# Install

# Install prerequisites

# Install Theengs Gateway

Doing so is simple as 1 command:

pip3 install TheengsGateway
1

You can access advanced configuration by typing:

python3 -m TheengsGateway -h
1

# Install Theengs Gateway as an Add ON in Home Assistant

  1. Open Home Assistant and navigate to the "Add-on Store". Click on the 3 dots (top right) and select "Repositories".
  2. Enter https://github.com/mihsu81/addon-theengsgw in the box and click on "Add".
  3. You should now see "TheengsGateway HA Add-on" at the bottom list.
  4. Click on "TheengsGateway", then click "Install".
  5. Under the "Configuration" tab, change the settings appropriately (at least MQTT parameters), see Parameters.
  6. Start the Add-on.

# Install Theengs Gateway as a snap

Theengs Gateway is also packaged as a snap in the Snap Store (opens new window). If you have snapd running on your Linux distribution, which is the case by default on Ubuntu, you can install the Theengs Gateway snap as:

snap install theengs-gateway
1

Have a look at the Theengs Gateway Snap (opens new window) documentation for more information about how to configure and start Theengs Gateway as a service.

# Advanced users - Build and install

git clone https://github.com/theengs/gateway.git
cd gateway
git submodule update --init --recursive
python3 setup.py sdist
cd dist
pip3 install distribution_file_name
1
2
3
4
5
6

TIP

When launching the gateway you must be outside of its source code folder to avoid errors