(0x0C,0x2A) Get Event Support [C]

Collaboration diagram for (0x0C,0x2A) Get Event Support [C]:

Classes
struct	mip::C::mip_3dm_get_event_support_command_info
struct	mip::C::mip_3dm_get_event_support_command
struct	mip::C::mip_3dm_get_event_support_response

Typedefs
typedef uint8_t	mip::C::mip_3dm_get_event_support_command_query
typedef struct mip_3dm_get_event_support_command_info	mip::C::mip_3dm_get_event_support_command_info
typedef struct mip_3dm_get_event_support_command	mip::C::mip_3dm_get_event_support_command
typedef struct mip_3dm_get_event_support_response	mip::C::mip_3dm_get_event_support_response

Functions
void	mip::C::insert_mip_3dm_get_event_support_command (mip_serializer *serializer, const mip_3dm_get_event_support_command *self)
void	mip::C::extract_mip_3dm_get_event_support_command (mip_serializer *serializer, mip_3dm_get_event_support_command *self)
void	mip::C::insert_mip_3dm_get_event_support_command_query (struct mip_serializer *serializer, const mip_3dm_get_event_support_command_query self)
void	mip::C::extract_mip_3dm_get_event_support_command_query (struct mip_serializer *serializer, mip_3dm_get_event_support_command_query *self)
void	mip::C::insert_mip_3dm_get_event_support_command_info (mip_serializer *serializer, const mip_3dm_get_event_support_command_info *self)
void	mip::C::extract_mip_3dm_get_event_support_command_info (mip_serializer *serializer, mip_3dm_get_event_support_command_info *self)
void	mip::C::insert_mip_3dm_get_event_support_response (mip_serializer *serializer, const mip_3dm_get_event_support_response *self)
void	mip::C::extract_mip_3dm_get_event_support_response (mip_serializer *serializer, mip_3dm_get_event_support_response *self)
mip_cmd_result	mip::C::mip_3dm_get_event_support (struct mip_interface *device, mip_3dm_get_event_support_command_query query, uint8_t *max_instances_out, uint8_t *num_entries_out, uint8_t num_entries_out_max, mip_3dm_get_event_support_command_info *entries_out)

Detailed Description

Lists the available trigger or action types.

There are a limited number of trigger and action slots available in the device. Up to M triggers and N actions can be configured at once in slots 1..M and 1..N respectively. M and N are identified by the max_instances field in the response with the appropriate query selector.

Each slot can be configured as one of a variety of different types of triggers or actions. The supported types are enumerated in the response to this command. Additionally, there is a limit on the number of a given type. In other words, while the device may support M triggers in total, only a few of them maybe usable as a given type. This limit helps optimize device resources. The limit is identified in the count field.

All of the information in this command is available in the user manual. This command provides a programmatic method for obtaining the information.

Typedef Documentation

mip_3dm_get_event_support_command

typedef struct mip_3dm_get_event_support_command mip::C::mip_3dm_get_event_support_command

mip_3dm_get_event_support_command_info

typedef struct mip_3dm_get_event_support_command_info mip::C::mip_3dm_get_event_support_command_info

mip_3dm_get_event_support_command_query

typedef uint8_t mip::C::mip_3dm_get_event_support_command_query

mip_3dm_get_event_support_response

typedef struct mip_3dm_get_event_support_response mip::C::mip_3dm_get_event_support_response

Function Documentation

extract_mip_3dm_get_event_support_command()

void mip::C::extract_mip_3dm_get_event_support_command	(	mip_serializer *	serializer,
		mip_3dm_get_event_support_command *	self
	)

extract_mip_3dm_get_event_support_command_info()

void mip::C::extract_mip_3dm_get_event_support_command_info	(	mip_serializer *	serializer,
		mip_3dm_get_event_support_command_info *	self
	)

extract_mip_3dm_get_event_support_command_query()

void mip::C::extract_mip_3dm_get_event_support_command_query	(	struct mip_serializer *	serializer,
		mip_3dm_get_event_support_command_query *	self
	)

extract_mip_3dm_get_event_support_response()

void mip::C::extract_mip_3dm_get_event_support_response	(	mip_serializer *	serializer,
		mip_3dm_get_event_support_response *	self
	)

insert_mip_3dm_get_event_support_command()

void mip::C::insert_mip_3dm_get_event_support_command	(	mip_serializer *	serializer,
		const mip_3dm_get_event_support_command *	self
	)

insert_mip_3dm_get_event_support_command_info()

void mip::C::insert_mip_3dm_get_event_support_command_info	(	mip_serializer *	serializer,
		const mip_3dm_get_event_support_command_info *	self
	)

insert_mip_3dm_get_event_support_command_query()

void mip::C::insert_mip_3dm_get_event_support_command_query	(	struct mip_serializer *	serializer,
		const mip_3dm_get_event_support_command_query	self
	)

insert_mip_3dm_get_event_support_response()

void mip::C::insert_mip_3dm_get_event_support_response	(	mip_serializer *	serializer,
		const mip_3dm_get_event_support_response *	self
	)

mip_3dm_get_event_support()

mip_cmd_result mip::C::mip_3dm_get_event_support	(	struct mip_interface *	device,
		mip_3dm_get_event_support_command_query	query,
		uint8_t *	max_instances_out,
		uint8_t *	num_entries_out,
		uint8_t	num_entries_out_max,
		mip_3dm_get_event_support_command_info *	entries_out
	)