Commit e297256a authored by ASN.1 Checker's avatar ASN.1 Checker
Browse files

Documentation update

parent 179427c2
Loading
Loading
Loading
Loading
+33 −36
Original line number Original line Diff line number Diff line
@@ -34,6 +34,8 @@ This type represents the Mim Container.
 It shall include the following components:
 It shall include the following components:


* _mimDataControlField_ of type [**MIMDataControlField**](#MIMDataControlField)  OPTIONAL<br>
* _mimDataControlField_ of type [**MIMDataControlField**](#MIMDataControlField)  OPTIONAL<br>
  a container of specific Control Data for MIM.

* _systemManagementData_ of type [**SystemManagementData**](AVM-Commons.md#SystemManagementData)  OPTIONAL<br>
* _systemManagementData_ of type [**SystemManagementData**](AVM-Commons.md#SystemManagementData)  OPTIONAL<br>
  a container of identification data
  a container of identification data


@@ -60,9 +62,6 @@ This type represents the Mim Container.
* _controlInterface_ of type [**ControlInterface**](#ControlInterface)  OPTIONAL<br>
* _controlInterface_ of type [**ControlInterface**](#ControlInterface)  OPTIONAL<br>
  This container offers different control methods for vehicle motion control VMC as a choice between .
  This container offers different control methods for vehicle motion control VMC as a choice between .


* MIMDataControlField<br>
  a container of specific Control Data for MIM.

```asn1
```asn1
Mim ::= SEQUENCE {
Mim ::= SEQUENCE {
  mimDataControlField MIMDataControlField OPTIONAL,
  mimDataControlField MIMDataControlField OPTIONAL,
@@ -294,15 +293,14 @@ The type PathControl sequeence represents the container with Path Snippet elemen
 It shall include the following components:
 It shall include the following components:


* _pathSnippet_ of type [**PathSnippet**](#PathSnippet)  OPTIONAL<br>
* _pathSnippet_ of type [**PathSnippet**](#PathSnippet)  OPTIONAL<br>
  a sequence of up to 200 way points

* _clearedDistanceOnPath_ of type [**Centimetre**](AVM-Commons.md#Centimetre) <br>
* _clearedDistanceOnPath_ of type [**Centimetre**](AVM-Commons.md#Centimetre) <br>
  the RVO can tell the vehicle to stop on the known PathSnippet without sending a new PathSnippet.
  the RVO can tell the vehicle to stop on the known PathSnippet without sending a new PathSnippet.


* _situationalVelocityLimit_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue)  OPTIONAL<br>
* _situationalVelocityLimit_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue)  OPTIONAL<br>
  the RVO can tell the vehicle to temporarily drive slower without sending a new PathSnippet. 
  the RVO can tell the vehicle to temporarily drive slower without sending a new PathSnippet. 


* Pathsnippet<br>
  a sequence of up to 200 way points

```asn1
```asn1
PathControl ::= SEQUENCE { 
PathControl ::= SEQUENCE { 
  pathSnippet PathSnippet OPTIONAL, 
  pathSnippet PathSnippet OPTIONAL, 
@@ -314,11 +312,7 @@ PathControl ::= SEQUENCE {
### <a name="PathSnippet"></a>PathSnippet
### <a name="PathSnippet"></a>PathSnippet
The type PathSnippet represents the container with Path Snippet elements.
The type PathSnippet represents the container with Path Snippet elements.


 It shall include the following components:
 It shall contain up to 200 way points of type [**WayPoint**](#WayPoint)

* WayPoint<br>
  a sequence of up to 200 way points

```asn1
```asn1
PathSnippet ::= SEQUENCE (SIZE(0..200)) OF WayPoint
PathSnippet ::= SEQUENCE (SIZE(0..200)) OF WayPoint
```
```
@@ -362,16 +356,17 @@ The type TrajectoryControl represents the container with elements for the trajec


* _timeReference_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts) <br>
* _timeReference_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts) <br>
  The reference time indicates the absolute time given in Vehicle Functional Clock 
  The reference time indicates the absolute time given in Vehicle Functional Clock 
   at which the first element of the ControlTrajectory vector and StateTrajectory vector is expected to be executed.
   at which the first element of the [**ControlTrajectory**](#ControlTrajectory) vector and [**StateTrajectory**](#StateTrajectory) vector is expected to be executed.


* _driveDirection_ of type [**DriveDirectionEnum**](#DriveDirectionEnum)  OPTIONAL<br>
* _driveDirection_ of type [**DriveDirectionEnum**](#DriveDirectionEnum)  OPTIONAL<br>
  The data element describes the desired driving direction of the vehicle in alignment with the signed value of the vehicle acceleration requests. 
  The data element describes the desired driving direction of the vehicle in alignment with the signed value of the vehicle acceleration requests. 


* _controlTrajectory_ of type [**ControlTrajectory**](#ControlTrajectory) <br>
* _controlTrajectory_ of type [**ControlTrajectory**](#ControlTrajectory) <br>
  This consists of a sequence of controlPoint containers with a maximum size of 50. 
  This consists of a sequence of [**ControlPoint**](#ControlPoint) elements with a maximum size of 50. 


* _stateTrajectory_ of type [**StateTrajectory**](#StateTrajectory)  OPTIONAL<br>
* _stateTrajectory_ of type [**StateTrajectory**](#StateTrajectory)  OPTIONAL<br>
  The elements in the optional field StateTrajectory vector are considered as odometry target values. These consist of a sequence of statePoint containers with a maximum size of 50.
  The elements in the optional field [**StateTrajectory**](#StateTrajectory) vector are considered as odometry target values.
          These consist of a sequence of [**StatePoint**](#StatePoint) elements with a maximum size of 50.


```asn1
```asn1
TrajectoryControl ::= SEQUENCE {
TrajectoryControl ::= SEQUENCE {
@@ -396,7 +391,7 @@ A ControlPoint container carries a set of ControlPoint elements,
  The data element contains the target curvature that is requested in the according control Poiint
  The data element contains the target curvature that is requested in the according control Poiint


* _controlParameter_ of type [**ControlParameter**](#ControlParameter) <br>
* _controlParameter_ of type [**ControlParameter**](#ControlParameter) <br>
  The field controlParameter selects the method how to represent a controlPoint container .
  This field selects the method how to represent a [**ControlPoint**](#ControlPoint) container .


```asn1
```asn1
ControlPoint ::= SEQUENCE {
ControlPoint ::= SEQUENCE {
@@ -406,7 +401,7 @@ ControlPoint ::= SEQUENCE {
```
```


### <a name="ControlParameter"></a>ControlParameter
### <a name="ControlParameter"></a>ControlParameter
The ControlParameter container offers two  options to represent the second parameter within a controlPoint, 
The ControlParameter container offers two  options to represent the second parameter within a [**ControlPoint**](#ControlPoint), 


 It shall include the following components:
 It shall include the following components:


@@ -414,7 +409,7 @@ The ControlParameter container offers two options to represent the second param
  The data element represents the vehicles's target acceleration in the according control point.
  The data element represents the vehicles's target acceleration in the according control point.


* _controlVelocity_ of type [**ControlVelocity**](#ControlVelocity) <br>
* _controlVelocity_ of type [**ControlVelocity**](#ControlVelocity) <br>
  The field controlVelocity is selected the according ControlPoint uses speed values instead of acceleration.
  Theis field is selected when the according [**ControlPoint**](#ControlPoint) uses speed values instead of acceleration.


```asn1
```asn1
ControlParameter ::= CHOICE {
ControlParameter ::= CHOICE {
@@ -424,20 +419,22 @@ controlVelocity ControlVelocity
```
```


### <a name="ControlAcceleration"></a>ControlAcceleration
### <a name="ControlAcceleration"></a>ControlAcceleration
The ControlAcceleration data element is a single data element when choosing the ControlParameter controlAcceleration
The [**ControlAcceleration**](#ControlAcceleration) data element is a single data element when choosing the [**ControlParameter**](#ControlParameter) controlAcceleration
 It deals with a signed acceleration value.
 It deals with a signed acceleration value.
```asn1
```asn1
ControlAcceleration ::= LongitudinalAccelerationValue
ControlAcceleration ::= LongitudinalAccelerationValue
```
```


### <a name="ControlVelocity"></a>ControlVelocity
### <a name="ControlVelocity"></a>ControlVelocity
The ControlVelocity container consists of 2 data elements belonging to the according controlPoint, 
The ControlVelocity container consists of 2 data elements belonging to the according [**ControlPoint**](#ControlPoint), 


 It includes the following components:
 It includes the following components:


* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>
* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>
  The data element represents the target speed of the vehicle. It is a signed velocity value. 
  The data element represents the target speed of the vehicle. It is a signed velocity value. 
   It deals with a signed velocity value. Positive: drive forwards / Negative: driving reverse.
   It deals with a signed velocity value.
   - Positive: drive forwards
   - Negative: driving reverse.


* _distanceToStop_ of type [**Centimetre**](AVM-Commons.md#Centimetre)  OPTIONAL<br>
* _distanceToStop_ of type [**Centimetre**](AVM-Commons.md#Centimetre)  OPTIONAL<br>
  The data element represents the unsigned maximum distance that the vehicle can drive before a standstill. 
  The data element represents the unsigned maximum distance that the vehicle can drive before a standstill. 
@@ -461,7 +458,7 @@ A StatePoint container carries a set of SatePoint elements,
 It shall include the following components:
 It shall include the following components:


* _statePose_ of type [**Pose**](AVM-Commons.md#Pose) <br>
* _statePose_ of type [**Pose**](AVM-Commons.md#Pose) <br>
  This field implements the sequence of data elements for the vehicle' positioning in the according statePoint. 
  This field implements the sequence of data elements for the vehicle's positioning in the according statePoint. 
   A point indicates an agreed reference point of the vehicle,e.g. the middle of the rear axle.
   A point indicates an agreed reference point of the vehicle,e.g. the middle of the rear axle.


* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>
* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>
@@ -478,10 +475,10 @@ StatePoint ::= SEQUENCE {
Data element DriveCommandActionEnum describes the current state in the vehicle identification process .
Data element DriveCommandActionEnum describes the current state in the vehicle identification process .
 It offers the following signal values:
 It offers the following signal values:
 
 
 - 0 - `sleep`		  - The vehicle is commanded to go into sleep mode for low power consumption.
 - 0 - `sleep`		- The vehicle is commanded to go into sleep mode for low power consumption
 - 1 - `initialize`	- The vehicle is awake and remains in standstill. It shall initialize and prepare for a driving job, including a sequence of power-on the engine system and the lights.  ,
 - 1 - `initialize`	- The vehicle is awake and remains in standstill. It shall initialize and prepare for a driving job, including a sequence of power-on the engine system and the lights,
 - 2 - `wait`			  - The vehicle shall wait in marshalling capable state.,
 - 2 - `wait`			- The vehicle shall wait in marshalling capable state,
 - 3 - `drive`		  - The vehicle is commanded to actively drive and follow the according control commands. Standstill and pause situations are potentially included in this stage. ,
 - 3 - `drive`		- The vehicle is commanded to actively drive and follow the according control commands. Standstill and pause situations are potentially included in this stage,
 - 4 - `terminate`	- The vehicle shall disable the according control interface. After brining the vehicle to a safe standstill state it shuts down as soon as possible.
 - 4 - `terminate`	- The vehicle shall disable the according control interface. After brining the vehicle to a safe standstill state it shuts down as soon as possible.
```asn1
```asn1
DriveCommandActionEnum ::= ENUMERATED {
DriveCommandActionEnum ::= ENUMERATED {
@@ -497,11 +494,11 @@ DriveCommandActionEnum ::= ENUMERATED {
Data element TerminateReasonEnum describes verbally the rational why to terminate the VMC process  .
Data element TerminateReasonEnum describes verbally the rational why to terminate the VMC process  .
 It offers the following signal values:
 It offers the following signal values:
 
 
 - 0 - `proceed`				- Everything is okay. Proceed, do not terminate. ,
 - 0 - `proceed`				- Everything is okay. Proceed, do not terminate,
 - 1 - `destination-reached`	- Vehicle has reached its destinations.  ,
 - 1 - `destination-reached`	- Vehicle has reached its destinations,
 - 2 - `infrastructure-error`	- Error in infrastructure detected. ,
 - 2 - `infrastructure-error`	- Error in infrastructure detected,
 - 3 - `vehicle-error`		- Vehicle has sent an error code. ,
 - 3 - `vehicle-error`		- Vehicle has sent an error code,
 - 4 - `backend`				- Error in backend. ,
 - 4 - `backend`				- Error in backend,
 - 5 - `vehicle-identification-error`   - Either a wrong or no code was detected. Even with a crash of the camera, there is an error.
 - 5 - `vehicle-identification-error`   - Either a wrong or no code was detected. Even with a crash of the camera, there is an error.
```asn1
```asn1
TerminateReasonEnum ::= ENUMERATED {
TerminateReasonEnum ::= ENUMERATED {
@@ -550,8 +547,8 @@ EmergencyStopEnum ::= ENUMERATED {
Data element InterlockEnum describes the status of vehicle interlock system during VMC .
Data element InterlockEnum describes the status of vehicle interlock system during VMC .
 It offers the following signal values:
 It offers the following signal values:
 
 
 - 0 - `none`				- The vehicle shall not use Interlock at this stage. ,
 - 0 - `none`				- The vehicle shall not use Interlock at this stage,
 - 1 - `zonal-interlock`	- Zonal Interlock is specific to the factory use case).  ,
 - 1 - `zonal-interlock`	- Zonal Interlock is specific to the factory use case,
 - 2 - `global-stop`		- Command for global stop - external operator intervention is required.
 - 2 - `global-stop`		- Command for global stop - external operator intervention is required.
```asn1
```asn1
InterlockEnum ::= ENUMERATED {
InterlockEnum ::= ENUMERATED {
+4 −4
Original line number Original line Diff line number Diff line
@@ -33,7 +33,7 @@ This type represents the optional container added to the MVM message mainly as a
 It includes the following components:
 It includes the following components:


* _mvmDataControlField_ of type [**MVMDataControlField**](#MVMDataControlField)  OPTIONAL<br>
* _mvmDataControlField_ of type [**MVMDataControlField**](#MVMDataControlField)  OPTIONAL<br>
  It contains specific Control Data for MVM   
  It contains specific Control Data for [**MVM**](#MVM)   


* _systemManagementData_ of type [**SystemManagementData**](AVM-Commons.md#SystemManagementData)  OPTIONAL<br>
* _systemManagementData_ of type [**SystemManagementData**](AVM-Commons.md#SystemManagementData)  OPTIONAL<br>
  It contains system management data, i.e. identification labels   				
  It contains system management data, i.e. identification labels   				
@@ -79,7 +79,7 @@ Mvm ::= SEQUENCE {
```
```


### <a name="MVMDataControlField"></a>MVMDataControlField
### <a name="MVMDataControlField"></a>MVMDataControlField
This type represents a container of specific Control Data for MVM.
This type represents a container of specific Control Data for [**MVM**](#MVM).


 It shall include the following components:
 It shall include the following components:


@@ -252,7 +252,7 @@ VehicleError ::= SEQUENCE {
```
```


### <a name="VehicleSafetyFeedback"></a>VehicleSafetyFeedback
### <a name="VehicleSafetyFeedback"></a>VehicleSafetyFeedback
Up to 20 VehicleSafetyFeedback containers for down to 5 ms monitoring, logging and debugging.
Up to 20 elements of [**VehicleSafetyFeedbackContainer**](#VehicleSafetyFeedbackContainer) for down to 5 ms monitoring, logging and debugging.
```asn1
```asn1
VehicleSafetyFeedback ::= SEQUENCE (SIZE(1..20)) OF VehicleSafetyFeedbackContainer
VehicleSafetyFeedback ::= SEQUENCE (SIZE(1..20)) OF VehicleSafetyFeedbackContainer
```
```
@@ -281,7 +281,7 @@ VehicleSafetyFeedbackContainer ::= SEQUENCE {
```
```


### <a name="SafetyViolationsContainer"></a>SafetyViolationsContainer
### <a name="SafetyViolationsContainer"></a>SafetyViolationsContainer
Up to 5 safety violations can be reported per cycle.
Up to 5 elements of [**SafetyViolationsEnum**](AVM-Commons.md#SafetyViolationsEnum) can be reported per cycle.
```asn1
```asn1
SafetyViolationsContainer ::= SEQUENCE (SIZE(0..5)) OF SafetyViolationsEnum
SafetyViolationsContainer ::= SEQUENCE (SIZE(0..5)) OF SafetyViolationsEnum
```
```
+23 −23

File changed.

Contains only whitespace changes.