Skip to content

docs: clarify WebSocket message types — QUANTITY energy is not streamed #6

Description

@MateoGreil

Context

The WebSocket documentation currently needs to clearly distinguish the message types emitted by the Comwatt stream.

Observed behavior

A full-hour live capture showed:

  • FLOW messages: streamed device power measurements;
  • STATE messages: streamed switch/state changes;
  • no QUANTITY messages: energy quantities are not emitted by the WebSocket stream.

Energy data must therefore be obtained through the REST time-series endpoints. Integrations that need real-time energy must integrate streamed power and periodically reconcile it with the official REST QUANTITY/HOUR buckets.

Please update the client README and streaming documentation so users do not expect energy quantities to arrive through WebSocket messages.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions