REYAX RYLR998 Antenna Transceiver Module User Guide
- October 30, 2023
- REYAX
Table of Contents
REYAX RYLR998 Antenna Transceiver Module
Product Information
Lora AT Command Guide
The Lora AT Command Guide applies to the RYLR998 and RYLR498 modules. It
provides a sequence of AT commands to set the ADDRESS, NETWORKED, BAND, and
other parameters for wireless communication.
The guide also includes AT commands to test the module, reset it, and set the
wireless work mode, UART baud rate, RF parameters, and RF frequency.
Product Usage Instructions
Lora AT Command Guide
-
Use the AT+ADDRESS command to set the ADDRESS of the transmitter or specified receiver. This is the identification of the module.
-
Use the AT+NETWORKID command to set the ID of the Lora network for group communication. The modules can communicate with each other only if they have the same NETWORK. If the ADDRESS of the specified receiver belongs to a different group, communication is not possible.
-
Use the AT+BAND command to set the center frequency of the wireless band for communication. The transmitter and receiver must use the same frequency to communicate with each other.
-
Use the AT+SEND command to send data to the specified ADDRESS. Use the Lora Modem Calculator Tool to calculate the transmission time. The payload part will increase by 8 bytes more than the
actual data length due to the program used by the module. -
Use the AT+MODE command to set the wireless work mode. Use AT+MODE=0 for transceiver mode and AT+MODE=1 for sleep mode. Use AT+MODE=2 for smart receiving power saving mode where you can switch between receiving mode and sleep mode to achieve power saving effect. Adjust the transmission time accordingly. Use AT+MODE? to check the current mode.
-
Use the AT+IPR command to set the UART baud rate. Use AT+IPR=9600 to set the baud rate as 9600. The settings will be memorized in Flash.
-
Use the AT+PARAMETER command to set the RF parameters. Use AT+PARAMETER=7,9,4,12 to set the parameters as SF9 at 500kHz, CR=4/5, and BW=125kHz for NETWORKID=18. Use AT+PARAMETER? to check the current parameters.
-
Use the AT+BAND command to set the RF frequency. Use AT+BAND=915000000 for 915000000Hz or leave it blank for the default value of 470000000Hz.
APPLY FOR
- RYLR998
- RYLR498
THE SEQUENCE OF USING AT COMMAND
- Use “AT+ADDRESS” to set ADDRESS. The ADDRESS is regard as the identification of transmitter or specified receiver.
- 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.
- 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.
- 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:
- < Spreading Factor>: The larger the SF is, the better the sensitivity is. But the transmission time will take longer.
- < Bandwidth>: The smaller the bandwidth is, the better the sensitivity is. But the transmission time will take longer.
- < Coding Rate>: The coding rate will be the fastest if setting it as 1.
- < 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”
- When the Payload length is greater than 100Bytes, Recommend to set AT + PARAMETER = 8,7,1,12”
- 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.
- AT Test if the module can respond to Commands.
| Syntax | Response |
|---|---|
| AT | +OK |
Software RESET
| Syntax | Response |
|---|---|
| AT+RESET | +RESET |
+READY
AT+MODE Set the wireless work mode.
| Syntax | Response |
|---|
AT+MODE=
Example : Set to sleep mode.
AT+MODE=1
2 : Smart receiving power saving mode
The switch between receiving mode and sleep 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.
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 2 seconds and then sleep mode for
two seconds to cycle until the correct signal is received.
| +OK
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
AT+IPR Set the UART baud rate.
| Syntax | Response |
|---|
- AT+IPR=
-
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
| +IPR=
AT+IPR?| +IPR=9600
AT+PARAMETER Set the RF parameters.
| Syntax | Response |
|---|
- AT+PARAMETER=
, -
, , -
-
7~11 (default 9) - *SF7to SF9 at 125kHz, SF7 to SF10 at 250kHz, and SF7 to SF11 at 500kHz
-
7~9, list as below： 7: 125 KHz (default) - 8: 250 KHz
- 9: 500 KHz
-
1~4, (default 1) -
(default 12) - When NETWORKID=18, The value can be configured to 4~24.
- Other NETWORKIDs can only be configured to 12.
- Example: Set the parameters as below,
-
7, 500KHz, 4, 15. - AT+PARAMETER=7,9,4,12
| +OK
AT+PARAMETER?| +PARAMETER=7,9,4,12
AT+BAND Set RF Frequency.
| Syntax | Response |
|---|
- AT+BAND=
-
is the RF Frequency, Unit is Hz 470000000: 470000000Hz - 915000000: 915000000Hz(default)
- Example: Set the frequency as 868500000Hz, AT+BAND=868500000
| +OK
AT+BAND?| +BAND=868500000
AT+ADDRESS Set the ADDRESS ID of module Lora.
| Syntax | Response |
|---|
- AT+ADDRESS=
- =0~65535 (default 0)
- Example: Set the address of the module as 120.
- *The settings will be memorized in Flash.
- AT+ADDRESS=120
| +OK
AT+ADDRESS?| +ADDRESS=120
AT+NETWORKID Set the network ID.
| Syntax | Response |
|---|
AT+NETWORKID=
Example: Set the network ID as 6,
*The settings will be memorized in Flash.
AT+NETWORKID=6
| +OK
AT+NETWORKID?| +NETWORK=6
AT+CPIN Set the domain password
| Syntax | Response |
|---|
- AT+CPIN=
-
An 8-character long password From 00000001 to FFFFFFFF, - Only by using the same password can the data be recognized.
- After resetting, the previously password will disappear.
- Example： Set the password to EEDCAA90
- AT+CPIN=EEDCAA90
| +OK
AT+CPIN? (default)
AT+CPIN? (After setting the password)
| +CPIN=No Password!
+CPIN=EEDCAA90
AT+CRFOP Set the RF output power.
| Syntax | Response |
|---|
- AT+CRFOP=
-
0~22 dBm 22: 22dBm(default) - 21: 21dBm
- 20: 20dBm
- ……
- 01: 1dBm
- 00: 0dBm
- Example: Set the output power as 10dBm,
- AT+CRFOP=10
| +OK
AT+CRFOP?| +CRFOP=10
AT+SEND Send data to the appointed address by Command Mode.
| Syntax | Response |
|---|
- AT+SEND=,
, - 0~65535, When the is 0, it will send data to all addresses (From 0 to 65535.)
-
Maximum 240bytes - ASCII Format
- Example: Send HELLO string to Address 50,
- AT+SEND=50,5,HELLO
| +OK
Search last transmit data, AT+SEND?| +SEND=50,5,HELLO
+RCV Show the received data actively.
| Syntax | Response |
|---|
- +RCV=,
,, , , - Transmitter Address ID
-
Data Length - ASCll Format Data
-
Received Signal Strength Indicator -
Signal-to-noise ratio
|
Example: Module received the ID Address 50 and send 5 bytes of data,
Content is HELLO string, RSSI is -99dBm, and SNR is 40, It will show as below.
+RCV=50, 5, HELLO, -99, 40
AT+UID? To inquire about module ID. 12BYTES
| Syntax | Response |
|---|---|
| AT+UID? | +UID=104737333437353600170029 |
AT+VER? To inquire about the firmware version.
| Syntax | Response |
|---|---|
| AT+VER? | +VER=RYLRxx8_Vx.x.x |
AT+FACTORY Set all current parameters to manufacturer defaults.
| Syntax | Response |
|---|
- AT+FACTORY
- Manufacturer defaults: BAND：915MHz UART：115200
- Spreading Factor：9
- Bandwidth：125kHz Coding Rate：1 Preamble
- Length：12 Address：0
- Network ID：18
- CRFOP：22
| +FACTORY
Other messages
| Narrative | Response |
|---|---|
| After RESET | +RESET |
+READY
Error result codes
| Narrative | Response |
|---|
There is not “enter” or 0x0D 0x0A in the end of the AT
Command.
| +ERR=1
The head of AT command is not “AT” string.| +ERR=2
Unknow command.| +ERR=4
The data to be sent does not match the actual length| +ERR=5
TX is over times.| +ERR=10
CRC error.| +ERR=12
TX data exceeds 240bytes.| +ERR=13
Failed to write flash memory.| +ERR=14
Unknow failure.| +ERR=15
Last TX was not completed| +ERR=17
Preamble value is not allowed.| +ERR=18
RX failed, Header error| +ERR=19
The time setting value of the “Smart receiving power saving
mode” is not allowed.
| +ERR=20
- E-mail:[email protected]
- Website: http://reyax.com
- Copyright © 2021, REYAX TECHNOLOGY CO., LTD.
Documents / Resources
|
REYAX RYLR998 Antenna Transceiver
Module
[pdf] User Guide
RYLR998, RYLR498, RYLR998 Antenna Transceiver Module, RYLR998, Antenna
Transceiver Module, Transceiver Module, Module
---|---
References
- REYAX: IoT Solution Provider｜Modules, Wireless Solution ＆ IoT Connectivity
- REYAX: IoT Solution Provider｜Modules, Wireless Solution ＆ IoT Connectivity