sol-mavlink.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#ifdef __cplusplus
extern "C" {
#endif

struct sol_mavlink;
typedef struct sol_mavlink sol_mavlink;

enum sol_mavlink_mode {
    SOL_MAVLINK_MODE_ACRO = 1,

    SOL_MAVLINK_MODE_ALT_HOLD = 2,
    SOL_MAVLINK_MODE_ALTITUDE = 3,

    SOL_MAVLINK_MODE_AUTO = 4,

    SOL_MAVLINK_MODE_AUTO_TUNE = 5,

    SOL_MAVLINK_MODE_CIRCLE = 6,

    SOL_MAVLINK_MODE_CRUISE = 7,

    SOL_MAVLINK_MODE_DRIFT = 8,

    SOL_MAVLINK_MODE_EASY = 9,
    SOL_MAVLINK_MODE_FBWA = 10,
    SOL_MAVLINK_MODE_FBWB = 11,
    SOL_MAVLINK_MODE_FLIP = 12,

    SOL_MAVLINK_MODE_GUIDED = 13,
    SOL_MAVLINK_MODE_HOLD = 14,
    SOL_MAVLINK_MODE_INITIALISING = 15,

    SOL_MAVLINK_MODE_LAND = 16,
    SOL_MAVLINK_MODE_LEARNING = 17,

    SOL_MAVLINK_MODE_LOITER = 18,
    SOL_MAVLINK_MODE_MANUAL = 19,
    SOL_MAVLINK_MODE_OF_LOITER = 20,

    SOL_MAVLINK_MODE_POS_HOLD = 21,

    SOL_MAVLINK_MODE_POSITION = 22,

    SOL_MAVLINK_MODE_RTL = 23,
    SOL_MAVLINK_MODE_SCAN = 24,

    SOL_MAVLINK_MODE_SPORT = 25,

    SOL_MAVLINK_MODE_STABILIZE = 26,
    SOL_MAVLINK_MODE_STEERING = 27,
    SOL_MAVLINK_MODE_STOP = 28,
    SOL_MAVLINK_MODE_TRAINING = 29,
    SOL_MAVLINK_MODE_UNKNOWN = 30,
};

typedef struct sol_mavlink_position {
    float latitude;

    float longitude;

    float altitude;

    float x;

    float y;

    float z;
} sol_mavlink_position;

typedef struct sol_mavlink_handlers {
#ifndef SOL_NO_API_VERSION
#define SOL_MAVLINK_HANDLERS_API_VERSION (1)

    uint16_t api_version;
#endif

    void (*connect) (void *data, struct sol_mavlink *mavlink);

    void (*mode_changed) (void *data, struct sol_mavlink *mavlink);

    void (*armed) (void *data, struct sol_mavlink *mavlink);

    void (*disarmed) (void *data, struct sol_mavlink *mavlink);

    void (*position_changed) (void *data, struct sol_mavlink *mavlink);

    void (*mission_reached) (void *data, struct sol_mavlink *mavlink);
} sol_mavlink_handlers;

typedef struct sol_mavlink_config {
#ifndef SOL_NO_API_VERSION
#define SOL_MAVLINK_CONFIG_API_VERSION (1)

    uint16_t api_version;
#endif

    const struct sol_mavlink_handlers *handlers;

    int baud_rate;
} sol_mavlink_config;

struct sol_mavlink *sol_mavlink_connect(const char *addr, const struct sol_mavlink_config *config, const void *data);

void sol_mavlink_disconnect(struct sol_mavlink *mavlink);

int sol_mavlink_set_armed(struct sol_mavlink *mavlink, bool armed);

int sol_mavlink_take_off(struct sol_mavlink *mavlink, struct sol_mavlink_position *pos);

int sol_mavlink_set_mode(struct sol_mavlink *mavlink, enum sol_mavlink_mode mode);

enum sol_mavlink_mode sol_mavlink_get_mode(struct sol_mavlink *mavlink);

bool sol_mavlink_is_armed(struct sol_mavlink *mavlink);

int sol_mavlink_get_current_position(struct sol_mavlink *mavlink, struct sol_mavlink_position *pos);

int sol_mavlink_get_home_position(struct sol_mavlink *mavlink, struct sol_mavlink_position *pos);

int sol_mavlink_land(struct sol_mavlink *mavlink, struct sol_mavlink_position *pos);

int sol_mavlink_go_to(struct sol_mavlink *mavlink, struct sol_mavlink_position *pos);

int sol_mavlink_change_speed(struct sol_mavlink *mavlink, float speed, bool airspeed);

#ifdef __cplusplus
}
#endif