Skip to content

Commit

Permalink
Add missing configuration docu
Browse files Browse the repository at this point in the history 
...for new options concerning the removal of unsupported fields from 
order messages.

Merged-by: Stefan Walter <stefan.walter@iml.fraunhofer.de>
  • Loading branch information
@sebo001 @swltr
sebo001 authored and swltr committed Jul 18, 2024
1 parent d265c88 commit 89903cb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions doc/v1.1/configuration.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,9 @@ For details regarding the functionality behind this property, see the 'Movement
The property value contains a padding distance in m, which is added when a node's deviation range is extended to include the vehicle position.
If the value is negative, it is instead replaced with zero.
(Default value: `0.01`.)
`vda5050:optionalParams.order` (prefix, optional)::
Property keys that start with this prefix should be extended by the path to the optional field in the order message separated by dots.
The property value contains the support status for the optional field, which can be `REQUIRED`, `SUPPORTED`, or `NOT_SUPPORTED`.
(Default value: `SUPPORTED`)

NOTE: If any of the required properties are not set or contain unusable data, the driver may fail to be instantiated for / attached to the vehicle.
2 changes: 1 addition & 1 deletion doc/v1.1/runtime-behaviour.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The general behaviour with sending order messages is the following:
* The order messages sent by this vehicle driver contain both the _base_ and the _horizon_ of the vehicle's route.
How many steps of the route are sent as _base_ and _horizon_ can be configured using the vehicle properties `vda5050:maxStepsBase` and `vda5050:maxStepsHorizon` -- see xref:configuration.adoc[].
* VDA5050 order messages have fields that are optional, and order messages sent to a vehicle should not contain any optional fields that are not supported by that vehicle.
The support status for optional fields can be set via vehicle properties by using the prefix `vda5050:optionalParams` followed by the path to the optional field in the order message separated by dots.
The support status for optional fields can be set via vehicle properties by using the prefix `vda5050:optionalParams.order` followed by the path to the optional field in the order message separated by dots.
The possible values are `REQUIRED`, `SUPPORTED` and `NOT_SUPPORTED`, with all optional fields being considered to be `SUPPORTED` by default.
For example, setting the optional field `allowedDeviationTheta` in `order/nodes/nodePosition` as not supported would require you to set the vehicle property `vda5050:optionalParams.order.nodes.nodePosition.allowedDeviationTheta` to the value `NOT_SUPPORTED`.
* The vehicle driver sends the next order message (for the next step on the vehicle's route) only after a state message from the vehicle indicates that it has received the previous order message (by reflecting the order message's `orderId` and `orderUpdateId`.)
Expand Down
4 changes: 4 additions & 0 deletions doc/v2.0/configuration.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,9 @@ For details regarding the functionality behind this property, see the 'Movement
The property value contains a padding distance in m, which is added when a node's deviation range is extended to include the vehicle position.
If the value is negative, it is instead replaced with zero.
(Default value: `0.01`.)
`vda5050:optionalParams.order` (prefix, optional)::
Property keys that start with this prefix should be extended by the path to the optional field in the order message separated by dots.
The property value contains the support status for the optional field, which can be `REQUIRED`, `SUPPORTED`, or `NOT_SUPPORTED`.
(Default value: `SUPPORTED`)

NOTE: If any of the required properties are not set or contain unusable data, the driver may fail to be instantiated for / attached to the vehicle.
2 changes: 1 addition & 1 deletion doc/v2.0/runtime-behaviour.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The general behaviour with sending order messages is the following:
* The order messages sent by this vehicle driver contain both the _base_ and the _horizon_ of the vehicle's route.
How many steps of the route are sent as _base_ and _horizon_ can be configured using the vehicle properties `vda5050:maxStepsBase` and `vda5050:maxStepsHorizon` -- see xref:configuration.adoc[].
* VDA5050 order messages have fields that are optional, and order messages sent to a vehicle should not contain any optional fields that are not supported by that vehicle.
The support status for optional fields can be set via vehicle properties by using the prefix `vda5050:optionalParams` followed by the path to the optional field in the order message separated by dots.
The support status for optional fields can be set via vehicle properties by using the prefix `vda5050:optionalParams.order` followed by the path to the optional field in the order message separated by dots.
The possible values are `REQUIRED`, `SUPPORTED` and `NOT_SUPPORTED`, with all optional fields being considered to be `SUPPORTED` by default.
For example, setting the optional field `allowedDeviationTheta` in `order/nodes/nodePosition` as not supported would require you to set the vehicle property `vda5050:optionalParams.order.nodes.nodePosition.allowedDeviationTheta` to the value `NOT_SUPPORTED`.
* The vehicle driver sends the next order message (for the next step on the vehicle's route) only after a state message from the vehicle indicates that it has received the previous order message (by reflecting the order message's `orderId` and `orderUpdateId`.)
Expand Down

0 comments on commit 89903cb

Please sign in to comment.