IPC Module - Modem Service

This page contains documentation of the Cellular Data API.

Messages

message modem_rusat_at_command_req

Parameters:

timeout (uint32) – Operation timeout in milliseconds.
command (string) – AT command to send to modem, will only accept one of the following: AT commands below must always be terminated with. … imply arbitrary trailing characters. AT^SSTA… AT^SSTGI… AT^SSTR… AT^SIND=”simstatus”,… AT^SIND=”simdata”,…

Return message:

modem_rusat_at_command_rsp

Request to send RUSAT AT command to NAD (Network Access Device).

message modem_rusat_at_command_rsp

Parameters:

result (enum modem_rusat_result) – Operation result.
status (uint8) – Operation status, if result is ‘ERROR’ and status is non zero then status is CME ERROR status. Otherwise zero.
response (string) – Modem response to AT command (one line per response).

message modem_rusat_sstn_latest_req

Request latest known SSTN URC value.

message modem_rusat_sstn_latest_rsp

message modem_rusat_urc_notification_publish_ind

Parameters:: urc (string) – URC string, can be one of the following: … imply arbitrary trailing characters. ^SSTN:… +CIEV: simstatus… +CIEV: simdata…

RUSAT related URC from NAD (Network Access Device).

message modem_rusat_urc_notification_subscribe_req: Subscribe to modem_rusat_urc_notification_publish_ind messages

message modem_rusat_urc_notification_subscribe_rsp

Result from modem_rusat_urc_notification_subscribe_req

message modem_rusat_urc_notification_unsubscribe_req_norsp: Unsubscribe from modem_rusat_urc_notification_publish_ind messages

enum modem_rusat_result

Result codes.

Constant	Value	Description
OK	0	NAD response line (one of possibly several).
ERROR	1	Any NAD reported error such as ERROR or CME ERROR etc.
ERROR_NAD_NOT_AVAILABLE	2	Nad is not in a state to process RUSAT AT commands.
ERROR_INVALID_COMMAND	3	Supplied RUSAT AT command is not qualified.
ERROR_FAILED_TO_SEND_AT_COMMAND	4	Unspecific error when trying to send command to NAD.