Kuon Common Simple Types

Classes
struct	KuonMotorCfg_T
struct	KuonImu_T

Enumerations
enum	kuon::KuonTriState {   kuon::KuonTriStateUnknown = -1,   kuon::KuonTriStateFalse = 0,   kuon::KuonTriStateOff = 0,   kuon::KuonTriStateDisabled = 0,   kuon::KuonTriStateLow = 0,   kuon::KuonTriStateOpen = 0,   kuon::KuonTriStateDark = 0,   kuon::KuonTriStateTrue = 1,   kuon::KuonTriStateOn = 1,   kuon::KuonTriStateEnabled = 1,   kuon::KuonTriStateHigh = 1,   kuon::KuonTriStateClosed = 1,   kuon::KuonTriStateLight = 1 }
	Kuon tri-state type. More...
enum	kuon::KuonRobotMode {   kuon::KuonRobotModeUnknown = -1,   kuon::KuonRobotModeManual = 1,   kuon::KuonRobotModeAuto = 2 }
	Kuon mode of operation. More...
enum	kuon::KuonAsyncTaskState {   kuon::KuonAsyncTaskStateIdle = 0,   kuon::KuonAsyncTaskStateWorking = 1 }
	Asynchronous task state. More...

Detailed Description

Common types used to control and report robot information. fields.

Enumeration Type Documentation

enum kuon::KuonAsyncTaskState

Asynchronous task state.

Enumerator
KuonAsyncTaskStateIdle	idle, no async task running
KuonAsyncTaskStateWorking	async task running

Definition at line 374 of file kuon.h.

  {
    KuonAsyncTaskStateIdle    = 0,    ///< idle, no async task running
    KuonAsyncTaskStateWorking = 1     ///< async task running
  };

enum kuon::KuonRobotMode

Kuon mode of operation.

Robot mode of operation.

Enumerator
KuonRobotModeUnknown	unknown mode state
KuonRobotModeManual	can only be operated locally, not remotely
KuonRobotModeAuto	fully available

Definition at line 364 of file kuon.h.

  {
    KuonRobotModeUnknown  = -1, ///< unknown mode state
    KuonRobotModeManual   =  1, ///< can only be operated locally, not remotely
    KuonRobotModeAuto     =  2  ///< fully available
  };

enum kuon::KuonTriState

Kuon tri-state type.

Basically, a tri-state value is either unknown, 0, or 1.

Enumerator
KuonTriStateUnknown	unknown state
KuonTriStateFalse	false
KuonTriStateOff	off
KuonTriStateDisabled	disabled
KuonTriStateLow	low
KuonTriStateOpen	open
KuonTriStateDark	dark
KuonTriStateTrue	true
KuonTriStateOn	on
KuonTriStateEnabled	enabled
KuonTriStateHigh	high
KuonTriStateClosed	closed
KuonTriStateLight	light

Definition at line 337 of file kuon.h.

  {
    // unknown
    KuonTriStateUnknown   = -1,     ///< unknown state

    // low state synonyms
    KuonTriStateFalse     = 0,      ///< false
    KuonTriStateOff       = 0,      ///< off
    KuonTriStateDisabled  = 0,      ///< disabled
    KuonTriStateLow       = 0,      ///< low
    KuonTriStateOpen      = 0,      ///< open
    KuonTriStateDark      = 0,      ///< dark

    // high state synonyms
    KuonTriStateTrue      = 1,      ///< true
    KuonTriStateOn        = 1,      ///< on
    KuonTriStateEnabled   = 1,      ///< enabled
    KuonTriStateHigh      = 1,      ///< high
    KuonTriStateClosed    = 1,      ///< closed
    KuonTriStateLight     = 1       ///< light
  };