Updated Default configuration (markdown)

master
Jan Gromeš 2024-05-05 20:42:09 +02:00
rodzic f876258a61
commit be750033b4
1 zmienionych plików z 35 dodań i 12 usunięć

@ -19,6 +19,7 @@ The table below shows default values of parameters that are common accross all s
| SX1276/77/78/79 | 434.0 MHz | 4.8 kbps | 5.0 kHz | 125.0 kHz | 10 dBm | 16 bits |
| RFM95/97 | 915.0 MHz | 4.8 kbps | 5.0 kHz | 125.0 kHz | 10 dBm | 16 bits |
| RFM96/98 | 434.0 MHz | 4.8 kbps | 5.0 kHz | 125.0 kHz | 10 dBm | 16 bits |
| LR1110/20 | 434.0 MHz | 4.8 kbps | 5.0 kHz | 156.2 kHz | 10 dBm | 16 bits |
### LoRa modules
The table below shows default values of parameters that are common accross all sub-GHz LoRa modules.
@ -30,6 +31,7 @@ The table below shows default values of parameters that are common accross all s
| SX1276/77/78/79 | 434.0 MHz | 125.0 kHz | 9 | 4/7 | private network | 10 dBm | 8 symbols |
| RFM95/97 | 915.0 MHz | 125.0 kHz | 9 | 4/7 | private network | 10 dBm | 8 symbols |
| RFM96/98 | 434.0 MHz | 125.0 kHz | 9 | 4/7 | private network | 10 dBm | 8 symbols |
| LR1110/20 | 434.0 MHz | 125.0 kHz | 9 | 4/7 | private network | 10 dBm | 8 symbols |
## Modules
@ -48,7 +50,7 @@ Legend:
* Output power: 10 dBm
* Preamble length: 16 bits
* Other:
* Packet length mode: variable, maximum of CC1101_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Packet length mode: variable, maximum of RADIOLIB_CC1101_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Sync word: 0x12 0xAD, 0 error bits, carrier sense above threshold not required
* Data shaping B-T product: 0 (plain 2-FSK, no Gaussian filter applied)
* Encoding: NRZ (non-return to zero - no encoding)
@ -57,7 +59,7 @@ Legend:
Equivalent to:
```c++
CC1101::begin(434.0, 4.8, 5.0, 135.0, 10, 16);
CC1101::variablePacketLengthMode(CC1101_MAX_PACKET_LENGTH);
CC1101::variablePacketLengthMode(RADIOLIB_CC1101_MAX_PACKET_LENGTH);
CC1101::setSyncWord(0x12, 0xAD, 0, false);
CC1101::setDataShaping(RADIOLIB_SHAPING_NONE);
CC1101::setEncoding(RADIOLIB_ENCODING_NRZ);
@ -95,7 +97,7 @@ nRF24::setAutoAck(true);
* Output power: 10 dBm
* Preamble length: 16 bits
* Other:
* Packet length mode: variable, maximum of RF69_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Packet length mode: variable, maximum of RADIOLIB_RF69_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Sync word: 0x12 0xAD
* Data shaping B-T product: 0 (plain 2-FSK, no Gaussian filter applied)
* Encoding: NRZ (non-return to zero - no encoding)
@ -109,7 +111,7 @@ nRF24::setAutoAck(true);
Equivalent to (assuming RF69):
```c++
RF69::begin(434.0, 4.8, 5.0, 125.0, 10, 16);
RF69::variablePacketLengthMode(RF69_MAX_PACKET_LENGTH);
RF69::variablePacketLengthMode(RADIOLIB_RF69_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
RF69::setSyncWord(syncWord, 2);
RF69::setDataShaping(RADIOLIB_SHAPING_NONE);
@ -150,7 +152,7 @@ Si443x::setEncoding(RADIOLIB_ENCODING_NRZ);
* Bandwidth: 125.0 kHz (dual-sideband)
* Spreading factor: 9
* Coding rate: 4/7
* Sync word: SX126X_SYNC_WORD_PRIVATE (0x12)
* Sync word: RADIOLIB_SX126X_SYNC_WORD_PRIVATE (0x12)
* Output power: 10 dBm
* Preamble length: 8 symbols
* TCXO reference voltage: 1.6 V (SX126x module with TCXO)
@ -165,7 +167,7 @@ Si443x::setEncoding(RADIOLIB_ENCODING_NRZ);
Equivalent to:
```c++
SX126x::begin(434.0, 125.0, 9, 7, SX126X_SYNC_WORD_PRIVATE, 10, 8, 1.6, false);
SX126x::begin(434.0, 125.0, 9, 7, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, 10, 8, 1.6, false);
SX126x::setCurrentLimit(60.0);
SX126x::setDio2AsRfSwitch(true);
SX126x::explicitHeader();
@ -183,7 +185,7 @@ SX126x::setCRC(2);
* TCXO reference voltage: 1.6 V (SX126x module with TCXO)
* LDO regulator mode: disabled (SX126x module with DC-DC power supply)
* Other:
* Packet length mode: variable, maximum of SX126X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Packet length mode: variable, maximum of RADIOLIB_SX126X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Sync word: 0x12 0xAD
* Data shaping B-T product: 0 (plain 2-FSK, no Gaussian filter applied)
* Encoding: NRZ (non-return to zero - no encoding)
@ -194,7 +196,7 @@ SX126x::setCRC(2);
Equivalent to (assuming SX1268):
```c++
SX1268::beginFSK(434.0, 4.8, 5.0, 156.2, 10, 16, 1.6, false);
SX126x::variablePacketLengthMode(SX126X_MAX_PACKET_LENGTH);
SX126x::variablePacketLengthMode(RADIOLIB_SX126X_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
SX126x::setSyncWord(syncWord, 2);
SX126x::setDataShaping(RADIOLIB_SHAPING_NONE);
@ -222,7 +224,7 @@ SX126x::setDio2AsRfSwitch(true);
Equivalent to (assuming SX1278):
```c++
SX1278::begin(434.0, 125.0, 9, 7, SX127X_SYNC_WORD, 10, 8, 0);
SX1278::begin(434.0, 125.0, 9, 7, RADIOLIB_SX127X_SYNC_WORD, 10, 8, 0);
SX1278::setCurrentLimit(60);
SX1278::setCRC(true);
SX1278::explicitHeader();
@ -238,7 +240,7 @@ SX1278::explicitHeader();
* Output power: 10 dBm
* OOK modulation: disabled
* Other:
* Packet length mode: variable, maximum of SX127X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Packet length mode: variable, maximum of RADIOLIB_SX127X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Sync word: 0x12 0xAD
* Data shaping B-T product: 0 (plain 2-FSK, no Gaussian filter applied)
* Encoding: NRZ (non-return to zero - no encoding)
@ -254,7 +256,7 @@ SX1278::explicitHeader();
Equivalent to (assuming SX1278):
```c++
SX1278::beginFSK(434.0, 4.8, 5.0, 125.0, 10, 16, false);
SX127x::variablePacketLengthMode(SX127X_MAX_PACKET_LENGTH);
SX127x::variablePacketLengthMode(RADIOLIB_SX127X_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
SX127x::setSyncWord(syncWord, 2);
SX1278::setDataShaping(RADIOLIB_SHAPING_NONE);
@ -300,7 +302,7 @@ SX128x::setCRC(2);
* Encoding: NRZ (non-return to zero - no encoding)
* CRC: enabled, 2 bytes, initial 0x1D0F, polynomial 0x1021
* Inaccessible:
* Packet length mode: variable, maximum of SX128X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* Packet length mode: variable, maximum of RADIOLIB_SX128X_MAX_PACKET_LENGTH bytes (length byte included in packet)
* LDO regulator mode: disabled (SX128x module with DC-DC power supply)
Equivalent to:
@ -357,6 +359,27 @@ SX128x::setSyncWord(syncWord, 4);
SX128x::setEncoding(0);
```
### LR11x0 - LoRa modem
* Begin method:
* Carrier frequency: 434.0 MHz
* Bandwidth: 125.0 kHz (dual-sideband)
* Spreading factor: 9
* Coding rate: 4/7
* Sync word: RADIOLIB_LR11X0_LORA_SYNC_WORD_PRIVATE (0x12)
* Output power: 10 dBm
* Preamble length: 8 symbols
* TCXO reference voltage: 1.6 V (LR11x0 module with TCXO)
* Other:
* LoRa header mode: explicit
* LoRa CRC: enabled, 2 bytes
Equivalent to (assuming LR1110):
```c++
LR1110::begin(434.0, 125.0, 9, 7, RADIOLIB_LR11X0_LORA_SYNC_WORD_PRIVATE, 10, 8, 1.6);
LR1110::explicitHeader();
LR1110::setCRC(2);
```
## Protocols
Legend: