PacketVersion1.hpp

Go to the documentation of this file.

// MAVLink router and firewall.
// Copyright (C) 2018  Michael R. Shannon <mrshannon.aerospace@gmail.com>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.


#ifndef PACKETVERSION1_HPP_
#define PACKETVERSION1_HPP_


#include <cstdint>
#include <memory>
#include <string>
#include <vector>

#include "mavlink.hpp"
#include "Packet.hpp"


namespace packet_v1
{

    /** MAVLink v1.0 start byte (0xFE).
     */
    const uint8_t START_BYTE = MAVLINK_STX_MAVLINK1;


    /** MAVLink v1.0 header length (6 bytes).
     */
    const size_t HEADER_LENGTH = 1 + MAVLINK_CORE_HEADER_MAVLINK1_LEN;


    /** MAVLink v1.0 checksum length (2 bytes).
     */
    const size_t CHECKSUM_LENGTH = MAVLINK_NUM_CHECKSUM_BYTES;


    /** MAVLink v1.0 version.
     */
    const ::Packet::Version VERSION = ::Packet::V1;


    /** A MAVLink packet with the version 1 wire protocol.
     */
    class Packet : public ::Packet
    {
        public:
            /** Copy constructor.
             *
             *  \param other Packet to copy from.
             */
            Packet(const Packet &other) = default;
            /** Move constructor.
             *
             *  \param other Packet to move from.
             */
            Packet(Packet &&other) = default;
            Packet(std::vector<uint8_t> data);
            virtual ::Packet::Version version() const;
            virtual unsigned long id() const;
            virtual std::string name() const;
            virtual MAVAddress source() const;
            virtual std::optional<MAVAddress> dest() const;
            /** Assignment operator.
             *
             *  \param other Packet to copy from.
             */
            Packet &operator=(const Packet &other) = default;
            /** Assignment operator (by move semantics).
             *
             *  \param other Packet to move from.
             */
            Packet &operator=(Packet &&other) = default;
    };


    bool header_complete(const std::vector<uint8_t> &data);
    bool packet_complete(const std::vector<uint8_t> &data);
    const struct mavlink::v1_header *header(
        const std::vector<uint8_t> &data);

}


#endif // PACKETVERSION1_HPP_