mavlink.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, James Jackson and Daniel Koch, BYU MAGICC Lab
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ROSFLIGHT_FIRMWARE_MAVLINK_H
#define ROSFLIGHT_FIRMWARE_MAVLINK_H

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpedantic"
#pragma GCC diagnostic ignored "-Wswitch-default"
#pragma GCC diagnostic ignored "-Wcast-align"
#pragma GCC diagnostic ignored "-Wignored-qualifiers"
#pragma GCC diagnostic ignored "-Wpragmas"
#pragma GCC diagnostic ignored "-Waddress-of-packed-member"
#include "v1.0/rosflight/mavlink.h"
#pragma GCC diagnostic pop

#include "interface/comm_link.h"

#include "board.h"

namespace rosflight_firmware
{
class Board;

class Mavlink : public CommLinkInterface
{
public:
  Mavlink(Board &board);
  void init(uint32_t baud_rate, uint32_t dev) override;
  void receive() override;

  void send_attitude_quaternion(uint8_t system_id,
                                uint64_t timestamp_us,
                                const turbomath::Quaternion &attitude,
                                const turbomath::Vector &angular_velocity) override;
  void send_baro(uint8_t system_id, float altitude, float pressure, float temperature) override;
  void send_command_ack(uint8_t system_id, Command command, bool success) override;
  void send_diff_pressure(uint8_t system_id, float velocity, float pressure, float temperature) override;
  void send_heartbeat(uint8_t system_id, bool fixed_wing) override;
  void send_imu(uint8_t system_id,
                uint64_t timestamp_us,
                const turbomath::Vector &accel,
                const turbomath::Vector &gyro,
                float temperature) override;
  void send_log_message(uint8_t system_id, LogSeverity severity, const char *text) override;
  void send_mag(uint8_t system_id, const turbomath::Vector &mag) override;
  void send_named_value_int(uint8_t system_id, uint32_t timestamp_ms, const char *const name, int32_t value) override;
  void send_named_value_float(uint8_t system_id, uint32_t timestamp_ms, const char *const name, float value) override;
  void send_output_raw(uint8_t system_id, uint32_t timestamp_ms, const float raw_outputs[14]) override;
  void send_param_value_int(uint8_t system_id,
                            uint16_t index,
                            const char *const name,
                            int32_t value,
                            uint16_t param_count) override;
  void send_param_value_float(uint8_t system_id,
                              uint16_t index,
                              const char *const name,
                              float value,
                              uint16_t param_count) override;
  void send_rc_raw(uint8_t system_id, uint32_t timestamp_ms, const uint16_t channels[8]) override;
  void send_sonar(uint8_t system_id,
                  /* TODO enum type*/ uint8_t type,
                  float range,
                  float max_range,
                  float min_range) override;
  void send_status(uint8_t system_id,
                   bool armed,
                   bool failsafe,
                   bool rc_override,
                   bool offboard,
                   uint8_t error_code,
                   uint8_t control_mode,
                   int16_t num_errors,
                   int16_t loop_time_us) override;
  void send_timesync(uint8_t system_id, int64_t tc1, int64_t ts1) override;
  void send_version(uint8_t system_id, const char *const version) override;
  void send_gnss(uint8_t system_id, const GNSSData &data) override;
  void send_gnss_full(uint8_t system_id, const GNSSFull &full) override;
  void send_error_data(uint8_t system_id, const StateManager::BackupData &error_data) override;
  void send_battery_status(uint8_t system_id, float voltage, float current) override;

  inline void set_listener(ListenerInterface *listener) override { listener_ = listener; }

private:
  void send_message(const mavlink_message_t &msg);

  void handle_msg_param_request_list(const mavlink_message_t *const msg);
  void handle_msg_param_request_read(const mavlink_message_t *const msg);
  void handle_msg_param_set(const mavlink_message_t *const msg);
  void handle_msg_offboard_control(const mavlink_message_t *const msg);
  void handle_msg_external_attitude(const mavlink_message_t *const msg);
  void handle_msg_rosflight_cmd(const mavlink_message_t *const msg);
  void handle_msg_rosflight_aux_cmd(const mavlink_message_t *const msg);
  void handle_msg_timesync(const mavlink_message_t *const msg);
  void handle_msg_heartbeat(const mavlink_message_t *const msg);
  void handle_mavlink_message();

  Board &board_;

  uint32_t compid_ = 250;
  mavlink_message_t in_buf_;
  mavlink_status_t status_;
  bool initialized_ = false;

  ListenerInterface *listener_ = nullptr;
};

} // namespace rosflight_firmware

#endif // ROSFLIGHT_FIRMWARE_MAVLINK_H