MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/communication/mavlink_stream.hpp
00001 /*******************************************************************************
00002  * Copyright (c) 2009-2016, MAV'RIC Development Team
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  * this list of conditions and the following disclaimer.
00010  *
00011  * 2. Redistributions in binary form must reproduce the above copyright notice,
00012  * this list of conditions and the following disclaimer in the documentation
00013  * and/or other materials provided with the distribution.
00014  *
00015  * 3. Neither the name of the copyright holder nor the names of its contributors
00016  * may be used to endorse or promote products derived from this software without
00017  * specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  ******************************************************************************/
00031 
00032 /*******************************************************************************
00033  * \file mavlink_stream.hpp
00034  *
00035  * \author MAV'RIC Team
00036  * \author Julien Lecoeur
00037  *
00038  * \brief A wrapper for MAVLink to use the stream interface
00039  *
00040  ******************************************************************************/
00041 
00042 
00043 #ifndef MAVLINK_STREAM_HPP_
00044 #define MAVLINK_STREAM_HPP_
00045 
00046 #include <cstdint>
00047 #include <cstdbool>
00048 #include "hal/common/serial.hpp"
00049 
00050 extern "C"
00051 {
00052 #include "hal/common/mavric_endian.h"
00053 }
00054 
00055 #ifdef __MAVRIC_ENDIAN_BIG__
00056 #define NATIVE_BIG_ENDIAN
00057 #endif
00058 
00059 extern "C"
00060 {
00061 #include "libs/mavlink/include/mavric/mavlink.h"
00062 }
00063 
00064 #define MAVLINK_BASE_STATION_ID 255
00065 
00069 class Mavlink_stream
00070 {
00071 public:
00072 
00076     typedef struct
00077     {
00078         mavlink_message_t msg;          
00079         mavlink_status_t status;        
00080     } msg_received_t;
00081 
00085     struct conf_t
00086     {
00087         uint32_t sysid;                 
00088         uint32_t compid;                
00089         bool     debug;                 
00090     };
00091 
00095     static conf_t default_config(void);
00096 
00100     Mavlink_stream(Serial& serial, const conf_t& config = default_config());
00101 
00102 
00110     bool send(mavlink_message_t* msg) const;
00111 
00119     bool receive(msg_received_t* rec);
00120 
00124     void flush();
00125 
00131     inline uint32_t sysid() const {return sysid_;};    // inline for higher exec speed
00132 
00138     inline uint32_t compid() const {return compid_;};    // inline for higher exec speed
00139 
00140     uint32_t sysid_;             
00141 
00142 private:
00143 
00144     uint32_t compid_;            
00145     Serial& serial_;
00146     uint8_t mavlink_channel_;    
00147     bool debug_;                  
00148 };
00149 
00150 #endif /* MAVLINK_STREAM_H */
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines