OMA-DM Client User Guide · 2017. 10. 11. · Configuration ... For ##RTN# function, there is AT#SPRTN command: AT#SPRTN="MSL" OK ... 1 #905 Notification – PRL DM session started

OMA-DM Client User Guide 80000NT10097A Rev.2 – 03/23/2015

OMA-DM Client User Guide

Rev.2 – 03/23/2015

Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 2 of 23

APPLICABILITY TABLE

Product

CE910-DUAL

DE910-DUAL

SW Versions

18.12.001

15.00.006


Rev.2 – 03/23/2015


Contents

1. INTRODUCTION ............................................................................................................... 6

2. Configuration ................................................................................................................... 7

2.1. Configuration Commands ................................................................................................... 7

2.1.1. Set OMA-DM Server Address - #OMADMSVADDR ....................................................................... 7

2.1.2. Set OMA-DM Server Port - #OMADMSVPORT .............................................................................. 7

2.1.3. Set OMA-DM Proxy Server Address - #OMADMPROXY ............................................................... 8

2.2. OMA-DM Commands ........................................................................................................... 8

2.2.1. OMA-DM Client Enable/Disable- #OMADMCEN ............................................................................. 8

2.2.2. OMA-DM Device Configuration - +OMADM .................................................................................... 9

2.2.3. OMA-DM PRL Configuration - +PRL ............................................................................................... 9

2.2.4. OMA-DM FUMO Configuration - +FUMO ...................................................................................... 10

2.2.5. Hands Free Activation - #HFA ....................................................................................................... 10

2.2.6. Hands Free Activation Cancel - #HFACANCEL ............................................................................ 11

3. URC screen .................................................................................................................... 12

3.1. HFA Flow ............................................................................................................................ 12

4. HFA ................................................................................................................................. 13

4.1. HFA ..................................................................................................................................... 13

4.2. HFA User Cancellation ...................................................................................................... 14

4.3. HFA Reset .......................................................................................................................... 14

5. Device Configuration .................................................................................................... 15

5.1. NIDC .................................................................................................................................... 15

5.2. CIDC .................................................................................................................................... 16

5.3. DC User Cancellation ........................................................................................................ 16

6. PRL Download ............................................................................................................... 17

6.1. NIPRL .................................................................................................................................. 17

6.2. CIPRL .................................................................................................................................. 18

6.3. PRL Cancellation ............................................................................................................... 18

6.4. PRL ID Checking ................................................................................................................ 18

7. Firmware Download ...................................................................................................... 19

7.1. NIFUMO .............................................................................................................................. 19


Rev.2 – 03/23/2015


7.2. CIFUMO .............................................................................................................................. 20

7.3. FUMO User Cancellation ................................................................................................... 21

8. NIA .................................................................................................................................. 22

8.1. NIA Retry ............................................................................................................................ 22

9. Document History ......................................................................................................... 23


Rev.2 – 03/23/2015


DISCLAIMER

The information contained in this document is the proprietary information of Telit Wireless Solutions Co., Ltd. and its affiliates (“TELIT”). The contents are confidential and any disclosure to persons other than the officers, employees, agents or subcontractors of the owner or licensee of this document, without the prior written consent of Telit, is strictly prohibited.

Telit makes every effort to ensure the quality of the information it makes available. Notwithstanding the foregoing, Telit does not make any warranty as to the information contained herein, and does not accept any liability for any injury, loss or damage of any kind incurred by use of or reliance upon the information.

Telit disclaims any and all responsibility for the application of the devices characterized in this document, and notes that the application of the device must comply with the safety standards of the applicable country, and where applicable, with the relevant wiring rules.

Telit reserves the right to make modifications, additions and deletions to this document due to typographical errors, inaccurate information, or improvements to programs and/or equipment at any time and without notice.

Such changes will, nevertheless be incorporated into new editions of this document.

All rights reserved.

Copyright © Telit Wireless Solutions Co., Ltd.


Rev.2 – 03/23/2015


1. INTRODUCTION This guide describes AT Command usage and Unsolicited Results Codes of Sprint OMA-DM Client for CE910-DUAL and DE910-DUAL. These modules are using Sprint’s OMA-DM Spec v. 2.54.


Rev.2 – 03/23/2015


2. Configuration

2.1. Configuration Commands There are AT commands to change some part of OMA-DM configuration.

OMA-DM AT commands can be use after #900(DM Client ready) event

#OMADMSVADDR – Set OMA-DM Server Address

AT#OMADMSVADDR=<URL>

Execution command sets OMA-DM server address. https://oma.ssprov.sprint.com/oma (factory default) Note: URL should be started with “https://” or “http://” string

AT#OMADMSVADDR? Read command reports the current OMA-DM server address.

Example AT#OMADMSVADDR=https://oma.spcsdns.net/oma OK AT#OMADMSVADDR? https://oma.spcsdns.net/oma OK

#OMADMSVPORT – Set OMA-DM Server Port

AT#OMADMSVPORT=<port number>

Execution command sets OMA-DM server port. 443 (factory default)

AT#OMADMSVPORT? Read command reports the current OMA-DM server port.

Example AT#OMADMSPORT=443 OK AT#OMADMSVPORT? 443 OK

https://oma.ssprov.sprint.com/oma


Rev.2 – 03/23/2015


#OMADMPROXY – Set OMA-DM Proxy Server Address

AT#OMADMPROXY=<port number>,<URL>

Execution command sets OMA-DM proxy server address. http://oma.ssprov.sprint.com:80 (factory default) Note: URL should be started with “https://” or “http://” string

AT#OMADMPROXY? Read command reports the current OMA-DM proxy server address.

Example AT#OMADMPROXY=80,http://oma.ssprov.sprint.com OK AT#OMADMPROXY? http://oma.ssprov.sprint.com:80 OK

2.2. OMA-DM Commands

#OMADMCEN – OMA-DM Client Enable / Disable

AT#OMADMCEN=<onoff> This command enables/disabled the OMA-DM Client feature. <onoff> - OMA-DM Client Status 0: disable 1: enable (default)

AT# OMADMCEN=? Test command returns the range of supported values for parameter <onoff>.

Example AT#OMADMCEN=? #OMADMCEN: (0,1) OK AT#OMADMCEN? #OMADMCEN: 1 OK AT#OMADMCEN=0 OK AT#OMADMCEN? #OMADMCEN: 0


Rev.2 – 03/23/2015


OK AT#OMADMCEN=1 OK OMA-DM service ready notification #900

+OMADM – OMA-DM Device Configuration

AT+OMADM=<onoff> This command initiates an OMA-DM client initiated device configuration (CIDC). <onoff> - Device configuration function status 0: disable 1: enable (default) 2: initiate CIDC

AT+OMADM? Read command

Example AT+OMADM=1 OK AT+OMADM? +OMADM: 1 OK CIDC (OMA-DM client device configuration) initiation. AT+OMADM=2 OK

+PRL – OMA-DM PRL Configuration

AT+PRL=<onoff> This command initiates an OMA-DM CIPRL session, i.e. the downloading of a new /updated PRL. <onoff> - PRL configuration function status 0: disable 1: enable (default) 2: initiate CIPRL


Rev.2 – 03/23/2015


AT+PRL? Read command

Example AT+PRL=1 OK AT+PRL? +PRL: 1 OK CIPRL initiation. AT+PRL=2 OK

+FUMO – OMA-DM FUMO Configuration

AT+FUMO=<onoff> This command sets OMA-DM FUMO enable parameter. <onoff> - FUMO configuration function status 0: disable 1: enable (default) 2: initiate CIFUMO

AT+FUMO ? Read command

Example AT+FUMO=1 OK AT+FUMO? +FUMO: 1 OK CIFUMO initiation. AT+FUMO=2 OK

#HFA – Hands Free Activation

AT#HFA This command initiates the “Sprint Hands Free Activation” (HFA) session.


Rev.2 – 03/23/2015


Example HFA initiation. AT#HFA OK

#HFACANCEL – Hands Free Activation Cancel

AT#HFACANCEL This command cancels the current HFA DM session.

Example HFA DM session cancel. AT#HFACANCEL OK


Rev.2 – 03/23/2015


3. URC screen

3.1. HFA Flow

#904 #914

#905 #909

#907 #921

#920: %

UART

#930

#901

#902: sec

#910

#916 #929: res


Rev.2 – 03/23/2015


4. HFA

4.1. HFA

HFA Process – Success Case

seq Terminal Description

1 #904 Notification - HFA Started

2 #914 Notification – Done, HFA Success

3 #DREL Notification – Data session release

HFA Process – Fail Case



2 <Error_Noti> Notification – Error happens while HFA

One of following notification will come out.

#911 - credential error

#912 - unreachable server

#913 - network error

#923 – etc.


HFA Process – Retry Case




Rev.2 – 03/23/2015


2 #901:<num_retry> Notification - HFA retry start


4 #902:<counter_sec> Notification – 60 seconds countdown.

This notification message happens for every 1 second.

5 Retry Max 5 times

It recursively proceed from seq#1 ~ seq#4.

6 #922 Notification – Done with no HFA information

If it meets HFA success or failure while this 5-time-retry, it will show the result as described in 4.1. HFA Success or 4.2. HFA Failure.

But if it ends with no profile, #922 is returned.

4.2. HFA User Cancellation

This is AT Command to cancel current HFA.

HFA Process


1 AT#HFACANCEL

OK

Notification - HFA Started

2 #924 Notification – HFA cancelled


4.3. HFA Reset For ##RTN# function, there is AT#SPRTN command:

AT#SPRTN="MSL"

OK

After AT#SPRTN, HFA will happen when the device is rebooted.

Please talk with Sprint to get the MSL code.


Rev.2 – 03/23/2015


5. Device Configuration

5.1. NIDC

After receiving NIA for DC, device configuration will happen.

For NIA retry, refer to section 8.

DC Process – Success Case


1 #906 Notification – DC DM session started

2 #918 Notification – DC Done, success


DC Process – Fail Case



2 <Error_Noti> Notification – Error happens while DC





#915 – update fails with other reasons



Rev.2 – 03/23/2015


5.2. CIDC

For CIDC, start DC session with AT+OMADM=2 command.

And DC process after AT+OMADM=2 command is same as NIDC.

When there is no profile to be updated, following messages will be shown.

DC Process – No Profile Case



2 #924 Notification – DC Done, no profile


5.3. DC User Cancellation

User can cancel DC session with AT#DCCANCEL command.

When AT#DCCANCEL issued, following messages will come out.

AT#DCCANCEL

OK

#924

#DREL


Rev.2 – 03/23/2015


6. PRL Download

6.1. NIPRL

After receiving NIA for PRL, device configuration will happen.


PRL Process – Success Case


1 #905 Notification – PRL DM session started

2 #909 Notification – Done, PRL success


Radio reset happens for PRL update after PRL update DM session succeeded.

PRL Process – Fail Case



2 <Error_Noti> Notification – Error happens while PRL








Rev.2 – 03/23/2015


6.2. CIPRL

For CIPRL, start PRL session with AT+PRL=2 command.

And CIPRL process started by AT+PRL=2 command is same as NIPRL.

When there is no PRL to be updated, following messages will be shown.

PRL Process – No PRL Case



2 #910 Notification – Done, No PRL update


6.3. PRL Cancellation

User can cancel PRL session with AT#PRLCANCEL command.

When AT#PRLCANCEL issued, following messages will come out.

AT#PRLCANCEL

OK

#910

#DREL

6.4. PRL ID Checking

To check PRLID, use this AT command:

AT$PRL?

<prl_id>

OK


Rev.2 – 03/23/2015


7. Firmware Download

7.1. NIFUMO

After receiving NIA for FUMO, device configuration will happen.


FUMO Process – Success Case


1 #907 Notification – FUMO DM session started

2 #921 Notification – Firmware download start

3 #921:<fw_total_size> Notification – Firmware size get from the OMA-DM server (byte)

4 #920:<dl_progress> Notification – Firmware download progress (percent)

5 #919 Notification – Done, Firmware downloaded successfully

6 #930 Notification – Reporting of Firmware Update result to server

7 #907 Notification – FUMO DM session start again until no more updates are available

8 #929:<result> Notification – Firmware Update result

#929: 200 - Update Success

#929: 402 - Firmware corrupted , CRC error

#929: 403 - Firmware Package Mismatch

#929: 404 - Firmware Signature Failed

#929: 406 - Authentication Failed

#929: 410 - General Error



Rev.2 – 03/23/2015


FUMO Process – Fail Case



2 <Error_Noti> Notification – Error happens while FUMO







7.2. CIFUMO

For CIFUMO, start FUMO session with AT+FUMO=2 command.

And CIFUMO process started by AT+FUMO=2 command is same as NIFUMO.

When there is no firmware to be updated, following messages will be shown.

FUMO Process – No Firmware Case



2 #916 Notification – Done, No firmware update



Rev.2 – 03/23/2015


7.3. FUMO User Cancellation

User can cancel FUMO session with AT#FUMOCANCEL command.

When AT#FUMOCANCEL issued, following messages will come out.

AT#FUMOCANCEL

OK

#916

#DREL


Rev.2 – 03/23/2015


8. NIA

8.1. NIA Retry

NIA Process – Retry Case


1 <start_noti> Notification – PRL, DC, FUMO DM session started

#905 : PRL DM session start message

#906 : DC DM session start message

#907 : FUMO DM session start message

#928 : NIA digest mismatch error

2 #926 Notification - NIA retry start


4 60 seconds wait.

5 Retry Max 5 times

It recursively proceed from seq#1 ~ seq#3.

6 #927 Notification – Done with no NIFA information

If it meets NIA success or failure while this 5-time-retry, it will show the result as described in 5.1 NI DC, 6.1 NI PRL or 7.1 NI FUMO.

But if it ends with no profile, #927 is returned.


Rev.2 – 03/23/2015


9. Document History

RReevviissiioonn DDaattee CChhaannggeess

0 04/04/2013 First Release

1 04/15/2013 Updated OMA-DM commands

2 03/23/2015 Removed #OMADLPROXY command Update APPLICABILITY TABLE

Documents

OMA-DM Client User Guide · 2017. 10. 11. · Configuration ... For ##RTN# function, there is AT#SPRTN command: AT#SPRTN="MSL" OK ... 1 #905 Notification – PRL DM session started