Skip to content

Default configuration

Jump to bottom
Jan Gromeš edited this page Jul 6, 2020 · 18 revisions

This page shows all the parameters set by default to radio modules and wireless protocols. These parameters will be set after calling module/protocol begin() method with no arguments provided. Modules/protocols without default argument values are not listed.

NOTE: Only the parameters changed by RadioLib are listed here. In addition, the module/protocol may also have other parameters, configuration of which is not implemented in RadioLib. These are not listed on this page - consult the module datasheet or protocol specification.

Legend:

  • Begin method - parameters configurable via begin() method.
  • Other - parameters which are not part of the begin() method, but can be configured using some other method from the library public API.
  • Inaccessible - parameters which can not be changed by the user.
  • Equivalent to - pseudo-code of calls to configuration methods that will result in the same configuration as the default.

Modules

CC1101

  • Begin method:
    • Carrier frequency: 434.0 MHz
    • Bit rate: 48.0 kbps
    • Frequency deviation: 48.0 kHz (single-sideband)
    • Receiver bandwidth: 125.0 kHz
    • 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)
    • 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)
  • Inaccessible: -

Equivalent to:

CC1101::begin(434.0, 48.0, 48.0, 125.0, 10, 16);
CC1101::variablePacketLengthMode(CC1101_MAX_PACKET_LENGTH);
CC1101::setSyncWord(0x12, 0xAD, 0, false);
CC1101::setDataShaping(RADIOLIB_SHAPING_NONE);
CC1101::setEncoding(RADIOLIB_ENCODING_NRZ);

nRF24

  • Begin method:
    • Carrier frequency: 2400 MHz
    • Data rate: 1000 kbps
    • Output power: -12 dBm
    • Address width: 5 bytes
  • Other:
    • CRC: enabled (16-bit CRC)
    • Auto-acknowledgement: enabled (all pipes)
  • Inaccessible:
    • Retries: 15
    • Retry delay: 1500 us
    • Dynamic payloads: enabled
    • Payload with ACK packets: disabled
    • Dynamic ACK: disabled

Equivalent to:

nRF24::begin(2400, 1000, -12, 5);
nRF24::setCrcFiltering(true);
nRF24::setAutoAck(true);

RF69/SX1231

  • Begin method:
    • Carrier frequency: 434.0 MHz
    • Bit rate: 48.0 kbps
    • Frequency deviation: 50.0 kHz (single-sideband)
    • Receiver bandwidth: 125.0 kHz
    • 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)
    • 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)
    • CRC: enabled
    • Address filtering: disabled
    • AES encryption: disabled
  • Inaccessible:
    • Over-current protection: enabled
    • Automatically clear packet on CRC mismatch: enabled

Equivalent to (assuming RF69):

RF69::begin(434.0, 48.0, 50.0, 125.0, 10, 16);
RF69::variablePacketLengthMode(RF69_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
RF69::setSyncWord(syncWord, 2);
RF69::setDataShaping(RADIOLIB_SHAPING_NONE);
RF69::setEncoding(RADIOLIB_ENCODING_NRZ);
RF69::setCrcFiltering(true);
RF69::disableAddressFiltering();
RF69::disableAES();

Si443x/RFM2x

  • Begin method:
    • Carrier frequency: 434.0 MHz
    • Bit rate: 48.0 kbps
    • Frequency deviation: 50.0 kHz (single-sideband)
    • Receiver bandwidth: 181.1 kHz
    • Output power: 10 dBm
    • Preamble length: 16 bits
  • Other:
    • 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)
  • Inaccessible:
    • Packet header: disabled
    • Broadcast address check: disabled

Equivalent to (assuming Si4432):

Si4432::begin(434.0, 48.0, 50.0, 181.1, 10, 16);
uint8_t syncWord[] = {0x12, 0xAD};
Si443x::setSyncWord(syncWord, 2);
Si443x::setDataShaping(RADIOLIB_SHAPING_NONE);
Si443x::setEncoding(RADIOLIB_ENCODING_NRZ);

SX126x - LoRa modem

  • Begin method:
    • Carrier frequency: 434.0 MHz
    • Bandwidth: 125.0 kHz (dual-sideband)
    • Spreading factor: 9
    • Coding rate: 4/7
    • Sync word: SX126X_SYNC_WORD_PRIVATE (0x12)
    • Output power: 10 dBm
    • Over-current protection: 60.0 mA
    • Preamble length: 8 symbols
    • TCXO reference voltage: 1.6 V (SX126x module with TCXO)
    • LDO regulator mode: disabled (SX126x module with DC-DC power supply)
  • Other:
    • DIO2 as RF switch control: enabled
    • LoRa header mode: explicit
    • LoRa CRC: enabled, 2 bytes
  • Inaccessible:
    • Number of CAD symbols: 8

Equivalent to:

SX126x::begin(434.0, 125.0, 9, 7, SX126X_SYNC_WORD_PRIVATE, 10, 60.0, 8, 1.6, false);
SX126x::setDio2AsRfSwitch(true);
SX126x::explicitHeader();
SX126x::setCRC(2);

SX126x - FSK modem

  • Begin method:
    • Carrier frequency: 434.0 MHz
    • Bit rate: 48.0 kbps
    • Frequency deviation: 50.0 kHz (single-sideband)
    • Receiver bandwidth: 156.2 kHz
    • Output power: 10 dBm
    • Preamble length: 16 bits
    • 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)
    • 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)
    • Over-current protection: 60.0 mA
    • DIO2 as RF switch control: enabled
  • Inaccessible: -

Equivalent to (assuming SX1268):

SX1268::beginFSK(434.0, 48.0, 156.2, 10, 16, 1.6, false);
SX126x::variablePacketLengthMode(SX126X_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
SX126x::setSyncWord(syncWord, 2);
SX126x::setDataShaping(RADIOLIB_SHAPING_NONE);
SX126x::setEncoding(RADIOLIB_ENCODING_NRZ);
SX126x::setCurrentLimit(60.0);
SX126x::setDio2AsRfSwitch(true);

SX127x/RFM9x - LoRa modem

  • Begin method:
    • Carrier frequency: 434.0 MHz (for SX1276/77/78/79 and RFM96/98) or 915.0 MHz (for SX1272/73 and RFM95/97)
    • Bandwidth: 125.0 kHz (dual-sideband)
    • Spreading factor: 9
    • Coding rate: 4/7
    • Sync word: SX127X_SYNC_WORD (0x12)
    • Output power: 17 dBm
    • Over-current protection: 100 mA
    • Preamble length: 8 symbols
    • Gain: 0 (automatic gain control enabled)
  • Other: -
  • Inaccessible:
    • LoRa header mode: explicit
    • Frequency hopping: disabled

Equivalent to (assuming SX1278):

SX1278::begin(434.0, 125.0, 9, 7, SX127X_SYNC_WORD, 17, 100, 8, 0);

SX127x/RFM9x - FSK modem

  • Begin method:
    • Carrier frequency: 434.0 MHz (for SX1276/77/78/79 and RFM96/98) or 915.0 MHz (for SX1272/73 and RFM95/97)
    • Bit rate: 48.0 kbps
    • Frequency deviation: 50.0 kHz (single-sideband)
    • Receiver bandwidth: 125.0 kHz
    • Preamble length: 16 bits
    • Output power: 10 dBm
    • OOK modulation: disabled
  • Other:
    • Packet length mode: variable, maximum of 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)
    • Over-current protection: 60 mA
    • Address filtering: disabled
    • RSSI measurement configuration: 2^(1 + 2) samples, offset 0 dBm
  • Inaccessible:
    • Automatically clear packet on CRC mismatch: enabled
    • Preamble polarity: 0x55 (start with 0)
    • Preamble detector: enabled, 2 bytes

Equivalent to (assuming SX1278):

SX1278::beginFSK(434.0, 48.0, 125.0, 10, 16, false);
SX127x::variablePacketLengthMode(SX127X_MAX_PACKET_LENGTH);
uint8_t syncWord[] = {0x12, 0xAD};
SX127x::setSyncWord(syncWord, 2);
SX1278::setDataShaping(RADIOLIB_SHAPING_NONE);
SX127x::setCurrentLimit(60);
SX127x::setEncoding(RADIOLIB_ENCODING_NRZ);
SX127x::disableAddressFiltering();
SX127x::setRSSIConfig(2, 0);

SX128x - LoRa modem

  • Begin method:
    • Carrier frequency: 2400.0 MHz
    • Bandwidth: 812.5 kHz (dual-sideband)
    • Spreading factor: 9
    • Coding rate: 4/7, long interleaving disabled
    • Output power: 10 dBm
    • Preamble length: 12 symbols
  • Other:
    • LoRa header mode: explicit
    • LoRa CRC: enabled, 2 bytes
  • Inaccessible:
    • LDO regulator mode: disabled (SX128x module with DC-DC power supply)
    • Number of CAD symbols: 8

Equivalent to:

SX128x::begin(2400.0, 812.5, 9, 7, 10, 12);
SX128x::explicitHeader();
SX128x::setCRC(2);

SX128x - GFSK modem

  • Begin method:
    • Carrier frequency: 2400.0 MHz
    • Bit rate: 800 kbps
    • Frequency deviation: 400 kHz (single-sideband)
    • Output power: 10 dBm
    • Preamble length: 16 bits
  • Other:
    • Sync word: 0x12 0xAD
    • Data shaping B-T product: 0.5 (GFSK)
    • 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)
    • LDO regulator mode: disabled (SX128x module with DC-DC power supply)

Equivalent to:

SX128x::beginGFSK(2400.0, 800, 400, 10, 16);
uint8_t syncWord[] = {0x12, 0xAD};
SX128x::setSyncWord(syncWord, 2);
SX128x::setDataShaping(RADIOLIB_SHAPING_0_5);
SX128x::setEncoding(RADIOLIB_ENCODING_NRZ);
SX128x::setCRC(2, 0x1D0F, 0x1021);

SX128x - BLE modem

  • Begin method:
    • Carrier frequency: 2400.0 MHz
    • Bit rate: 800 kbps
    • Frequency deviation: 400 kHz (single-sideband)
    • Output power: 10 dBm
    • Data shaping B-T product: 0.5 (GFSK)
  • Other:
    • CRC: enabled, 3 bytes
    • Encoding: whitening
  • Inaccessible:
    • LDO regulator mode: disabled (SX128x module with DC-DC power supply)

Equivalent to:

SX128x::beginBLE(2400.0, 800, 400, 10, 0.5);
SX128x::setCRC(3);
SX128x::setEncoding(2);

SX128x - FLRC modem

  • Begin method:
    • Carrier frequency: 2400.0 MHz
    • Bit rate: 650 kbps
    • FLRC coding rate: 3/4
    • Output power: 10 dBm
    • Preamble length: 16 bits
    • Data shaping B-T product: 0.5
  • Other:
    • CRC: enabled, 2 bytes, initial 0x1D0F, polynomial 0x1021
    • Sync word: 0x2D 0x01 0x4B 0x1D
    • Encoding: NRZ (non-return to zero - no encoding)
  • Inaccessible:
    • LDO regulator mode: disabled (SX128x module with DC-DC power supply)

Equivalent to:

SX128x::beginFLRC(2400.0, 650, 3, 10, 16, 0.5);
SX128x::setCRC(2, 0x1D0F, 0x1021);
uint8_t syncWord[] = {0x2D, 0x01, 0x4B, 0x1D};
SX128x::setSyncWord(syncWord, 4);
SX128x::setEncoding(0);

Protocols

AX.25

  • Begin method:
    • Source station callsign: no default value
    • 4-bit source station SSID: 0
    • Preamble length: 8 AX25_FLAG bytes
  • Other: -
  • Inaccessible: -

Equivalent to (assuming "N7LEM" source station callsign):

AX25Client::begin("N7LEM", 0, 8);

Hellschreiber

  • Begin method:
    • Carrier frequency: no default value
    • Baud rate: 122.5 Baud ("Feld Hell")
  • Other: -
  • Inaccessible: -

Equivalent to (assuming 434.0 MHz carrier):

HellClient::begin(434.0, 122.5);

Morse

  • Begin method:
    • Carrier frequency: no default value
    • Word rate: 20 words per minute (assuming "PARIS" as typical word)
  • Other: -
  • Inaccessible: -

Equivalent to (assuming 434.0 MHz carrier):

MorseClient::begin(434.0, 20);

RTTY

  • Begin method:
    • Base (space) frequency: no default value
    • Frequency shift between space and mark: no default value
    • Baud rate: no default value
    • Encoding: ASCII (7-bit)
    • Stop bits: 1
  • Other: -
  • Inaccessible: -

Equivalent to (assuming 434.0 MHz base, 183 Hz shift and 45 baud):

RTTYClient::begin(434.0, 183, 45, ASCII, 1);

SSTV

  • Begin method:
    • Base frequency: no default value
    • SSTV mode: no default value
    • Timing correction factor: 1.0
  • Other: -
  • Inaccessible: -

Equivalent to (assuming 434.0 MHz base and Wrasse mode):

MorseClient::begin(434.0, Wrasse, 1.0);
Clone this wiki locally