Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iotopen_bridge-0.1.6.tar.gz (116.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iotopen_bridge-0.1.6-py3-none-any.whl (169.5 kB view details)

Uploaded Python 3

File details

Details for the file iotopen_bridge-0.1.6.tar.gz.

File metadata

  • Download URL: iotopen_bridge-0.1.6.tar.gz
  • Upload date:
  • Size: 116.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for iotopen_bridge-0.1.6.tar.gz
Algorithm Hash digest
SHA256 7f06190be84748b3f538ef4457b537a056736439e8fec9c684db8a2a2eff6c0a
MD5 326fbe683e8d735c86f0b298ea32da6e
BLAKE2b-256 1e6124f20e11b577b8694015e4fe8545845601ec127698a21679ecea7f7e56a5

See more details on using hashes here.

File details

Details for the file iotopen_bridge-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: iotopen_bridge-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 169.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for iotopen_bridge-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ba5ca93a1cd13e74dd1a60d235207ca34814193a793d1e7fe63263ab720324a2
MD5 eefd175d9932599bd28b81731972d2dc
BLAKE2b-256 0d4d4c74bbfcf754cb92e9312021b03301a708ca65c012c5d28b8b33df238bc6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page