ipc_digital_inputs

Digital Inputs Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_digital_input_result
	Dynamic-length array of a_ipc_enum_digital_input_result. More...
struct	a_ipc_dyn_array_enum_digital_input_channel
	Dynamic-length array of a_ipc_enum_digital_input_channel. More...
struct	a_ipc_dyn_array_enum_digital_input_value
	Dynamic-length array of a_ipc_enum_digital_input_value. More...
struct	a_ipc_dyn_array_enum_digital_input_state
	Dynamic-length array of a_ipc_enum_digital_input_state. More...
struct	a_ipc_msg_digital_input_channel_set_configuration_req
	Configure a digital input channel. More...
struct	a_ipc_msg_digital_input_channel_set_configuration_rsp
	Sent in response to a_ipc_msg_digital_input_channel_set_configuration_req. More...
struct	a_ipc_msg_digital_input_channel_get_configuration_req
	Read configuration of a digital input channel. More...
struct	a_ipc_msg_digital_input_channel_get_configuration_rsp
	Sent in response to a_ipc_msg_digital_input_channel_get_configuration_req. More...
struct	a_ipc_msg_digital_input_channel_request_req
	Request a digital input channel to be enabled. More...
struct	a_ipc_msg_digital_input_channel_request_rsp
	Sent in response to a_ipc_msg_digital_input_channel_request_req. More...
struct	a_ipc_msg_digital_input_channel_release_req_norsp
	Release a digital input channel for given 'user'. More...
struct	a_ipc_msg_digital_input_channel_status_req
	Read status of a digital input channel. More...
struct	a_ipc_msg_digital_input_channel_status_rsp
	The current status of a digital input channel. More...
struct	a_ipc_msg_digital_input_channel_status_publish_ind
	Event indicator for channel values. More...
struct	a_ipc_msg_digital_input_channel_status_subscribe_req
	Subscribe to updates for digital_input_channel_status. More...
struct	a_ipc_msg_digital_input_channel_status_subscribe_rsp
	Sent in response to a_ipc_msg_digital_input_channel_status_subscribe_req. More...
struct	a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp
	Unsubscribe from updates for digital_input_channel_status. More...

Enumerations
enum	a_ipc_enum_digital_input_result { A_IPC_ENUM_DIGITAL_INPUT_RESULT_OK , A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_INVALID_PARAMETER , A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_CHANNEL_NOT_AVAILABLE , A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_INTERNAL }
	Result codes. More...
enum	a_ipc_enum_digital_input_channel {   A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_ONSW , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_1 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_2 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_3 ,   A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_4 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_5 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_6 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_7 ,   A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_8 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_1 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_2 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_3 ,   A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_4 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_5 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_6 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_7 ,   A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_8 , A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_NUMBER_OF_CHANNELS }
	Digital channels. More...
enum	a_ipc_enum_digital_input_value { A_IPC_ENUM_DIGITAL_INPUT_VALUE_LOW , A_IPC_ENUM_DIGITAL_INPUT_VALUE_HIGH , A_IPC_ENUM_DIGITAL_INPUT_VALUE_UNAVAILABLE }
	Possible values for digital input pins. More...
enum	a_ipc_enum_digital_input_state { A_IPC_ENUM_DIGITAL_INPUT_STATE_DISABLED , A_IPC_ENUM_DIGITAL_INPUT_STATE_ENABLED }
	State of a digital input. More...

Functions
A_IPC_RESULT	a_ipc_init_digital_input_channel_set_configuration_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_set_configuration_req. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_set_configuration_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_set_configuration_rsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_get_configuration_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_get_configuration_req. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_get_configuration_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_get_configuration_rsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_request_req. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_request_rsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_release_req_norsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_req. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_rsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_publish_ind (a_ipc_msg *msg, uint32_t channel_maxlength, uint32_t value_maxlength)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_publish_ind. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_digital_input_channel_status_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp. More...

Detailed Description

Digital Inputs Service.

This page contains documentation of the Digital Inputs Service API.

The available digital inputs and the possible configurations are hardware dependent. Check the hardware specification to find the available ports and possible configurations for your device.

Wake-up enabled pins will wake up the system regardless of the pin being requested or not.

---

Data Structure Documentation

a_ipc_dyn_array_enum_digital_input_result

struct a_ipc_dyn_array_enum_digital_input_result

Dynamic-length array of a_ipc_enum_digital_input_result.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_digital_input_result *	value	The contents of the array.

a_ipc_dyn_array_enum_digital_input_channel

struct a_ipc_dyn_array_enum_digital_input_channel

Dynamic-length array of a_ipc_enum_digital_input_channel.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_digital_input_channel *	value	The contents of the array.

a_ipc_dyn_array_enum_digital_input_value

struct a_ipc_dyn_array_enum_digital_input_value

Dynamic-length array of a_ipc_enum_digital_input_value.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_digital_input_value *	value	The contents of the array.

a_ipc_dyn_array_enum_digital_input_state

struct a_ipc_dyn_array_enum_digital_input_state

Dynamic-length array of a_ipc_enum_digital_input_state.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_digital_input_state *	value	The contents of the array.

a_ipc_msg_digital_input_channel_set_configuration_req

struct a_ipc_msg_digital_input_channel_set_configuration_req

Configure a digital input channel.

Values configured are stored persistently.

Not valid to call for ONSW.

Response is delivered in a_ipc_msg_digital_input_channel_set_configuration_rsp.

Create using a_ipc_init_digital_input_channel_set_configuration_req().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_SET_CONFIGURATION_REQ.

Data Fields
uint32_t	analog_high_threshold_mv	See also a_ipc_msg_digital_input_channel_set_configuration_req::analog_low_threshold_mv
uint32_t	analog_low_threshold_mv	Thresholds for analog-as-digital inputs in millivolts. When the voltage value drops below the Low threshold, the input will be considered low, and when the voltage value rises above the High threshold it will be considered high. Check hardware specification for minimum and maximum values. Values are ignored for digital input pins.
a_ipc_enum_digital_input_channel	channel	The channel to configure.
bool	enable_wakeup	Use pin to wake system up from sleep or standby. Any transition will trigger a wakeup. Values are ignored for analog-as-digital inputs.

a_ipc_msg_digital_input_channel_set_configuration_rsp

struct a_ipc_msg_digital_input_channel_set_configuration_rsp

Sent in response to a_ipc_msg_digital_input_channel_set_configuration_req.

Create using a_ipc_init_digital_input_channel_set_configuration_rsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_SET_CONFIGURATION_RSP.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel that was configured.
a_ipc_enum_digital_input_result	result	Result of the operation.

a_ipc_msg_digital_input_channel_get_configuration_req

struct a_ipc_msg_digital_input_channel_get_configuration_req

Read configuration of a digital input channel.

Not valid to call for ONSW and FMSW.

Response is delivered in a_ipc_msg_digital_input_channel_get_configuration_rsp.

Create using a_ipc_init_digital_input_channel_get_configuration_req().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_GET_CONFIGURATION_REQ.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel to read configuration of.

a_ipc_msg_digital_input_channel_get_configuration_rsp

struct a_ipc_msg_digital_input_channel_get_configuration_rsp

Sent in response to a_ipc_msg_digital_input_channel_get_configuration_req.

Create using a_ipc_init_digital_input_channel_get_configuration_rsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_GET_CONFIGURATION_RSP.

Data Fields
uint32_t	analog_high_threshold_mv	See also a_ipc_msg_digital_input_channel_get_configuration_rsp::analog_low_threshold_mv
uint32_t	analog_low_threshold_mv	Current thresholds for analog-as-digital inputs in millivolts. Values should be ignored for digital input pins.
a_ipc_enum_digital_input_channel	channel	The channel that was read configuration for.
bool	enable_wakeup	Enabled pin to wake system up from sleep or standby. Values should be ignored for analog-as-digital inputs.
a_ipc_enum_digital_input_result	result	Result of the operation.

a_ipc_msg_digital_input_channel_request_req

struct a_ipc_msg_digital_input_channel_request_req

Request a digital input channel to be enabled.

The channel will be enabled if there is at least one user request.

Response is delivered in a_ipc_msg_digital_input_channel_request_rsp.

Create using a_ipc_init_digital_input_channel_request_req().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_REQUEST_REQ.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel to request.
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_digital_input_channel_request_rsp

struct a_ipc_msg_digital_input_channel_request_rsp

Sent in response to a_ipc_msg_digital_input_channel_request_req.

Create using a_ipc_init_digital_input_channel_request_rsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_REQUEST_RSP.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel that was requested.
a_ipc_enum_digital_input_result	result	Result of the operation.

a_ipc_msg_digital_input_channel_release_req_norsp

struct a_ipc_msg_digital_input_channel_release_req_norsp

Release a digital input channel for given 'user'.

The channel will be disabled if there are no outstanding requests.

Create using a_ipc_init_digital_input_channel_release_req_norsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_RELEASE_REQ_NORSP.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel to release.
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_digital_input_channel_status_req

struct a_ipc_msg_digital_input_channel_status_req

Read status of a digital input channel.

Response is delivered in a_ipc_msg_digital_input_channel_status_rsp.

Create using a_ipc_init_digital_input_channel_status_req().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_REQ.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel to read status of.

a_ipc_msg_digital_input_channel_status_rsp

struct a_ipc_msg_digital_input_channel_status_rsp

The current status of a digital input channel.

values are only valid when result is OK.

Sent in response to a_ipc_msg_digital_input_channel_status_req.

Create using a_ipc_init_digital_input_channel_status_rsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_RSP.

Data Fields
a_ipc_enum_digital_input_channel	channel	The channel that the status is valid for.
a_ipc_enum_digital_input_result	result	Result of the operation.
a_ipc_enum_digital_input_state	state	The state of the channel.
a_ipc_enum_digital_input_value	value	The value of the input.

a_ipc_msg_digital_input_channel_status_publish_ind

struct a_ipc_msg_digital_input_channel_status_publish_ind

Event indicator for channel values.

Sent periodically or on each DIN prefixed input change.

At least one input must be enabled for the event to be sent. Disabled inputs will not be included in this event,

Subscribe using a_ipc_msg_digital_input_channel_status_subscribe_req and unsubscribe using a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp.

Create using a_ipc_init_digital_input_channel_status_publish_ind().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_PUBLISH_IND.

Data Fields
a_ipc_dyn_array_enum_digital_input_channel	channel	The channel the value corresponds to.
uint32_t	num_of_entries	Number of entries in each array.
a_ipc_dyn_array_enum_digital_input_value	value	The value of the input.

a_ipc_msg_digital_input_channel_status_subscribe_req

struct a_ipc_msg_digital_input_channel_status_subscribe_req

Subscribe to updates for digital_input_channel_status.

a_ipc_msg_digital_input_channel_status_publish_ind will be received until a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_digital_input_channel_status_subscribe_rsp.

Create using a_ipc_init_digital_input_channel_status_subscribe_req().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_SUBSCRIBE_REQ.

a_ipc_msg_digital_input_channel_status_subscribe_rsp

struct a_ipc_msg_digital_input_channel_status_subscribe_rsp

Sent in response to a_ipc_msg_digital_input_channel_status_subscribe_req.

Create using a_ipc_init_digital_input_channel_status_subscribe_rsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp

struct a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp

Unsubscribe from updates for digital_input_channel_status.

a_ipc_msg_digital_input_channel_status_publish_ind will no longer be received.

Create using a_ipc_init_digital_input_channel_status_unsubscribe_req_norsp().

Message type is A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

a_ipc_enum_digital_input_channel

enum a_ipc_enum_digital_input_channel

Digital channels.

These channels correspond to physical pins in the main connector. It is possible that not all channels are available. Check hardware specification to find available channels. Analog inputs when used through this API function as digital inputs, refer to analog inputs Service to use them as true analog inputs.

Enumerator
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_ONSW	ONSW.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_1	DIN_1.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_2	DIN_2.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_3	DIN_3.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_4	DIN_4.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_5	DIN_5.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_6	DIN_6.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_7	DIN_7.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_DIN_8	DIN_8.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_1	AIN_1.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_2	AIN_2.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_3	AIN_3.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_4	AIN_4.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_5	AIN_5.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_6	AIN_6.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_7	AIN_7.
A_IPC_ENUM_DIGITAL_INPUT_CHANNEL_AIN_8	AIN_8.

a_ipc_enum_digital_input_result

enum a_ipc_enum_digital_input_result

Result codes.

Enumerator
A_IPC_ENUM_DIGITAL_INPUT_RESULT_OK	OK.
A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_INVALID_PARAMETER	Invalid parameter.
A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_CHANNEL_NOT_AVAILABLE	Channel not available.
A_IPC_ENUM_DIGITAL_INPUT_RESULT_ERROR_INTERNAL	Internal.

a_ipc_enum_digital_input_state

enum a_ipc_enum_digital_input_state

State of a digital input.

Enumerator
A_IPC_ENUM_DIGITAL_INPUT_STATE_DISABLED	Disabled.
A_IPC_ENUM_DIGITAL_INPUT_STATE_ENABLED	Enabled.

a_ipc_enum_digital_input_value

enum a_ipc_enum_digital_input_value

Possible values for digital input pins.

Enumerator
A_IPC_ENUM_DIGITAL_INPUT_VALUE_LOW	Signal is low.
A_IPC_ENUM_DIGITAL_INPUT_VALUE_HIGH	Signal is high.
A_IPC_ENUM_DIGITAL_INPUT_VALUE_UNAVAILABLE	Signal level cannot be determined, i.e. a floating analog pin.

Function Documentation

a_ipc_init_digital_input_channel_get_configuration_req()

A_IPC_RESULT a_ipc_init_digital_input_channel_get_configuration_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_get_configuration_req.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_GET_CONFIGURATION_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_get_configuration_rsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_get_configuration_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_get_configuration_rsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_GET_CONFIGURATION_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_release_req_norsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_release_req_norsp	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_release_req_norsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_RELEASE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_digital_input_channel_request_req()

A_IPC_RESULT a_ipc_init_digital_input_channel_request_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_request_req.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_REQUEST_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
user_maxlength	The maximum string length for user in the message.

a_ipc_init_digital_input_channel_request_rsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_request_rsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_REQUEST_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_set_configuration_req()

A_IPC_RESULT a_ipc_init_digital_input_channel_set_configuration_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_set_configuration_req.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_SET_CONFIGURATION_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_set_configuration_rsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_set_configuration_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_set_configuration_rsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_SET_CONFIGURATION_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_status_publish_ind()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_publish_ind	(	a_ipc_msg *	msg,
		uint32_t	channel_maxlength,
		uint32_t	value_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_publish_ind.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize
channel_maxlength	The number of array elements to reserve for channel in the message.
value_maxlength	The number of array elements to reserve for value in the message.

a_ipc_init_digital_input_channel_status_req()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_req.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_status_rsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_rsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_status_subscribe_req()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_subscribe_req.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_status_subscribe_rsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_subscribe_rsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_digital_input_channel_status_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_digital_input_channel_status_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_digital_input_channel_status_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_DIGITAL_INPUT_CHANNEL_STATUS_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

Variable Documentation

analog_high_threshold_mv [1/2]

uint32_t a_ipc_msg_digital_input_channel_set_configuration_req::analog_high_threshold_mv

See also

a_ipc_msg_digital_input_channel_set_configuration_req::analog_low_threshold_mv

analog_high_threshold_mv [2/2]

uint32_t a_ipc_msg_digital_input_channel_get_configuration_rsp::analog_high_threshold_mv

See also

a_ipc_msg_digital_input_channel_get_configuration_rsp::analog_low_threshold_mv

analog_low_threshold_mv [1/2]

uint32_t a_ipc_msg_digital_input_channel_set_configuration_req::analog_low_threshold_mv

Thresholds for analog-as-digital inputs in millivolts.

When the voltage value drops below the Low threshold, the input will be considered low, and when the voltage value rises above the High threshold it will be considered high. Check hardware specification for minimum and maximum values. Values are ignored for digital input pins.

analog_low_threshold_mv [2/2]

uint32_t a_ipc_msg_digital_input_channel_get_configuration_rsp::analog_low_threshold_mv

Current thresholds for analog-as-digital inputs in millivolts.

Values should be ignored for digital input pins.

channel [1/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_set_configuration_req::channel

The channel to configure.

channel [2/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_set_configuration_rsp::channel

The channel that was configured.

channel [3/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_get_configuration_req::channel

The channel to read configuration of.

channel [4/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_get_configuration_rsp::channel

The channel that was read configuration for.

channel [5/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_request_req::channel

The channel to request.

channel [6/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_request_rsp::channel

The channel that was requested.

channel [7/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_release_req_norsp::channel

The channel to release.

channel [8/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_status_req::channel

The channel to read status of.

channel [9/10]

a_ipc_enum_digital_input_channel a_ipc_msg_digital_input_channel_status_rsp::channel

The channel that the status is valid for.

channel [10/10]

a_ipc_dyn_array_enum_digital_input_channel a_ipc_msg_digital_input_channel_status_publish_ind::channel

The channel the value corresponds to.

enable_wakeup [1/2]

bool a_ipc_msg_digital_input_channel_set_configuration_req::enable_wakeup

Use pin to wake system up from sleep or standby.

Any transition will trigger a wakeup. Values are ignored for analog-as-digital inputs.

enable_wakeup [2/2]

bool a_ipc_msg_digital_input_channel_get_configuration_rsp::enable_wakeup

Enabled pin to wake system up from sleep or standby.

Values should be ignored for analog-as-digital inputs.

num_of_entries

uint32_t a_ipc_msg_digital_input_channel_status_publish_ind::num_of_entries

Number of entries in each array.

result [1/5]

a_ipc_enum_digital_input_result a_ipc_msg_digital_input_channel_set_configuration_rsp::result

Result of the operation.

result [2/5]

a_ipc_enum_digital_input_result a_ipc_msg_digital_input_channel_get_configuration_rsp::result

Result of the operation.

result [3/5]

a_ipc_enum_digital_input_result a_ipc_msg_digital_input_channel_request_rsp::result

Result of the operation.

result [4/5]

a_ipc_enum_digital_input_result a_ipc_msg_digital_input_channel_status_rsp::result

Result of the operation.

result [5/5]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_digital_input_channel_status_subscribe_rsp::result

The result of the subscription request.

state

a_ipc_enum_digital_input_state a_ipc_msg_digital_input_channel_status_rsp::state

The state of the channel.

user [1/2]

a_ipc_dyn_string a_ipc_msg_digital_input_channel_request_req::user

User identifier, max 15 characters long.

user [2/2]

a_ipc_dyn_string a_ipc_msg_digital_input_channel_release_req_norsp::user

User identifier, max 15 characters long.

value [1/2]

a_ipc_enum_digital_input_value a_ipc_msg_digital_input_channel_status_rsp::value

The value of the input.

value [2/2]

a_ipc_dyn_array_enum_digital_input_value a_ipc_msg_digital_input_channel_status_publish_ind::value

The value of the input.