ardupilot/libraries/AP_LandingGear/AP_LandingGear.h
2015-01-07 11:58:15 +09:00

80 lines
2.7 KiB
C++

// -*- tab-width: 4; Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*-
/// @file AP_LandingGear.h
/// @brief Landing gear control library
#ifndef AP_LANDINGGEAR_H
#define AP_LANDINGGEAR_H
#include <AP_Param.h>
#include <AP_Common.h>
#include <AP_Relay.h>
#define AP_LANDINGGEAR_TRIGGER_TYPE_RELAY_0 0
#define AP_LANDINGGEAR_TRIGGER_TYPE_RELAY_1 1
#define AP_LANDINGGEAR_TRIGGER_TYPE_RELAY_2 2
#define AP_LANDINGGEAR_TRIGGER_TYPE_RELAY_3 3
#define AP_LANDINGGEAR_TRIGGER_TYPE_SERVO 10
#define AP_LANDINGGEAR_SERVO_RETRACT_PWM_DEFAULT 1250 // default PWM value to move servo to when landing gear is up
#define AP_LANDINGGEAR_SERVO_DEPLOY_PWM_DEFAULT 1750 // default PWM value to move servo to when landing gear is down
#define COMMAND_MODE_DEPLOY 0 // command gear to deploy
#define COMMAND_MODE_AUTO 1 // command gear to actuate automatically
#define COMMAND_MODE_RETRACT 2 // command gear to retract
/// @class AP_LandingGear
/// @brief Class managing the control of landing gear
class AP_LandingGear {
public:
/// Constructor
AP_LandingGear(AP_Relay& relay) :
_relay(relay),
_deployed(false),
_retract_enabled(false)
{
// setup parameter defaults
AP_Param::setup_object_defaults(this, var_info);
}
/// enabled - returns true if landing gear retract is enabled
bool enabled() const { return _retract_enabled; }
/// deployed - returns true if the landing gear is deployed
bool deployed() const { return _deployed; }
/// update - should be called at 10hz
void update();
void set_cmd_mode(int8_t cmd) { _command_mode = cmd; }
static const struct AP_Param::GroupInfo var_info[];
private:
bool _retract_enabled; // true if landing gear retraction is enabled
// Parameters
AP_Int8 _control_type; // 0,1,2,3:Relay 10:Servo
AP_Int16 _servo_retract_pwm; // PWM value to move servo to when gear is retracted
AP_Int16 _servo_deploy_pwm; // PWM value to move servo to when gear is deployed
// internal variables
AP_Relay &_relay; // pointer to relay object from the base class Relay.
bool _deployed; // true if the landing gear has been deployed, initialized false
int8_t _command_mode; // pilots commanded control mode: Manual Deploy, Auto, or Manual Retract
/// enable - enable landing gear retraction
void enable(bool on_off);
/// retract - retract landing gear
void retract();
/// deploy - deploy the landing gear
void deploy();
};
#endif /* AP_LANDINGGEAR_H */