-
Notifications
You must be signed in to change notification settings - Fork 16
Standalone Installation
mak-gitdev edited this page Jan 19, 2024
·
7 revisions
An installation script is available.
- Download the script to a directory.
- In a terminal, go to that directory and run:
chmod u+x install.sh
- To know how to launch the script, run:
./install.sh -h
- Finally, launch the script with the required arguments. For example, to install version 0.1.28 in the current directory, run:
./install.sh -v 0.1.28 -d ./
IMPORTANT NOTE: There is no need for root priviledges during the install. The install script displays an error and exits when the script is ran with root priviledges.
- adapt the
standalone/enoceanmqtt.conf.sample
file and put it to /etc/enoceanmqtt.conf:- Set the enocean interface port. Follow these instructions if you want to set a persistent device name for your enocean interface.
-
overlay = HA
shall be added in the config section to indicate that the HA overlay is to be used. -
mqtt_discovery_prefix = <prefix>
shall also be added in the config section. where<prefix>
is the MQTT prefix used for discovery. It defaults tohomeassistant
and can be configured in the Home Assistant MQTT integration as follow:If you have other HA integrations using MQTT discovery (e.g. zigbee2mqtt, etc.),mqtt: discovery_prefix: <prefix>
<prefix>
should be set tohomeassistant
as it seems to be the one used in general. - Define the MQTT broker parameters
- Define the
mqtt_prefix
. This is the prefix which will be used to interact with your EnOcean devices.
EnOceanMQTT will interact with EnOcean devices through the device root topic<mqtt_prefix>/<device_name>
. - Define the devices to monitor. You only need to specify the device name, address, rorg, func and type. See Normal Usage for more details.
- ensure that the MQTT broker is running
- run
enoceanmqtt
Assuming you want this tool to run as a daemon, which gets automatically started by systemd:
- Adapt and copy the
standalone/enoceanmqtt.service
to/etc/systemd/system/
systemctl enable enoceanmqtt
systemctl start enoceanmqtt