Skip to content

IPBuilding Gateway Companion - Latest

Choose a tag to compare

View all tags
@markminnoye markminnoye released this 18 Jun 14:45
· 25 commits to main since this release
v1.1.0
b80346f

Highlights

  • First public release of the IPBuilding Gateway HA companion — an open Home Assistant integration for the IPBuilding field-bus (UDP/1001 to IP0200PoE relays, IP0300PoE dimmers, and IP1100PoE input modules). Scenes, automations, and button→action logic stay in Home Assistant; the companion is a thin client that turns the gateway's WebSocket /ws and REST /api/v1/ into standard HA entities.
  • Auto-discovery: Supervisor discovery when the gateway runs as an HA add-on; Zeroconf (_ipbgw._tcp.local.) for standalone gateways; manual host/port entry as a fallback.
  • Entities: light (relays + dimmers), switch (with semantic types: plug, fan, …), event for physical IP1100PoE buttons (press / long_press / release), sensor for per-channel power, and a discovery-sweep button on the hub device.
  • Three-tier device tree — gateway → module (relay / dimmer / input) → channel — with via_device links and optional channel → area mapping from devices.json on the gateway.
  • English + Dutch UI translations.

Requirements

  • A running IPBuilding Gateway reachable from Home Assistant (HA add-on on the same host, or any host on your IPBuilding VLAN). Default port: 8080.
  • Home Assistant 2023.8 or newer (for EventEntity).

Install (HACS)

  1. HACS → Integrations → ⋮ → Custom repositories.
  2. Add https://github.com/markminnoye/ha-ipbuilding-gateway as type Integration.
  3. Search for IPBuilding Gateway HA and install.
  4. Restart Home Assistant.
  5. The integration appears under Settings → Devices & Services → Discovered when the gateway is reachable. Click Add to set it up; or add it manually with the gateway's host and port.

Full installation and configuration guide: README.

First steps

  • The companion mirrors the gateway's devices.json. If the gateway has no devices yet, a one-time discovery sweep runs automatically on first start and reloads the integration. You can also trigger a sweep from the Run discovery sweep button on the hub device.
  • Channels and modules show up in the device registry. To suggest a Home Assistant area per channel, set room on the device in the gateway's devices.json (the companion will match it to an existing HA area, or pre-select it during the "Name and assign" onboarding step).
  • For button-to-action automations, use the event.<hardware_id> entities on IP1100PoE inputs. The companion also publishes typed bus events (ha_ipbuilding_gateway.button_pressed / button_long_pressed / button_released) for use in legacy event-trigger automations.

Acknowledgements

Built against the open IPBuilding Gateway (field-bus hub). The legacy IPBox REST/WebConfig is not a dependency of this integration.

Assets 2
Loading