Development Messages
Target
Target.
- Abbreviation: Target
- Identification Number: 800
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Label |
label |
- |
plaintext |
Target identifier. |
Same as field type |
| Latitude WGS-84 |
lat |
rad |
fp64_t |
WGS-84 Latitude coordinate. |
Same as field type |
| Longitude WGS-84 |
lon |
rad |
fp64_t |
WGS-84 Longitude coordinate. |
Same as field type |
| Z Reference |
z |
m |
fp32_t |
Z axis reference. Use z_units to specify whether z represents
depth, altitude or other. |
Same as field type |
| Z Units |
z_units |
Enumerated |
uint8_t |
Units of the z reference. |
Same as field type |
| Course Over Ground |
cog |
rad |
fp32_t |
Course Over Ground (true). |
Same as field type |
| Speed Over Ground |
sog |
m/s |
fp32_t |
Speed Over Ground. |
Same as field type |
EntityParameter
Entity parameter.
- Abbreviation: EntityParameter
- Identification Number: 801
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Name |
name |
- |
plaintext |
Name of the parameter. |
Same as field type |
| Value |
value |
- |
plaintext |
Current value of the parameter. |
Same as field type |
EntityParameters
List of entity parameters.
- Abbreviation: EntityParameters
- Identification Number: 802
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
Name of the entity. |
Same as field type |
| Parameters |
params |
- |
message-list |
List of parameters. |
Same as field type |
QueryEntityParameters
No description
- Abbreviation: QueryEntityParameters
- Identification Number: 803
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
|
Same as field type |
| Visibility |
visibility |
- |
plaintext |
|
Same as field type |
| Scope |
scope |
- |
plaintext |
|
Same as field type |
SetEntityParameters
No description
- Abbreviation: SetEntityParameters
- Identification Number: 804
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
|
Same as field type |
| Parameters |
params |
- |
message-list |
|
Same as field type |
SaveEntityParameters
No description
- Abbreviation: SaveEntityParameters
- Identification Number: 805
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
|
Same as field type |
Create Session
Request creating a new session with this remote peer. Example
session sequence is shown in the following diagram.
- Abbreviation: CreateSession
- Identification Number: 806
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Session Timeout |
timeout |
- |
uint32_t |
Session timeout, in seconds. If no messages are received from
the remote peer, the session will be closed after this ammount
of seconds have ellapsed. |
Same as field type |
Close Session
Request closing of an ongoing session
- Abbreviation: CloseSession
- Identification Number: 807
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Session Identifier |
sessid |
- |
uint32_t |
|
Same as field type |
Session Subscription
No description
- Abbreviation: SessionSubscription
- Identification Number: 808
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Session Identifier |
sessid |
- |
uint32_t |
|
Same as field type |
| Messages to subscribe |
messages |
- |
plaintext |
Comma-separated list of messages to subscribe. Example:
“EstimatedState,EulerAngles,Temperature” |
Same as field type |
Session Keep-Alive
Message exchanged to prevent a session from timing out
- Abbreviation: SessionKeepAlive
- Identification Number: 809
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Session Identifier |
sessid |
- |
uint32_t |
|
Same as field type |
Session Status
Message transmitted periodically to inform the state of a communication session
- Abbreviation: SessionStatus
- Identification Number: 810
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Session Identifier |
sessid |
- |
uint32_t |
|
Same as field type |
| Status |
status |
Enumerated |
uint8_t |
|
Same as field type |
Push Entity Parameters
No description
- Abbreviation: PushEntityParameters
- Identification Number: 811
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
|
Same as field type |
Pop Entity Parameters
No description
- Abbreviation: PopEntityParameters
- Identification Number: 812
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Entity Name |
name |
- |
plaintext |
|
Same as field type |
I/O Event
Notification of an I/O event.
- Abbreviation: IoEvent
- Identification Number: 813
- Fixed Payload Size: 0
| Name |
Abbreviation |
Unit |
Type |
Description |
Range |
|---|
| Type |
type |
Enumerated |
uint8_t |
Event type. |
Same as field type |
| Error Message |
error |
- |
plaintext |
Human-readable error message. |
Same as field type |
