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

Documentation update

parent 1b1823a1

docs/AVP-Commons-PDU-Descriptions.md→docs/AVP-Commons.md

+1 −1
Original line number Diff line number Diff line 
# <a name="AVP-Commons-PDU-Descriptions"></a>ASN.1 module AVP-Commons-PDU-Descriptions

# <a name="AVP-Commons"></a>ASN.1 module AVP-Commons

OID: _{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) avpCommons (5) major-version-1 (1) minor-version-1(1) }_



## Data Elements:

docs/PCIM-PDU-Descriptions.md

+22 −22
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
OID: _{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) pcim (6) major-version-1 (1) minor-version-1 (1) }_



## Imports:

* **[AVP-Commons-PDU-Descriptions](AVP-Commons-PDU-Descriptions.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) avpCommons (5) major-version-1 (1) minor-version-1(1) }*<br/>

* **[AVP-Commons](AVP-Commons.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) avpCommons (5) major-version-1 (1) minor-version-1(1) }*<br/>

* **[ETSI-ITS-CDD](ETSI-ITS-CDD.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) 102894 cdd (2) major-version-3 (3) minor-version-1 (1) }*<br/>

## Data Elements:

### <a name="PCIM"></a>PCIM
@@ -13,7 +13,7 @@ This type represents the PCIM PDU. 
* _header_ of type [**ItsPduHeader**](ETSI-ITS-CDD.md#ItsPduHeader) <br>

  the header of the PCIM PDU.



* _e2eProtection_ of type [**ParkingControlE2EProtection**](AVP-Commons-PDU-Descriptions.md#ParkingControlE2EProtection) <br>

* _e2eProtection_ of type [**ParkingControlE2EProtection**](AVP-Commons.md#ParkingControlE2EProtection) <br>

  A mandatory container for E2E Protection by Autosar Profile 4



* _pcim_ of type [**Pcim**](#Pcim) <br>
@@ -48,21 +48,21 @@ This type represents the VehicleContainer. 


 It shall include the following components:



* _checksum_ of type [**UInt32**](AVP-Commons-PDU-Descriptions.md#UInt32)  OPTIONAL<br>

* _checksum_ of type [**UInt32**](AVP-Commons.md#UInt32)  OPTIONAL<br>

  the VehicleContainer checksum of a single vehicle.



* _msgGenerationTime_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts)  OPTIONAL<br>

  the time at which the vehicle container was fully assembled.



* _sessionID_ of type [**SessionMissionID**](AVP-Commons-PDU-Descriptions.md#SessionMissionID) <br>

* _sessionID_ of type [**SessionMissionID**](AVP-Commons.md#SessionMissionID) <br>

  It is a unique identifier that is known by the infrastructure and 

          the vehicle side at the same time. It is valid for a complete parking/marshalling task.



* _missionID_ of type [**SessionMissionID**](AVP-Commons-PDU-Descriptions.md#SessionMissionID)  OPTIONAL<br>

* _missionID_ of type [**SessionMissionID**](AVP-Commons.md#SessionMissionID)  OPTIONAL<br>

  It is a unique identifier that is known by the infrastructure and 

          the vehicle side at the same time. It identifies a subtask within a sessionID.



* _rollingCounterFromPcvm_ of type [**RollingCounter**](AVP-Commons-PDU-Descriptions.md#RollingCounter) <br>

* _rollingCounterFromPcvm_ of type [**RollingCounter**](AVP-Commons.md#RollingCounter) <br>

  It serves as a mirror of the rolling counter that was 

          received with the latest PCVM of the corresponding vehicle.
@@ -89,7 +89,7 @@ This type represents the VehicleContainer. 
* _controlInterface_ of type [**ControlInterface**](#ControlInterface) <br>

  This container offers different control methods for vehicle motion control VMC as a choice between .



* _oemSpecific_ of type [**OEMSpecificData**](AVP-Commons-PDU-Descriptions.md#OEMSpecificData)  OPTIONAL<br>

* _oemSpecific_ of type [**OEMSpecificData**](AVP-Commons.md#OEMSpecificData)  OPTIONAL<br>

* OEMSpecificData<br>

  This data element defines optionally 2 bytes are used to carry

          specific information or request from an RVO system to a specific OEM vehicle.
@@ -133,11 +133,11 @@ This type represents the container with data elements for the blinking vehicle i 


 It shall include the following components:



* _vidRvoPublicKey_ of type [**UInt64**](AVP-Commons-PDU-Descriptions.md#UInt64) <br>

* _vidRvoPublicKey_ of type [**UInt64**](AVP-Commons.md#UInt64) <br>

  A 64-bit public key is transmitted from the RVO to the vehicle

          in order to derive the vehicle identification secret.



* _codeLength_ of type [**UInt8**](AVP-Commons-PDU-Descriptions.md#UInt8) <br>

* _codeLength_ of type [**UInt8**](AVP-Commons.md#UInt8) <br>

  The codelength data element sends a value that indicates how many bits (8 - 20)

          from the seed shall be used for generating the blinking pattern.
@@ -166,13 +166,13 @@ This type represents the container with data elements for the vehicle obtaining 
* _velocityMax_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

  During the allowed expiration time the vehicle shall not exceed the velocityMax speed value in forward as well in reverse driving conditions.



* _curvatureMin_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _curvatureMin_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  During the allowed expiration time the vehicle steering system shall not exceed the limits of interval given by data element curvatureMin.



* _curvatureMax_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _curvatureMax_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  During the allowed expiration time the vehicle steering system shall not exceed the limits of interval given by data element curvatureMax.



* _checksum_ of type [**UInt32**](AVP-Commons-PDU-Descriptions.md#UInt32)                       <br>

* _checksum_ of type [**UInt32**](AVP-Commons.md#UInt32)                       <br>

  The driving permission needs to be protected by a dedicated safety checksum.



```asn1
@@ -190,10 +190,10 @@ This type represents the container with data elements for requesting a safety ti 


 It shall include the following components:



* _challenge_ of type [**UInt16**](AVP-Commons-PDU-Descriptions.md#UInt16) <br>

* _challenge_ of type [**UInt16**](AVP-Commons.md#UInt16) <br>

  The Remote Vehicle Operation shall use this challenge to relate the response to this request. This challenge is chosen by the RVO in accordance with the safety requirements. 



* _checksum_ of type [**UInt32**](AVP-Commons-PDU-Descriptions.md#UInt32) <br>

* _checksum_ of type [**UInt32**](AVP-Commons.md#UInt32) <br>

  This safety time synchronization needs to be protected by a dedicated safety checksum.



```asn1
@@ -216,7 +216,7 @@ This type represents the container with data elements for general drive commands 
* _terminateReason_ of type [**TerminateReasonEnum**](#TerminateReasonEnum) <br>

  If action equals terminate, indicates whether a terminate is requested because the vehicle reached the destination or because of an error.



* _selectGear_ of type [**GearEnum**](AVP-Commons-PDU-Descriptions.md#GearEnum)  OPTIONAL<br>

* _selectGear_ of type [**GearEnum**](AVP-Commons.md#GearEnum)  OPTIONAL<br>

  It describes the desired driving direction of the vehicle in alignment with the signed value of the vehicle speed requests.



* _directionIndicator_ of type [**VehicleDirIndicatorEnum**](#VehicleDirIndicatorEnum) <br>
@@ -250,7 +250,7 @@ This type represents the container with a report of the vehicle's localization. 


 It shall include the following components:



* _detectedPose_ of type [**Pose**](AVP-Commons-PDU-Descriptions.md#Pose) <br>

* _detectedPose_ of type [**Pose**](AVP-Commons.md#Pose) <br>

  This field implements the sequence of data elements for the vehicle' positioning. The pointed reference is the middle of the rear axle.   



* _poseMeasurementTime_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts) <br>
@@ -301,16 +301,16 @@ This type represents the container with elements describing a way point, 


 It shall include the following components:



* _index_ of type [**WaypointIndex**](AVP-Commons-PDU-Descriptions.md#WaypointIndex) <br>

* _index_ of type [**WaypointIndex**](AVP-Commons.md#WaypointIndex) <br>

  It is used to build an array of consecutive way points.



* _wayPointPose_ of type [**Pose**](AVP-Commons-PDU-Descriptions.md#Pose) <br>

* _wayPointPose_ of type [**Pose**](AVP-Commons.md#Pose) <br>

  This field implements the positioning request to the vehicle. The pointed reference is the middle of the rear axle.  



* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

  This data element represents the target speed of the vehicle in that specific way point.



* _curvature_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _curvature_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  This data element represents the target curvature of the vehicle in that specific way point.



It is a signed velocity value compliant with the drive direction request. Positive: drive forwards / Negative: reverse.
@@ -360,7 +360,7 @@ A ControlPoint container carries a set of ControlPoint elements, 


 It shall include the following components:



* _curvature_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _curvature_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  The data element contains the target curvature that is requested in the according control Poiint



* _controlParameter_ of type [**ControlParameter**](#ControlParameter) <br>
@@ -404,7 +404,7 @@ The ControlVelocity container consists of 2 data elements belonging to the accor 
* _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. 



* _distanceToStop_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre)  OPTIONAL			<br>

* _distanceToStop_ of type [**Centimetre**](AVP-Commons.md#Centimetre)  OPTIONAL			<br>

  The data element represents the maximum distance that the vehicle can drive before a standstill. 



```asn1
@@ -424,7 +424,7 @@ A StatePoint container carries a set of SatePoint elements, 


 It shall include the following components:



* _statePose_ of type [**Pose**](AVP-Commons-PDU-Descriptions.md#Pose) <br>

* _statePose_ of type [**Pose**](AVP-Commons.md#Pose) <br>

  This field implements the sequence of data elements for the vehicle' positioning in the according statePoint. The pointed reference is the middle of the rear axle.



* _velocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

docs/PCVM-PDU-Descriptions.md

+27 −27
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
OID: _{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) pcvm (4) major-version-1 (1) minor-version-1(1) }_



## Imports:

* **[AVP-Commons-PDU-Descriptions](AVP-Commons-PDU-Descriptions.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) avpCommons (5) major-version-1 (1) minor-version-1(1) }*<br/>

* **[AVP-Commons](AVP-Commons.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) ts (103882) avpCommons (5) major-version-1 (1) minor-version-1(1) }*<br/>

* **[ETSI-ITS-CDD](ETSI-ITS-CDD.md)** *{ itu-t (0) identified-organization (4) etsi (0) itsDomain (5) wg1 (1) 102894 cdd (2) major-version-3 (3) minor-version-1 (1) }*<br/>

## Data Elements:

### <a name="PCVM"></a>PCVM
@@ -13,7 +13,7 @@ This type represents the PCVM PDU. 
* _header_ of type [**ItsPduHeader**](ETSI-ITS-CDD.md#ItsPduHeader) <br>

  The header of the PCVM PDU.



* _e2eProtection_ of type [**ParkingControlE2EProtection**](AVP-Commons-PDU-Descriptions.md#ParkingControlE2EProtection) <br>

* _e2eProtection_ of type [**ParkingControlE2EProtection**](AVP-Commons.md#ParkingControlE2EProtection) <br>

  A mandatory container for E2E Protection by Autosar Profile 4.



* _pcvm_ of type [**Pcvm**](#Pcvm) <br>
@@ -35,13 +35,13 @@ This type represents the optional container added to the PCVM message mainly as 
* _msgGenerationTime_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts)  OPTIONAL<br>

  Represents the time when the PCVM was genaerated.   



* _sessionID_ of type [**SessionMissionID**](AVP-Commons-PDU-Descriptions.md#SessionMissionID) <br>

* _sessionID_ of type [**SessionMissionID**](AVP-Commons.md#SessionMissionID) <br>

  Represents a 32 character session ID.   				



* _missionID_ of type [**SessionMissionID**](AVP-Commons-PDU-Descriptions.md#SessionMissionID)  OPTIONAL<br>

* _missionID_ of type [**SessionMissionID**](AVP-Commons.md#SessionMissionID)  OPTIONAL<br>

  Represents a 32 character mission ID.



* _rollingCounterFromPcim_ of type [**RollingCounter**](AVP-Commons-PDU-Descriptions.md#RollingCounter) <br>

* _rollingCounterFromPcim_ of type [**RollingCounter**](AVP-Commons.md#RollingCounter) <br>

  Represents the rolling counter of last received PCIM.



* _vehicleState_ of type [**VehicleState**](#VehicleState) <br>
@@ -68,7 +68,7 @@ This type represents the optional container added to the PCVM message mainly as 
* _vehicleProperties_ of type [**VehicleProperties**](#VehicleProperties)  OPTIONAL<br>

  Represents vehicle-specific data elements as feedback from vehicle to external system.



* _oemSpecific_ of type [**OEMSpecificData**](AVP-Commons-PDU-Descriptions.md#OEMSpecificData)  OPTIONAL<br>

* _oemSpecific_ of type [**OEMSpecificData**](AVP-Commons.md#OEMSpecificData)  OPTIONAL<br>

  Represents an OEM specific 16 bit field for special purposes.
@@ -102,22 +102,22 @@ This type represents the container theat carries signals about the actual status 
* _operationMode_ of type [**OperationModeEnum**](#OperationModeEnum) <br>

  The current operation mode or state of the vehicle.



* _gearSelected_ of type [**GearEnum**](AVP-Commons-PDU-Descriptions.md#GearEnum) <br>

* _gearSelected_ of type [**GearEnum**](AVP-Commons.md#GearEnum) <br>

  Direction in which the vehicle is currently driving or about to drive.



* _currentVelocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

  Current vehicle velocity. Negative when driving backwards.



* _currentCurvature_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _currentCurvature_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  Current vehicle curvature.



* _secureStandstill_ of type **BOOLEAN** <br>

  True if the vehicle is currently in secure standstill (i.e. standstill and secured against rolling, even when vehicle is powered down and even on ramps).



* _idxLastWayPoint_ of type [**WaypointIndex**](AVP-Commons-PDU-Descriptions.md#WaypointIndex)  OPTIONAL<br>

* _idxLastWayPoint_ of type [**WaypointIndex**](AVP-Commons.md#WaypointIndex)  OPTIONAL<br>

  Index of last WayPoint that has been received from infrastucture. 0 if not applicable.



* _localizedPose_ of type [**Pose**](AVP-Commons-PDU-Descriptions.md#Pose)  OPTIONAL<br>

* _localizedPose_ of type [**Pose**](AVP-Commons.md#Pose)  OPTIONAL<br>

  The current vehicle pose estimated by the vehicle. (Usually close to the pose estimated by the GMS, prediction by the vehicle) 



```asn1
@@ -138,10 +138,10 @@ This type represents the optional container supporting a key exchange process th 


 It includes the following components:



* _vidVehicleState_ of type [**VidVehicleStateEnum**](AVP-Commons-PDU-Descriptions.md#VidVehicleStateEnum) <br>

* _vidVehicleState_ of type [**VidVehicleStateEnum**](AVP-Commons.md#VidVehicleStateEnum) <br>

  The current vehicle identification state.



* _vidVehiclePublicKey_ of type [**UInt64**](AVP-Commons-PDU-Descriptions.md#UInt64) <br>

* _vidVehiclePublicKey_ of type [**UInt64**](AVP-Commons.md#UInt64) <br>

  Public Key used by vehicle to derive vehicle identification secret.



```asn1
@@ -156,7 +156,7 @@ This type represents the optional container supporting the calculation of the IT 


 It includes the following components:



* _challenge_ of type [**UInt16**](AVP-Commons-PDU-Descriptions.md#UInt16) <br>

* _challenge_ of type [**UInt16**](AVP-Commons.md#UInt16) <br>

  Challenge received in the SafetyTimeSyncRequest message.



* _vehicleSafetyClockReceiveTimestamp_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts) <br>
@@ -165,7 +165,7 @@ This type represents the optional container supporting the calculation of the IT 
* _vehicleSafetyClockTransmitTimestamp_ of type [**TimestampIts**](ETSI-ITS-CDD.md#TimestampIts) <br>

  Time of the Vehicle Safety Clock when this response left for the RV.



* _checksum_ of type [**UInt32**](AVP-Commons-PDU-Descriptions.md#UInt32) <br>

* _checksum_ of type [**UInt32**](AVP-Commons.md#UInt32) <br>

  See safety checksum calculation.



```asn1
@@ -185,7 +185,7 @@ This type represents the optional container supporting a safe confirmation by th 
* _vehicleType_ of type [**IA5String**](#IA5String)  (SIZE(1..32))<br>

  Vehicle type identifier.



* _checksum_ of type [**UInt32**](AVP-Commons-PDU-Descriptions.md#UInt32) <br>

* _checksum_ of type [**UInt32**](AVP-Commons.md#UInt32) <br>

  Safety checksum calculation.



```asn1
@@ -206,10 +206,10 @@ This type represents the optional container data carrier and is added to the PCV 
* _vehCode_ of type [**VehCodeEnum**](#VehCodeEnum) <br>

  Depending on the given error, the infrastructure either tries to resolve the issue or aborts the mission, saves this message for logging and forwards its content to the backend.



* _customCode_ of type [**UInt8**](AVP-Commons-PDU-Descriptions.md#UInt8) <br>

* _customCode_ of type [**UInt8**](AVP-Commons.md#UInt8) <br>

  Customer specific error code. The infrastructure won't further interpret this value.



* _description_ of type [**Description**](AVP-Commons-PDU-Descriptions.md#Description)  OPTIONAL<br>

* _description_ of type [**Description**](AVP-Commons.md#Description)  OPTIONAL<br>

  optional description of the error with further details.



```asn1
@@ -229,7 +229,7 @@ This type represents the optional container added to the PCVM message mainly for 
* _requestedVelocity_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

  The currently requested velocity sent to the vehicle. Negative when driving backwards.



* _requestedCurvature_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _requestedCurvature_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  The currently requested curvature sent to the vehicle.



* _powertrainActive_ of type **BOOLEAN** <br>
@@ -254,7 +254,7 @@ This type represents the optional container added to the PCVM message mainly as 


 It includes the following components:



* _remainingTimeToDrive_ of type [**Millisecond16**](AVP-Commons-PDU-Descriptions.md#Millisecond16) <br>

* _remainingTimeToDrive_ of type [**Millisecond16**](AVP-Commons.md#Millisecond16) <br>

  Represents the time which the vehicle is allowed to keep driving until brakes must be engaged. Signed value.



* _drivingAllowed_ of type **BOOLEAN** <br>
@@ -290,22 +290,22 @@ This type represents the optional container added to the PCVM message mainly as 
* _basicVehicleClass_ of type [**BasicVehicleClassEnum**](#BasicVehicleClassEnum) <br>

  It shares the vehicle class information to the RVO. 



* _vehicleLength_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleLength_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents the overall vehicle length in (cm).



* _vehicleWheelbase_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleWheelbase_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents the wheelbase value (cm).



* _vehicleRearOverhang_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleRearOverhang_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents the rear overhang value (cm). 



* _vehicleWidth_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleWidth_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents the overall vehicle width value (cm).  



* _vehicleTireWidth_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleTireWidth_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents a rough vehicle mass value imported fom the CDD.



* _vehicleTrackWidth_ of type [**Centimetre**](AVP-Commons-PDU-Descriptions.md#Centimetre) <br>

* _vehicleTrackWidth_ of type [**Centimetre**](AVP-Commons.md#Centimetre) <br>

  Represents the specified width of tires value (cm). 



* _vehicleMass_ of type [**VehicleMass**](ETSI-ITS-CDD.md#VehicleMass) <br>
@@ -314,10 +314,10 @@ This type represents the optional container added to the PCVM message mainly as 
* _vehicleSpeedLimit_ of type [**VelocityComponentValue**](ETSI-ITS-CDD.md#VelocityComponentValue) <br>

  Represents the limit value of the vehicle speed according to the use case, unit in (cm/s).   



* _vehicleCuvatureLimit_ of type [**HighResCurvature**](AVP-Commons-PDU-Descriptions.md#HighResCurvature) <br>

* _vehicleCuvatureLimit_ of type [**HighResCurvature**](AVP-Commons.md#HighResCurvature) <br>

  Represents the maximum curvature for left and right turning (assumed symmetrical).



* _vehicleMaxAngularSteeringRate_ of type [**RadPerSecond**](AVP-Commons-PDU-Descriptions.md#RadPerSecond) <br>

* _vehicleMaxAngularSteeringRate_ of type [**RadPerSecond**](AVP-Commons.md#RadPerSecond) <br>

  Represents maximum steering rate for automated operation (rate of road wheel angle).