Skip to content

Commit 94ccf85

Browse files
authored
Clarify IDs for VCU communication
1 parent 3337323 commit 94ccf85

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

modules/ROOT/pages/ids-and-definitions.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,17 @@ The agrirouter API uses several IDs, which can be a little confusing. But don’
2222
|A UUID representing a Certification for one app. An app has to be certified every time, a new version with changed capabilities against agrirouter are implemented.
2323

2424
|deviceAlternateId
25-
|The Id of the endpoint of an application instance. It’s used to address the outbox and inbox.
26-
25+
|The Id of the endpoint of an application instance. +
26+
For communication _on behalf_ of a VCU, this is the *owning telemetry platform's* endpoint Id.
2727
|endpointId
2828
|The endpointId is the unique address of an Application Instance on the agrirouter. It's used to directly address an endpoint from a different endpoint and to mark the source of a message.
2929

3030
|gatewayId
3131
|This is a simple enumeration to determine the protocol type of the communication. It’s either 2=MQTT or 3=REST
3232

3333
|sensorAlternateId
34-
|The endpointId equals the sensorAlternateId
34+
|The endpointId equals the sensorAlternateId. +
35+
For communication _on behalf_ of a VCU, this is the *VCU's endpoint Id*.
3536

3637
|======================================================================================================================================================================================================
3738

0 commit comments

Comments
 (0)