Event types
The Energy Hub Alliance provides different event types to notify about the status of your devices and connections.
General information
There are three different ways streaming messages are triggered. The receival of streaming data by the partner is always handled in the same way. The Energy Hub Alliance will make sure that the vendor data is always up to date.
In case you feel that data of a device might be outdated, a data update can be requested manually. This function is triggered by calling e.g. Refresh vehicle data. In addition to the response of the API-request, this will also trigger a streaming message, if the device can be reached. The refresh endpoints should be used with caution, as it might trigger too many requests to the vendor API when used too excessively.
Message format
Kafka messages send to your Kafka Broker have the following format:
{subscriptionId}.{deviceType}.{eventType}
The subscriptionId is the ID of your subscription created in the partner portal. The deviceType is the type of the connected device or object, which can be either vehicle, tariff or hvac. The eventType is the action related to the message and described in more details below.
Supported event types
There are three main events types supported by the streaming service.
Connect
The connect event notifies if a new device has been connected to the Energy Hub Alliance.
Update
The connect event send the newest data of a device, when at least one data model property has changed. Use this event to recieve the latest device data.
Delete
The connect event notifies if a new device has been disconnected from the Energy Hub Alliance by the end-user or the partner.
Offline
The connect event notifies if a device has not been reachable for some time from and went offline.
Examples and data model
All message always send the full data model object of the related device type of the message. In case of the connect or delete message, the last know state of the device will be send.