Skip to content

Commit

Permalink
Correct spelling in files (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdeweerd authored Dec 17, 2023
1 parent eb82258 commit 3e67dcd
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ The RSSI Threshold for signal detection is automatically determined based on the

For background see section 2.1.3.2. of SX127X Data sheet

To tune the SX127X OOK RSSI FIXED Threshold two values are used to determine if the threhold needs to be increased or decreased. The first is the noise recevied between signals. If the number of noise bits received between signals is greater than 100, then the threshold is incremented. Second is the unparsed signals. If an unparsed signal is received, but it has less than 20 pulses, the threhold is decremented.
To tune the SX127X OOK RSSI FIXED Threshold two values are used to determine if the threshold needs to be increased or decreased. The first is the noise received between signals. If the number of noise bits received between signals is greater than 100, then the threshold is incremented. Second is the unparsed signals. If an unparsed signal is received, but it has less than 20 pulses, the threshold is decremented.

The first approach is what is recommended in the SX127X datasheet, and the second is a control to lower the threshold if it is too high and incomplete signals are received.

Expand Down Expand Up @@ -359,11 +359,11 @@ ONBOARD_LED ; GPIO pin to toggle during signal reception ( Typically o

```plaintext
RF_SX1276 ; Enable support for SX1276 Transceiver
OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
OOK_FIXED_THRESHOLD ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals
```

### SX1276 Module Wiring ( Required if not using standard configuraton )
### SX1276 Module Wiring ( Required if not using standard configuration )

```plaintext
RF_MODULE_CS ; SX1276 SPI Chip select
Expand All @@ -376,11 +376,11 @@ RF_MODULE_DIO1 ; SX1276 DIO1 PIN

```plaintext
RF_SX1278 - Enable support for SX1276
OOK_FIXED_THRESHOLD ; Inital OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
OOK_FIXED_THRESHOLD ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
AUTOOOKFIX ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals
```

### SX1278 Module Wiring ( Required if not using standard configuraton )
### SX1278 Module Wiring ( Required if not using standard configuration )

```plaintext
RF_MODULE_CS ; SX1278 SPI Chip select
Expand All @@ -404,7 +404,7 @@ RF_MODULE_GDO0 ; CC1101 GDOO PIN
RF_MODULE_GDO2 ; CC1101 GDO2 PIN
```

## RF Module SPI Wiring ( Required if not using standard configuraton )
## RF Module SPI Wiring ( Required if not using standard configuration )

When using a non standard SPI configuration ( Standard config is SCK - 18, MISO - 19, MOSI - 23, CS - 5)

Expand Down Expand Up @@ -501,5 +501,5 @@ January 2023
* [RTL 433 ON ESP32 DEVICE - MQTT HOME ASSISTANT](https://youtube.com/watch?v=H-JXWbWjJYE&feature=shares)
* [Using low-cost wireless sensors in the unlicensed bands](https://lwn.net/Articles/921497/)

Febuary 2023
February 2023
* [OpenMQTTGateway Connects Many Things to Your Home Automation](https://www.youtube.com/watch?v=_gdXR1uklaY)
2 changes: 1 addition & 1 deletion include/rtl_433.h
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ typedef struct r_cfg {
int bufferSize; // size of message buffer for message callback
/**
* callback to controlling program to be executed when a message is received.
* Object point passsed is a pointer to a JSON formatted message for
* Object point passed is a pointer to a JSON formatted message for
* publishing.
*/
void (*callback)(char *message);
Expand Down
12 changes: 6 additions & 6 deletions src/rtl_433_ESP.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ Module* _mod = radio.getMod();
#define rtl_433_ReceiverTask_Priority 2
#define rtl_433_ReceiverTask_Core 0

/*----------------------------- Initalize variables -----------------------------*/
/*----------------------------- Initialize variables -----------------------------*/

/**
* Is the receiver currently receving a signal
* Is the receiver currently receiving a signal
*/
static bool receiveMode = false;

Expand Down Expand Up @@ -131,7 +131,7 @@ rtl_433_ESP::rtl_433_ESP() {
}

/**
* @brief Initalize Transceiver and rtl_433 decoders
* @brief Initialize Transceiver and rtl_433 decoders
*
* @param inputPin - GPIO of receiver
* @param receiveFrequency - receive frequency
Expand Down Expand Up @@ -164,7 +164,7 @@ void rtl_433_ESP::initReceiver(byte inputPin, float receiveFrequency) {
newSPI.begin(RF_MODULE_SCK, RF_MODULE_MISO, RF_MODULE_MOSI, RF_MODULE_CS);
#endif

/*----------------------------- Initalize Transceiver -----------------------------*/
/*----------------------------- Initialize Transceiver -----------------------------*/

#ifdef RF_CC1101
int state = radio.begin();
Expand Down Expand Up @@ -413,7 +413,7 @@ void rtl_433_ESP::resetReceiver() {
}

/**
* @brief Enable signal reciever logic
* @brief Enable signal receiver logic
*
* @param inputPin
*/
Expand Down Expand Up @@ -607,7 +607,7 @@ void rtl_433_ESP::rtl_433_ReceiverTask(void* pvParameters) {
totalSignals++;
if ((_nrpulses > PD_MIN_PULSES) &&
((signalEnd - signalStart) >
MINIMUM_SIGNAL_LENGTH)) // Minumum signal length of MINIMUM_SIGNAL_LENGTH MS
MINIMUM_SIGNAL_LENGTH)) // Minimum signal length of MINIMUM_SIGNAL_LENGTH MS
{
_pulseTrains[_actualPulseTrain].num_pulses = _nrpulses + 1;
_pulseTrains[_actualPulseTrain].signalDuration =
Expand Down
12 changes: 6 additions & 6 deletions src/rtl_433_ESP.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
# define OOK_MODULATION true
#endif

// signals shorter than this are ignored in interupt handler
// signals shorter than this are ignored in interrupt handler

#if OOK_MODULATION
# define MINIMUM_PULSE_LENGTH 50
Expand Down Expand Up @@ -223,7 +223,7 @@
#endif

/**
* message - JSON formated message from device
* message - JSON formatted message from device
*/
typedef void (*rtl_433_ESPCallBack)(char* message);

Expand Down Expand Up @@ -252,13 +252,13 @@ class rtl_433_ESP {
* callback function signature
*
* (char *message)
* message - JSON formated message from device
* message - JSON formatted message from device
*/
void setCallback(rtl_433_ESPCallBack callback, char* messageBuffer,
int bufferSize);

/**
* Set minumum RSSI value for receiver
* Set minimum RSSI value for receiver
*/
void setRSSIThreshold(int);

Expand All @@ -280,7 +280,7 @@ class rtl_433_ESP {
static void initReceiver(byte inputPin, float receiveFrequency);

/**
* Enable pulse receiver interupt and logic
* Enable pulse receiver interrupt and logic
*/
static void enableReceiver();

Expand Down Expand Up @@ -408,7 +408,7 @@ class rtl_433_ESP {

/**
* Get last received PulseTrain.
* Returns: last PulseTrain or 0 if not avaiable
* Returns: last PulseTrain or 0 if not available
*/
static int receivePulseTrain();

Expand Down
4 changes: 2 additions & 2 deletions src/signalDecoder.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ void rtlSetup() {
logprintfLn(LOG_DEBUG, "sizeof(cfg) %d, heap %d", sizeof(cfg),
ESP.getFreeHeap());
#endif
cfg->conversion_mode = CONVERT_SI; // Default all output to Celcius
cfg->conversion_mode = CONVERT_SI; // Default all output to Celsius
if (rtl_433_ESP::ookModulation) {
cfg->num_r_devices = NUMOF_OOK_DEVICES;
} else {
Expand Down Expand Up @@ -324,7 +324,7 @@ void rtlSetup() {
memcpy(&cfg->devices[79], &tpms_truck, sizeof(r_device));
}

// end of fragement
// end of fragment

#else
memcpy(&cfg->devices[0], &lacrosse_tx141x, sizeof(r_device));
Expand Down
2 changes: 1 addition & 1 deletion tools/update_rtl_433_devices.sh
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ cat devices.list | awk -f device.awk | egrep ${FSK_MODULATION} | awk -F\" '{ pri

echo "}" >> decoder.fragment
echo "" >> decoder.fragment
echo " // end of fragement" >> decoder.fragment
echo " // end of fragment" >> decoder.fragment

echo
echo "Please update src/signalDecoder.cpp with decoder.fragment"
Expand Down

0 comments on commit 3e67dcd

Please sign in to comment.