(0x0C,0x2B) Event Control

Enables or disables event triggers. More...

Classes
struct	mip::C::mip_3dm_event_control_command
struct	mip::C::mip_3dm_event_control_response

Typedefs
typedef enum mip_3dm_event_control_command_mode	mip::C::mip_3dm_event_control_command_mode
typedef struct mip_3dm_event_control_command	mip::C::mip_3dm_event_control_command
typedef struct mip_3dm_event_control_response	mip::C::mip_3dm_event_control_response

Enumerations
enum	mip::C::mip_3dm_event_control_command_mode { mip::C::MIP_3DM_EVENT_CONTROL_COMMAND_MODE_DISABLED = 0, mip::C::MIP_3DM_EVENT_CONTROL_COMMAND_MODE_ENABLED = 1, mip::C::MIP_3DM_EVENT_CONTROL_COMMAND_MODE_TEST = 2, mip::C::MIP_3DM_EVENT_CONTROL_COMMAND_MODE_TEST_PULSE = 3 }

Functions
void	mip::C::insert_mip_3dm_event_control_command (microstrain_serializer *serializer, const mip_3dm_event_control_command *self)
void	mip::C::extract_mip_3dm_event_control_command (microstrain_serializer *serializer, mip_3dm_event_control_command *self)
void	mip::C::insert_mip_3dm_event_control_response (microstrain_serializer *serializer, const mip_3dm_event_control_response *self)
void	mip::C::extract_mip_3dm_event_control_response (microstrain_serializer *serializer, mip_3dm_event_control_response *self)
mip_cmd_result	mip::C::mip_3dm_write_event_control (mip_interface *device, uint8_t instance, mip_3dm_event_control_command_mode mode)
mip_cmd_result	mip::C::mip_3dm_read_event_control (mip_interface *device, uint8_t instance, mip_3dm_event_control_command_mode *mode_out)
mip_cmd_result	mip::C::mip_3dm_save_event_control (mip_interface *device, uint8_t instance)
mip_cmd_result	mip::C::mip_3dm_load_event_control (mip_interface *device, uint8_t instance)
mip_cmd_result	mip::C::mip_3dm_default_event_control (mip_interface *device, uint8_t instance)

Detailed Description

Enables or disables event triggers.

Triggers can be disabled, enabled, and tested. While disabled, a trigger will not evaluate its logic and effective behave like no trigger is configured. A disabled trigger will not activate any actions. Triggers are disabled by default.

Use this command to enable (or disable) a trigger, or to place it into a test mode. When in test mode, the trigger logic is disabled but the output is forced to the active state, meaning that it will behave as if the trigger logic is satisfied and any associated actions will execute.

Typedef Documentation

mip_3dm_event_control_command

typedef struct mip_3dm_event_control_command mip::C::mip_3dm_event_control_command

mip_3dm_event_control_command_mode

typedef enum mip_3dm_event_control_command_mode mip::C::mip_3dm_event_control_command_mode

mip_3dm_event_control_response

typedef struct mip_3dm_event_control_response mip::C::mip_3dm_event_control_response

Enumeration Type Documentation

mip_3dm_event_control_command_mode

enum mip::C::mip_3dm_event_control_command_mode

Enumerator
MIP_3DM_EVENT_CONTROL_COMMAND_MODE_DISABLED	Trigger is disabled.
MIP_3DM_EVENT_CONTROL_COMMAND_MODE_ENABLED	Trigger is enabled and will work normally.
MIP_3DM_EVENT_CONTROL_COMMAND_MODE_TEST	Forces the trigger to the active state for testing purposes.
MIP_3DM_EVENT_CONTROL_COMMAND_MODE_TEST_PULSE	Trigger is forced to the active state for one event cycle only. After the test cycle, the mode reverts to the previous state (either enabled or disabled).

Function Documentation

extract_mip_3dm_event_control_command()

void mip::C::extract_mip_3dm_event_control_command	(	microstrain_serializer *	serializer,
		mip_3dm_event_control_command *	self
	)

extract_mip_3dm_event_control_response()

void mip::C::extract_mip_3dm_event_control_response	(	microstrain_serializer *	serializer,
		mip_3dm_event_control_response *	self
	)

insert_mip_3dm_event_control_command()

void mip::C::insert_mip_3dm_event_control_command	(	microstrain_serializer *	serializer,
		const mip_3dm_event_control_command *	self
	)

insert_mip_3dm_event_control_response()

void mip::C::insert_mip_3dm_event_control_response	(	microstrain_serializer *	serializer,
		const mip_3dm_event_control_response *	self
	)

mip_3dm_default_event_control()

mip_cmd_result mip::C::mip_3dm_default_event_control	(	mip_interface *	device,
		uint8_t	instance
	)

mip_3dm_load_event_control()

mip_cmd_result mip::C::mip_3dm_load_event_control	(	mip_interface *	device,
		uint8_t	instance
	)

mip_3dm_read_event_control()

mip_cmd_result mip::C::mip_3dm_read_event_control	(	mip_interface *	device,
		uint8_t	instance,
		mip_3dm_event_control_command_mode *	mode_out
	)

mip_3dm_save_event_control()

mip_cmd_result mip::C::mip_3dm_save_event_control	(	mip_interface *	device,
		uint8_t	instance
	)

mip_3dm_write_event_control()

mip_cmd_result mip::C::mip_3dm_write_event_control	(	mip_interface *	device,
		uint8_t	instance,
		mip_3dm_event_control_command_mode	mode
	)