Zimi Controller

Component to integrate with Zimi Controller and associated devices.

This component will set up the following platforms.

Platform	Description
cover	Open or close a cover (typically garage door).
fan	Switch a fan on or off and change speed.
light	Switch a light on or off.
switch	Switch a switch on or off.

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 zimi.
4. Download all the files from the custom_components/zimi/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "zimi"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/zimi/translations/en.json
custom_components/zimi/__init__.py
custom_components/zimi/config_flow.py
custom_components/zimi/const.py
custom_components/zimi/cover.py
custom_components/zimi/fan.py
custom_components/zimi/light.py
custom_components/zimi/manifest.json
custom_components/zimi/sensor.json
custom_components/zimi/strings.json
custom_components/zimi/switch.py

Configuration is done in the UI

Configuration Options

The following configuration options are shown when adding a new ZIMI integration:

Option	Value
host	hostname for ZCC or leave blank to attempt to discover on network
port	port number for manually configured ZCC host
timeout	TCP/IP socket timeout value - leave as is
verbosity	level of debug output between 0 and 2. 1 is a good setting.
watchdog	number of seconds between refresh of the connection or 0 if not used

Automatic setup via UDP discovery

The integration can attempt to discover a ZCC device on the local network if the user does not enter data into the IP Address and Port fields. If a ZCC is discovered, the IP address and port will be used to interrogate the ZCC to identify all ControlPoints. This data includes Properties, States and Actions which is used to create an Entities within Home Assistant.

Manual setup via IP and Port

If the automatic discovery is unsuccessful the user can enter a known IP Address and Port during configuration. The IP will need to be ascertained by the user via their respective network, the default port is 5003.

ControlPoints

A Zimi Powermesh is made up of a number of ControlPoints. A ControlPoint is an individually controllable output on a Zimi Powermesh device. One device can have up to 4 ControlPoints (in the case of a 4 point Multi Purpose Switch).

ControlPoints are assigned to a Room and given a Name via the Zimi App.

Behaviour Link can be used in the Zimi App to link an unused ControlPoint to another ControlPoint allowing multiple physical switching points for the same endpoint (light).

Naming

Entities will be created in Home Assistant based naming in the Zimi App. Some consideration should be given to establishing a structured naming scheme in the Zimi App prior to discovery for a cleaner and more manageable experience in Home Assistant.

• Entities will be placed in a Home Assistant Area base on the Room Name in the Zimi App. If the Area does not exist it will be created.
• Entity name in Home Assistant will be the ControlPoint Name in the Zimi App
• Entity ID in Home Assistant will be type.name (i.e. switch.downlights)

If the same name is given to multiple ControlPoints a numeric will automatically be appended during the creation of the Entity. For example, if Downlights is used in the Zimi App to identify similar devices in multiple rooms the Entity ID(s) in Home Assistant would be:

• light.downlights
• light.downlights_2
• light.downlights_3

Each of these Entities be uniquely identifiable via it's Area assignment.

Zimi Network Updates

Changes in the Zimi network (naming and addition of devices) can be picked up by doing a Reload of the integration.

Compatibility

Integration has been tested on: ZCC Firmware version 20220303010011

This can be checked in the Zimi App check under: Settings -> Manage Network -> Cloud Connect

Known issues

• Zimi Controller IP address auto-discovery has some issues: (a) it does not work if the HA is hosted in a docker container, (b) it has been shown to have some issues at HA restart. For best results enter the IP address of the controller when setting up the integration.
• Garage Door Controller does not accept 0 via the UI slider, can be closed via down action
• Switch (Power Point) icons do not update status, this can be resolved by adding state_color: true to the entity card
• If unexpected behaviour is observed try power cycling the ZCC

Contributions are welcome!

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

---