diff --git a/examples/Si443x/Si443x_Transmit/Si443x_Transmit.ino b/examples/Si443x/Si443x_Transmit/Si443x_Transmit.ino new file mode 100644 index 00000000..d33a4783 --- /dev/null +++ b/examples/Si443x/Si443x_Transmit/Si443x_Transmit.ino @@ -0,0 +1,93 @@ +/* + RadioLib Si443x Transmit Example + + This example transmits packets using Si4432 FSK radio module. + Each packet contains up to 64 bytes of data, in the form of: + - Arduino String + - null-terminated char array (C-string) + - arbitrary binary data (byte array) + + Other modules from Si443x/RFM2x family can also be used. + + For full API reference, see the GitHub Pages + https://jgromes.github.io/RadioLib/ +*/ + +// include the library +#include + +// Si4432 has the following connections: +// nSEL pin: 10 +// nIRQ pin: 2 +// SDN pin: 9 +Si4432 fsk = new Module(10, 2, 9); + +// or using RadioShield +// https://github.com/jgromes/RadioShield +//Si4432 fsk = RadioShield.ModuleA; + +void setup() { + Serial.begin(9600); + + // initialize Si4432 with default settings + Serial.print(F("[Si4432] Initializing ... ")); + // carrier frequency: 434.0 MHz + // bit rate: 48.0 kbps + // frequency deviation: 50.0 kHz + // Rx bandwidth: 125.0 kHz + // output power: 13 dBm + // sync word: 0x2D 0x01 + // OOK modulation: disabled + int state = fsk.begin(); + if (state == ERR_NONE) { + Serial.println(F("success!")); + } else { + Serial.print(F("failed, code ")); + Serial.println(state); + while (true); + } +} + +void loop() { + Serial.print(F("[Si4432] Transmitting packet ... ")); + + // you can transmit C-string or Arduino string up to + // 64 characters long + // NOTE: transmit() is a blocking method! + // See example Si443x_Transmit_Interrupt for details + // on non-blocking transmission method. + int state = fsk.transmit("Hello World!"); + + // you can also transmit byte array up to 64 bytes long + /* + byte byteArr[] = {0x01, 0x23, 0x45, 0x56, 0x78, 0xAB, 0xCD, 0xEF}; + int state = fsk.transmit(byteArr, 8); + */ + + if (state == ERR_NONE) { + // the packet was successfully transmitted + Serial.println(F(" success!")); + + // print measured data rate + Serial.print(F("[Si4432] Datarate:\t")); + Serial.print(fsk.getDataRate()); + Serial.println(F(" bps")); + + } else if (state == ERR_PACKET_TOO_LONG) { + // the supplied packet was longer than 256 bytes + Serial.println(F(" too long!")); + + } else if (state == ERR_TX_TIMEOUT) { + // timeout occured while transmitting packet + Serial.println(F(" timeout!")); + + } else { + // some other error occurred + Serial.print(F("failed, code ")); + Serial.println(state); + + } + + // wait for a second before transmitting again + delay(1000); +} diff --git a/src/modules/Si443x/Si4432.cpp b/src/modules/Si443x/Si4432.cpp new file mode 100644 index 00000000..3904fa8e --- /dev/null +++ b/src/modules/Si443x/Si4432.cpp @@ -0,0 +1,5 @@ +#include "Si4432.h" + +Si4432::Si4432(Module* mod) : Si443x(mod) { + +} diff --git a/src/modules/Si443x/Si4432.h b/src/modules/Si443x/Si4432.h new file mode 100644 index 00000000..7be5b31e --- /dev/null +++ b/src/modules/Si443x/Si4432.h @@ -0,0 +1,34 @@ +#ifndef _RADIOLIB_SI4432_H +#define _RADIOLIB_SI4432_H + +#include "../../TypeDef.h" +#include "../../Module.h" +#include "Si443x.h" + +/*! + \class Si4432 + + \brief Derived class for %Si4432 modules. +*/ +class Si4432: public Si443x { + public: + + // constructor + + /*! + \brief Default constructor. + + \param mod Instance of Module that will be used to communicate with the radio chip. + */ + Si4432(Module* mod); + +#ifndef RADIOLIB_GODMODE + protected: +#endif + +#ifndef RADIOLIB_GODMODE + private: +#endif +}; + +#endif diff --git a/src/modules/Si443x/Si443x.cpp b/src/modules/Si443x/Si443x.cpp new file mode 100644 index 00000000..7df74cb8 --- /dev/null +++ b/src/modules/Si443x/Si443x.cpp @@ -0,0 +1,5 @@ +#include "Si443x.h" + +Si443x::Si443x(Module* mod) : PhysicalLayer(SI443X_FREQUENCY_STEP_SIZE, SI443X_MAX_PACKET_LENGTH) { + _mod = mod; +} diff --git a/src/modules/Si443x/Si443x.h b/src/modules/Si443x/Si443x.h new file mode 100644 index 00000000..67698066 --- /dev/null +++ b/src/modules/Si443x/Si443x.h @@ -0,0 +1,579 @@ +#ifndef _RADIOLIB_SI443X_H +#define _RADIOLIB_SI443X_H + +#include "../../TypeDef.h" +#include "../../Module.h" + +#include "../../protocols/PhysicalLayer/PhysicalLayer.h" + +// Si443x physical layer properties +#define SI443X_FREQUENCY_STEP_SIZE 156.25 +#define SI443X_MAX_PACKET_LENGTH 64 + +// Si443x series common registers +#define SI443X_REG_DEVICE_TYPE 0x00 +#define SI443X_REG_DEVICE_VERSION 0x01 +#define SI443X_REG_DEVICE_STATUS 0x02 +#define SI443X_REG_INTERRUPT_STATUS_1 0x03 +#define SI443X_REG_INTERRUPT_STATUS_2 0x04 +#define SI443X_REG_INTERRUPT_ENABLE_1 0x05 +#define SI443X_REG_INTERRUPT_ENABLE_2 0x06 +#define SI443X_REG_OP_FUNC_CONTROL_1 0x07 +#define SI443X_REG_OP_FUNC_CONTROL_2 0x08 +#define SI443X_REG_XOSC_LOAD_CAPACITANCE 0x09 +#define SI443X_REG_MCU_OUTPUT_CLOCK 0x0A +#define SI443X_REG_GPIO0_CONFIG 0x0B +#define SI443X_REG_GPIO1_CONFIG 0x0C +#define SI443X_REG_GPIO2_CONFIG 0x0D +#define SI443X_REG_IO_PORT_CONFIG 0x0E +#define SI443X_REG_ADC_CONFIG 0x0F +#define SI443X_REG_ADC_SENSOR_AMP_OFFSET 0x10 +#define SI443X_REG_ADC_VALUE 0x11 +#define SI443X_REG_TEMP_SENSOR_CONTROL 0x12 +#define SI443X_REG_TEMP_VALUE_OFFSET 0x13 +#define SI443X_REG_WAKEUP_TIMER_PERIOD_1 0x14 +#define SI443X_REG_WAKEUP_TIMER_PERIOD_2 0x15 +#define SI443X_REG_WAKEUP_TIMER_PERIOD_3 0x16 +#define SI443X_REG_WAKEUP_TIMER_VALUE_1 0x17 +#define SI443X_REG_WAKEUP_TIMER_VALUE_2 0x18 +#define SI443X_REG_LOW_DC_MODE_DURATION 0x19 +#define SI443X_REG_LOW_BATT_DET_THRESHOLD 0x1A +#define SI443X_REG_BATT_VOLTAGE_LEVEL 0x1B +#define SI443X_REG_IF_FILTER_BANDWIDTH 0x1C +#define SI443X_REG_AFC_LOOP_GEARSHIFT_OVERRIDE 0x1D +#define SI443X_REG_AFC_TIMING_CONTROL 0x1E +#define SI443X_REG_CLOCK_REC_GEARSHIFT_OVERRIDE 0x1F +#define SI443X_REG_CLOCK_REC_OVERSAMP_RATIO 0x20 +#define SI443X_REG_CLOCK_REC_OFFSET_2 0x21 +#define SI443X_REG_CLOCK_REC_OFFSET_1 0x22 +#define SI443X_REG_CLOCK_REC_OFFSET_0 0x23 +#define SI443X_REG_CLOCK_REC_TIMING_LOOP_GAIN_1 0x24 +#define SI443X_REG_CLOCK_REC_TIMING_LOOP_GAIN_0 0x25 +#define SI443X_REG_RSSI 0x26 +#define SI443X_REG_RSSI_CLEAR_CHANNEL_THRESHOLD 0x27 +#define SI443X_REG_ANTENNA_DIVERSITY_1 0x28 +#define SI443X_REG_ANTENNA_DIVERSITY_2 0x29 +#define SI443X_REG_AFC_LIMITER 0x2A +#define SI443X_REG_AFC_CORRECTION 0x2B +#define SI443X_REG_OOK_COUNTER_1 0x2C +#define SI443X_REG_OOK_COUNTER_2 0x2D +#define SI443X_REG_SLICER_PEAK_HOLD 0x2E +#define SI443X_REG_DATA_ACCESS_CONTROL 0x30 +#define SI443X_REG_EZMAC_STATUS 0x31 +#define SI443X_REG_HEADER_CONTROL_1 0x32 +#define SI443X_REG_HEADER_CONTROL_2 0x33 +#define SI443X_REG_PREAMBLE_LENGTH 0x34 +#define SI443X_REG_PREAMBLE_DET_CONTROL 0x35 +#define SI443X_REG_SYNC_WORD_3 0x36 +#define SI443X_REG_SYNC_WORD_2 0x37 +#define SI443X_REG_SYNC_WORD_1 0x38 +#define SI443X_REG_SYNC_WORD_0 0x39 +#define SI443X_REG_TRANSMIT_HEADER_3 0x3A +#define SI443X_REG_TRANSMIT_HEADER_2 0x3B +#define SI443X_REG_TRANSMIT_HEADER_1 0x3C +#define SI443X_REG_TRANSMIT_HEADER_0 0x3D +#define SI443X_REG_TRANSMIT_PACKET_LENGTH 0x3E +#define SI443X_REG_CHECK_HEADER_3 0x3F +#define SI443X_REG_CHECK_HEADER_2 0x40 +#define SI443X_REG_CHECK_HEADER_1 0x41 +#define SI443X_REG_CHECK_HEADER_0 0x42 +#define SI443X_REG_HEADER_ENABLE_3 0x43 +#define SI443X_REG_HEADER_ENABLE_2 0x44 +#define SI443X_REG_HEADER_ENABLE_1 0x45 +#define SI443X_REG_HEADER_ENABLE_0 0x46 +#define SI443X_REG_RECEIVED_HEADER_3 0x47 +#define SI443X_REG_RECEIVED_HEADER_2 0x48 +#define SI443X_REG_RECEIVED_HEADER_1 0x49 +#define SI443X_REG_RECEIVED_HEADER_0 0x4A +#define SI443X_REG_RECEIVED_PACKET_LENGTH 0x4B +#define SI443X_REG_ADC8_CONTROL 0x4F +#define SI443X_REG_CHANNEL_FILTER_COEFF 0x60 +#define SI443X_REG_XOSC_CONTROL_TEST 0x62 +#define SI443X_REG_AGC_OVERRIDE_1 0x69 +#define SI443X_REG_TX_POWER 0x6D +#define SI443X_REG_TX_DATA_RATE_1 0x6E +#define SI443X_REG_TX_DATA_RATE_0 0x6F +#define SI443X_REG_MODULATION_MODE_CONTROL_1 0x70 +#define SI443X_REG_MODULATION_MODE_CONTROL_2 0x71 +#define SI443X_REG_FREQUENCY_DEVIATION 0x72 +#define SI443X_REG_FREQUENCY_OFFSET_1 0x73 +#define SI443X_REG_FREQUENCY_OFFSET_2 0x74 +#define SI443X_REG_FREQUENCY_BAND_SELECT 0x75 +#define SI443X_REG_NOM_CARRIER_FREQUENCY_1 0x76 +#define SI443X_REG_NOM_CARRIER_FREQUENCY_0 0x77 +#define SI443X_REG_FREQUENCY_HOPPING_CHANNEL_SEL 0x79 +#define SI443X_REG_FREQUENCY_HOPPING_STEP_SIZE 0x7A +#define SI443X_REG_TX_FIFO_CONTROL_1 0x7C +#define SI443X_REG_TX_FIFO_CONTROL_2 0x7D +#define SI443X_REG_RX_FIFO_CONTROL 0x7E +#define SI443X_REG_FIFO_ACCESS 0x7F + +// Si443x common LoRa modem settings +// SI443X_REG_DEVICE_TYPE MSB LSB DESCRIPTION +#define SI443X_DEVICE_TYPE 0x08 // 4 0 device identification register + +// SI443X_REG_DEVICE_VERSION +#define SI443X_DEVICE_VERSION 0x06 // 4 0 chip version register + +// SI443X_REG_DEVICE_STATUS +#define SI443X_RX_TX_FIFO_OVERFLOW 0b10000000 // 7 7 Rx/Tx FIFO overflow flag +#define SI443X_RX_TX_FIFO_UNDERFLOW 0b01000000 // 6 6 Rx/Tx FIFO underflow flag +#define SI443X_RX_FIFO_EMPTY 0b00100000 // 5 5 Rx FIFO empty flag +#define SI443X_HEADER_ERROR 0b00010000 // 4 4 header error flag +#define SI443X_FREQUENCY_ERROR 0b00001000 // 3 3 frequency error flag (frequency outside allowed range) +#define SI443X_TX 0b00000010 // 1 0 power state: Tx +#define SI443X_RX 0b00000001 // 1 0 Rx +#define SI443X_IDLE 0b00000000 // 1 0 idle + +// SI443X_REG_INTERRUPT_STATUS_1 +#define SI443X_FIFO_LEVEL_ERROR_INTERRUPT 0b10000000 // 7 7 Tx/Rx FIFO overflow or underflow +#define SI443X_TX_FIFO_ALMOST_FULL_INTERRUPT 0b01000000 // 6 6 Tx FIFO almost full +#define SI443X_TX_FIFO_ALMOST_EMPTY_INTERRUPT 0b00100000 // 5 5 Tx FIFO almost empty +#define SI443X_RX_FIFO_ALMOST_FULL_INTERRUPT 0b00010000 // 4 4 Rx FIFO almost full +#define SI443X_EXTERNAL_INTERRUPT 0b00001000 // 3 3 external interrupt occurred on GPIOx +#define SI443X_PACKET_SENT_INTERRUPT 0b00000100 // 2 2 packet transmission done +#define SI443X_VALID_PACKET_RECEIVED_INTERRUPT 0b00000010 // 1 1 valid packet has been received +#define SI443X_CRC_ERROR_INTERRUPT 0b00000001 // 0 0 CRC failed + +// SI443X_REG_INTERRUPT_STATUS_2 +#define SI443X_SYNC_WORD_DETECTED_INTERRUPT 0b10000000 // 7 7 sync word has been detected +#define SI443X_VALID_PREAMBLE_DETECTED_INTERRUPT 0b01000000 // 6 6 valid preamble has been detected +#define SI443X_INVALID_PREAMBLE_DETECTED_INTERRUPT 0b00100000 // 5 5 invalid preamble has been detected +#define SI443X_RSSI_INTERRUPT 0b00010000 // 4 4 RSSI exceeded programmed threshold +#define SI443X_WAKEUP_TIMER_INTERRUPT 0b00001000 // 3 3 wake-up timer expired +#define SI443X_LOW_BATTERY_INTERRUPT 0b00000100 // 2 2 low battery detected +#define SI443X_CHIP_READY_INTERRUPT 0b00000010 // 1 1 chip ready event detected +#define SI443X_POWER_ON_RESET_INTERRUPT 0b00000001 // 0 0 power-on-reset detected + +// SI443X_REG_INTERRUPT_ENABLE_1 +#define SI443X_FIFO_LEVEL_ERROR_ENABLED 0b10000000 // 7 7 Tx/Rx FIFO overflow or underflow interrupt enabled +#define SI443X_TX_FIFO_ALMOST_FULL_ENABLED 0b01000000 // 6 6 Tx FIFO almost full interrupt enabled +#define SI443X_TX_FIFO_ALMOST_EMPTY_ENABLED 0b00100000 // 5 5 Tx FIFO almost empty interrupt enabled +#define SI443X_RX_FIFO_ALMOST_FULL_ENABLED 0b00010000 // 4 4 Rx FIFO almost full interrupt enabled +#define SI443X_EXTERNAL_ENABLED 0b00001000 // 3 3 external interrupt interrupt enabled +#define SI443X_PACKET_SENT_ENABLED 0b00000100 // 2 2 packet transmission done interrupt enabled +#define SI443X_VALID_PACKET_RECEIVED_ENABLED 0b00000010 // 1 1 valid packet received interrupt enabled +#define SI443X_CRC_ERROR_ENABLED 0b00000001 // 0 0 CRC failed interrupt enabled + +// SI443X_REG_INTERRUPT_STATUS_2 +#define SI443X_SYNC_WORD_DETECTED_ENABLED 0b10000000 // 7 7 sync word interrupt enabled +#define SI443X_VALID_PREAMBLE_DETECTED_ENABLED 0b01000000 // 6 6 valid preamble interrupt enabled +#define SI443X_INVALID_PREAMBLE_DETECTED_ENABLED 0b00100000 // 5 5 invalid preamble interrupt enabled +#define SI443X_RSSI_ENABLED 0b00010000 // 4 4 RSSI exceeded programmed threshold interrupt enabled +#define SI443X_WAKEUP_TIMER_ENABLED 0b00001000 // 3 3 wake-up timer interrupt enabled +#define SI443X_LOW_BATTERY_ENABLED 0b00000100 // 2 2 low battery interrupt enabled +#define SI443X_CHIP_READY_ENABLED 0b00000010 // 1 1 chip ready event interrupt enabled +#define SI443X_POWER_ON_RESET_ENABLED 0b00000001 // 0 0 power-on-reset interrupt enabled + +// SI443X_REG_OP_FUNC_CONTROL_1 +#define SI443X_SOFTWARE_RESET 0b10000000 // 7 7 reset all registers to default values +#define SI443X_ENABLE_LOW_BATTERY_DETECT 0b01000000 // 6 6 enable low battery detection +#define SI443X_ENABLE_WAKEUP_TIMER 0b00100000 // 5 5 enable wakeup timer +#define SI443X_32_KHZ_RC 0b00000000 // 4 4 32.768 kHz source: RC oscillator (default) +#define SI443X_32_KHZ_XOSC 0b00010000 // 4 4 crystal oscillator +#define SI443X_TX_ON 0b00001000 // 3 3 Tx on in manual transmit mode +#define SI443X_RX_ON 0b00000100 // 2 2 Rx on in manual receive mode +#define SI443X_PLL_ON 0b00000010 // 1 1 PLL on (tune mode) +#define SI443X_XTAL_ON 0b00000001 // 1 1 crystal oscillator on (ready mode) + +// SI443X_REG_OP_FUNC_CONTROL_2 +#define SI443X_ANT_DIV_TR_HL_IDLE_L 0b00000000 // 7 5 GPIO1/2 states: Tx/Rx GPIO1 H, GPIO2 L; idle low (default) +#define SI443X_ANT_DIV_TR_LH_IDLE_L 0b00100000 // 7 5 Tx/Rx GPIO1 L, GPIO2 H; idle low +#define SI443X_ANT_DIV_TR_HL_IDLE_H 0b01000000 // 7 5 Tx/Rx GPIO1 H, GPIO2 L; idle high +#define SI443X_ANT_DIV_TR_LH_IDLE_H 0b01100000 // 7 5 Tx/Rx GPIO1 L, GPIO2 H; idle high +#define SI443X_ANT_DIV_TR_ALG_IDLE_L 0b10000000 // 7 5 Tx/Rx diversity algorithm; idle low +#define SI443X_ANT_DIV_TR_ALG_IDLE_H 0b10100000 // 7 5 Tx/Rx diversity algorithm; idle high +#define SI443X_ANT_DIV_TR_ALG_BEACON_IDLE_L 0b11000000 // 7 5 Tx/Rx diversity algorithm (beacon); idle low +#define SI443X_ANT_DIV_TR_ALG_BEACON_IDLE_H 0b11100000 // 7 5 Tx/Rx diversity algorithm (beacon); idle high +#define SI443X_RX_MULTIPACKET_OFF 0b00000000 // 4 4 Rx multipacket: disabled (default) +#define SI443X_RX_MULTIPACKET_ON 0b00010000 // 4 4 enabled +#define SI443X_AUTO_TX_OFF 0b00000000 // 3 3 Tx autotransmit on FIFO almost full: disabled (default) +#define SI443X_AUTO_TX_ON 0b00001000 // 3 3 enabled +#define SI443X_LOW_DUTY_CYCLE_OFF 0b00000000 // 2 2 low duty cycle mode: disabled (default) +#define SI443X_LOW_DUTY_CYCLE_ON 0b00000100 // 2 2 enabled +#define SI443X_RX_FIFO_RESET 0b00000010 // 1 1 Rx FIFO reset/clear: reset (call first) +#define SI443X_RX_FIFO_CLEAR 0b00000000 // 1 1 clear (call second) +#define SI443X_TX_FIFO_RESET 0b00000001 // 0 0 Tx FIFO reset/clear: reset (call first) +#define SI443X_TX_FIFO_CLEAR 0b00000000 // 0 0 clear (call second) + +// SI443X_REG_XOSC_LOAD_CAPACITANCE +#define SI443X_XTAL_SHIFT 0b00000000 // 7 7 crystal capacitance configuration: +#define SI443X_XTAL_LOAD_CAPACITANCE 0b01111111 // 6 0 C_int = 1.8 pF + 0.085 pF * SI443X_XTAL_LOAD_CAPACITANCE + 3.7 pF * SI443X_XTAL_SHIFT + +// SI443X_REG_MCU_OUTPUT_CLOCK +#define SI443X_CLOCK_TAIL_CYCLES_OFF 0b00000000 // 5 4 additional clock cycles: none (default) +#define SI443X_CLOCK_TAIL_CYCLES_128 0b00010000 // 5 4 128 +#define SI443X_CLOCK_TAIL_CYCLES_256 0b00100000 // 5 4 256 +#define SI443X_CLOCK_TAIL_CYCLES_512 0b00110000 // 5 4 512 +#define SI443X_LOW_FREQ_CLOCK_OFF 0b00000000 // 3 3 32.768 kHz clock output: disabled (default) +#define SI443X_LOW_FREQ_CLOCK_ON 0b00001000 // 3 3 enabled +#define SI443X_MCU_CLOCK_30_MHZ 0b00000000 // 2 0 GPIO clock output: 30 MHz +#define SI443X_MCU_CLOCK_15_MHZ 0b00000001 // 2 0 15 MHz +#define SI443X_MCU_CLOCK_10_MHZ 0b00000010 // 2 0 10 MHz +#define SI443X_MCU_CLOCK_4_MHZ 0b00000011 // 2 0 4 MHz +#define SI443X_MCU_CLOCK_3_MHZ 0b00000100 // 2 0 3 MHz +#define SI443X_MCU_CLOCK_2_MHZ 0b00000101 // 2 0 2 MHz +#define SI443X_MCU_CLOCK_1_MHZ 0b00000110 // 2 0 1 MHz (default) +#define SI443X_MCU_CLOCK_32_KHZ 0b00000111 // 2 0 32.768 kHz + +// SI443X_REG_GPIO0_CONFIG + SI443X_REG_GPIO1_CONFIG + SI443X_REG_GPIO2_CONFIG +#define SI443X_GPIOX_DRIVE_STRENGTH 0b00000000 // 7 6 GPIOx drive strength (higher number = stronger drive) +#define SI443X_GPIOX_PULLUP_OFF 0b00000000 // 5 5 GPIOx internal 200k pullup: disabled (default) +#define SI443X_GPIOX_PULLUP_ON 0b00100000 // 5 5 enabled +#define SI443X_GPIO0_POWER_ON_RESET_OUT 0b00000000 // 4 0 GPIOx function: power-on-reset output (GPIO0 only, default) +#define SI443X_GPIO1_POWER_ON_RESET_INV_OUT 0b00000000 // 4 0 inverted power-on-reset output (GPIO1 only, default) +#define SI443X_GPIO2_MCU_CLOCK_OUT 0b00000000 // 4 0 MCU clock output (GPIO2 only, default) +#define SI443X_GPIOX_WAKEUP_OUT 0b00000001 // 4 0 wakeup timer expired output +#define SI443X_GPIOX_LOW_BATTERY_OUT 0b00000010 // 4 0 low battery detect output +#define SI443X_GPIOX_DIGITAL_OUT 0b00000011 // 4 0 direct digital output +#define SI443X_GPIOX_EXT_INT_FALLING_IN 0b00000100 // 4 0 external interrupt, falling edge +#define SI443X_GPIOX_EXT_INT_RISING_IN 0b00000101 // 4 0 external interrupt, rising edge +#define SI443X_GPIOX_EXT_INT_CHANGE_IN 0b00000110 // 4 0 external interrupt, state change +#define SI443X_GPIOX_ADC_IN 0b00000111 // 4 0 ADC analog input +#define SI443X_GPIOX_ANALOG_TEST_N_IN 0b00001000 // 4 0 analog test N input +#define SI443X_GPIOX_ANALOG_TEST_P_IN 0b00001001 // 4 0 analog test P input +#define SI443X_GPIOX_DIGITAL_IN 0b00001010 // 4 0 direct digital input +#define SI443X_GPIOX_DIGITAL_TEST_OUT 0b00001011 // 4 0 digital test output +#define SI443X_GPIOX_ANALOG_TEST_N_OUT 0b00001100 // 4 0 analog test N output +#define SI443X_GPIOX_ANALOG_TEST_P_OUT 0b00001101 // 4 0 analog test P output +#define SI443X_GPIOX_REFERENCE_VOLTAGE_OUT 0b00001110 // 4 0 reference voltage output +#define SI443X_GPIOX_TX_RX_DATA_CLK_OUT 0b00001111 // 4 0 Tx/Rx clock output in direct mode +#define SI443X_GPIOX_TX_DATA_IN 0b00010000 // 4 0 Tx data input direct mode +#define SI443X_GPIOX_EXT_RETRANSMIT_REQUEST_IN 0b00010001 // 4 0 external retransmission request input +#define SI443X_GPIOX_TX_STATE_OUT 0b00010010 // 4 0 Tx state output +#define SI443X_GPIOX_TX_FIFO_ALMOST_FULL_OUT 0b00010011 // 4 0 Tx FIFO almost full output +#define SI443X_GPIOX_RX_DATA_OUT 0b00010100 // 4 0 Rx data output +#define SI443X_GPIOX_RX_STATE_OUT 0b00010101 // 4 0 Rx state output +#define SI443X_GPIOX_RX_FIFO_ALMOST_FULL_OUT 0b00010110 // 4 0 Rx FIFO almost full output +#define SI443X_GPIOX_ANT_DIV_1_OUT 0b00010111 // 4 0 antenna diversity output 1 +#define SI443X_GPIOX_ANT_DIV_2_OUT 0b00011000 // 4 0 antenna diversity output 2 +#define SI443X_GPIOX_VALID_PREAMBLE_OUT 0b00011001 // 4 0 valid preamble detected output +#define SI443X_GPIOX_INVALID_PREAMBLE_OUT 0b00011010 // 4 0 invalid preamble detected output +#define SI443X_GPIOX_SYNC_WORD_DETECTED_OUT 0b00011011 // 4 0 sync word detected output +#define SI443X_GPIOX_CLEAR_CHANNEL_OUT 0b00011100 // 4 0 clear channel assessment output +#define SI443X_GPIOX_VDD 0b00011101 // 4 0 VDD +#define SI443X_GPIOX_GND 0b00011110 // 4 0 GND + +// SI443X_REG_IO_PORT_CONFIG +#define SI443X_GPIO2_EXT_INT_STATE_MASK 0b01000000 // 6 6 external interrupt state mask for: GPIO2 +#define SI443X_GPIO1_EXT_INT_STATE_MASK 0b00100000 // 5 5 GPIO1 +#define SI443X_GPIO0_EXT_INT_STATE_MASK 0b00010000 // 4 4 GPIO0 +#define SI443X_IRQ_BY_SDO_OFF 0b00000000 // 3 3 output IRQ state on SDO pin: disabled (default) +#define SI443X_IRQ_BY_SDO_ON 0b00001000 // 3 3 enabled +#define SI443X_GPIO2_DIGITAL_STATE_MASK 0b00000100 // 2 2 digital state mask for: GPIO2 +#define SI443X_GPIO1_DIGITAL_STATE_MASK 0b00000010 // 1 1 GPIO1 +#define SI443X_GPIO0_DIGITAL_STATE_MASK 0b00000001 // 0 0 GPIO0 + +// SI443X_REG_ADC_CONFIG +#define SI443X_ADC_START 0b10000000 // 7 7 ADC control: start measurement +#define SI443X_ADC_RUNNING 0b00000000 // 7 7 measurement in progress +#define SI443X_ADC_DONE 0b10000000 // 7 7 done +#define SI443X_ADC_SOURCE_TEMPERATURE 0b00000000 // 6 4 ADC source: internal temperature sensor (default) +#define SI443X_ADC_SOURCE_GPIO0_SINGLE 0b00010000 // 6 4 single-ended on GPIO0 +#define SI443X_ADC_SOURCE_GPIO1_SINGLE 0b00100000 // 6 4 single-ended on GPIO1 +#define SI443X_ADC_SOURCE_GPIO2_SINGLE 0b00110000 // 6 4 single-ended on GPIO2 +#define SI443X_ADC_SOURCE_GPIO01_DIFF 0b01000000 // 6 4 differential on GPIO0 (+) and GPIO1 (-) +#define SI443X_ADC_SOURCE_GPIO12_DIFF 0b01010000 // 6 4 differential on GPIO1 (+) and GPIO2 (-) +#define SI443X_ADC_SOURCE_GPIO02_DIFF 0b01100000 // 6 4 differential on GPIO0 (+) and GPIO2 (-) +#define SI443X_ADC_SOURCE_GND 0b01110000 // 6 4 GND +#define SI443X_ADC_REFERNCE_BAND_GAP 0b00000000 // 3 2 ADC reference: internal bandgap 1.2 V (default) +#define SI443X_ADC_REFERNCE_VDD_3 0b00001000 // 3 2 VDD/3 +#define SI443X_ADC_REFERNCE_VDD_2 0b00001100 // 3 2 VDD/2 +#define SI443X_ADC_GAIN 0b00000000 // 1 0 ADC amplifier gain + +// SI443X_REG_ADC_SENSOR_AMP_OFFSET +#define SI443X_ADC_OFFSET 0b00000000 // 3 0 ADC offset + +// SI443X_REG_TEMP_SENSOR_CONTROL +#define SI443X_TEMP_SENSOR_RANGE_64_TO_64_C 0b00000000 // 7 6 temperature sensor range: -64 to 64 deg. C, 0.5 deg. C resolution (default) +#define SI443X_TEMP_SENSOR_RANGE_64_TO_192_C 0b01000000 // 7 6 -64 to 192 deg. C, 1.0 deg. C resolution +#define SI443X_TEMP_SENSOR_RANGE_0_TO_128_C 0b11000000 // 7 6 0 to 128 deg. C, 0.5 deg. C resolution +#define SI443X_TEMP_SENSOR_RANGE_40_TO_216_F 0b10000000 // 7 6 -40 to 216 deg. F, 1.0 deg. F resolution +#define SI443X_TEMP_SENSOR_KELVIN_TO_CELSIUS_OFF 0b00000000 // 5 5 Kelvin to Celsius offset: disabled +#define SI443X_TEMP_SENSOR_KELVIN_TO_CELSIUS_ON 0b00100000 // 5 5 enabled (default) +#define SI443X_TEMP_SENSOR_TRIM_OFF 0b00000000 // 4 4 temperature sensor trim: disabled (default) +#define SI443X_TEMP_SENSOR_TRIM_ON 0b00010000 // 4 4 enabled +#define SI443X_TEMP_SENSOR_TRIM_VALUE 0b00000000 // 3 0 temperature sensor trim value + +// SI443X_REG_WAKEUP_TIMER_PERIOD_1 +#define SI443X_WAKEUP_TIMER_EXPONENT 0b00000011 // 4 0 wakeup timer value exponent + +// SI443X_REG_WAKEUP_TIMER_PERIOD_2 + SI443X_REG_WAKEUP_TIMER_PERIOD_3 +#define SI443X_WAKEUP_TIMER_MANTISSA_MSB 0x00 // 7 0 wakeup timer value: +#define SI443X_WAKEUP_TIMER_MANTISSA_LSB 0x01 // 7 0 T = (4 * SI443X_WAKEUP_TIMER_MANTISSA * 2 ^ SI443X_WAKEUP_TIMER_EXPONENT) / 32.768 ms + +// SI443X_REG_LOW_DC_MODE_DURATION +#define SI443X_LOW_DC_MODE_DURATION_MANTISSA 0x01 // 7 0 low duty cycle mode duration: T = (4 * SI443X_LOW_DC_MODE_DURATION_MANTISSA * 2 ^ SI443X_WAKEUP_TIMER_EXPONENT) / 32.768 ms + +// SI443X_REG_LOW_BATT_DET_THRESHOLD +#define SI443X_LOW_BATT_DET_THRESHOLD 0b00010100 // 4 0 low battery detection threshold: Vth = 1.7 + SI443X_LOW_BATT_DET_THRESHOLD * 0.05 V (defaults to 2.7 V) + +// SI443X_REG_IF_FILTER_BANDWIDTH +#define SI443X_BYPASS_DEC_BY_3_OFF 0b00000000 // 7 7 bypass decimate-by-3 stage: disabled (default) +#define SI443X_BYPASS_DEC_BY_3_ON 0b10000000 // 7 7 enabled +#define SI443X_IF_FILTER_DEC_RATE 0b00000000 // 6 4 IF filter decimation rate +#define SI443X_IF_FILTER_COEFF_SET 0b00000001 // 3 0 IF filter coefficient set selection + +// SI443X_REG_AFC_LOOP_GEARSHIFT_OVERRIDE +#define SI443X_AFC_WIDEBAND_OFF 0b00000000 // 7 7 AFC wideband: disabled (default) +#define SI443X_AFC_WIDEBAND_ON 0b10000000 // 7 7 enabled +#define SI443X_AFC_OFF 0b00000000 // 6 6 AFC: disabled +#define SI443X_AFC_ON 0b01000000 // 6 6 enabled (default) +#define SI443X_AFC_HIGH_GEAR_SETTING 0b00000000 // 5 3 AFC high gear setting +#define SI443X_SECOND_PHASE_BIAS_0_DB 0b00000100 // 2 2 second phase antenna selection bias: 0 dB (default) +#define SI443X_SECOND_PHASE_BIAS_1_5_DB 0b00000000 // 2 2 1.5 dB +#define SI443X_MOVING_AVERAGE_TAP_8 0b00000010 // 1 1 moving average filter tap length: 8*Tb +#define SI443X_MOVING_AVERAGE_TAP_4 0b00000000 // 1 1 4*Tb after first preamble (default) +#define SI443X_ZERO_PHASE_RESET_5 0b00000000 // 0 0 reset preamble detector after: 5 zero phases (default) +#define SI443X_ZERO_PHASE_RESET_2 0b00000001 // 0 0 3 zero phases + +// SI443X_REG_AFC_TIMING_CONTROL +#define SI443X_SW_ANT_TIMER 0b00000000 // 7 6 number of periods to wait for RSSI to stabilize during antenna switching +#define SI443X_SHORT_WAIT 0b00001000 // 5 3 period to wait after AFC correction +#define SI443X_ANTENNA_SWITCH_WAIT 0b00000010 // 2 0 antenna switching wait time + +// SI443X_REG_CLOCK_REC_GEARSHIFT_OVERRIDE +#define SI443X_CLOCK_RECOVER_FAST_GEARSHIFT 0b00000000 // 5 3 clock recovery fast gearshift value +#define SI443X_CLOCK_RECOVER_SLOW_GEARSHIFT 0b00000011 // 2 0 clock recovery slow gearshift value + +// SI443X_REG_CLOCK_REC_OVERSAMP_RATIO +#define SI443X_CLOCK_REC_OVERSAMP_RATIO_LSB 0b01100100 // 7 0 oversampling rate LSB, defaults to 12.5 clock cycles per bit + +// SI443X_REG_CLOCK_REC_OFFSET_2 +#define SI443X_CLOCK_REC_OVERSAMP_RATIO_MSB 0b00000000 // 7 5 oversampling rate MSB, defaults to 12.5 clock cycles per bit +#define SI443X_SECOND_PHASE_SKIP_THRESHOLD 0b00000000 // 4 4 skip seconds phase antenna diversity threshold +#define SI443X_NCO_OFFSET_MSB 0b00000001 // 3 0 NCO offset MSB + +// SI443X_REG_CLOCK_REC_OFFSET_1 +#define SI443X_NCO_OFFSET_MID 0b01000111 // 7 0 NCO offset MID + +// SI443X_REG_CLOCK_REC_OFFSET_0 +#define SI443X_NCO_OFFSET_LSB 0b10101110 // 7 0 NCO offset LSB + +// SI443X_REG_CLOCK_REC_TIMING_LOOP_GAIN_1 +#define SI443X_RX_COMPENSATION_OFF 0b00000000 // 4 4 Rx compensation for high data rate: disabled (default) +#define SI443X_RX_COMPENSATION_ON 0b00010000 // 4 4 enabled +#define SI443X_CLOCK_REC_GAIN_DOUBLE_OFF 0b00000000 // 3 3 clock recovery gain doubling: disabled (default) +#define SI443X_CLOCK_REC_GAIN_DOUBLE_ON 0b00001000 // 3 3 enabled +#define SI443X_CLOCK_REC_LOOP_GAIN_MSB 0b00000010 // 2 0 clock recovery timing loop gain MSB + +// SI443X_REG_CLOCK_REC_TIMING_LOOP_GAIN_0 +#define SI443X_CLOCK_REC_LOOP_GAIN_LSB 0b10001111 // 7 0 clock recovery timing loop gain LSB + +// SI443X_REG_RSSI_CLEAR_CHANNEL_THRESHOLD +#define SI443X_RSSI_CLEAR_CHANNEL_THRESHOLD 0b00011110 // 7 0 RSSI clear channel interrupt threshold + +// SI443X_REG_AFC_LIMITER +#define SI443X_AFC_LIMITER 0x00 // 7 0 AFC limiter value + +// SI443X_REG_OOK_COUNTER_1 +#define SI443X_OOK_FREEZE_OFF 0b00000000 // 5 5 OOK moving average detector freeze: disabled (default) +#define SI443X_OOK_FREEZE_ON 0b00100000 // 5 5 enabled +#define SI443X_PEAK_DETECTOR_OFF 0b00000000 // 4 4 peak detector: disabled +#define SI443X_PEAK_DETECTOR_ON 0b00010000 // 4 4 enabled (default) +#define SI443X_OOK_MOVING_AVERAGE_OFF 0b00000000 // 3 3 OOK moving average: disabled +#define SI443X_OOK_MOVING_AVERAGE_ON 0b00001000 // 3 3 enabled (default) +#define SI443X_OOK_COUNTER_MSB 0b00000000 // 2 0 OOK counter MSB + +// SI443X_REG_OOK_COUNTER_2 +#define SI443X_OOK_COUNTER_LSB 0b10111100 // 7 0 OOK counter LSB + +// SI443X_REG_SLICER_PEAK_HOLD +#define SI443X_PEAK_DETECTOR_ATTACK 0b00010000 // 6 4 OOK peak detector attach time +#define SI443X_PEAK_DETECTOR_DECAY 0b00001100 // 3 0 OOK peak detector decay time + +// SI443X_REG_DATA_ACCESS_CONTROL +#define SI443X_PACKET_RX_HANDLING_OFF 0b00000000 // 7 7 packet Rx handling: disabled +#define SI443X_PACKET_RX_HANDLING_ON 0b10000000 // 7 7 enabled (default) +#define SI443X_LSB_FIRST_OFF 0b00000000 // 6 6 LSB first transmission: disabled (default) +#define SI443X_LSB_FIRST_ON 0b01000000 // 6 6 enabled +#define SI443X_CRC_DATA_ONLY_OFF 0b00000000 // 5 5 CRC calculated only from data fields: disabled (default) +#define SI443X_CRC_DATA_ONLY_ON 0b00100000 // 5 5 enabled +#define SI443X_SKIP_SECOND_PHASE_PREAMBLE_DET_OFF 0b00000000 // 4 4 skip second phase of preamble detection: disabled (default) +#define SI443X_SKIP_SECOND_PHASE_PREAMBLE_DET_ON 0b00010000 // 4 4 enabled +#define SI443X_PACKET_TX_HANDLING_OFF 0b00000000 // 3 3 packet Tx handling: disabled +#define SI443X_PACKET_TX_HANDLING_ON 0b00001000 // 3 3 enabled (default) +#define SI443X_CRC_OFF 0b00000000 // 2 2 CRC: disabled +#define SI443X_CRC_ON 0b00000100 // 2 2 enabled (default) +#define SI443X_CRC_CCITT 0b00000000 // 1 0 CRC type: CCITT +#define SI443X_CRC_IBM_CRC16 0b00000001 // 1 0 IBM CRC-16 (default) +#define SI443X_CRC_IEC16 0b00000010 // 1 0 IEC-16 +#define SI443X_CRC_BIACHEVA 0b00000011 // 1 0 Biacheva + +// SI443X_REG_EZMAC_STATUS +#define SI443X_CRC_ALL_ONE 0b01000000 // 6 6 last received CRC was all ones +#define SI443X_PACKET_SEARCHING 0b00100000 // 5 5 radio is searching for a valid packet +#define SI443X_PACKET_RECEIVING 0b00010000 // 4 4 radio is currently receiving packet +#define SI443X_VALID_PACKET_RECEIVED 0b00001000 // 3 3 valid packet was received +#define SI443X_CRC_ERROR 0b00000100 // 2 2 CRC check failed +#define SI443X_PACKET_TRANSMITTING 0b00000010 // 1 1 radio is currently transmitting packet +#define SI443X_PACKET_SENT 0b00000001 // 0 0 packet sent + +// SI443X_REG_HEADER_CONTROL_1 +#define SI443X_BROADCAST_ADDR_CHECK_NONE 0b00000000 // 7 4 broadcast address check: none (default) +#define SI443X_BROADCAST_ADDR_CHECK_BYTE0 0b00010000 // 7 4 on byte 0 +#define SI443X_BROADCAST_ADDR_CHECK_BYTE1 0b00100000 // 7 4 on byte 1 +#define SI443X_BROADCAST_ADDR_CHECK_BYTE2 0b01000000 // 7 4 on byte 2 +#define SI443X_BROADCAST_ADDR_CHECK_BYTE3 0b10000000 // 7 4 on byte 3 +#define SI443X_RECEIVED_HEADER_CHECK_NONE 0b00000000 // 3 0 received header check: none +#define SI443X_RECEIVED_HEADER_CHECK_BYTE0 0b00010000 // 3 0 on byte 0 +#define SI443X_RECEIVED_HEADER_CHECK_BYTE1 0b00100000 // 3 0 on byte 1 +#define SI443X_RECEIVED_HEADER_CHECK_BYTE2 0b01000000 // 3 0 on byte 2 (default) +#define SI443X_RECEIVED_HEADER_CHECK_BYTE3 0b10000000 // 3 0 on byte 3 (default) + +// SI443X_REG_HEADER_CONTROL_2 +#define SI443X_SYNC_WORD_TIMEOUT_OFF 0b00000000 // 7 7 ignore timeout period when searching for sync word: disabled (default) +#define SI443X_SYNC_WORD_TIMEOUT_ON 0b10000000 // 7 7 enabled +#define SI443X_HEADER_LENGTH_HEADER_NONE 0b00000000 // 6 4 header length: none +#define SI443X_HEADER_LENGTH_HEADER_3 0b00010000 // 6 4 header 3 +#define SI443X_HEADER_LENGTH_HEADER_32 0b00100000 // 6 4 header 3 and 2 +#define SI443X_HEADER_LENGTH_HEADER_321 0b00110000 // 6 4 header 3, 2 and 1 (default) +#define SI443X_HEADER_LENGTH_HEADER_3210 0b01000000 // 6 4 header 3, 2, 1, and 0 +#define SI443X_FIXED_PACKET_LENGTH_OFF 0b00000000 // 3 3 fixed packet length mode: disabled (default) +#define SI443X_FIXED_PACKET_LENGTH_ON 0b00001000 // 3 3 enabled +#define SI443X_SYNC_LENGTH_SYNC_3 0b00000000 // 2 1 sync word length: sync 3 +#define SI443X_SYNC_LENGTH_SYNC_32 0b00000010 // 2 1 sync 3 and 2 (default) +#define SI443X_SYNC_LENGTH_SYNC_321 0b00000100 // 2 1 sync 3, 2 and 1 +#define SI443X_SYNC_LENGTH_SYNC_3210 0b00000110 // 2 1 sync 3, 2, 1 and 0 +#define SI443X_PREAMBLE_LENGTH_MSB 0b00000000 // 0 0 preamble length MSB + +// SI443X_REG_PREAMBLE_LENGTH +#define SI443X_PREAMBLE_LENGTH_LSB 0b00001000 // 0 0 preamble length LSB, defaults to 32 bits + +// SI443X_REG_PREAMBLE_DET_CONTROL +#define SI443X_PREAMBLE_DET_THRESHOLD 0b00101000 // 7 3 number of 4-bit nibbles in valid preamble, defaults to 20 bits +#define SI443X_RSSI_OFFSET 0b00000010 // 2 0 RSSI calculation offset, defaults to +8 dB + +// SI443X_REG_SYNC_WORD_3 - SI443X_REG_SYNC_WORD_0 +#define SI443X_SYNC_WORD_3 0x2D // 7 0 sync word: 4th byte (MSB) +#define SI443X_SYNC_WORD_2 0xD4 // 7 0 3rd byte +#define SI443X_SYNC_WORD_1 0x00 // 7 0 2nd byte +#define SI443X_SYNC_WORD_0 0x00 // 7 0 1st byte (LSB) + +// SI443X_REG_CHANNEL_FILTER_COEFF +#define SI443X_INVALID_PREAMBLE_THRESHOLD 0b00000000 // 7 4 invalid preamble threshold in nibbles + +// SI443X_REG_XOSC_CONTROL_TEST +#define SI443X_STATE_LOW_POWER 0b00000000 // 7 5 chip power state: low power +#define SI443X_STATE_READY 0b00100000 // 7 5 ready +#define SI443X_STATE_TUNE 0b01100000 // 7 5 tune +#define SI443X_STATE_TX 0b01000000 // 7 5 Tx +#define SI443X_STATE_RX 0b11100000 // 7 5 Rx + +// SI443X_REG_AGC_OVERRIDE_1 +#define SI443X_AGC_GAIN_INCREASE_OFF 0b00000000 // 6 6 AGC gain increase override: disabled (default) +#define SI443X_AGC_GAIN_INCREASE_ON 0b01000000 // 6 6 enabled +#define SI443X_AGC_OFF 0b00000000 // 5 5 AGC loop: disabled +#define SI443X_AGC_ON 0b00100000 // 5 5 enabled (default) +#define SI443X_LNA_GAIN_MIN 0b00000000 // 4 4 LNA gain select: 5 dB (default) +#define SI443X_LNA_GAIN_MAX 0b00010000 // 4 4 25 dB +#define SI443X_PGA_GAIN_OVERRIDE 0b00000000 // 3 0 PGA gain override, gain = SI443X_PGA_GAIN_OVERRIDE * 3 dB + +// SI443X_REG_TX_POWER +#define SI443X_LNA_SWITCH_OFF 0b00000000 // 3 3 LNA switch control: disabled +#define SI443X_LNA_SWITCH_ON 0b00001000 // 3 3 enabled (default) +#define SI443X_OUTPUT_POWER 0b00000000 // 2 0 output power in 3 dB steps, 0 is chip min, 7 is chip max + +// SI443X_REG_TX_DATA_RATE_1 + SI443X_REG_TX_DATA_RATE_0 +#define SI443X_DATA_RATE_MSB 0x0A // 7 0 data rate: DR = 10^6 * (SI443X_DATA_RATE / 2^16) in high data rate mode or +#define SI443X_DATA_RATE_LSB 0x3D // 7 0 DR = 10^6 * (SI443X_DATA_RATE / 2^21) in low data rate mode (defaults to 40 kbps) + +// SI443X_REG_MODULATION_MODE_CONTROL_1 +#define SI443X_HIGH_DATA_RATE_MODE 0b00000000 // 5 5 data rate: above 30 kbps (default) +#define SI443X_LOW_DATA_RATE_MODE 0b00100000 // 5 5 below 30 kbps +#define SI443X_PACKET_HANDLER_POWER_DOWN_OFF 0b00000000 // 4 4 power off packet handler in low power mode: disabled (default) +#define SI443X_PACKET_HANDLER_POWER_DOWN_ON 0b00010000 // 4 4 enabled +#define SI443X_MANCHESTER_PREAMBLE_POL_LOW 0b00000000 // 3 3 preamble polarity in Manchester mode: low +#define SI443X_MANCHESTER_PREAMBLE_POL_HIGH 0b00001000 // 3 3 high (default) +#define SI443X_MANCHESTER_INVERTED_OFF 0b00000000 // 2 2 inverted Manchester encoding: disabled +#define SI443X_MANCHESTER_INVERTED_ON 0b00000100 // 2 2 enabled (default) +#define SI443X_MANCHESTER_OFF 0b00000000 // 1 1 Manchester encoding: disabled (default) +#define SI443X_MANCHESTER_ON 0b00000010 // 1 1 enabled +#define SI443X_WHITENING_OFF 0b00000000 // 0 0 data whitening: disabled (default) +#define SI443X_WHITENING_ON 0b00000001 // 0 0 enabled + +// SI443X_REG_MODULATION_MODE_CONTROL_2 +#define SI443X_TX_DATA_CLOCK_NONE 0b00000000 // 7 6 Tx data clock: disabled (default) +#define SI443X_TX_DATA_CLOCK_GPIO 0b01000000 // 7 6 GPIO pin +#define SI443X_TX_DATA_CLOCK_SDI 0b10000000 // 7 6 SDI pin +#define SI443X_TX_DATA_CLOCK_NIRQ 0b11000000 // 7 6 nIRQ pin +#define SI443X_TX_DATA_SOURCE_GPIO 0b00000000 // 5 4 Tx data source in direct mode: GPIO pin (default) +#define SI443X_TX_DATA_SOURCE_SDI 0b00010000 // 5 4 SDI pin +#define SI443X_TX_DATA_SOURCE_FIFO 0b00100000 // 5 4 FIFO +#define SI443X_TX_DATA_SOURCE_PN9 0b00110000 // 5 4 PN9 internal +#define SI443X_TX_RX_INVERTED_OFF 0b00000000 // 3 3 Tx/Rx data inverted: disabled (default) +#define SI443X_TX_RX_INVERTED_ON 0b00001000 // 3 3 enabled +#define SI443X_FREQUENCY_DEVIATION_MSB 0b00000000 // 2 2 frequency deviation MSB +#define SI443X_MODULATION_NONE 0b00000000 // 1 0 modulation type: unmodulated carrier (default) +#define SI443X_MODULATION_OOK 0b00000001 // 1 0 OOK +#define SI443X_MODULATION_FSK 0b00000010 // 1 0 FSK +#define SI443X_MODULATION_GFSK 0b00000011 // 1 0 GFSK + +// SI443X_REG_FREQUENCY_DEVIATION +#define SI443X_FREQUENCY_DEVIATION_LSB 0b00100000 // 7 0 frequency deviation LSB, Fd = 625 Hz * SI443X_FREQUENCY_DEVIATION, defaults to 20 kHz + +// SI443X_REG_FREQUENCY_OFFSET_1 + SI443X_REG_FREQUENCY_OFFSET_2 +#define SI443X_FREQUENCY_OFFSET_MSB 0x00 // 7 0 frequency offset: +#define SI443X_FREQUENCY_OFFSET_LSB 0x00 // 1 0 Foff = 156.25 Hz * (SI443X_BAND_SELECT + 1) * SI443X_FREQUENCY_OFFSET, defaults to 156.25 Hz + +// SI443X_REG_FREQUENCY_BAND_SELECT +#define SI443X_SIDE_BAND_SELECT_LOW 0b00000000 // 6 6 Rx LO tuning: below channel frequency (default) +#define SI443X_SIDE_BAND_SELECT_HIGH 0b01000000 // 6 6 above channel frequency +#define SI443X_BAND_SELECT_LOW 0b00000000 // 5 5 band select: low, 240 - 479.9 MHz +#define SI443X_BAND_SELECT_HIGH 0b00100000 // 5 5 high, 480 - 960 MHz (default) +#define SI443X_FREQUENCY_BAND_SELECT 0b00010101 // 4 0 frequency band select + +// SI443X_REG_NOM_CARRIER_FREQUENCY_1 + SI443X_REG_NOM_CARRIER_FREQUENCY_0 +#define SI443X_NOM_CARRIER_FREQUENCY_MSB 0b10111011 // 7 0 nominal carrier frequency: +#define SI443X_NOM_CARRIER_FREQUENCY_LSB 0b10000000 // 7 0 Fc = (SI443X_BAND_SELECT + 1)*10*(SI443X_FREQUENCY_BAND_SELECT + 24) + (SI443X_NOM_CARRIER_FREQUENCY - SI443X_FREQUENCY_OFFSET)/6400 [MHz] + +// SI443X_REG_FREQUENCY_HOPPING_CHANNEL_SEL +#define SI443X_FREQUENCY_HOPPING_CHANNEL 0x00 // 7 0 frequency hopping channel number + +// SI443X_REG_FREQUENCY_HOPPING_STEP_SIZE +#define SI443X_FREQUENCY_HOPPING_STEP_SIZE 0x00 // 7 0 frequency hopping step size + +// SI443X_REG_TX_FIFO_CONTROL_1 +#define SI443X_TX_FIFO_ALMOST_FULL_THRESHOLD 0x37 // 5 0 Tx FIFO almost full threshold + +// SI443X_REG_TX_FIFO_CONTROL_2 +#define SI443X_TX_FIFO_ALMOST_EMPTY_THRESHOLD 0x04 // 5 0 Tx FIFO almost full threshold + +// SI443X_REG_RX_FIFO_CONTROL +#define SI443X_RX_FIFO_ALMOST_FULL_THRESHOLD 0x37 // 5 0 Rx FIFO almost full threshold + +/*! + \class Si443x + + \brief Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from this base class. + This class should not be instantiated directly from Arduino sketch, only from its derived classes. +*/ +class Si443x: public PhysicalLayer { + public: + // introduce PhysicalLayer overloads + using PhysicalLayer::transmit; + using PhysicalLayer::receive; + using PhysicalLayer::startTransmit; + using PhysicalLayer::readData; + + // constructor + + /*! + \brief Default constructor. + + \param mod Instance of Module that will be used to communicate with the radio. + */ + Si443x(Module* mod); + +#ifndef RADIOLIB_GODMODE + protected: +#endif + Module* _mod; + +#ifndef RADIOLIB_GODMODE + private: +#endif + +}; + +#endif