Ingen endring fra 3.2
High-level view of communication
...
RuterSalg both consumes and produces MQTT messages on the local MQTT broker in the vehicle. The schemas are documented externally for ADT 2.x and ADT 3.x, but we will here describe which topics RuterSalg consume, and how they are utilized, and which topics we produce.
ADT 3.3
Consumed:
Local Topic | Data | Direction | Link | Description |
---|---|---|---|---|
operational/assignment/attempt/request | OUT | signOff → code: FINISHED | ||
pe/sales/current_stop | A variety of data needed by the RuterSalg app | IN | With ADT 3, the RuterSalg backend starts producing a topic sent to the vehicle, containing a variety of data that is used by the app, like the current stop and zone, NEXT stop and zone, lineId and chainId. RuterSalg uses this topic from version 2.6 | |
pe/vehicle/api | ADT-version, VIN | IN |
Produced:
Local topic | Remote topic | Link | Description |
---|---|---|---|
pe/sales/diagnostics | ruter/<sender>/<vehicleRef>/adt/v3/pe/sales/diagnostics | Primary use: This topic is intended for health status for the RuterSalg application on each vehicle. The health status is intended both as a real time surveillance of health status for each individual bus as well as aggregating data per operator to see larger, more general issues. The topic can also, when enriched with other data, determine whether or not RuterSalg was used and working on a specific departure. Failure to have a working sales setup during a journey constitutes an SLA breach. Possible secondary use: This topic may also be used by the operators to quickly discover issues with their own devices, as well as getting a general fleet-wide status if aggregated. | |
pe/sales/sla | ruter/<sender>/<vehicleRef>/adt/v3/pe/sales/sla | New topic in ADT 3.3. Up until 3.3 we have been using the loggedIn field in the diagnostics message to measure whether the driver has logged onto the TETSalg app, but having an internal MQTT topic as basis for SLA measurements is not ideal. We have therefore created a new external message which will follow normal ADT versioning and restrictions as the basis for measurements. The loggedIn field will still exist in the diagnostics messages, but will no longer be used for SLA measurement. |
(The rest of this document is deprecated and will be removed from ADT v4)
ADT 2.x
Consumed:
Local Topic | Data | Direction | Link | Description |
---|---|---|---|---|
di/assignment_attempt/block | VIN | OUT | assignmentType: SIGNON assignmentType: SIGNOFF | |
|
|
|
This has been replaced by oi/current_vehicle_journey/expected_call (see below). No longer needed. | |
pe/dpi/journey | sorted list of next stops (stopPlaceId) | IN | List of stop places: journeyRef: | |
oi/current_vehicle_journey/expected_call | Next quay | IN | In early 2022 we were told that the nextstop topic would be deprecated and that the data we needed would be available in expected_call. We changed RuterSalg to first handle both nextstop and expected_call, and later to no longer consume nextstop. This now has the same function as nextstop did before. | |
pe/vehicle/api | ADT-version | IN | The sales app uses this topic to determine which ADT version the vehicle uses. |
Produced:
Local topic | Remote topic | Link | Description |
---|---|---|---|
pe/sales/diagnostics | ruter/<sender>/<vehicleRef>/pe/sales/diagnostics | Primary use: This topic is intended for health status for the RuterSalg application on each vehicle. The health status is intended both as a real time surveillance of health status for each individual bus as well as aggregating data per operator to see larger, more general issues. The topic can also, when enriched with other data, determine whether or not RuterSalg was used and working on a specific departure. Failure to have a working sales setup during a journey constitutes an SLA breach. Possible secondary use: This topic may also be used by the operators to quickly discover issues with their own devices, as well as getting a general fleet-wide status if aggregated. | |
pe/sales/saleresult | ruter/<sender>/<vehicleRef>/pe/sales/saleresult | No longer in use by Ruter | |
pe/sales/validationresult | ruter/<sender>/<vehicleRef>/pe/sales/validationresult | No longer in use by Ruter |
ADT 3.x
Consumed:
...
Local Topic
...
Data
...
Direction
...
Link
...
Description
...
operational/assignment/attempt/request
...
OUT
...
...
signOff → code: FINISHED
When this message is received, the user is automatically logged out of RuterSalg if manual log out has not already been performed
...
pe/sales/current_stop
...
A variety of data needed by the RuterSalg app
...
IN
...
...
With ADT 3, the RuterSalg backend starts producing a topic sent to the vehicle, containing a variety of data that is used by the app, like the current stop and zone, NEXT stop and zone, lineId and chainId.
RuterSalg uses this topic from version 2.6
...
pe/vehicle/api
...
ADT-version, VIN
...
IN
...
...