IPC Module - Cellular Data Service

This page contains documentation of the Cellular Data API.

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

ACU6-Lite: N/A.

Messages

message cellular_data_request_req
Parameters:

user (string) – User identifier, max 15 characters long.

Return message:

cellular_data_request_rsp

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.

message cellular_data_request_rsp
Parameters:

result (enum cellular_result) – Result of the operation

Modem data connection request result.

message cellular_data_release_req_norsp
Parameters:

user (string) – User identifier, max 15 characters long.

Release a modem data connection.

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

message cellular_data_secondary_request_req
Parameters:

user (string) – User identifier, max 15 characters long.

Return message:

cellular_data_secondary_request_rsp

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.

message cellular_data_secondary_request_rsp
Parameters:

result (enum cellular_result) – Result of the operation

Modem data connection request result.

message cellular_data_secondary_release_req_norsp
Parameters:

user (string) – User identifier, max 15 characters long.

Release the secondary modem data connection.

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

message cellular_info_req
Return message:

cellular_info_rsp

Request Modem and SIM information.

message cellular_info_rsp
Parameters:

Modem and SIM information result.

message cellular_status_publish_ind
Parameters:

  • connected (uint8) – Data connection status. true if there is a working cellular packet data connection. false if not.

  • rssi (int32) – Signal strength in dBm, if known. -1 if the signal strength is unknown.

A message with the current cellular status.

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

message cellular_status_subscribe_req

Subscribe to cellular_status_publish_ind messages

message cellular_status_subscribe_rsp
Parameters:

result (enum ipc_subscribe_result)

Result from cellular_status_subscribe_req

message cellular_status_unsubscribe_req_norsp

Unsubscribe from cellular_status_publish_ind messages

message cellular_status_secondary_publish_ind
Parameters:

connected (uint8) – Secondary data connection status. true if there is a working cellular packet data connection. false if not.

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

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

message cellular_status_secondary_subscribe_req

Subscribe to cellular_status_secondary_publish_ind messages

message cellular_status_secondary_subscribe_rsp
Parameters:

result (enum ipc_subscribe_result)

Result from cellular_status_secondary_subscribe_req

message cellular_status_secondary_unsubscribe_req_norsp

Unsubscribe from cellular_status_secondary_publish_ind messages

message cellular_temperature_req
Return message:

cellular_temperature_rsp

Request Modem temperature.

message cellular_temperature_rsp
Parameters:

Request Modem temperature result.

message cellular_status_latest_req
Return message:

cellular_status_latest_rsp

Request latest known cellular status.

message cellular_status_latest_rsp
Parameters:

  • result (enum cellular_result) – Result of the operation

  • connected (uint8) – Data connection status. true if there is a working cellular packet data connection. false if not.

  • rssi (int32) – Signal strength in dBm, if known. -1 if the signal strength is unknown.

Request latest known cellular status result.

message cellular_status_secondary_latest_req
Return message:

cellular_status_secondary_latest_rsp

Request latest known secondary cellular status.

message cellular_status_secondary_latest_rsp
Parameters:

  • result (enum cellular_result) – Result of the operation

  • connected (uint8) – Data connection status. true if there is a working cellular packet data connection. false if not.

Request latest known second_cellular status result.

message cellular_extended_status_publish_ind
Parameters:

  • data_status (enum cellular_connection_status) – Current status of the cellular data connection

  • access_technology (enum cellular_access_technology) – Currently active radio access technology

  • mcc (string[3]) – Mobile Country Code (ITU Rec E.212) Valid for all access technologies

  • mnc (string[3]) – 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

  • lac_tac (uint16) – Location ID within MCC/MNC Referred to as LAC in GSM and UMTS and TAC in LTE and 5G

  • cid (uint32) – Cell ID (CID) GSM: Cell ID, 16-bit UMTS: Cell ID, 28-bit LTE: Global Cell ID, 28-bit

  • pci (uint16) – Phyiscal Cell ID (PCI) Only valid for LTE and 5G networks

  • arfcn (uint32) – 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

  • signal_strength (int16) – 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

  • signal_quality (int16) – 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

A message with extended cellular status information.

message cellular_extended_status_subscribe_req

Subscribe to cellular_extended_status_publish_ind messages

message cellular_extended_status_subscribe_rsp
Parameters:

result (enum ipc_subscribe_result)

Result from cellular_extended_status_subscribe_req

message cellular_extended_status_unsubscribe_req_norsp

Unsubscribe from cellular_extended_status_publish_ind messages

Enums

enum cellular_result

Result codes.

Constant

Value

Description

OK

0

OK

ERROR_INVALID_PARAMETER

1

Invalid parameter

ERROR_NO_REQUEST_SLOT_AVAILABLE

2

No request slot available

ERROR_NAD_IS_BOOTING

3

NAD is booting

ERROR_UNKNOWN

4

Unknown
enum cellular_connection_status

Cellular connection status.

Constant

Value

Description

UNKNOWN

0

Unknown

NOT_CONNECTED

1

Not connected

SEARCHING

2

Searching

CONNECTED

3

Connected
enum cellular_access_technology

Cellular radio access technology.

Constant

Value

Description

UNKNOWN

0

Unknown

GSM

1

GSM

UMTS

2

UMTS

LTE

3

LTE

5G

4

5G