Secure IoT Open Lynx ↔ Home Assistant MQTT Discovery bridge
Project description
iotopen-bridge
Secure, extensible bridge between IoT Open Lynx and Home Assistant using MQTT + HA MQTT Discovery.
Quick start
Install (PyPI)
pip install iotopen-bridge
Install (dev)
pip install -e ".[dev]"
Home Assistant integration helper (optional)
If you are writing a Home Assistant custom integration and want minimal glue code,
you can build a BridgeConfig from your config flow values and start the runtime from HA:
from iotopen_bridge.ha import HABridgeHandle, build_bridge_config
cfg = build_bridge_config(
base_url="https://lynx.iotopen.se",
api_key="...",
installation_id=2222,
mqtt_host="localhost",
mqtt_port=1883,
)
handle = HABridgeHandle.from_config(cfg)
await handle.async_start(hass)
Configure
Create config.yml (see examples/config.example.yaml):
lynx:
base_url: "https://lynx.example"
installation_id: 2222
api_key: "${IOTOPEN_API_KEY}"
mqtt:
host: "mqtt.example"
port: 8883 #tls 1883 non secured
username: "${MQTT_USER}"
password: "${MQTT_PASS}"
client_id: "iotopen-bridge"
tls:
enabled: true
cafile: "/etc/ssl/certs/ca-certificates.crt"
verify_hostname: true
ha:
discovery:
enabled: true
prefix: "homeassistant"
state_prefix: "iotopen"
Run
iotopen-bridge run --config config.yml
Probes
iotopen-bridge probe-api --config config.yml
iotopen-bridge probe-mqtt --config config.yml --sub "2086/obj/#" --count 20
Design
- Inventory from Lynx API (FunctionX).
- Telemetry from FunctionX
topic_read. - Commands to FunctionX
topic_set. - HA MQTT Discovery auto-creates entities in Home Assistant.
See docs/architecture.md.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iotopen_bridge-0.1.4.tar.gz.
File metadata
- Download URL: iotopen_bridge-0.1.4.tar.gz
- Upload date:
- Size: 111.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d701261e5e576ff3c03c6746e628b46e18fc202d9dad45632531c579fdf1d4c
|
|
| MD5 |
bc556034f926d79df9f9a4caf797d87a
|
|
| BLAKE2b-256 |
7ba867e13523eb218a5777133f8e8b164509560cb96d1445ac2a79e2b3d68480
|
Provenance
The following attestation bundles were made for iotopen_bridge-0.1.4.tar.gz:
Publisher:
publish.yml on afiay/iotopen-bridge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iotopen_bridge-0.1.4.tar.gz -
Subject digest:
0d701261e5e576ff3c03c6746e628b46e18fc202d9dad45632531c579fdf1d4c - Sigstore transparency entry: 772295088
- Sigstore integration time:
-
Permalink:
afiay/iotopen-bridge@0b66e5f32f033e7e442fb28dfe9b1de42f961338 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/afiay
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0b66e5f32f033e7e442fb28dfe9b1de42f961338 -
Trigger Event:
push
-
Statement type:
File details
Details for the file iotopen_bridge-0.1.4-py3-none-any.whl.
File metadata
- Download URL: iotopen_bridge-0.1.4-py3-none-any.whl
- Upload date:
- Size: 165.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80b62e69222b71c664f13506a3200b1430ebd83e539de7cfc26a675f0110d13a
|
|
| MD5 |
5471f8f4536a4fd2ce892cc89417662c
|
|
| BLAKE2b-256 |
f943d77cd1409d995f93875f282e62808be3e792442650a6bc0df1da2ace5e51
|
Provenance
The following attestation bundles were made for iotopen_bridge-0.1.4-py3-none-any.whl:
Publisher:
publish.yml on afiay/iotopen-bridge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iotopen_bridge-0.1.4-py3-none-any.whl -
Subject digest:
80b62e69222b71c664f13506a3200b1430ebd83e539de7cfc26a675f0110d13a - Sigstore transparency entry: 772295092
- Sigstore integration time:
-
Permalink:
afiay/iotopen-bridge@0b66e5f32f033e7e442fb28dfe9b1de42f961338 -
Branch / Tag:
refs/tags/v0.1.4 - Owner: https://github.com/afiay
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0b66e5f32f033e7e442fb28dfe9b1de42f961338 -
Trigger Event:
push
-
Statement type: