Skip to content

Usage

Jump to bottom
mak-gitdev edited this page Aug 13, 2023 · 11 revisions

Pairing your device

If pairing is needed, please follow the instruction of your device regarding pairing.
Enoceanmqtt supports pairing through the Python EnOcean library.
Once your device is in pairing mode, go to Settings -> Devices & Services -> Under Mosquitto Broker click on xx devices ->, select the ENOCEANMQTT device and turn on the LEARN switch.
The pairing response will be submitted automatically.
Turn off the LEARN switch once pairing is completed.

Normal usage

Enoceanmqtt works as usual.
The Home Assistant overlay is only in charge of creating automatically and managing MQTT devices in Home Assistant.
At startup, all specified devices are created or updated in Home Assistant such that the user can directly interact with the device.
Your devices will be available in Home Assistant under the MQTT integration's devices and entities.

Delete your device from Home Assistant

If you want to delete your device from Home Assistant:

  • Remove your device from the enoceanmqtt device configuration file. You can at this stage, restart the addon and not follow the next steps. Follow the next steps if you don't want to restart the addon
  • Browse to the devices of MQTT integration
  • Click on your device
  • Click on the delete button in the configuration section

Virtual devices

From version 0.1.24, support for virtual devices has been added so that HA can now act as one or more virtual devices, typically a rocker switch such as F6-02-01.
For example, considering your Base ID is 0xFFDA5580 and you want HA to emulate 2 rocker switches like F6-02-01, you can add in your device file:

[myEmulatedRocker1]
address = 0xFFFFFFFF
rorg    = 0xF6
func    = 0x02
type    = 0x01
sender  = 0xFFDA5580
virtual = 1

[myEmulatedRocker2]
address = 0xFFFFFFFF
rorg    = 0xF6
func    = 0x02
type    = 0x01
sender  = 0xFFDA5581
virtual = 1

sender is the EnOcean address of the virtual rocker switch. It should be in the range [Base_ID...Base_ID+127]. virtual is used to indicate that this is a virtual device so that it is mapped to control entities (switch, button, select, etc.) instead of status entities (binary_sensor, sensor, etc.).

Clone this wiki locally