"""Serial Command Enums"""
# pylint: disable=bad-whitespace
[docs]class Cmd:
"""the domain of key/value pairs used for serial commands to the roboclaw.
Each command represents a specfic function of the :py:class:`~roboclaw.Roboclaw`
driver.
"""
M1FORWARD = 0 #: The `forward_m1` command byte
M1BACKWARD = 1 #: The `backward_m1` command byte
SETMINMB = 2 #: The `set_min_voltage_main_battery` command byte
SETMAXMB = 3 #: The `set_max_voltage_main_battery` command byte
M2FORWARD = 4 #: The `forward_m2` command byte
M2BACKWARD = 5 #: The `backward_m2` command byte
M17BIT = 6 #: The `forward_backward_m1` command byte
M27BIT = 7 #: The `forward_backward_m2` command byte
MIXEDFORWARD = 8 #: The `forward_mixed` command byte
MIXEDBACKWARD = 9 #: The `backward_mixed` command byte
MIXEDRIGHT = 10 #: The `turn_right_mixed` command byte
MIXEDLEFT = 11 #: The `turn_left_mixed` command byte
MIXEDFB = 12 #: The `forward_backward_mixed` command byte
MIXEDLR = 13 #: The `left_right_mixed` command byte
GETM1ENC = 16 #: The `read_encoder_m1` command byte
GETM2ENC = 17 #: The `read_encoder_m2` command byte
GETM1SPEED = 18 #: The `read_speed_m1` command byte
GETM2SPEED = 19 #: The `read_speed_m2` command byte
RESETENC = 20 #: The `reset_encoders` command byte
GETVERSION = 21 #: The `read_version` command byte
SETM1ENCCOUNT = 22 #: The `set_enc_m1` command byte
SETM2ENCCOUNT = 23 #: The `set_enc_m2` command byte
GETMBATT = 24 #: The `read_main_battery_voltage` command byte
GETLBATT = 25 #: The `read_logic_battery_voltage` command byte
SETMINLB = 26 #: The `set_min_voltage_logic_battery` command byte
SETMAXLB = 27 #: The `set_max_voltage_logic_battery` command byte
SETM1PID = 28 #: The `set_m1_velocity_pid` command byte
SETM2PID = 29 #: The `set_m2_velocity_pid` command byte
GETM1ISPEED = 30 #: The `read_raw_speed_m1` command byte
GETM2ISPEED = 31 #: The `read_raw_speed_m2` command byte
M1DUTY = 32 #: The `duty_m1` command byte
M2DUTY = 33 #: The `duty_m2` command byte
MIXEDDUTY = 34 #: The `duty_m1_m2` command byte
M1SPEED = 35 #: The `speed_m1` command byte
M2SPEED = 36 #: The `speed_m2` command byte
MIXEDSPEED = 37 #: The `speed_m1_m2` command byte
M1SPEEDACCEL = 38 #: The `speed_accel_m1` command byte
M2SPEEDACCEL = 39 #: The `speed_accel_m2` command byte
MIXEDSPEEDACCEL = 40 #: The `speed_accel_m1_m2` command byte
M1SPEEDDIST = 41 #: The `speed_distance_m1` command byte
M2SPEEDDIST = 42 #: The `speed_distance_m2` command byte
MIXEDSPEEDDIST = 43 #: The `speed_distance_m1_m2` command byte
M1SPEEDACCELDIST = 44 #: The `speed_accel_distance_m1` command byte
M2SPEEDACCELDIST = 45 #: The `speed_accel_distance_m2` command byte
MIXEDSPEEDACCELDIST = 46 #: The `speed_accel_distance_m1_m2` command byte
GETBUFFERS = 47 #: The `read_buffer_length` command byte
GETPWMS = 48 #: The `read_pwms` command byte
GETCURRENTS = 49 #: The `read_currents` command byte
MIXEDSPEED2ACCEL = 50 #: The `speed_accel_m1_m2_2` command byte
MIXEDSPEED2ACCELDIST = 51 #: The `speed_accel_distance_m1_m2_2` command byte
M1DUTYACCEL = 52 #: The `duty_accel_m1` command byte
M2DUTYACCEL = 53 #: The `duty_accel_m2` command byte
MIXEDDUTYACCEL = 54 #: The `duty_accel_m1_m2` command byte
READM1PID = 55 #: The `read_m1_velocity_pid` command byte
READM2PID = 56 #: The `read_m2_velocity_pid` command byte
SETMAINVOLTAGES = 57 #: The `set_main_voltages` command byte
SETLOGICVOLTAGES = 58 #: The `set_logic_voltages` command byte
GETMINMAXMAINVOLTAGES = 59 #: The `read_min_max_main_voltages` command byte
GETMINMAXLOGICVOLTAGES = 60 #: The `read_min_max_logic_voltages` command byte
SETM1POSPID = 61 #: The `set_m1_position_pid` command byte
SETM2POSPID = 62 #: The `set_m2_position_pid` command byte
READM1POSPID = 63 #: The `read_m1_position_pid` command byte
READM2POSPID = 64 #: The `read_m2_position_pid` command byte
M1SPEEDACCELDECCELPOS = 65 #: The `speed_accel_deccel_position_m1` command byte
M2SPEEDACCELDECCELPOS = 66 #: The `speed_accel_deccel_position_m2` command byte
MIXEDSPEEDACCELDECCELPOS = 67 #: The `speed_accel_deccel_position_m1_m2` command byte
SETM1DEFAULTACCEL = 68 #: The `set_m1_default_accel` command byte
SETM2DEFAULTACCEL = 69 #: The `set_m2_default_accel` command byte
SETPINFUNCTIONS = 74 #: The `set_pin_functions` command byte
GETPINFUNCTIONS = 75 #: The `read_pin_functions` command byte
SETDEADBAND = 76 #: The `set_deadband` command byte
GETDEADBAND = 77 #: The `get_deadband` command byte
RESTOREDEFAULTS = 80 #: The `restore_defaults` command byte
GETTEMP = 82 #: The `read_temp` command byte
GETTEMP2 = 83 #: The `read_temp2` command byte
GETERROR = 90 #: The `read_error` command byte
GETENCODERMODE = 91 #: The `read_encoder_modes` command byte
SETM1ENCODERMODE = 92 #: The `set_m1_encoder_mode` command byte
SETM2ENCODERMODE = 93 #: The `set_m2_encoder_mode` command byte
WRITENVM = 94 #: The `write_nvm` command byte
READNVM = 95 #: The `read_nvm` command byte
SETCONFIG = 98 #: The `set_config` command byte
GETCONFIG = 99 #: The `get_config` command byte
SETM1MAXCURRENT = 133 #: The `set_m1_max_current` command byte
SETM2MAXCURRENT = 134 #: The `set_m2_max_current` command byte
GETM1MAXCURRENT = 135 #: The `read_m1_max_current` command byte
GETM2MAXCURRENT = 136 #: The `read_m2_max_current` command byte
SETPWMMODE = 148 #: The `set_pwm_mode` command byte
GETPWMMODE = 149 #: The `read_pwm_mode` command byte
READEEPROM = 252 #: The `read_eeprom` command byte
WRITEEEPROM = 253 #: The `write_eeprom` command byte
FLAGBOOTLOADER = 255 #: The command byte