diff options
Diffstat (limited to 'mavlink/include/mavlink/v1.0/common/mavlink_msg_battery_status.h')
| -rw-r--r-- | mavlink/include/mavlink/v1.0/common/mavlink_msg_battery_status.h | 397 |
1 files changed, 0 insertions, 397 deletions
diff --git a/mavlink/include/mavlink/v1.0/common/mavlink_msg_battery_status.h b/mavlink/include/mavlink/v1.0/common/mavlink_msg_battery_status.h deleted file mode 100644 index 03e4d569e..000000000 --- a/mavlink/include/mavlink/v1.0/common/mavlink_msg_battery_status.h +++ /dev/null @@ -1,397 +0,0 @@ -// MESSAGE BATTERY_STATUS PACKING - -#define MAVLINK_MSG_ID_BATTERY_STATUS 147 - -typedef struct __mavlink_battery_status_t -{ - int32_t current_consumed; ///< Consumed charge, in milliampere hours (1 = 1 mAh), -1: autopilot does not provide mAh consumption estimate - int32_t energy_consumed; ///< Consumed energy, in 100*Joules (intergrated U*I*dt) (1 = 100 Joule), -1: autopilot does not provide energy consumption estimate - uint16_t voltage_cell_1; ///< Battery voltage of cell 1, in millivolts (1 = 1 millivolt) - uint16_t voltage_cell_2; ///< Battery voltage of cell 2, in millivolts (1 = 1 millivolt), -1: no cell - uint16_t voltage_cell_3; ///< Battery voltage of cell 3, in millivolts (1 = 1 millivolt), -1: no cell - uint16_t voltage_cell_4; ///< Battery voltage of cell 4, in millivolts (1 = 1 millivolt), -1: no cell - uint16_t voltage_cell_5; ///< Battery voltage of cell 5, in millivolts (1 = 1 millivolt), -1: no cell - uint16_t voltage_cell_6; ///< Battery voltage of cell 6, in millivolts (1 = 1 millivolt), -1: no cell - int16_t current_battery; ///< Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current - uint8_t accu_id; ///< Accupack ID - int8_t battery_remaining; ///< Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot does not estimate the remaining battery -} mavlink_battery_status_t; - -#define MAVLINK_MSG_ID_BATTERY_STATUS_LEN 24 -#define MAVLINK_MSG_ID_147_LEN 24 - -#define MAVLINK_MSG_ID_BATTERY_STATUS_CRC 177 -#define MAVLINK_MSG_ID_147_CRC 177 - - - -#define MAVLINK_MESSAGE_INFO_BATTERY_STATUS { \ - "BATTERY_STATUS", \ - 11, \ - { { "current_consumed", NULL, MAVLINK_TYPE_INT32_T, 0, 0, offsetof(mavlink_battery_status_t, current_consumed) }, \ - { "energy_consumed", NULL, MAVLINK_TYPE_INT32_T, 0, 4, offsetof(mavlink_battery_status_t, energy_consumed) }, \ - { "voltage_cell_1", NULL, MAVLINK_TYPE_UINT16_T, 0, 8, offsetof(mavlink_battery_status_t, voltage_cell_1) }, \ - { "voltage_cell_2", NULL, MAVLINK_TYPE_UINT16_T, 0, 10, offsetof(mavlink_battery_status_t, voltage_cell_2) }, \ - { "voltage_cell_3", NULL, MAVLINK_TYPE_UINT16_T, 0, 12, offsetof(mavlink_battery_status_t, voltage_cell_3) }, \ - { "voltage_cell_4", NULL, MAVLINK_TYPE_UINT16_T, 0, 14, offsetof(mavlink_battery_status_t, voltage_cell_4) }, \ - { "voltage_cell_5", NULL, MAVLINK_TYPE_UINT16_T, 0, 16, offsetof(mavlink_battery_status_t, voltage_cell_5) }, \ - { "voltage_cell_6", NULL, MAVLINK_TYPE_UINT16_T, 0, 18, offsetof(mavlink_battery_status_t, voltage_cell_6) }, \ - { "current_battery", NULL, MAVLINK_TYPE_INT16_T, 0, 20, offsetof(mavlink_battery_status_t, current_battery) }, \ - { "accu_id", NULL, MAVLINK_TYPE_UINT8_T, 0, 22, offsetof(mavlink_battery_status_t, accu_id) }, \ - { "battery_remaining", NULL, MAVLINK_TYPE_INT8_T, 0, 23, offsetof(mavlink_battery_status_t, battery_remaining) }, \ - } \ -} - - -/** - * @brief Pack a battery_status message - * @param system_id ID of this system - * @param component_id ID of this component (e.g. 200 for IMU) - * @param msg The MAVLink message to compress the data into - * - * @param accu_id Accupack ID - * @param voltage_cell_1 Battery voltage of cell 1, in millivolts (1 = 1 millivolt) - * @param voltage_cell_2 Battery voltage of cell 2, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_3 Battery voltage of cell 3, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_4 Battery voltage of cell 4, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_5 Battery voltage of cell 5, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_6 Battery voltage of cell 6, in millivolts (1 = 1 millivolt), -1: no cell - * @param current_battery Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current - * @param current_consumed Consumed charge, in milliampere hours (1 = 1 mAh), -1: autopilot does not provide mAh consumption estimate - * @param energy_consumed Consumed energy, in 100*Joules (intergrated U*I*dt) (1 = 100 Joule), -1: autopilot does not provide energy consumption estimate - * @param battery_remaining Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot does not estimate the remaining battery - * @return length of the message in bytes (excluding serial stream start sign) - */ -static inline uint16_t mavlink_msg_battery_status_pack(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, - uint8_t accu_id, uint16_t voltage_cell_1, uint16_t voltage_cell_2, uint16_t voltage_cell_3, uint16_t voltage_cell_4, uint16_t voltage_cell_5, uint16_t voltage_cell_6, int16_t current_battery, int32_t current_consumed, int32_t energy_consumed, int8_t battery_remaining) -{ -#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS - char buf[MAVLINK_MSG_ID_BATTERY_STATUS_LEN]; - _mav_put_int32_t(buf, 0, current_consumed); - _mav_put_int32_t(buf, 4, energy_consumed); - _mav_put_uint16_t(buf, 8, voltage_cell_1); - _mav_put_uint16_t(buf, 10, voltage_cell_2); - _mav_put_uint16_t(buf, 12, voltage_cell_3); - _mav_put_uint16_t(buf, 14, voltage_cell_4); - _mav_put_uint16_t(buf, 16, voltage_cell_5); - _mav_put_uint16_t(buf, 18, voltage_cell_6); - _mav_put_int16_t(buf, 20, current_battery); - _mav_put_uint8_t(buf, 22, accu_id); - _mav_put_int8_t(buf, 23, battery_remaining); - - memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#else - mavlink_battery_status_t packet; - packet.current_consumed = current_consumed; - packet.energy_consumed = energy_consumed; - packet.voltage_cell_1 = voltage_cell_1; - packet.voltage_cell_2 = voltage_cell_2; - packet.voltage_cell_3 = voltage_cell_3; - packet.voltage_cell_4 = voltage_cell_4; - packet.voltage_cell_5 = voltage_cell_5; - packet.voltage_cell_6 = voltage_cell_6; - packet.current_battery = current_battery; - packet.accu_id = accu_id; - packet.battery_remaining = battery_remaining; - - memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif - - msg->msgid = MAVLINK_MSG_ID_BATTERY_STATUS; -#if MAVLINK_CRC_EXTRA - return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_BATTERY_STATUS_LEN, MAVLINK_MSG_ID_BATTERY_STATUS_CRC); -#else - return mavlink_finalize_message(msg, system_id, component_id, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif -} - -/** - * @brief Pack a battery_status message on a channel - * @param system_id ID of this system - * @param component_id ID of this component (e.g. 200 for IMU) - * @param chan The MAVLink channel this message will be sent over - * @param msg The MAVLink message to compress the data into - * @param accu_id Accupack ID - * @param voltage_cell_1 Battery voltage of cell 1, in millivolts (1 = 1 millivolt) - * @param voltage_cell_2 Battery voltage of cell 2, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_3 Battery voltage of cell 3, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_4 Battery voltage of cell 4, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_5 Battery voltage of cell 5, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_6 Battery voltage of cell 6, in millivolts (1 = 1 millivolt), -1: no cell - * @param current_battery Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current - * @param current_consumed Consumed charge, in milliampere hours (1 = 1 mAh), -1: autopilot does not provide mAh consumption estimate - * @param energy_consumed Consumed energy, in 100*Joules (intergrated U*I*dt) (1 = 100 Joule), -1: autopilot does not provide energy consumption estimate - * @param battery_remaining Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot does not estimate the remaining battery - * @return length of the message in bytes (excluding serial stream start sign) - */ -static inline uint16_t mavlink_msg_battery_status_pack_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, - mavlink_message_t* msg, - uint8_t accu_id,uint16_t voltage_cell_1,uint16_t voltage_cell_2,uint16_t voltage_cell_3,uint16_t voltage_cell_4,uint16_t voltage_cell_5,uint16_t voltage_cell_6,int16_t current_battery,int32_t current_consumed,int32_t energy_consumed,int8_t battery_remaining) -{ -#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS - char buf[MAVLINK_MSG_ID_BATTERY_STATUS_LEN]; - _mav_put_int32_t(buf, 0, current_consumed); - _mav_put_int32_t(buf, 4, energy_consumed); - _mav_put_uint16_t(buf, 8, voltage_cell_1); - _mav_put_uint16_t(buf, 10, voltage_cell_2); - _mav_put_uint16_t(buf, 12, voltage_cell_3); - _mav_put_uint16_t(buf, 14, voltage_cell_4); - _mav_put_uint16_t(buf, 16, voltage_cell_5); - _mav_put_uint16_t(buf, 18, voltage_cell_6); - _mav_put_int16_t(buf, 20, current_battery); - _mav_put_uint8_t(buf, 22, accu_id); - _mav_put_int8_t(buf, 23, battery_remaining); - - memcpy(_MAV_PAYLOAD_NON_CONST(msg), buf, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#else - mavlink_battery_status_t packet; - packet.current_consumed = current_consumed; - packet.energy_consumed = energy_consumed; - packet.voltage_cell_1 = voltage_cell_1; - packet.voltage_cell_2 = voltage_cell_2; - packet.voltage_cell_3 = voltage_cell_3; - packet.voltage_cell_4 = voltage_cell_4; - packet.voltage_cell_5 = voltage_cell_5; - packet.voltage_cell_6 = voltage_cell_6; - packet.current_battery = current_battery; - packet.accu_id = accu_id; - packet.battery_remaining = battery_remaining; - - memcpy(_MAV_PAYLOAD_NON_CONST(msg), &packet, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif - - msg->msgid = MAVLINK_MSG_ID_BATTERY_STATUS; -#if MAVLINK_CRC_EXTRA - return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_BATTERY_STATUS_LEN, MAVLINK_MSG_ID_BATTERY_STATUS_CRC); -#else - return mavlink_finalize_message_chan(msg, system_id, component_id, chan, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif -} - -/** - * @brief Encode a battery_status struct - * - * @param system_id ID of this system - * @param component_id ID of this component (e.g. 200 for IMU) - * @param msg The MAVLink message to compress the data into - * @param battery_status C-struct to read the message contents from - */ -static inline uint16_t mavlink_msg_battery_status_encode(uint8_t system_id, uint8_t component_id, mavlink_message_t* msg, const mavlink_battery_status_t* battery_status) -{ - return mavlink_msg_battery_status_pack(system_id, component_id, msg, battery_status->accu_id, battery_status->voltage_cell_1, battery_status->voltage_cell_2, battery_status->voltage_cell_3, battery_status->voltage_cell_4, battery_status->voltage_cell_5, battery_status->voltage_cell_6, battery_status->current_battery, battery_status->current_consumed, battery_status->energy_consumed, battery_status->battery_remaining); -} - -/** - * @brief Encode a battery_status struct on a channel - * - * @param system_id ID of this system - * @param component_id ID of this component (e.g. 200 for IMU) - * @param chan The MAVLink channel this message will be sent over - * @param msg The MAVLink message to compress the data into - * @param battery_status C-struct to read the message contents from - */ -static inline uint16_t mavlink_msg_battery_status_encode_chan(uint8_t system_id, uint8_t component_id, uint8_t chan, mavlink_message_t* msg, const mavlink_battery_status_t* battery_status) -{ - return mavlink_msg_battery_status_pack_chan(system_id, component_id, chan, msg, battery_status->accu_id, battery_status->voltage_cell_1, battery_status->voltage_cell_2, battery_status->voltage_cell_3, battery_status->voltage_cell_4, battery_status->voltage_cell_5, battery_status->voltage_cell_6, battery_status->current_battery, battery_status->current_consumed, battery_status->energy_consumed, battery_status->battery_remaining); -} - -/** - * @brief Send a battery_status message - * @param chan MAVLink channel to send the message - * - * @param accu_id Accupack ID - * @param voltage_cell_1 Battery voltage of cell 1, in millivolts (1 = 1 millivolt) - * @param voltage_cell_2 Battery voltage of cell 2, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_3 Battery voltage of cell 3, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_4 Battery voltage of cell 4, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_5 Battery voltage of cell 5, in millivolts (1 = 1 millivolt), -1: no cell - * @param voltage_cell_6 Battery voltage of cell 6, in millivolts (1 = 1 millivolt), -1: no cell - * @param current_battery Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current - * @param current_consumed Consumed charge, in milliampere hours (1 = 1 mAh), -1: autopilot does not provide mAh consumption estimate - * @param energy_consumed Consumed energy, in 100*Joules (intergrated U*I*dt) (1 = 100 Joule), -1: autopilot does not provide energy consumption estimate - * @param battery_remaining Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot does not estimate the remaining battery - */ -#ifdef MAVLINK_USE_CONVENIENCE_FUNCTIONS - -static inline void mavlink_msg_battery_status_send(mavlink_channel_t chan, uint8_t accu_id, uint16_t voltage_cell_1, uint16_t voltage_cell_2, uint16_t voltage_cell_3, uint16_t voltage_cell_4, uint16_t voltage_cell_5, uint16_t voltage_cell_6, int16_t current_battery, int32_t current_consumed, int32_t energy_consumed, int8_t battery_remaining) -{ -#if MAVLINK_NEED_BYTE_SWAP || !MAVLINK_ALIGNED_FIELDS - char buf[MAVLINK_MSG_ID_BATTERY_STATUS_LEN]; - _mav_put_int32_t(buf, 0, current_consumed); - _mav_put_int32_t(buf, 4, energy_consumed); - _mav_put_uint16_t(buf, 8, voltage_cell_1); - _mav_put_uint16_t(buf, 10, voltage_cell_2); - _mav_put_uint16_t(buf, 12, voltage_cell_3); - _mav_put_uint16_t(buf, 14, voltage_cell_4); - _mav_put_uint16_t(buf, 16, voltage_cell_5); - _mav_put_uint16_t(buf, 18, voltage_cell_6); - _mav_put_int16_t(buf, 20, current_battery); - _mav_put_uint8_t(buf, 22, accu_id); - _mav_put_int8_t(buf, 23, battery_remaining); - -#if MAVLINK_CRC_EXTRA - _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_BATTERY_STATUS, buf, MAVLINK_MSG_ID_BATTERY_STATUS_LEN, MAVLINK_MSG_ID_BATTERY_STATUS_CRC); -#else - _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_BATTERY_STATUS, buf, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif -#else - mavlink_battery_status_t packet; - packet.current_consumed = current_consumed; - packet.energy_consumed = energy_consumed; - packet.voltage_cell_1 = voltage_cell_1; - packet.voltage_cell_2 = voltage_cell_2; - packet.voltage_cell_3 = voltage_cell_3; - packet.voltage_cell_4 = voltage_cell_4; - packet.voltage_cell_5 = voltage_cell_5; - packet.voltage_cell_6 = voltage_cell_6; - packet.current_battery = current_battery; - packet.accu_id = accu_id; - packet.battery_remaining = battery_remaining; - -#if MAVLINK_CRC_EXTRA - _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_BATTERY_STATUS, (const char *)&packet, MAVLINK_MSG_ID_BATTERY_STATUS_LEN, MAVLINK_MSG_ID_BATTERY_STATUS_CRC); -#else - _mav_finalize_message_chan_send(chan, MAVLINK_MSG_ID_BATTERY_STATUS, (const char *)&packet, MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif -#endif -} - -#endif - -// MESSAGE BATTERY_STATUS UNPACKING - - -/** - * @brief Get field accu_id from battery_status message - * - * @return Accupack ID - */ -static inline uint8_t mavlink_msg_battery_status_get_accu_id(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint8_t(msg, 22); -} - -/** - * @brief Get field voltage_cell_1 from battery_status message - * - * @return Battery voltage of cell 1, in millivolts (1 = 1 millivolt) - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_1(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 8); -} - -/** - * @brief Get field voltage_cell_2 from battery_status message - * - * @return Battery voltage of cell 2, in millivolts (1 = 1 millivolt), -1: no cell - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_2(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 10); -} - -/** - * @brief Get field voltage_cell_3 from battery_status message - * - * @return Battery voltage of cell 3, in millivolts (1 = 1 millivolt), -1: no cell - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_3(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 12); -} - -/** - * @brief Get field voltage_cell_4 from battery_status message - * - * @return Battery voltage of cell 4, in millivolts (1 = 1 millivolt), -1: no cell - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_4(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 14); -} - -/** - * @brief Get field voltage_cell_5 from battery_status message - * - * @return Battery voltage of cell 5, in millivolts (1 = 1 millivolt), -1: no cell - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_5(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 16); -} - -/** - * @brief Get field voltage_cell_6 from battery_status message - * - * @return Battery voltage of cell 6, in millivolts (1 = 1 millivolt), -1: no cell - */ -static inline uint16_t mavlink_msg_battery_status_get_voltage_cell_6(const mavlink_message_t* msg) -{ - return _MAV_RETURN_uint16_t(msg, 18); -} - -/** - * @brief Get field current_battery from battery_status message - * - * @return Battery current, in 10*milliamperes (1 = 10 milliampere), -1: autopilot does not measure the current - */ -static inline int16_t mavlink_msg_battery_status_get_current_battery(const mavlink_message_t* msg) -{ - return _MAV_RETURN_int16_t(msg, 20); -} - -/** - * @brief Get field current_consumed from battery_status message - * - * @return Consumed charge, in milliampere hours (1 = 1 mAh), -1: autopilot does not provide mAh consumption estimate - */ -static inline int32_t mavlink_msg_battery_status_get_current_consumed(const mavlink_message_t* msg) -{ - return _MAV_RETURN_int32_t(msg, 0); -} - -/** - * @brief Get field energy_consumed from battery_status message - * - * @return Consumed energy, in 100*Joules (intergrated U*I*dt) (1 = 100 Joule), -1: autopilot does not provide energy consumption estimate - */ -static inline int32_t mavlink_msg_battery_status_get_energy_consumed(const mavlink_message_t* msg) -{ - return _MAV_RETURN_int32_t(msg, 4); -} - -/** - * @brief Get field battery_remaining from battery_status message - * - * @return Remaining battery energy: (0%: 0, 100%: 100), -1: autopilot does not estimate the remaining battery - */ -static inline int8_t mavlink_msg_battery_status_get_battery_remaining(const mavlink_message_t* msg) -{ - return _MAV_RETURN_int8_t(msg, 23); -} - -/** - * @brief Decode a battery_status message into a struct - * - * @param msg The message to decode - * @param battery_status C-struct to decode the message contents into - */ -static inline void mavlink_msg_battery_status_decode(const mavlink_message_t* msg, mavlink_battery_status_t* battery_status) -{ -#if MAVLINK_NEED_BYTE_SWAP - battery_status->current_consumed = mavlink_msg_battery_status_get_current_consumed(msg); - battery_status->energy_consumed = mavlink_msg_battery_status_get_energy_consumed(msg); - battery_status->voltage_cell_1 = mavlink_msg_battery_status_get_voltage_cell_1(msg); - battery_status->voltage_cell_2 = mavlink_msg_battery_status_get_voltage_cell_2(msg); - battery_status->voltage_cell_3 = mavlink_msg_battery_status_get_voltage_cell_3(msg); - battery_status->voltage_cell_4 = mavlink_msg_battery_status_get_voltage_cell_4(msg); - battery_status->voltage_cell_5 = mavlink_msg_battery_status_get_voltage_cell_5(msg); - battery_status->voltage_cell_6 = mavlink_msg_battery_status_get_voltage_cell_6(msg); - battery_status->current_battery = mavlink_msg_battery_status_get_current_battery(msg); - battery_status->accu_id = mavlink_msg_battery_status_get_accu_id(msg); - battery_status->battery_remaining = mavlink_msg_battery_status_get_battery_remaining(msg); -#else - memcpy(battery_status, _MAV_PAYLOAD(msg), MAVLINK_MSG_ID_BATTERY_STATUS_LEN); -#endif -} |