nrf9160

Set command

The set command subscribes Universal Subscriber Identity Module Application Toolkit (USAT) event notifications. The unsolicited result code is %USATEV: XXX.

The application can use the notifications to get information on USAT events. The application can ensure Universal Integrated Circuit Card (UICC) data transmission by not deactivating the modem when the Bearer Independent Protocol (BIP) channel is open.

Syntax:

%USATEV=<subscribe>[,<event_mask>]

The set command parameters and their defined values are the following:

<subscribe>
0 – Unsubscribe and disable USAT event notifications.
1 – Subscribe and enable USAT event notifications.
<event_mask>
String. Bit string where LSB is BIP events. Leading zeros can be omitted. Maximum length 3 characters. If the parameter is omitted, notifications of all events are subscribed.
Allows to select a subset of USAT events to be reported. Can be used only in a subscribe command (<subscribe>=1). One or more event categories can be selected by setting bits to 1. If the <event_mask> parameter is omitted, all events are enabled (same as entering <event_mask> "111").
Bit 1 – BIP events.
Bit 2 – REFRESH events.
Bit 3 – SMS delivery to or from UICC.
<refresh_type>
REFRESH mode received from UICC.
Valid range 0–10.
Values as specified in ETSI TS 102 223 Ch. 8.6.
<refresh_result>
Result of REFRESH command.
0 – REFRESH performed successfully.
1 – REFRESH rejected, for example, device is busy on data transfer.
2 – REFRESH failed.

The notification syntax descriptions are as follows:

SMS has been received and delivered to UICC by using envelope command SMS-PP data download:

%USATEV: SMS Receive

Sending SMS requested by UICC by using proactive command SEND SHORT MESSAGE:

%USATEV: SMS Send

BIP channel connect process has been started as requested by UICC by using proactive command OPEN CHANNEL:

%USATEV: BIP Connecting

BIP channel connect process has been finished successfully, providing the UICC access to, for example, SIM Over-the-Air (OTA) server:

%USATEV: BIP Connected

BIP channel connection attempt failed or the channel has been closed by UICC by using proactive command CLOSE CHANNEL:

%USATEV: BIP Closed

Proactive command REFRESH has been received from UICC indicating that UICC content has been changed:

%USATEV: REFRESH Requested <refresh_type>

REFRESH command is completed with result indicated in <refresh_result>:

%USATEV: REFRESH End <refresh_result>

The following command example subscribes notifications of all available USAT events:

AT%USATEV=1
OK

The following command example subscribes notifications of BIP channel related USAT events only:

AT%USATEV=1,"001"
OK

The following command example subscribes notifications of BIP channel and SMS related USAT events only:

AT%USATEV=1,"101"
OK

The following command example unsubscribes all USAT event notifications:

AT%USATEV=0
OK