Application Note
R19AN0075EU0150 Rev.1.50
Page 1 of 76
Mar.15.22
RYZ014 Modules
Use Cases with AT Commands
Introduction
This document will provide RYZ014-based platform users with practical use cases of AT commands.
Target Device
RYZ014 modules.
Contents
1.
General Introduction ........................................................................................................... 5
2.
Network Connection............................................................................................................ 5
2.1
Check that the SIM Card is Ready...................................................................................................... 5
2.1.1
Feature Description .......................................................................................................................... 5
2.1.2
Use Cases ....................................................................................................................................... 6
2.1.3
Error Handling .................................................................................................................................. 9
2.2
Configure the Operator Mode ............................................................................................................. 9
2.2.1
Feature Description .......................................................................................................................... 9
2.2.2
Use Cases ..................................................................................................................................... 10
2.2.3
Error Handling ................................................................................................................................ 12
2.3
Connect to the Network and Check that Attach is Done .................................................................... 12
2.3.1
Feature Description ........................................................................................................................ 12
2.3.2
Use Cases ..................................................................................................................................... 13
2.3.3
Error Handling ................................................................................................................................ 15
3.
How to Manage TLS Certificates ........................................................................................18
3.1
Feature Description .......................................................................................................................... 18
3.1.
Use Cases with Certificates.............................................................................................................. 18
3.1.1
Identify a Free Certificate Index Entry ............................................................................................. 18
3.1.2
Add Certificate at Index 0 ............................................................................................................... 20
3.1.3
Read Certificate at Index 0 ............................................................................................................. 20
3.1.4
Remove Certificate at Index 0......................................................................................................... 20
3.2
Use Cases with Private Keys ............................................................................................................ 20
3.2.1
Upload a Private Key-at Index 1. .................................................................................................... 20
3.2.2
Read the Private Key at Index 1 ..................................................................................................... 21
3.2.3
Remove the Private Key at Index 1 ................................................................................................. 21
3.3
Use Cases to Setup a Security Profile .............................................................................................. 21
3.4
Error Handling .................................................................................................................................. 22
4.
Proprietary FOTA...............................................................................................................22
4.1
Feature Description .......................................................................................................................... 22
Page 1: ... 2 2 3 Error Handling 12 2 3 Connect to the Network and Check that Attach is Done 12 2 3 1 Feature Description 12 2 3 2 Use Cases 13 2 3 3 Error Handling 15 3 How to Manage TLS Certificates 18 3 1 Feature Description 18 3 1 Use Cases with Certificates 18 3 1 1 Identify a Free Certificate Index Entry 18 3 1 2 Add Certificate at Index 0 20 3 1 3 Read Certificate at Index 0 20 3 1 4 Remove Certificat...
Page 2: ...30 5 1 3 Use Cases in Command Mode 30 5 1 4 Accept Any Remote Option 31 5 1 5 Error Handling 32 5 2 How to Send Data with TCP 33 5 2 1 Feature Description 33 5 2 2 Use Cases in Online Mode 33 5 2 3 Use Cases in Command Mode with Text Data 35 5 2 4 Use Cases in Command Mode with Hex Data 35 5 2 5 Error Handling 36 5 3 How to Send Data on HTTP Connection 36 5 3 1 Feature Description 36 5 3 2 Use Cas...
Page 3: ...d Receive a SMS in PDU Mode 58 6 2 1 Feature Description 58 6 2 2 Use Case 58 6 3 How to Manage SMS Storage 59 6 3 1 Feature Description 59 6 3 2 Use Cases 59 6 3 3 Error Handling 61 7 Low Power with eDRX and PSM 62 7 1 How to Use eDRX Feature 62 7 1 1 Feature Description 62 7 1 2 Use Cases 64 7 2 How to Use PSM Feature 64 7 2 1 Feature Description 64 7 2 2 Use Case 67 7 3 eDRX and PSM Troubleshoo...
Page 4: ... 22 10 1 UART Interfaces 70 10 2 How to Configure the RING Signal 70 10 2 1 Feature Description 70 10 2 2 Use Cases 71 10 3 How to Configure Modem Alarms 71 10 3 1 Feature Description 71 10 3 2 Use Cases 71 11 Manufacturing 74 12 Appendix Glossary and Abbreviations 74 Revision History 76 ...
Page 5: ...ry to attach to the network until the host MCU sets the CFUN state to 1 meaning full functionality This section will help you to connect your RYZ014 based device to the network following these simple steps 1 Confirm that the SIM card in your device works properly 2 Confirm that your device is configured to interact with your operator s network 3 Attach your device to the network 2 1 Check that the...
Page 6: ... SIM slot AT CSUS CSUS 0 OK Verify that the change was considered AT CFUN 4 OK Set the modem to airplane mode so that the SIM is read AT CIMI 208019706849013 OK Make sure that the IMSI corresponds to the one of the SIM you want to use If CIMI is sent before the modem finishes reading the SIM card it will return an error AT RESET OK Restart the modem SHUTDOWN SYSSTART AT CSUS CSUS 0 OK The configur...
Page 7: ...IMST SQNSIMST 1 5 OK If URC are not enabled it is possible to check the SIM state with this command as well 2 1 2 4 Enable SIM Lock with PIN Code Command Response Comment AT CLCK SC 1 0000 OK SC SIM lock SIM UICC card installed in the currently selected card slot SIM UICC asks password in MT power up and when this lock command issued 1 lock 0000 PIN code 2 1 2 5 Disable SIM Lock with PIN Code Comm...
Page 8: ...T CPIN 0000 OK PIN code is correct SIM card unlocked Check SIM card state AT CPIN CPIN READY SIM card is present and unlocked ready to use 2 1 2 7 Enter PUK Code to Unlock SIM Command Response Comment Check current SIM card state AT CPIN CPIN SIM PUK OK Require SIM PUK to unlock SIM card Type PUK code to unlock with 12345678 PUK code AT CPIN 12345678 ERROR PUK code is not correct SIM card is still...
Page 9: ... using the CSUS command first check how many SIM slots are supported by the module and second confirm the CFUN 0 state Command Response Comment Check the number of supported SIM slots case only 1 slot AT CSUS CSUS 1 OK Only one SIM slot is supported external Trying to switch to the internal SIM slot results in error AT CSUS 1 CME ERROR ERROR If the CFUN state is 1 or 4 the SIM slot cannot be switc...
Page 10: ...efined operator modes By default the software is configured with standard operator mode The UE will scan in priority the EARFCN on which it managed to attach previously It will then scan for all the bands that are configured without adding any priority between the bands when in standard mode Note Please refer to the System Integration Guide for more information on the operator modes and the scanni...
Page 11: ... SQNBANDSEL 0 telstra 3 28 SQNBANDSEL 0 telus 12 4 5 SQNBANDSEL 0 truphone 1 2 4 8 12 20 SQNBANDSEL 0 verizon no roaming 4 13 SQNBANDSEL 0 verizon 13 4 5 12 17 20 SQNBANDSEL 0 vodafone 20 8 OK 17 bands are configured for the standard operator mode Reduce the number of bands to be scanned AT SQNBANDSEL 0 st andard 3 8 20 SQNBANDSEL 0 standard 3 8 20 OK The bands to be scanned will be limited to ban...
Page 12: ...anned in a specificoperator mode Please note that you can only reduce the bands to be scanned and not add a new one When adding a new band the AT command will not return any error but the new band will not be scanned by the modem It is highly recommended to use the SQNBANDSEL command with the standard operator mode only AT SQNBANDSEL 0 orange 20 SQNBANDSEL 0 orange 20 OK Scanning is now limited to...
Page 13: ...EREG 1 0002 01A2 2002 7 2 3 2 2 Check the Network s Registration Status Command Response Comment Query network registration status AT CEREG CEREG 0 1 OK 0 network registration URC disabled 1 registered home network 2 3 2 3 Check the PDP Context Configuration Command Response Comment Get current PDP context configuration AT CGDCONT CGDCONT 1 IPV4V6 broadband 0 0 0 0 0 0 0 0 CGDCONT 2 IPV4V6 lwaacti...
Page 14: ... CGPADDR CGPADDR 1 192 168 6 3 32 1 4 104 48 6 0 3 3 2 1 4 104 48 6 0 3 CGPADDR 2 CGPADDR 3 192 168 11 2 CGPADDR 4 OK cid 1 IPv4 and IPv6 address cid 2 not activated no IP address cid 3 IPv4 address Query IP address of cid 1 AT CGPADDR 1 CGPADDR 1 192 168 6 3 32 1 4 104 48 6 0 3 3 2 1 4 104 48 6 0 3 OK cid 1 IPv4 and IPv6 address 2 3 2 6 Detach from the Network Command Response Comment AT CFUN 0 O...
Page 15: ...nd is not currently searching an operator to register to Command Response Comment AT CEREG Query network registration status CEREG 0 0 OK Possible causes SIM card error SIM card not detected PIN code not entered SIM card read error The registration is not started COPS 2 execute the actions below AT CFUN Check if current CFUN state is 1 CFUN 1 OK AT CGATT 1 OK Force EPS attach 2 3 3 2 If CEREG retu...
Page 16: ...o retrieve a coverage no action required CEREG 1 Verify reception signal strength In the response below rssi is the signal strength of the antenna and ber is the bit error rate in percent Please refer to AT Commands User s Manual for details on values and levels AT CSQ CSQ rssi ber If the signal strength is low change to a different position and try again AT CEREG Query network registration status...
Page 17: ...K 0 automatic operator select mode 0 long format alphanumeric oper Amarisoft Network oper name 7 E UTRAN 2 3 3 4 If CEREG returns status 4 If CEREG returns status 4 an unknown error occurred for example out of E UTRAN coverage Command Response Comment AT CEREG Query network registrationstatus CEREG 0 4 OK Check current signal strength AT CSQ CSQ 18 99 or not detectableOK 18 RSSI 77dBm 99 channel b...
Page 18: ...on volatile memory using certificate or privatekey parameters with the specific index inthe file system The file size corresponds to the exact number of bytes to be uploaded After an AT SQNSNVW write command is issued the user sends certificate bytes in PEM Privacy enhanced Electronic Mail format To delete a certificate or a private key the user simply writes a 0 byte certificate or private key us...
Page 19: ...0 000000000000000000000000000000000000000000000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000000000000000000000000000000 0000000000000000000 sha1 9aacd9b54b2f972ef2e1bd488eb550afcc462d46 SQNSNVR certificate 3 C US O DigiCert Inc OU www digicert com CN DigiCert Global Root CA 0000000000000000 C US O DigiCert Inc OU www digicert com CN DigiCert Global Roo...
Page 20: ...00 000000 000000000000000000000000000000000000000000 0000000000000 0000000 00000000000000000000000000000000000 C GB ST United Kingdom L Derby O Mosquitto OU CA CN mosquitto org emailAddr ess roger atchoo org 12 06 29 22 11 59 22 06 27 22 11 59 sha1RSA 00000000000000000000 sha1 1d214e931ab1 da59c 1e08f025f268d2783a51f0a OK 3 1 4 Remove Certificate at Index 0 Command Response Comment AT SQNSNVW cert...
Page 21: ...bdYKO3JprPxSBoRponZJvDGEZuM3N7p3S lRoi7G5wG5mvUmaE5RAgMBAAGj REyPOFdGdhBY2P1FNRy0MDr6xr D2ZOwxs63dG1nnAnWZg7qwoLgpZ4fESPD3PkA 1ZgKJc2zbSQ9fCPxt2W3mdVav66c6fsb7els2W2Iz7gERJSX END CERTIFICATE OK Upload a private key type file with size 1679 bytes into file system AT SQNSNVW privatekey 0 167 9 After prompt enter the data from certificate file and press Enter at the end BEGIN RSA PRIVATE KEY MIIEpQIB...
Page 22: ...char can be changed by an ATS3 command Please refer to AT Commands Reference Manual for more details When developing an application on the host MCU based on AT commands if no specific requirements are set please use CR r as the terminator character Depending on the software release AT SQNSPCFG might not allow setting all the cipher suites supported by the modem In that case the list of cipher suit...
Page 23: ...TP compliant with RFC1738 4 2 1 Synchronous Upgrade using HTTPS Protocol Command Response Comment Launch the device upgrade AT SQNSUPGRADE https s3 us west 2 amazonaws com FileShare 41613 ue dup 1 10 0 The device will reboot automatically after the firmware is installed and report progress every 10 in synchronous upgrade OK SQNSUPGRADE available UE can access URL SQNSUPGRADE downloading 0 Start do...
Page 24: ... command SQNSUPGRADE downloading 1 Download started SQNSUPGRADE downloading 2 Progress notification SQNSUPGRADE downloading 100 OK The new SW image is downloaded and stored in theUE s file system SQNSUPGRADE rebooting The UE will reboot to install thenew SW image SQNSUPGRADE installed Device is upgraded to the newSW image SYSSTART Device is ready for operation 4 2 3 Synchronous Upgrade using HTTPS...
Page 25: ...re is installed and report progress every 1 in synchronous upgrade SQNSUPGRADE available UE can access the URL specified in the command SQNSUPGRADE downloading 1 Download started SQNSUPGRADE downloading 2 Progress notification SQNSUPGRADE downloading 100 OK The new SW image is downloaded and stored in theUE s file system SQNSUPGRADE rebooting The UE will reboot to install thenew SW image SQNSUPGRA...
Page 26: ...SUPGRADE downloading 40 SQNSUPGRADE downloading 50 SQNSUPGRADE downloading 60 SQNSUPGRADE downloading 70 SQNSUPGRADE downloading 80 SQNSUPGRADE downloading 90 SQNSUPGRADE downloading 100 Progress notifications SQNSUPGRADE rebooting Device is rebooting and willenter updater mode to finish the upgrade SQNSUPGRADE installed Device is upgraded to thenew SW SYSSTART 4 2 5 Cancel Asynchronous Upgrade wi...
Page 27: ... SQNSUPGRADE downloading 50 SQNSUPGRADE downloading 60 SQNSUPGRADE downloading 70 SQNSUPGRADE downloading 80 SQNSUPGRADE downloading 90 SQNSUPGRADE downloading 100 SQNSUPGRADE rebooting SQNSUPGRADE installed SYSSTART 4 2 7 Cancel Asynchronous Upgrade with FTP protocol Command Response Comment Launch the asynchronous update with FTP protocol Login is ftpuser and password is ftppwd AT SQNSUPGRADE ft...
Page 28: ...nd the destination firmware version the new version to be upgraded When receiving error code 531 when host system is trying to initiate FOTA upgrade check that the modem attaches on network before starting FOTA upgrade When losing the network connection the modem would try no more than 10 times if an error occurred during downloading and resume if network connection is back The modem cannot be pow...
Page 29: ...s expire Therefore it isrecommended to check the socket status with AT SQNSS command before sending data Certificates and private keys can be stored to the non volatile memory through AT commands Specific AT commands are implemented for HTTP HTTPS FTP and TFTP transfers Two modes are supported with these commands In asynchronous mode the command is executed in background by the system For instance...
Page 30: ...string and press enter when complete OK AT SQNSS Check socket configuration status SQNSS 1 2 192 168 13 3 49165 192 168 13 1 8008 SQNSS 2 0 SQNSS 3 0 SQNSS 4 0 SQNSS 5 0 SQNSS 6 0 OK AT SQNSO 1 Resumes socket connection The CONNECT indication is given and the modem goes into online data mode again CONNECT OK SQNSRING 1 SQNSRING URC indicates here that there is incoming connection on 1st socket AT ...
Page 31: ...s configured within the socket and how to send packets to another IP address port 5 1 4 1 Receive Data from a Different Server Command Response Comment Ensure that UE is attached to LTE network You can then configure the socket AT SQNSCFG 1 1 300 0 0 50 OK Basic socketconfiguration AT SQNSCFGEXT 1 2 0 0 OK AT SQNSD 1 1 5000 172 16 72 2 0 3000 1 1 OK Enable receive data from any other remotethan IP...
Page 32: ...The AT command syntax isdescribed in the 3GPP 27 007 4 1 and 4 2 and ITU V250 5 2 1 The termination character is CR by default For example when using CR LF r n as terminator it would be without impact for most of AT commands since the n would be treated as invalid AT command But for AT which need input data during executing the second char LF n would stay in the buffer and be treated as input data...
Page 33: ...o configure the transmission protocol TCP or UDP AT SQNSSEND AT SQNSSENDEXT AT SQNSRECV AT SQNSH URC SQNSRING A typical TCP setup is illustrated in Figure 2 Figure 3 TCP Typical Setup Note The connection to the server is opened from another machine by running netcat shorten as nc program as follows nc l 8008 Data from the server are also typed manually 5 2 2 Use Cases in Online Mode Command Respon...
Page 34: ...y data back to UE this data shall bereceived over serial link Suspend online mode OK The UART is back to AT command mode The socketis suspended AT SQNSS Check socket status Command Response Comment SQNSS 1 2 192 168 13 3 49165 192 168 13 1 8008 SQNSS 2 0 SQNSS 3 0 SQNSS 4 0 SQNSS 5 0 SQNSS 6 0 AT SQNSO 1 Restore the socket in online mode CONNECT Success indication OK Suspend the socket Got again S...
Page 35: ...1 100 Receive up to 100 bytesfrom 1st socket SQNSRECV 1 24 24 bytes are received Hello extend from client OK AT SQNSH 1 OK Shutdown connection 5 2 4 Use Cases in Command Mode with Hex Data In hex mode data is represented as a sequence of hexadecimal numbers from 00 to FF This is usually used to send a binary file In this case AT SQNSSENDEXT usage is suggested since all data can be sent without any...
Page 36: ...loping an application on the host MCU based on AT commands if no specific requirements are set please use CR r as the terminator character The format of SQNSRING can be configured by AT SQNSCFGEXT When AT SQNSCFGEXT parameter srMode is set to 2 the Unsolicited Response is SQNSRING connId recData data Data is shown in the URC but this does not mean that the received bytes are flushed from the buffe...
Page 37: ... returns error when there is no body only a header in the data received 5 3 2 2 Send POST Request with AT SQNHTTPSND This test is to be run after the GET request sequence Command Response Comment AT SQNHTTPSND 1 0 post 7 Type the command See below the notes on post param and extra header line parameters Get a prompt Type string with additional parameter and press CTRL Z foo bar OK In case of succe...
Page 38: ...daryv9K2Q6NJOnI5kAZX In the example above data length is 336 And after you get a prompt enter 336 bytes as content with boundary string as a separator Both AT SQNHTTPSND and AT SQNHTTPQRY commands support the optional parameter extra_header_line It allows inclusion of an additional HTTP header line character is used to identify the header line ending If you want to type char in header just echo it...
Page 39: ... SQNFPUT command performs a HTTP POST or PUT request with file content to server When an answer from HTTP server is received you will see SQNHTTPRING URC with information The fifth parameter post_param is different from the one in SQNHTTPSND command It can take two different values json log txt json log zip It will convert the uploading content to json format zip txt logs BASE_64_FILE If one of th...
Page 40: ...a start with n and this may trigger other problems When sending data in HEX mode it will trigger and ERROR immediately as n is an invalid HEX char The terminator char can be changed by ATS3 command please refer to AT Commands Reference Manual for more details When developing an application on the host MCU based on AT commands if no specific requirements are set please use CR r as the terminator ch...
Page 41: ...ernet cid is 3 as defined on Verizon network For most ofthe other network operators the internet cid is 1 AT SQNSCFG 1 3 300 90 600 50 OK AT SQNSSCFG 1 1 1 OK Enable security profile 1 set above on socketconnection id 1 AT SQNSD 1 0 32806 ec2 3 134 42 3 us east 2 compute amazonaws co m 0 0 1 OK AT SQNSSEND 1 Hello with TLS OK SQNSRING 1 AT SQNSRECV 1 100 SQNSRECV 1 15 Hello with TLSOK 5 4 2 1 Add ...
Page 42: ...pload privatekey type file with size 1679 bytes into file system AT SQNSNVW privatekey 1 167 9 After prompt enter the data from certificate file and press Enter at the end BEGIN RSA PRIVATE KEY MIIEpQIBAAKCAQEA0DeexyAY2TP1LeRL MR7nVXzq eQysfvZCzZVy39KXPtSaGL 5gHjlGS2ufB9ZB3KgOxSMlF W7oqB6xa5FLMD4YQfgQiUux6kmuQZ4r3yvCUlOxD h46R1gIvDPGBeS0r7Ex4ILu WCYDIWrQ740KaxODp8 z10GfqFzKMq7eVFBl6gBtzU1JMs7L12qn...
Page 43: ...rofile 1 AT SQNHTTPCFG 0 github com 443 0 1 120 1 1 OK AT SQNHTTPQRY 0 0 OK Send a HTTP Get queryon profile 0 if succeed you would get an URClater SQNHTTPRING 0 200 text html charset utf 8 0 AT SQNHTTPRCV 0 0 Read the body of httpresponse You would see a prompt then the whole data followed by an OK OK Note that SQNHTTPRCV returns error when there isno body only a header inthe data received 5 5 3 T...
Page 44: ...ad received data You would see the content displayed then followed by a result status Data OK If all data are received you will get the download status URC to indicate that the download is complete SQNFGETREPORT complete 5 6 3 Use Cases The example detailed in this section is the typical application of downloading a file to the Host MCU PC in asynchronous mode 5 7 How to Use FTP AT Commands 5 7 1 ...
Page 45: ... file from the remote ftp server 192 168 10 1 and save the file as mylocalfile on the device s file system AT SQNFGET ftp 192 168 10 1 testfile 0 mylocalfile OK SQNFGETREPORT started SQNFGETRING 200 SQNFGETREPORT downloading SQNFGETREPORT complete AT SQNFGET ftp 192 168 10 1 testfile 0 OK SQNFGETREPORT started SQNFGETRING 200 SQNFGETREPORT downloading SQNFGETREPORT complete Data can only be read w...
Page 46: ... configure the following SSL TLS connections properties 5 8 2 MQTT Server AWS IoT platform Cloud IoT Core Azure or any other MQTT server can be used tests and usage Another test server is Mosquitto https test mosquitto org 5 8 2 1 Mosquitto Mosquitto is a MQTT open source test server https test mosquitto org This server can run on a local setup To test MQTTS connection use openssl to generate cert...
Page 47: ...mands Then set a security profile with SQNSPCFG using the two certificates and the private key you just uploaded Please refer to Section 3 How to Manage TLS Certificates on page 18 for more details on SQNSNVW and SQNSPCFG usage Please refer to Section 5 8 3 3 to connect to AWS IoT server subscribe and publish to a topic Pay attention to the following The client id parameter to be set in the SQNSMQ...
Page 48: ...llow carefully the steps described in https cloud google com iot docs how tos credentials keys to generate a public private key pair with a Linux OS that will be used to authenticate your device on the cloud On Windows you can use PUTTYgen to do that The private key rsa_private pem needs to be used to generate a JWT Jason Web Token as explained below The public key rsa_public pem should be used wh...
Page 49: ... to set a password using a JWT Jason Web Token Please refer to https cloud google com iot docs how tos credentials jwtsto generate the JWT signature that will be set in the pwd parameter of SQNMQTTCFG 4th parameter The host domain name to be used in the SQNSMQTTCONNECT command is mqtt googleapis com 5 8 3 Use Cases 5 8 3 1 Non Encrypted Command Response Comment Configure client id and client id st...
Page 50: ... The data is provided as length defined multi line data or ESC to cancel publishing AT SQNSMQTTPUBLISH 0 sqn tes t 1 32 is the length of the payload to be entered after the prompt msg hello from IoT device The AT ends automatically once 32 bytes of data are entered SQNSMQTTPUBLISH 2 OK SQNSMQTTPUBLISH 0 2 0 Notification that publishing operation is finished for client 0 Receive a message by client...
Page 51: ...the server connection Configure the security profile If the remote server does not support one of the cipher suites configured in the cipherSpecs list the handshake fails For security reason it is recommended to reduce the list to the minimum to avoid man in the middle attack like The third parameter is cipher suites Supported cipher suites IANA number RFC Name 0x2F TLS_RSA_WITH_AES_128_CBC_SHA 0x...
Page 52: ...device SQNSMQTTPUBLISH 2 OK The AT ends automatically once 32 bytes of data are entered SQNSMQTTPUBLISH 0 2 0 URC notifies that publishing operation is finished for client 0 Receive a message by client id 0 or last received message in case of qos 0 when receiving SQNSMQTTONMESSAGE SQNSMQTTONMESSAGE 0 sqn test 32 1 1 URC notifies about a new received message which was stored to the internal message...
Page 53: ...e If the remote server does not support one of the cipher suites configured in the cipherSpecs list the handshake fails If the remote server does not support one of the cipher suites configured in the cipherSpecs list the handshake fails For security reason it is recommended to reduce the list to the minimum to avoid man in the middle type attacks Use AT SQNSNVR certificate and AT SQNSNVR privatek...
Page 54: ...d 5 8 2 3 to get the domain names to be used for AWS and IoT Core port 8883 is for test with MQTT encrypted SQNSMQTTONCONNECT 0 0 URC notifies that connection operation is finished Subscribe to a topic sqn test on test Mosquitto broker previously connected with SQNSMQTTCONNECT command AT SQNSMQTTSUBSCRIBE 0 sq n test 1 OK SQNSMQTTONSUBSCRIBE 0 sq n test 0 URC notifies that subscribing operation is...
Page 55: ...nd the cloud settings 6 SMS The SMS service transfers short messages between UEs via an SMS service center The SMS service center serves as an interworking and relaying function between the UEs The supported transport layer for RYZ014 is SMS over NAS also called SMS over SG with 3GPP format 3GPP2 format is not supported with SMS over NAS It complies with 3GPP specification 27 005 There are two sup...
Page 56: ...t CP DATA RP ACK 4 optional if delivery report DL NAS Transport CP ACK This section presents how to Send and receive SMS in text mode Send and receive SMS in PDU mode Perform operations on memory storage select storage area read delete 6 1 How to Send and Receive SMS in Text Mode 6 1 1 Feature Description This section details the operations required to send and receive a short message with standar...
Page 57: ...d AT CSCA CSCA 886932400851 145 OK Configure SMS service center address in case it s not well configured Note Contact your service provider to get SMS service center address accordingly AT CSCA 0932400851 OK Send SMS to subscriber phone number 886932123456 AT CMGS 886932123456 Press Enter to get the prompt This is my test message This is prompt Write the message here CTRL Z Complete the message wi...
Page 58: ...hat is helpful to send compressed data binary data or to build a specific encoding of the characters in the binary bit stream Web applications allow to send SMS in PDU mode and others convert SMS between text and PDU modes The related AT commands are AT CMGF to set the SMS format AT CSCA to configure the SMS service center AT CMGS to send a SMS AT CMGR to read a SMS 6 2 2 Use Case 6 2 2 1 Send SMS...
Page 59: ...ll be used when sending receiving reading writing or deleting SMS messages Find the number of messages that are currently stored in the message storage area Find the maximum number of messages that can be stored in the message storage area AT CMGL lists all the SMS in memory AT CMGD is used to delete a SMS 6 3 2 Use Cases 6 3 2 1 Find the Number and the Maximum Number of Messages Command Response ...
Page 60: ...atus again AT CPMS CPMS ME 1 10 ME 1 10 ME 1 10 OK Contents of send storage area is increased so do read area and receiving area AT CPMS ME ME SM CPMS 1 10 1 10 0 20 OK Configure storage area to SIM AT CMGS 11000000151 bbbb CTRL Z Send two more messages to yourself again CMGS 4 OK CMTI SM 1 AT CPMS CPMS ME 1 10 ME 1 10 SM 1 20 OK AT CMGS 11000000151 ccccc CTRL Z CMGS 5 OK CMTI SM 2 AT CPMS CPMS ME...
Page 61: ...1000000151 18 12 29 14 22 28 32 aaaaa OK AT CMGD 1 OK AT CPMS CPMS ME 0 10 ME 0 10 ME 0 10 OK AT CPMS SM ME ME CPMS 19 20 0 10 0 10 Delete the SMS in the SIM card AT CMGF 1 OK AT CMGL all CMGL 2 REC READ Amarisoft 17 10 19 05 39 38 08 hello CMGL 20 REC READ 11000000102 18 03 30 03 14 45 16 sCommunicationsCommunicationsCommunications Delete index 2 AT CMGD 2 OK AT CPMS CPMS SM 18 20 ME 0 10 ME 0 10...
Page 62: ...use 4 SMS memory slots for its storage Thus when receiving concatenated SMS it is recommended to regularly check SMS memory usage otherwise once it is full the UE will not be able to receive any SMS text or PDU mode 7 Low Power with eDRX and PSM Please refer to the power consumption measurements application note for more details on low power mode with Monarch modules 7 1 How to Use eDRX Feature 7 ...
Page 63: ...e 2 6 4 seconds 12 8 seconds 0 1 0 1 81 92 seconds 7 68 seconds 15 36 seconds 0 1 1 0 102 4 seconds see note 2 8 96 seconds 17 92 seconds 0 1 1 1 122 88 seconds see note 2 10 24 seconds 20 48 seconds 1 0 0 0 143 36 seconds see note 2 11 52 seconds 23 04 seconds 1 0 0 1 163 84 seconds 12 8 seconds 25 6 seconds 1 0 1 0 327 68 seconds 14 08 seconds 28 16 seconds 1 0 1 1 655 36 seconds 15 36 seconds 3...
Page 64: ...e to 20 48 s requested PTW to 2 56 s AT SQNEDRX 2 4 0010 0001 OK 4 E UTRAN WB S1 mode eDRX cycle 20 48s TW 2 56 s AT SQNEDRX SQNEDRX 2 4 0010 0001 OK Get used eDRX cycle and PTW value check the enabled URC CEDRXP CEDRXP 4 0010 0010 0011 4 E UTRAN WB S1 mode Requested eDRX cycle 20 48 s Network provided eDRX cycle 20 48 s PTW 10 24 s Query current configured eDRX parameters Note The used eDRX cycle...
Page 65: ...e originating services Two timers are used to activate PSM T3324 defines the short idle window Period 2 during which the device is reachable T3412 defines the duration between two TAUs Tracking Area Updates during which the device can be dormant Period 1 Table 5 presents the mapping for the T3324 timer Bits 4 to 0 represent the binary coded timer value and bits 5 to 7 define the timer value unit f...
Page 66: ...t is only applicable to the T3312 extended value IE and the T3412 extended value IE see 3GPP TS 24 301 120 If it is received in an integrity protected message value shall be interpreted as multiples of 320 hours Otherwise value shall be interpreted as multiples of 1 hour 2 This timer value unit is not applicable to the T3412 extended value IE If this timer value is received the T3412 extended valu...
Page 67: ... and T3324 value AT CEREG 4 OK 4 For a UE that wants to apply PSM enable network registration and location information unsolicited result code CEREG AT CFUN 1 OK After successful attach or completed TAU check the URC CEREG CEREG 1 0002 01A2D004 7 00000101 00000101 7 E UTRAN Cat M1 mode Active time T3324 10 seconds Periodic TAU timer T3412 extended 180 minutes Retrieve the used value manually after...
Page 68: ... by the host MCU on all the UART configured as AT ports The estimated sleep duration is long enough RYZ014 module will not enter deep sleep mode if a timer is scheduled to pop within a few 10ths of a second 8 Informal Network Scan 8 1 Feature Description Two different AT commands can be used to get information on the serving and neighboring cells AT SQNINS This command can be used only when CFUN s...
Page 69: ... restore All the parameters regarding the UART that were modified after the restauration point was created The entire filesystem including low power settings The operator mode will be reset to standard mode scanning all the 17 bands by default Filesystem would be reset to factory state Note Device reboot is required to finalize the reset to factory state This can be triggered through AT RESET AT S...
Page 70: ...4 based modem is designed to be used as DCE Data Communication Equipment It communicates with the customer application DTE for Data Terminal Equipment based on DCE DTE convention Note Please refer to the module s datasheet for more details on UART interfaces 10 2 How to Configure the RING Signal 10 2 1 Feature Description RING is a pre defined signal which is used to notify the Host that there is ...
Page 71: ...re Modem Alarms 10 3 1 Feature Description In some cases MCU needs to set timers in the module and get an alarm when expired AT CALA and AT CALD are 3GPP standard AT commands defined in specification 27 007 The related AT commands are AT CALA AT CALD URC CALV AT CCLK 10 3 2 Use Cases 10 3 2 1 Get Current Time Date Command Response Comment The time set in the AT is absolute time A timer is usually ...
Page 72: ...et alarm timer AT CALA 00 01 30 00 1 0 second 0 1 OK Check alarm timer AT CALA CALA 19 01 01 00 01 00 0 0 first alarm 0 CALA 19 01 01 00 01 30 1 0 second 1 2 3 4 5 6 7 1 OK CALV 1 30 s later Due to silent is 1 no text is displayed here Check the date is shifted for next day tomorrow AT CALA CALA 19 01 01 00 01 00 0 0 first alarm 0 CALA 19 01 02 00 01 30 1 0 second 1 2 3 4 5 6 7 1 OK Compared with ...
Page 73: ...0 second 1 2 3 4 5 6 7 1 CALA 19 01 06 00 02 00 2 0 third alarm 2 7 0 OK Compared with above date it is now 19 01 06 10 3 2 5 Overwrite Expired Alarm with the Same Alarm ID IS Possible Command Response Comment Check current alarm config AT CALA CALA 19 01 01 00 01 00 0 0 first alarm 0 CALA 19 01 02 00 01 30 1 0 second 1 2 3 4 5 6 7 1 CALA 19 01 06 00 02 00 2 0 third alarm 2 7 0 OK Overwrite timer ...
Page 74: ...MEI information cannot be overwritten the IMEI is written on an OTP one time programmable memory 12 Appendix Glossary and Abbreviations Term Description ADC Analog to Digital Converter Airplane mode Device mode where the modem is ON but the RF functions are OFF AT Prefix for AT commands Historical prefix for Hayes commands meaning Attention DL Downlink DUP File extension used for Sequans upgrade p...
Page 75: ...nsmitter PPP Point to Point Protocol SMSC SMS Center GPIO General Purpose Input Output RRC Radio Resource Control PMU Power Management Unit LTE Long Term Evolution APN Access Point Name PDN Packet Data Network PLMN Public Land Mobile Network EARFCN E UTRA Absolute Radio Frequency Channel Number IMEI International Mobile Equipment Identity IMSI International mobile subscriber identity HLR Home Loca...
Page 76: ...0150 Rev 1 50 Page 76 of 76 Mar 15 22 Revision History Rev Date Description Page Summary 1 00 Apr 16 21 Initial release 1 50 Mar 15 22 Overall update Moved 3 Factory Reset to 9 Factory Reset Added 3 How to Manage TLS Certificates Added 4 Proprietary FOTA ...
Page 77: ...ons failure or accident arising out of the use of Renesas Electronics products outside of such specified ranges 7 Although Renesas Electronics endeavors to improve the quality and reliability of Renesas Electronics products semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions Unless designated as a hi...
