1 #if !defined(_RADIOLIB_CC1101_H) && !defined(RADIOLIB_EXCLUDE_CC1101)
2 #define _RADIOLIB_CC1101_H
4 #include "../../TypeDef.h"
5 #include "../../Module.h"
7 #include "../../protocols/PhysicalLayer/PhysicalLayer.h"
10 #define RADIOLIB_CC1101_FREQUENCY_STEP_SIZE 396.7285156
11 #define RADIOLIB_CC1101_MAX_PACKET_LENGTH 255
12 #define RADIOLIB_CC1101_CRYSTAL_FREQ 26.0
13 #define RADIOLIB_CC1101_DIV_EXPONENT 16
14 #define RADIOLIB_CC1101_FIFO_SIZE 64
17 #define RADIOLIB_CC1101_CMD_READ 0b10000000
18 #define RADIOLIB_CC1101_CMD_WRITE 0b00000000
19 #define RADIOLIB_CC1101_CMD_BURST 0b01000000
20 #define RADIOLIB_CC1101_CMD_ACCESS_STATUS_REG 0b01000000
21 #define RADIOLIB_CC1101_CMD_FIFO_RX 0b10000000
22 #define RADIOLIB_CC1101_CMD_FIFO_TX 0b00000000
23 #define RADIOLIB_CC1101_CMD_RESET 0x30
24 #define RADIOLIB_CC1101_CMD_FSTXON 0x31
25 #define RADIOLIB_CC1101_CMD_XOFF 0x32
26 #define RADIOLIB_CC1101_CMD_CAL 0x33
27 #define RADIOLIB_CC1101_CMD_RX 0x34
28 #define RADIOLIB_CC1101_CMD_TX 0x35
29 #define RADIOLIB_CC1101_CMD_IDLE 0x36
30 #define RADIOLIB_CC1101_CMD_WOR 0x38
31 #define RADIOLIB_CC1101_CMD_POWER_DOWN 0x39
32 #define RADIOLIB_CC1101_CMD_FLUSH_RX 0x3A
33 #define RADIOLIB_CC1101_CMD_FLUSH_TX 0x3B
34 #define RADIOLIB_CC1101_CMD_WOR_RESET 0x3C
35 #define RADIOLIB_CC1101_CMD_NOP 0x3D
38 #define RADIOLIB_CC1101_REG_IOCFG2 0x00
39 #define RADIOLIB_CC1101_REG_IOCFG1 0x01
40 #define RADIOLIB_CC1101_REG_IOCFG0 0x02
41 #define RADIOLIB_CC1101_REG_FIFOTHR 0x03
42 #define RADIOLIB_CC1101_REG_SYNC1 0x04
43 #define RADIOLIB_CC1101_REG_SYNC0 0x05
44 #define RADIOLIB_CC1101_REG_PKTLEN 0x06
45 #define RADIOLIB_CC1101_REG_PKTCTRL1 0x07
46 #define RADIOLIB_CC1101_REG_PKTCTRL0 0x08
47 #define RADIOLIB_CC1101_REG_ADDR 0x09
48 #define RADIOLIB_CC1101_REG_CHANNR 0x0A
49 #define RADIOLIB_CC1101_REG_FSCTRL1 0x0B
50 #define RADIOLIB_CC1101_REG_FSCTRL0 0x0C
51 #define RADIOLIB_CC1101_REG_FREQ2 0x0D
52 #define RADIOLIB_CC1101_REG_FREQ1 0x0E
53 #define RADIOLIB_CC1101_REG_FREQ0 0x0F
54 #define RADIOLIB_CC1101_REG_MDMCFG4 0x10
55 #define RADIOLIB_CC1101_REG_MDMCFG3 0x11
56 #define RADIOLIB_CC1101_REG_MDMCFG2 0x12
57 #define RADIOLIB_CC1101_REG_MDMCFG1 0x13
58 #define RADIOLIB_CC1101_REG_MDMCFG0 0x14
59 #define RADIOLIB_CC1101_REG_DEVIATN 0x15
60 #define RADIOLIB_CC1101_REG_MCSM2 0x16
61 #define RADIOLIB_CC1101_REG_MCSM1 0x17
62 #define RADIOLIB_CC1101_REG_MCSM0 0x18
63 #define RADIOLIB_CC1101_REG_FOCCFG 0x19
64 #define RADIOLIB_CC1101_REG_BSCFG 0x1A
65 #define RADIOLIB_CC1101_REG_AGCCTRL2 0x1B
66 #define RADIOLIB_CC1101_REG_AGCCTRL1 0x1C
67 #define RADIOLIB_CC1101_REG_AGCCTRL0 0x1D
68 #define RADIOLIB_CC1101_REG_WOREVT1 0x1E
69 #define RADIOLIB_CC1101_REG_WOREVT0 0x1F
70 #define RADIOLIB_CC1101_REG_WORCTRL 0x20
71 #define RADIOLIB_CC1101_REG_FREND1 0x21
72 #define RADIOLIB_CC1101_REG_FREND0 0x22
73 #define RADIOLIB_CC1101_REG_FSCAL3 0x23
74 #define RADIOLIB_CC1101_REG_FSCAL2 0x24
75 #define RADIOLIB_CC1101_REG_FSCAL1 0x25
76 #define RADIOLIB_CC1101_REG_FSCAL0 0x26
77 #define RADIOLIB_CC1101_REG_RCCTRL1 0x27
78 #define RADIOLIB_CC1101_REG_RCCTRL0 0x28
79 #define RADIOLIB_CC1101_REG_FSTEST 0x29
80 #define RADIOLIB_CC1101_REG_PTEST 0x2A
81 #define RADIOLIB_CC1101_REG_AGCTEST 0x2B
82 #define RADIOLIB_CC1101_REG_TEST2 0x2C
83 #define RADIOLIB_CC1101_REG_TEST1 0x2D
84 #define RADIOLIB_CC1101_REG_TEST0 0x2E
85 #define RADIOLIB_CC1101_REG_PARTNUM 0x30
86 #define RADIOLIB_CC1101_REG_VERSION 0x31
87 #define RADIOLIB_CC1101_REG_FREQEST 0x32
88 #define RADIOLIB_CC1101_REG_LQI 0x33
89 #define RADIOLIB_CC1101_REG_RSSI 0x34
90 #define RADIOLIB_CC1101_REG_MARCSTATE 0x35
91 #define RADIOLIB_CC1101_REG_WORTIME1 0x36
92 #define RADIOLIB_CC1101_REG_WORTIME0 0x37
93 #define RADIOLIB_CC1101_REG_PKTSTATUS 0x38
94 #define RADIOLIB_CC1101_REG_VCO_VC_DAC 0x39
95 #define RADIOLIB_CC1101_REG_TXBYTES 0x3A
96 #define RADIOLIB_CC1101_REG_RXBYTES 0x3B
97 #define RADIOLIB_CC1101_REG_RCCTRL1_STATUS 0x3C
98 #define RADIOLIB_CC1101_REG_RCCTRL0_STATUS 0x3D
99 #define RADIOLIB_CC1101_REG_PATABLE 0x3E
100 #define RADIOLIB_CC1101_REG_FIFO 0x3F
103 #define RADIOLIB_CC1101_GDO2_NORM 0b00000000
104 #define RADIOLIB_CC1101_GDO2_INV 0b01000000
107 #define RADIOLIB_CC1101_GDO1_DS_LOW 0b00000000
108 #define RADIOLIB_CC1101_GDO1_DS_HIGH 0b10000000
109 #define RADIOLIB_CC1101_GDO1_NORM 0b00000000
110 #define RADIOLIB_CC1101_GDO1_INV 0b01000000
113 #define RADIOLIB_CC1101_GDO0_TEMP_SENSOR_OFF 0b00000000
114 #define RADIOLIB_CC1101_GDO0_TEMP_SENSOR_ON 0b10000000
115 #define RADIOLIB_CC1101_GDO0_NORM 0b00000000
116 #define RADIOLIB_CC1101_GDO0_INV 0b01000000
119 #define RADIOLIB_CC1101_GDOX_RX_FIFO_FULL 0x00
120 #define RADIOLIB_CC1101_GDOX_RX_FIFO_FULL_OR_PKT_END 0x01
121 #define RADIOLIB_CC1101_GDOX_TX_FIFO_ABOVE_THR 0x02
122 #define RADIOLIB_CC1101_GDOX_TX_FIFO_FULL 0x03
123 #define RADIOLIB_CC1101_GDOX_RX_FIFO_OVERFLOW 0x04
124 #define RADIOLIB_CC1101_GDOX_TX_FIFO_UNDERFLOW 0x05
125 #define RADIOLIB_CC1101_GDOX_SYNC_WORD_SENT_OR_RECEIVED 0x06
126 #define RADIOLIB_CC1101_GDOX_PKT_RECEIVED_CRC_OK 0x07
127 #define RADIOLIB_CC1101_GDOX_PREAMBLE_QUALITY_REACHED 0x08
128 #define RADIOLIB_CC1101_GDOX_CHANNEL_CLEAR 0x09
129 #define RADIOLIB_CC1101_GDOX_PLL_LOCKED 0x0A
130 #define RADIOLIB_CC1101_GDOX_SERIAL_CLOCK 0x0B
131 #define RADIOLIB_CC1101_GDOX_SERIAL_DATA_SYNC 0x0C
132 #define RADIOLIB_CC1101_GDOX_SERIAL_DATA_ASYNC 0x0D
133 #define RADIOLIB_CC1101_GDOX_CARRIER_SENSE 0x0E
134 #define RADIOLIB_CC1101_GDOX_CRC_OK 0x0F
135 #define RADIOLIB_CC1101_GDOX_RX_HARD_DATA1 0x16
136 #define RADIOLIB_CC1101_GDOX_RX_HARD_DATA0 0x17
137 #define RADIOLIB_CC1101_GDOX_PA_PD 0x1B
138 #define RADIOLIB_CC1101_GDOX_LNA_PD 0x1C
139 #define RADIOLIB_CC1101_GDOX_RX_SYMBOL_TICK 0x1D
140 #define RADIOLIB_CC1101_GDOX_WOR_EVNT0 0x24
141 #define RADIOLIB_CC1101_GDOX_WOR_EVNT1 0x25
142 #define RADIOLIB_CC1101_GDOX_CLK_256 0x26
143 #define RADIOLIB_CC1101_GDOX_CLK_32K 0x27
144 #define RADIOLIB_CC1101_GDOX_CHIP_RDYN 0x29
145 #define RADIOLIB_CC1101_GDOX_XOSC_STABLE 0x2B
146 #define RADIOLIB_CC1101_GDOX_HIGH_Z 0x2E
147 #define RADIOLIB_CC1101_GDOX_HW_TO_0 0x2F
148 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_1 0x30
149 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_1_5 0x31
150 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_2 0x32
151 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_3 0x33
152 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_4 0x34
153 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_6 0x35
154 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_8 0x36
155 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_12 0x37
156 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_16 0x38
157 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_24 0x39
158 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_32 0x3A
159 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_48 0x3B
160 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_64 0x3C
161 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_96 0x3D
162 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_128 0x3E
163 #define RADIOLIB_CC1101_GDOX_CLOCK_XOSC_192 0x3F
166 #define RADIOLIB_CC1101_ADC_RETENTION_OFF 0b00000000
167 #define RADIOLIB_CC1101_ADC_RETENTION_ON 0b01000000
168 #define RADIOLIB_CC1101_RX_ATTEN_0_DB 0b00000000
169 #define RADIOLIB_CC1101_RX_ATTEN_6_DB 0b00010000
170 #define RADIOLIB_CC1101_RX_ATTEN_12_DB 0b00100000
171 #define RADIOLIB_CC1101_RX_ATTEN_18_DB 0b00110000
172 #define RADIOLIB_CC1101_FIFO_THR_TX_61_RX_4 0b00000000
175 #define RADIOLIB_CC1101_SYNC_WORD_MSB 0xD3
178 #define RADIOLIB_CC1101_SYNC_WORD_LSB 0x91
181 #define RADIOLIB_CC1101_PACKET_LENGTH 0xFF
184 #define RADIOLIB_CC1101_PQT 0x00
185 #define RADIOLIB_CC1101_CRC_AUTOFLUSH_OFF 0b00000000
186 #define RADIOLIB_CC1101_CRC_AUTOFLUSH_ON 0b00001000
187 #define RADIOLIB_CC1101_APPEND_STATUS_OFF 0b00000000
188 #define RADIOLIB_CC1101_APPEND_STATUS_ON 0b00000100
189 #define RADIOLIB_CC1101_ADR_CHK_NONE 0b00000000
190 #define RADIOLIB_CC1101_ADR_CHK_NO_BROADCAST 0b00000001
191 #define RADIOLIB_CC1101_ADR_CHK_SINGLE_BROADCAST 0b00000010
192 #define RADIOLIB_CC1101_ADR_CHK_DOUBLE_BROADCAST 0b00000011
195 #define RADIOLIB_CC1101_WHITE_DATA_OFF 0b00000000
196 #define RADIOLIB_CC1101_WHITE_DATA_ON 0b01000000
197 #define RADIOLIB_CC1101_PKT_FORMAT_NORMAL 0b00000000
198 #define RADIOLIB_CC1101_PKT_FORMAT_SYNCHRONOUS 0b00010000
199 #define RADIOLIB_CC1101_PKT_FORMAT_RANDOM 0b00100000
200 #define RADIOLIB_CC1101_PKT_FORMAT_ASYNCHRONOUS 0b00110000
201 #define RADIOLIB_CC1101_CRC_OFF 0b00000000
202 #define RADIOLIB_CC1101_CRC_ON 0b00000100
203 #define RADIOLIB_CC1101_LENGTH_CONFIG_FIXED 0b00000000
204 #define RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE 0b00000001
205 #define RADIOLIB_CC1101_LENGTH_CONFIG_INFINITE 0b00000010
208 #define RADIOLIB_CC1101_DEVICE_ADDR 0x00
211 #define RADIOLIB_CC1101_CHAN 0x00
214 #define RADIOLIB_CC1101_FREQ_IF 0x0F
217 #define RADIOLIB_CC1101_FREQOFF 0x00
220 #define RADIOLIB_CC1101_FREQ_MSB 0x1E
221 #define RADIOLIB_CC1101_FREQ_MID 0xC4
222 #define RADIOLIB_CC1101_FREQ_LSB 0xEC
225 #define RADIOLIB_CC1101_CHANBW_E 0b10000000
226 #define RADIOLIB_CC1101_CHANBW_M 0b00000000
227 #define RADIOLIB_CC1101_DRATE_E 0x0C
230 #define RADIOLIB_CC1101_DRATE_M 0x22
233 #define RADIOLIB_CC1101_DEM_DCFILT_OFF 0b10000000
234 #define RADIOLIB_CC1101_DEM_DCFILT_ON 0b00000000
235 #define RADIOLIB_CC1101_MOD_FORMAT_2_FSK 0b00000000
236 #define RADIOLIB_CC1101_MOD_FORMAT_GFSK 0b00010000
237 #define RADIOLIB_CC1101_MOD_FORMAT_ASK_OOK 0b00110000
238 #define RADIOLIB_CC1101_MOD_FORMAT_4_FSK 0b01000000
239 #define RADIOLIB_CC1101_MOD_FORMAT_MFSK 0b01110000
240 #define RADIOLIB_CC1101_MANCHESTER_EN_OFF 0b00000000
241 #define RADIOLIB_CC1101_MANCHESTER_EN_ON 0b00001000
242 #define RADIOLIB_CC1101_SYNC_MODE_NONE 0b00000000
243 #define RADIOLIB_CC1101_SYNC_MODE_15_16 0b00000001
244 #define RADIOLIB_CC1101_SYNC_MODE_16_16 0b00000010
245 #define RADIOLIB_CC1101_SYNC_MODE_30_32 0b00000011
246 #define RADIOLIB_CC1101_SYNC_MODE_NONE_THR 0b00000100
247 #define RADIOLIB_CC1101_SYNC_MODE_15_16_THR 0b00000101
248 #define RADIOLIB_CC1101_SYNC_MODE_16_16_THR 0b00000110
249 #define RADIOLIB_CC1101_SYNC_MODE_30_32_THR 0b00000111
252 #define RADIOLIB_CC1101_FEC_OFF 0b00000000
253 #define RADIOLIB_CC1101_FEC_ON 0b10000000
254 #define RADIOLIB_CC1101_NUM_PREAMBLE_2 0b00000000
255 #define RADIOLIB_CC1101_NUM_PREAMBLE_3 0b00010000
256 #define RADIOLIB_CC1101_NUM_PREAMBLE_4 0b00100000
257 #define RADIOLIB_CC1101_NUM_PREAMBLE_6 0b00110000
258 #define RADIOLIB_CC1101_NUM_PREAMBLE_8 0b01000000
259 #define RADIOLIB_CC1101_NUM_PREAMBLE_12 0b01010000
260 #define RADIOLIB_CC1101_NUM_PREAMBLE_16 0b01100000
261 #define RADIOLIB_CC1101_NUM_PREAMBLE_24 0b01110000
262 #define RADIOLIB_CC1101_CHANSPC_E 0x02
265 #define RADIOLIB_CC1101_CHANSPC_M 0xF8
268 #define RADIOLIB_CC1101_DEVIATION_E 0b01000000
269 #define RADIOLIB_CC1101_DEVIATION_M 0b00000111
270 #define RADIOLIB_CC1101_MSK_PHASE_CHANGE_PERIOD 0x07
273 #define RADIOLIB_CC1101_RX_TIMEOUT_RSSI_OFF 0b00000000
274 #define RADIOLIB_CC1101_RX_TIMEOUT_RSSI_ON 0b00010000
275 #define RADIOLIB_CC1101_RX_TIMEOUT_QUAL_OFF 0b00000000
276 #define RADIOLIB_CC1101_RX_TIMEOUT_QUAL_ON 0b00001000
277 #define RADIOLIB_CC1101_RX_TIMEOUT_OFF 0b00000111
278 #define RADIOLIB_CC1101_RX_TIMEOUT_MAX 0b00000000
281 #define RADIOLIB_CC1101_CCA_MODE_ALWAYS 0b00000000
282 #define RADIOLIB_CC1101_CCA_MODE_RSSI_THR 0b00010000
283 #define RADIOLIB_CC1101_CCA_MODE_RX_PKT 0b00100000
284 #define RADIOLIB_CC1101_CCA_MODE_RSSI_THR_RX_PKT 0b00110000
285 #define RADIOLIB_CC1101_RXOFF_IDLE 0b00000000
286 #define RADIOLIB_CC1101_RXOFF_FSTXON 0b00000100
287 #define RADIOLIB_CC1101_RXOFF_TX 0b00001000
288 #define RADIOLIB_CC1101_RXOFF_RX 0b00001100
289 #define RADIOLIB_CC1101_TXOFF_IDLE 0b00000000
290 #define RADIOLIB_CC1101_TXOFF_FSTXON 0b00000001
291 #define RADIOLIB_CC1101_TXOFF_TX 0b00000010
292 #define RADIOLIB_CC1101_TXOFF_RX 0b00000011
295 #define RADIOLIB_CC1101_FS_AUTOCAL_NEVER 0b00000000
296 #define RADIOLIB_CC1101_FS_AUTOCAL_IDLE_TO_RXTX 0b00010000
297 #define RADIOLIB_CC1101_FS_AUTOCAL_RXTX_TO_IDLE 0b00100000
298 #define RADIOLIB_CC1101_FS_AUTOCAL_RXTX_TO_IDLE_4TH 0b00110000
299 #define RADIOLIB_CC1101_PO_TIMEOUT_COUNT_1 0b00000000
300 #define RADIOLIB_CC1101_PO_TIMEOUT_COUNT_16 0b00000100
301 #define RADIOLIB_CC1101_PO_TIMEOUT_COUNT_64 0b00001000
302 #define RADIOLIB_CC1101_PO_TIMEOUT_COUNT_256 0b00001100
303 #define RADIOLIB_CC1101_PIN_CTRL_OFF 0b00000000
304 #define RADIOLIB_CC1101_PIN_CTRL_ON 0b00000010
305 #define RADIOLIB_CC1101_XOSC_FORCE_OFF 0b00000000
306 #define RADIOLIB_CC1101_XOSC_FORCE_ON 0b00000001
309 #define RADIOLIB_CC1101_FOC_BS_CS_GATE_OFF 0b00000000
310 #define RADIOLIB_CC1101_FOC_BS_CS_GATE_ON 0b00100000
311 #define RADIOLIB_CC1101_FOC_PRE_K 0b00000000
312 #define RADIOLIB_CC1101_FOC_PRE_2K 0b00001000
313 #define RADIOLIB_CC1101_FOC_PRE_3K 0b00010000
314 #define RADIOLIB_CC1101_FOC_PRE_4K 0b00011000
315 #define RADIOLIB_CC1101_FOC_POST_K 0b00000000
316 #define RADIOLIB_CC1101_FOC_POST_K_2 0b00000100
317 #define RADIOLIB_CC1101_FOC_LIMIT_NO_COMPENSATION 0b00000000
318 #define RADIOLIB_CC1101_FOC_LIMIT_BW_CHAN_8 0b00000001
319 #define RADIOLIB_CC1101_FOC_LIMIT_BW_CHAN_4 0b00000010
320 #define RADIOLIB_CC1101_FOC_LIMIT_BW_CHAN_2 0b00000011
323 #define RADIOLIB_CC1101_BS_PRE_KI 0b00000000
324 #define RADIOLIB_CC1101_BS_PRE_2KI 0b01000000
325 #define RADIOLIB_CC1101_BS_PRE_3KI 0b10000000
326 #define RADIOLIB_CC1101_BS_PRE_4KI 0b11000000
327 #define RADIOLIB_CC1101_BS_PRE_KP 0b00000000
328 #define RADIOLIB_CC1101_BS_PRE_2KP 0b00010000
329 #define RADIOLIB_CC1101_BS_PRE_3KP 0b00100000
330 #define RADIOLIB_CC1101_BS_PRE_4KP 0b00110000
331 #define RADIOLIB_CC1101_BS_POST_KI 0b00000000
332 #define RADIOLIB_CC1101_BS_POST_KI_2 0b00001000
333 #define RADIOLIB_CC1101_BS_POST_KP 0b00000000
334 #define RADIOLIB_CC1101_BS_POST_KP_1 0b00000100
335 #define RADIOLIB_CC1101_BS_LIMIT_NO_COMPENSATION 0b00000000
336 #define RADIOLIB_CC1101_BS_LIMIT_3_125 0b00000001
337 #define RADIOLIB_CC1101_BS_LIMIT_6_25 0b00000010
338 #define RADIOLIB_CC1101_BS_LIMIT_12_5 0b00000011
341 #define RADIOLIB_CC1101_MAX_DVGA_GAIN_0 0b00000000
342 #define RADIOLIB_CC1101_MAX_DVGA_GAIN_1 0b01000000
343 #define RADIOLIB_CC1101_MAX_DVGA_GAIN_2 0b10000000
344 #define RADIOLIB_CC1101_MAX_DVGA_GAIN_3 0b11000000
345 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_0_DB 0b00000000
346 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_2_6_DB 0b00001000
347 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_6_1_DB 0b00010000
348 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_7_4_DB 0b00011000
349 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_9_2_DB 0b00100000
350 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_11_5_DB 0b00101000
351 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_14_6_DB 0b00110000
352 #define RADIOLIB_CC1101_LNA_GAIN_REDUCE_17_1_DB 0b00111000
353 #define RADIOLIB_CC1101_MAGN_TARGET_24_DB 0b00000000
354 #define RADIOLIB_CC1101_MAGN_TARGET_27_DB 0b00000001
355 #define RADIOLIB_CC1101_MAGN_TARGET_30_DB 0b00000010
356 #define RADIOLIB_CC1101_MAGN_TARGET_33_DB 0b00000011
357 #define RADIOLIB_CC1101_MAGN_TARGET_36_DB 0b00000100
358 #define RADIOLIB_CC1101_MAGN_TARGET_38_DB 0b00000101
359 #define RADIOLIB_CC1101_MAGN_TARGET_40_DB 0b00000110
360 #define RADIOLIB_CC1101_MAGN_TARGET_42_DB 0b00000111
363 #define RADIOLIB_CC1101_AGC_LNA_PRIORITY_LNA2 0b00000000
364 #define RADIOLIB_CC1101_AGC_LNA_PRIORITY_LNA 0b01000000
365 #define RADIOLIB_CC1101_CARRIER_SENSE_REL_THR_OFF 0b00000000
366 #define RADIOLIB_CC1101_CARRIER_SENSE_REL_THR_6_DB 0b00010000
367 #define RADIOLIB_CC1101_CARRIER_SENSE_REL_THR_10_DB 0b00100000
368 #define RADIOLIB_CC1101_CARRIER_SENSE_REL_THR_14_DB 0b00110000
369 #define RADIOLIB_CC1101_CARRIER_SENSE_ABS_THR 0x00
372 #define RADIOLIB_CC1101_HYST_LEVEL_NONE 0b00000000
373 #define RADIOLIB_CC1101_HYST_LEVEL_LOW 0b01000000
374 #define RADIOLIB_CC1101_HYST_LEVEL_MEDIUM 0b10000000
375 #define RADIOLIB_CC1101_HYST_LEVEL_HIGH 0b11000000
376 #define RADIOLIB_CC1101_WAIT_TIME_8_SAMPLES 0b00000000
377 #define RADIOLIB_CC1101_WAIT_TIME_16_SAMPLES 0b00010000
378 #define RADIOLIB_CC1101_WAIT_TIME_24_SAMPLES 0b00100000
379 #define RADIOLIB_CC1101_WAIT_TIME_32_SAMPLES 0b00110000
380 #define RADIOLIB_CC1101_AGC_FREEZE_NEVER 0b00000000
381 #define RADIOLIB_CC1101_AGC_FREEZE_SYNC_WORD 0b00000100
382 #define RADIOLIB_CC1101_AGC_FREEZE_MANUAL_A 0b00001000
383 #define RADIOLIB_CC1101_AGC_FREEZE_MANUAL_AD 0b00001100
384 #define RADIOLIB_CC1101_FILTER_LENGTH_8 0b00000000
385 #define RADIOLIB_CC1101_FILTER_LENGTH_16 0b00000001
386 #define RADIOLIB_CC1101_FILTER_LENGTH_32 0b00000010
387 #define RADIOLIB_CC1101_FILTER_LENGTH_64 0b00000011
388 #define RADIOLIB_CC1101_ASK_OOK_BOUNDARY_4_DB 0b00000000
389 #define RADIOLIB_CC1101_ASK_OOK_BOUNDARY_8_DB 0b00000001
390 #define RADIOLIB_CC1101_ASK_OOK_BOUNDARY_12_DB 0b00000010
391 #define RADIOLIB_CC1101_ASK_OOK_BOUNDARY_16_DB 0b00000011
394 #define RADIOLIB_CC1101_EVENT0_TIMEOUT_MSB 0x87
395 #define RADIOLIB_CC1101_EVENT0_TIMEOUT_LSB 0x6B
398 #define RADIOLIB_CC1101_RC_POWER_UP 0b00000000
399 #define RADIOLIB_CC1101_RC_POWER_DOWN 0b10000000
400 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_4 0b00000000
401 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_6 0b00010000
402 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_8 0b00100000
403 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_12 0b00110000
404 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_16 0b01000000
405 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_24 0b01010000
406 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_32 0b01100000
407 #define RADIOLIB_CC1101_EVENT1_TIMEOUT_48 0b01110000
408 #define RADIOLIB_CC1101_RC_CAL_OFF 0b00000000
409 #define RADIOLIB_CC1101_RC_CAL_ON 0b00001000
410 #define RADIOLIB_CC1101_WOR_RES_1 0b00000000
411 #define RADIOLIB_CC1101_WOR_RES_2_5 0b00000001
412 #define RADIOLIB_CC1101_WOR_RES_2_10 0b00000010
413 #define RADIOLIB_CC1101_WOR_RES_2_15 0b00000011
416 #define RADIOLIB_CC1101_LNA_CURRENT 0x01
417 #define RADIOLIB_CC1101_LNA2MIX_CURRENT 0x01
418 #define RADIOLIB_CC1101_LODIV_BUF_CURRENT_RX 0x01
419 #define RADIOLIB_CC1101_MIX_CURRENT 0x02
422 #define RADIOLIB_CC1101_LODIV_BUF_CURRENT_TX 0x01
423 #define RADIOLIB_CC1101_PA_POWER 0x00
426 #define RADIOLIB_CC1101_CHP_CURR_CAL_OFF 0b00000000
427 #define RADIOLIB_CC1101_CHP_CURR_CAL_ON 0b00100000
428 #define RADIOLIB_CC1101_FSCAL3 0x09
431 #define RADIOLIB_CC1101_VCO_CORE_LOW 0b00000000
432 #define RADIOLIB_CC1101_VCO_CORE_HIGH 0b00100000
433 #define RADIOLIB_CC1101_FSCAL2 0x0A
436 #define RADIOLIB_CC1101_FSCAL1 0x20
439 #define RADIOLIB_CC1101_FSCAL0 0x0D
442 #define RADIOLIB_CC1101_RCCTRL1 0x41
445 #define RADIOLIB_CC1101_RCCTRL0 0x00
448 #define RADIOLIB_CC1101_TEMP_SENS_IDLE_OFF 0x7F
449 #define RADIOLIB_CC1101_TEMP_SENS_IDLE_ON 0xBF
452 #define RADIOLIB_CC1101_VCO_SEL_CAL_OFF 0b00000000
453 #define RADIOLIB_CC1101_VCO_SEL_CAL_ON 0b00000010
456 #define RADIOLIB_CC1101_PARTNUM 0x00
459 #define RADIOLIB_CC1101_VERSION_CURRENT 0x14
460 #define RADIOLIB_CC1101_VERSION_LEGACY 0x04
461 #define RADIOLIB_CC1101_VERSION_CLONE 0x17
464 #define RADIOLIB_CC1101_MARC_STATE_SLEEP 0x00
465 #define RADIOLIB_CC1101_MARC_STATE_IDLE 0x01
466 #define RADIOLIB_CC1101_MARC_STATE_XOFF 0x02
467 #define RADIOLIB_CC1101_MARC_STATE_VCOON_MC 0x03
468 #define RADIOLIB_CC1101_MARC_STATE_REGON_MC 0x04
469 #define RADIOLIB_CC1101_MARC_STATE_MANCAL 0x05
470 #define RADIOLIB_CC1101_MARC_STATE_VCOON 0x06
471 #define RADIOLIB_CC1101_MARC_STATE_REGON 0x07
472 #define RADIOLIB_CC1101_MARC_STATE_STARTCAL 0x08
473 #define RADIOLIB_CC1101_MARC_STATE_BWBOOST 0x09
474 #define RADIOLIB_CC1101_MARC_STATE_FS_LOCK 0x0A
475 #define RADIOLIB_CC1101_MARC_STATE_IFADCON 0x0B
476 #define RADIOLIB_CC1101_MARC_STATE_ENDCAL 0x0C
477 #define RADIOLIB_CC1101_MARC_STATE_RX 0x0D
478 #define RADIOLIB_CC1101_MARC_STATE_RX_END 0x0E
479 #define RADIOLIB_CC1101_MARC_STATE_RX_RST 0x0F
480 #define RADIOLIB_CC1101_MARC_STATE_TXRX_SWITCH 0x10
481 #define RADIOLIB_CC1101_MARC_STATE_RXFIFO_OVERFLOW 0x11
482 #define RADIOLIB_CC1101_MARC_STATE_FSTXON 0x12
483 #define RADIOLIB_CC1101_MARC_STATE_TX 0x13
484 #define RADIOLIB_CC1101_MARC_STATE_TX_END 0x14
485 #define RADIOLIB_CC1101_MARC_STATE_RXTX_SWITCH 0x15
486 #define RADIOLIB_CC1101_MARC_STATE_TXFIFO_UNDERFLOW 0x16
489 #define RADIOLIB_CC1101_WORTIME_MSB 0x00
490 #define RADIOLIB_CC1101_WORTIME_LSB 0x00
493 #define RADIOLIB_CC1101_CRC_OK 0b10000000
494 #define RADIOLIB_CC1101_CRC_ERROR 0b00000000
495 #define RADIOLIB_CC1101_CS 0b01000000
496 #define RADIOLIB_CC1101_PQT_REACHED 0b00100000
497 #define RADIOLIB_CC1101_CCA 0b00010000
498 #define RADIOLIB_CC1101_SFD 0b00001000
499 #define RADIOLIB_CC1101_GDO2_ACTIVE 0b00000100
500 #define RADIOLIB_CC1101_GDO0_ACTIVE 0b00000001
503 #define RADIOLIB_CC1101_DEFAULT_FREQ 434.0
504 #define RADIOLIB_CC1101_DEFAULT_BR 4.8
505 #define RADIOLIB_CC1101_DEFAULT_FREQDEV 5.0
506 #define RADIOLIB_CC1101_DEFAULT_RXBW 135.0
507 #define RADIOLIB_CC1101_DEFAULT_POWER 10
508 #define RADIOLIB_CC1101_DEFAULT_PREAMBLELEN 16
509 #define RADIOLIB_CC1101_DEFAULT_SW {0x12, 0xAD}
510 #define RADIOLIB_CC1101_DEFAULT_SW_LEN 2
554 float freq = RADIOLIB_CC1101_DEFAULT_FREQ,
555 float br = RADIOLIB_CC1101_DEFAULT_BR,
556 float freqDev = RADIOLIB_CC1101_DEFAULT_FREQDEV,
557 float rxBw = RADIOLIB_CC1101_DEFAULT_RXBW,
558 int8_t power = RADIOLIB_CC1101_DEFAULT_POWER,
559 uint8_t preambleLength = RADIOLIB_CC1101_DEFAULT_PREAMBLELEN);
573 int16_t
transmit(uint8_t* data,
size_t len, uint8_t addr = 0)
override;
585 int16_t
receive(uint8_t* data,
size_t len)
override;
601 int16_t
standby(uint8_t mode)
override;
682 int16_t
startTransmit(uint8_t* data,
size_t len, uint8_t addr = 0)
override;
711 int16_t
startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask,
size_t len);
723 int16_t
readData(uint8_t* data,
size_t len)
override;
794 int16_t
setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
809 int16_t
setSyncWord(uint8_t* syncWord, uint8_t len, uint8_t maxErrBits = 0,
bool requireCarrierSense =
false);
829 int16_t
setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs = 0);
845 int16_t
setOOK(
bool enableOOK);
975 #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
1002 #if !defined(RADIOLIB_GODMODE) && !defined(RADIOLIB_LOW_LEVEL)
1008 int16_t SPIgetRegValue(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);
1009 int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2);
1010 void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);
1011 uint8_t SPIreadRegister(uint8_t reg);
1012 void SPIwriteRegisterBurst(uint8_t reg, uint8_t* data,
size_t len);
1013 void SPIwriteRegister(uint8_t reg, uint8_t data);
1015 void SPIsendCommand(uint8_t cmd);
1017 #if !defined(RADIOLIB_GODMODE)
1021 float _freq = RADIOLIB_CC1101_DEFAULT_FREQ;
1022 float _br = RADIOLIB_CC1101_DEFAULT_BR;
1023 uint8_t _rawRSSI = 0;
1024 uint8_t _rawLQI = 0;
1025 uint8_t _modulation = RADIOLIB_CC1101_MOD_FORMAT_2_FSK;
1027 size_t _packetLength = 0;
1028 bool _packetLengthQueried =
false;
1029 uint8_t _packetLengthConfig = RADIOLIB_CC1101_LENGTH_CONFIG_VARIABLE;
1031 bool _promiscuous =
false;
1033 bool _directMode =
true;
1035 int8_t _power = RADIOLIB_CC1101_DEFAULT_POWER;
1041 int16_t directMode(
bool sync);
1042 static void getExpMant(
float target, uint16_t mantOffset, uint8_t divExp, uint8_t expMax, uint8_t& exp, uint8_t& mant);
1043 int16_t setPacketMode(uint8_t mode, uint16_t len);
Control class for CC1101 module.
Definition: CC1101.h:517
int16_t setDIOMapping(uint32_t pin, uint32_t value)
Configure DIO pin mapping to get a given signal on a DIO pin (if available).
Definition: CC1101.cpp:944
int16_t setFrequencyDeviation(float freqDev) override
Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.
Definition: CC1101.cpp:506
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: CC1101.cpp:774
void readBit(uint32_t pin)
Function to read and process data bit in direct reception mode.
Definition: CC1101.cpp:939
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: CC1101.cpp:165
int16_t setPromiscuousMode(bool promiscuous=true)
Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address,...
Definition: CC1101.cpp:823
int16_t getChipVersion()
Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...
Definition: CC1101.cpp:930
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t setRxBandwidth(float rxBw)
Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.
Definition: CC1101.cpp:485
int16_t packetMode()
Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...
Definition: CC1101.cpp:216
int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)
Sets 16-bit sync word as a two byte value.
Definition: CC1101.cpp:657
float getRSSI()
Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.
Definition: CC1101.cpp:747
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
int16_t disableSyncWordFiltering(bool requireCarrierSense=false)
Disable preamble and sync word filtering and generation.
Definition: CC1101.cpp:809
int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in variable packet length mode.
Definition: CC1101.cpp:792
void setDirectAction(void(*func)(void))
Set interrupt service routine function to call when data bit is receveid in direct mode.
Definition: CC1101.cpp:935
uint8_t getLQI() const
Gets LQI (Link Quality Indicator) of the last received packet.
Definition: CC1101.cpp:770
void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:902
CC1101(Module *module)
Default constructor.
Definition: CC1101.cpp:5
int16_t setNodeAddress(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
Sets node and broadcast addresses. Calling this method will also enable address filtering.
Definition: CC1101.cpp:697
int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)
Enable sync word filtering and generation.
Definition: CC1101.cpp:796
int16_t standby() override
Sets the module to standby mode.
Definition: CC1101.cpp:151
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition: CC1101.cpp:906
uint8_t randomByte()
Get one truly random byte from RSSI noise.
Definition: CC1101.cpp:910
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:145
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464....
Definition: CC1101.cpp:439
int16_t disableAddressFiltering()
Disables address filtering. Calling this method will also erase previously set addresses.
Definition: CC1101.cpp:708
void setGdo0Action(void(*func)(void), uint32_t dir)
Sets interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:223
int16_t receiveDirectAsync()
Starts asynchronous direct mode reception.
Definition: CC1101.cpp:199
int16_t setBitRate(float br)
Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.
Definition: CC1101.cpp:465
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: CC1101.cpp:813
int16_t receiveDirect() override
Starts direct mode reception.
Definition: CC1101.cpp:195
int16_t setEncoding(uint8_t encoding) override
Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER,...
Definition: CC1101.cpp:878
void clearGdo0Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:227
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
int16_t getFrequencyDeviation(float *freqDev)
Gets frequency deviation.
Definition: CC1101.cpp:533
int16_t setOutputPower(int8_t power)
Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.
Definition: CC1101.cpp:558
void clearGdo2Action()
Clears interrupt service routine to call when GDO0 activates.
Definition: CC1101.cpp:239
int16_t setPreambleLength(uint8_t preambleLength)
Sets preamble length.
Definition: CC1101.cpp:662
int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_CC1101_MAX_PACKET_LENGTH)
Set modem in fixed packet length mode.
Definition: CC1101.cpp:788
void setGdo2Action(void(*func)(void), uint32_t dir)
Sets interrupt service routine to call when GDO2 activates.
Definition: CC1101.cpp:231
int16_t setDataShaping(uint8_t sh) override
Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADI...
Definition: CC1101.cpp:859
int16_t begin(float freq=RADIOLIB_CC1101_DEFAULT_FREQ, float br=RADIOLIB_CC1101_DEFAULT_BR, float freqDev=RADIOLIB_CC1101_DEFAULT_FREQDEV, float rxBw=RADIOLIB_CC1101_DEFAULT_RXBW, int8_t power=RADIOLIB_CC1101_DEFAULT_POWER, uint8_t preambleLength=RADIOLIB_CC1101_DEFAULT_PREAMBLELEN)
Initialization method.
Definition: CC1101.cpp:13
bool getPromiscuousMode()
Get whether the modem is in promiscuous mode: no packet filtering (e.g., no preamble,...
Definition: CC1101.cpp:855
int16_t transmitDirectAsync(uint32_t frf=0)
Starts asynchronous direct mode transmission.
Definition: CC1101.cpp:169
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: CC1101.cpp:320
int16_t startReceive()
Interrupt-driven receive method. GDO0 will be activated when full packet is received.
Definition: CC1101.cpp:330
int16_t setOOK(bool enableOOK)
Enables/disables OOK modulation instead of FSK.
Definition: CC1101.cpp:718
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:28
static const size_t RFSWITCH_MAX_PINS
The maximum number of pins supported by the RF switch code.
Definition: Module.h:39
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:205
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:145
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112