Classes | Defines | Functions
mavlink_helpers.h File Reference
#include "string.h"
#include "checksum.h"
#include "mavlink_types.h"
#include "mavlink_conversions.h"
Include dependency graph for include_v1.0/mavlink_helpers.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

union  __mavlink_bitfield

Defines

#define MAVLINK_HELPER

Functions

MAVLINK_HELPER uint16_t mavlink_finalize_message (mavlink_message_t *msg, uint8_t system_id, uint8_t component_id, uint8_t length)
 Finalize a MAVLink message with MAVLINK_COMM_0 as default channel.
MAVLINK_HELPER uint16_t mavlink_finalize_message_chan (mavlink_message_t *msg, uint8_t system_id, uint8_t component_id, uint8_t chan, uint8_t length)
 Finalize a MAVLink message with channel assignment.
MAVLINK_HELPER uint8_t mavlink_frame_char (uint8_t chan, uint8_t c, mavlink_message_t *r_message, mavlink_status_t *r_mavlink_status)
MAVLINK_HELPER uint8_t mavlink_frame_char_buffer (mavlink_message_t *rxmsg, mavlink_status_t *status, uint8_t c, mavlink_message_t *r_message, mavlink_status_t *r_mavlink_status)
MAVLINK_HELPER mavlink_message_t * mavlink_get_channel_buffer (uint8_t chan)
MAVLINK_HELPER mavlink_status_t * mavlink_get_channel_status (uint8_t chan)
MAVLINK_HELPER uint16_t mavlink_msg_to_send_buffer (uint8_t *buffer, const mavlink_message_t *msg)
 Pack a message to send it over a serial byte stream.
MAVLINK_HELPER uint8_t mavlink_parse_char (uint8_t chan, uint8_t c, mavlink_message_t *r_message, mavlink_status_t *r_mavlink_status)
MAVLINK_HELPER void mavlink_reset_channel_status (uint8_t chan)
 Reset the status of a channel.
MAVLINK_HELPER void mavlink_start_checksum (mavlink_message_t *msg)
MAVLINK_HELPER void mavlink_update_checksum (mavlink_message_t *msg, uint8_t c)
MAVLINK_HELPER uint8_t put_bitfield_n_by_index (int32_t b, uint8_t bits, uint8_t packet_index, uint8_t bit_index, uint8_t *r_bit_index, uint8_t *buffer)
 Put a bitfield of length 1-32 bit into the buffer.

Define Documentation

#define MAVLINK_HELPER

Definition at line 10 of file include_v1.0/mavlink_helpers.h.

Function Documentation

MAVLINK_HELPER uint16_t mavlink_finalize_message ( mavlink_message_t *  msg,
uint8_t  system_id,
uint8_t  component_id,
uint8_t  length 
)

Finalize a MAVLink message with MAVLINK_COMM_0 as default channel.

Definition at line 105 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint16_t mavlink_finalize_message_chan ( mavlink_message_t *  msg,
uint8_t  system_id,
uint8_t  component_id,
uint8_t  chan,
uint8_t  length 
)

Finalize a MAVLink message with channel assignment.

This function calculates the checksum and sets length and aircraft id correctly. It assumes that the message id and the payload are already correctly set. This function can also be used if the message header has already been written before (as in mavlink_msg_xxx_pack instead of mavlink_msg_xxx_pack_headerless), it just introduces little extra overhead.

Parameters:
msgMessage to finalize
system_idId of the sending (this) system, 1-127
lengthMessage length

Definition at line 71 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint8_t mavlink_frame_char ( uint8_t  chan,
uint8_t  c,
mavlink_message_t *  r_message,
mavlink_status_t *  r_mavlink_status 
)

This is a convenience function which handles the complete MAVLink parsing. the function will parse one byte at a time and return the complete packet once it could be successfully decoded. This function will return 0, 1 or 2 (MAVLINK_FRAMING_INCOMPLETE, MAVLINK_FRAMING_OK or MAVLINK_FRAMING_BAD_CRC)

Messages are parsed into an internal buffer (one for each channel). When a complete message is received it is copies into *returnMsg and the channel's status is copied into *returnStats.

Parameters:
chanID of the current channel. This allows to parse different channels with this function. a channel is not a physical message channel like a serial port, but a logic partition of the communication streams in this case. COMM_NB is the limit for the number of channels on MCU (e.g. ARM7), while COMM_NB_HIGH is the limit for the number of channels in Linux/Windows
cThe char to parse
returnMsgNULL if no message could be decoded, the message data else
returnStatsif a message was decoded, this is filled with the channel's stats
Returns:
0 if no message could be decoded, 1 on good message and CRC, 2 on bad CRC

A typical use scenario of this function call is:

 #include <mavlink.h>

 mavlink_message_t msg;
 int chan = 0;


 while(serial.bytesAvailable > 0)
 {
   uint8_t byte = serial.getNextByte();
   if (mavlink_frame_char(chan, byte, &msg) != MAVLINK_FRAMING_INCOMPLETE)
     {
     printf("Received message with ID %d, sequence: %d from component %d of system %d", msg.msgid, msg.seq, msg.compid, msg.sysid);
     }
 }

Definition at line 465 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint8_t mavlink_frame_char_buffer ( mavlink_message_t *  rxmsg,
mavlink_status_t *  status,
uint8_t  c,
mavlink_message_t *  r_message,
mavlink_status_t *  r_mavlink_status 
)

This is a varient of mavlink_frame_char() but with caller supplied parsing buffers. It is useful when you want to create a MAVLink parser in a library that doesn't use any global variables

Parameters:
rxmsgparsing message buffer
statusparsing starus buffer
cThe char to parse
returnMsgNULL if no message could be decoded, the message data else
returnStatsif a message was decoded, this is filled with the channel's stats
Returns:
0 if no message could be decoded, 1 on good message and CRC, 2 on bad CRC

A typical use scenario of this function call is:

 #include <mavlink.h>

 mavlink_message_t msg;
 int chan = 0;


 while(serial.bytesAvailable > 0)
 {
   uint8_t byte = serial.getNextByte();
   if (mavlink_frame_char(chan, byte, &msg) != MAVLINK_FRAMING_INCOMPLETE)
     {
     printf("Received message with ID %d, sequence: %d from component %d of system %d", msg.msgid, msg.seq, msg.compid, msg.sysid);
     }
 }

Definition at line 240 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER mavlink_message_t* mavlink_get_channel_buffer ( uint8_t  chan)

Definition at line 33 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER mavlink_status_t* mavlink_get_channel_status ( uint8_t  chan)

Definition at line 17 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint16_t mavlink_msg_to_send_buffer ( uint8_t *  buffer,
const mavlink_message_t *  msg 
)

Pack a message to send it over a serial byte stream.

Definition at line 174 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint8_t mavlink_parse_char ( uint8_t  chan,
uint8_t  c,
mavlink_message_t *  r_message,
mavlink_status_t *  r_mavlink_status 
)

This is a convenience function which handles the complete MAVLink parsing. the function will parse one byte at a time and return the complete packet once it could be successfully decoded. This function will return 0 or 1.

Messages are parsed into an internal buffer (one for each channel). When a complete message is received it is copies into *returnMsg and the channel's status is copied into *returnStats.

Parameters:
chanID of the current channel. This allows to parse different channels with this function. a channel is not a physical message channel like a serial port, but a logic partition of the communication streams in this case. COMM_NB is the limit for the number of channels on MCU (e.g. ARM7), while COMM_NB_HIGH is the limit for the number of channels in Linux/Windows
cThe char to parse
returnMsgNULL if no message could be decoded, the message data else
returnStatsif a message was decoded, this is filled with the channel's stats
Returns:
0 if no message could be decoded or bad CRC, 1 on good message and CRC

A typical use scenario of this function call is:

 #include <mavlink.h>

 mavlink_message_t msg;
 int chan = 0;


 while(serial.bytesAvailable > 0)
 {
   uint8_t byte = serial.getNextByte();
   if (mavlink_parse_char(chan, byte, &msg))
     {
     printf("Received message with ID %d, sequence: %d from component %d of system %d", msg.msgid, msg.seq, msg.compid, msg.sysid);
     }
 }

< The currently decoded message

< The current decode status

Definition at line 515 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER void mavlink_reset_channel_status ( uint8_t  chan)

Reset the status of a channel.

Definition at line 49 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER void mavlink_start_checksum ( mavlink_message_t *  msg)

Definition at line 196 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER void mavlink_update_checksum ( mavlink_message_t *  msg,
uint8_t  c 
)

Definition at line 201 of file include_v1.0/mavlink_helpers.h.

MAVLINK_HELPER uint8_t put_bitfield_n_by_index ( int32_t  b,
uint8_t  bits,
uint8_t  packet_index,
uint8_t  bit_index,
uint8_t *  r_bit_index,
uint8_t *  buffer 
)

Put a bitfield of length 1-32 bit into the buffer.

Parameters:
bthe value to add, will be encoded in the bitfield
bitsnumber of bits to use to encode b, e.g. 1 for boolean, 2, 3, etc.
packet_indexthe position in the packet (the index of the first byte to use)
bit_indexthe position in the byte (the index of the first bit to use)
bufferpacket buffer to write into
Returns:
new position of the last used byte in the buffer

Definition at line 546 of file include_v1.0/mavlink_helpers.h.


mavlink
Author(s): Lorenz Meier
autogenerated on Sun May 22 2016 04:05:43