Classes | Macros | Typedefs | Functions
mavlink_msg_resource_request.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  __mavlink_resource_request_t
 

Macros

#define MAVLINK_MESSAGE_INFO_RESOURCE_REQUEST
 
#define MAVLINK_MSG_ID_142_CRC   72
 
#define MAVLINK_MSG_ID_142_LEN   243
 
#define MAVLINK_MSG_ID_RESOURCE_REQUEST   142
 
#define MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC   72
 
#define MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN   243
 
#define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_STORAGE_LEN   120
 
#define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_URI_LEN   120
 

Typedefs

typedef struct __mavlink_resource_request_t mavlink_resource_request_t
 

Functions

static void mavlink_msg_resource_request_decode (const mavlink_message_t *msg, mavlink_resource_request_t *resource_request)
 Decode a resource_request message into a struct. More...
 
static uint16_t mavlink_msg_resource_request_encode (uint8_t system_id, uint8_t component_id, mavlink_message_t *msg, const mavlink_resource_request_t *resource_request)
 Encode a resource_request struct. More...
 
static uint16_t mavlink_msg_resource_request_encode_chan (uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t *msg, const mavlink_resource_request_t *resource_request)
 Encode a resource_request struct on a channel. More...
 
static uint8_t mavlink_msg_resource_request_get_request_id (const mavlink_message_t *msg)
 Send a resource_request message. More...
 
static uint16_t mavlink_msg_resource_request_get_storage (const mavlink_message_t *msg, uint8_t *storage)
 Get field storage from resource_request message. More...
 
static uint8_t mavlink_msg_resource_request_get_transfer_type (const mavlink_message_t *msg)
 Get field transfer_type from resource_request message. More...
 
static uint16_t mavlink_msg_resource_request_get_uri (const mavlink_message_t *msg, uint8_t *uri)
 Get field uri from resource_request message. More...
 
static uint8_t mavlink_msg_resource_request_get_uri_type (const mavlink_message_t *msg)
 Get field uri_type from resource_request message. More...
 
static uint16_t mavlink_msg_resource_request_pack (uint8_t system_id, uint8_t component_id, mavlink_message_t *msg, uint8_t request_id, uint8_t uri_type, const uint8_t *uri, uint8_t transfer_type, const uint8_t *storage)
 Pack a resource_request message. More...
 
static uint16_t mavlink_msg_resource_request_pack_chan (uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t *msg, uint8_t request_id, uint8_t uri_type, const uint8_t *uri, uint8_t transfer_type, const uint8_t *storage)
 Pack a resource_request message on a channel. More...
 

Macro Definition Documentation

#define MAVLINK_MESSAGE_INFO_RESOURCE_REQUEST
Value:
{ \
"RESOURCE_REQUEST", \
5, \
{ { "request_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 0, offsetof(mavlink_resource_request_t, request_id) }, \
{ "uri_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 1, offsetof(mavlink_resource_request_t, uri_type) }, \
{ "uri", NULL, MAVLINK_TYPE_UINT8_T, 120, 2, offsetof(mavlink_resource_request_t, uri) }, \
{ "transfer_type", NULL, MAVLINK_TYPE_UINT8_T, 0, 122, offsetof(mavlink_resource_request_t, transfer_type) }, \
{ "storage", NULL, MAVLINK_TYPE_UINT8_T, 120, 123, offsetof(mavlink_resource_request_t, storage) }, \
} \
}

Definition at line 23 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_ID_142_CRC   72

Definition at line 18 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_ID_142_LEN   243

Definition at line 15 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_ID_RESOURCE_REQUEST   142

Definition at line 3 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_ID_RESOURCE_REQUEST_CRC   72

Definition at line 17 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_ID_RESOURCE_REQUEST_LEN   243

Definition at line 14 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_STORAGE_LEN   120

Definition at line 21 of file mavlink_msg_resource_request.h.

#define MAVLINK_MSG_RESOURCE_REQUEST_FIELD_URI_LEN   120

Definition at line 20 of file mavlink_msg_resource_request.h.

Typedef Documentation

Function Documentation

static void mavlink_msg_resource_request_decode ( const mavlink_message_t *  msg,
mavlink_resource_request_t resource_request 
)
inlinestatic

Decode a resource_request message into a struct.

Parameters
msgThe message to decode
resource_requestC-struct to decode the message contents into

Definition at line 287 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_encode ( uint8_t  system_id,
uint8_t  component_id,
mavlink_message_t *  msg,
const mavlink_resource_request_t resource_request 
)
inlinestatic

Encode a resource_request struct.

Parameters
system_idID of this system
component_idID of this component (e.g. 200 for IMU)
msgThe MAVLink message to compress the data into
resource_requestC-struct to read the message contents from

Definition at line 128 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_encode_chan ( uint8_t  system_id,
uint8_t  component_id,
uint8_t  chan,
mavlink_message_t *  msg,
const mavlink_resource_request_t resource_request 
)
inlinestatic

Encode a resource_request struct on a channel.

Parameters
system_idID of this system
component_idID of this component (e.g. 200 for IMU)
chanThe MAVLink channel this message will be sent over
msgThe MAVLink message to compress the data into
resource_requestC-struct to read the message contents from

Definition at line 142 of file mavlink_msg_resource_request.h.

static uint8_t mavlink_msg_resource_request_get_request_id ( const mavlink_message_t *  msg)
inlinestatic

Send a resource_request message.

Parameters
chanMAVLink channel to send the message
request_idRequest ID. This ID should be re-used when sending back URI contents
uri_typeThe type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
uriThe requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
transfer_typeThe way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
storageThe storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP). Get field request_id from resource_request message
Returns
Request ID. This ID should be re-used when sending back URI contents

Definition at line 236 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_get_storage ( const mavlink_message_t *  msg,
uint8_t *  storage 
)
inlinestatic

Get field storage from resource_request message.

Returns
The storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).

Definition at line 276 of file mavlink_msg_resource_request.h.

static uint8_t mavlink_msg_resource_request_get_transfer_type ( const mavlink_message_t *  msg)
inlinestatic

Get field transfer_type from resource_request message.

Returns
The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.

Definition at line 266 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_get_uri ( const mavlink_message_t *  msg,
uint8_t *  uri 
)
inlinestatic

Get field uri from resource_request message.

Returns
The requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)

Definition at line 256 of file mavlink_msg_resource_request.h.

static uint8_t mavlink_msg_resource_request_get_uri_type ( const mavlink_message_t *  msg)
inlinestatic

Get field uri_type from resource_request message.

Returns
The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary

Definition at line 246 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_pack ( uint8_t  system_id,
uint8_t  component_id,
mavlink_message_t *  msg,
uint8_t  request_id,
uint8_t  uri_type,
const uint8_t *  uri,
uint8_t  transfer_type,
const uint8_t *  storage 
)
inlinestatic

Pack a resource_request message.

Parameters
system_idID of this system
component_idID of this component (e.g. 200 for IMU)
msgThe MAVLink message to compress the data into
request_idRequest ID. This ID should be re-used when sending back URI contents
uri_typeThe type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
uriThe requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
transfer_typeThe way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
storageThe storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
Returns
length of the message in bytes (excluding serial stream start sign)

Definition at line 48 of file mavlink_msg_resource_request.h.

static uint16_t mavlink_msg_resource_request_pack_chan ( uint8_t  system_id,
uint8_t  component_id,
uint8_t  chan,
mavlink_message_t *  msg,
uint8_t  request_id,
uint8_t  uri_type,
const uint8_t *  uri,
uint8_t  transfer_type,
const uint8_t *  storage 
)
inlinestatic

Pack a resource_request message on a channel.

Parameters
system_idID of this system
component_idID of this component (e.g. 200 for IMU)
chanThe MAVLink channel this message will be sent over
msgThe MAVLink message to compress the data into
request_idRequest ID. This ID should be re-used when sending back URI contents
uri_typeThe type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
uriThe requested unique resource identifier (URI). It is not necessarily a straight domain name (depends on the URI type enum)
transfer_typeThe way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
storageThe storage path the autopilot wants the URI to be stored in. Will only be valid if the transfer_type has a storage associated (e.g. MAVLink FTP).
Returns
length of the message in bytes (excluding serial stream start sign)

Definition at line 90 of file mavlink_msg_resource_request.h.



rosflight
Author(s): Daniel Koch , James Jackson
autogenerated on Thu Apr 15 2021 05:09:28