Skip to content

Getting data via WebSocket protocol#

To obtain information about events and incidents using the web socket protocol, you can use the tool built into LUNA CARS_Analytics — Swagger REST-API Cars Analytics Backend (Figure 9).

The web interface with the available REST-API methods is located at the link below.

http://IP_ADDRESS:ANALYTICS_FRONTEND_PORT/docs
  • IP_ADDRESS — IP address of the target server where the LUNA CARS product is installed;
  • ANALYTICS_FRONTEND_PORT — port for connecting to the frontend component of CARS_Analytics (default value is 8080, for more details see the CARS_INSTALLER_Installation_Manual, Appendix 1. Settings of «.env-vanilla» file).
Swagger page view
Figure 9. Swagger page view

In the WebSocket section there are two sections available for receiving data using GET requests (Figure 10)

  • /ws/cars/1/0/events — getting scenarios data with the Event type;
  • /ws/cars/1/0/incidents — getting scenarios data with the Incident type;
View of the WebSocket section
Figure 10. View of the WebSocket section