eWBM LoRa AT Command, Manual

Page 1: ...LoRa AT Command Manual LoRa AT Command Manual Powered by MS500 ...

Page 2: ...tributes 7 5 AT Command Usage Scenario 8 5 1 Initial Join request to Network Server Over the Air Activation OTAA 8 5 2 Data transfer during server connection Upload download 9 5 3 Entering Sleep Mode and Waking up from Sleep Mode 11 6 Activation Command 12 6 1 Command Table 12 6 2 Command Detail 12 AT DEVEUI 12 AT APPEUI 13 AT APPKEY 13 AT PNM 14 AT NJM 14 AT CLASS 16 AT JOIN 17 AT NJS 17 AT AJOIN...

Page 3: ...SSI 23 AT SNR 24 8 LoRaMAC Configure Command 25 8 1 Command Table 25 8 2 Command Detail 25 AT REGION 25 AT ADR 26 AT DR 27 AT RX2FQ 28 AT RX2DR 28 AT RX1DL 29 AT RX2DL 29 AT JN1DL 30 AT JN2DL 30 AT MUFR 31 AT MCFR 31 AT TXP 32 AT FCU 33 AT FCD 33 AT BAT 34 AT LCHK 34 AT CRYPTO 35 AT CH 35 9 System Command 37 9 1 Command Table 37 9 2 Command Detail 37 AT RESET 37 AT SINF 38 ...

Page 4: ...021 4 49 AT VER 38 AT SAG 39 AT CFM 39 AT SLEEP 40 AT ALARM 40 AT TIME 41 AT DATE 42 AT ECHO 42 AT FRESET 43 10 Debug Command 44 10 1 Command Table 44 10 2 Command Detail 44 AT DBG 44 AT TXCW 45 AT RXTT 45 AT TXTT 46 AT TSTP 46 AT GPIO 47 Document Revision and Reference 48 ...

Page 5: ...SEMTECH SX1276 radio transceiver supporting LoRa Receiver Sensitivity up to 136 dBm Frequency Range 920 923 MHz Korea 923 Japan Asia 863 870 MHz EU 902 928 MHz North America 865 867 MHz India Up to 14 dBm Output Power LoRa Alliance Certified UART Communication Interface AT Command set support for LoRaWAN LoRaWAN Certified KR920 923 Korea AS923 Japan Asia EU863 870 Europe US902 928 US Canada ...

Page 6: ...TUP Port Setup Information Baud Rate 115200 Data 8 bit Parity None Stop 1 bit Flow Control None 4 COMMAND FORMAT 4 1 FORMATTING RULES FOR CHARACTER STRING COMMAND 1 Command Line terminates either in CR or LF 2 Command Parameter is defined by a Blank Character 3 Command Parameter is separated by the symbol as described below CR LR OK or an error string CR LR ...

Page 7: ...ed to execute Failed Error Character String Error Character String Command failed to execute Command Not Found Command is Not Found 4 3 COMMAND ATTRIBUTES All Commands have one or more of the following attributes Syntax Command R Command to read out data and or to monitor system status W Command to Write and or to control system status F Command to store configuration in Flash memory Reset the mod...

Page 8: ...e AT JOIN command to join the server The connection status can be checked in the resulting Log file It can also be confirmed by running AT NJS command AT DEVEUI 0000000000000001 OK AT APPEUI 70b3d57ed0010e4f OK AT APPKEY de52ddd16146079649c89a0c1bd9eae5 OK AT JOIN Send JOIN_REQ Port 0 Size 0 Adr 1 AdrAckReq 0 Ack 0 Cnt 0 00 00 19 925 TxConfig ch922500000 pwr 14 bw 0 sf7 OK 00 00 20 001 TxDone 00 0...

Page 9: ... completed an Attempt to auto Join as shown below Send JOIN_REQ Port 0 Size 0 Adr 1 AdrAckReq 0 Ack 0 Cnt 0 00 07 34 585 TxConfig ch 922500000 pwr 14 bw 0 sf7 00 07 34 660 TxDone AT A00 07 39 644 RxConfig ch 922500000 bw 0 sf7 Rx1 JOIN_ACCEPT size 33 rssi 88 snr 26 Rx1DrOffset 0 RxDelay1 1000 Rx2Dr 0 EVENT JOINED Join is completed AT SENDB 2 1100ff Send the 3 Byte Hexadecimal 11 00 ff data to Port...

Page 10: ...NCONFIRMED_UP Port 2 Size 5 Adr 1 AdrAckReq 0 Ack 0 Cnt 1 00 18 36 373 TxConfig ch 923100000 pwr 14 bw 0 sf12 OK 00 18 37 705 TxDone 00 18 38 720 RxConfig ch 923100000 bw 0 sf12 00 18 39 732 RxConfig ch 921900000 bw 0 sf12 Rx2 UNCONFIRMED_DOWN size 16 rssi 91 snr 29 Adr 0 AdrAckReq 0 Ack 0 Cnt 0 EVENT RECVB 1 aabbff Received the 3 Byte Hexadecimal data aa bb ff from server to Port 1 AT RECVB To co...

Page 11: ...mode 2 Wake up by setting the RTC Alarm AT SLEEP Command to Enter Sleep Mode EVENT SLEEP Message indicating Entering Sleep Mode is completed Wakeup by RESETN Message indicating the Wake up by RESET OTAA KR920 Wakeup completed Message indicating Wake up is completed AT ALARM 5 Set to Wake up 5 second after entering Sleep Mode OK AT SLEEP Command to Enter Sleep Mode EVENT SLEEP Entering Sleep Mode i...

Page 12: ...er Connection Status 6 2 8 AT AJOIN Execute auto JOIN after the booting 6 2 9 AT NWKSKY Network Session Key 6 2 10 AT APPSKEY Application Session Key 6 2 11 AT DADDR Device Address 4byte 6 2 12 AT NWKID Returns Network ID 4 Byte 6 2 13 AT AINF Returns Activation setting value 6 2 14 6 2 COMMAND DETAIL AT DEVEUI End device identifier in IEEE EUI64 address space Provided by the Module Manufacturer 1...

Page 13: ...in secure storage in Flash memory Format AT APPEUI AppEUI ENTER Example AT APPEUI 70b3d57ed0010e4f OK AT APPKEY To read out the Application key AppKey The AppKey is an AES 128 root key specific to the end device Provided by the Lora Network Supplier 32 hex digit 16 Byte input and output Table 4 AT APPKEY Syntax Operation Remark AT APPKEY R Example AT APPKEY de52ddd16146079649c89a0c1bd9eae5 OK WF U...

Page 14: ...ork Mode with the specified value Format AT PNM 0 1 ENTER Example AT PNM 0 OK Note 0 Public Network OFF 1 Public Network ON Default AT NJM Command for Network Join Mode Setting Reboot after the setting is updated and stored Table 6 AT NJM Syntax Operation Remark AT NJM R Return with current setting value of Network Join Mode Example AT NJM 1 OK WF Update Network Join Mode Setting with the specifie...

Page 15: ...Activation Command eWBM LoRa AT Command Manual for Consumer Products Rev 0 6 02 2021 15 49 Note 0 ABP 1 OTAA Default 2 P2P ...

Page 16: ...ion Remark AT CLASS R Return with current setting value of LoRa MAC Class Example AT CLASS A OK WF Update the LoRa MAC CLASS with the specified value Format AT CLASS LoRa MAC Class ENTER Example AT CLASS C OK Note LoRa MAC Class A Default B or C Application Layer MAC Layer Class A Baseline Class B Beacon Class C Continuous PHY Layer RF Layer EU AS KR US LoRa Protocol Stack ...

Page 17: ...JOINED CR LF 03 00 02 556 EVENT JOINED AT NJS Command to check Join Status Table 9 AT NJS Syntax Operation Remark AT NJS R Format AT NJS ENTER Example AT NJS 1 OK Note 0 Network not joined 1 Network joined AT AJOIN Command to set Automatic Join Request when device is booted Table 10 AT AJOIN Syntax Operation Remark AT AJOIN R Return with current setting value of Automatic Join Request when the dev...

Page 18: ...SKEY 74b3ee804428aaca16f319ab5d615f0b OK WF Update Network Session Key 16 Byte with the specified value ABP only Format AT NWKSKEY Network Session Key ENTER Example AT NWKSKEY 74b3ee804428aaca16f319ab5d615f0b OK AT APPSKEY Application Session Key 16byte Returns 32 hex digit 16 Byte Table 12 AT APPSKEY Syntax Operation Remark AT APPSKEY R Readout the current setting value of Application Session Key...

Page 19: ...9 AT DADDR 260521e9 OK AT NWKID Network ID 4byte display value 8 hex digit 4byte display e g MSB 0x00 0x12 0x34 0x56 WF Mode 6 hex digit 3Byte input e g MSB 0x12 0x34 0x56 Table 14 AT DADDR Syntax Operation Remark AT NWKID R Readout current value of Network ID 4 Byte Example e g MSB 0x00 0x12 0x34 0x56 AT NWKID 00123456 OK WF Update Network ID with the specified value 3 Byte ABP Only Format AT DAD...

Page 20: ...nd Name setting value Table 15 AT AINF Syntax Operation Remark AT AINF R Format AT AINF ENTER Example AT AINF DEVEUI 0000000000000002 APPEUI 70b3d57ed0010e4f APPKEY de52ddd16146079649c89a0c1bd9eae5 PNM Public NJM OTAA CLASS A NJS Joined0 NetID 00123456 DADDR 260521e9 NWKSKEY 74b3ee804428aaca16f319ab5d615f0b APPSKEY 5e337a1a75a4f87911cb718631a162ff AJOIN Auto OK ...

Page 21: ...VB Confirm Received Downlink Data data type in hexadecimal 7 2 4 AT RSSI Returns RSSI value of the last received data 7 2 5 AT SNR Returns SNR value from the last received data 7 2 6 7 2 COMMAND DETAIL AT SEND LoRa Data Uplink Command Send Data Type text data Table 17 AT SEND Syntax Operation Remark AT SEND W Uplink command of LoRa Data Data transfer type text Format AT SEND application port data ...

Page 22: ...a ENTER Example Send 5 Byte hexadecimal 0x0a 0x0b 0x0c 0x0d 0x0e to Port 2 AT SENDB 2 0a0b0c0d0e OK Note When the data is sent successfully OK message returns If failed AT_ERROR message returns AT RECV Readout Received Downlink Data Received Data Type text data Table 19 AT RECV Syntax Operation Remark AT RECV R Readout received downlink data Data type text Format AT RECV application port data ENTE...

Page 23: ...d0e OK Once received data is read out the data is removed Thus the following subsequent readout command returns no data as shown below AT RECV 2 OK E An EVENT Message is printed out when Payload data is received Example EVENT space RECVB space port number colon Hex data CR LF EVENT RECVB 99 000102030405060708090a0b0c0d0e0f Note Execute the AT RECVB command to confirm that the received data type is...

Page 24: ...l for Consumer Products Rev 0 6 02 2021 24 49 AT SNR Readout SNR signal noise ratio value of the last received data Table 22 AT SNR Syntax Operation Remark AT SNR R Readout SNR value of the last received data Format AT SNR ENTER Example AT SNR 26 OK ...

Page 25: ... Join Accept Delay 8 2 9 AT MUFR Unconfirmed uplink Resend 8 2 10 AT MCFR Confirmed uplink resend 8 2 11 AT TXP Tx Power index 8 2 12 AT FCU Uplink Counter 8 2 13 AT FCD Downlink Counter 8 2 14 AT BAT Battery Level 8 2 15 AT LCHK Mac Command LinkCheckReq 8 2 16 AT CRYPTO Encryption Configuration Standard 8 2 17 AT CH Channel Configuration 8 2 18 8 2 COMMAND DETAIL AT REGION Returns LoRaMAC Region ...

Page 26: ...r Region it becomes effective only after a device reboot Example Update the Region set to KR920 AT REGION 6 Boot by CPU OTAA KR920 Boot completed F W VERSION 0 15 DEVICE EUI 50f8a50000010099 AT ADR Auto Data Rate ADR Configuration Table 25 AT ADR Syntax Operation Remark AT ADR R Readout current set value of ADR Configuration Example AT ADR 1 OK WF Set ADR Configuration Format AT ADR 0 1 ENTER Exam...

Page 27: ...ion Remark AT DR R Returns with a current data rate Example AT DR 0 OK WF Update data rate with a specified number Format AT DR data rate ENTER Example AT DR 5 OK Note Data Rate Configuration 0 SF12 BW125 KR920 AS923 EU868 1 SF11 BW125 KR920 AS923 EU868 2 SF10 BW125 KR920 AS923 EU868 3 SF9 BW125 KR920 AS923 EU868 4 SF8 BW125 KR920 AS923 EU868 5 SF7 BW125 KR920 AS923 EU868 6 SF7 BW250 AS923 EU868 7...

Page 28: ...Q 921900000 OK W Update the frequency of RX Window 2 with a specified number Format AT RX2FQ Rx Window 2 ENTER Example AT RX2FQ 921900000 OK AT RX2DR Rx Window 2 data rate 0 7 corresponding to DR_X Command Table 28 AT RX2DR Syntax Operation Remark AT RX2DR R Readout current value of Rx Window 2 data rate Example AT RX2DR 0 OK W Update Rx Window 2 data rate with a specified number Format AT RX2FQ 0...

Page 29: ...y between the end of the TX and the Rx Window 2 in ms Table 30 AT RX2DL Syntax Operation Remark AT RX2DL R Readout the delay between the end of the TX and the RX Window2 in ms Example AT RX2DL 2000 OK WF Set the delay between the end of the Tx and the Rx Window 2 in ms Reset using the default setting Format 1 AT RX2DL delay ENTER Example 1 AT RX2DL 2000 메모 포함 오5 6 11 19 무슨 뜻인요 혹 Reset Stored value...

Page 30: ...indow 1 in ms Example AT JN1DL 5000 OK W Set the Join Accept Delay between the end of the Tx and the Join Rx Window 1 in ms Format AT JN1DL delay ENTER Example AT JN1DL 5000 OK AT JN2DL Set the Join Accept delay between the end of the TX and the Join Rx Window 2 in ms Table 32 AT JN2DL Syntax Operation Remark AT JN2DL R Readout the Join Accept Delay between the end of the Tx and the Join Rx Window...

Page 31: ...the value of repetition for unconfirmed uplink with the specified value Format AT MUFR number ENTER Example AT MUFR 15 OK Note number number of repetition 1 15 default 1 max 15 AT MCFR Resend command for confirmed uplink The send command repeats until an acknowledgement from the server is arrived The default number of repetitions sets to 8 Table 34 AT MCFR Syntax Operation Remark AT MCFR R Readout...

Page 32: ...EIRP 14 Max EIRP 16 Max EIRP 18 Max EIRP 20 CN470 Max EIRP Max EIRP 2 Max EIRP 4 Max EIRP 6 Max EIRP 8 Max EIRP 10 Max EIRP 14 Max EIRP 14 CN779 Max EIRP Max EIRP 2 Max EIRP 4 Max EIRP 6 Max EIRP 8 Max EIRP 10 EU433 Max EIRP Max EIRP 2 Max EIRP 4 Max EIRP 6 Max EIRP 8 Max EIRP 10 EU868 Max EIRP Max EIRP 2 Max EIRP 4 Max EIRP 6 Max EIRP 8 Max EIRP 10 Max EIRP 14 Max EIRP 14 IN865 Max EIRP Max EIRP ...

Page 33: ...35 OK W Set the Uplink Counter For Testing Purpose Format AT FCU number ENTER Example AT FCU 65535 OK Note number uplink counter 0 65535 AT FCD Downlink Counter Command Table 37 AT FCD Syntax Operation Remark AT FCD R Readout the current downlink counter value Example AT FCD 65535 OK W Set Downlink Counter with the specified value For Testing Purpose Format AT FCD number ENTER Example AT FCD 65535...

Page 34: ...T Battery level ENTER Example AT BAT 254 OK Updated battery level value is sent to server as part of DevStatusAns Note Battery level 0 USB 1 Min level 254 Fully charged 255 Error AT LCHK Line Check Command The command is used to check that the link is working properly Table 39 AT LCHK Syntax Operation Remark AT LCHK W The Mac command LinkCheckReq is sent to the server Format AT LCHK ENTER Example ...

Page 35: ...requested in OTAA mode the AES is used instead of ARIA The ARIA gets used only in Uplink Downlink data encryption AT CH Readout the current Configuration then update the Channel Table 41 AT CH Syntax Operation Remark AT CH R Readout the current Channel Configuration Format AT CH freq drrange status ch ENTER Example Display Configuration for all Channel AT CH 0 freq 922100000 drrange 0 to 5 status ...

Page 36: ...status 1 OK Example Readout CH1 Frequency AT CH 1 freq 922300000 OK Example Readout CH1 DR Range AT CH 1 drrange 0 to 5 OK Example Readout CH1 Status Availability 1 used 0 unused AT CH 1 status 1 OK WF Change Channel Properties and store at Memory Example Change CH7 Frequency AT CH 7 freq 922300000 OK Example Change DR Range Min and Max of CH1 AT CH 7 drrange 1 4 OK Example Configure to activate C...

Page 37: ...8 AT DATE RTC Date 9 2 9 AT ECHO AT Command Responding Message ECHO 9 2 10 AT FRESET Command to reset the configuration 9 2 11 9 2 COMMAND DETAIL AT RESET System Reset command Table 43 AT RESET Syntax Operation Remark AT RESET W System Reset Command Format AT RESET ENTER Example After Reset Booting Message prints out AT RESET Boot by CPU OTAA KR920 Boot completed AT RESET channels ENTER Example De...

Page 38: ...ation Remark AT SINF R Example AT SINF VER 0 01 REGION KR920 DATE 2000 01 01 TIME 05 49 54 275 ECHO On SAG 0 000000 dBi ADR Enabled DR 0 SF12 BW125 MCFR 8 Confirmed Uplink retry count MUFR 1 Unconfirmed Uplink retry count CFM Unconfirmed Uplink Message Type ALARM 0 seconds OK AT VER Firmware Version Information Table 45 AT SAG Syntax Operation Remark AT VER R Readout firmware version Example AT VE...

Page 39: ...wer is configured to transmit a packet set it as small as Antenna Gain Format AT SAG gain ENTER Example AT SAG 1 1 000000 OK Note default Value 0 dBm gain Integer Input Value between 4 and 6 dBm is allowed AT CFM Readout and set command for Uplink Packet Type Table 47 AT CFM Syntax Operation Remark AT CFM R Readout uplink packet type Example AT CFM 1 OK WF Set the Uplink Packet Type Format AT CFM ...

Page 40: ...TC Wakeup time Default is set to 0 sec Table 49 AT WAKEUPTIME Syntax Operation Remark AT ALARM R Readout the current set value of RTC wakeup time Example AT ALARM 5 OK W Set the RTC wakeup time with a specified number Format AT ALARM ver ENTER Example 1 AT ALARM 5 OK Example 2 Wake up by alarm after entering the Sleep Mode AT SLEEP EVENT SLEEP Wakeup by RTC OTAA KR920 Wakeup completed Note 1 Defau...

Page 41: ...E RTC Time Command Table 50 AT TIME Syntax Operation Remark AT TIME R Displays the RTC time Example AT TIME 15 43 09 630 OK W Set the RTC time Format Hour 2 digit Min 2 digit Sec 2 digit ms 3 digit Example AT TIME 15 42 30 OK Note Use the same input format as shown in the displayed output time ...

Page 42: ... date year 4 digit monthe 2 digit date 2 digit Example AT DATE 2018 3 15 OK Note Use the same input format as shown in the displayed output date AT ECHO Echo command Table 52 AT ECHO Syntax Operation Remark AT ECHO R Readout the configured value of the Echo Command The default is 0 i e OFF Example AT ECHO 0 OK WF Set the Echo command with the specified value Format AT ECHO 0 1 ENTER Example AT ECH...

Page 43: ... Products Rev 0 6 02 2021 43 49 AT FRESET Except for Device EUI reset the configuration Table 53 AT ECHO Syntax Operation Remark AT FRESET W Execute Reset Command Example AT FRESET Factory reset Boot by CPU OTAA KR920 Boot completed 메모 포함 병전24 AT FRESET 추가 ...

Page 44: ...ode Tx Signal Strength Test 10 2 2 AT RXTT LoRa Rx Signal Strength Test 10 2 3 AT TXTT LoRa Tx Signal Strength Test 10 2 4 AT TSTP Stop RF Test 10 2 5 AT GPIO MS500 GPIO Pin Information 10 2 6 10 2 COMMAND DETAIL AT DBG Readout the Debug Message Type Table 55 AT DBG Syntax Operation Remark AT DBG R Readout the current Debug Message configuration AT DBG 0 OK W Set the Debug Message with the specifi...

Page 45: ...556 EVENT TXCW timeout AT RXTT LoRa Rx RF Strength Test Table 57 AT RXTT Syntax Operation Remark AT RXTT W Format AT RXST Spreading Factor Data rate ENTER Example Frequency 922500000 SF 7 for Rx mode until the data is received AT RXTT 922500000 7 0 OK E 1 Rx Receive Data Print format timestamp space EVENT space RXST space Data Size space RSSI value space SNR value CR LF EVENT RxDone size 23 rssi 6...

Page 46: ...n frequency sec ENTER Example Frequency 922500000 14dBm SF7 Bandwidth 125kHz 100Byte Data is transmitted in 5 sec period AT TXTT 922500000 14 7 0 100 5 OK E 57 Tx transmission is successful Print format timestamp space EVENT space TXST transmitted CR LF EVENT TxDone 2 Tx Transmission Timeout Transmission failure Print format timestamp space EVENT space TXST timeout CR LF EVENT TxTimeout AT TSTP RF...

Page 47: ...ation Pin Name is case insensitive AT GPIO PC6 Pull Down GPIO Out 1 OK W Format AT GPIO Pin Input Output ENTER Example 1 PC6 Pin Input Configuration Use either I or i AT GPIO PC6 i OK Example 2 Confirm the configuration value of PC6 pin AT GPIO PC6 Pull Down GPIO In 0 OK Example 3 Set the PC6 Pin Output Configuration Use either O or o AT GPIO PC6 o 1 OK Example 4 Confirm the configuration value of...

Page 48: ... 2019 01 10 eWBM Add AT Command Usage Scenario 0 1 2019 02 28 eWBM Enhanced tables and added figures 0 3 2019 04 26 eWBM Add P2P API Library 0 4 2019 06 07 eWBM Added LoRaMac Channel Configuration Function and updated the document 0 5 2019 07 31 eWBM Added Factory reset command network join mode and reboot for the update in region configuration 0 6 2021 02 15 eWBM Delete P2P function 메모 포함 병전26 0 ...

Page 49: ... means electronic mechanical manual optical or otherwise without prior written permission of eWBM Co Ltd NO WARRANTY NOTICE eWBM Co Ltd makes no warranty of any kind in regard to this material which is delivered to you as is including but not limited to the implied warranties as to its accuracy or fitness for a specific purpose Any use of this technical documentation or the information contained t...