Skip to content

Real Time Push

Jump to bottom
Veldkornet edited this page Oct 15, 2026 · 2 revisions

🔄 Real-Time Push Subscriptions

Instead of waiting for the polling interval, the integration can subscribe to real-time telemetry and alarm push from HYXI Cloud. HYXI then pushes data and alarm changes to Home Assistant's webhook endpoint as soon as it receives them.

This is cloud-only and opt-in.

Enabling it

Push needs HYXI's cloud to reach Home Assistant over HTTPS: through Home Assistant Cloud, an external HTTPS URL set in Home Assistant, or a custom HTTPS URL you enter. It's only offered when one of those is available.

  • When adding a cloud entry, tick Enable Real-Time Webhook Push on the setup screen (off by default). A second screen then asks for an optional custom callback URL.
  • For an existing entry, go to Settings → Devices & Services → HYXI → Configure and toggle Enable Real-Time Webhook Push. You can also set:
    • Push Update Frequency (seconds) — telemetry push rate, default 10.
    • Custom Callback URL — by default the integration uses Home Assistant Cloud or the external URL registered with Home Assistant. If HYXI can't reach that (CGNAT, a custom reverse proxy, an ngrok / Cloudflare tunnel, …), enter a reachable HTTPS base URL here; the integration appends the webhook path itself.

The integration then registers its webhooks on Home Assistant and subscribes with HYXI. The webhook IDs are random, so the callback URLs can't be guessed.

Diagnostics

Each cloud entry gets a Real-Time Subscription Status sensor:

  • State — active, inactive, or error, depending on subscription health.
  • data_push and alarm_push — for the real-time and alarm subscriptions: status, subscription code, callback URL, push rate, last error, and when the last push arrived.
  • subscriptions — every push subscription HYXI holds for your API keys: code, type, callback URL, creation time and devices. Leftovers from earlier setups show up here too, and can be cancelled with hyxi_cloud.cancel_subscription.

A Renew Subscription button cancels and re-creates both subscriptions if push gets stuck.

Coexistence with polling

You don't need to change or disable the normal polling interval when push is on:

  • Live updates — a push frame updates your sensors immediately.
  • Poll as heartbeat — the background poll (default 5 min) still runs, to fetch metrics only available via pull queries (e.g. grid power) and as a fallback.
  • Automatic fallback — if push frames stop arriving (network disruption, proxy failure, cloud outage), REST polling just carries on.

Leftover subscriptions (B004002)

HYXI refuses a new subscription for a device that already has one ("device serial number has been subscribed to repeatedly", B004002). Before subscribing, the integration cancels any real-time or alarm subscription HYXI holds for the same devices, so leftovers from earlier setups no longer block push. This only reaches subscriptions made with the same API keys; for others, see Troubleshooting → Real-Time Push subscription lockouts.

See also

  • Installation Guide — where the option lives, alongside the other optional features.
  • Troubleshooting — lockout recovery and the hyxi_cloud.cancel_subscription action.

Clone this wiki locally