MIP SDK  0.0.1
MicroStrain Communications Library for embedded systems
Classes | Public Types | Public Attributes | Static Public Attributes | List of all members
mip::commands_3dm::EventAction Struct Reference

#include <commands_3dm.hpp>

Collaboration diagram for mip::commands_3dm::EventAction:
Collaboration graph
[legend]

Classes

struct  GpioParams
 
struct  MessageParams
 
union  Parameters
 
struct  Response
 

Public Types

enum class  Type : uint8_t { NONE = 0 , GPIO = 1 , MESSAGE = 2 }
 

Public Attributes

FunctionSelector function = static_cast<FunctionSelector>(0)
 
uint8_t instance = 0
 Action number. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all instances. More...
 
uint8_t trigger = 0
 Trigger ID number. More...
 
Type type = static_cast<Type>(0)
 Type of action to configure. More...
 
Parameters parameters
 

Static Public Attributes

static const uint8_t DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET
 
static const uint8_t FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_EVENT_ACTION_CONFIG
 
static const bool HAS_WRITE_FUNCTION = true
 
static const bool HAS_READ_FUNCTION = true
 
static const bool HAS_SAVE_FUNCTION = true
 
static const bool HAS_LOAD_FUNCTION = true
 
static const bool HAS_RESET_FUNCTION = true
 

Member Enumeration Documentation

◆ Type

enum mip::commands_3dm::EventAction::Type : uint8_t
strong
Enumerator
NONE 

No action. Parameters should be empty.

GPIO 

Control the state of a GPIO pin. See GpioParameters.

MESSAGE 

Output a data packet. See MessageParameters.

Member Data Documentation

◆ DESCRIPTOR_SET

const uint8_t mip::commands_3dm::EventAction::DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET
static

◆ FIELD_DESCRIPTOR

const uint8_t mip::commands_3dm::EventAction::FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_EVENT_ACTION_CONFIG
static

◆ function

FunctionSelector mip::commands_3dm::EventAction::function = static_cast<FunctionSelector>(0)

◆ HAS_LOAD_FUNCTION

const bool mip::commands_3dm::EventAction::HAS_LOAD_FUNCTION = true
static

◆ HAS_READ_FUNCTION

const bool mip::commands_3dm::EventAction::HAS_READ_FUNCTION = true
static

◆ HAS_RESET_FUNCTION

const bool mip::commands_3dm::EventAction::HAS_RESET_FUNCTION = true
static

◆ HAS_SAVE_FUNCTION

const bool mip::commands_3dm::EventAction::HAS_SAVE_FUNCTION = true
static

◆ HAS_WRITE_FUNCTION

const bool mip::commands_3dm::EventAction::HAS_WRITE_FUNCTION = true
static

◆ instance

uint8_t mip::commands_3dm::EventAction::instance = 0

Action number. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all instances.

◆ parameters

Parameters mip::commands_3dm::EventAction::parameters

◆ trigger

uint8_t mip::commands_3dm::EventAction::trigger = 0

Trigger ID number.

◆ type

Type mip::commands_3dm::EventAction::type = static_cast<Type>(0)

Type of action to configure.


The documentation for this struct was generated from the following file: