OMA-DM Client User Guide · 2017. 10. 11. · Configuration ... For ##RTN# function, there is...
Transcript of OMA-DM Client User Guide · 2017. 10. 11. · Configuration ... For ##RTN# function, there is...
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 3 of 23
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 4 of 23
7.2. CIFUMO .............................................................................................................................. 20
7.3. FUMO User Cancellation ................................................................................................... 21
8. NIA .................................................................................................................................. 22
8.1. NIA Retry ............................................................................................................................ 22
9. Document History ......................................................................................................... 23
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 5 of 23
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.
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 6 of 23
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.
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 7 of 23
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 8 of 23
#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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 9 of 23
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 10 of 23
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.
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 11 of 23
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 12 of 23
3. URC screen
3.1. HFA Flow
#904 #914
#905 #909
#907 #921
#920: %
UART
#930
#901
#902: sec
#910
#916 #929: res
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 13 of 23
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
seq Terminal Description
1 #904 Notification - HFA Started
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.
3 #DREL Notification – Data session release
HFA Process – Retry Case
seq Terminal Description
1 #904 Notification - HFA Started
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 14 of 23
2 #901:<num_retry> Notification - HFA retry start
3 #DREL Notification – Data session release
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
seq Terminal Description
1 AT#HFACANCEL
OK
Notification - HFA Started
2 #924 Notification – HFA cancelled
3 #DREL Notification – Data session release
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.
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 15 of 23
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
seq Terminal Description
1 #906 Notification – DC DM session started
2 #918 Notification – DC Done, success
3 #DREL Notification – Data session release
DC Process – Fail Case
seq Terminal Description
1 #906 Notification – DC DM session started
2 <Error_Noti> Notification – Error happens while DC
One of following notification will come out.
#911 - credential error
#912 - unreachable server
#913 - network error
#915 – update fails with other reasons
3 #DREL Notification – Data session release
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 16 of 23
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
seq Terminal Description
1 #906 Notification – DC DM session started
2 #924 Notification – DC Done, no profile
3 #DREL Notification – Data session release
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 17 of 23
6. PRL Download
6.1. NIPRL
After receiving NIA for PRL, device configuration will happen.
For NIA retry, refer to section 8.
PRL Process – Success Case
seq Terminal Description
1 #905 Notification – PRL DM session started
2 #909 Notification – Done, PRL success
3 #DREL Notification – Data session release
Radio reset happens for PRL update after PRL update DM session succeeded.
PRL Process – Fail Case
seq Terminal Description
1 #905 Notification – PRL DM session started
2 <Error_Noti> Notification – Error happens while PRL
One of following notification will come out.
#911 - credential error
#912 - unreachable server
#913 - network error
#915 – update fails with other reasons
3 #DREL Notification – Data session release
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 18 of 23
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
seq Terminal Description
1 #905 Notification – PRL DM session started
2 #910 Notification – Done, No PRL update
3 #DREL Notification – Data session release
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 19 of 23
7. Firmware Download
7.1. NIFUMO
After receiving NIA for FUMO, device configuration will happen.
For NIA retry, refer to section 8.
FUMO Process – Success Case
seq Terminal Description
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
9 #DREL Notification – Data session release
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 20 of 23
FUMO Process – Fail Case
seq Terminal Description
1 #907 Notification – FUMO DM session started
2 <Error_Noti> Notification – Error happens while FUMO
One of following notification will come out.
#911 - credential error
#912 - unreachable server
#913 - network error
#915 – update fails with other reasons
3 #DREL Notification – Data session release
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
seq Terminal Description
1 #907 Notification – FUMO DM session started
2 #916 Notification – Done, No firmware update
3 #DREL Notification – Data session release
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 21 of 23
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
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 22 of 23
8. NIA
8.1. NIA Retry
NIA Process – Retry Case
seq Terminal Description
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
3 #DREL Notification – Data session release
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.
OMA-DM Client User Guide
Rev.2 – 03/23/2015
Reproduction forbidden without Telit Wireless solutions Co., Ltd. All Rights Reserved Page 23 of 23
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