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

Documentation update

parent 1dcd8ebb

docs/AVM-Commons.md

+43 −47
Original line number Diff line number Diff line
@@ -98,7 +98,8 @@ Psi ::= INTEGER { 
    xDirection  (0), 

	  outOfRange  (62832),

    unavailable (62833)	

} (0..62833)

} 

(0..62833)

```



### <a name="Centimetre"></a>Centimetre
@@ -162,7 +163,8 @@ HighResCurvature ::= INTEGER { 
    straight           (0),

    outOfRangePositive (32767), 

    unavailable        (-32768)

} (-32768..32767)

} 

(-32768..32767)

```



### <a name="RadPerSecond"></a>RadPerSecond
@@ -186,7 +188,8 @@ RadPerSecond ::= INTEGER { 
    negativeOutOfRange (-32766), 

    positiveOutOfRange (32766), 

    unavailable        (-32767)

} (-32767..32766)

} 

(-32767..32766)

```



### <a name="Millisecond16"></a>Millisecond16
@@ -245,9 +248,6 @@ Data element MotorSystemEnum optionally describes the desired or system stae of 
 - 0 - `off`      - Propulsion motor  off 

 - 1 - `on`       - Propulsion motor on

 - 2 - `unknown`  - The propulsion motor state is unknown.



Values:

* **unknown** (2)<br>

```asn1

MotorSystemEnum ::= ENUMERATED {

  off(0),
@@ -262,21 +262,17 @@ Data element VidVehicleStateEnum describes the current state in the vehicle iden 
 

 - 0 - `undefined`                    - Default value ,

 - 1 - `ready`                        - Vehicle is ready to get flashing code ,

 - 2 - `lightflashing-inprogress`     - Vehicle flashing is in progress,

 - 3 - `lightflashing-completed`      - Flashing is finished,

 - 4 - `lightflashing-failed`         - This indicates that the vehicle can't flash because of vehicle error,

 - 2 - `lightFlashingInProgress`      - Vehicle flashing is in progress,

 - 3 - `lightFlashingCompleted`       - Flashing is finished,

 - 4 - `lightFlashingFailed`          - This indicates that the vehicle can't flash because of vehicle error,

 - 5 - `authorized`                   - Vehicle identification was successful and vehicle has switched its state.



Values:

* **lightflashing-inprogress** (2)<br>

* **lightflashing-failed** (4)<br>

```asn1

VidVehicleStateEnum ::= ENUMERATED {

  undefined(0),   

  ready(1),        

  lightflashing-inprogress (2), 

  lightflashing-completed(3),   

  lightflashing-failed (4),  

  lightFlashingInProgress(2), 

  lightFlashingCompleted(3),   

  lightFlashingFailed(4),  

  authorized(5)      

}

```
@@ -287,31 +283,31 @@ Data element SafetyViolationsEnum reports the outcome of a specific safety cycle 


 It offers the following signal values:

 

 - 0 - `no-violation`                         - Default value ,

 - 1 - `no-driving-permission-received`       - Vehicle has not received a driving permission ,

 - 2 - `last-driving-permission-too-old`      - The driving permission is outdated,

 - 3 - `crc-violation-clock-sync-response`    - The time synchronization response has an invalid checksum,

 - 4 - `crc-violation-driving-permission`     - The driving permission has an invalid checksum,

 - 5 - `expiration-time-violation`            - the allowed time is expired.

 - 6 - `driving-direction-mismatch`           - wrong driving direction is indcated, plausibility error with speed signal,

 - 7 - `velocity-violation`                   - The speed value is out of the allowed range ,

 - 8 - `curvature-min-violation`              - The allowed minimal curvature is out of range ,

 - 9 - `curvature-max-violation`              - The allowed maximal curvature is out of range ,

 - 10 - `expiration-time-too-high`            - The experiation time is out of the allowed range,

 - 0 - `noViolation`                         - Default value ,

 - 1 - `noDrivingPermissionReceived`         - Vehicle has not received a driving permission ,

 - 2 - `lastDrivingPermissionTooOld`         - The driving permission is outdated,

 - 3 - `crcViolationClockSyncRequest`        - The time synchronization request has an invalid checksum,

 - 4 - `crcViolationDrivingPermission`       - The driving permission has an invalid checksum,

 - 5 - `expirationTimeViolation`             - the allowed time is expired.

 - 6 - `drivingDirectionMismatch`            - wrong driving direction is indcated, plausibility error with speed signal,

 - 7 - `velocityViolation`                   - The speed value is out of the allowed range ,

 - 8 - `curvatureMinViolation`               - The allowed minimal curvature is out of range ,

 - 9 - `curvatureMaxViolation`               - The allowed maximal curvature is out of range ,

 - 10 - `expirationTimeTooHigh`              - The experiation time is out of the allowed range,

 - 11 - `monitoring`                         - Violation monitoring is ongoing.

```asn1

SafetyViolationsEnum ::= ENUMERATED {

  no-violation(0),

  no-driving-permission-received(1),

  last-driving-permission-too-old(2),

  crc-violation-clock-sync-request(3),

  crc-violation-driving-permission(4),

  expiration-time-violation(5),

  driving-direction-mismatch(6),

  velocity-violation(7),

  curvature-min-violation(8),

  curvature-max-violation(9),

  expiration-time-too-high(10),

  noViolation(0),

  noDrivingPermissionReceived(1),

  lastDrivingPermissionTooOld(2),

  crcViolationClockSyncRequest(3),

  crcViolationDrivingPermission(4),

  expirationTimeViolation(5),

  drivingDirectionMismatch(6),

  velocityViolation(7),

  curvatureMinViolation(8),

  curvatureMaxViolation(9),

  expirationTimeTooHigh(10),

  monitoring(11),

  ...

}

docs/MIM-PDU-Descriptions.md

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



## Imports:

* **[AVM-Commons](AVM-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) } WITH SUCCESSORS*<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-4 (4) minor-version-1 (1) } WITH SUCCESSORS*<br/>

* **[AVM-Commons](AVM-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-4 (4) minor-version-1 (1) }*<br/>

## Data Elements:

### <a name="MIM"></a>MIM

This type represents the MIM PDU.
@@ -495,19 +495,19 @@ Data element TerminateReasonEnum describes verbally the rational why to terminat 
 It offers the following signal values:

 

 - 0 - `proceed`				- Everything is okay. Proceed, do not terminate,

 - 1 - `destination-reached`	- Vehicle has reached its destinations,

 - 2 - `infrastructure-error`	- Error in infrastructure detected,

 - 3 - `vehicle-error`		- Vehicle has sent an error code,

 - 1 - `destinationReached`	- Vehicle has reached its destinations,

 - 2 - `infrastructureError`	- Error in infrastructure detected,

 - 3 - `vehicleError`		- Vehicle has sent an error code,

 - 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 - `vehicleIdentificationError`   - Either a wrong or no code was detected. Even with a crash of the camera, there is an error.

```asn1

TerminateReasonEnum ::= ENUMERATED {

  proceed(0),               

  destination-reached(1),   

  infrastructure-error(2),   

  vehicle-error(3),         

  destinationReached(1),   

  infrastructureError(2),   

  vehicleError(3),         

  backend(4),

  vehicle-identification-error(5)                

  vehicleIdentificationError(5)                

}

```
@@ -531,14 +531,14 @@ Data element EmergencyStopEnum describes the status of the EmergencyStop Request 
 - 0 - `inactive`		- The vehicle shall not use EmergencyStop at this stage. ,

 - 1 - `precharge`	- The vehicle brake  system shall stay in standby (brake prefill) and wait for an active command.  ,

 - 2 - `active`		  - The vehicle shall initiate an emergency stop using the maximum possible deceleration. ,

 - 3 - `temp-error`	- Maturing Failures - Vehicle shall decellerate and hold, it is waiting for the failure to clear or mature. ,

 - 3 - `tempError`	- Maturing Failures - Vehicle shall decellerate and hold, it is waiting for the failure to clear or mature. ,

 - 4 - `suspend`		- Command for critical failures (not recoverable) in RVO system – The vehicle shall decelerate and secure.

```asn1

EmergencyStopEnum ::= ENUMERATED {

  inactive(0),   	 

  precharge(1),  	

  active(2),      	

  temp-error(3),	

  temError(3),	

  suspend(4)		

}

```
@@ -548,13 +548,13 @@ Data element InterlockEnum describes the status of vehicle interlock system duri 
 It offers the following signal values:

 

 - 0 - `none`				    - The vehicle shall not use Interlock at this stage,

 - 1 - `zonal-interlock`	- Zonal Interlock is specific to the factory use case,

 - 2 - `global-stop`		- Command for global stop - external operator intervention is required.

 - 1 - `zonalInterlock`	- Zonal Interlock is specific to the factory use case,

 - 2 - `globalStop`		  - Command for global stop - external operator intervention is required.

```asn1

InterlockEnum ::= ENUMERATED {

  none(0),   			 

  zonal-interlock(1),  	

  global-stop(2)      	  

  zonalInterlock(1),  	

  globalStop(2)      	  

}

```
@@ -563,15 +563,15 @@ Data element VehicleHornRequestEnum describes the use of vehicle alarm horn duri 
 It offers the following signal values:

 

 - 0 - `none`				  - The vehicle does not sound a horn at this stage. ,

 - 1 - `single-horn`		- The vehicle applies a single horn for alerting surroundings when marshalling of vehicle is starting.  ,

 - 2 - `double-horn`		- For notifying pedestrians who pose obstacles to the vehicle marshalling task.  ,

 - 3 - `hold-horn`		- In event of ground staff intervention is needed for the vehicle.

 - 1 - `singleHorn`		- The vehicle applies a single horn for alerting surroundings when marshalling of vehicle is starting.  ,

 - 2 - `doubleHorn`		- For notifying pedestrians who pose obstacles to the vehicle marshalling task.  ,

 - 3 - `holdHorn`		  - In event of ground staff intervention is needed for the vehicle.

```asn1

VehicleHornRequestEnum ::= ENUMERATED {

  none(0),   			

  single-horn(1),	

  double-horn(2),	

  hold-horn(3)		

  singleHorn(1),	

  doubleHorn(2),	

  holdHorn(3)		

}

```
@@ -579,14 +579,14 @@ VehicleHornRequestEnum ::= ENUMERATED { 
Data element VidRequestCommandEnum describes the vehicle identification request.

 It offers the following signal values:

 

 - 0 - `generate-new-code` - A new safe vehicle identification cycle was started. There is no intent for flashing in this cycle.

 - 1 - `generate-new-code-and-prepare-for-flashing`  - A new safe vehicle identification cycle was started. Flashing will be required in this cycle.

 - 0 - `generateNewCode`                       - A new safe vehicle identification cycle was started. There is no intent for flashing in this cycle.

 - 1 - `generateNewCodeAndPrepareForFlashing`  - A new safe vehicle identification cycle was started. Flashing will be required in this cycle.

 - 2 - `flashing`	                             - The infrastructure is prepared and waiting for the Subject Vehicle to flash the code.  ,

 - 3 - `successful`                            - The Subject Vehicle was recognized correctly and the identification is completed.  ,

```asn1

VidRequestCommandEnum ::= ENUMERATED {

  generate-new-code(0),     

  generate-new-code-and-prepare-for-flashing(1), 

  generateNewCode(0),     

  generateNewCodeAndPrepareForFlashing(1), 

  flashing(2), 		

  successful(3)

}

docs/MVM-PDU-Descriptions.md

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



## Imports:

* **[AVM-Commons](AVM-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) } WITH SUCCESSORS*<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-4 (4) minor-version-1 (1) } WITH SUCCESSORS*<br/>

* **[AVM-Commons](AVM-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-4 (4) minor-version-1 (1) }*<br/>

## Data Elements:

### <a name="MVM"></a>MVM

This type represents the MVM PDU.