mailto:sales@reyax.comREYAX: IoT Solution Provider｜Modules, Wireless Solution ＆ IoT Connectivity
User Guide for REYAX TECHNOLOGY models including: RYLR998, RYLR498, RYLR998 Lora At Command Guide, RYLR998, Lora At Command Guide, At Command Guide, Command Guide, Guide
2 REYAX RYLR998 RYLR498 LoRa AT COMMAND GUIDE Copyright © 2021, REYAX TECHNOLOGY CO., LTD. THE SEQUENCE OF USING AT COMMAND 1. Use ⍈AT ADDRESS⍉ to set ADDRESS ...
File Info : application/pdf, 9 Pages, 488.74KB
DocumentDocument23-OCT-2023 56312E33 LoRa® AT COMMAND GUIDE APPLY FOR: 1. RYLR998 2. RYLR498 RYLR998_RYLR498 NETWORK STRUCTURE With the own LoRa® wireless transceiver function and the application program designed by customers, the RYLR998 and RYLR498 can achieve different network architectures such as "Point to Point", "Point to Multipoint" or " Multipoint to Multipoint ". The figure below shows that the modules can communicate with each other only by setting the same NETWORKID. If the ADDRESS of specified receiver belongs to different group, it is not able to communicate with each other. Copyright © 2020, REYAX TECHNOLOGY CO., LTD. 1 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE THE SEQUENCE OF USING AT COMMAND 1. Use "AT+ADDRESS" to set ADDRESS. The ADDRESS is regard as the identification of transmitter or specified receiver. 2. Use "AT+NETWORKID" to set the ID of LoRa® network. This is a Group function. Only by setting the same NETWORKID can the modules communicate with each other. If the ADDRESS of specified receiver is belong to different group, it is not able to communicate with each other. 3. Use" AT+BAND" to set the center frequency of wireless band. The transmitter and the receiver are required to use the same frequency to communicate with each other. 4. Use" AT+PARAMETER" to set the RF wireless parameters. The transmitter and the receiver are required to set the same parameters to communicate with each other. The parameters of which as follows: [1] <Spreading Factor>: The larger the SF is, the better the sensitivity is. But the transmission time will take longer. [2] <Bandwidth>: The smaller the bandwidth is, the better the sensitivity is. But the transmission time will take longer. [3] <Coding Rate>: The coding rate will be the fastest if setting it as 1. [4] <Programmed Preamble>: Preamble code. If the preamble code is bigger, it will result in the less opportunity of losing data. Generally preamble code can be set above 10 if under the permission of the transmission time. Recommend to set "AT + PARAMETER = 9,7,1,12" [5] When the Payload length is greater than 100Bytes, Recommend to set "AT + PARAMETER = 8,7,1,12" 5. Use "AT+SEND" to send data to the specified ADDRESS. Please use "LoRa® Modem Calculator Tool" to calculate the transmission time. Due to the program used by the module, the payload part will increase more 8 bytes than the actual data length. AT Command Set It is required to key in "enter" or "\r\n" in the end of all AT Commands. Add" ? "in the end of the commands to ask the current setting value. It is required to wait until the module replies +OK so that you can execute the next AT command. 1. AT Test if the module can respond to Commands. Syntax AT Response +OK 2. Software RESET Syntax AT+RESET Response +RESET +READY Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 2 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 3. AT+MODE Set the wireless work mode. Syntax AT+MODE=<Parameter>[,<RX time>,<Low speed time>] Response +OK <Parameter>range 0 to 2 0Transceiver mode (default). 1Sleep mode. Example : Set to sleep mode. AT+MODE=1 2 : Smart receiving power saving mode The switch between receiving mode and low speed mode can be used to achieve the effect of power saving, and the appropriate transmission time must be adjusted by yourself to match this mode. <RX time>=30ms~60000ms, (default 1000) <Low speed time>=30ms~60000ms, (default 1000) When the correct LoRa® data format is received, it will return to the transceiver mode. When the received data is correct, +RCV format data will be output. Example : The Smart receiving power saving mode. AT+MODE=2,3000,3000 Set to turn on receiving mode for 3 seconds and then low speed mode for 3 seconds to cycle until the correct signal is received. AT+MODE? `When MODE=0 AT+MODE? Or Any digital signal `When MODE=1 AT+MODE? Or Any digital signal `When MODE=2 +MODE=0 +MODE=0 +MODE=0 Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 3 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 4. AT+IPR Set the UART baud rate. Syntax AT+IPR=<rate> <rate> is the UART baud rate 300 1200 4800 9600 19200 28800 38400 57600 115200(default) Example: Set the baud rate as 9600, *The settings will be memorized in Flash. AT+IPR=9600 AT+IPR? Response +IPR=<rate> +IPR=9600 5. AT+BAND Set RF Frequency. Syntax Response AT+BAND=<Parameter>,<Frequency Memory> +OK <Parameter>is the RF Frequency, Unit is Hz 490000000: 490000000Hz(default: RYLY498) 915000000: 915000000Hz(default: RYLY998) <Frequency Memory> M for memory Example: Set the frequency as 868500000Hz. AT+BAND=868500000 Example: Set the frequency as 868500000Hz and be memorized in Flash.(Only support after F/W version 1.2.0) AT+BAND=868500000,M AT+BAND? +BAND=868500000 Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 4 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 6. AT+PARAMETER Set the RF parameters. Syntax AT+PARAMETER=<Spreading Factor>, <Bandwidth>,<Coding Rate>, <Programmed Preamble> Response +OK <Spreading Factor>5~11 (default 9) *SF7to SF9 at 125kHz, SF7 to SF10 at 250kHz, and SF7 to SF11 at 500kHz <Bandwidth>7~9, list as below 7: 125 KHz (default) 8: 250 KHz 9: 500 KHz <Coding Rate>1~4, (default 1) <Programmed Preamble>(default 12) When NETWORKID=18, The value can be configured to 4~24. Other NETWORKID can only be configured to 12. Example: Set the parameters as below, <Spreading Factor> 7, <Bandwidth> 500KHz, <Coding Rate> 4, <Programmed Preamble> 15. AT+PARAMETER=7,9,4,15 AT+PARAMETER? +PARAMETER=7,9,4,15 7. AT+ADDRESS Set the ADDRESS ID of module LoRa®. Syntax AT+ADDRESS=<Address> Response +OK <Address>=0~65535 (default 0) Example: Set the address of module as 120. *The settings will be memorized in Flash. AT+ADDRESS=120 AT+ADDRESS? +ADDRESS=120 Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 5 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 8. AT+NETWORKID Set the network ID. Syntax AT+NETWORKID=<Network ID> <NetworkID>=3~15,18(default18) Example: Set the network ID as 6, *The settings will be memorized in Flash. AT+NETWORKID=6 AT+NETWORKID? Response +OK +NETWORK=6 9. AT+CPIN Set the domain password Syntax AT+CPIN=<Password> <Password>An 8 character long password From 00000001 to FFFFFFFF, Only by using same password can the data be recognized. After resetting, the previously password will disappear. ExampleSet the password to EEDCAA90 AT+CPIN=EEDCAA90 AT+CPIN? (default) AT+CPIN? (After setting the password) Response +OK +CPIN=No Password! +CPIN=eedcaa90 Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 6 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 10. AT+CRFOP Set the RF output power. Syntax AT+CRFOP=<power> <power>0~22 dBm 22: 22dBm(default) 21: 21dBm 20: 20dBm ...... 01: 1dBm 00: 0dBm Example: Set the output power as 10dBm, AT+CRFOP=10 Response +OK * RF Output Power must be set to less than AT+CRFOP=14 to comply CE certification. AT+CRFOP? +CRFOP=10 11. AT+SEND Send data to the appointed address by Command Mode. Syntax Response AT+SEND=<Address>,<Payload Length>,<Data> +OK <Address>0~65535, When the <Address> is 0, it will send data to all address (From 0 to 65535.) <Payload Length> Maximum 240bytes <Data>ASCII Format Example : Send HELLO string to the Address 50, AT+SEND=50,5,HELLO Search last transmit data, +SEND=50,5,HELLO AT+SEND? Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 7 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 12. +RCV Show the received data actively. Syntax Response +RCV=<Address>,<Length>,<Data>,<RSSI>,<SNR> <Address> Transmitter Address ID <Length> Data Length <Data> ASCll Format Data <RSSI> Received Signal Strength Indicator <SNR> Signal-to-noise ratio Example: Module received the ID Address 50 send 5 bytes data, Content is HELLO string, RSSI is -99dBm, SNR is 40, It will show as below. +RCV=50, 5, HELLO, -99, 40 13. AT+UID? To inquire module ID. 12BYTES Syntax AT+UID? Response +UID=104737333437353600170029 14. AT+VER? To inquire the firmware version. Syntax AT+VER? Response +VER=RYLRxx8_Vx.x.x 15. AT+FACTORY Set all current parameters to manufacturer defaults. Syntax AT+FACTORY Manufacturer defaults: BAND915MHz UART115200 Spreading Factor9 Bandwidth125kHz Coding Rate1 Preamble Length12 Address0 Network ID18 CRFOP22 Response +FACTORY Copyright © 2021, REYAX TECHNOLOGY CO., LTD. 8 REYAX RYLR998 RYLR498 LoRa® AT COMMAND GUIDE 16. Other messages Narrative After RESET Response +RESET +READY 17. Error result codes Narrative There is not "enter" or 0x0D 0x0A in the end of the AT Command. The head of AT command is not "AT" string. Unknown command. The data to be sent does not match the actual length TX is over times. CRC error. TX data exceeds 240bytes. Failed to write flash memory. Unknown failure. Last TX was not completed Preamble value is not allowed. RX failed, Header error The time setting value of the "Smart receiving power saving mode" is not allowed. Response +ERR=1 +ERR=2 +ERR=4 +ERR=5 +ERR=10 +ERR=12 +ERR=13 +ERR=14 +ERR=15 +ERR=17 +ERR=18 +ERR=19 +ERR=20 Copyright © 2021, REYAX TECHNOLOGY CO., LTD. E-mail: sales@reyax.com Website: http://reyax.com 9