Skip to content

theengs/gateway-snap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build status Check status GitHub license theengs-gateway amd64 arm64 armhf

Theengs Gateway Snap

Theengs Gateway packaged as a snap.

How to install

Get it from the Snap Store

You can install the snap on amd64, arm64 and armhf systems with:

snap install theengs-gateway

If you're running this on Ubuntu Core on a Raspberry Pi, also install the following snaps for Bluetooth:

snap install bluez pi-bluetooth

How to configure

First give the snap access to Bluetooth:

snap connect theengs-gateway:bluez-client :bluez

If you're running the snap on Ubuntu Core, this command needs to be:

snap connect theengs-gateway:bluez-client bluez:service

You can show the snap's configuration with:

$ snap get -d theengs-gateway
{
        "bindkeys": "",
        "ble": {
                "adapter": "",
                "enable": 1,
                "scan-duration": 5,
                "time-between": 5
        },
        "general-presence": 0,
        "ha": {
                "discovery": 1,
                "discovery-device-name": "TheengsGateway",
                "discovery-filter": "IBEACON",
                "discovery-topic": "homeassistant/sensor",
                "hass-discovery": 1
        },
        "identities": "",
        "log-level": "INFO",
        "mqtt": {
                "enable-tls": 0,
                "enable-ws": 0,
                "host": "",
                "pass": "",
                "port": 1883,
                "pub-topic": "home/TheengsGateway/BTtoMQTT",
                "lwt-topic": "home/TheengsGateway/LWT",
                "sub-topic": "home/+/BTtoMQTT/undecoded",
                "publish-advdata": 0,
                "user": ""
        },
        "time-sync": {
                "addresses": "",
                "format": 0
        },
        "presence": {
                "topic": "home/TheengsGateway/presence",
                "enable": 0
        },
        "tracker-timeout": 120
}

You need to set at least the MQTT configuration, for instance:

snap set theengs-gateway mqtt.host=MYBROKER mqtt.user=MYUSER mqtt.pass=MYPASS

Have a look at Theengs Gateway's documentation for the meaning of all configuration options.

After changing the configuration, Theengs Gateway should now run as a service. If you want it to start automatically after booting your Linux distribution, enable the service with:

snap start --enable theengs-gateway

Have a look at the snap's logs to troubleshoot problems:

snap logs theengs-gateway -f