Dialect: csAirLink
WARNING
This topic documents the version of the dialect file in the mavlink/mavlink Github repository, which may not be up to date with the file in the source repository (it is up to the dialect owner to push changes when needed). The source repo should be listed in the comments at the top of the XML definition file listed below (but may not be).
This topic is a human-readable form of the XML definition file: csAirLink.xml.
INFO
- MAVLink 2 extension fields are displayed in blue.
- Entities from dialects are displayed only as headings (with link to original)
Protocol version: 3
MAVLink Include Files
None
Summary
| Type | Defined | Included |
|---|---|---|
| Messages | 6 | 0 |
| Enums | 5 | 0 |
| Commands | 0 | 0 |
The following sections list all entities in the dialect (both included and defined in this file).
Messages
AIRLINK_AUTH (52000)
Authorization package
| Field Name | Type | Description |
|---|---|---|
| login | char[50] | Login |
| password | char[50] | Password |
AIRLINK_AUTH_RESPONSE (52001)
Response to the authorization request
| Field Name | Type | Values | Description |
|---|---|---|---|
| resp_type | uint8_t | AIRLINK_AUTH_RESPONSE_TYPE | Response type |
AIRLINK_EYE_GS_HOLE_PUSH_REQUEST (52002)
Request to hole punching
| Field Name | Type | Values | Description |
|---|---|---|---|
| resp_type | uint8_t | AIRLINK_EYE_GS_HOLE_PUSH_RESP_TYPE | Hole push response type |
AIRLINK_EYE_GS_HOLE_PUSH_RESPONSE (52003)
Response information about the connected device
| Field Name | Type | Values | Description |
|---|---|---|---|
| resp_type | uint8_t | AIRLINK_EYE_GS_HOLE_PUSH_RESP_TYPE | Hole push response type |
| ip_version | uint8_t | AIRLINK_EYE_IP_VERSION | ip version |
| ip_address_4 | uint8_t[4] | ip 4 address | |
| ip_address_6 | uint8_t[16] | ip 6 address | |
| ip_port | uint32_t | port |
AIRLINK_EYE_HP (52004)
A package with information about the hole punching status. It is used for constant sending to avoid NAT closing timeout.
| Field Name | Type | Values | Description |
|---|---|---|---|
| resp_type | uint8_t | AIRLINK_EYE_HOLE_PUSH_TYPE | Hole push response type |
AIRLINK_EYE_TURN_INIT (52005)
Initializing the TURN protocol
| Field Name | Type | Values | Description |
|---|---|---|---|
| resp_type | uint8_t | AIRLINK_EYE_TURN_INIT_TYPE | Turn init type |
Enumerated Types
AIRLINK_AUTH_RESPONSE_TYPE
| Value | Name | Description |
|---|---|---|
| 0 | AIRLINK_ERROR_LOGIN_OR_PASS | Login or password error |
| 1 | AIRLINK_AUTH_OK | Auth successful |
AIRLINK_EYE_GS_HOLE_PUSH_RESP_TYPE
| Value | Name | Description |
|---|---|---|
| 0 | AIRLINK_HPR_PARTNER_NOT_READY | |
| 1 | AIRLINK_HPR_PARTNER_READY |
AIRLINK_EYE_IP_VERSION
| Value | Name | Description |
|---|---|---|
| 0 | AIRLINK_IP_V4 | |
| 1 | AIRLINK_IP_V6 |
AIRLINK_EYE_HOLE_PUSH_TYPE
| Value | Name | Description |
|---|---|---|
| 0 | AIRLINK_HP_NOT_PENETRATED | |
| 1 | AIRLINK_HP_BROKEN |
AIRLINK_EYE_TURN_INIT_TYPE
| Value | Name | Description |
|---|---|---|
| 0 | AIRLINK_TURN_INIT_START | |
| 1 | AIRLINK_TURN_INIT_OK | |
| 2 | AIRLINK_TURN_INIT_BAD |