MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Classes | Typedefs | Enumerations | Functions
(0x0C,0x2F) Event Action

Configures various types of event actions. More...

Classes

struct  mip::C::mip_3dm_event_action_command_gpio_params
 
struct  mip::C::mip_3dm_event_action_command_message_params
 
union  mip::C::mip_3dm_event_action_command_parameters
 
struct  mip::C::mip_3dm_event_action_command
 
struct  mip::C::mip_3dm_event_action_response
 

Typedefs

typedef enum mip_3dm_event_action_command_gpio_params_mode mip::C::mip_3dm_event_action_command_gpio_params_mode
 
typedef struct mip_3dm_event_action_command_gpio_params mip::C::mip_3dm_event_action_command_gpio_params
 
typedef struct mip_3dm_event_action_command_message_params mip::C::mip_3dm_event_action_command_message_params
 
typedef enum mip_3dm_event_action_command_type mip::C::mip_3dm_event_action_command_type
 
typedef union mip_3dm_event_action_command_parameters mip::C::mip_3dm_event_action_command_parameters
 
typedef struct mip_3dm_event_action_command mip::C::mip_3dm_event_action_command
 
typedef struct mip_3dm_event_action_response mip::C::mip_3dm_event_action_response
 

Enumerations

enum  mip::C::mip_3dm_event_action_command_gpio_params_mode {
  mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_DISABLED = 0, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ACTIVE_HIGH = 1, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ACTIVE_LOW = 2, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ONESHOT_HIGH = 5,
  mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ONESHOT_LOW = 6, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_TOGGLE = 7
}
 
enum  mip::C::mip_3dm_event_action_command_type { mip::C::MIP_3DM_EVENT_ACTION_COMMAND_TYPE_NONE = 0, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_TYPE_GPIO = 1, mip::C::MIP_3DM_EVENT_ACTION_COMMAND_TYPE_MESSAGE = 2 }
 

Functions

void mip::C::insert_mip_3dm_event_action_command_gpio_params (microstrain_serializer *serializer, const mip_3dm_event_action_command_gpio_params *self)
 
void mip::C::extract_mip_3dm_event_action_command_gpio_params (microstrain_serializer *serializer, mip_3dm_event_action_command_gpio_params *self)
 
void mip::C::insert_mip_3dm_event_action_command_message_params (microstrain_serializer *serializer, const mip_3dm_event_action_command_message_params *self)
 
void mip::C::extract_mip_3dm_event_action_command_message_params (microstrain_serializer *serializer, mip_3dm_event_action_command_message_params *self)
 
void mip::C::insert_mip_3dm_event_action_command (microstrain_serializer *serializer, const mip_3dm_event_action_command *self)
 
void mip::C::extract_mip_3dm_event_action_command (microstrain_serializer *serializer, mip_3dm_event_action_command *self)
 
void mip::C::insert_mip_3dm_event_action_response (microstrain_serializer *serializer, const mip_3dm_event_action_response *self)
 
void mip::C::extract_mip_3dm_event_action_response (microstrain_serializer *serializer, mip_3dm_event_action_response *self)
 
mip_cmd_result mip::C::mip_3dm_write_event_action (mip_interface *device, uint8_t instance, uint8_t trigger, mip_3dm_event_action_command_type type, const mip_3dm_event_action_command_parameters *parameters)
 
mip_cmd_result mip::C::mip_3dm_read_event_action (mip_interface *device, uint8_t instance, uint8_t *trigger_out, mip_3dm_event_action_command_type *type_out, mip_3dm_event_action_command_parameters *parameters_out)
 
mip_cmd_result mip::C::mip_3dm_save_event_action (mip_interface *device, uint8_t instance)
 
mip_cmd_result mip::C::mip_3dm_load_event_action (mip_interface *device, uint8_t instance)
 
mip_cmd_result mip::C::mip_3dm_default_event_action (mip_interface *device, uint8_t instance)
 

Detailed Description

Configures various types of event actions.

Typedef Documentation

◆ mip_3dm_event_action_command

◆ mip_3dm_event_action_command_gpio_params

◆ mip_3dm_event_action_command_gpio_params_mode

◆ mip_3dm_event_action_command_message_params

◆ mip_3dm_event_action_command_parameters

◆ mip_3dm_event_action_command_type

◆ mip_3dm_event_action_response

Enumeration Type Documentation

◆ mip_3dm_event_action_command_gpio_params_mode

Enumerator
MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_DISABLED 

Pin state will not be changed.

MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ACTIVE_HIGH 

Pin will be set high when the trigger is active and low otherwise.

MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ACTIVE_LOW 

Pin will be set low when the trigger is active and high otherwise.

MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ONESHOT_HIGH 

Pin will be set high each time the trigger activates. It will not be set low.

MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_ONESHOT_LOW 

Pin will be set low each time the trigger activates. It will not be set high.

MIP_3DM_EVENT_ACTION_COMMAND_GPIO_PARAMS_MODE_TOGGLE 

Pin will change to the opposite state each time the trigger activates.

◆ mip_3dm_event_action_command_type

Enumerator
MIP_3DM_EVENT_ACTION_COMMAND_TYPE_NONE 

No action. Parameters should be empty.

MIP_3DM_EVENT_ACTION_COMMAND_TYPE_GPIO 

Control the state of a GPIO pin. See GpioParameters.

MIP_3DM_EVENT_ACTION_COMMAND_TYPE_MESSAGE 

Output a data packet. See MessageParameters.

Function Documentation

◆ extract_mip_3dm_event_action_command()

void mip::C::extract_mip_3dm_event_action_command ( microstrain_serializer serializer,
mip_3dm_event_action_command self 
)

◆ extract_mip_3dm_event_action_command_gpio_params()

void mip::C::extract_mip_3dm_event_action_command_gpio_params ( microstrain_serializer serializer,
mip_3dm_event_action_command_gpio_params self 
)

◆ extract_mip_3dm_event_action_command_message_params()

void mip::C::extract_mip_3dm_event_action_command_message_params ( microstrain_serializer serializer,
mip_3dm_event_action_command_message_params self 
)

◆ extract_mip_3dm_event_action_response()

void mip::C::extract_mip_3dm_event_action_response ( microstrain_serializer serializer,
mip_3dm_event_action_response self 
)

◆ insert_mip_3dm_event_action_command()

void mip::C::insert_mip_3dm_event_action_command ( microstrain_serializer serializer,
const mip_3dm_event_action_command self 
)

◆ insert_mip_3dm_event_action_command_gpio_params()

void mip::C::insert_mip_3dm_event_action_command_gpio_params ( microstrain_serializer serializer,
const mip_3dm_event_action_command_gpio_params self 
)

◆ insert_mip_3dm_event_action_command_message_params()

void mip::C::insert_mip_3dm_event_action_command_message_params ( microstrain_serializer serializer,
const mip_3dm_event_action_command_message_params self 
)

◆ insert_mip_3dm_event_action_response()

void mip::C::insert_mip_3dm_event_action_response ( microstrain_serializer serializer,
const mip_3dm_event_action_response self 
)

◆ mip_3dm_default_event_action()

mip_cmd_result mip::C::mip_3dm_default_event_action ( mip_interface device,
uint8_t  instance 
)

◆ mip_3dm_load_event_action()

mip_cmd_result mip::C::mip_3dm_load_event_action ( mip_interface device,
uint8_t  instance 
)

◆ mip_3dm_read_event_action()

mip_cmd_result mip::C::mip_3dm_read_event_action ( mip_interface device,
uint8_t  instance,
uint8_t *  trigger_out,
mip_3dm_event_action_command_type type_out,
mip_3dm_event_action_command_parameters parameters_out 
)

◆ mip_3dm_save_event_action()

mip_cmd_result mip::C::mip_3dm_save_event_action ( mip_interface device,
uint8_t  instance 
)

◆ mip_3dm_write_event_action()

mip_cmd_result mip::C::mip_3dm_write_event_action ( mip_interface device,
uint8_t  instance,
uint8_t  trigger,
mip_3dm_event_action_command_type  type,
const mip_3dm_event_action_command_parameters parameters 
)