How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SPAN eBus MQTT API

Publish/subscribe streaming API hosted on SPAN Panel using the Electrification Bus (eBus) integration framework and the Homie Convention. SPAN Panel hosts an MQTT broker accessible over MQTTS (8883), WS, and WSS. Clients subscribe to `ebus/5//...` topics to receive real-time panel state, per-circuit telemetry, energy storage state, and SPAN Drive integration data, and publish to `/set` topics to operate relays and control panel state. The broker enforces topic-level ACLs — full read access on `ebus/#`, write access limited to Homie `/set` control topics and to non-panel device subtrees under `ebus/5/`. Credentials are obtained via the REST authentication endpoint.

SPAN eBus MQTT API is one of 9 APIs that SPAN publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include MQTT, Homie, Electrification Bus, eBus, and Pub-Sub. The published artifact set on APIs.io includes API documentation, an AsyncAPI specification, and 1 JSON Schema.

This event API exposes 11 operations across 11 channels, and defines 9 schemas. It is described by AsyncAPI 2.6.0, at version r202615.

The API connects through 2 servers: span-{serialNumber}.local:8883 (mqtts), span-{serialNumber}.local:8884 (wss).

11 operations 11 channels 9 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
r202615
Servers
span-{serialNumber}.local:8883 (mqtts)
span-{serialNumber}.local:8884 (wss)
License
Resource Areas
1

Channels & Operations 11

Across 11 channels, the API surfaces 11 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 11
SUB
ebus/5/{serial}/$state
Subscribe to SPAN Panel Homie lifecycle state.
subscribePanelState 1 param body
SUB
ebus/5/{serial}/$description
Subscribe to the panel's Homie $description schema.
subscribePanelDescription 1 param body
SUB
ebus/5/{serial}/panel/power
Stream real-time whole-home power values.
subscribePanelPower 1 param body
SUB
ebus/5/{serial}/panel/meter
Stream main meter cumulative energy registers.
subscribePanelMeter 1 param body
SUB
ebus/5/{serial}/panel/grid
Stream grid / main relay state changes.
subscribeGridState 1 param body
PUB
ebus/5/{serial}/panel/grid/set
Publish a desired grid relay state.
setGridState 1 param body
SUB
ebus/5/{serial}/panel/islanding-state
Stream islanding state transitions.
subscribeIslandingState 1 param body
SUB
ebus/5/{serial}/circuits/{circuitId}/power
Stream per-circuit real-time power.
subscribeCircuitPower 2 params body
SUB
ebus/5/{serial}/circuits/{circuitId}/relay-state
Stream per-circuit relay state changes.
subscribeCircuitRelayState 2 params body
PUB
ebus/5/{serial}/circuits/{circuitId}/relay-state/set
Publish a desired per-circuit relay state.
setCircuitRelayState 2 params body
SUB
ebus/5/{serial}/storage/soe
Stream energy storage state-of-energy updates.
subscribeStorageSoe 1 param body

Messages & Schemas 9

The contract defines 9 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

HomieState
message
HomieDescription
message
PanelPower
message
PanelMeter
message
RelayState
message
RelayStateSet
message
IslandingState
message
CircuitPower
message
StateOfEnergy
message

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

span-ebus-asyncapi.yml Raw ↑

Other APIs SPAN publishes across the network.

SPAN Auth API
SPAN Circuits API
SPAN Islanding State API
SPAN Panel API
SPAN Spaces API
SPAN Status API
SPAN Storage API
SPAN Wifi API
Where this information came from

This is an independent, third-party profile of SPAN eBus MQTT API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.