Keep the plugin ICD docs and jenkins-ci-rme/README.md
Revert part of the markdown cleanup: the two TrainingAreaBase plugin ICD docs and jenkins-ci-rme/README.md stay in the tree; the root migration/validation reports remain removed. README.md pointers to jenkins-ci-rme/README.md are restored.
This commit is contained in:
1 parent
4bc64639e4
commit
a62b729577
4 files changed
+257
-7
No files matched your search
Executable
+79
@@ -0,0 +1,79 @@
|
||||
c# UFOM HLA Plugin
|
||||
|
||||
This is a small documentation of the UFOM HLA TAB Plugin. This document will cover most of the behaviours of the different Telegrams that are supported.
|
||||
## Change Position
|
||||
This plugin publishes all changes in position from every Participant that is not external. A "MountActionRequest" will be sent out if an external participant mounts an internal participant ( vehicle ).
|
||||
- External Participant Mounts Internal Participant -> **MountActionRequest** will be sent.
|
||||
- External Participant Unmounts from internal participant -> **UnmountActionRequest** will be sent.
|
||||
- Mounted external participant mounts any internal participant -> **MountActionRequest** will be sent.
|
||||
> **Note:** No **UnmountActionRequest** will be sent in this case
|
||||
|
||||
- Mounted external participant mounts any external participant -> **Nothing** will be sent.
|
||||
|
||||
## JSON Telegrams
|
||||
### UFOMHLA_ADD_PARTICIPANT
|
||||
ID: 8100
|
||||
|
||||
### UFOMHLA_REMOVE_PARTICIPANT
|
||||
ID: 8101
|
||||
|
||||
### UFOMHLA_POSITION_CHANGED
|
||||
ID: 8102
|
||||
|
||||
#### Example:
|
||||
|
||||
{
|
||||
"typeId": 8102,
|
||||
"type": "UFomHlaPositionChanged",
|
||||
"data":{
|
||||
"header": {
|
||||
"equipmentNumber": 1234,
|
||||
"timeStamp": 12341234
|
||||
},
|
||||
"lon": 1.2341234,
|
||||
"lat": 1.2341234,
|
||||
"z": 0
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
### UFOMHLA_VULNERABILITY_STATE_CHANGED
|
||||
ID: 8103
|
||||
|
||||
### UFOMHLA_LASER_DESIGNATION
|
||||
ID: 8104
|
||||
|
||||
### UFOMHLA_SEND_CHARGE_TYPES
|
||||
ID: 8105
|
||||
|
||||
### UFOMHLA_PARTICIPANT_MOUNT
|
||||
ID: 8106
|
||||
**mountedOn** : Equipment number of the participant to be mounted
|
||||
#### Example:
|
||||
|
||||
{
|
||||
"typeId": 8101,
|
||||
"type": "UFomHlaParticipantMount",
|
||||
"data":{
|
||||
"header": {
|
||||
"equipmentNumber": 1234,
|
||||
"timeStamp": 12341234
|
||||
},
|
||||
"mountedOn": 123,
|
||||
}
|
||||
}
|
||||
|
||||
### UFOMHLA_PARTICIPANT_UNMOUNT
|
||||
ID: 8107
|
||||
#### Example:
|
||||
|
||||
{
|
||||
"typeId": 8101,
|
||||
"type": "UFomHlaParticipantUnmount",
|
||||
"data":{
|
||||
"header": {
|
||||
"equipmentNumber": 1234,
|
||||
"timeStamp": 12341234
|
||||
}
|
||||
}
|
||||
}
|
||||
+120
@@ -0,0 +1,120 @@
|
||||
All Telegrams only defined for communication between TAB-Plugin and Apache Virtual Machine
|
||||
|
||||
|
||||
AddParticipant Telegram(Sending updated or added participant to Apache)
|
||||
|
||||
Example Telegram:
|
||||
<pre><code>
|
||||
{
|
||||
typeId:8000,
|
||||
type: ApacheHlaAddParticipant,
|
||||
data:
|
||||
{
|
||||
header: {
|
||||
equipmentNumber: 42,
|
||||
timeStamp: MsecsSinceEpoch
|
||||
},
|
||||
status: 11,
|
||||
forceIdentifier: 42,
|
||||
ets: "2.0.0.0.0.0.1",
|
||||
GeoPosition: {
|
||||
lon: 15.145274,
|
||||
lat: 24.5554556,
|
||||
z: 55.000124
|
||||
}
|
||||
}
|
||||
}
|
||||
</pre></code>
|
||||
|
||||
|
||||
|
||||
RemoveParticipant Telegram(Sending deleted participant to Apache)
|
||||
|
||||
|
||||
Example Telegram:
|
||||
<pre><code>
|
||||
{
|
||||
typeId:8001,
|
||||
type: ApacheHlaRemoveParticipant,
|
||||
data:
|
||||
{
|
||||
header: {
|
||||
equipmentNumber: 42,
|
||||
timeStamp: MsecsSinceEpoch
|
||||
}
|
||||
}
|
||||
}
|
||||
</pre></code>
|
||||
|
||||
Change Position Telegram( Send new Position of participant to Apache)
|
||||
|
||||
Example Telegram:
|
||||
<pre><code>
|
||||
{
|
||||
typeId:8002,
|
||||
type: ApacheHlaPositionChanged,
|
||||
data:
|
||||
{
|
||||
header: {
|
||||
equipmentNumber: 42,
|
||||
timeStamp: MsecsSinceEpoch
|
||||
},
|
||||
lon: 15.275884,
|
||||
lat: 37.854856,
|
||||
z: 42.255278
|
||||
}
|
||||
}
|
||||
</pre></code>
|
||||
|
||||
Change VulnerabilityState Telegram(Sending updated VulnerabilityState to Apache)
|
||||
|
||||
|
||||
Example Telegram:
|
||||
<pre><code>
|
||||
{
|
||||
typeId:8003,
|
||||
type: ApacheHlaVulnerabilityStateChanged,
|
||||
data:
|
||||
{
|
||||
header: {
|
||||
equipmentNumber: 42,
|
||||
timeStamp: MsecsSinceEpoch
|
||||
},
|
||||
status: 11
|
||||
}
|
||||
}
|
||||
</pre></code>
|
||||
|
||||
|
||||
|
||||
AllChargeTypes Telegram(Sending all Charge Types at the beginning of an exercise to Apache)
|
||||
|
||||
|
||||
Example Telegram:
|
||||
|
||||
<pre><code>
|
||||
{
|
||||
typeId:8005,
|
||||
type: ApacheHlaSendChargeTypes,
|
||||
data:
|
||||
[
|
||||
{
|
||||
id: 420,
|
||||
name: 42mm,
|
||||
entityTypeStruct: TestTest,
|
||||
primaryGearTasCode: 11,
|
||||
radius: 7
|
||||
},
|
||||
{
|
||||
id: 777,
|
||||
name: 77mm,
|
||||
entityTypeStruct: TestTest,
|
||||
primaryGearTasCode: 77,
|
||||
radius: 77
|
||||
},
|
||||
{
|
||||
...
|
||||
}
|
||||
]
|
||||
}
|
||||
</pre></code>
|
||||
Reference in new issue
Block a user