Skip to content

Real time data

Kamea exposes data in real time through a websocket (WS) using the Socket.IO standard.

Note

For more information on Socket.IO, consult its official get started guide. This documentation will not cover the technical details of Socket.IO, but will focus on its usage to retrieve real-time data from Kamea.

Currently, the WS exposes this data for real-time consumption:

  • Telemetries

In the future, it will also expose:

  • States updates
  • Device connectivity status
  • Jobs progression
  • ...

Data sent through the WS will be distributed only once, when it is first generated by the platform. Since all data is available in at least one of the databases, it is always possible to retrieve it through an API call if the client was not connected to the WS when it was emitted.

The WS uses the same authorization mechanism as the API. So if a user has been granted access to read telemetry on a device, they can access its telemetry both through the API and the WS. On the other hand, if they are not allowed to access the data on the API, they will not be able to access it through the WS neither.

Consequently, Socket.IO can be used by any client in possession of a bearer token retrieved through the identity provider.

Even though the main client target for Socket.IO is web browsers, it is also available on most platforms: mobile applications, Node.JS, etc...

Technical details

To see how to subscribe to real-time data read this guide.