ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
cc1101.h
Go to the documentation of this file.
1#pragma once
2
4#include "esphome/core/hal.h"
7#include "cc1101defs.h"
8#include <vector>
9
10namespace esphome::cc1101 {
11
13
15 public:
16 virtual void on_packet(const std::vector<uint8_t> &packet, float freq_offset, float rssi, uint8_t lqi) = 0;
17};
18
19class CC1101Component final : public Component,
20 public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW,
21 spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ> {
22 public:
24
25 void setup() override;
26 void loop() override;
27 void dump_config() override;
28 void configure();
29
30 // Actions
31 void begin_tx();
32 void begin_rx();
33 void reset();
34 void set_idle();
35
36 // GDO Pin Configuration
37 void set_gdo0_pin(InternalGPIOPin *pin) { this->gdo0_pin_ = pin; }
38
39 // Configuration Setters
40 void set_output_power(float value);
43
44 // Tuner settings
45 void set_frequency(float value);
46 void set_if_frequency(float value);
47 void set_filter_bandwidth(float value);
48 void set_channel(uint8_t value);
49 void set_channel_spacing(float value);
50 void set_fsk_deviation(float value);
51 void set_msk_deviation(uint8_t value);
52 void set_symbol_rate(float value);
56 void set_manchester(bool value);
57 void set_num_preamble(uint8_t value);
58 void set_sync1(uint8_t value);
59 void set_sync0(uint8_t value);
60
61 // AGC settings
67 void set_lna_priority(bool value);
73
74 // Frequency offset compensation and bit synchronization settings
75 void set_foc_bs_cs_gate(bool value);
84
85 // Packet mode settings
86 void set_packet_mode(bool value);
87 void set_packet_length(uint8_t value);
88 void set_crc_enable(bool value);
89 void set_whitening(bool value);
90
91 // Packet mode operations
92 CC1101Error transmit_packet(const std::vector<uint8_t> &packet) {
93 return this->transmit_packet(packet.data(), packet.size());
94 }
95 CC1101Error transmit_packet(const uint8_t *data, size_t len);
96 void register_listener(CC1101Listener *listener) { this->listeners_.push_back(listener); }
97 Trigger<std::vector<uint8_t>, float, float, uint8_t> *get_packet_trigger() { return &this->packet_trigger_; }
98
99 protected:
100 uint16_t chip_id_{0};
101 bool initialized_{false};
102
105 uint8_t pa_table_[PA_TABLE_SIZE]{};
106
107 CC1101State state_;
108
109 // GDO pin for packet reception
111 static void gpio_intr(CC1101Component *arg);
112
113 // Packet handling
114 void call_listeners_(const std::vector<uint8_t> &packet, float freq_offset, float rssi, uint8_t lqi);
116 std::vector<uint8_t> packet_;
117 std::vector<CC1101Listener *> listeners_;
118
119 // Low-level Helpers
120 uint8_t strobe_(Command cmd);
121 void write_(Register reg);
122 void write_(Register reg, uint8_t value);
123 void write_(Register reg, const uint8_t *buffer, size_t length);
124 void read_(Register reg);
125 void read_(Register reg, uint8_t *buffer, size_t length);
126
127 // State Management
128 bool wait_for_state_(State target_state, uint32_t timeout_ms = 100);
129 bool enter_calibrated_(State target_state, Command cmd);
130 void enter_idle_();
131 bool enter_rx_();
132 bool enter_tx_();
133};
134
135} // namespace esphome::cc1101
void set_bs_post_kp(BsPostKp value)
Definition cc1101.cpp:760
void set_packet_mode(bool value)
Definition cc1101.cpp:767
Trigger< std::vector< uint8_t >, float, float, uint8_t > * get_packet_trigger()
Definition cc1101.h:97
void set_max_dvga_gain(MaxDvgaGain value)
Definition cc1101.cpp:641
void set_whitening(bool value)
Definition cc1101.cpp:816
void set_carrier_sense_above_threshold(bool value)
Definition cc1101.cpp:580
void write_(Register reg)
Definition cc1101.cpp:359
void set_sync0(uint8_t value)
Definition cc1101.cpp:620
void set_freeze(Freeze value)
Definition cc1101.cpp:683
void call_listeners_(const std::vector< uint8_t > &packet, float freq_offset, float rssi, uint8_t lqi)
Definition cc1101.cpp:181
void set_rx_attenuation(RxAttenuation value)
Definition cc1101.cpp:475
InternalGPIOPin * gdo0_pin_
Definition cc1101.h:110
void set_symbol_rate(float value)
Definition cc1101.cpp:561
void register_listener(CC1101Listener *listener)
Definition cc1101.h:96
void set_bs_pre_ki(BsPreKi value)
Definition cc1101.cpp:739
uint8_t strobe_(Command cmd)
Definition cc1101.cpp:348
void set_sync_mode(SyncMode value)
Definition cc1101.cpp:573
void set_fsk_deviation(float value)
Definition cc1101.cpp:542
void set_bs_pre_kp(BsPreKp value)
Definition cc1101.cpp:746
void set_msk_deviation(uint8_t value)
Definition cc1101.cpp:553
void set_carrier_sense_rel_thr(CarrierSenseRelThr value)
Definition cc1101.cpp:655
uint8_t pa_table_[PA_TABLE_SIZE]
Definition cc1101.h:105
void set_lna_priority(bool value)
Definition cc1101.cpp:662
void set_foc_bs_cs_gate(bool value)
Definition cc1101.cpp:704
void set_foc_pre_k(FocPreK value)
Definition cc1101.cpp:718
void set_output_power(float value)
Definition cc1101.cpp:447
void set_modulation_type(Modulation value)
Definition cc1101.cpp:587
void set_if_frequency(float value)
Definition cc1101.cpp:503
void set_frequency(float value)
Definition cc1101.cpp:489
void set_num_preamble(uint8_t value)
Definition cc1101.cpp:606
void set_hyst_level(HystLevel value)
Definition cc1101.cpp:697
void set_filter_bandwidth(float value)
Definition cc1101.cpp:510
void set_filter_length_fsk_msk(FilterLengthFskMsk value)
Definition cc1101.cpp:669
void set_crc_enable(bool value)
Definition cc1101.cpp:809
static void gpio_intr(CC1101Component *arg)
Definition cc1101.cpp:115
void set_carrier_sense_abs_thr(int8_t value)
Definition cc1101.cpp:648
void set_bs_post_ki(BsPostKi value)
Definition cc1101.cpp:753
bool enter_calibrated_(State target_state, Command cmd)
Definition cc1101.cpp:321
void set_magn_target(MagnTarget value)
Definition cc1101.cpp:627
void set_channel_spacing(float value)
Definition cc1101.cpp:530
CC1101Error transmit_packet(const std::vector< uint8_t > &packet)
Definition cc1101.h:92
void set_gdo0_pin(InternalGPIOPin *pin)
Definition cc1101.h:37
void set_wait_time(WaitTime value)
Definition cc1101.cpp:690
std::vector< CC1101Listener * > listeners_
Definition cc1101.h:117
void set_dc_blocking_filter(bool value)
Definition cc1101.cpp:482
void set_packet_length(uint8_t value)
Definition cc1101.cpp:796
void set_manchester(bool value)
Definition cc1101.cpp:599
std::vector< uint8_t > packet_
Definition cc1101.h:116
void set_channel(uint8_t value)
Definition cc1101.cpp:521
void set_foc_limit(FocLimit value)
Definition cc1101.cpp:711
void set_filter_length_ask_ook(FilterLengthAskOok value)
Definition cc1101.cpp:676
void set_max_lna_gain(MaxLnaGain value)
Definition cc1101.cpp:634
void set_sync1(uint8_t value)
Definition cc1101.cpp:613
bool wait_for_state_(State target_state, uint32_t timeout_ms=100)
Definition cc1101.cpp:308
void set_bs_limit(BsLimit value)
Definition cc1101.cpp:732
void set_foc_post_k(FocPostK value)
Definition cc1101.cpp:725
Trigger< std::vector< uint8_t >, float, float, uint8_t > packet_trigger_
Definition cc1101.h:115
virtual void on_packet(const std::vector< uint8_t > &packet, float freq_offset, float rssi, uint8_t lqi)=0
The SPIDevice is what components using the SPI will create.
Definition spi.h:456
uint32_t buffer
Definition gif.cpp:50
uint32_t value
Definition hal.cpp:41
const void size_t len
Definition hal.h:68
static void uint32_t