Skip to content

Added SPI dependency #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Viproz wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Added SPI dependency #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
eff5af1
Added dependency
Viproz Oct 24, 2021
9b15376
Missing Spi.end() before RegConfigSettings() caused ESP32-C3 to hang
fleibede Jul 26, 2024
e1ab28a
Return response status on SPI send.
Viproz Mar 29, 2025
1e45280
Merge pull request #1 from fleibede/fix-init-for-esp32
Viproz Aug 8, 2025
63b1a3d
Added a timeout for MISO wait to avoid crashes.
Viproz Aug 9, 2025
26ba864
ESP32 preprocessor is now not always defined with ESPHome or platformio.
Viproz Aug 9, 2025
4eec10a
Fixed gpio read/write on SPI pin spitting out errors.
Viproz Aug 9, 2025
c8988a2
Return the last status byte acquired when wring a burst of data.
Viproz Aug 9, 2025
3664897
Added function to write as much as possible into the write buffer.
Viproz Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 121 additions & 44 deletions ELECHOUSE_CC1101_SRC_DRV.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ cc1101 Driver for RC Switch. Mod by Little Satan. With permission to modify and
#define READ_BURST 0xC0 //read burst
#define BYTES_IN_RXFIFO 0x7F //byte number in RXfifo
#define max_modul 6
#define MISO_TIMEOUT 10 // Timeout for MISO pin to go low in milliseconds

byte modulation = 2;
byte frend0;
Expand Down Expand Up @@ -77,6 +78,47 @@ uint8_t PA_TABLE_433[8] {0x12,0x0E,0x1D,0x34,0x60,0x84,0xC8,0xC0,};
uint8_t PA_TABLE_868[10] {0x03,0x17,0x1D,0x26,0x37,0x50,0x86,0xCD,0xC5,0xC0,}; //779 - 899.99
// -30 -20 -15 -10 -6 0 5 7 10 11
uint8_t PA_TABLE_915[10] {0x03,0x0E,0x1E,0x27,0x38,0x8E,0x84,0xCC,0xC3,0xC0,}; //900 - 928

/****************************************************************
*FUNCTION NAME: waitForMisoLow
*FUNCTION : Safely waits for MISO pin to go low, indicating that the SPI device is ready.
*INPUT : None
*OUTPUT : Returns true if MISO goes low within the timeout, false if it times out.
*NOTE : This function is used to ensure that the SPI device is ready before proceeding with communication.
****************************************************************/
bool waitForMisoLow() {
uint32_t start = millis();
while (
#if defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
// Use of gpio_get_level for ESP32 is necessary because SPI makes the pin not a GPIO pin
gpio_get_level((gpio_num_t)MISO_PIN)
#else
digitalRead(MISO_PIN)
#endif
) {
if (millis() - start > MISO_TIMEOUT) {
return false; // Timed out
}
delay(0); // Yield to allow other tasks to run
}
return true;
}

/****************************************************************
*FUNCTION NAME:writeSPIPin
*FUNCTION :Write value to SPI pin
*INPUT :pin: pin number; value: value to write
*OUTPUT :none
*NOTE : This function is used to write a value to a specific SPI pin, ensuring compatibility with ESP32 and other platforms.
****************************************************************/
void writeSPIPin(uint8_t pin, uint8_t value) {
#if defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
gpio_set_level((gpio_num_t)pin, value);
#else
digitalWrite(pin, value);
#endif
}

/****************************************************************
*FUNCTION NAME:SpiStart
*FUNCTION :spi communication start
Expand All @@ -92,7 +134,7 @@ void ELECHOUSE_CC1101::SpiStart(void)
pinMode(SS_PIN, OUTPUT);

// enable SPI
#ifdef ESP32
#if defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
SPI.begin(SCK_PIN, MISO_PIN, MOSI_PIN, SS_PIN);
#else
SPI.begin();
Expand Down Expand Up @@ -137,34 +179,43 @@ void ELECHOUSE_CC1101::GDO0_Set (void)
*INPUT :none
*OUTPUT :none
****************************************************************/
void ELECHOUSE_CC1101::Reset (void)
bool ELECHOUSE_CC1101::Reset (void)
{
digitalWrite(SS_PIN, LOW);
writeSPIPin(SS_PIN, LOW);
delay(1);
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, HIGH);
delay(1);
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
writeSPIPin(SS_PIN, LOW);
if(!waitForMisoLow()) return false;
SPI.transfer(CC1101_SRES);
while(digitalRead(MISO_PIN));
digitalWrite(SS_PIN, HIGH);
if(!waitForMisoLow()) return false;
writeSPIPin(SS_PIN, HIGH);

return true;
}
/****************************************************************
*FUNCTION NAME:Init
*FUNCTION :CC1101 initialization
*INPUT :none
*OUTPUT :none
*FUNCTION NAME: Init
*FUNCTION : CC1101 initialization
*INPUT : none
*OUTPUT : true: success; false: fail
****************************************************************/
void ELECHOUSE_CC1101::Init(void)
bool ELECHOUSE_CC1101::Init(void)
{
setSpi();
SpiStart(); //spi initialization
digitalWrite(SS_PIN, HIGH);
digitalWrite(SCK_PIN, HIGH);
digitalWrite(MOSI_PIN, LOW);
Reset(); //CC1101 reset
RegConfigSettings(); //CC1101 register config
writeSPIPin(SS_PIN, HIGH);
writeSPIPin(SCK_PIN, HIGH);
writeSPIPin(MOSI_PIN, LOW);

//CC1101 reset
if(!Reset())
return false;

SpiEnd();
//CC1101 register config
RegConfigSettings();

return true;
}
/****************************************************************
*FUNCTION NAME:SpiWriteReg
Expand All @@ -175,11 +226,11 @@ void ELECHOUSE_CC1101::Init(void)
void ELECHOUSE_CC1101::SpiWriteReg(byte addr, byte value)
{
SpiStart();
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
SPI.transfer(addr);
SPI.transfer(value);
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, HIGH);
SpiEnd();
}
/****************************************************************
Expand All @@ -188,35 +239,61 @@ void ELECHOUSE_CC1101::SpiWriteReg(byte addr, byte value)
*INPUT :addr: register address; buffer:register value array; num:number to write
*OUTPUT :none
****************************************************************/
void ELECHOUSE_CC1101::SpiWriteBurstReg(byte addr, byte *buffer, byte num)
byte ELECHOUSE_CC1101::SpiWriteBurstReg(byte addr, byte *buffer, byte num)
{
byte i, temp;
SpiStart();
temp = addr | WRITE_BURST;
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
SPI.transfer(temp);
for (i = 0; i < num; i++)
{
SPI.transfer(buffer[i]);
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
byte resp = SPI.transfer(temp);
for (i = 0; i < num; i++) {
resp = SPI.transfer(buffer[i]);
}
writeSPIPin(SS_PIN, HIGH);
SpiEnd();

return resp;
}
/****************************************************************
*FUNCTION NAME:SpiWriteBurstMaxReg
*FUNCTION :CC1101 write burst data to register
*INPUT :addr: register address; buffer:register value array; num:number to write
*OUTPUT :none
****************************************************************/
byte ELECHOUSE_CC1101::SpiWriteBurstMaxReg(byte addr, byte *buffer, byte maxNum, byte *written)
{
byte i, temp;
SpiStart();
temp = addr | WRITE_BURST;
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
byte resp = SPI.transfer(temp);
for (i = 0; i < maxNum && (resp & 0x0F) > 0; i++) {
resp = SPI.transfer(buffer[i]);
}
digitalWrite(SS_PIN, HIGH);
*written = i;
writeSPIPin(SS_PIN, HIGH);
SpiEnd();

return resp;
}
/****************************************************************
*FUNCTION NAME:SpiStrobe
*FUNCTION :CC1101 Strobe
*INPUT :strobe: command; //refer define in CC1101.h//
*OUTPUT :none
****************************************************************/
void ELECHOUSE_CC1101::SpiStrobe(byte strobe)
byte ELECHOUSE_CC1101::SpiStrobe(byte strobe)
{
SpiStart();
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
SPI.transfer(strobe);
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
byte resp = SPI.transfer(strobe);
writeSPIPin(SS_PIN, HIGH);
SpiEnd();

return resp;
}
/****************************************************************
*FUNCTION NAME:SpiReadReg
Expand All @@ -229,11 +306,11 @@ byte ELECHOUSE_CC1101::SpiReadReg(byte addr)
byte temp, value;
SpiStart();
temp = addr| READ_SINGLE;
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
SPI.transfer(temp);
value=SPI.transfer(0);
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, HIGH);
SpiEnd();
return value;
}
Expand All @@ -249,14 +326,14 @@ void ELECHOUSE_CC1101::SpiReadBurstReg(byte addr, byte *buffer, byte num)
byte i,temp;
SpiStart();
temp = addr | READ_BURST;
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
SPI.transfer(temp);
for(i=0;i<num;i++)
{
buffer[i]=SPI.transfer(0);
}
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, HIGH);
SpiEnd();
}

Expand All @@ -271,11 +348,11 @@ byte ELECHOUSE_CC1101::SpiReadStatus(byte addr)
byte value,temp;
SpiStart();
temp = addr | READ_BURST;
digitalWrite(SS_PIN, LOW);
while(digitalRead(MISO_PIN));
writeSPIPin(SS_PIN, LOW);
waitForMisoLow();
SPI.transfer(temp);
value=SPI.transfer(0);
digitalWrite(SS_PIN, HIGH);
writeSPIPin(SS_PIN, HIGH);
SpiEnd();
return value;
}
Expand All @@ -293,7 +370,7 @@ void ELECHOUSE_CC1101::setSpi(void){
SCK_PIN = 52; MISO_PIN = 50; MOSI_PIN = 51; SS_PIN = 53;
#elif ESP8266
SCK_PIN = 14; MISO_PIN = 12; MOSI_PIN = 13; SS_PIN = 15;
#elif ESP32
#elif defined(ESP32) || defined(ARDUINO_ARCH_ESP32)
SCK_PIN = 18; MISO_PIN = 19; MOSI_PIN = 23; SS_PIN = 5;
#else
SCK_PIN = 13; MISO_PIN = 12; MOSI_PIN = 11; SS_PIN = 10;
Expand Down
9 changes: 5 additions & 4 deletions ELECHOUSE_CC1101_SRC_DRV.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ class ELECHOUSE_CC1101
void SpiEnd(void);
void GDO_Set (void);
void GDO0_Set (void);
void Reset (void);
bool Reset (void);
void setSpi(void);
void RegConfigSettings(void);
void Calibrate(void);
Expand All @@ -128,7 +128,7 @@ class ELECHOUSE_CC1101
void Split_MDMCFG2(void);
void Split_MDMCFG4(void);
public:
void Init(void);
bool Init(void);
byte SpiReadStatus(byte addr);
void setSpiPin(byte sck, byte miso, byte mosi, byte ss);
void addSpiPin(byte sck, byte miso, byte mosi, byte ss, byte modul);
Expand Down Expand Up @@ -162,9 +162,10 @@ class ELECHOUSE_CC1101
byte CheckReceiveFlag(void);
byte ReceiveData(byte *rxBuffer);
bool CheckCRC(void);
void SpiStrobe(byte strobe);
byte SpiStrobe(byte strobe);
void SpiWriteReg(byte addr, byte value);
void SpiWriteBurstReg(byte addr, byte *buffer, byte num);
byte SpiWriteBurstReg(byte addr, byte *buffer, byte num);
byte SpiWriteBurstMaxReg(byte addr, byte *buffer, byte maxNum, byte *written);
byte SpiReadReg(byte addr);
void SpiReadBurstReg(byte addr, byte *buffer, byte num);
void setClb(byte b, byte s, byte e);
Expand Down
8 changes: 7 additions & 1 deletion library.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,11 @@
"frameworks": [
"arduino"
],
"platforms": "*"
"platforms": "*",
"dependencies":
[
{
"name": "SPI"
}
]
}