Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theengs/gateway-snap

Theengs Gateway packaged as a snap
https://github.com/theengs/gateway-snap

ble home-assistant home-automation iot mqtt smarthome snap snapcraft

Last synced: about 15 hours ago
JSON representation

Theengs Gateway packaged as a snap

Host: GitHub
URL: https://github.com/theengs/gateway-snap
Owner: theengs
License: gpl-3.0
Created: 2022-07-17T09:33:37.000Z (over 2 years ago)
Default Branch: development
Last Pushed: 2024-02-11T17:51:57.000Z (9 months ago)
Last Synced: 2024-02-11T18:23:35.629Z (9 months ago)
Topics: ble, home-assistant, home-automation, iot, mqtt, smarthome, snap, snapcraft
Language: Shell
Homepage:
Size: 67.4 KB
Stars: 4
Watchers: 4
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

[![Build status](https://github.com/theengs/gateway-snap/workflows/Build/badge.svg)](https://github.com/theengs/gateway-snap/actions)
[![Check status](https://github.com/theengs/gateway-snap/workflows/Check/badge.svg)](https://github.com/theengs/gateway-snap/actions)
[![GitHub license](https://img.shields.io/github/license/theengs/gateway-snap.svg)](https://github.com/theengs/gateway-snap/blob/development/LICENSE)
[![theengs-gateway](https://snapcraft.io/theengs-gateway/badge.svg)](https://snapcraft.io/theengs-gateway)
![amd64](https://img.shields.io/badge/amd64-yes-green.svg)
![arm64](https://img.shields.io/badge/arm64-yes-green.svg)
![armhf](https://img.shields.io/badge/armhf-yes-green.svg)

# Theengs Gateway Snap

[Theengs Gateway](https://github.com/theengs/gateway) packaged as a snap.

## How to install

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-white.svg)](https://snapcraft.io/theengs-gateway)

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

```shell
snap install theengs-gateway
```

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

```shell
snap install bluez pi-bluetooth
```

## How to configure

First give the snap access to Bluetooth:

```shell
snap connect theengs-gateway:bluez-client :bluez
```

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

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

You can show the snap's configuration with:

```shell
$ 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:

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

Have a look at [Theengs Gateway's documentation](https://gateway.theengs.io/use/use.html#details-options) 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:

```shell
snap start --enable theengs-gateway
```

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

```shell
snap logs theengs-gateway -f
```