-
Notifications
You must be signed in to change notification settings - Fork 1
/
SensorTransmitter.h
368 lines (285 loc) · 13.1 KB
/
SensorTransmitter.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
///////////////////////////////////////////////////////////////////////////////////////////////////
// SensorTransmitter.h
//
// Bresser 5-in-1/6-in-1/7-in-1 868 MHz Sensor Radio Transmitter
// based on CC1101 or SX1276/RFM95W and ESP32/ESP8266
//
// https://github.com/matthias-bs/SensorTransmitter
//
// created: 11/2023
//
//
// MIT License
//
// Copyright (c) 2023 Matthias Prinke
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
// History:
// 20231111 Created based on
// https://github.com/jgromes/RadioLib/blob/master/examples/SX127x/SX127x_Transmit_Blocking/SX127x_Transmit_Blocking.ino
// 20231112 Added utilization of class WeatherSensor
// Added JSON string as payload source
// 20231113 Added JSON string input from serial console
// Added TRANSCEIVER_CHIP
// 20231114 Added enum Encoders
//
// ToDo:
// -
//
///////////////////////////////////////////////////////////////////////////////////////////////////
#if !defined(SENSOR_TRANSMITTER_H)
#define SENSOR_TRANSMITTER_H
#include <Arduino.h>
#define NUM_SENSORS 1 //!< WeatherSensor - no. of sensors
#define WIND_DATA_FLOATINGPOINT //!< WeatherSensor - wind data type
//!< Select one of the following data sources
//#define DATA_RAW //!< payload from raw data
//#define DATA_GEN //!< payload from WeatherSensor::genMessage()
//#define DATA_JSON_CONST //!< payload from JSON constant string
#define DATA_JSON_INPUT //!< payload from JSON serial console input
#define TX_INTERVAL 30 //!< transmit interval in seconds
enum struct Encoders {
ENC_BRESSER_5IN1,
ENC_BRESSER_6IN1,
ENC_BRESSER_7IN1,
ENC_BRESSER_LEAKAGE,
ENC_BRESSER_LIGHTNING
};
// ------------------------------------------------------------------------------------------------
// --- Board ---
// ------------------------------------------------------------------------------------------------
// Use pinning for LoRaWAN Node
// LILIGO TTGO LoRaP32 board with integrated RF tranceiver (SX1276)
// See pin definitions in
// https://github.com/espressif/arduino-esp32/tree/master/variants/ttgo-lora32-*
// and
// https://www.thethingsnetwork.org/forum/t/big-esp32-sx127x-topic-part-2/11973
// This define is set by selecting "Board: TTGO LoRa32-OLED" / "Board Revision: TTGO LoRa32 V1 (No TFCard)"
// in the Arduino IDE:
//#define ARDUINO_TTGO_LoRa32_V1
// This define is set by selecting "Board: TTGO LoRa32-OLED" / "Board Revision: TTGO LoRa32 V2"
// in the Arduino IDE:
//#define ARDUINO_TTGO_LoRa32_V2
// This define is set by selecting "Board: TTGO LoRa32-OLED" / "Board Revision: TTGO LoRa32 V2.1 (1.6.1)"
// in the Arduino IDE:
//#define ARDUINO_TTGO_LoRa32_V21new
// This define is set by selecting "Board: Heltec Wireless Stick"
// in the Arduino IDE:
//#define ARDUINO_heltec_wireless_stick
// This define is set by selecting "Board: Heltec WiFi LoRa 32(V2)"
// in the Adruino IDE:
//#define ARDUINO_heltec_wifi_lora_32_V2
// Adafruit Feather ESP32S2 with RFM95W "FeatherWing" ADA3232
// https://github.com/espressif/arduino-esp32/blob/master/variants/adafruit_feather_esp32s2/pins_arduino.h
//
// This define is set by selecting "Adafruit Feather ESP32-S2" in the Arduino IDE:
//#define ARDUINO_ADAFRUIT_FEATHER_ESP32S2
// Adafruit Feather ESP32 with RFM95W "FeatherWing" ADA3232
// https://github.com/espressif/arduino-esp32/blob/master/variants/feather_esp32/pins_arduino.h
//
// This define is set by selecting "Adafruit ESP32 Feather" in the Arduino IDE:
//#define ARDUINO_FEATHER_ESP32
// Adafruit Feather RP2040 with RFM95W "FeatherWing" ADA3232
// https://github.com/espressif/arduino-esp32/blob/master/variants/feather_esp32/pins_arduino.h
//
// This define is set by selecting "Adafruit Feather RP2040" in the Arduino IDE:
//#define ARDUINO_ADAFRUIT_FEATHER_RP2040
// DFRobot Firebeetle32
// https://github.com/espressif/arduino-esp32/tree/master/variants/firebeetle32/pins_arduino.h
//
// This define (not very specific...) is set by selecting "FireBeetle-ESP32" in the Arduino IDE:
//#define ARDUINO_ESP32_DEV
#if defined(ARDUINO_TTGO_LoRa32_V1)
#pragma message("ARDUINO_TTGO_LoRa32_V1 defined; using on-board transceiver")
#define USE_SX1276
#elif defined(ARDUINO_TTGO_LoRa32_V2)
#pragma message("ARDUINO_TTGO_LoRa32_V2 defined; using on-board transceiver")
#pragma message("LoRa DIO1 must be wired to GPIO33 manually!")
#define USE_SX1276
#elif defined(ARDUINO_TTGO_LoRa32_v21new)
#pragma message("ARDUINO_TTGO_LoRa32_V21new defined; using on-board transceiver")
#define USE_SX1276
#elif defined(ARDUINO_heltec_wireless_stick)
#pragma message("ARDUINO_heltec_wireless_stick defined; using on-board transceiver")
#define USE_SX1276
#elif defined(ARDUINO_heltec_wifi_lora_32_V2)
#pragma message("ARDUINO_heltec_wifi_lora_32_V2 defined; using on-board transceiver")
#define USE_SX1276
#elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2)
#pragma message("ARDUINO_ADAFRUIT_FEATHER_ESP32S2 defined; assuming RFM95W FeatherWing will be used")
#define USE_SX1276
#elif defined(ARDUINO_FEATHER_ESP32)
#pragma message("ARDUINO_FEATHER_ESP32 defined; assuming RFM95W FeatherWing will be used")
#define USE_SX1276
#pragma message("Required wiring: A to RST, B to DIO1, D to DIO0, E to CS")
#elif defined(ARDUINO_AVR_FEATHER32U4)
#pragma message("ARDUINO_AVR_FEATHER32U4 defined; assuming this is the Adafruit Feather 32u4 RFM95 LoRa Radio")
#define USE_SX1276
#elif defined(ARDUINO_ADAFRUIT_FEATHER_RP2040)
#pragma message("ARDUINO_ADAFRUIT_FEATHER_RP2040 defined; assuming assuming RFM95W FeatherWing will be used")
#define USE_SX1276
#pragma message("Required wiring: A to RST, B to DIO1, D to DIO0, E to CS")
#elif defined(ARDUINO_ESP32_DEV)
//#define LORAWAN_NODE
#define FIREBEETLE_ESP32_COVER_LORA
#if defined(FIREBEETLE_ESP32_COVER_LORA)
#pragma message("FIREBEETLE_ESP32_COVER_LORA defined; assuming this is a FireBeetle ESP32 with FireBeetle Cover LoRa")
#define USE_SX1276
#pragma message("Required wiring: D2 to RESET, D3 to DIO0, D4 to CS, D5 to DIO1")
#elif defined(LORAWAN_NODE)
#pragma message("LORAWAN_NODE defined; assuming this is the LoRaWAN_Node board (DFRobot Firebeetle32 + Adafruit RFM95W LoRa Radio)")
#define USE_SX1276
#else
#pragma message("ARDUINO_ESP32_DEV defined; select either LORAWAN_NODE or FIREBEETLE_ESP32_COVER_LORA manually!")
#endif
#endif
// ------------------------------------------------------------------------------------------------
// --- Radio Transceiver ---
// ------------------------------------------------------------------------------------------------
// Select type of receiver module (if not yet defined based on the assumptions above)
#if ( !defined(USE_CC1101) && !defined(USE_SX1276) )
#define USE_CC1101
//#define USE_SX1276
#endif
#if ( (defined(USE_CC1101) && defined(USE_SX1276)) || \
(defined(USE_SX1276) && defined(USE_SX1262)) || \
(defined(USE_SX1262) && defined(USE_CC1101)) )
#error "Either USE_CC1101 OR USE_SX1276 OR USE_SX1262 must be defined!"
#endif
#if defined(USE_CC1101)
#define TRANSCEIVER_CHIP "[CC1101]"
#elif defined(USE_SX1276)
#define TRANSCEIVER_CHIP "[SX1276]"
#elif defined(USE_SX1262)
#define TRANSCEIVER_CHIP "[SX1262]"
#else
#error "Either USE_CC1101, USE_SX1276 or USE_SX1262 must be defined!"
#endif
// Arduino default SPI pins
//
// Board SCK MOSI MISO
// ESP8266 D5 D7 D6
// ESP32 D18 D23 D19
#if defined(LORAWAN_NODE)
// Use pinning for LoRaWAN_Node (https://github.com/matthias-bs/LoRaWAN_Node)
#define PIN_TRANSCEIVER_CS 14
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 4
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 16
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 12
#elif defined(FIREBEETLE_ESP32_COVER_LORA)
#define PIN_TRANSCEIVER_CS 27 // D4
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 26 // D3
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 9 // D5
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 25 // D2
#elif defined(ARDUINO_TTGO_LoRa32_V1) || defined(ARDUINO_TTGO_LoRa32_V2)
// Use pinning for LILIGO TTGO LoRa32-OLED
#define PIN_TRANSCEIVER_CS LORA_CS
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ LORA_IRQ
// CC1101: GDO2 / RFM95W/SX127x: G1
// n.c. on v1/v2?, LORA_D1 on v21
#define PIN_TRANSCEIVER_GPIO 33
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST LORA_RST
#elif defined(ARDUINO_TTGO_LoRa32_v21new)
// Use pinning for LILIGO TTGO LoRa32-OLED V2.1 (1.6.1)
// Same pinout for Heltec Wireless Stick
#define PIN_TRANSCEIVER_CS LORA_CS
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ LORA_IRQ
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO LORA_D1
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST LORA_RST
#elif defined(ARDUINO_heltec_wireless_stick) || defined(ARDUINO_heltec_wifi_lora_32_V2)
// Use pinning for Heltec Wireless Stick or WiFi LoRa32 V2, respectively
#define PIN_TRANSCEIVER_CS SS
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ DIO0
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO DIO1
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST RST_LoRa
#elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2)
// Use pinning for Adafruit Feather ESP32S2 with RFM95W "FeatherWing" ADA3232
#define PIN_TRANSCEIVER_CS 6
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 5
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 11
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 9
#elif defined(ARDUINO_FEATHER_ESP32)
// Use pinning for Adafruit Feather ESP32 with RFM95W "FeatherWing" ADA3232
#define PIN_TRANSCEIVER_CS 14
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 32
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 33
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 27
#elif defined(ESP32)
// Generic pinning for ESP32 development boards
#define PIN_TRANSCEIVER_CS 27
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 21
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 33
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 32
#elif defined(ESP8266)
// Generic pinning for ESP8266 development boards (e.g. LOLIN/WEMOS D1 mini)
#define PIN_TRANSCEIVER_CS 15
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 4
// CC1101: GDO2 / RFM95W/SX127x: G1
#define PIN_TRANSCEIVER_GPIO 5
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 2
#elif defined(ARDUINO_AVR_FEATHER32U4)
// Pinning for Adafruit Feather 32u4
#define PIN_TRANSCEIVER_CS 8
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 7
// CC1101: GDO2 / RFM95W/SX127x: G1 (not used)
#define PIN_TRANSCEIVER_GPIO 99
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 4
#elif defined(ARDUINO_ADAFRUIT_FEATHER_RP2040)
// Use pinning for Adafruit Feather RP2040 with RFM95W "FeatherWing" ADA3232
#define PIN_TRANSCEIVER_CS 7
// CC1101: GDO0 / RFM95W/SX127x: G0
#define PIN_TRANSCEIVER_IRQ 8
// CC1101: GDO2 / RFM95W/SX127x: G1 (not used)
#define PIN_TRANSCEIVER_GPIO 10
// RFM95W/SX127x - GPIOxx / CC1101 - RADIOLIB_NC
#define PIN_TRANSCEIVER_RST 11
#endif
#define STR_HELPER(x) #x
#define STR(x) STR_HELPER(x)
#pragma message("Transmitter chip: " TRANSCEIVER_CHIP)
#pragma message("Pin config: RST->" STR(PIN_TRANSCEIVER_RST) ", CS->" STR(PIN_TRANSCEIVER_CS) ", GD0/G0/IRQ->" STR(PIN_TRANSCEIVER_IRQ) ", GDO2/G1/GPIO->" STR(PIN_TRANSCEIVER_GPIO) )
#endif