Installation

Virtual environment

Installation

Hint

On Windows use the python command instead of python3

Navigate to the folder in which the virtual environment shall be created (e.g.):

cd /opt/sml2mqtt

If the folder does not exist yet you can create it with the mkdir command:

mkdir /opt/sml2mqtt

Create virtual environment (this will create a new subfolder “venv”):

python3 -m venv venv

Go into folder of virtual environment:

cd venv

1. Activate the virtual environment

   Linux:

   source bin/activate
   

   Windows:

   Scripts\activate
   

2. Upgrade pip and setuptools:

   python3 -m pip install --upgrade pip setuptools
   

Install sml2mqtt:

python3 -m pip install sml2mqtt

1. Run sml2mqtt:

   sml2mqtt --config PATH_TO_CONFIGURATION_FILE
   

Upgrading

1. Stop sml2mqtt

2. Activate the virtual environment

   Navigate to the folder where sml2mqtt is installed:

   cd /opt/sml2mqtt
   

   Activate the virtual environment

   Linux:

   source bin/activate
   

   Windows:

   Scripts\activate
   

3. Run the following command in your activated virtual environment:

   python3 -m pip install --upgrade sml2mqtt
   

4. Start sml2mqtt

5. Observe the log for errors in case there were changes

Autostart after reboot

To automatically start the sml2mqtt from the virtual environment after a reboot call:

nano /etc/systemd/system/sml2mqtt.service

and copy paste the following contents. If the user/group which is running sml2mqtt is not “openhab” replace accordingly. If your installation is not done in “/opt/sml2mqtt/venv/bin” replace accordingly as well:

[Unit]
Description=sml2mqtt
Documentation=https://github.com/spacemanspiff2007/sml2mqtt
After=network-online.target

[Service]
Type=simple
User=openhab
Group=openhab
Restart=on-failure
RestartSec=10min
ExecStart=/opt/sml2mqtt/venv/bin/sml2mqtt -c PATH_TO_CONFIGURATION_FILE

[Install]
WantedBy=multi-user.target

Now execute the following commands to enable autostart:

sudo systemctl --system daemon-reload
sudo systemctl enable sml2mqtt.service

It is now possible to start, stop, restart and check the status of sml2mqtt with:

sudo systemctl start sml2mqtt.service
sudo systemctl stop sml2mqtt.service
sudo systemctl restart sml2mqtt.service
sudo systemctl status sml2mqtt.service

Docker

Installation through docker is available:

docker pull spacemanspiff2007/sml2mqtt:latest

The docker image has one volume /sml2mqtt which has to be mounted. There the config.yml will be used or a new config.yml will be created

The analyze option can also be set through an environment variable (see command line interface).