The message schema to communicate orders from fleet control to the mobile robot.

Hierarchy

  • Order

Indexable

[property: string]: any

Properties

edges: V3_0.Edge[]

Directional connection between two nodes. Array of edge objects to be traversed for fulfilling the order. One node is enough for a valid order. Leave edge list empty for that case.

headerId: number

headerId of the message. The headerId is defined per topic and incremented by 1 with each sent (but not necessarily received) message.

manufacturer: string

Manufacturer of the mobile robot

nodes: V3_0.Node[]

Array of nodes objects to be traversed for fulfilling the order. One node is enough for a valid order. Leave edge list empty for that case.

orderDescription?: string

Additional human-readable information only for visualization purposes; this shall not be used for any logical processes.

orderId: string

Order Identification. This is to be used to identify multiple order messages that belong to the same order.

orderUpdateId: number

Order update identification. It is unique per orderId, starting at 0 for a new order. If an order update is rejected, this field shall be passed in the rejection message.

serialNumber: string

Serial number of the mobile robot.

timestamp: string

Timestamp in ISO8601 format (YYYY-MM-DDTHH:mm:ss.fffZ).

version: string

Version of the protocol [Major].[Minor].[Patch]

Generated using TypeDoc