AP_JSButton.h

Go to the documentation of this file.

#pragma once

#include <AP_Param/AP_Param.h>

class JSButton {
public:
    JSButton();

    // Button functions
    typedef enum {
        k_none                  = 0,            
        k_shift                 = 1,            
        k_arm_toggle            = 2,            
        k_arm                   = 3,            
        k_disarm                = 4,            

        k_mode_manual           = 5,            
        k_mode_stabilize        = 6,            
        k_mode_depth_hold       = 7,            
        k_mode_poshold          = 8,            
        k_mode_auto             = 9,            
        k_mode_circle           = 10,           
        k_mode_guided           = 11,           
        k_mode_acro             = 12,           

        // 12-20 reserved for future mode functions
        k_mount_center          = 21,           
        k_mount_tilt_up         = 22,           
        k_mount_tilt_down       = 23,           
        k_camera_trigger        = 24,           
        k_camera_source_toggle  = 25,           
        k_mount_pan_right       = 26,           
        k_mount_pan_left        = 27,           
        // 26-30 reserved for future camera functions
        k_lights1_cycle         = 31,           
        k_lights1_brighter      = 32,           
        k_lights1_dimmer        = 33,           
        k_lights2_cycle         = 34,           
        k_lights2_brighter      = 35,           
        k_lights2_dimmer        = 36,           
        // 37-40 reserved for future light functions
        k_gain_toggle           = 41,           
        k_gain_inc              = 42,           
        k_gain_dec              = 43,           
        k_trim_roll_inc         = 44,           
        k_trim_roll_dec         = 45,           
        k_trim_pitch_inc        = 46,           
        k_trim_pitch_dec        = 47,           
        k_input_hold_set        = 48,           
        k_roll_pitch_toggle     = 49,           

        // 50 reserved for future function

        k_relay_1_on            = 51,           
        k_relay_1_off           = 52,           
        k_relay_1_toggle        = 53,           
        k_relay_2_on            = 54,           
        k_relay_2_off           = 55,           
        k_relay_2_toggle        = 56,           
        k_relay_3_on            = 57,           
        k_relay_3_off           = 58,           
        k_relay_3_toggle        = 59,           

        // 60 reserved for future function
        k_servo_1_inc           = 61,           
        k_servo_1_dec           = 62,           
        k_servo_1_min           = 63,           
        k_servo_1_max           = 64,           
        k_servo_1_center        = 65,           

        k_servo_2_inc           = 66,
        k_servo_2_dec           = 67,
        k_servo_2_min           = 68,
        k_servo_2_max           = 69,
        k_servo_2_center        = 70,

        k_servo_3_inc           = 71,
        k_servo_3_dec           = 72,
        k_servo_3_min           = 73,
        k_servo_3_max           = 74,
        k_servo_3_center        = 75,

        k_servo_1_min_momentary = 76,          
        k_servo_1_max_momentary = 77,          
        k_servo_1_min_toggle    = 78,          
        k_servo_1_max_toggle    = 79,          

        k_servo_2_min_momentary = 80,
        k_servo_2_max_momentary = 81,
        k_servo_2_min_toggle    = 82,
        k_servo_2_max_toggle    = 83,

        k_servo_3_min_momentary = 84,
        k_servo_3_max_momentary = 85,
        k_servo_3_min_toggle    = 86,
        k_servo_3_max_toggle    = 87,

        // 88-90 reserved for future functions
        k_custom_1              = 91,           
        k_custom_2              = 92,           
        k_custom_3              = 93,           
        k_custom_4              = 94,           
        k_custom_5              = 95,           
        k_custom_6              = 96,           
        // 97-100 reserved for future functions
        k_relay_4_on            = 101,           
        k_relay_4_off           = 102,           
        k_relay_4_toggle        = 103,           

        k_relay_1_momentary     = 104,           
        k_relay_2_momentary     = 105,
        k_relay_3_momentary     = 106,
        k_relay_4_momentary     = 107,

        // 108+ reserved for future functions
        k_nr_btn_functions         
    } button_function_t;

    // If shift is false, returns the function assigned to this button
    // If shift is true, returns the shift function assigned to this button
    uint8_t function(bool shift = false) const;

    // Sets the default function and shift function parameter values for this button
    void set_default(button_function_t f, button_function_t sf);

    static const struct AP_Param::GroupInfo var_info[];

private:
    // Button mappings
    AP_Int8 _function;
    AP_Int8 _sfunction;
};