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.4.post2.tar.gz (113.7 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.4.post2-py3-none-any.whl (166.9 kB view details)

Uploaded Python 3

File details

Details for the file iotopen_bridge-0.1.4.post2.tar.gz.

File metadata

  • Download URL: iotopen_bridge-0.1.4.post2.tar.gz
  • Upload date:
  • Size: 113.7 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.4.post2.tar.gz
Algorithm Hash digest
SHA256 86e25939077c9ebcd3538761325dca1feae02a5ab08f7156380a963e020cc8fc
MD5 295b0494663e251df8c2c3240cb4c3b1
BLAKE2b-256 b7e96a0fa8839092c94d190aeb968bbb24e196fb3dc4da75806102ca4334966b

See more details on using hashes here.

File details

Details for the file iotopen_bridge-0.1.4.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for iotopen_bridge-0.1.4.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 c7c901285ebdf64dc6c701798d376c57c06191645056bd8be0a8a6fe7affe99e
MD5 b3cdaf1faacc9d3db1568b54c6d31f63
BLAKE2b-256 3b77e6960faddb7d07a3606b63dbd5ac810ed567f6e6707b2a85ded4ef8c9000

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