Home Assistant homee integration

Component to integrate with homee.

Based on the intial work of FreshlyBrewedCode

Integration is in HACS Default Repositories now!

This component will set up the following platforms.

Platform	Description
alarm-control-panel	Integrate the homee status.
binary_sensor	Integrate homee devices that provide binary state information like on/off or open/close.
climate	Integrate homee devices that provide temperature and can set a target temperature. Currently only heating thermostats are supported.
cover	Integrate homee devices that provide motor and position functions such as blinds and shutter actuators
event	Integrate events from button remots from homee.
light	Integrate lights from homee.
lock	Integrate locks from homee.
number	Integrate number entities - usually settings of some kind.
sensor	Integrate homee devices that provide readings.
switch	Integrate homee devices that can be turned on/off and can optionally provide information about the current power consumption.

ℹ️ Upgrade from previous Repository

⚠️ Backup homee and Home Assistant!

1. In HACS click on the homee integration.

2. In the top right menu click "remove"

3. click "ignore". This way, the integration will be deleted, but the config will stay.

4. !WITHOUT RESTART! Add this repository to HACS and install.

5. Now restart.

If you want to use the new feature to import all devicess from homee, you have to remove the integration and reinstall.

Installation

⚠️ Backup homee and Home Assistant!

HACS (recommended)

Integration is available as default repository in HACS.

1. Make sure the HACS integration is properly installed for your instance of home assistant.
2. In the HACS UI go to "Integrations", click on "+" in the lower right corner".
3. Paste https://github.com/Taraman17/hass-homee into the field that says "Add custom repository URL", select "Integration" from "Category" dropdown and click "Add".
4. You should now see a card with the homee integration in the HACS -> "Integrations" section. Click "Install".
5. Select the latest version from the dropdown and click "Install".
6. Restart Home Assistant.

Manual installation

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called homee.
4. Download all the files from the custom_components/homee/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant.

Configuration

ℹ️ Because of a bug (#5) configuring more than one homee in Home Assistant can cause strange behavour - feedback is appreciated.

The integration will attempt to discover homee cubes in your network. Discovered cubes should show up in the "Configuration" -> "Integrations" section along with the associated homee id and host ip address.

1. In the HA UI go to "Configuration" -> "Integrations", click "Configure" on a discovered homee or click "+", search for "homee", and select the "homee" integration from the list. Or click here:
2. In the dialog enter the username and password of a homee account that can access your cube, as well as the host (ip address of the homee cube) if you are not configuring a discovered cube. As well choose if you want to import all devices into HA or only ones from certain homee-groups Click submit.
3. If the connection was successful you will see the "Group Configuration" section. if you chose "only devices from groups" in the first step, you can select the groups from which you want to import devices here. These options for door/window sensors can also be changed later from by clicking on the "Options" button on the homee integration. For more details on the available options check the Options section.
4. Click submit. Your devices will be automatically added to Home Assistant.

Options

The following table shows the available options that can be configured in the "Initial Configuration" step or using the "Options" button on an existing configuration. Please note that you have to restart Home Assistant after changing the options using the "Options" button.

Option	Default	Description
The groups that should be imported	all groups	The integration will only import devices that are in any of the selected groups if you chose so in the first config step. Use this option to limit the devices that you want to import.
Groups that contain window sensors	empty	Any binary_sensor that is in any of the selected groups will use the window device class. You should select a homee group that contains all of your window sensors.
Groups that contain door sensors	empty	Any binary_sensor that is in any of the selected groups will use the door device class. You should select a homee group that contains all of your door sensors.
Add (debug) information about the homee node and attributes to each entity	False	Enabling this option will add the homee_data attribute to every entity created by this integration. The attribute contains information about the homee node (name, id, profile) and the attributes (id, type). This option can be useful for debugging or advanced automations when used with templates.

Homee device not working correctly?

As of now this integration has support for a few devices only. If you have Homee devices, that are not discovered or not working correctly, open an issue and do the following to provide a log:

1. Add following lines to configuration.yaml to enable info logging for hass-homee:

logger:
  default: warn
  logs:
    custom_components.homee: info

2. Restart Home Assistant.
3. Go to "Settings->System->Logs" and show complete logs.
4. Look for lines containing "INFO (MainThread) [custom_components.homee]" and copy them
5. Open an issue describing the device and paste the logs in the corresponding section

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Home Assistant encourages developers of integrations to use a separate python package that handles the communication between Home Assistant and the different devices (i.e. python api/backend). This integration uses pymee to connect and communicate with the homee websocket api. For some features it may be necessary to make changes to pymee first.

---