APM:Libraries
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
JSButton Class Reference

#include <AP_JSButton.h>

Collaboration diagram for JSButton:
[legend]

Public Types

enum  button_function_t {
  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, 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,
  k_lights1_cycle = 31, k_lights1_brighter = 32, k_lights1_dimmer = 33, k_lights2_cycle = 34,
  k_lights2_brighter = 35, k_lights2_dimmer = 36, 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, 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,
  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, k_custom_1 = 91,
  k_custom_2 = 92, k_custom_3 = 93, k_custom_4 = 94, k_custom_5 = 95,
  k_custom_6 = 96, 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,
  k_nr_btn_functions
}
 

Public Member Functions

 JSButton ()
 
uint8_t function (bool shift=false) const
 
void set_default (button_function_t f, button_function_t sf)
 

Static Public Attributes

static const struct AP_Param::GroupInfo var_info []
 

Private Attributes

AP_Int8 _function
 
AP_Int8 _sfunction
 

Detailed Description

Definition at line 5 of file AP_JSButton.h.

Member Enumeration Documentation

◆ button_function_t

Enumerator
k_none 

disabled

k_shift 

"shift" buttons to allow more functions

k_arm_toggle 

arm/disarm vehicle toggle

k_arm 

arm vehicle

k_disarm 

disarm vehicle

k_mode_manual 

enter enter manual mode

k_mode_stabilize 

enter stabilize mode

k_mode_depth_hold 

enter depth hold mode

k_mode_poshold 

enter poshold mode

k_mode_auto 

enter auto mode

k_mode_circle 

enter circle mode

k_mode_guided 

enter guided mode

k_mode_acro 

enter acro mode

k_mount_center 

move mount to center

k_mount_tilt_up 

tilt mount up

k_mount_tilt_down 

tilt mount down

k_camera_trigger 

trigger camera shutter

k_camera_source_toggle 

toggle camera source

k_mount_pan_right 

pan mount right

k_mount_pan_left 

pan mount left

k_lights1_cycle 

lights 1 cycle

k_lights1_brighter 

lights 1 up

k_lights1_dimmer 

lights 1 down

k_lights2_cycle 

lights 2 cycle

k_lights2_brighter 

lights 2 up

k_lights2_dimmer 

lights 2 down

k_gain_toggle 

toggle different gain settings

k_gain_inc 

increase control gain

k_gain_dec 

decrease control gain

k_trim_roll_inc 

increase roll trim

k_trim_roll_dec 

decrease roll trim

k_trim_pitch_inc 

increase pitch trim

k_trim_pitch_dec 

decrease pitch trim

k_input_hold_set 

toggle input hold (trim to current controls)

k_roll_pitch_toggle 

adjust roll/pitch input instead of forward/lateral

k_relay_1_on 

trigger relay on

k_relay_1_off 

trigger relay off

k_relay_1_toggle 

trigger relay toggle

k_relay_2_on 

trigger relay on

k_relay_2_off 

trigger relay off

k_relay_2_toggle 

trigger relay toggle

k_relay_3_on 

trigger relay on

k_relay_3_off 

trigger relay off

k_relay_3_toggle 

trigger relay toggle

k_servo_1_inc 

increase servo output

k_servo_1_dec 

decrease servo output

k_servo_1_min 

center servo

k_servo_1_max 

set servo output to minimum (SERVOn_MIN)

k_servo_1_center 

set servo output to maximum (SERVOn_MAX)

k_servo_2_inc 
k_servo_2_dec 
k_servo_2_min 
k_servo_2_max 
k_servo_2_center 
k_servo_3_inc 
k_servo_3_dec 
k_servo_3_min 
k_servo_3_max 
k_servo_3_center 
k_servo_1_min_momentary 

set servo output to minimum (SERVOn_MIN) until released

k_servo_1_max_momentary 

set servo output to minimum (SERVOn_MAX) until released

k_servo_1_min_toggle 

toggle servo output btwn trim (SERVOn_TRIM) and min (SERVOn_MIN)

k_servo_1_max_toggle 

toggle servo output btwn trim (SERVOn_TRIM) and max (SERVOn_MAX)

k_servo_2_min_momentary 
k_servo_2_max_momentary 
k_servo_2_min_toggle 
k_servo_2_max_toggle 
k_servo_3_min_momentary 
k_servo_3_max_momentary 
k_servo_3_min_toggle 
k_servo_3_max_toggle 
k_custom_1 

custom user button 1

k_custom_2 

custom user button 2

k_custom_3 

custom user button 3

k_custom_4 

custom user button 4

k_custom_5 

custom user button 5

k_custom_6 

custom user button 6

k_relay_4_on 

trigger relay on

k_relay_4_off 

trigger relay off

k_relay_4_toggle 

trigger relay toggle

k_relay_1_momentary 

relay toggle when button is pushed, and again when released

k_relay_2_momentary 
k_relay_3_momentary 
k_relay_4_momentary 
k_nr_btn_functions 

This must be the last enum value (only add new values before this one)

Definition at line 10 of file AP_JSButton.h.

Constructor & Destructor Documentation

◆ JSButton()

JSButton::JSButton ( void  )

Definition at line 22 of file AP_JSButton.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ function()

uint8_t JSButton::function ( bool  shift = false) const

Definition at line 27 of file AP_JSButton.cpp.

◆ set_default()

void JSButton::set_default ( button_function_t  f,
button_function_t  sf 
)

Definition at line 35 of file AP_JSButton.cpp.

Member Data Documentation

◆ _function

AP_Int8 JSButton::_function
private

Definition at line 130 of file AP_JSButton.h.

Referenced by function(), and set_default().

◆ _sfunction

AP_Int8 JSButton::_sfunction
private

Definition at line 131 of file AP_JSButton.h.

Referenced by function(), and set_default().

◆ var_info

const AP_Param::GroupInfo JSButton::var_info
static
Initial value:
= {
AP_GROUPINFO("FUNCTION", 1, JSButton, _function, 0),
AP_GROUPINFO("SFUNCTION", 2, JSButton, _sfunction, 0),
}

Definition at line 126 of file AP_JSButton.h.

Referenced by JSButton().


The documentation for this class was generated from the following files: