{"id":18327910,"url":"https://github.com/theengs/gateway-appliance","last_synced_at":"2026-05-03T17:34:21.814Z","repository":{"id":49403002,"uuid":"517078308","full_name":"theengs/gateway-appliance","owner":"theengs","description":"Ubuntu Core appliance with Theengs Gateway pre-installed","archived":false,"fork":false,"pushed_at":"2024-02-11T18:29:40.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"development","last_synced_at":"2025-04-09T16:55:35.333Z","etag":null,"topics":["appliance","ble","home-assistant","home-automation","iot","mqtt","raspberry-pi","smarthome","snap","snapcraft","ubuntu-core"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theengs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-23T14:23:07.000Z","updated_at":"2022-10-28T21:46:24.000Z","dependencies_parsed_at":"2024-11-05T19:12:52.357Z","dependency_job_id":"4d667bda-b46e-4c64-87d6-396040db1f72","html_url":"https://github.com/theengs/gateway-appliance","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/theengs/gateway-appliance","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theengs%2Fgateway-appliance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theengs%2Fgateway-appliance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theengs%2Fgateway-appliance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theengs%2Fgateway-appliance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theengs","download_url":"https://codeload.github.com/theengs/gateway-appliance/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theengs%2Fgateway-appliance/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32578780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appliance","ble","home-assistant","home-automation","iot","mqtt","raspberry-pi","smarthome","snap","snapcraft","ubuntu-core"],"created_at":"2024-11-05T19:12:37.093Z","updated_at":"2026-05-03T17:34:21.780Z","avatar_url":"https://github.com/theengs.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build status](https://github.com/theengs/gateway-appliance/workflows/Build/badge.svg)](https://github.com/theengs/gateway-appliance/actions)\n[![Check status](https://github.com/theengs/gateway-appliance/workflows/Checks/badge.svg)](https://github.com/theengs/gateway-appliance/actions)\n[![GitHub license](https://img.shields.io/github/license/theengs/gateway-appliance.svg)](https://github.com/theengs/gateway-appliance/blob/development/LICENSE)\n[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/theengs/gateway-appliance?label=Theengs%20Gateway)](https://github.com/theengs/gateway-appliance/releases)\n![amd64](https://img.shields.io/badge/amd64-yes-green.svg)\n![arm64](https://img.shields.io/badge/pi_arm64-yes-green.svg)\n![armhf](https://img.shields.io/badge/pi_armhf-yes-green.svg)\n\n# Theengs Gateway Appliance\n[Ubuntu Core](https://ubuntu.com/core) appliance with [Theengs Gateway](https://github.com/theengs/gateway) pre-installed \n\n## How to install\nDownload the .img.xz file from the [latest release](https://github.com/theengs/gateway-appliance/releases) of this repository.\n\nThere are three files to choose from:\n\n* theengs-gateway-core22-amd64.img.xz: for Intel NUC\n* theengs-gateway-core22-pi-arm64.img.xz: for Raspberry Pi 3, 4, 400, CM4 and Zero 2 W\n* theengs-gateway-core22-pi-armhf.img.xz: for Raspberry Pi 2, 3, 4, 400, CM4 and Zero 2 W\n\nNote that the Raspberry Pi 2 only supports 32-bits, so you need the armhf image for this model. You also need a separate Bluetooth USB dongle (Bluetooth 4.0 or higher) to be able to use Theengs Gateway, because this model doesn't have a built-in Bluetooth chip.\n\nSee the instructions for [Installing Ubuntu Core 22 on a Raspberry Pi](https://ubuntu.com/core/docs/install-raspberry-pi), but use one of the images of this repository instead of the default Ubuntu Core 22 image.\n\nAfter installing the appliance, the operating system and Theengs Gateway should automatically upgrade when a newer release is available.\n\nMake sure to set the correct timezone for the appliance, e.g.:\n\n```shell\nsnap set system system.timezone=\"Europe/Brussels\"\n```\n\n## How to configure\n\nFirst give the snap access to Bluetooth:\n\n```shell\nsnap connect theengs-gateway:bluez-client bluez:service\n```\n\nYou can show the Theengs Gateway snap's configuration with:\n\n```shell\n$ snap get -d theengs-gateway\n{\n        \"ble\": {\n                \"adapter\": \"\",\n                \"scan-duration\": 5,\n                \"time-between\": 5\n        },\n        \"ha\": {\n                \"discovery\": 1,\n                \"discovery-device-name\": \"TheengsGateway\",\n                \"discovery-filter\": \"IBEACON\",\n                \"discovery-topic\": \"homeassistant/sensor\",\n                \"hass-discovery\": 1\n        },\n        \"log-level\": \"WARNING\",\n        \"mqtt\": {\n                \"host\": \"\",\n                \"pass\": \"\",\n                \"port\": 1883,\n                \"pub-topic\": \"home/TheengsGateway/BTtoMQTT\",\n                \"lwt-topic\": \"home/TheengsGateway/LWT\",\n                \"sub-topic\": \"home/+/BTtoMQTT/undecoded\",\n                \"publish-advdata\": 0,\n                \"user\": \"\"\n        },\n        \"time-sync\": {\n                \"addresses\": \"\",\n                \"format\": 0\n        },\n        \"presence\": {\n                \"topic\": \"home/TheengsGateway/presence\",\n                \"enable\": 0\n        }\n}\n```\n\nYou need to set at least the MQTT configuration, for instance:\n\n```shell\nsnap set theengs-gateway mqtt.host=MYBROKER mqtt.user=MYUSER mqtt.pass=MYPASS\n```\n\nHave a look at [Theengs Gateway's documentation](https://gateway.theengs.io/use/use.html#details-options) for the meaning of all configuration options.\n\nAfter changing the configuration, Theengs Gateway should now run as a service. If you want it to start automatically after booting your appliance, enable the service with:\n\n```shell\nsnap start --enable theengs-gateway\n```\n\n## How to build new images\nIf you want to build the images yourself, you can do this in one command:\n\n```\n./scripts/build-images.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheengs%2Fgateway-appliance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheengs%2Fgateway-appliance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheengs%2Fgateway-appliance/lists"}