ipc_cellular

Cellular Data Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_cellular_result
	Dynamic-length array of a_ipc_enum_cellular_result. More...
struct	a_ipc_dyn_array_enum_cellular_connection_status
	Dynamic-length array of a_ipc_enum_cellular_connection_status. More...
struct	a_ipc_dyn_array_enum_cellular_access_technology
	Dynamic-length array of a_ipc_enum_cellular_access_technology. More...
struct	a_ipc_msg_cellular_data_request_req
	Request a modem data connection. More...
struct	a_ipc_msg_cellular_data_request_rsp
	Modem data connection request result. More...
struct	a_ipc_msg_cellular_data_release_req_norsp
	Release a modem data connection. More...
struct	a_ipc_msg_cellular_data_secondary_request_req
	Request the secondary modem data connection. More...
struct	a_ipc_msg_cellular_data_secondary_request_rsp
	Modem data connection request result. More...
struct	a_ipc_msg_cellular_data_secondary_release_req_norsp
	Release the secondary modem data connection. More...
struct	a_ipc_msg_cellular_info_req
	Request Modem and SIM information. More...
struct	a_ipc_msg_cellular_info_rsp
	Modem and SIM information result. More...
struct	a_ipc_msg_cellular_status_publish_ind
	A message with the current cellular status. More...
struct	a_ipc_msg_cellular_status_secondary_publish_ind
	A message with the current cellular status for secondary cellular connection. More...
struct	a_ipc_msg_cellular_temperature_req
	Request Modem temperature. More...
struct	a_ipc_msg_cellular_temperature_rsp
	Request Modem temperature result. More...
struct	a_ipc_msg_cellular_status_latest_req
	Request latest known cellular status. More...
struct	a_ipc_msg_cellular_status_latest_rsp
	Request latest known cellular status result. More...
struct	a_ipc_msg_cellular_status_secondary_latest_req
	Request latest known secondary cellular status. More...
struct	a_ipc_msg_cellular_status_secondary_latest_rsp
	Request latest known second_cellular status result. More...
struct	a_ipc_msg_cellular_extended_status_publish_ind
	A message with extended cellular status information. More...
struct	a_ipc_msg_cellular_status_subscribe_req
	Subscribe to updates for cellular_status. More...
struct	a_ipc_msg_cellular_status_subscribe_rsp
	Sent in response to a_ipc_msg_cellular_status_subscribe_req. More...
struct	a_ipc_msg_cellular_status_unsubscribe_req_norsp
	Unsubscribe from updates for cellular_status. More...
struct	a_ipc_msg_cellular_status_secondary_subscribe_req
	Subscribe to updates for cellular_status_secondary. More...
struct	a_ipc_msg_cellular_status_secondary_subscribe_rsp
	Sent in response to a_ipc_msg_cellular_status_secondary_subscribe_req. More...
struct	a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp
	Unsubscribe from updates for cellular_status_secondary. More...
struct	a_ipc_msg_cellular_extended_status_subscribe_req
	Subscribe to updates for cellular_extended_status. More...
struct	a_ipc_msg_cellular_extended_status_subscribe_rsp
	Sent in response to a_ipc_msg_cellular_extended_status_subscribe_req. More...
struct	a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp
	Unsubscribe from updates for cellular_extended_status. More...

Enumerations
enum	a_ipc_enum_cellular_result {   A_IPC_ENUM_CELLULAR_RESULT_OK , A_IPC_ENUM_CELLULAR_RESULT_ERROR_INVALID_PARAMETER , A_IPC_ENUM_CELLULAR_RESULT_ERROR_NO_REQUEST_SLOT_AVAILABLE , A_IPC_ENUM_CELLULAR_RESULT_ERROR_NAD_IS_BOOTING ,   A_IPC_ENUM_CELLULAR_RESULT_ERROR_UNKNOWN }
	Result codes. More...
enum	a_ipc_enum_cellular_connection_status { A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_UNKNOWN , A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_NOT_CONNECTED , A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_SEARCHING , A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_CONNECTED }
	Cellular connection status. More...
enum	a_ipc_enum_cellular_access_technology {   A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_UNKNOWN , A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_GSM , A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_UMTS , A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_LTE ,   A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_5G }
	Cellular radio access technology. More...

Functions
A_IPC_RESULT	a_ipc_init_cellular_data_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_request_req. More...
A_IPC_RESULT	a_ipc_init_cellular_data_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_request_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_data_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_release_req_norsp. More...
A_IPC_RESULT	a_ipc_init_cellular_data_secondary_request_req (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_request_req. More...
A_IPC_RESULT	a_ipc_init_cellular_data_secondary_request_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_request_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_data_secondary_release_req_norsp (a_ipc_msg *msg, uint32_t user_maxlength)
	Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_release_req_norsp. More...
A_IPC_RESULT	a_ipc_init_cellular_info_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_info_req. More...
A_IPC_RESULT	a_ipc_init_cellular_info_rsp (a_ipc_msg *msg, uint32_t iccid_maxlength, uint32_t euiccid_maxlength, uint32_t imei_maxlength, uint32_t imsi_maxlength)
	Initialize the message buffer to contain a_ipc_msg_cellular_info_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_publish_ind (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_publish_ind. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_publish_ind (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_publish_ind. More...
A_IPC_RESULT	a_ipc_init_cellular_temperature_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_temperature_req. More...
A_IPC_RESULT	a_ipc_init_cellular_temperature_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_temperature_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_latest_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_latest_req. More...
A_IPC_RESULT	a_ipc_init_cellular_status_latest_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_latest_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_latest_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_latest_req. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_latest_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_latest_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_extended_status_publish_ind (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_publish_ind. More...
A_IPC_RESULT	a_ipc_init_cellular_status_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_cellular_status_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_unsubscribe_req_norsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_status_secondary_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp. More...
A_IPC_RESULT	a_ipc_init_cellular_extended_status_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_cellular_extended_status_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_cellular_extended_status_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp. More...

Detailed Description

Cellular Data Service.

This page contains documentation of the Cellular Data Service API.

ACU6-Pro: Cellular Internet is available on the eth1 interface, with local IP 198.18.3.2.

ACU6-Lite: N/A.

---

Data Structure Documentation

a_ipc_dyn_array_enum_cellular_result

struct a_ipc_dyn_array_enum_cellular_result

Dynamic-length array of a_ipc_enum_cellular_result.

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

a_ipc_dyn_array_enum_cellular_connection_status

struct a_ipc_dyn_array_enum_cellular_connection_status

Dynamic-length array of a_ipc_enum_cellular_connection_status.

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

a_ipc_dyn_array_enum_cellular_access_technology

struct a_ipc_dyn_array_enum_cellular_access_technology

Dynamic-length array of a_ipc_enum_cellular_access_technology.

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

a_ipc_msg_cellular_data_request_req

struct a_ipc_msg_cellular_data_request_req

Request a modem data connection.

If successful the requester is guaranteed a data connection until a a_ipc_msg_cellular_data_release_ind is sent. (External circumstances, can of course affect the connection) A data connection might be available even if not requested, since the main system or other users can have a modem data request active.

Response is delivered in a_ipc_msg_cellular_data_request_rsp.

Create using a_ipc_init_cellular_data_request_req().

Message type is A_IPC_MSG_CELLULAR_DATA_REQUEST_REQ.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_cellular_data_request_rsp

struct a_ipc_msg_cellular_data_request_rsp

Modem data connection request result.

Sent in response to a_ipc_msg_cellular_data_request_req.

Create using a_ipc_init_cellular_data_request_rsp().

Message type is A_IPC_MSG_CELLULAR_DATA_REQUEST_RSP.

Data Fields
a_ipc_enum_cellular_result	result	Result of the operation.

a_ipc_msg_cellular_data_release_req_norsp

struct a_ipc_msg_cellular_data_release_req_norsp

Release a modem data connection.

After this is sent the requester is not guaranteed a data connection.

Create using a_ipc_init_cellular_data_release_req_norsp().

Message type is A_IPC_MSG_CELLULAR_DATA_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_cellular_data_secondary_request_req

struct a_ipc_msg_cellular_data_secondary_request_req

Request the secondary modem data connection.

If successful the requester is guaranteed a data connection until a a_ipc_msg_cellular_data_release_ind is sent. (External circumstances, can of course affect the connection) A data connection might be available even if not requested, since the main system or other users can have a secondary data request active.

Response is delivered in a_ipc_msg_cellular_data_secondary_request_rsp.

Create using a_ipc_init_cellular_data_secondary_request_req().

Message type is A_IPC_MSG_CELLULAR_DATA_SECONDARY_REQUEST_REQ.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_cellular_data_secondary_request_rsp

struct a_ipc_msg_cellular_data_secondary_request_rsp

Modem data connection request result.

Sent in response to a_ipc_msg_cellular_data_secondary_request_req.

Create using a_ipc_init_cellular_data_secondary_request_rsp().

Message type is A_IPC_MSG_CELLULAR_DATA_SECONDARY_REQUEST_RSP.

Data Fields
a_ipc_enum_cellular_result	result	Result of the operation.

a_ipc_msg_cellular_data_secondary_release_req_norsp

struct a_ipc_msg_cellular_data_secondary_release_req_norsp

Release the secondary modem data connection.

After this is sent the requester is not guaranteed a data connection.

Create using a_ipc_init_cellular_data_secondary_release_req_norsp().

Message type is A_IPC_MSG_CELLULAR_DATA_SECONDARY_RELEASE_REQ_NORSP.

Data Fields
a_ipc_dyn_string	user	User identifier, max 15 characters long.

a_ipc_msg_cellular_info_req

struct a_ipc_msg_cellular_info_req

Request Modem and SIM information.

Response is delivered in a_ipc_msg_cellular_info_rsp.

Create using a_ipc_init_cellular_info_req().

Message type is A_IPC_MSG_CELLULAR_INFO_REQ.

a_ipc_msg_cellular_info_rsp

struct a_ipc_msg_cellular_info_rsp

Modem and SIM information result.

Sent in response to a_ipc_msg_cellular_info_req.

Create using a_ipc_init_cellular_info_rsp().

Message type is A_IPC_MSG_CELLULAR_INFO_RSP.

Data Fields
a_ipc_dyn_string	euiccid	EUICCID.
a_ipc_dyn_string	iccid	ICCID.
a_ipc_dyn_string	imei	IMEI.
a_ipc_dyn_string	imsi	IMSI.
a_ipc_enum_cellular_result	result	Result of the operation.

a_ipc_msg_cellular_status_publish_ind

struct a_ipc_msg_cellular_status_publish_ind

A message with the current cellular status.

Status updates are sent when there is a change in status.

Subscribe using a_ipc_msg_cellular_status_subscribe_req and unsubscribe using a_ipc_msg_cellular_status_unsubscribe_req_norsp.

Create using a_ipc_init_cellular_status_publish_ind().

Message type is A_IPC_MSG_CELLULAR_STATUS_PUBLISH_IND.

Data Fields
bool	connected	Data connection status. true if there is a working cellular packet data connection. false if not.
int32_t	rssi	Signal strength in dBm, if known. -1 if the signal strength is unknown.

a_ipc_msg_cellular_status_secondary_publish_ind

struct a_ipc_msg_cellular_status_secondary_publish_ind

A message with the current cellular status for secondary cellular connection.

Status updates are sent when there is a change in status.

Subscribe using a_ipc_msg_cellular_status_secondary_subscribe_req and unsubscribe using a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp.

Create using a_ipc_init_cellular_status_secondary_publish_ind().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_PUBLISH_IND.

Data Fields
bool	connected	Secondary data connection status. true if there is a working cellular packet data connection. false if not.

a_ipc_msg_cellular_temperature_req

struct a_ipc_msg_cellular_temperature_req

Request Modem temperature.

Response is delivered in a_ipc_msg_cellular_temperature_rsp.

Create using a_ipc_init_cellular_temperature_req().

Message type is A_IPC_MSG_CELLULAR_TEMPERATURE_REQ.

a_ipc_msg_cellular_temperature_rsp

struct a_ipc_msg_cellular_temperature_rsp

Request Modem temperature result.

Sent in response to a_ipc_msg_cellular_temperature_req.

Create using a_ipc_init_cellular_temperature_rsp().

Message type is A_IPC_MSG_CELLULAR_TEMPERATURE_RSP.

Data Fields
a_ipc_enum_cellular_result	result	Result of the operation.
int32_t	temperature	Temperature.

a_ipc_msg_cellular_status_latest_req

struct a_ipc_msg_cellular_status_latest_req

Request latest known cellular status.

Response is delivered in a_ipc_msg_cellular_status_latest_rsp.

Create using a_ipc_init_cellular_status_latest_req().

Message type is A_IPC_MSG_CELLULAR_STATUS_LATEST_REQ.

a_ipc_msg_cellular_status_latest_rsp

struct a_ipc_msg_cellular_status_latest_rsp

Request latest known cellular status result.

Sent in response to a_ipc_msg_cellular_status_latest_req.

Create using a_ipc_init_cellular_status_latest_rsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_LATEST_RSP.

Data Fields
bool	connected	Data connection status. true if there is a working cellular packet data connection. false if not.
a_ipc_enum_cellular_result	result	Result of the operation.
int32_t	rssi	Signal strength in dBm, if known. -1 if the signal strength is unknown.

a_ipc_msg_cellular_status_secondary_latest_req

struct a_ipc_msg_cellular_status_secondary_latest_req

Request latest known secondary cellular status.

Response is delivered in a_ipc_msg_cellular_status_secondary_latest_rsp.

Create using a_ipc_init_cellular_status_secondary_latest_req().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_LATEST_REQ.

a_ipc_msg_cellular_status_secondary_latest_rsp

struct a_ipc_msg_cellular_status_secondary_latest_rsp

Request latest known second_cellular status result.

Sent in response to a_ipc_msg_cellular_status_secondary_latest_req.

Create using a_ipc_init_cellular_status_secondary_latest_rsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_LATEST_RSP.

Data Fields
bool	connected	Data connection status. true if there is a working cellular packet data connection. false if not.
a_ipc_enum_cellular_result	result	Result of the operation.

a_ipc_msg_cellular_extended_status_publish_ind

struct a_ipc_msg_cellular_extended_status_publish_ind

A message with extended cellular status information.

Subscribe using a_ipc_msg_cellular_extended_status_subscribe_req and unsubscribe using a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp.

Create using a_ipc_init_cellular_extended_status_publish_ind().

Message type is A_IPC_MSG_CELLULAR_EXTENDED_STATUS_PUBLISH_IND.

Data Fields
a_ipc_enum_cellular_access_technology	access_technology	Currently active radio access technology.
uint32_t	arfcn	Radio Frequency Channel Number. Mapping to actual frequency depends on access technology GSM: ARFCN - Absolute Radio Frequency Channel Number UMTS: UARFCN - UTRAN Absolute Radio Frequency Channel Number LTE: EARFCN - E-UTRA Absolute Radio Frequency Channel Number 5G: ARFCN - Absolute Radio Frequency Channel Number
uint32_t	cid	Cell ID (CID) GSM: Cell ID, 16-bit UMTS: Cell ID, 28-bit LTE: Global Cell ID, 28-bit
a_ipc_enum_cellular_connection_status	data_status	Current status of the cellular data connection.
uint16_t	lac_tac	Location ID within MCC/MNC. Referred to as LAC in GSM and UMTS and TAC in LTE and 5G
char	mcc[3+1]	Mobile Country Code (ITU Rec E.212) Valid for all access technologies
char	mnc[3+1]	Mobile Network Code (ITU Rec E.212) Can be 2 or 3 digits, where leading zeros are significant, so that MNC of 01 and 001 are two different distinct IDs. Valid for all access technologies
uint16_t	pci	Phyiscal Cell ID (PCI) Only valid for LTE and 5G networks
int16_t	signal_quality	Signal quality. The mapping, range and relation to "good reception" is access technology specific If unknown, it is set to INT16_MIN (lowest possible int16_t) GSM: Unavailable UMTS: EC/IO - Carrier-to-interference ratio in dBm LTE: RSRQ - Reference Signal Received Quality in dB 5: TBD
int16_t	signal_strength	Signal power. The mapping, range and relation to "good reception" is access technology specific If unknown, it is set to INT16_MIN (lowest possible int16_t) GSM: RSSI - Received Signal Strength Indicator, signal strength in dBm UMTS: RSCP - Received Signal Code Power, in dBm LTE: RSRP - Reference Signal Received Power, strength of LTE reference signal in dBm 5G: TBD

a_ipc_msg_cellular_status_subscribe_req

struct a_ipc_msg_cellular_status_subscribe_req

Subscribe to updates for cellular_status.

a_ipc_msg_cellular_status_publish_ind will be received until a_ipc_msg_cellular_status_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_cellular_status_subscribe_rsp.

Create using a_ipc_init_cellular_status_subscribe_req().

Message type is A_IPC_MSG_CELLULAR_STATUS_SUBSCRIBE_REQ.

a_ipc_msg_cellular_status_subscribe_rsp

struct a_ipc_msg_cellular_status_subscribe_rsp

Sent in response to a_ipc_msg_cellular_status_subscribe_req.

Create using a_ipc_init_cellular_status_subscribe_rsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_cellular_status_unsubscribe_req_norsp

struct a_ipc_msg_cellular_status_unsubscribe_req_norsp

Unsubscribe from updates for cellular_status.

a_ipc_msg_cellular_status_publish_ind will no longer be received.

Create using a_ipc_init_cellular_status_unsubscribe_req_norsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_UNSUBSCRIBE_REQ_NORSP.

a_ipc_msg_cellular_status_secondary_subscribe_req

struct a_ipc_msg_cellular_status_secondary_subscribe_req

Subscribe to updates for cellular_status_secondary.

a_ipc_msg_cellular_status_secondary_publish_ind will be received until a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_cellular_status_secondary_subscribe_rsp.

Create using a_ipc_init_cellular_status_secondary_subscribe_req().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_SUBSCRIBE_REQ.

a_ipc_msg_cellular_status_secondary_subscribe_rsp

struct a_ipc_msg_cellular_status_secondary_subscribe_rsp

Sent in response to a_ipc_msg_cellular_status_secondary_subscribe_req.

Create using a_ipc_init_cellular_status_secondary_subscribe_rsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp

struct a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp

Unsubscribe from updates for cellular_status_secondary.

a_ipc_msg_cellular_status_secondary_publish_ind will no longer be received.

Create using a_ipc_init_cellular_status_secondary_unsubscribe_req_norsp().

Message type is A_IPC_MSG_CELLULAR_STATUS_SECONDARY_UNSUBSCRIBE_REQ_NORSP.

a_ipc_msg_cellular_extended_status_subscribe_req

struct a_ipc_msg_cellular_extended_status_subscribe_req

Subscribe to updates for cellular_extended_status.

a_ipc_msg_cellular_extended_status_publish_ind will be received until a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_cellular_extended_status_subscribe_rsp.

Create using a_ipc_init_cellular_extended_status_subscribe_req().

Message type is A_IPC_MSG_CELLULAR_EXTENDED_STATUS_SUBSCRIBE_REQ.

a_ipc_msg_cellular_extended_status_subscribe_rsp

struct a_ipc_msg_cellular_extended_status_subscribe_rsp

Sent in response to a_ipc_msg_cellular_extended_status_subscribe_req.

Create using a_ipc_init_cellular_extended_status_subscribe_rsp().

Message type is A_IPC_MSG_CELLULAR_EXTENDED_STATUS_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp

struct a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp

Unsubscribe from updates for cellular_extended_status.

a_ipc_msg_cellular_extended_status_publish_ind will no longer be received.

Create using a_ipc_init_cellular_extended_status_unsubscribe_req_norsp().

Message type is A_IPC_MSG_CELLULAR_EXTENDED_STATUS_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

a_ipc_enum_cellular_access_technology

enum a_ipc_enum_cellular_access_technology

Cellular radio access technology.

Enumerator
A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_UNKNOWN	Unknown.
A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_GSM	GSM.
A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_UMTS	UMTS.
A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_LTE	LTE.
A_IPC_ENUM_CELLULAR_ACCESS_TECHNOLOGY_5G	5G

a_ipc_enum_cellular_connection_status

enum a_ipc_enum_cellular_connection_status

Cellular connection status.

Enumerator
A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_UNKNOWN	Unknown.
A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_NOT_CONNECTED	Not connected.
A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_SEARCHING	Searching.
A_IPC_ENUM_CELLULAR_CONNECTION_STATUS_CONNECTED	Connected.

a_ipc_enum_cellular_result

enum a_ipc_enum_cellular_result

Result codes.

Enumerator
A_IPC_ENUM_CELLULAR_RESULT_OK	OK.
A_IPC_ENUM_CELLULAR_RESULT_ERROR_INVALID_PARAMETER	Invalid parameter.
A_IPC_ENUM_CELLULAR_RESULT_ERROR_NO_REQUEST_SLOT_AVAILABLE	No request slot available.
A_IPC_ENUM_CELLULAR_RESULT_ERROR_NAD_IS_BOOTING	NAD is booting.
A_IPC_ENUM_CELLULAR_RESULT_ERROR_UNKNOWN	Unknown.

Function Documentation

a_ipc_init_cellular_data_release_req_norsp()

A_IPC_RESULT a_ipc_init_cellular_data_release_req_norsp	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_cellular_data_release_req_norsp.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_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_cellular_data_request_req()

A_IPC_RESULT a_ipc_init_cellular_data_request_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_cellular_data_request_req.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_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_cellular_data_request_rsp()

A_IPC_RESULT a_ipc_init_cellular_data_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_data_request_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_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_cellular_data_secondary_release_req_norsp()

A_IPC_RESULT a_ipc_init_cellular_data_secondary_release_req_norsp	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_release_req_norsp.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_SECONDARY_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_cellular_data_secondary_request_req()

A_IPC_RESULT a_ipc_init_cellular_data_secondary_request_req	(	a_ipc_msg *	msg,
		uint32_t	user_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_request_req.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_SECONDARY_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_cellular_data_secondary_request_rsp()

A_IPC_RESULT a_ipc_init_cellular_data_secondary_request_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_data_secondary_request_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_DATA_SECONDARY_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_cellular_extended_status_publish_ind()

A_IPC_RESULT a_ipc_init_cellular_extended_status_publish_ind

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_publish_ind.

msg->info.type will be A_IPC_MSG_CELLULAR_EXTENDED_STATUS_PUBLISH_IND.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_cellular_extended_status_subscribe_req()

A_IPC_RESULT a_ipc_init_cellular_extended_status_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_subscribe_req.

msg->info.type will be A_IPC_MSG_CELLULAR_EXTENDED_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_cellular_extended_status_subscribe_rsp()

A_IPC_RESULT a_ipc_init_cellular_extended_status_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_subscribe_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_EXTENDED_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_cellular_extended_status_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_cellular_extended_status_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_extended_status_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_CELLULAR_EXTENDED_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

a_ipc_init_cellular_info_req()

A_IPC_RESULT a_ipc_init_cellular_info_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_info_req.

msg->info.type will be A_IPC_MSG_CELLULAR_INFO_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_cellular_info_rsp()

A_IPC_RESULT a_ipc_init_cellular_info_rsp	(	a_ipc_msg *	msg,
		uint32_t	iccid_maxlength,
		uint32_t	euiccid_maxlength,
		uint32_t	imei_maxlength,
		uint32_t	imsi_maxlength
	)

Initialize the message buffer to contain a_ipc_msg_cellular_info_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_INFO_RSP.

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

Parameters

msg	The message buffer to initialize
iccid_maxlength	The maximum string length for iccid in the message.
euiccid_maxlength	The maximum string length for euiccid in the message.
imei_maxlength	The maximum string length for imei in the message.
imsi_maxlength	The maximum string length for imsi in the message.

a_ipc_init_cellular_status_latest_req()

A_IPC_RESULT a_ipc_init_cellular_status_latest_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_latest_req.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_LATEST_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_cellular_status_latest_rsp()

A_IPC_RESULT a_ipc_init_cellular_status_latest_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_latest_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_LATEST_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_cellular_status_publish_ind()

A_IPC_RESULT a_ipc_init_cellular_status_publish_ind

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_publish_ind.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_PUBLISH_IND.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_cellular_status_secondary_latest_req()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_latest_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_latest_req.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_LATEST_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_cellular_status_secondary_latest_rsp()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_latest_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_latest_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_LATEST_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_cellular_status_secondary_publish_ind()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_publish_ind

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_publish_ind.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_PUBLISH_IND.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_cellular_status_secondary_subscribe_req()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_subscribe_req.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_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_cellular_status_secondary_subscribe_rsp()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_subscribe_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_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_cellular_status_secondary_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_cellular_status_secondary_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_secondary_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_CELLULAR_STATUS_SECONDARY_UNSUBSCRIBE_REQ_NORSP.

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

Parameters

msg	The message buffer to initialize

a_ipc_init_cellular_status_subscribe_req()

A_IPC_RESULT a_ipc_init_cellular_status_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_subscribe_req.

msg->info.type will be A_IPC_MSG_CELLULAR_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_cellular_status_subscribe_rsp()

A_IPC_RESULT a_ipc_init_cellular_status_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_subscribe_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_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_cellular_status_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_cellular_status_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_status_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_CELLULAR_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

a_ipc_init_cellular_temperature_req()

A_IPC_RESULT a_ipc_init_cellular_temperature_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_temperature_req.

msg->info.type will be A_IPC_MSG_CELLULAR_TEMPERATURE_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_cellular_temperature_rsp()

A_IPC_RESULT a_ipc_init_cellular_temperature_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_cellular_temperature_rsp.

msg->info.type will be A_IPC_MSG_CELLULAR_TEMPERATURE_RSP.

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

Parameters

msg	The message buffer to initialize

Variable Documentation

access_technology

a_ipc_enum_cellular_access_technology a_ipc_msg_cellular_extended_status_publish_ind::access_technology

Currently active radio access technology.

arfcn

uint32_t a_ipc_msg_cellular_extended_status_publish_ind::arfcn

Radio Frequency Channel Number.

Mapping to actual frequency depends on access technology

GSM: ARFCN - Absolute Radio Frequency Channel Number UMTS: UARFCN - UTRAN Absolute Radio Frequency Channel Number LTE: EARFCN - E-UTRA Absolute Radio Frequency Channel Number 5G: ARFCN - Absolute Radio Frequency Channel Number

cid

uint32_t a_ipc_msg_cellular_extended_status_publish_ind::cid

Cell ID (CID)

GSM: Cell ID, 16-bit UMTS: Cell ID, 28-bit LTE: Global Cell ID, 28-bit

connected [1/4]

bool a_ipc_msg_cellular_status_publish_ind::connected

Data connection status.

true if there is a working cellular packet data connection. false if not.

connected [2/4]

bool a_ipc_msg_cellular_status_secondary_publish_ind::connected

Secondary data connection status.

true if there is a working cellular packet data connection. false if not.

connected [3/4]

bool a_ipc_msg_cellular_status_latest_rsp::connected

Data connection status.

true if there is a working cellular packet data connection. false if not.

connected [4/4]

bool a_ipc_msg_cellular_status_secondary_latest_rsp::connected

Data connection status.

true if there is a working cellular packet data connection. false if not.

data_status

a_ipc_enum_cellular_connection_status a_ipc_msg_cellular_extended_status_publish_ind::data_status

Current status of the cellular data connection.

euiccid

a_ipc_dyn_string a_ipc_msg_cellular_info_rsp::euiccid

EUICCID.

iccid

a_ipc_dyn_string a_ipc_msg_cellular_info_rsp::iccid

ICCID.

imei

a_ipc_dyn_string a_ipc_msg_cellular_info_rsp::imei

IMEI.

imsi

a_ipc_dyn_string a_ipc_msg_cellular_info_rsp::imsi

IMSI.

lac_tac

uint16_t a_ipc_msg_cellular_extended_status_publish_ind::lac_tac

Location ID within MCC/MNC.

Referred to as LAC in GSM and UMTS and TAC in LTE and 5G

mcc

char a_ipc_msg_cellular_extended_status_publish_ind::mcc[3+1]

Mobile Country Code (ITU Rec E.212)

Valid for all access technologies

mnc

char a_ipc_msg_cellular_extended_status_publish_ind::mnc[3+1]

Mobile Network Code (ITU Rec E.212) Can be 2 or 3 digits, where leading zeros are significant, so that MNC of 01 and 001 are two different distinct IDs.

Valid for all access technologies

pci

uint16_t a_ipc_msg_cellular_extended_status_publish_ind::pci

Phyiscal Cell ID (PCI)

Only valid for LTE and 5G networks

result [1/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_data_request_rsp::result

Result of the operation.

result [2/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_data_secondary_request_rsp::result

Result of the operation.

result [3/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_info_rsp::result

Result of the operation.

result [4/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_temperature_rsp::result

Result of the operation.

result [5/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_status_latest_rsp::result

Result of the operation.

result [6/9]

a_ipc_enum_cellular_result a_ipc_msg_cellular_status_secondary_latest_rsp::result

Result of the operation.

result [7/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_cellular_status_subscribe_rsp::result

The result of the subscription request.

result [8/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_cellular_status_secondary_subscribe_rsp::result

The result of the subscription request.

result [9/9]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_cellular_extended_status_subscribe_rsp::result

The result of the subscription request.

rssi [1/2]

int32_t a_ipc_msg_cellular_status_publish_ind::rssi

Signal strength in dBm, if known.

-1 if the signal strength is unknown.

rssi [2/2]

int32_t a_ipc_msg_cellular_status_latest_rsp::rssi

Signal strength in dBm, if known.

-1 if the signal strength is unknown.

signal_quality

int16_t a_ipc_msg_cellular_extended_status_publish_ind::signal_quality

Signal quality.

The mapping, range and relation to "good reception" is access technology specific If unknown, it is set to INT16_MIN (lowest possible int16_t)

GSM: Unavailable UMTS: EC/IO - Carrier-to-interference ratio in dBm LTE: RSRQ - Reference Signal Received Quality in dB 5: TBD

signal_strength

int16_t a_ipc_msg_cellular_extended_status_publish_ind::signal_strength

Signal power.

The mapping, range and relation to "good reception" is access technology specific If unknown, it is set to INT16_MIN (lowest possible int16_t)

GSM: RSSI - Received Signal Strength Indicator, signal strength in dBm UMTS: RSCP - Received Signal Code Power, in dBm LTE: RSRP - Reference Signal Received Power, strength of LTE reference signal in dBm 5G: TBD

temperature

int32_t a_ipc_msg_cellular_temperature_rsp::temperature

Temperature.

user [1/4]

a_ipc_dyn_string a_ipc_msg_cellular_data_request_req::user

User identifier, max 15 characters long.

user [2/4]

a_ipc_dyn_string a_ipc_msg_cellular_data_release_req_norsp::user

User identifier, max 15 characters long.

user [3/4]

a_ipc_dyn_string a_ipc_msg_cellular_data_secondary_request_req::user

User identifier, max 15 characters long.

user [4/4]

a_ipc_dyn_string a_ipc_msg_cellular_data_secondary_release_req_norsp::user

User identifier, max 15 characters long.