# Install
Several methods are available to install the gateway:
# Install Theengs Gateway as a pip package
Prerequisites:
- Install Python3 (opens new window)
- Install pip (opens new window)
Make sure to have the latest version of pip if it's already installed:
pip install --upgrade pip
Then install Theengs Gateway with:
pip install TheengsGateway
You can access advanced configuration by typing:
python3 -m TheengsGateway -h
# Install Theengs Gateway as a pip package in a Python virtual environment
Recent versions of Python may prevent you from installing pip packages outside a Python virtual environment. For example, this is the case in Debian 12 ("bookworm"). Install Theengs Gateway then in a virtual environment.
First install pip and the venv module for Python:
sudo apt update
sudo apt install python3-pip python3-venv
2
Then create a virtual environment called theengs and activate it:
python3 -m venv theengs
source theengs/bin/activate
2
The command prompt is then preceded by (theengs) to show you're working in the virtual environment. Now you can install the Theengs Gateway package:
pip install TheengsGateway
After this, you can access advanced configuration by typing:
python3 -m TheengsGateway -h
If you want to run Theengs Gateway again in another shell session, don't forget to activate the virtual environment first.
# Install Theengs Gateway as an Add ON in Home Assistant
- Add the Add-on repository into the add-on store
Or by going to Settings -> Add-ons -> Add-on store -> ⁞ (Menu) -> Repositories -> Fill in the URL https://github.com/mihsu81/addon-theengsgw -> Add.
- You should now see TheengsGateway HA Add-on at the bottom list.
- Click on TheengsGateway, then click Install.
- Under the Configuration tab, change the settings appropriately (at least MQTT parameters), see Parameters (opens new window).
- 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
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.
# Install Theengs Gateway as a docker
Theengs Gateway is also available from docker hub thanks to @maretodoric (opens new window)
docker pull theengs/gateway
# Advanced users - Build and install
Make sure to have the latest version of pip:
pip install --upgrade pip
Then clone the repository:
git clone https://github.com/theengs/gateway.git
cd gateway
2
Then build and install the package:
pip install .
TIP
When launching the gateway you must be outside of its source code folder to avoid errors
← Controller 3 - Use ✈️ →