diff --git a/html/_wipper_snapper___i2_c_8h.html b/html/_wipper_snapper___i2_c_8h.html index 64efd0790..32aa79a6c 100644 --- a/html/_wipper_snapper___i2_c_8h.html +++ b/html/_wipper_snapper___i2_c_8h.html @@ -106,6 +106,7 @@ #include "drivers/WipperSnapper_I2C_Driver_SCD30.h"
#include "drivers/WipperSnapper_I2C_Driver_SCD4X.h"
#include "drivers/WipperSnapper_I2C_Driver_SEN5X.h"
+#include "drivers/WipperSnapper_I2C_Driver_SEN6X.h"
#include "drivers/WipperSnapper_I2C_Driver_SGP30.h"
#include "drivers/WipperSnapper_I2C_Driver_SGP40.h"
#include "drivers/WipperSnapper_I2C_Driver_SHT3X.h"
@@ -117,6 +118,7 @@ #include "drivers/WipperSnapper_I2C_Driver_TSL2591.h"
#include "drivers/WipperSnapper_I2C_Driver_VCNL4020.h"
#include "drivers/WipperSnapper_I2C_Driver_VCNL4040.h"
+#include "drivers/WipperSnapper_I2C_Driver_VCNL4200.h"
#include "drivers/WipperSnapper_I2C_Driver_VEML7700.h"
#include "drivers/WipperSnapper_I2C_Driver_VL53L0X.h"
#include "drivers/WipperSnapper_I2C_Driver_VL53L1X.h"
diff --git a/html/_wipper_snapper___i2_c_8h_source.html b/html/_wipper_snapper___i2_c_8h_source.html index 9bdf4d2d6..57d1a508f 100644 --- a/html/_wipper_snapper___i2_c_8h_source.html +++ b/html/_wipper_snapper___i2_c_8h_source.html @@ -66,7 +66,7 @@
WipperSnapper_I2C.h
-Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_Component_I2C_H
17 #define WipperSnapper_Component_I2C_H
18 
19 #include "Wippersnapper.h"
20 #include <Wire.h>
21 
22 #include "drivers/WipperSnapper_I2C_Driver.h"
23 #include "drivers/WipperSnapper_I2C_Driver_ADT7410.h"
24 #include "drivers/WipperSnapper_I2C_Driver_AHTX0.h"
25 #include "drivers/WipperSnapper_I2C_Driver_BH1750.h"
26 #include "drivers/WipperSnapper_I2C_Driver_BME280.h"
27 #include "drivers/WipperSnapper_I2C_Driver_BME680.h"
28 #include "drivers/WipperSnapper_I2C_Driver_BMP280.h"
29 #include "drivers/WipperSnapper_I2C_Driver_BMP3XX.h"
30 #include "drivers/WipperSnapper_I2C_Driver_DPS310.h"
31 #include "drivers/WipperSnapper_I2C_Driver_DS2484.h"
32 #include "drivers/WipperSnapper_I2C_Driver_ENS160.h"
33 #include "drivers/WipperSnapper_I2C_Driver_HDC302X.h"
34 #include "drivers/WipperSnapper_I2C_Driver_HTS221.h"
35 #include "drivers/WipperSnapper_I2C_Driver_HTU21D.h"
36 #include "drivers/WipperSnapper_I2C_Driver_HTU31D.h"
37 #include "drivers/WipperSnapper_I2C_Driver_INA219.h"
38 #include "drivers/WipperSnapper_I2C_Driver_LC709203F.h"
39 #include "drivers/WipperSnapper_I2C_Driver_LPS22HB.h"
40 #include "drivers/WipperSnapper_I2C_Driver_LPS25HB.h"
41 #include "drivers/WipperSnapper_I2C_Driver_LPS3XHW.h"
42 #include "drivers/WipperSnapper_I2C_Driver_LTR329_LTR303.h"
43 #include "drivers/WipperSnapper_I2C_Driver_LTR390.h"
44 #include "drivers/WipperSnapper_I2C_Driver_MAX17048.h"
45 #include "drivers/WipperSnapper_I2C_Driver_MCP3421.h"
46 #include "drivers/WipperSnapper_I2C_Driver_MCP9808.h"
47 #include "drivers/WipperSnapper_I2C_Driver_MPL115A2.h"
48 #include "drivers/WipperSnapper_I2C_Driver_MPRLS.h"
49 #include "drivers/WipperSnapper_I2C_Driver_MS8607.h"
50 #include "drivers/WipperSnapper_I2C_Driver_NAU7802.h"
51 #include "drivers/WipperSnapper_I2C_Driver_PCT2075.h"
52 #include "drivers/WipperSnapper_I2C_Driver_PM25.h"
53 #include "drivers/WipperSnapper_I2C_Driver_SCD30.h"
54 #include "drivers/WipperSnapper_I2C_Driver_SCD4X.h"
55 #include "drivers/WipperSnapper_I2C_Driver_SEN5X.h"
56 #include "drivers/WipperSnapper_I2C_Driver_SGP30.h"
57 #include "drivers/WipperSnapper_I2C_Driver_SGP40.h"
58 #include "drivers/WipperSnapper_I2C_Driver_SHT3X.h"
59 #include "drivers/WipperSnapper_I2C_Driver_SHT4X.h"
60 #include "drivers/WipperSnapper_I2C_Driver_SHTC3.h"
61 #include "drivers/WipperSnapper_I2C_Driver_SI7021.h"
62 #include "drivers/WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor.h"
63 #include "drivers/WipperSnapper_I2C_Driver_TMP117.h"
64 #include "drivers/WipperSnapper_I2C_Driver_TSL2591.h"
65 #include "drivers/WipperSnapper_I2C_Driver_VCNL4020.h"
66 #include "drivers/WipperSnapper_I2C_Driver_VCNL4040.h"
67 #include "drivers/WipperSnapper_I2C_Driver_VEML7700.h"
68 #include "drivers/WipperSnapper_I2C_Driver_VL53L0X.h"
69 #include "drivers/WipperSnapper_I2C_Driver_VL53L1X.h"
70 #include "drivers/WipperSnapper_I2C_Driver_VL53L4CD.h"
71 #include "drivers/WipperSnapper_I2C_Driver_VL53L4CX.h"
72 #include "drivers/WipperSnapper_I2C_Driver_VL6180X.h"
73 
74 #define I2C_TIMEOUT_MS 50
75 
76 // forward decl.
77 class Wippersnapper;
78 
79 /**************************************************************************/
83 /**************************************************************************/
84 class WipperSnapper_Component_I2C {
85 public:
86  WipperSnapper_Component_I2C(
87  wippersnapper_i2c_v1_I2CBusInitRequest *msgInitRequest);
88  ~WipperSnapper_Component_I2C();
89  bool isInitialized();
90  wippersnapper_i2c_v1_BusResponse getBusStatus();
91 
92  wippersnapper_i2c_v1_I2CBusScanResponse scanAddresses();
93  bool
94  initI2CDevice(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq);
95 
96  void updateI2CDeviceProperties(
97  wippersnapper_i2c_v1_I2CDeviceUpdateRequest *msgDeviceUpdateReq);
98  void deinitI2CDevice(
99  wippersnapper_i2c_v1_I2CDeviceDeinitRequest *msgDeviceDeinitReq);
100 
101  void update();
102 
103  void sensorEventRead(
104  std::vector<WipperSnapper_I2C_Driver *>::iterator &iter,
105  unsigned long curTime,
106  wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
107  bool (WipperSnapper_I2C_Driver::*getEventFunc)(sensors_event_t *),
108  long (WipperSnapper_I2C_Driver::*getPeriodFunc)(),
109  long (WipperSnapper_I2C_Driver::*getPeriodPrvFunc)(),
110  void (WipperSnapper_I2C_Driver::*setPeriodPrvFunc)(long),
111  wippersnapper_i2c_v1_SensorType sensorType, const char *sensorName,
112  const char *unit, sensors_event_t event,
113  float sensors_event_t::*valueMember, bool &sensorsReturningFalse,
114  int &retries);
115 
116  void fillEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
117  float value,
118  wippersnapper_i2c_v1_SensorType sensorType);
119 
120  void
121  displayDeviceEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
122  uint32_t sensorAddress);
123 
124  bool encodePublishI2CDeviceEventMsg(
125  wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
126  uint32_t sensorAddress);
127 
128 private:
129  bool _isInit = false;
130  int32_t _portNum;
131  TwoWire *_i2c = nullptr;
132  wippersnapper_i2c_v1_BusResponse _busStatusResponse;
133  std::vector<WipperSnapper_I2C_Driver *> drivers;
134  // Sensor driver objects
135  WipperSnapper_I2C_Driver_AHTX0 *_ahtx0 = nullptr;
136  WipperSnapper_I2C_Driver_DPS310 *_dps310 = nullptr;
137  WipperSnapper_I2C_Driver_DS2484 *_ds2484 = nullptr;
138  WipperSnapper_I2C_Driver_ENS160 *_ens160 = nullptr;
139  WipperSnapper_I2C_Driver_SCD30 *_scd30 = nullptr;
140  WipperSnapper_I2C_Driver_BH1750 *_bh1750 = nullptr;
141  WipperSnapper_I2C_Driver_BME280 *_bme280 = nullptr;
142  WipperSnapper_I2C_Driver_BMP280 *_bmp280 = nullptr;
143  WipperSnapper_I2C_Driver_BMP3XX *_bmp3xx = nullptr;
144  WipperSnapper_I2C_Driver_BME680 *_bme680 = nullptr;
145  WipperSnapper_I2C_Driver_HDC302X *_hdc302x = nullptr;
146  WipperSnapper_I2C_Driver_HTS221 *_hts221 = nullptr;
147  WipperSnapper_I2C_Driver_HTU21D *_htu21d = nullptr;
148  WipperSnapper_I2C_Driver_HTU31D *_htu31d = nullptr;
149  WipperSnapper_I2C_Driver_INA219 *_ina219 = nullptr;
150  WipperSnapper_I2C_Driver_LTR329_LTR303 *_ltr329 = nullptr;
151  WipperSnapper_I2C_Driver_LTR390 *_ltr390 = nullptr;
152  WipperSnapper_I2C_Driver_MCP3421 *_mcp3421 = nullptr;
153  WipperSnapper_I2C_Driver_MCP9808 *_mcp9808 = nullptr;
154  WipperSnapper_I2C_Driver_MPL115A2 *_mpl115a2 = nullptr;
155  WipperSnapper_I2C_Driver_MPRLS *_mprls = nullptr;
156  WipperSnapper_I2C_Driver_MS8607 *_ms8607 = nullptr;
157  WipperSnapper_I2C_Driver_NAU7802 *_nau7802 = nullptr;
158  WipperSnapper_I2C_Driver_TMP117 *_tmp117 = nullptr;
159  WipperSnapper_I2C_Driver_TSL2591 *_tsl2591 = nullptr;
160  WipperSnapper_I2C_Driver_VCNL4020 *_vcnl4020 = nullptr;
161  WipperSnapper_I2C_Driver_VCNL4040 *_vcnl4040 = nullptr;
162  WipperSnapper_I2C_Driver_VEML7700 *_veml7700 = nullptr;
163  WipperSnapper_I2C_Driver_SCD4X *_scd40 = nullptr;
164  WipperSnapper_I2C_Driver_SEN5X *_sen5x = nullptr;
165  WipperSnapper_I2C_Driver_SGP30 *_sgp30 = nullptr;
166  WipperSnapper_I2C_Driver_SGP40 *_sgp40 = nullptr;
167  WipperSnapper_I2C_Driver_PCT2075 *_pct2075 = nullptr;
168  WipperSnapper_I2C_Driver_PM25 *_pm25 = nullptr;
169  WipperSnapper_I2C_Driver_SI7021 *_si7021 = nullptr;
170  WipperSnapper_I2C_Driver_SHT4X *_sht4x = nullptr;
171  WipperSnapper_I2C_Driver_SHT3X *_sht3x = nullptr;
172  WipperSnapper_I2C_Driver_SHTC3 *_shtc3 = nullptr;
173  WipperSnapper_I2C_Driver_LC709203F *_lc = nullptr;
174  WipperSnapper_I2C_Driver_LPS22HB *_lps22hb = nullptr;
175  WipperSnapper_I2C_Driver_LPS25HB *_lps25hb = nullptr;
176  WipperSnapper_I2C_Driver_LPS3XHW *_lps3xhw = nullptr;
177  WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor *_ss = nullptr;
178  WipperSnapper_I2C_Driver_VL53L0X *_vl53l0x = nullptr;
179  WipperSnapper_I2C_Driver_VL53L1X *_vl53l1x = nullptr;
180  WipperSnapper_I2C_Driver_VL53L4CD *_vl53l4cd = nullptr;
181  WipperSnapper_I2C_Driver_VL53L4CX *_vl53l4cx = nullptr;
182  WipperSnapper_I2C_Driver_VL6180X *_vl6180x = nullptr;
183  WipperSnapper_I2C_Driver_MAX17048 *_max17048 = nullptr;
184  WipperSnapper_I2C_Driver_ADT7410 *_adt7410 = nullptr;
185 };
186 extern Wippersnapper WS;
187 
188 #endif // WipperSnapper_Component_I2C_H
WipperSnapper_Component_I2C
Class that provides an interface with the I2C bus.
Definition: WipperSnapper_I2C.h:84
+Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_Component_I2C_H
17 #define WipperSnapper_Component_I2C_H
18 
19 #include "Wippersnapper.h"
20 #include <Wire.h>
21 
22 #include "drivers/WipperSnapper_I2C_Driver.h"
23 #include "drivers/WipperSnapper_I2C_Driver_ADT7410.h"
24 #include "drivers/WipperSnapper_I2C_Driver_AHTX0.h"
25 #include "drivers/WipperSnapper_I2C_Driver_BH1750.h"
26 #include "drivers/WipperSnapper_I2C_Driver_BME280.h"
27 #include "drivers/WipperSnapper_I2C_Driver_BME680.h"
28 #include "drivers/WipperSnapper_I2C_Driver_BMP280.h"
29 #include "drivers/WipperSnapper_I2C_Driver_BMP3XX.h"
30 #include "drivers/WipperSnapper_I2C_Driver_DPS310.h"
31 #include "drivers/WipperSnapper_I2C_Driver_DS2484.h"
32 #include "drivers/WipperSnapper_I2C_Driver_ENS160.h"
33 #include "drivers/WipperSnapper_I2C_Driver_HDC302X.h"
34 #include "drivers/WipperSnapper_I2C_Driver_HTS221.h"
35 #include "drivers/WipperSnapper_I2C_Driver_HTU21D.h"
36 #include "drivers/WipperSnapper_I2C_Driver_HTU31D.h"
37 #include "drivers/WipperSnapper_I2C_Driver_INA219.h"
38 #include "drivers/WipperSnapper_I2C_Driver_LC709203F.h"
39 #include "drivers/WipperSnapper_I2C_Driver_LPS22HB.h"
40 #include "drivers/WipperSnapper_I2C_Driver_LPS25HB.h"
41 #include "drivers/WipperSnapper_I2C_Driver_LPS3XHW.h"
42 #include "drivers/WipperSnapper_I2C_Driver_LTR329_LTR303.h"
43 #include "drivers/WipperSnapper_I2C_Driver_LTR390.h"
44 #include "drivers/WipperSnapper_I2C_Driver_MAX17048.h"
45 #include "drivers/WipperSnapper_I2C_Driver_MCP3421.h"
46 #include "drivers/WipperSnapper_I2C_Driver_MCP9808.h"
47 #include "drivers/WipperSnapper_I2C_Driver_MPL115A2.h"
48 #include "drivers/WipperSnapper_I2C_Driver_MPRLS.h"
49 #include "drivers/WipperSnapper_I2C_Driver_MS8607.h"
50 #include "drivers/WipperSnapper_I2C_Driver_NAU7802.h"
51 #include "drivers/WipperSnapper_I2C_Driver_PCT2075.h"
52 #include "drivers/WipperSnapper_I2C_Driver_PM25.h"
53 #include "drivers/WipperSnapper_I2C_Driver_SCD30.h"
54 #include "drivers/WipperSnapper_I2C_Driver_SCD4X.h"
55 #include "drivers/WipperSnapper_I2C_Driver_SEN5X.h"
56 #include "drivers/WipperSnapper_I2C_Driver_SEN6X.h"
57 #include "drivers/WipperSnapper_I2C_Driver_SGP30.h"
58 #include "drivers/WipperSnapper_I2C_Driver_SGP40.h"
59 #include "drivers/WipperSnapper_I2C_Driver_SHT3X.h"
60 #include "drivers/WipperSnapper_I2C_Driver_SHT4X.h"
61 #include "drivers/WipperSnapper_I2C_Driver_SHTC3.h"
62 #include "drivers/WipperSnapper_I2C_Driver_SI7021.h"
63 #include "drivers/WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor.h"
64 #include "drivers/WipperSnapper_I2C_Driver_TMP117.h"
65 #include "drivers/WipperSnapper_I2C_Driver_TSL2591.h"
66 #include "drivers/WipperSnapper_I2C_Driver_VCNL4020.h"
67 #include "drivers/WipperSnapper_I2C_Driver_VCNL4040.h"
68 #include "drivers/WipperSnapper_I2C_Driver_VCNL4200.h"
69 #include "drivers/WipperSnapper_I2C_Driver_VEML7700.h"
70 #include "drivers/WipperSnapper_I2C_Driver_VL53L0X.h"
71 #include "drivers/WipperSnapper_I2C_Driver_VL53L1X.h"
72 #include "drivers/WipperSnapper_I2C_Driver_VL53L4CD.h"
73 #include "drivers/WipperSnapper_I2C_Driver_VL53L4CX.h"
74 #include "drivers/WipperSnapper_I2C_Driver_VL6180X.h"
75 
76 #define I2C_TIMEOUT_MS 50
77 
78 // forward decl.
79 class Wippersnapper;
80 
81 /**************************************************************************/
85 /**************************************************************************/
86 class WipperSnapper_Component_I2C {
87 public:
88  WipperSnapper_Component_I2C(
89  wippersnapper_i2c_v1_I2CBusInitRequest *msgInitRequest);
90  ~WipperSnapper_Component_I2C();
91  bool isInitialized();
92  wippersnapper_i2c_v1_BusResponse getBusStatus();
93 
94  wippersnapper_i2c_v1_I2CBusScanResponse scanAddresses();
95  bool
96  initI2CDevice(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq);
97 
98  void updateI2CDeviceProperties(
99  wippersnapper_i2c_v1_I2CDeviceUpdateRequest *msgDeviceUpdateReq);
100  void deinitI2CDevice(
101  wippersnapper_i2c_v1_I2CDeviceDeinitRequest *msgDeviceDeinitReq);
102 
103  void update();
104 
105  void sensorEventRead(
106  std::vector<WipperSnapper_I2C_Driver *>::iterator &iter,
107  unsigned long curTime,
108  wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
109  bool (WipperSnapper_I2C_Driver::*getEventFunc)(sensors_event_t *),
110  long (WipperSnapper_I2C_Driver::*getPeriodFunc)(),
111  long (WipperSnapper_I2C_Driver::*getPeriodPrvFunc)(),
112  void (WipperSnapper_I2C_Driver::*setPeriodPrvFunc)(long),
113  wippersnapper_i2c_v1_SensorType sensorType, const char *sensorName,
114  const char *unit, sensors_event_t event,
115  float sensors_event_t::*valueMember, bool &sensorsReturningFalse,
116  int &retries);
117 
118  void fillEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
119  float value,
120  wippersnapper_i2c_v1_SensorType sensorType);
121 
122  void
123  displayDeviceEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
124  uint32_t sensorAddress);
125 
126  bool encodePublishI2CDeviceEventMsg(
127  wippersnapper_signal_v1_I2CResponse *msgi2cResponse,
128  uint32_t sensorAddress);
129 
130 private:
131  bool _isInit = false;
132  int32_t _portNum;
133  TwoWire *_i2c = nullptr;
134  wippersnapper_i2c_v1_BusResponse _busStatusResponse;
135  std::vector<WipperSnapper_I2C_Driver *> drivers;
136  // Sensor driver objects
137  WipperSnapper_I2C_Driver_AHTX0 *_ahtx0 = nullptr;
138  WipperSnapper_I2C_Driver_DPS310 *_dps310 = nullptr;
139  WipperSnapper_I2C_Driver_DS2484 *_ds2484 = nullptr;
140  WipperSnapper_I2C_Driver_ENS160 *_ens160 = nullptr;
141  WipperSnapper_I2C_Driver_SCD30 *_scd30 = nullptr;
142  WipperSnapper_I2C_Driver_BH1750 *_bh1750 = nullptr;
143  WipperSnapper_I2C_Driver_BME280 *_bme280 = nullptr;
144  WipperSnapper_I2C_Driver_BMP280 *_bmp280 = nullptr;
145  WipperSnapper_I2C_Driver_BMP3XX *_bmp3xx = nullptr;
146  WipperSnapper_I2C_Driver_BME680 *_bme680 = nullptr;
147  WipperSnapper_I2C_Driver_HDC302X *_hdc302x = nullptr;
148  WipperSnapper_I2C_Driver_HTS221 *_hts221 = nullptr;
149  WipperSnapper_I2C_Driver_HTU21D *_htu21d = nullptr;
150  WipperSnapper_I2C_Driver_HTU31D *_htu31d = nullptr;
151  WipperSnapper_I2C_Driver_INA219 *_ina219 = nullptr;
152  WipperSnapper_I2C_Driver_LTR329_LTR303 *_ltr329 = nullptr;
153  WipperSnapper_I2C_Driver_LTR390 *_ltr390 = nullptr;
154  WipperSnapper_I2C_Driver_MCP3421 *_mcp3421 = nullptr;
155  WipperSnapper_I2C_Driver_MCP9808 *_mcp9808 = nullptr;
156  WipperSnapper_I2C_Driver_MPL115A2 *_mpl115a2 = nullptr;
157  WipperSnapper_I2C_Driver_MPRLS *_mprls = nullptr;
158  WipperSnapper_I2C_Driver_MS8607 *_ms8607 = nullptr;
159  WipperSnapper_I2C_Driver_NAU7802 *_nau7802 = nullptr;
160  WipperSnapper_I2C_Driver_TMP117 *_tmp117 = nullptr;
161  WipperSnapper_I2C_Driver_TSL2591 *_tsl2591 = nullptr;
162  WipperSnapper_I2C_Driver_VCNL4020 *_vcnl4020 = nullptr;
163  WipperSnapper_I2C_Driver_VCNL4040 *_vcnl4040 = nullptr;
164  WipperSnapper_I2C_Driver_VCNL4200 *_vcnl4200 = nullptr;
165  WipperSnapper_I2C_Driver_VEML7700 *_veml7700 = nullptr;
166  WipperSnapper_I2C_Driver_SCD4X *_scd40 = nullptr;
167  WipperSnapper_I2C_Driver_SEN5X *_sen5x = nullptr;
168  WipperSnapper_I2C_Driver_SEN6X *_sen6x = nullptr;
169  WipperSnapper_I2C_Driver_SGP30 *_sgp30 = nullptr;
170  WipperSnapper_I2C_Driver_SGP40 *_sgp40 = nullptr;
171  WipperSnapper_I2C_Driver_PCT2075 *_pct2075 = nullptr;
172  WipperSnapper_I2C_Driver_PM25 *_pm25 = nullptr;
173  WipperSnapper_I2C_Driver_SI7021 *_si7021 = nullptr;
174  WipperSnapper_I2C_Driver_SHT4X *_sht4x = nullptr;
175  WipperSnapper_I2C_Driver_SHT3X *_sht3x = nullptr;
176  WipperSnapper_I2C_Driver_SHTC3 *_shtc3 = nullptr;
177  WipperSnapper_I2C_Driver_LC709203F *_lc = nullptr;
178  WipperSnapper_I2C_Driver_LPS22HB *_lps22hb = nullptr;
179  WipperSnapper_I2C_Driver_LPS25HB *_lps25hb = nullptr;
180  WipperSnapper_I2C_Driver_LPS3XHW *_lps3xhw = nullptr;
181  WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor *_ss = nullptr;
182  WipperSnapper_I2C_Driver_VL53L0X *_vl53l0x = nullptr;
183  WipperSnapper_I2C_Driver_VL53L1X *_vl53l1x = nullptr;
184  WipperSnapper_I2C_Driver_VL53L4CD *_vl53l4cd = nullptr;
185  WipperSnapper_I2C_Driver_VL53L4CX *_vl53l4cx = nullptr;
186  WipperSnapper_I2C_Driver_VL6180X *_vl6180x = nullptr;
187  WipperSnapper_I2C_Driver_MAX17048 *_max17048 = nullptr;
188  WipperSnapper_I2C_Driver_ADT7410 *_adt7410 = nullptr;
189 };
190 extern Wippersnapper WS;
191 
192 #endif // WipperSnapper_Component_I2C_H
WipperSnapper_Component_I2C
Class that provides an interface with the I2C bus.
Definition: WipperSnapper_I2C.h:86
WipperSnapper_I2C_Driver_SCD30
Class that provides a driver interface for the SCD30 sensor.
Definition: WipperSnapper_I2C_Driver_SCD30.h:27
WipperSnapper_I2C_Driver_MS8607
Class that provides a sensor driver for the MS8607 PHT sensor.
Definition: WipperSnapper_I2C_Driver_MS8607.h:27
WipperSnapper_I2C_Driver_LPS3XHW.h
@@ -75,13 +75,14 @@
WipperSnapper_Component_I2C::isInitialized
bool isInitialized()
Returns if i2c port is initialized.
Definition: WipperSnapper_I2C.cpp:125
WipperSnapper_I2C_Driver_VCNL4040
Class that provides a driver interface for a VCNL4040 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4040.h:26
WipperSnapper_I2C_Driver_SCD4X
Class that provides a driver interface for the SCD40 sensor.
Definition: WipperSnapper_I2C_Driver_SCD4X.h:29
+
WipperSnapper_I2C_Driver_SEN6X.h
WipperSnapper_Component_I2C::scanAddresses
wippersnapper_i2c_v1_I2CBusScanResponse scanAddresses()
Scans all I2C addresses on the bus between 0x08 and 0x7F inclusive and returns an array of the device...
Definition: WipperSnapper_I2C.cpp:145
WipperSnapper_I2C_Driver_PCT2075
Class that provides a driver interface for a PCT2075 sensor.
Definition: WipperSnapper_I2C_Driver_PCT2075.h:26
WipperSnapper_I2C_Driver_TSL2591.h
WipperSnapper_I2C_Driver_ADT7410
Class that provides a driver interface for a ADT7410 sensor.
Definition: WipperSnapper_I2C_Driver_ADT7410.h:26
WipperSnapper_I2C_Driver_VCNL4020.h
WipperSnapper_I2C_Driver_VL53L4CD
Class that provides a driver interface for a VL53L4CD sensor.
Definition: WipperSnapper_I2C_Driver_VL53L4CD.h:26
-
WipperSnapper_Component_I2C::fillEventMessage
void fillEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, float value, wippersnapper_i2c_v1_SensorType sensorType)
Fills a sensor_event message with the sensor&#39;s value and type.
Definition: WipperSnapper_I2C.cpp:905
+
WipperSnapper_Component_I2C::fillEventMessage
void fillEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, float value, wippersnapper_i2c_v1_SensorType sensorType)
Fills a sensor_event message with the sensor&#39;s value and type.
Definition: WipperSnapper_I2C.cpp:933
WipperSnapper_I2C_Driver_HTS221.h
WipperSnapper_I2C_Driver_VL6180X
Class that provides a driver interface for a VL6180X sensor.
Definition: WipperSnapper_I2C_Driver_VL6180X.h:27
WipperSnapper_I2C_Driver_BMP280.h
@@ -89,7 +90,7 @@
WipperSnapper_I2C_Driver_LPS25HB.h
WipperSnapper_Component_I2C::initI2CDevice
bool initI2CDevice(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq)
Initializes I2C device driver.
Definition: WipperSnapper_I2C.cpp:213
WipperSnapper_I2C_Driver_BME280.h
-
WipperSnapper_Component_I2C::displayDeviceEventMessage
void displayDeviceEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, uint32_t sensorAddress)
Displays a sensor event message on the TFT.
Definition: WipperSnapper_I2C.cpp:930
+
WipperSnapper_Component_I2C::displayDeviceEventMessage
void displayDeviceEventMessage(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, uint32_t sensorAddress)
Displays a sensor event message on the TFT.
Definition: WipperSnapper_I2C.cpp:958
WipperSnapper_I2C_Driver_INA219.h
WipperSnapper_I2C_Driver_HTU31D
Class that provides a sensor driver for the HTU31D humidity and temperature sensor.
Definition: WipperSnapper_I2C_Driver_HTU31D.h:19
WipperSnapper_I2C_Driver_PM25
Class that provides a driver interface for the PM25 sensor.
Definition: WipperSnapper_I2C_Driver_PM25.h:28
@@ -106,22 +107,23 @@
WipperSnapper_I2C_Driver_LC709203F
Class that provides a driver interface for a LC709203F sensor.
Definition: WipperSnapper_I2C_Driver_LC709203F.h:27
WipperSnapper_I2C_Driver_DS2484.h
WipperSnapper_I2C_Driver_BMP280
Class that provides a sensor driver for the BMP280 temperature and pressure sensor.
Definition: WipperSnapper_I2C_Driver_BMP280.h:30
-
WipperSnapper_Component_I2C::sensorEventRead
void sensorEventRead(std::vector< WipperSnapper_I2C_Driver *>::iterator &iter, unsigned long curTime, wippersnapper_signal_v1_I2CResponse *msgi2cResponse, bool(WipperSnapper_I2C_Driver::*getEventFunc)(sensors_event_t *), long(WipperSnapper_I2C_Driver::*getPeriodFunc)(), long(WipperSnapper_I2C_Driver::*getPeriodPrvFunc)(), void(WipperSnapper_I2C_Driver::*setPeriodPrvFunc)(long), wippersnapper_i2c_v1_SensorType sensorType, const char *sensorName, const char *unit, sensors_event_t event, float sensors_event_t::*valueMember, bool &sensorsReturningFalse, int &retries)
Reads a sensor event from an I2C device driver.
Definition: WipperSnapper_I2C.cpp:1326
-
WipperSnapper_Component_I2C::encodePublishI2CDeviceEventMsg
bool encodePublishI2CDeviceEventMsg(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, uint32_t sensorAddress)
Encodes an I2C sensor device&#39;s signal message.
Definition: WipperSnapper_I2C.cpp:865
+
WipperSnapper_Component_I2C::sensorEventRead
void sensorEventRead(std::vector< WipperSnapper_I2C_Driver *>::iterator &iter, unsigned long curTime, wippersnapper_signal_v1_I2CResponse *msgi2cResponse, bool(WipperSnapper_I2C_Driver::*getEventFunc)(sensors_event_t *), long(WipperSnapper_I2C_Driver::*getPeriodFunc)(), long(WipperSnapper_I2C_Driver::*getPeriodPrvFunc)(), void(WipperSnapper_I2C_Driver::*setPeriodPrvFunc)(long), wippersnapper_i2c_v1_SensorType sensorType, const char *sensorName, const char *unit, sensors_event_t event, float sensors_event_t::*valueMember, bool &sensorsReturningFalse, int &retries)
Reads a sensor event from an I2C device driver.
Definition: WipperSnapper_I2C.cpp:1354
+
WipperSnapper_Component_I2C::encodePublishI2CDeviceEventMsg
bool encodePublishI2CDeviceEventMsg(wippersnapper_signal_v1_I2CResponse *msgi2cResponse, uint32_t sensorAddress)
Encodes an I2C sensor device&#39;s signal message.
Definition: WipperSnapper_I2C.cpp:893
WipperSnapper_I2C_Driver_LPS22HB.h
WipperSnapper_I2C_Driver_MPRLS.h
WipperSnapper_I2C_Driver_BME680.h
WipperSnapper_I2C_Driver
Base class for I2C Drivers.
Definition: WipperSnapper_I2C_Driver.h:30
WipperSnapper_I2C_Driver_SGP30
Class that provides a driver interface for a SGP30 sensor.
Definition: WipperSnapper_I2C_Driver_SGP30.h:12
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
WipperSnapper_I2C_Driver_HTU31D.h
-
WipperSnapper_I2C_Driver_SEN5X
Class that provides a driver interface for the SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:29
+
WipperSnapper_I2C_Driver_SEN5X
Class that provides a driver interface for the SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:28
+
WipperSnapper_I2C_Driver_SEN6X
Class that provides a driver interface for the SEN6X sensor.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:30
WipperSnapper_I2C_Driver_HDC302X
Class that provides a sensor driver for the HDC302X humidity and temperature sensor. This implementation uses the 1 Hz data rate.
Definition: WipperSnapper_I2C_Driver_HDC302X.h:19
WipperSnapper_I2C_Driver_SHTC3.h
WipperSnapper_Component_I2C::WipperSnapper_Component_I2C
WipperSnapper_Component_I2C(wippersnapper_i2c_v1_I2CBusInitRequest *msgInitRequest)
Creates a new WipperSnapper I2C component.
Definition: WipperSnapper_I2C.cpp:31
WipperSnapper_I2C_Driver_MS8607.h
WipperSnapper_I2C_Driver_SHT4X
Class that provides a driver interface for the SHT4X sensor.
Definition: WipperSnapper_I2C_Driver_SHT4X.h:30
-
WipperSnapper_Component_I2C::deinitI2CDevice
void deinitI2CDevice(wippersnapper_i2c_v1_I2CDeviceDeinitRequest *msgDeviceDeinitReq)
Deinitializes and deletes an I2C device driver object.
Definition: WipperSnapper_I2C.cpp:830
+
WipperSnapper_Component_I2C::deinitI2CDevice
void deinitI2CDevice(wippersnapper_i2c_v1_I2CDeviceDeinitRequest *msgDeviceDeinitReq)
Deinitializes and deletes an I2C device driver object.
Definition: WipperSnapper_I2C.cpp:858
WipperSnapper_I2C_Driver_SHT3X
Class that provides a driver interface for the SHT3X sensor.
Definition: WipperSnapper_I2C_Driver_SHT3X.h:30
Wippersnapper.h
WipperSnapper_I2C_Driver_HDC302X.h
@@ -149,7 +151,8 @@
WipperSnapper_I2C_Driver_VL53L0X
Class that provides a driver interface for a VL53L0X sensor.
Definition: WipperSnapper_I2C_Driver_VL53L0X.h:27
WipperSnapper_I2C_Driver_VL53L1X
Class that provides a driver interface for a VL53L1X sensor.
Definition: WipperSnapper_I2C_Driver_VL53L1X.h:27
WipperSnapper_I2C_Driver_VL53L4CD.h
-
WipperSnapper_Component_I2C::updateI2CDeviceProperties
void updateI2CDeviceProperties(wippersnapper_i2c_v1_I2CDeviceUpdateRequest *msgDeviceUpdateReq)
Updates the properties of an I2C device driver.
Definition: WipperSnapper_I2C.cpp:802
+
WipperSnapper_I2C_Driver_VCNL4200.h
+
WipperSnapper_Component_I2C::updateI2CDeviceProperties
void updateI2CDeviceProperties(wippersnapper_i2c_v1_I2CDeviceUpdateRequest *msgDeviceUpdateReq)
Updates the properties of an I2C device driver.
Definition: WipperSnapper_I2C.cpp:830
WS
Wippersnapper WS
Definition: Wippersnapper.cpp:36
WipperSnapper_I2C_Driver_MPRLS
Class that provides a sensor driver for the MPRLS sensor.
Definition: WipperSnapper_I2C_Driver_MPRLS.h:27
WipperSnapper_I2C_Driver_PCT2075.h
@@ -170,6 +173,7 @@
WipperSnapper_I2C_Driver_MCP3421.h
WipperSnapper_I2C_Driver_SGP40
Class that provides a driver interface for the SGP40 sensor.
Definition: WipperSnapper_I2C_Driver_SGP40.h:28
WipperSnapper_I2C_Driver_INA219
Class that provides a driver interface for a INA219 sensor.
Definition: WipperSnapper_I2C_Driver_INA219.h:26
+
WipperSnapper_I2C_Driver_VCNL4200
Class that provides a driver interface for a VCNL4200 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:26
WipperSnapper_I2C_Driver_VEML7700.h
WipperSnapper_I2C_Driver_MAX17048
Class that provides a driver interface for a MAX17048 sensor.
Definition: WipperSnapper_I2C_Driver_MAX17048.h:27
WipperSnapper_I2C_Driver_NAU7802
Class that provides a driver interface for the NAU7802.
Definition: WipperSnapper_I2C_Driver_NAU7802.h:29
@@ -182,7 +186,7 @@
WipperSnapper_I2C_Driver_VCNL4040.h
WipperSnapper_I2C_Driver_VCNL4020
Class that provides a driver interface for a VCNL4020 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4020.h:26
WipperSnapper_I2C_Driver_MPL115A2.h
-
WipperSnapper_Component_I2C::update
void update()
Queries all I2C device drivers for new values. Fills and sends an I2CSensorEvent with the sensor even...
Definition: WipperSnapper_I2C.cpp:1026
+
WipperSnapper_Component_I2C::update
void update()
Queries all I2C device drivers for new values. Fills and sends an I2CSensorEvent with the sensor even...
Definition: WipperSnapper_I2C.cpp:1054
diff --git a/html/_wipper_snapper___i2_c___driver_8h_source.html b/html/_wipper_snapper___i2_c___driver_8h_source.html index 11ac8df04..aad183e29 100644 --- a/html/_wipper_snapper___i2_c___driver_8h_source.html +++ b/html/_wipper_snapper___i2_c___driver_8h_source.html @@ -66,7 +66,7 @@
WipperSnapper_I2C_Driver.h
-Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_I2C_Driver_H
17 #define WipperSnapper_I2C_Driver_H
18 
19 #include <Adafruit_Sensor.h>
20 #include <Arduino.h>
21 
22 #define PERIOD_24HRS_AGO_MILLIS (millis() - (24 * 60 * 60 * 1000))
23 
25 /**************************************************************************/
29 /**************************************************************************/
30 class WipperSnapper_I2C_Driver {
31 
32 public:
33  /*******************************************************************************/
41  /*******************************************************************************/
42  WipperSnapper_I2C_Driver(TwoWire *i2c, uint16_t sensorAddress) {
43  _i2c = i2c;
44  _sensorAddress = sensorAddress;
45  }
46 
47  /*******************************************************************************/
51  /*******************************************************************************/
52  virtual ~WipperSnapper_I2C_Driver() {}
53 
54  /*******************************************************************************/
59  /*******************************************************************************/
60  bool begin() { return false; }
61 
62  /*******************************************************************************/
70  /*******************************************************************************/
71  void setSensorPeriod(float period,
72  wippersnapper_i2c_v1_SensorType sensorType) {
73  long sensorPeriod = (long)period * 1000;
74 
75  switch (sensorType) {
76  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE:
77  _tempSensorPeriod = sensorPeriod;
78  break;
79  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_RELATIVE_HUMIDITY:
80  _humidSensorPeriod = sensorPeriod;
81  break;
82  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PRESSURE:
83  _pressureSensorPeriod = sensorPeriod;
84  break;
85  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_CO2:
86  _CO2SensorPeriod = sensorPeriod;
87  break;
88  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_ECO2:
89  _ECO2SensorPeriod = sensorPeriod;
90  break;
91  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_TVOC:
92  _TVOCSensorPeriod = sensorPeriod;
93  break;
94  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_ALTITUDE:
95  _altitudeSensorPeriod = sensorPeriod;
96  break;
97  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE:
98  _objectTempSensorPeriod = sensorPeriod;
99  break;
100  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_LIGHT:
101  _lightSensorPeriod = sensorPeriod;
102  break;
103  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM10_STD:
104  _PM10SensorPeriod = sensorPeriod;
105  break;
106  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM25_STD:
107  _PM25SensorPeriod = sensorPeriod;
108  break;
109  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM100_STD:
110  _PM100SensorPeriod = sensorPeriod;
111  break;
112  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_UNITLESS_PERCENT:
113  _unitlessPercentPeriod = sensorPeriod;
114  break;
115  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_VOLTAGE:
116  _voltagePeriod = sensorPeriod;
117  break;
118  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_CURRENT:
119  _currentPeriod = sensorPeriod;
120  break;
121  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PROXIMITY:
122  _proximitySensorPeriod = sensorPeriod;
123  break;
124  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_RAW:
125  _rawSensorPeriod = sensorPeriod;
126  break;
127  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE_FAHRENHEIT:
128  _ambientTempFPeriod = sensorPeriod;
129  break;
130  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE_FAHRENHEIT:
131  _objectTempFPeriod = sensorPeriod;
132  break;
133  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_GAS_RESISTANCE:
134  _gasResistancePeriod = sensorPeriod;
135  break;
136  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_NOX_INDEX:
137  _NOxIndexPeriod = sensorPeriod;
138  break;
139  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_VOC_INDEX:
140  _VOCIndexPeriod = sensorPeriod;
141  break;
142  default:
143  break;
144  }
145  }
146 
147  /*******************************************************************************/
154  /*******************************************************************************/
155  void
156  configureDriver(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq) {
157  int propertyIdx = 0; // contains the amount of i2c sensors in the
158  // msgDeviceInitReq to configure
159  while (propertyIdx < msgDeviceInitReq->i2c_device_properties_count) {
160  setSensorPeriod(
161  msgDeviceInitReq->i2c_device_properties[propertyIdx].sensor_period,
162  msgDeviceInitReq->i2c_device_properties[propertyIdx].sensor_type);
163  ++propertyIdx;
164  }
165  }
166 
167  /*******************************************************************************/
172  /*******************************************************************************/
173  uint16_t getI2CAddress() { return _sensorAddress; }
174 
175  /****************************** SENSOR_TYPE: CO2
176  * *******************************/
177  /*********************************************************************************/
183  /*********************************************************************************/
184  virtual long getSensorCO2Period() { return _CO2SensorPeriod; }
185 
186  /*********************************************************************************/
192  /*********************************************************************************/
193  virtual long getSensorCO2PeriodPrv() { return _CO2SensorPeriodPrv; }
194 
195  /*******************************************************************************/
201  /*******************************************************************************/
202  virtual void setSensorCO2PeriodPrv(long period) {
203  _CO2SensorPeriodPrv = period;
204  }
205 
206  /*******************************************************************************/
214  /*******************************************************************************/
215  virtual bool getEventCO2(sensors_event_t *co2Event) {
216  (void)
217  co2Event; // Parameter is intentionally unused in this virtual function.
218  return false;
219  }
220 
221  /****************************** SENSOR_TYPE: ECO2
222  * *******************************/
223  /*********************************************************************************/
229  /*********************************************************************************/
230  virtual long getSensorECO2Period() { return _ECO2SensorPeriod; }
231 
232  /*********************************************************************************/
238  /*********************************************************************************/
239  virtual long getSensorECO2PeriodPrv() { return _ECO2SensorPeriodPrv; }
240 
241  /*******************************************************************************/
247  /*******************************************************************************/
248  virtual void setSensorECO2PeriodPrv(long period) {
249  _ECO2SensorPeriodPrv = period;
250  }
251 
252  /*******************************************************************************/
260  /*******************************************************************************/
261  virtual bool getEventECO2(sensors_event_t *eco2Event) {
262  (void)eco2Event; // Parameter is intentionally unused in this virtual
263  // function.
264  return false;
265  }
266 
267  /****************************** SENSOR_TYPE: TVOC
268  * *******************************/
269  /*********************************************************************************/
275  /*********************************************************************************/
276  virtual long getSensorTVOCPeriod() { return _TVOCSensorPeriod; }
277 
278  /*********************************************************************************/
284  /*********************************************************************************/
285  virtual long getSensorTVOCPeriodPrv() { return _TVOCSensorPeriodPrv; }
286 
287  /*******************************************************************************/
293  /*******************************************************************************/
294  virtual void setSensorTVOCPeriodPrv(long period) {
295  _TVOCSensorPeriodPrv = period;
296  }
297 
298  /*******************************************************************************/
306  /*******************************************************************************/
307  virtual bool getEventTVOC(sensors_event_t *tvocEvent) {
308  (void)tvocEvent; // Parameter is intentionally unused in this virtual
309  // function.
310  return false;
311  }
312 
313  /********************** SENSOR_TYPE: AMBIENT TEMPERATURE (°C)
314  * ***********************/
315  /*********************************************************************************/
321  /*********************************************************************************/
322  virtual long getSensorAmbientTempPeriod() { return _tempSensorPeriod; }
323 
324  /*********************************************************************************/
331  /*********************************************************************************/
332  virtual long getSensorAmbientTempPeriodPrv() { return _tempSensorPeriodPrv; }
333 
334  /*******************************************************************************/
342  /*******************************************************************************/
343  virtual void setSensorAmbientTempPeriodPrv(long periodPrv) {
344  _tempSensorPeriodPrv = periodPrv;
345  }
346 
347  /*******************************************************************************/
356  /*******************************************************************************/
357  virtual bool getEventAmbientTemp(sensors_event_t *tempEvent) {
358  (void)tempEvent; // Parameter is intentionally unused in this virtual
359  // function.
360  return false;
361  }
362 
363  /************************* SENSOR_TYPE: RELATIVE_HUMIDITY
364  * ***********************/
365  /*********************************************************************************/
371  /*********************************************************************************/
372  virtual long getSensorRelativeHumidityPeriod() { return _humidSensorPeriod; }
373 
374  /*********************************************************************************/
380  /*********************************************************************************/
381  virtual long getSensorRelativeHumidityPeriodPrv() {
382  return _humidSensorPeriodPrv;
383  }
384 
385  /*******************************************************************************/
391  /*******************************************************************************/
392  virtual void setSensorRelativeHumidityPeriodPrv(long periodPrv) {
393  _humidSensorPeriodPrv = periodPrv;
394  }
395 
396  /*******************************************************************************/
405  /*******************************************************************************/
406  virtual bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
407  (void)humidEvent; // Parameter is intentionally unused in this virtual
408  // function.
409  return false;
410  }
411 
412  /**************************** SENSOR_TYPE: PRESSURE
413  * ****************************/
414  /*********************************************************************************/
420  /*********************************************************************************/
421  virtual long getSensorPressurePeriod() { return _pressureSensorPeriod; }
422 
423  /*********************************************************************************/
429  /*********************************************************************************/
430  virtual long getSensorPressurePeriodPrv() { return _pressureSensorPeriodPrv; }
431 
432  /*******************************************************************************/
438  /*******************************************************************************/
439  virtual void setSensorPressurePeriodPrv(long period) {
440  _pressureSensorPeriodPrv = period;
441  }
442 
443  /*******************************************************************************/
452  /*******************************************************************************/
453  virtual bool getEventPressure(sensors_event_t *pressureEvent) {
454  (void)pressureEvent; // Parameter is intentionally unused in this virtual
455  // function.
456  return false;
457  }
458 
459  /**************************** SENSOR_TYPE: Altitude
460  * ****************************/
461  /*********************************************************************************/
467  /*********************************************************************************/
468  virtual long getSensorAltitudePeriod() { return _altitudeSensorPeriod; }
469 
470  /*********************************************************************************/
476  /*********************************************************************************/
477  virtual long getSensorAltitudePeriodPrv() { return _altitudeSensorPeriodPrv; }
478 
479  /*******************************************************************************/
485  /*******************************************************************************/
486  virtual void setSensorAltitudePeriodPrv(long period) {
487  _altitudeSensorPeriodPrv = period;
488  }
489 
490  /*******************************************************************************/
499  /*******************************************************************************/
500  virtual bool getEventAltitude(sensors_event_t *altitudeEvent) {
501  (void)altitudeEvent; // Parameter is intentionally unused in this virtual
502  // function.
503  return false;
504  }
505 
506  /**************************** SENSOR_TYPE: Object_Temperature
507  * ****************************/
508  /*********************************************************************************/
515  /*********************************************************************************/
516  virtual long getSensorObjectTempPeriod() { return _objectTempSensorPeriod; }
517 
518  /*********************************************************************************/
525  /*********************************************************************************/
526  virtual long getSensorObjectTempPeriodPrv() {
527  return _objectTempSensorPeriodPrv;
528  }
529 
530  /*******************************************************************************/
537  /*******************************************************************************/
538  virtual void setSensorObjectTempPeriodPrv(long period) {
539  _objectTempSensorPeriodPrv = period;
540  }
541 
542  /*******************************************************************************/
551  /*******************************************************************************/
552  virtual bool getEventObjectTemp(sensors_event_t *objectTempEvent) {
553  (void)objectTempEvent; // Parameter is intentionally unused in this virtual
554  // function.
555  return false;
556  }
557 
558  /**************************** SENSOR_TYPE: LIGHT
559  * ****************************/
560  /*********************************************************************************/
567  /*********************************************************************************/
568  virtual long getSensorLightPeriod() { return _lightSensorPeriod; }
569 
570  /*********************************************************************************/
577  /*********************************************************************************/
578  virtual long getSensorLightPeriodPrv() { return _lightSensorPeriodPrv; }
579 
580  /*******************************************************************************/
587  /*******************************************************************************/
588  virtual void setSensorLightPeriodPrv(long period) {
589  _lightSensorPeriodPrv = period;
590  }
591 
592  /*******************************************************************************/
601  /*******************************************************************************/
602  virtual bool getEventLight(sensors_event_t *lightEvent) {
603  (void)lightEvent; // Parameter is intentionally unused in this virtual
604  // function.
605  return false;
606  }
607 
608  /**************************** SENSOR_TYPE: PM10_STD
609  * ****************************/
610  /*********************************************************************************/
617  /*********************************************************************************/
618  virtual long getSensorPM10_STDPeriod() { return _PM10SensorPeriod; }
619 
620  /*********************************************************************************/
627  /*********************************************************************************/
628  virtual long getSensorPM10_STDPeriodPrv() { return _PM10SensorPeriodPrv; }
629 
630  /*******************************************************************************/
637  /*******************************************************************************/
638  virtual void setSensorPM10_STDPeriodPrv(long period) {
639  _PM10SensorPeriodPrv = period;
640  }
641 
642  /*******************************************************************************/
651  /*******************************************************************************/
652  virtual bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
653  (void)pm10StdEvent; // Parameter is intentionally unused in this virtual
654  // function.
655  return false;
656  }
657 
658  /**************************** SENSOR_TYPE: PM25_STD
659  * ****************************/
660  /*********************************************************************************/
667  /*********************************************************************************/
668  virtual long getSensorPM25_STDPeriod() { return _PM25SensorPeriod; }
669 
670  /*********************************************************************************/
677  /*********************************************************************************/
678  virtual long getSensorPM25_STDPeriodPrv() { return _PM25SensorPeriodPrv; }
679 
680  /*******************************************************************************/
687  /*******************************************************************************/
688  virtual void setSensorPM25_STDPeriodPrv(long period) {
689  _PM25SensorPeriodPrv = period;
690  }
691 
692  /*******************************************************************************/
701  /*******************************************************************************/
702  virtual bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
703  (void)pm25StdEvent; // Parameter is intentionally unused in this virtual
704  // function.
705  return false;
706  }
707 
708  /**************************** SENSOR_TYPE: PM100_STD
709  * ****************************/
710  /*********************************************************************************/
717  /*********************************************************************************/
718  virtual long getSensorPM100_STDPeriod() { return _PM100SensorPeriod; }
719 
720  /*********************************************************************************/
727  /*********************************************************************************/
728  virtual long getSensorPM100_STDPeriodPrv() { return _PM100SensorPeriodPrv; }
729 
730  /*******************************************************************************/
737  /*******************************************************************************/
738  virtual void setSensorPM100_STDPeriodPrv(long period) {
739  _PM100SensorPeriodPrv = period;
740  }
741 
742  /*******************************************************************************/
751  /*******************************************************************************/
752  virtual bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
753  (void)pm100StdEvent; // Parameter is intentionally unused in this virtual
754  // function.
755  return false;
756  }
757 
758  /**************************** SENSOR_TYPE: UNITLESS_PERCENT
759  * ****************************/
760  /*********************************************************************************/
767  /*********************************************************************************/
768  virtual long getSensorUnitlessPercentPeriod() {
769  return _unitlessPercentPeriod;
770  }
771 
772  /*********************************************************************************/
779  /*********************************************************************************/
780  virtual long getSensorUnitlessPercentPeriodPrv() {
781  return _unitlessPercentPeriodPrv;
782  }
783 
784  /*******************************************************************************/
791  /*******************************************************************************/
792  virtual void setSensorUnitlessPercentPeriodPrv(long period) {
793  _unitlessPercentPeriodPrv = period;
794  }
795 
796  /*******************************************************************************/
805  /*******************************************************************************/
806  virtual bool getEventUnitlessPercent(sensors_event_t *unitlessPercentEvent) {
807  (void)unitlessPercentEvent; // Parameter is intentionally unused in this
808  // virtual function.
809  return false;
810  }
811 
812  /**************************** SENSOR_TYPE: VOLTAGE
813  * ****************************/
814  /*********************************************************************************/
820  /*********************************************************************************/
821  virtual long getSensorVoltagePeriod() { return _voltagePeriod; }
822 
823  /*********************************************************************************/
829  /*********************************************************************************/
830  virtual long getSensorVoltagePeriodPrv() { return _voltagePeriodPrv; }
831 
832  /*******************************************************************************/
838  /*******************************************************************************/
839  virtual void setSensorVoltagePeriodPrv(long period) {
840  _voltagePeriodPrv = period;
841  }
842 
843  /*******************************************************************************/
852  /*******************************************************************************/
853  virtual bool getEventVoltage(sensors_event_t *voltageEvent) {
854  (void)voltageEvent; // Parameter is intentionally unused in this virtual
855  // function.
856  return false;
857  }
858 
859  /**************************** SENSOR_TYPE: CURRENT
860  * ****************************/
861  /*********************************************************************************/
867  /*********************************************************************************/
868  virtual long getSensorCurrentPeriod() { return _currentPeriod; }
869 
870  /*********************************************************************************/
876  /*********************************************************************************/
877  virtual long getSensorCurrentPeriodPrv() { return _currentPeriodPrv; }
878 
879  /*******************************************************************************/
885  /*******************************************************************************/
886  virtual void setSensorCurrentPeriodPrv(long period) {
887  _currentPeriodPrv = period;
888  }
889 
890  /*******************************************************************************/
899  /*******************************************************************************/
900  virtual bool getEventCurrent(sensors_event_t *currentEvent) {
901  (void)currentEvent; // Parameter is intentionally unused in this virtual
902  // function.
903  return false;
904  }
905 
906  /****************************** SENSOR_TYPE: Raw
907  * *******************************/
908  /*********************************************************************************/
914  /*********************************************************************************/
915  virtual long getSensorRawPeriod() { return _rawSensorPeriod; }
916 
917  /*********************************************************************************/
923  /*********************************************************************************/
924  virtual long getSensorRawPeriodPrv() { return _rawSensorPeriodPrv; }
925 
926  /*******************************************************************************/
932  /*******************************************************************************/
933  virtual void setSensorRawPeriodPrv(long period) {
934  _rawSensorPeriodPrv = period;
935  }
936 
937  /*******************************************************************************/
945  /*******************************************************************************/
946  virtual bool getEventRaw(sensors_event_t *rawEvent) {
947  (void)
948  rawEvent; // Parameter is intentionally unused in this virtual function.
949  return false;
950  }
951 
952  /****************************** SENSOR_TYPE: Ambient Temp (°F)
953  * *******************************/
954 
955  /*******************************************************************************/
960  /*******************************************************************************/
961  virtual void disableAmbientTempF() { _ambientTempFPeriod = 0.0L; }
962 
963  /*********************************************************************************/
970  /*********************************************************************************/
971  virtual long getSensorAmbientTempFPeriod() { return _ambientTempFPeriod; }
972 
973  /*********************************************************************************/
980  /*********************************************************************************/
981  virtual long getSensorAmbientTempFPeriodPrv() {
982  return _ambientTempFPeriodPrv;
983  }
984 
985  /*******************************************************************************/
993  /*******************************************************************************/
994  virtual void setSensorAmbientTempFPeriodPrv(long period) {
995  _ambientTempFPeriodPrv = period;
996  }
997 
998  /*******************************************************************************/
1008  /*******************************************************************************/
1009  virtual bool getEventAmbientTempF(sensors_event_t *AmbientTempFEvent) {
1010  // obtain ambient temp. in °C
1011  if (!getEventAmbientTemp(AmbientTempFEvent))
1012  return false;
1013  // convert event from °C to °F
1014  AmbientTempFEvent->temperature =
1015  (AmbientTempFEvent->temperature * 9.0) / 5.0 + 32;
1016  return true;
1017  }
1018 
1019  /****************************** SENSOR_TYPE: Object Temp (°F)
1020  * *******************************/
1021  /*********************************************************************************/
1028  /*********************************************************************************/
1029  virtual long getSensorObjectTempFPeriod() { return _objectTempFPeriod; }
1030 
1031  /*********************************************************************************/
1038  /*********************************************************************************/
1039  virtual long getSensorObjectTempFPeriodPrv() { return _objectTempFPeriodPrv; }
1040 
1041  /*******************************************************************************/
1049  /*******************************************************************************/
1050  virtual void setSensorObjectTempFPeriodPrv(long period) {
1051  _objectTempFPeriodPrv = period;
1052  }
1053 
1054  /*******************************************************************************/
1064  /*******************************************************************************/
1065  virtual bool getEventObjectTempF(sensors_event_t *objectTempFEvent) {
1066  // obtain ambient temp. in °C
1067  if (!getEventObjectTemp(objectTempFEvent))
1068  return false;
1069  // convert event from °C to °F
1070  objectTempFEvent->temperature =
1071  (objectTempFEvent->temperature * 9.0) / 5.0 + 32.0;
1072  return true;
1073  }
1074 
1075  /****************************** SENSOR_TYPE: Gas Resistance (ohms)
1076  * *******************************/
1077  /*********************************************************************************/
1084  /*********************************************************************************/
1085  virtual long getSensorGasResistancePeriod() { return _gasResistancePeriod; }
1086 
1087  /*********************************************************************************/
1094  /*********************************************************************************/
1095  virtual long getSensorGasResistancePeriodPrv() {
1096  return _gasResistancePeriodPrv;
1097  }
1098 
1099  /*******************************************************************************/
1107  /*******************************************************************************/
1108  virtual void setSensorGasResistancePeriodPrv(long period) {
1109  _gasResistancePeriodPrv = period;
1110  }
1111 
1112  /*******************************************************************************/
1121  /*******************************************************************************/
1122  virtual bool getEventGasResistance(sensors_event_t *gasEvent) {
1123  (void)
1124  gasEvent; // Parameter is intentionally unused in this virtual function.
1125  return false;
1126  }
1127 
1128  /****************************** SENSOR_TYPE: NOx Index (index)
1129  * *******************************/
1130  /*********************************************************************************/
1137  /*********************************************************************************/
1138  virtual long getSensorNOxIndexPeriod() { return _NOxIndexPeriod; }
1139 
1140  /*********************************************************************************/
1147  /*********************************************************************************/
1148  virtual long getSensorNOxIndexPeriodPrv() { return _NOxIndexPeriodPrv; }
1149 
1150  /*******************************************************************************/
1158  /*******************************************************************************/
1159  virtual void setSensorNOxIndexPeriodPrv(long period) {
1160  _NOxIndexPeriodPrv = period;
1161  }
1162 
1163  /*******************************************************************************/
1172  /*******************************************************************************/
1173  virtual bool getEventNOxIndex(sensors_event_t *gasEvent) {
1174  (void)
1175  gasEvent; // Parameter is intentionally unused in this virtual function.
1176  return false;
1177  }
1178 
1179  /****************************** SENSOR_TYPE: VOC Index (index)
1180  * *******************************/
1181  /*********************************************************************************/
1188  /*********************************************************************************/
1189  virtual long getSensorVOCIndexPeriod() { return _VOCIndexPeriod; }
1190 
1191  /*********************************************************************************/
1198  /*********************************************************************************/
1199  virtual long getSensorVOCIndexPeriodPrv() { return _VOCIndexPeriodPrv; }
1200 
1201  /*******************************************************************************/
1209  /*******************************************************************************/
1210  virtual void setSensorVOCIndexPeriodPrv(long period) {
1211  _VOCIndexPeriodPrv = period;
1212  }
1213 
1214  /*******************************************************************************/
1223  /*******************************************************************************/
1224  virtual bool getEventVOCIndex(sensors_event_t *gasEvent) {
1225  (void)
1226  gasEvent; // Parameter is intentionally unused in this virtual function.
1227  return false;
1228  }
1229 
1230  /**************************** SENSOR_TYPE: PROXIMITY
1231  * ****************************/
1232  /*******************************************************************************/
1236  /*******************************************************************************/
1237  virtual void enableSensorProximity(){};
1238 
1239  /*******************************************************************************/
1243  /*******************************************************************************/
1244  virtual void disableSensorProximity() { _proximitySensorPeriod = 0.0L; }
1245 
1246  /*********************************************************************************/
1253  /*********************************************************************************/
1254  virtual long sensorProximityPeriod() { return _proximitySensorPeriod; }
1255 
1256  /*******************************************************************************/
1263  /*******************************************************************************/
1264  virtual void setSensorProximityPeriod(long period) {
1265  if (period == 0)
1266  disableSensorProximity();
1267  _proximitySensorPeriod = period;
1268  }
1269 
1270  /*********************************************************************************/
1277  /*********************************************************************************/
1278  virtual long SensorProximityPeriodPrv() { return _proximitySensorPeriodPrv; }
1279 
1280  /*******************************************************************************/
1287  /*******************************************************************************/
1288  virtual void setSensorProximityPeriodPrv(long period) {
1289  _proximitySensorPeriodPrv = period;
1290  }
1291 
1292  /*******************************************************************************/
1301  /*******************************************************************************/
1302  virtual bool getEventProximity(sensors_event_t *proximityEvent) {
1303  (void)proximityEvent; // Parameter is intentionally unused in this virtual
1304  // function.
1305  return false;
1306  }
1307 
1308  /*******************************************************************************/
1315  /*******************************************************************************/
1316  virtual void updateSensorProximity(float period) {
1317  setSensorProximityPeriod(period);
1318  }
1319 
1320 protected:
1321  TwoWire *_i2c;
1322  uint16_t _sensorAddress;
1323  long _tempSensorPeriod =
1324  0L;
1325  long _tempSensorPeriodPrv =
1326  PERIOD_24HRS_AGO_MILLIS;
1327  long _humidSensorPeriod =
1329  0L;
1330  long _humidSensorPeriodPrv =
1331  PERIOD_24HRS_AGO_MILLIS;
1332  long _pressureSensorPeriod =
1334  0L;
1335  long _pressureSensorPeriodPrv =
1336  PERIOD_24HRS_AGO_MILLIS;
1337  long _CO2SensorPeriod =
1339  0L;
1340  long _CO2SensorPeriodPrv =
1341  PERIOD_24HRS_AGO_MILLIS;
1342  long _ECO2SensorPeriod =
1343  0L;
1344  long _ECO2SensorPeriodPrv =
1345  PERIOD_24HRS_AGO_MILLIS;
1346  long _TVOCSensorPeriod =
1347  0L;
1348  long _TVOCSensorPeriodPrv =
1349  PERIOD_24HRS_AGO_MILLIS;
1350  long _altitudeSensorPeriod =
1351  0L;
1352  long _altitudeSensorPeriodPrv =
1353  PERIOD_24HRS_AGO_MILLIS;
1354  long _objectTempSensorPeriod = 0L;
1356  long _objectTempSensorPeriodPrv =
1358  PERIOD_24HRS_AGO_MILLIS;
1359  long _lightSensorPeriod =
1361  0L;
1362  long _lightSensorPeriodPrv =
1363  PERIOD_24HRS_AGO_MILLIS;
1364  long _PM10SensorPeriod =
1366  0L;
1367  long _PM10SensorPeriodPrv =
1368  PERIOD_24HRS_AGO_MILLIS;
1369  long _PM25SensorPeriod =
1370  0L;
1371  long _PM25SensorPeriodPrv =
1372  PERIOD_24HRS_AGO_MILLIS;
1373  long _PM100SensorPeriod =
1374  0L;
1375  long _PM100SensorPeriodPrv =
1376  PERIOD_24HRS_AGO_MILLIS;
1377  long _unitlessPercentPeriod =
1379  0L;
1380  long _unitlessPercentPeriodPrv =
1381  PERIOD_24HRS_AGO_MILLIS;
1382  long _voltagePeriod =
1384  0L;
1385  long _voltagePeriodPrv =
1386  PERIOD_24HRS_AGO_MILLIS;
1387  long _currentPeriod =
1389  0L;
1390  long _currentPeriodPrv =
1391  PERIOD_24HRS_AGO_MILLIS;
1392  long _rawSensorPeriod =
1394  0L;
1395  long _rawSensorPeriodPrv =
1396  PERIOD_24HRS_AGO_MILLIS;
1397  long _ambientTempFPeriod = 0L;
1398  long _ambientTempFPeriodPrv =
1400  PERIOD_24HRS_AGO_MILLIS;
1401  long _objectTempFPeriod = 0L;
1403  long _objectTempFPeriodPrv =
1405  PERIOD_24HRS_AGO_MILLIS;
1406  long _gasResistancePeriod = 0L;
1408  long _gasResistancePeriodPrv =
1410  PERIOD_24HRS_AGO_MILLIS;
1411  long _NOxIndexPeriod =
1413  0L;
1414  long _NOxIndexPeriodPrv =
1415  PERIOD_24HRS_AGO_MILLIS;
1416  long _VOCIndexPeriod =
1418  0L;
1419  long _VOCIndexPeriodPrv =
1420  PERIOD_24HRS_AGO_MILLIS;
1421  long _proximitySensorPeriod =
1423  0L;
1424  long _proximitySensorPeriodPrv =
1425  PERIOD_24HRS_AGO_MILLIS;
1426 };
1428 
1429 #endif // WipperSnapper_I2C_Driver_H
WipperSnapper_I2C_Driver::_unitlessPercentPeriod
long _unitlessPercentPeriod
The time period between reading the unitless % sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1378
+Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_I2C_Driver_H
17 #define WipperSnapper_I2C_Driver_H
18 
19 #include <Adafruit_Sensor.h>
20 #include <Arduino.h>
21 
22 #define PERIOD_24HRS_AGO_MILLIS (millis() - (24 * 60 * 60 * 1000))
23 
25 /**************************************************************************/
29 /**************************************************************************/
30 class WipperSnapper_I2C_Driver {
31 
32 public:
33  /*******************************************************************************/
41  /*******************************************************************************/
42  WipperSnapper_I2C_Driver(TwoWire *i2c, uint16_t sensorAddress) {
43  _i2c = i2c;
44  _sensorAddress = sensorAddress;
45  }
46 
47  /*******************************************************************************/
51  /*******************************************************************************/
52  virtual ~WipperSnapper_I2C_Driver() {}
53 
54  /*******************************************************************************/
59  /*******************************************************************************/
60  bool begin() { return false; }
61 
62  /*******************************************************************************/
70  /*******************************************************************************/
71  void setSensorPeriod(float period,
72  wippersnapper_i2c_v1_SensorType sensorType) {
73  long sensorPeriod = (long)period * 1000;
74 
75  switch (sensorType) {
76  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE:
77  _tempSensorPeriod = sensorPeriod;
78  break;
79  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_RELATIVE_HUMIDITY:
80  _humidSensorPeriod = sensorPeriod;
81  break;
82  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PRESSURE:
83  _pressureSensorPeriod = sensorPeriod;
84  break;
85  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_CO2:
86  _CO2SensorPeriod = sensorPeriod;
87  break;
88  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_ECO2:
89  _ECO2SensorPeriod = sensorPeriod;
90  break;
91  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_TVOC:
92  _TVOCSensorPeriod = sensorPeriod;
93  break;
94  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_ALTITUDE:
95  _altitudeSensorPeriod = sensorPeriod;
96  break;
97  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE:
98  _objectTempSensorPeriod = sensorPeriod;
99  break;
100  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_LIGHT:
101  _lightSensorPeriod = sensorPeriod;
102  break;
103  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM10_STD:
104  _PM10SensorPeriod = sensorPeriod;
105  break;
106  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM25_STD:
107  _PM25SensorPeriod = sensorPeriod;
108  break;
109  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PM100_STD:
110  _PM100SensorPeriod = sensorPeriod;
111  break;
112  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_UNITLESS_PERCENT:
113  _unitlessPercentPeriod = sensorPeriod;
114  break;
115  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_VOLTAGE:
116  _voltagePeriod = sensorPeriod;
117  break;
118  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_CURRENT:
119  _currentPeriod = sensorPeriod;
120  break;
121  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_PROXIMITY:
122  _proximitySensorPeriod = sensorPeriod;
123  break;
124  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_RAW:
125  _rawSensorPeriod = sensorPeriod;
126  break;
127  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE_FAHRENHEIT:
128  _ambientTempFPeriod = sensorPeriod;
129  break;
130  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE_FAHRENHEIT:
131  _objectTempFPeriod = sensorPeriod;
132  break;
133  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_GAS_RESISTANCE:
134  _gasResistancePeriod = sensorPeriod;
135  break;
136  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_NOX_INDEX:
137  _NOxIndexPeriod = sensorPeriod;
138  break;
139  case wippersnapper_i2c_v1_SensorType_SENSOR_TYPE_VOC_INDEX:
140  _VOCIndexPeriod = sensorPeriod;
141  break;
142  default:
143  break;
144  }
145  }
146 
147  /*******************************************************************************/
154  /*******************************************************************************/
155  void
156  configureDriver(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq) {
157  int propertyIdx = 0; // contains the amount of i2c sensors in the
158  // msgDeviceInitReq to configure
159  while (propertyIdx < msgDeviceInitReq->i2c_device_properties_count) {
160  setSensorPeriod(
161  msgDeviceInitReq->i2c_device_properties[propertyIdx].sensor_period,
162  msgDeviceInitReq->i2c_device_properties[propertyIdx].sensor_type);
163  ++propertyIdx;
164  }
165  }
166 
167  /*******************************************************************************/
172  /*******************************************************************************/
173  uint16_t getI2CAddress() { return _sensorAddress; }
174 
175  /****************************** SENSOR_TYPE: CO2
176  * *******************************/
177  /*********************************************************************************/
183  /*********************************************************************************/
184  virtual long getSensorCO2Period() { return _CO2SensorPeriod; }
185 
186  /*********************************************************************************/
192  /*********************************************************************************/
193  virtual long getSensorCO2PeriodPrv() { return _CO2SensorPeriodPrv; }
194 
195  /*******************************************************************************/
201  /*******************************************************************************/
202  virtual void setSensorCO2PeriodPrv(long period) {
203  _CO2SensorPeriodPrv = period;
204  }
205 
206  /*******************************************************************************/
214  /*******************************************************************************/
215  virtual bool getEventCO2(sensors_event_t *co2Event) {
216  (void)
217  co2Event; // Parameter is intentionally unused in this virtual function.
218  return false;
219  }
220 
221  /****************************** SENSOR_TYPE: ECO2
222  * *******************************/
223  /*********************************************************************************/
229  /*********************************************************************************/
230  virtual long getSensorECO2Period() { return _ECO2SensorPeriod; }
231 
232  /*********************************************************************************/
238  /*********************************************************************************/
239  virtual long getSensorECO2PeriodPrv() { return _ECO2SensorPeriodPrv; }
240 
241  /*******************************************************************************/
247  /*******************************************************************************/
248  virtual void setSensorECO2PeriodPrv(long period) {
249  _ECO2SensorPeriodPrv = period;
250  }
251 
252  /*******************************************************************************/
260  /*******************************************************************************/
261  virtual bool getEventECO2(sensors_event_t *eco2Event) {
262  (void)eco2Event; // Parameter is intentionally unused in this virtual
263  // function.
264  return false;
265  }
266 
267  /****************************** SENSOR_TYPE: TVOC
268  * *******************************/
269  /*********************************************************************************/
275  /*********************************************************************************/
276  virtual long getSensorTVOCPeriod() { return _TVOCSensorPeriod; }
277 
278  /*********************************************************************************/
284  /*********************************************************************************/
285  virtual long getSensorTVOCPeriodPrv() { return _TVOCSensorPeriodPrv; }
286 
287  /*******************************************************************************/
293  /*******************************************************************************/
294  virtual void setSensorTVOCPeriodPrv(long period) {
295  _TVOCSensorPeriodPrv = period;
296  }
297 
298  /*******************************************************************************/
306  /*******************************************************************************/
307  virtual bool getEventTVOC(sensors_event_t *tvocEvent) {
308  (void)tvocEvent; // Parameter is intentionally unused in this virtual
309  // function.
310  return false;
311  }
312 
313  /********************** SENSOR_TYPE: AMBIENT TEMPERATURE (°C)
314  * ***********************/
315  /*********************************************************************************/
321  /*********************************************************************************/
322  virtual long getSensorAmbientTempPeriod() { return _tempSensorPeriod; }
323 
324  /*********************************************************************************/
331  /*********************************************************************************/
332  virtual long getSensorAmbientTempPeriodPrv() { return _tempSensorPeriodPrv; }
333 
334  /*******************************************************************************/
342  /*******************************************************************************/
343  virtual void setSensorAmbientTempPeriodPrv(long periodPrv) {
344  _tempSensorPeriodPrv = periodPrv;
345  }
346 
347  /*******************************************************************************/
356  /*******************************************************************************/
357  virtual bool getEventAmbientTemp(sensors_event_t *tempEvent) {
358  (void)tempEvent; // Parameter is intentionally unused in this virtual
359  // function.
360  return false;
361  }
362 
363  /************************* SENSOR_TYPE: RELATIVE_HUMIDITY
364  * ***********************/
365  /*********************************************************************************/
371  /*********************************************************************************/
372  virtual long getSensorRelativeHumidityPeriod() { return _humidSensorPeriod; }
373 
374  /*********************************************************************************/
380  /*********************************************************************************/
381  virtual long getSensorRelativeHumidityPeriodPrv() {
382  return _humidSensorPeriodPrv;
383  }
384 
385  /*******************************************************************************/
391  /*******************************************************************************/
392  virtual void setSensorRelativeHumidityPeriodPrv(long periodPrv) {
393  _humidSensorPeriodPrv = periodPrv;
394  }
395 
396  /*******************************************************************************/
405  /*******************************************************************************/
406  virtual bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
407  (void)humidEvent; // Parameter is intentionally unused in this virtual
408  // function.
409  return false;
410  }
411 
412  /**************************** SENSOR_TYPE: PRESSURE
413  * ****************************/
414  /*********************************************************************************/
420  /*********************************************************************************/
421  virtual long getSensorPressurePeriod() { return _pressureSensorPeriod; }
422 
423  /*********************************************************************************/
429  /*********************************************************************************/
430  virtual long getSensorPressurePeriodPrv() { return _pressureSensorPeriodPrv; }
431 
432  /*******************************************************************************/
438  /*******************************************************************************/
439  virtual void setSensorPressurePeriodPrv(long period) {
440  _pressureSensorPeriodPrv = period;
441  }
442 
443  /*******************************************************************************/
452  /*******************************************************************************/
453  virtual bool getEventPressure(sensors_event_t *pressureEvent) {
454  (void)pressureEvent; // Parameter is intentionally unused in this virtual
455  // function.
456  return false;
457  }
458 
459  /**************************** SENSOR_TYPE: Altitude
460  * ****************************/
461  /*********************************************************************************/
467  /*********************************************************************************/
468  virtual long getSensorAltitudePeriod() { return _altitudeSensorPeriod; }
469 
470  /*********************************************************************************/
476  /*********************************************************************************/
477  virtual long getSensorAltitudePeriodPrv() { return _altitudeSensorPeriodPrv; }
478 
479  /*******************************************************************************/
485  /*******************************************************************************/
486  virtual void setSensorAltitudePeriodPrv(long period) {
487  _altitudeSensorPeriodPrv = period;
488  }
489 
490  /*******************************************************************************/
499  /*******************************************************************************/
500  virtual bool getEventAltitude(sensors_event_t *altitudeEvent) {
501  (void)altitudeEvent; // Parameter is intentionally unused in this virtual
502  // function.
503  return false;
504  }
505 
506  /**************************** SENSOR_TYPE: Object_Temperature
507  * ****************************/
508  /*********************************************************************************/
515  /*********************************************************************************/
516  virtual long getSensorObjectTempPeriod() { return _objectTempSensorPeriod; }
517 
518  /*********************************************************************************/
525  /*********************************************************************************/
526  virtual long getSensorObjectTempPeriodPrv() {
527  return _objectTempSensorPeriodPrv;
528  }
529 
530  /*******************************************************************************/
537  /*******************************************************************************/
538  virtual void setSensorObjectTempPeriodPrv(long period) {
539  _objectTempSensorPeriodPrv = period;
540  }
541 
542  /*******************************************************************************/
551  /*******************************************************************************/
552  virtual bool getEventObjectTemp(sensors_event_t *objectTempEvent) {
553  (void)objectTempEvent; // Parameter is intentionally unused in this virtual
554  // function.
555  return false;
556  }
557 
558  /**************************** SENSOR_TYPE: LIGHT
559  * ****************************/
560  /*********************************************************************************/
567  /*********************************************************************************/
568  virtual long getSensorLightPeriod() { return _lightSensorPeriod; }
569 
570  /*********************************************************************************/
577  /*********************************************************************************/
578  virtual long getSensorLightPeriodPrv() { return _lightSensorPeriodPrv; }
579 
580  /*******************************************************************************/
587  /*******************************************************************************/
588  virtual void setSensorLightPeriodPrv(long period) {
589  _lightSensorPeriodPrv = period;
590  }
591 
592  /*******************************************************************************/
601  /*******************************************************************************/
602  virtual bool getEventLight(sensors_event_t *lightEvent) {
603  (void)lightEvent; // Parameter is intentionally unused in this virtual
604  // function.
605  return false;
606  }
607 
608  /**************************** SENSOR_TYPE: PM10_STD
609  * ****************************/
610  /*********************************************************************************/
617  /*********************************************************************************/
618  virtual long getSensorPM10_STDPeriod() { return _PM10SensorPeriod; }
619 
620  /*********************************************************************************/
627  /*********************************************************************************/
628  virtual long getSensorPM10_STDPeriodPrv() { return _PM10SensorPeriodPrv; }
629 
630  /*******************************************************************************/
637  /*******************************************************************************/
638  virtual void setSensorPM10_STDPeriodPrv(long period) {
639  _PM10SensorPeriodPrv = period;
640  }
641 
642  /*******************************************************************************/
651  /*******************************************************************************/
652  virtual bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
653  (void)pm10StdEvent; // Parameter is intentionally unused in this virtual
654  // function.
655  return false;
656  }
657 
658  /**************************** SENSOR_TYPE: PM25_STD
659  * ****************************/
660  /*********************************************************************************/
667  /*********************************************************************************/
668  virtual long getSensorPM25_STDPeriod() { return _PM25SensorPeriod; }
669 
670  /*********************************************************************************/
677  /*********************************************************************************/
678  virtual long getSensorPM25_STDPeriodPrv() { return _PM25SensorPeriodPrv; }
679 
680  /*******************************************************************************/
687  /*******************************************************************************/
688  virtual void setSensorPM25_STDPeriodPrv(long period) {
689  _PM25SensorPeriodPrv = period;
690  }
691 
692  /*******************************************************************************/
701  /*******************************************************************************/
702  virtual bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
703  (void)pm25StdEvent; // Parameter is intentionally unused in this virtual
704  // function.
705  return false;
706  }
707 
708  /**************************** SENSOR_TYPE: PM100_STD
709  * ****************************/
710  /*********************************************************************************/
717  /*********************************************************************************/
718  virtual long getSensorPM100_STDPeriod() { return _PM100SensorPeriod; }
719 
720  /*********************************************************************************/
727  /*********************************************************************************/
728  virtual long getSensorPM100_STDPeriodPrv() { return _PM100SensorPeriodPrv; }
729 
730  /*******************************************************************************/
737  /*******************************************************************************/
738  virtual void setSensorPM100_STDPeriodPrv(long period) {
739  _PM100SensorPeriodPrv = period;
740  }
741 
742  /*******************************************************************************/
751  /*******************************************************************************/
752  virtual bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
753  (void)pm100StdEvent; // Parameter is intentionally unused in this virtual
754  // function.
755  return false;
756  }
757 
758  /**************************** SENSOR_TYPE: UNITLESS_PERCENT
759  * ****************************/
760  /*********************************************************************************/
767  /*********************************************************************************/
768  virtual long getSensorUnitlessPercentPeriod() {
769  return _unitlessPercentPeriod;
770  }
771 
772  /*********************************************************************************/
779  /*********************************************************************************/
780  virtual long getSensorUnitlessPercentPeriodPrv() {
781  return _unitlessPercentPeriodPrv;
782  }
783 
784  /*******************************************************************************/
791  /*******************************************************************************/
792  virtual void setSensorUnitlessPercentPeriodPrv(long period) {
793  _unitlessPercentPeriodPrv = period;
794  }
795 
796  /*******************************************************************************/
805  /*******************************************************************************/
806  virtual bool getEventUnitlessPercent(sensors_event_t *unitlessPercentEvent) {
807  (void)unitlessPercentEvent; // Parameter is intentionally unused in this
808  // virtual function.
809  return false;
810  }
811 
812  /**************************** SENSOR_TYPE: VOLTAGE
813  * ****************************/
814  /*********************************************************************************/
820  /*********************************************************************************/
821  virtual long getSensorVoltagePeriod() { return _voltagePeriod; }
822 
823  /*********************************************************************************/
829  /*********************************************************************************/
830  virtual long getSensorVoltagePeriodPrv() { return _voltagePeriodPrv; }
831 
832  /*******************************************************************************/
838  /*******************************************************************************/
839  virtual void setSensorVoltagePeriodPrv(long period) {
840  _voltagePeriodPrv = period;
841  }
842 
843  /*******************************************************************************/
852  /*******************************************************************************/
853  virtual bool getEventVoltage(sensors_event_t *voltageEvent) {
854  (void)voltageEvent; // Parameter is intentionally unused in this virtual
855  // function.
856  return false;
857  }
858 
859  /**************************** SENSOR_TYPE: CURRENT
860  * ****************************/
861  /*********************************************************************************/
867  /*********************************************************************************/
868  virtual long getSensorCurrentPeriod() { return _currentPeriod; }
869 
870  /*********************************************************************************/
876  /*********************************************************************************/
877  virtual long getSensorCurrentPeriodPrv() { return _currentPeriodPrv; }
878 
879  /*******************************************************************************/
885  /*******************************************************************************/
886  virtual void setSensorCurrentPeriodPrv(long period) {
887  _currentPeriodPrv = period;
888  }
889 
890  /*******************************************************************************/
899  /*******************************************************************************/
900  virtual bool getEventCurrent(sensors_event_t *currentEvent) {
901  (void)currentEvent; // Parameter is intentionally unused in this virtual
902  // function.
903  return false;
904  }
905 
906  /****************************** SENSOR_TYPE: Raw
907  * *******************************/
908  /*********************************************************************************/
914  /*********************************************************************************/
915  virtual long getSensorRawPeriod() { return _rawSensorPeriod; }
916 
917  /*********************************************************************************/
923  /*********************************************************************************/
924  virtual long getSensorRawPeriodPrv() { return _rawSensorPeriodPrv; }
925 
926  /*******************************************************************************/
932  /*******************************************************************************/
933  virtual void setSensorRawPeriodPrv(long period) {
934  _rawSensorPeriodPrv = period;
935  }
936 
937  /*******************************************************************************/
945  /*******************************************************************************/
946  virtual bool getEventRaw(sensors_event_t *rawEvent) {
947  (void)
948  rawEvent; // Parameter is intentionally unused in this virtual function.
949  return false;
950  }
951 
952  /****************************** SENSOR_TYPE: Ambient Temp (°F)
953  * *******************************/
954 
955  /*******************************************************************************/
960  /*******************************************************************************/
961  virtual void disableAmbientTempF() { _ambientTempFPeriod = 0.0L; }
962 
963  /*********************************************************************************/
970  /*********************************************************************************/
971  virtual long getSensorAmbientTempFPeriod() { return _ambientTempFPeriod; }
972 
973  /*********************************************************************************/
980  /*********************************************************************************/
981  virtual long getSensorAmbientTempFPeriodPrv() {
982  return _ambientTempFPeriodPrv;
983  }
984 
985  /*******************************************************************************/
993  /*******************************************************************************/
994  virtual void setSensorAmbientTempFPeriodPrv(long period) {
995  _ambientTempFPeriodPrv = period;
996  }
997 
998  /*******************************************************************************/
1008  /*******************************************************************************/
1009  virtual bool getEventAmbientTempF(sensors_event_t *AmbientTempFEvent) {
1010  // obtain ambient temp. in °C
1011  if (!getEventAmbientTemp(AmbientTempFEvent))
1012  return false;
1013  // convert event from °C to °F
1014  AmbientTempFEvent->temperature =
1015  (AmbientTempFEvent->temperature * 9.0) / 5.0 + 32;
1016  return true;
1017  }
1018 
1019  /****************************** SENSOR_TYPE: Object Temp (°F)
1020  * *******************************/
1021  /*********************************************************************************/
1028  /*********************************************************************************/
1029  virtual long getSensorObjectTempFPeriod() { return _objectTempFPeriod; }
1030 
1031  /*********************************************************************************/
1038  /*********************************************************************************/
1039  virtual long getSensorObjectTempFPeriodPrv() { return _objectTempFPeriodPrv; }
1040 
1041  /*******************************************************************************/
1049  /*******************************************************************************/
1050  virtual void setSensorObjectTempFPeriodPrv(long period) {
1051  _objectTempFPeriodPrv = period;
1052  }
1053 
1054  /*******************************************************************************/
1064  /*******************************************************************************/
1065  virtual bool getEventObjectTempF(sensors_event_t *objectTempFEvent) {
1066  // obtain ambient temp. in °C
1067  if (!getEventObjectTemp(objectTempFEvent))
1068  return false;
1069  // convert event from °C to °F
1070  objectTempFEvent->temperature =
1071  (objectTempFEvent->temperature * 9.0) / 5.0 + 32.0;
1072  return true;
1073  }
1074 
1075  /****************************** SENSOR_TYPE: Gas Resistance (ohms)
1076  * *******************************/
1077  /*********************************************************************************/
1084  /*********************************************************************************/
1085  virtual long getSensorGasResistancePeriod() { return _gasResistancePeriod; }
1086 
1087  /*********************************************************************************/
1094  /*********************************************************************************/
1095  virtual long getSensorGasResistancePeriodPrv() {
1096  return _gasResistancePeriodPrv;
1097  }
1098 
1099  /*******************************************************************************/
1107  /*******************************************************************************/
1108  virtual void setSensorGasResistancePeriodPrv(long period) {
1109  _gasResistancePeriodPrv = period;
1110  }
1111 
1112  /*******************************************************************************/
1121  /*******************************************************************************/
1122  virtual bool getEventGasResistance(sensors_event_t *gasEvent) {
1123  (void)
1124  gasEvent; // Parameter is intentionally unused in this virtual function.
1125  return false;
1126  }
1127 
1128  /****************************** SENSOR_TYPE: NOx Index (index)
1129  * *******************************/
1130  /*********************************************************************************/
1137  /*********************************************************************************/
1138  virtual long getSensorNOxIndexPeriod() { return _NOxIndexPeriod; }
1139 
1140  /*********************************************************************************/
1147  /*********************************************************************************/
1148  virtual long getSensorNOxIndexPeriodPrv() { return _NOxIndexPeriodPrv; }
1149 
1150  /*******************************************************************************/
1158  /*******************************************************************************/
1159  virtual void setSensorNOxIndexPeriodPrv(long period) {
1160  _NOxIndexPeriodPrv = period;
1161  }
1162 
1163  /*******************************************************************************/
1172  /*******************************************************************************/
1173  virtual bool getEventNOxIndex(sensors_event_t *gasEvent) {
1174  (void)
1175  gasEvent; // Parameter is intentionally unused in this virtual function.
1176  return false;
1177  }
1178 
1179  /****************************** SENSOR_TYPE: VOC Index (index)
1180  * *******************************/
1181  /*********************************************************************************/
1188  /*********************************************************************************/
1189  virtual long getSensorVOCIndexPeriod() { return _VOCIndexPeriod; }
1190 
1191  /*********************************************************************************/
1198  /*********************************************************************************/
1199  virtual long getSensorVOCIndexPeriodPrv() { return _VOCIndexPeriodPrv; }
1200 
1201  /*******************************************************************************/
1209  /*******************************************************************************/
1210  virtual void setSensorVOCIndexPeriodPrv(long period) {
1211  _VOCIndexPeriodPrv = period;
1212  }
1213 
1214  /*******************************************************************************/
1223  /*******************************************************************************/
1224  virtual bool getEventVOCIndex(sensors_event_t *gasEvent) {
1225  (void)
1226  gasEvent; // Parameter is intentionally unused in this virtual function.
1227  return false;
1228  }
1229 
1230  /**************************** SENSOR_TYPE: PROXIMITY
1231  * ****************************/
1232  /*******************************************************************************/
1236  /*******************************************************************************/
1237  virtual void enableSensorProximity() {};
1238 
1239  /*******************************************************************************/
1243  /*******************************************************************************/
1244  virtual void disableSensorProximity() { _proximitySensorPeriod = 0.0L; }
1245 
1246  /*********************************************************************************/
1253  /*********************************************************************************/
1254  virtual long sensorProximityPeriod() { return _proximitySensorPeriod; }
1255 
1256  /*******************************************************************************/
1263  /*******************************************************************************/
1264  virtual void setSensorProximityPeriod(long period) {
1265  if (period == 0)
1266  disableSensorProximity();
1267  _proximitySensorPeriod = period;
1268  }
1269 
1270  /*********************************************************************************/
1277  /*********************************************************************************/
1278  virtual long SensorProximityPeriodPrv() { return _proximitySensorPeriodPrv; }
1279 
1280  /*******************************************************************************/
1287  /*******************************************************************************/
1288  virtual void setSensorProximityPeriodPrv(long period) {
1289  _proximitySensorPeriodPrv = period;
1290  }
1291 
1292  /*******************************************************************************/
1301  /*******************************************************************************/
1302  virtual bool getEventProximity(sensors_event_t *proximityEvent) {
1303  (void)proximityEvent; // Parameter is intentionally unused in this virtual
1304  // function.
1305  return false;
1306  }
1307 
1308  /*******************************************************************************/
1315  /*******************************************************************************/
1316  virtual void updateSensorProximity(float period) {
1317  setSensorProximityPeriod(period);
1318  }
1319 
1320 protected:
1321  TwoWire *_i2c;
1322  uint16_t _sensorAddress;
1323  long _tempSensorPeriod =
1324  0L;
1325  long _tempSensorPeriodPrv =
1326  PERIOD_24HRS_AGO_MILLIS;
1327  long _humidSensorPeriod =
1329  0L;
1330  long _humidSensorPeriodPrv =
1331  PERIOD_24HRS_AGO_MILLIS;
1332  long _pressureSensorPeriod =
1334  0L;
1335  long _pressureSensorPeriodPrv =
1336  PERIOD_24HRS_AGO_MILLIS;
1337  long _CO2SensorPeriod =
1339  0L;
1340  long _CO2SensorPeriodPrv =
1341  PERIOD_24HRS_AGO_MILLIS;
1342  long _ECO2SensorPeriod =
1343  0L;
1344  long _ECO2SensorPeriodPrv =
1345  PERIOD_24HRS_AGO_MILLIS;
1346  long _TVOCSensorPeriod =
1347  0L;
1348  long _TVOCSensorPeriodPrv =
1349  PERIOD_24HRS_AGO_MILLIS;
1350  long _altitudeSensorPeriod =
1351  0L;
1352  long _altitudeSensorPeriodPrv =
1353  PERIOD_24HRS_AGO_MILLIS;
1354  long _objectTempSensorPeriod = 0L;
1356  long _objectTempSensorPeriodPrv =
1358  PERIOD_24HRS_AGO_MILLIS;
1359  long _lightSensorPeriod =
1361  0L;
1362  long _lightSensorPeriodPrv =
1363  PERIOD_24HRS_AGO_MILLIS;
1364  long _PM10SensorPeriod =
1366  0L;
1367  long _PM10SensorPeriodPrv =
1368  PERIOD_24HRS_AGO_MILLIS;
1369  long _PM25SensorPeriod =
1370  0L;
1371  long _PM25SensorPeriodPrv =
1372  PERIOD_24HRS_AGO_MILLIS;
1373  long _PM100SensorPeriod =
1374  0L;
1375  long _PM100SensorPeriodPrv =
1376  PERIOD_24HRS_AGO_MILLIS;
1377  long _unitlessPercentPeriod =
1379  0L;
1380  long _unitlessPercentPeriodPrv =
1381  PERIOD_24HRS_AGO_MILLIS;
1382  long _voltagePeriod =
1384  0L;
1385  long _voltagePeriodPrv =
1386  PERIOD_24HRS_AGO_MILLIS;
1387  long _currentPeriod =
1389  0L;
1390  long _currentPeriodPrv =
1391  PERIOD_24HRS_AGO_MILLIS;
1392  long _rawSensorPeriod =
1394  0L;
1395  long _rawSensorPeriodPrv =
1396  PERIOD_24HRS_AGO_MILLIS;
1397  long _ambientTempFPeriod = 0L;
1398  long _ambientTempFPeriodPrv =
1400  PERIOD_24HRS_AGO_MILLIS;
1401  long _objectTempFPeriod = 0L;
1403  long _objectTempFPeriodPrv =
1405  PERIOD_24HRS_AGO_MILLIS;
1406  long _gasResistancePeriod = 0L;
1408  long _gasResistancePeriodPrv =
1410  PERIOD_24HRS_AGO_MILLIS;
1411  long _NOxIndexPeriod =
1413  0L;
1414  long _NOxIndexPeriodPrv =
1415  PERIOD_24HRS_AGO_MILLIS;
1416  long _VOCIndexPeriod =
1418  0L;
1419  long _VOCIndexPeriodPrv =
1420  PERIOD_24HRS_AGO_MILLIS;
1421  long _proximitySensorPeriod =
1423  0L;
1424  long _proximitySensorPeriodPrv =
1425  PERIOD_24HRS_AGO_MILLIS;
1426 };
1428 
1429 #endif // WipperSnapper_I2C_Driver_H
WipperSnapper_I2C_Driver::_unitlessPercentPeriod
long _unitlessPercentPeriod
The time period between reading the unitless % sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1378
WipperSnapper_I2C_Driver::getSensorUnitlessPercentPeriodPrv
virtual long getSensorUnitlessPercentPeriodPrv()
Base implementation - Returns the previous time interval at which the unitless % sensor was queried l...
Definition: WipperSnapper_I2C_Driver.h:780
WipperSnapper_I2C_Driver::getSensorLightPeriodPrv
virtual long getSensorLightPeriodPrv()
Base implementation - Returns the previous time interval at which the light sensor was queried last...
Definition: WipperSnapper_I2C_Driver.h:578
WipperSnapper_I2C_Driver::getSensorObjectTempPeriodPrv
virtual long getSensorObjectTempPeriodPrv()
Base implementation - Returns the previous time interval at which the object temperature sensor was q...
Definition: WipperSnapper_I2C_Driver.h:526
diff --git a/html/_wipper_snapper___i2_c___driver___b_m_e680_8h_source.html b/html/_wipper_snapper___i2_c___driver___b_m_e680_8h_source.html index 08645dcd4..4f5d1a46a 100644 --- a/html/_wipper_snapper___i2_c___driver___b_m_e680_8h_source.html +++ b/html/_wipper_snapper___i2_c___driver___b_m_e680_8h_source.html @@ -66,7 +66,7 @@
WipperSnapper_I2C_Driver_BME680.h
-Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_I2C_Driver_BME680_H
17 #define WipperSnapper_I2C_Driver_BME680_H
18 
19 #include "WipperSnapper_I2C_Driver.h"
20 #include <Adafruit_BME680.h>
21 
22 #define SEALEVELPRESSURE_HPA (1013.25)
23 
24 /**************************************************************************/
29 /**************************************************************************/
30 class WipperSnapper_I2C_Driver_BME680 : public WipperSnapper_I2C_Driver {
31 
32 public:
33  /*******************************************************************************/
41  /*******************************************************************************/
42  WipperSnapper_I2C_Driver_BME680(TwoWire *i2c, uint16_t sensorAddress)
43  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
44  _i2c = i2c;
45  _sensorAddress = sensorAddress;
46  }
47 
48  /*******************************************************************************/
52  /*******************************************************************************/
53  ~WipperSnapper_I2C_Driver_BME680() { delete _bme; }
54 
55  /*******************************************************************************/
60  /*******************************************************************************/
61  bool begin() {
62  _bme = new Adafruit_BME680(_i2c);
63 
64  // attempt to initialize BME680
65  if (!_bme->begin(_sensorAddress))
66  return false;
67 
68  // Set up oversampling and filter initialization
69  // defaults from
70  // https://github.com/adafruit/Adafruit_BME680/blob/master/examples/bme680test/bme680test.ino
71  _bme->setTemperatureOversampling(BME680_OS_8X);
72  _bme->setHumidityOversampling(BME680_OS_2X);
73  _bme->setPressureOversampling(BME680_OS_4X);
74  _bme->setIIRFilterSize(BME680_FILTER_SIZE_3);
75  _bme->setGasHeater(320, 150); // 320*C for 150 ms
76 
77  return true;
78  }
79 
80  /*******************************************************************************/
85  /*******************************************************************************/
86  bool bmePerformReading() { return _bme->performReading(); }
87 
88  /*******************************************************************************/
96  /*******************************************************************************/
97  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
98  if (!bmePerformReading())
99  return false;
100  tempEvent->temperature = _bme->temperature;
101  return true;
102  }
103 
104  /*******************************************************************************/
112  /*******************************************************************************/
113  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
114  if (!bmePerformReading())
115  return false;
116  humidEvent->relative_humidity = _bme->humidity;
117  return true;
118  }
119 
120  /*******************************************************************************/
129  /*******************************************************************************/
130  bool getEventPressure(sensors_event_t *pressureEvent) {
131  if (!bmePerformReading())
132  return false;
133  pressureEvent->pressure = (float)_bme->pressure;
134  return true;
135  }
136 
137  /*******************************************************************************/
145  /*******************************************************************************/
146  bool getEventAltitude(sensors_event_t *altitudeEvent) {
147  if (!bmePerformReading())
148  return false;
149  altitudeEvent->altitude = (float)_bme->readAltitude(SEALEVELPRESSURE_HPA);
150  return true;
151  }
152 
153  /*******************************************************************************/
162  /*******************************************************************************/
163  virtual bool getEventGasResistance(sensors_event_t *gasEvent) {
164  if (!bmePerformReading())
165  return false;
166 
167  gasEvent->gas_resistance = (float)_bme->gas_resistance;
168  return true;
169  }
170 
171 protected:
172  Adafruit_BME680 *_bme;
173 };
174 
175 #endif // WipperSnapper_I2C_Driver_BME680
WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp
bool getEventAmbientTemp(sensors_event_t *tempEvent)
Gets the BME680&#39;s current temperature.
Definition: WipperSnapper_I2C_Driver_BME680.h:97
+Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_I2C_Driver_BME680_H
17 #define WipperSnapper_I2C_Driver_BME680_H
18 
19 #include "WipperSnapper_I2C_Driver.h"
20 #include <Adafruit_BME680.h>
21 
22 #define SEALEVELPRESSURE_HPA (1013.25)
23 
24 /**************************************************************************/
29 /**************************************************************************/
30 class WipperSnapper_I2C_Driver_BME680 : public WipperSnapper_I2C_Driver {
31 
32 public:
33  /*******************************************************************************/
41  /*******************************************************************************/
42  WipperSnapper_I2C_Driver_BME680(TwoWire *i2c, uint16_t sensorAddress)
43  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
44  _i2c = i2c;
45  _sensorAddress = sensorAddress;
46  }
47 
48  /*******************************************************************************/
52  /*******************************************************************************/
53  ~WipperSnapper_I2C_Driver_BME680() { delete _bme; }
54 
55  /*******************************************************************************/
60  /*******************************************************************************/
61  bool begin() {
62  _bme = new Adafruit_BME680(_i2c);
63 
64  // attempt to initialize BME680
65  if (!_bme->begin(_sensorAddress))
66  return false;
67 
68  // Set up oversampling and filter initialization
69  // defaults from
70  // https://github.com/adafruit/Adafruit_BME680/blob/master/examples/bme680test/bme680test.ino
71  _bme->setTemperatureOversampling(BME680_OS_8X);
72  _bme->setHumidityOversampling(BME680_OS_2X);
73  _bme->setPressureOversampling(BME680_OS_4X);
74  _bme->setIIRFilterSize(BME680_FILTER_SIZE_3);
75  _bme->setGasHeater(320, 150); // 320*C for 150 ms
76 
77  return true;
78  }
79 
80  /*******************************************************************************/
85  /*******************************************************************************/
86  bool bmePerformReading() { return _bme->performReading(); }
87 
88  /*******************************************************************************/
96  /*******************************************************************************/
97  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
98  if (!bmePerformReading())
99  return false;
100  tempEvent->temperature = _bme->temperature;
101  return true;
102  }
103 
104  /*******************************************************************************/
112  /*******************************************************************************/
113  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
114  if (!bmePerformReading())
115  return false;
116  humidEvent->relative_humidity = _bme->humidity;
117  return true;
118  }
119 
120  /*******************************************************************************/
129  /*******************************************************************************/
130  bool getEventPressure(sensors_event_t *pressureEvent) {
131  if (!bmePerformReading())
132  return false;
133  pressureEvent->pressure = (float)_bme->pressure / 100.0;
134  return true;
135  }
136 
137  /*******************************************************************************/
145  /*******************************************************************************/
146  bool getEventAltitude(sensors_event_t *altitudeEvent) {
147  if (!bmePerformReading())
148  return false;
149  altitudeEvent->altitude = (float)_bme->readAltitude(SEALEVELPRESSURE_HPA);
150  return true;
151  }
152 
153  /*******************************************************************************/
162  /*******************************************************************************/
163  virtual bool getEventGasResistance(sensors_event_t *gasEvent) {
164  if (!bmePerformReading())
165  return false;
166 
167  gasEvent->gas_resistance = (float)_bme->gas_resistance;
168  return true;
169  }
170 
171 protected:
172  Adafruit_BME680 *_bme;
173 };
174 
175 #endif // WipperSnapper_I2C_Driver_BME680
WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp
bool getEventAmbientTemp(sensors_event_t *tempEvent)
Gets the BME680&#39;s current temperature.
Definition: WipperSnapper_I2C_Driver_BME680.h:97
WipperSnapper_I2C_Driver_BME680::WipperSnapper_I2C_Driver_BME680
WipperSnapper_I2C_Driver_BME680(TwoWire *i2c, uint16_t sensorAddress)
Constructor for an BME680 sensor.
Definition: WipperSnapper_I2C_Driver_BME680.h:42
WipperSnapper_I2C_Driver_BME680::getEventRelativeHumidity
bool getEventRelativeHumidity(sensors_event_t *humidEvent)
Gets the BME680&#39;s current relative humidity reading.
Definition: WipperSnapper_I2C_Driver_BME680.h:113
SEALEVELPRESSURE_HPA
#define SEALEVELPRESSURE_HPA
Default sea level pressure, in hPa.
Definition: WipperSnapper_I2C_Driver_BME680.h:22
diff --git a/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html b/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html index e6cff6ab3..cf286b586 100644 --- a/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html +++ b/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html @@ -81,9 +81,9 @@  

Detailed Description

-

Device driver for the SEN5X CO2, Temperature, and Humidity sensor. TEMPORARY HACK

+

Device driver for the SEN5X air quality sensors.

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

-

Copyright (c) Marni Brewster 2022 for Adafruit Industries.

+

Copyright (c) Tyeth Gundry 2022 for Adafruit Industries.

MIT license, all text here must be included in any redistribution.

diff --git a/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html b/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html index d61f62f72..b54c812a6 100644 --- a/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html +++ b/html/_wipper_snapper___i2_c___driver___s_e_n5_x_8h_source.html @@ -66,26 +66,26 @@
WipperSnapper_I2C_Driver_SEN5X.h
-Go to the documentation of this file.
1 
17 #ifndef WipperSnapper_I2C_Driver_SEN5X_H
18 #define WipperSnapper_I2C_Driver_SEN5X_H
19 
20 #include "WipperSnapper_I2C_Driver.h"
21 #include <SensirionI2CSen5x.h>
22 #include <Wire.h>
23 
24 /**************************************************************************/
28 /**************************************************************************/
29 class WipperSnapper_I2C_Driver_SEN5X : public WipperSnapper_I2C_Driver {
30 
31  const float OVERFLOW_SEN55 = (0xFFFF / 10); // maxes out at u_int16 / 10
32 
33 public:
34  /*******************************************************************************/
42  /*******************************************************************************/
43  WipperSnapper_I2C_Driver_SEN5X(TwoWire *i2c, uint16_t sensorAddress)
44  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
45  _i2c = i2c;
46  _sensorAddress = sensorAddress;
47  }
48 
49  /*******************************************************************************/
54  /*******************************************************************************/
55  bool begin() {
56  _sen = new SensirionI2CSen5x();
57  _sen->begin(*_i2c);
58  u_int16_t error_stop = _sen->deviceReset();
59  if (error_stop != 0) {
60  return false;
61  }
62  // Wait 1 second for sensors to start recording + 100ms for reset command
63  delay(1100);
64  u_int16_t error_start = _sen->startMeasurement();
65  if (error_start != 0) {
66  return false;
67  }
68 
69  return true;
70  }
71 
72  /*******************************************************************************/
80  /*******************************************************************************/
81  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
82  float massConcentrationPm1p0, massConcentrationPm2p5,
83  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
84  ambientTemperature, vocIndex, noxIndex;
85  uint16_t error;
86 
87  error = _sen->readMeasuredValues(
88  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
89  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
90  noxIndex);
91  if ((_tempSensorPeriod != 0 && error != 0) || ambientTemperature == NAN) {
92  return false;
93  }
94 
95  tempEvent->temperature = ambientTemperature;
96  return true;
97  }
98 
99  /*******************************************************************************/
107  /*******************************************************************************/
108  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
109  float massConcentrationPm1p0, massConcentrationPm2p5,
110  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
111  ambientTemperature, vocIndex, noxIndex;
112  uint16_t error;
113 
114  error = _sen->readMeasuredValues(
115  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
116  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
117  noxIndex);
118  if ((_humidSensorPeriod != 0 && error != 0) || ambientHumidity == NAN) {
119  return false;
120  }
121 
122  humidEvent->relative_humidity = ambientHumidity;
123  return true;
124  }
125 
126  /*******************************************************************************/
137  /*******************************************************************************/
138  bool getEventNOxIndex(sensors_event_t *noxIndexEvent) {
139  float massConcentrationPm1p0, massConcentrationPm2p5,
140  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
141  ambientTemperature, vocIndex, noxIndex;
142  uint16_t error;
143 
144  error = _sen->readMeasuredValues(
145  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
146  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
147  noxIndex);
148  if ((_NOxIndexPeriod != 0 && error != 0) || noxIndex == NAN) {
149  return false;
150  }
151 
152  noxIndexEvent->nox_index = noxIndex;
153  return true;
154  }
155 
156  /*******************************************************************************/
164  /*******************************************************************************/
165  bool getEventVOCIndex(sensors_event_t *vocIndexEvent) {
166  float massConcentrationPm1p0, massConcentrationPm2p5,
167  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
168  ambientTemperature, vocIndex, noxIndex;
169  uint16_t error;
170 
171  error = _sen->readMeasuredValues(
172  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
173  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
174  noxIndex);
175  if ((_VOCIndexPeriod != 0 && error != 0) || vocIndex == NAN) {
176  return false;
177  }
178 
179  vocIndexEvent->voc_index = vocIndex;
180  return true;
181  }
182 
183  /*******************************************************************************/
191  /*******************************************************************************/
192  bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
193  float massConcentrationPm1p0, massConcentrationPm2p5,
194  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
195  ambientTemperature, vocIndex, noxIndex;
196  uint16_t error;
197 
198  error = _sen->readMeasuredValues(
199  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
200  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
201  noxIndex);
202  if ((_PM10SensorPeriod != 0 && error != 0) ||
203  massConcentrationPm1p0 == NAN ||
204  massConcentrationPm1p0 == OVERFLOW_SEN55) {
205  return false;
206  }
207 
208  pm10StdEvent->pm10_std = massConcentrationPm1p0;
209  return true;
210  }
211 
212  /*******************************************************************************/
220  /*******************************************************************************/
221  bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
222  float massConcentrationPm1p0, massConcentrationPm2p5,
223  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
224  ambientTemperature, vocIndex, noxIndex;
225  uint16_t error;
226 
227  error = _sen->readMeasuredValues(
228  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
229  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
230  noxIndex);
231  if ((_PM25SensorPeriod != 0 && error != 0) ||
232  massConcentrationPm2p5 == NAN ||
233  massConcentrationPm2p5 == OVERFLOW_SEN55) {
234  return false;
235  }
236 
237  pm25StdEvent->pm25_std = massConcentrationPm2p5;
238  return true;
239  }
240 
241  /*******************************************************************************/
249  /*******************************************************************************/
250  bool getEventPM40_STD(sensors_event_t *pm40StdEvent) {
251  float massConcentrationPm1p0, massConcentrationPm2p5,
252  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
253  ambientTemperature, vocIndex, noxIndex;
254  uint16_t error;
255 
256  error = _sen->readMeasuredValues(
257  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
258  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
259  noxIndex);
260  if ((_PM25SensorPeriod != 0 && error != 0) ||
261  massConcentrationPm4p0 == NAN ||
262  massConcentrationPm4p0 == OVERFLOW_SEN55) {
263  return false;
264  }
265 
266  pm40StdEvent->data[0] = massConcentrationPm4p0;
267  return true;
268  }
269 
270  /*******************************************************************************/
278  /*******************************************************************************/
279  bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
280  float massConcentrationPm1p0, massConcentrationPm2p5,
281  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
282  ambientTemperature, vocIndex, noxIndex;
283  uint16_t error;
284 
285  error = _sen->readMeasuredValues(
286  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
287  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
288  noxIndex);
289  if ((_PM100SensorPeriod != 0 && error != 0) ||
290  massConcentrationPm10p0 == NAN ||
291  massConcentrationPm10p0 == OVERFLOW_SEN55) {
292  return false;
293  }
294 
295  pm100StdEvent->pm100_std = massConcentrationPm10p0;
296  return true;
297  }
298 
299 protected:
300  SensirionI2CSen5x *_sen;
301 };
302 
303 #endif // WipperSnapper_I2C_Driver_SEN5X
WipperSnapper_I2C_Driver_SEN5X::_sen
SensirionI2CSen5x * _sen
SEN5X driver object.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:300
-
WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex
bool getEventVOCIndex(sensors_event_t *vocIndexEvent)
Gets the SEN5X&#39;s current VOC reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:165
+Go to the documentation of this file.
1 
16 #ifndef WipperSnapper_I2C_Driver_SEN5X_H
17 #define WipperSnapper_I2C_Driver_SEN5X_H
18 
19 #include "WipperSnapper_I2C_Driver.h"
20 #include <SensirionI2CSen5x.h>
21 #include <Wire.h>
22 
23 /**************************************************************************/
27 /**************************************************************************/
28 class WipperSnapper_I2C_Driver_SEN5X : public WipperSnapper_I2C_Driver {
29 
30  const float OVERFLOW_SEN55 = (0xFFFF / 10); // maxes out at u_int16 / 10
31 
32 public:
33  /*******************************************************************************/
41  /*******************************************************************************/
42  WipperSnapper_I2C_Driver_SEN5X(TwoWire *i2c, uint16_t sensorAddress)
43  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
44  _i2c = i2c;
45  _sensorAddress = sensorAddress;
46  }
47 
48  /*******************************************************************************/
53  /*******************************************************************************/
54  bool begin() {
55  _sen = new SensirionI2CSen5x();
56  _sen->begin(*_i2c);
57  u_int16_t error_stop = _sen->deviceReset();
58  if (error_stop != 0) {
59  return false;
60  }
61  // Wait 1 second for sensors to start recording + 100ms for reset command
62  delay(1100);
63  u_int16_t error_start = _sen->startMeasurement();
64  if (error_start != 0) {
65  return false;
66  }
67 
68  return true;
69  }
70 
71  /*******************************************************************************/
79  /*******************************************************************************/
80  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
81  float massConcentrationPm1p0, massConcentrationPm2p5,
82  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
83  ambientTemperature, vocIndex, noxIndex;
84  uint16_t error;
85 
86  error = _sen->readMeasuredValues(
87  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
88  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
89  noxIndex);
90  if ((_tempSensorPeriod != 0 && error != 0) || ambientTemperature == NAN) {
91  return false;
92  }
93 
94  tempEvent->temperature = ambientTemperature;
95  return true;
96  }
97 
98  /*******************************************************************************/
106  /*******************************************************************************/
107  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
108  float massConcentrationPm1p0, massConcentrationPm2p5,
109  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
110  ambientTemperature, vocIndex, noxIndex;
111  uint16_t error;
112 
113  error = _sen->readMeasuredValues(
114  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
115  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
116  noxIndex);
117  if ((_humidSensorPeriod != 0 && error != 0) || ambientHumidity == NAN) {
118  return false;
119  }
120 
121  humidEvent->relative_humidity = ambientHumidity;
122  return true;
123  }
124 
125  /*******************************************************************************/
136  /*******************************************************************************/
137  bool getEventNOxIndex(sensors_event_t *noxIndexEvent) {
138  float massConcentrationPm1p0, massConcentrationPm2p5,
139  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
140  ambientTemperature, vocIndex, noxIndex;
141  uint16_t error;
142 
143  error = _sen->readMeasuredValues(
144  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
145  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
146  noxIndex);
147  if ((_NOxIndexPeriod != 0 && error != 0) || noxIndex == NAN) {
148  return false;
149  }
150 
151  noxIndexEvent->nox_index = noxIndex;
152  return true;
153  }
154 
155  /*******************************************************************************/
163  /*******************************************************************************/
164  bool getEventVOCIndex(sensors_event_t *vocIndexEvent) {
165  float massConcentrationPm1p0, massConcentrationPm2p5,
166  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
167  ambientTemperature, vocIndex, noxIndex;
168  uint16_t error;
169 
170  error = _sen->readMeasuredValues(
171  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
172  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
173  noxIndex);
174  if ((_VOCIndexPeriod != 0 && error != 0) || vocIndex == NAN) {
175  return false;
176  }
177 
178  vocIndexEvent->voc_index = vocIndex;
179  return true;
180  }
181 
182  /*******************************************************************************/
190  /*******************************************************************************/
191  bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
192  float massConcentrationPm1p0, massConcentrationPm2p5,
193  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
194  ambientTemperature, vocIndex, noxIndex;
195  uint16_t error;
196 
197  error = _sen->readMeasuredValues(
198  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
199  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
200  noxIndex);
201  if ((_PM10SensorPeriod != 0 && error != 0) ||
202  massConcentrationPm1p0 == NAN ||
203  massConcentrationPm1p0 == OVERFLOW_SEN55) {
204  return false;
205  }
206 
207  pm10StdEvent->pm10_std = massConcentrationPm1p0;
208  return true;
209  }
210 
211  /*******************************************************************************/
219  /*******************************************************************************/
220  bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
221  float massConcentrationPm1p0, massConcentrationPm2p5,
222  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
223  ambientTemperature, vocIndex, noxIndex;
224  uint16_t error;
225 
226  error = _sen->readMeasuredValues(
227  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
228  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
229  noxIndex);
230  if ((_PM25SensorPeriod != 0 && error != 0) ||
231  massConcentrationPm2p5 == NAN ||
232  massConcentrationPm2p5 == OVERFLOW_SEN55) {
233  return false;
234  }
235 
236  pm25StdEvent->pm25_std = massConcentrationPm2p5;
237  return true;
238  }
239 
240  /*******************************************************************************/
248  /*******************************************************************************/
249  bool getEventPM40_STD(sensors_event_t *pm40StdEvent) {
250  float massConcentrationPm1p0, massConcentrationPm2p5,
251  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
252  ambientTemperature, vocIndex, noxIndex;
253  uint16_t error;
254 
255  error = _sen->readMeasuredValues(
256  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
257  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
258  noxIndex);
259  if ((_PM25SensorPeriod != 0 && error != 0) ||
260  massConcentrationPm4p0 == NAN ||
261  massConcentrationPm4p0 == OVERFLOW_SEN55) {
262  return false;
263  }
264 
265  pm40StdEvent->data[0] = massConcentrationPm4p0;
266  return true;
267  }
268 
269  /*******************************************************************************/
277  /*******************************************************************************/
278  bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
279  float massConcentrationPm1p0, massConcentrationPm2p5,
280  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
281  ambientTemperature, vocIndex, noxIndex;
282  uint16_t error;
283 
284  error = _sen->readMeasuredValues(
285  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
286  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
287  noxIndex);
288  if ((_PM100SensorPeriod != 0 && error != 0) ||
289  massConcentrationPm10p0 == NAN ||
290  massConcentrationPm10p0 == OVERFLOW_SEN55) {
291  return false;
292  }
293 
294  pm100StdEvent->pm100_std = massConcentrationPm10p0;
295  return true;
296  }
297 
298 protected:
299  SensirionI2CSen5x *_sen;
300 };
301 
302 #endif // WipperSnapper_I2C_Driver_SEN5X
WipperSnapper_I2C_Driver_SEN5X::_sen
SensirionI2CSen5x * _sen
SEN5X driver object.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:299
+
WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex
bool getEventVOCIndex(sensors_event_t *vocIndexEvent)
Gets the SEN5X&#39;s current VOC reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:164
WipperSnapper_I2C_Driver::_PM10SensorPeriod
long _PM10SensorPeriod
The time period between reading the pm25 sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1365
WipperSnapper_I2C_Driver::_PM100SensorPeriod
long _PM100SensorPeriod
The time period between reading the pm100_std sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1373
-
WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity
bool getEventRelativeHumidity(sensors_event_t *humidEvent)
Gets the SEN5X&#39;s current relative humidity reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:108
-
WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD
bool getEventPM25_STD(sensors_event_t *pm25StdEvent)
Gets the SEN5X sensor&#39;s PM2.5 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:221
-
WipperSnapper_I2C_Driver_SEN5X::WipperSnapper_I2C_Driver_SEN5X
WipperSnapper_I2C_Driver_SEN5X(TwoWire *i2c, uint16_t sensorAddress)
Constructor for a SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:43
-
WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD
bool getEventPM100_STD(sensors_event_t *pm100StdEvent)
Gets the SEN5X sensor&#39;s PM10.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:279
+
WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity
bool getEventRelativeHumidity(sensors_event_t *humidEvent)
Gets the SEN5X&#39;s current relative humidity reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:107
+
WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD
bool getEventPM25_STD(sensors_event_t *pm25StdEvent)
Gets the SEN5X sensor&#39;s PM2.5 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:220
+
WipperSnapper_I2C_Driver_SEN5X::WipperSnapper_I2C_Driver_SEN5X
WipperSnapper_I2C_Driver_SEN5X(TwoWire *i2c, uint16_t sensorAddress)
Constructor for a SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:42
+
WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD
bool getEventPM100_STD(sensors_event_t *pm100StdEvent)
Gets the SEN5X sensor&#39;s PM10.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:278
WipperSnapper_I2C_Driver::_tempSensorPeriod
long _tempSensorPeriod
The time period between reading the temperature sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1323
-
WipperSnapper_I2C_Driver_SEN5X::getEventPM40_STD
bool getEventPM40_STD(sensors_event_t *pm40StdEvent)
Gets the SEN5X sensor&#39;s PM4.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:250
+
WipperSnapper_I2C_Driver_SEN5X::getEventPM40_STD
bool getEventPM40_STD(sensors_event_t *pm40StdEvent)
Gets the SEN5X sensor&#39;s PM4.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:249
WipperSnapper_I2C_Driver
Base class for I2C Drivers.
Definition: WipperSnapper_I2C_Driver.h:30
-
WipperSnapper_I2C_Driver_SEN5X
Class that provides a driver interface for the SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:29
-
WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex
bool getEventNOxIndex(sensors_event_t *noxIndexEvent)
Gets the SEN5X&#39;s current NOX reading. Note: If this value is unknown, which is true for SEN54...
Definition: WipperSnapper_I2C_Driver_SEN5X.h:138
+
WipperSnapper_I2C_Driver_SEN5X
Class that provides a driver interface for the SEN5X sensor.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:28
+
WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex
bool getEventNOxIndex(sensors_event_t *noxIndexEvent)
Gets the SEN5X&#39;s current NOX reading. Note: If this value is unknown, which is true for SEN54...
Definition: WipperSnapper_I2C_Driver_SEN5X.h:137
WipperSnapper_I2C_Driver::_humidSensorPeriod
long _humidSensorPeriod
The time period between reading the humidity sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1328
-
WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD
bool getEventPM10_STD(sensors_event_t *pm10StdEvent)
Gets the SEN5X sensor&#39;s PM1.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:192
+
WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD
bool getEventPM10_STD(sensors_event_t *pm10StdEvent)
Gets the SEN5X sensor&#39;s PM1.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:191
WipperSnapper_I2C_Driver::_sensorAddress
uint16_t _sensorAddress
The I2C driver&#39;s unique I2C address.
Definition: WipperSnapper_I2C_Driver.h:1322
WipperSnapper_I2C_Driver::_VOCIndexPeriod
long _VOCIndexPeriod
The time period between reading the VOC Index sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1417
-
WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp
bool getEventAmbientTemp(sensors_event_t *tempEvent)
Gets the SEN5X&#39;s current temperature.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:81
+
WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp
bool getEventAmbientTemp(sensors_event_t *tempEvent)
Gets the SEN5X&#39;s current temperature.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:80
WipperSnapper_I2C_Driver.h
-
WipperSnapper_I2C_Driver_SEN5X::begin
bool begin()
Initializes the SEN5X sensor and begins I2C.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:55
+
WipperSnapper_I2C_Driver_SEN5X::begin
bool begin()
Initializes the SEN5X sensor and begins I2C.
Definition: WipperSnapper_I2C_Driver_SEN5X.h:54
WipperSnapper_I2C_Driver::_PM25SensorPeriod
long _PM25SensorPeriod
The time period between reading the pm25 sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1369
WipperSnapper_I2C_Driver::_NOxIndexPeriod
long _NOxIndexPeriod
The time period between reading the NOx Index sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1412
WipperSnapper_I2C_Driver::_i2c
TwoWire * _i2c
Pointer to the I2C driver&#39;s Wire object.
Definition: WipperSnapper_I2C_Driver.h:1321
diff --git a/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html b/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html new file mode 100644 index 000000000..3cd126ddb --- /dev/null +++ b/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html @@ -0,0 +1,96 @@ + + + + + + + +Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_SEN6X.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
WipperSnapper_I2C_Driver_SEN6X.h File Reference
+
+
+
#include "WipperSnapper_I2C_Driver.h"
+#include <SensirionI2cSen66.h>
+#include <Wire.h>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  WipperSnapper_I2C_Driver_SEN6X
 Class that provides a driver interface for the SEN6X sensor. More...
 
+

Detailed Description

+

Device driver for the SEN66 Particulate Matter, Temperature, Humidity, VOC, NOX, and CO2 sensor.

+

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

+

Copyright (c) Tyeth Gundry 2022 for Adafruit Industries. Modified (c) by Martin Ebner 2024 https://github.com/MartinEbnerSensirion

+

MIT license, all text here must be included in any redistribution.

+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html b/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html new file mode 100644 index 000000000..02a0baa36 --- /dev/null +++ b/html/_wipper_snapper___i2_c___driver___s_e_n6_x_8h_source.html @@ -0,0 +1,102 @@ + + + + + + + +Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_SEN6X.h Source File + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
WipperSnapper_I2C_Driver_SEN6X.h
+
+
+Go to the documentation of this file.
1 
18 #ifndef WipperSnapper_I2C_Driver_SEN6X_H
19 #define WipperSnapper_I2C_Driver_SEN6X_H
20 
21 #include "WipperSnapper_I2C_Driver.h"
22 #include <SensirionI2cSen66.h>
23 #include <Wire.h>
24 
25 /**************************************************************************/
29 /**************************************************************************/
30 class WipperSnapper_I2C_Driver_SEN6X : public WipperSnapper_I2C_Driver {
31 
32  const float OVERFLOW_SEN6X = (0xFFFF / 10); // maxes out at u_int16 / 10
33 
34 public:
35  /*******************************************************************************/
43  /*******************************************************************************/
44  WipperSnapper_I2C_Driver_SEN6X(TwoWire *i2c, uint16_t sensorAddress)
45  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
46  _i2c = i2c;
47  _sensorAddress = sensorAddress;
48  }
49 
50  /*******************************************************************************/
55  /*******************************************************************************/
56  bool begin() {
57  _sen = new SensirionI2cSen66();
58  _sen->begin(*_i2c, (uint8_t)_sensorAddress);
59  u_int16_t error_stop = _sen->deviceReset();
60  if (error_stop != 0) {
61  return false;
62  }
63  // Wait 1 second for sensors to start recording + 100ms for reset command
64  delay(1100);
65  u_int16_t error_start = _sen->startContinuousMeasurement();
66  if (error_start != 0) {
67  return false;
68  }
69 
70  return true;
71  }
72 
73  /*******************************************************************************/
81  /*******************************************************************************/
82  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
83  float massConcentrationPm1p0, massConcentrationPm2p5,
84  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
85  ambientTemperature, vocIndex, noxIndex;
86  uint16_t co2;
87  uint16_t error;
88 
89  error = _sen->readMeasuredValues(
90  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
91  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
92  noxIndex, co2);
93  if ((_tempSensorPeriod != 0 && error != 0) || ambientTemperature == NAN) {
94  return false;
95  }
96 
97  tempEvent->temperature = ambientTemperature;
98  return true;
99  }
100 
101  /*******************************************************************************/
109  /*******************************************************************************/
110  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
111  float massConcentrationPm1p0, massConcentrationPm2p5,
112  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
113  ambientTemperature, vocIndex, noxIndex;
114  uint16_t co2;
115  uint16_t error;
116 
117  error = _sen->readMeasuredValues(
118  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
119  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
120  noxIndex, co2);
121  if ((_humidSensorPeriod != 0 && error != 0) || ambientHumidity == NAN) {
122  return false;
123  }
124 
125  humidEvent->relative_humidity = ambientHumidity;
126  return true;
127  }
128 
129  /*******************************************************************************/
140  /*******************************************************************************/
141  bool getEventNOxIndex(sensors_event_t *noxIndexEvent) {
142  float massConcentrationPm1p0, massConcentrationPm2p5,
143  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
144  ambientTemperature, vocIndex, noxIndex;
145  uint16_t co2;
146  uint16_t error;
147 
148  error = _sen->readMeasuredValues(
149  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
150  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
151  noxIndex, co2);
152  if ((_NOxIndexPeriod != 0 && error != 0) || noxIndex == NAN) {
153  return false;
154  }
155 
156  noxIndexEvent->nox_index = noxIndex;
157  return true;
158  }
159 
160  /*******************************************************************************/
168  /*******************************************************************************/
169  bool getEventVOCIndex(sensors_event_t *vocIndexEvent) {
170  float massConcentrationPm1p0, massConcentrationPm2p5,
171  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
172  ambientTemperature, vocIndex, noxIndex;
173  uint16_t co2;
174  uint16_t error;
175 
176  error = _sen->readMeasuredValues(
177  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
178  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
179  noxIndex, co2);
180  if ((_VOCIndexPeriod != 0 && error != 0) || vocIndex == NAN) {
181  return false;
182  }
183 
184  vocIndexEvent->voc_index = vocIndex;
185  return true;
186  }
187 
188  /*******************************************************************************/
196  /*******************************************************************************/
197  bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
198  float massConcentrationPm1p0, massConcentrationPm2p5,
199  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
200  ambientTemperature, vocIndex, noxIndex;
201  uint16_t co2;
202  uint16_t error;
203 
204  error = _sen->readMeasuredValues(
205  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
206  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
207  noxIndex, co2);
208  if ((_PM10SensorPeriod != 0 && error != 0) ||
209  massConcentrationPm1p0 == NAN ||
210  massConcentrationPm1p0 == OVERFLOW_SEN6X) {
211  return false;
212  }
213 
214  pm10StdEvent->pm10_std = massConcentrationPm1p0;
215  return true;
216  }
217 
218  /*******************************************************************************/
226  /*******************************************************************************/
227  bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
228  float massConcentrationPm1p0, massConcentrationPm2p5,
229  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
230  ambientTemperature, vocIndex, noxIndex;
231  uint16_t co2;
232  uint16_t error;
233 
234  error = _sen->readMeasuredValues(
235  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
236  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
237  noxIndex, co2);
238  if ((_PM25SensorPeriod != 0 && error != 0) ||
239  massConcentrationPm2p5 == NAN ||
240  massConcentrationPm2p5 == OVERFLOW_SEN6X) {
241  return false;
242  }
243 
244  pm25StdEvent->pm25_std = massConcentrationPm2p5;
245  return true;
246  }
247 
248  /*******************************************************************************/
256  /*******************************************************************************/
257  bool getEventPM40_STD(sensors_event_t *pm40StdEvent) {
258  float massConcentrationPm1p0, massConcentrationPm2p5,
259  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
260  ambientTemperature, vocIndex, noxIndex;
261  uint16_t co2;
262  uint16_t error;
263 
264  error = _sen->readMeasuredValues(
265  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
266  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
267  noxIndex, co2);
268  if ((_PM25SensorPeriod != 0 && error != 0) ||
269  massConcentrationPm4p0 == NAN ||
270  massConcentrationPm4p0 == OVERFLOW_SEN6X) {
271  return false;
272  }
273 
274  pm40StdEvent->data[0] = massConcentrationPm4p0;
275  return true;
276  }
277 
278  /*******************************************************************************/
286  /*******************************************************************************/
287  bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
288  float massConcentrationPm1p0, massConcentrationPm2p5,
289  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
290  ambientTemperature, vocIndex, noxIndex;
291  uint16_t co2;
292  uint16_t error;
293 
294  error = _sen->readMeasuredValues(
295  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
296  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
297  noxIndex, co2);
298  if ((_PM100SensorPeriod != 0 && error != 0) ||
299  massConcentrationPm10p0 == NAN ||
300  massConcentrationPm10p0 == OVERFLOW_SEN6X) {
301  return false;
302  }
303 
304  pm100StdEvent->pm100_std = massConcentrationPm10p0;
305  return true;
306  }
307 
308  /*******************************************************************************/
316  /*******************************************************************************/
317  bool getEventCO2(sensors_event_t *co2Event) {
318  float massConcentrationPm1p0, massConcentrationPm2p5,
319  massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
320  ambientTemperature, vocIndex, noxIndex;
321  uint16_t co2;
322  uint16_t error;
323 
324  error = _sen->readMeasuredValues(
325  massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
326  massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
327  noxIndex, co2);
328 
329  if ((_CO2SensorPeriod != 0 && error != 0) || co2 == 0xFFFF) {
330  return false;
331  }
332 
333  co2Event->CO2 = co2;
334  return true;
335  }
336 
337 protected:
338  SensirionI2cSen66 *_sen;
339 };
340 
341 #endif // WipperSnapper_I2C_Driver_SEN6X
WipperSnapper_I2C_Driver::_PM10SensorPeriod
long _PM10SensorPeriod
The time period between reading the pm25 sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1365
+
WipperSnapper_I2C_Driver::_PM100SensorPeriod
long _PM100SensorPeriod
The time period between reading the pm100_std sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1373
+
WipperSnapper_I2C_Driver_SEN6X::getEventPM40_STD
bool getEventPM40_STD(sensors_event_t *pm40StdEvent)
Gets the SEN6X sensor&#39;s PM4.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:257
+
WipperSnapper_I2C_Driver_SEN6X::getEventCO2
bool getEventCO2(sensors_event_t *co2Event)
Gets the SEN6X sensor&#39;s CO2 reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:317
+
WipperSnapper_I2C_Driver_SEN6X::getEventNOxIndex
bool getEventNOxIndex(sensors_event_t *noxIndexEvent)
Gets the SEN6X&#39;s current NOX reading. Note: If this value is unknown, which is true for SEN54...
Definition: WipperSnapper_I2C_Driver_SEN6X.h:141
+
WipperSnapper_I2C_Driver_SEN6X::getEventRelativeHumidity
bool getEventRelativeHumidity(sensors_event_t *humidEvent)
Gets the SEN6X&#39;s current relative humidity reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:110
+
WipperSnapper_I2C_Driver_SEN6X::getEventPM10_STD
bool getEventPM10_STD(sensors_event_t *pm10StdEvent)
Gets the SEN6X sensor&#39;s PM1.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:197
+
WipperSnapper_I2C_Driver_SEN6X::getEventVOCIndex
bool getEventVOCIndex(sensors_event_t *vocIndexEvent)
Gets the SEN6X&#39;s current VOC reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:169
+
WipperSnapper_I2C_Driver::_tempSensorPeriod
long _tempSensorPeriod
The time period between reading the temperature sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1323
+
WipperSnapper_I2C_Driver_SEN6X::getEventPM25_STD
bool getEventPM25_STD(sensors_event_t *pm25StdEvent)
Gets the SEN6X sensor&#39;s PM2.5 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:227
+
WipperSnapper_I2C_Driver
Base class for I2C Drivers.
Definition: WipperSnapper_I2C_Driver.h:30
+
WipperSnapper_I2C_Driver_SEN6X
Class that provides a driver interface for the SEN6X sensor.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:30
+
WipperSnapper_I2C_Driver::_humidSensorPeriod
long _humidSensorPeriod
The time period between reading the humidity sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1328
+
WipperSnapper_I2C_Driver_SEN6X::getEventPM100_STD
bool getEventPM100_STD(sensors_event_t *pm100StdEvent)
Gets the SEN6X sensor&#39;s PM10.0 STD reading.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:287
+
WipperSnapper_I2C_Driver::_sensorAddress
uint16_t _sensorAddress
The I2C driver&#39;s unique I2C address.
Definition: WipperSnapper_I2C_Driver.h:1322
+
WipperSnapper_I2C_Driver::_VOCIndexPeriod
long _VOCIndexPeriod
The time period between reading the VOC Index sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1417
+
WipperSnapper_I2C_Driver_SEN6X::WipperSnapper_I2C_Driver_SEN6X
WipperSnapper_I2C_Driver_SEN6X(TwoWire *i2c, uint16_t sensorAddress)
Constructor for a SEN6X sensor.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:44
+
WipperSnapper_I2C_Driver.h
+
WipperSnapper_I2C_Driver_SEN6X::begin
bool begin()
Initializes the SEN6X sensor and begins I2C.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:56
+
WipperSnapper_I2C_Driver_SEN6X::_sen
SensirionI2cSen66 * _sen
SEN6X driver object.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:338
+
WipperSnapper_I2C_Driver::_PM25SensorPeriod
long _PM25SensorPeriod
The time period between reading the pm25 sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1369
+
WipperSnapper_I2C_Driver::_CO2SensorPeriod
long _CO2SensorPeriod
The time period between reading the CO2 sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1338
+
WipperSnapper_I2C_Driver_SEN6X::getEventAmbientTemp
bool getEventAmbientTemp(sensors_event_t *tempEvent)
Gets the SEN6X&#39;s current temperature.
Definition: WipperSnapper_I2C_Driver_SEN6X.h:82
+
WipperSnapper_I2C_Driver::_NOxIndexPeriod
long _NOxIndexPeriod
The time period between reading the NOx Index sensor&#39;s value.
Definition: WipperSnapper_I2C_Driver.h:1412
+
WipperSnapper_I2C_Driver::_i2c
TwoWire * _i2c
Pointer to the I2C driver&#39;s Wire object.
Definition: WipperSnapper_I2C_Driver.h:1321
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html b/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html new file mode 100644 index 000000000..707379fe9 --- /dev/null +++ b/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html @@ -0,0 +1,95 @@ + + + + + + + +Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_VCNL4200.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes
+
+
WipperSnapper_I2C_Driver_VCNL4200.h File Reference
+
+
+
#include "WipperSnapper_I2C_Driver.h"
+#include <Adafruit_VCNL4200.h>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  WipperSnapper_I2C_Driver_VCNL4200
 Class that provides a driver interface for a VCNL4200 sensor. More...
 
+

Detailed Description

+

Device driver for the VCNL4200 light + proximity sensor.

+

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

+

Copyright (c) Tyeth Gundry 2024 for Adafruit Industries.

+

MIT license, all text here must be included in any redistribution.

+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html b/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html new file mode 100644 index 000000000..da57f3d70 --- /dev/null +++ b/html/_wipper_snapper___i2_c___driver___v_c_n_l4200_8h_source.html @@ -0,0 +1,88 @@ + + + + + + + +Adafruit Library: src/components/i2c/drivers/WipperSnapper_I2C_Driver_VCNL4200.h Source File + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
WipperSnapper_I2C_Driver_VCNL4200.h
+
+
+Go to the documentation of this file.
1 
15 #ifndef WipperSnapper_I2C_Driver_VCNL4200_H
16 #define WipperSnapper_I2C_Driver_VCNL4200_H
17 
18 #include "WipperSnapper_I2C_Driver.h"
19 #include <Adafruit_VCNL4200.h>
20 
21 /**************************************************************************/
25 /**************************************************************************/
26 class WipperSnapper_I2C_Driver_VCNL4200 : public WipperSnapper_I2C_Driver {
27 public:
28  /*******************************************************************************/
36  /*******************************************************************************/
37  WipperSnapper_I2C_Driver_VCNL4200(TwoWire *i2c, uint16_t sensorAddress)
38  : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
39  _i2c = i2c;
40  _sensorAddress = sensorAddress;
41  }
42 
43  /*******************************************************************************/
47  /*******************************************************************************/
48  ~WipperSnapper_I2C_Driver_VCNL4200() { delete _vcnl4200; }
49 
50  /*******************************************************************************/
55  /*******************************************************************************/
56  bool begin() {
57  _vcnl4200 = new Adafruit_VCNL4200();
58  bool status = false;
59  // Attempt to initialize and configure VCNL4200
60  if (!_vcnl4200->begin(_sensorAddress, _i2c)) {
61  return false;
62  }
63  status = _vcnl4200->setALSshutdown(false);
64  status &= _vcnl4200->setProxShutdown(false);
65  status &= _vcnl4200->setProxHD(true); // 16bit instead of 12bit
66  status &= _vcnl4200->setALSIntegrationTime(VCNL4200_ALS_IT_400MS);
67  status &= _vcnl4200->setProxDuty(VCNL4200_PS_DUTY_1_160);
68  status &= _vcnl4200->setProxLEDCurrent(VCNL4200_LED_I_200MA);
69  status &= _vcnl4200->setProxIntegrationTime(VCNL4200_PS_IT_9T);
70  return status;
71  }
72 
73  /*******************************************************************************/
82  /*******************************************************************************/
83  bool getEventLight(sensors_event_t *lightEvent) {
84  // Get sensor event populated in lux via AUTO integration and gain
85  lightEvent->light = _vcnl4200->readALSdata();
86  return true;
87  }
88 
89  /*******************************************************************************/
97  /*******************************************************************************/
98  bool getEventProximity(sensors_event_t *proximityEvent) {
99  proximityEvent->data[0] = (float)_vcnl4200->readProxData();
100  return true;
101  }
102 
103 protected:
104  Adafruit_VCNL4200 *_vcnl4200;
105 };
106 
107 #endif // WipperSnapper_I2C_Driver_VCNL4200
WipperSnapper_I2C_Driver_VCNL4200::~WipperSnapper_I2C_Driver_VCNL4200
~WipperSnapper_I2C_Driver_VCNL4200()
Destructor for an VCNL4200 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:48
+
WipperSnapper_I2C_Driver
Base class for I2C Drivers.
Definition: WipperSnapper_I2C_Driver.h:30
+
WipperSnapper_I2C_Driver_VCNL4200::getEventLight
bool getEventLight(sensors_event_t *lightEvent)
Performs a light sensor read using the Adafruit Unified Sensor API.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:83
+
WipperSnapper_I2C_Driver::_sensorAddress
uint16_t _sensorAddress
The I2C driver&#39;s unique I2C address.
Definition: WipperSnapper_I2C_Driver.h:1322
+
WipperSnapper_I2C_Driver_VCNL4200::begin
bool begin()
Initializes the VCNL4200 sensor and begins I2C.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:56
+
WipperSnapper_I2C_Driver.h
+
WipperSnapper_I2C_Driver_VCNL4200::WipperSnapper_I2C_Driver_VCNL4200
WipperSnapper_I2C_Driver_VCNL4200(TwoWire *i2c, uint16_t sensorAddress)
Constructor for a VCNL4200 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:37
+
WipperSnapper_I2C_Driver_VCNL4200
Class that provides a driver interface for a VCNL4200 sensor.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:26
+
WipperSnapper_I2C_Driver_VCNL4200::getEventProximity
bool getEventProximity(sensors_event_t *proximityEvent)
Reads the VCNL4200&#39;s proximity value into an event (no unit).
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:98
+
WipperSnapper_I2C_Driver_VCNL4200::_vcnl4200
Adafruit_VCNL4200 * _vcnl4200
Pointer to VCNL4200 light sensor object.
Definition: WipperSnapper_I2C_Driver_VCNL4200.h:104
+
WipperSnapper_I2C_Driver::_i2c
TwoWire * _i2c
Pointer to the I2C driver&#39;s Wire object.
Definition: WipperSnapper_I2C_Driver.h:1321
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/_wippersnapper_8h.html b/html/_wippersnapper_8h.html index 1a8ceedfd..54d616c34 100644 --- a/html/_wippersnapper_8h.html +++ b/html/_wippersnapper_8h.html @@ -137,7 +137,7 @@  Retry a function until a condition is met or a timeout is reached. More...
  -#define WS_VERSION   "1.0.0-beta.92" +#define WS_VERSION   "1.0.0-beta.95"  WipperSnapper app. version (semver-formatted)
  diff --git a/html/_wippersnapper_8h_source.html b/html/_wippersnapper_8h_source.html index d59720417..ad95e308a 100644 --- a/html/_wippersnapper_8h_source.html +++ b/html/_wippersnapper_8h_source.html @@ -66,152 +66,152 @@
Wippersnapper.h
-Go to the documentation of this file.
1 
18 #ifndef WIPPERSNAPPER_H
19 #define WIPPERSNAPPER_H
20 
21 // Cpp STD
22 #include <vector>
23 
24 // Nanopb dependencies
25 #include <nanopb/pb_common.h>
26 #include <nanopb/pb_decode.h>
27 #include <nanopb/pb_encode.h>
28 #include <pb.h>
29 
30 #include <wippersnapper/description/v1/description.pb.h> // description.proto
31 #include <wippersnapper/signal/v1/signal.pb.h> // signal.proto
32 
33 // External libraries
34 #include "Adafruit_MQTT.h" // MQTT Client
35 #include "Adafruit_SleepyDog.h" // Watchdog
36 #include "Arduino.h" // Wiring
37 #include <SPI.h> // SPI
38 
39 // Wippersnapper API Helpers
40 #include "Wippersnapper_Boards.h"
41 #include "components/statusLED/Wippersnapper_StatusLED.h"
42 #include "provisioning/ConfigJson.h"
43 
44 #define WS_DEBUG
45 #define WS_PRINTER Serial
46 
47 // Define actual debug output functions when necessary.
48 #ifdef WS_DEBUG
49 #define WS_DEBUG_PRINT(...) \
50  { WS_PRINTER.print(__VA_ARGS__); }
51 #define WS_DEBUG_PRINTLN(...) \
52  { WS_PRINTER.println(__VA_ARGS__); }
53 #define WS_DEBUG_PRINTHEX(...) \
54  { WS_PRINTER.print(__VA_ARGS__, HEX); }
55 #else
56 #define WS_DEBUG_PRINT(...) \
57  {}
58 #define WS_DEBUG_PRINTLN(...) \
59  {}
60 #endif
61 
62 #define WS_DELAY_WITH_WDT(timeout) \
63  { \
64  unsigned long start = millis(); \
65  while (millis() - start < timeout) { \
66  delay(10); \
67  yield(); \
68  feedWDT(); \
69  if (millis() < start) { \
70  start = millis(); /* if rollover */ \
71  } \
72  } \
73  }
74 
75 /**************************************************************************/
93 /**************************************************************************/
94 #define RETRY_FUNCTION_UNTIL_TIMEOUT(func, result_type, result_var, condition, \
95  timeout, interval, ...) \
96  { \
97  unsigned long startTime = millis(); \
98  while (millis() - startTime < timeout) { \
99  result_type result_var = func(__VA_ARGS__); \
100  if (condition(result_var)) { \
101  break; \
102  } \
103  if (startTime > millis()) { \
104  startTime = millis(); /* if rollover */ \
105  } \
106  WS_DELAY_WITH_WDT(interval); \
107  } \
108  }
109 
110 // Wippersnapper pb helpers
111 #include <nanopb/ws_pb_helpers.h>
112 
113 // Wippersnapper components
114 #include "components/analogIO/Wippersnapper_AnalogIO.h"
115 #include "components/digitalIO/Wippersnapper_DigitalGPIO.h"
116 #include "components/i2c/WipperSnapper_I2C.h"
117 
118 // Includes for ESP32-only
119 #ifdef ARDUINO_ARCH_ESP32
120 #include "components/ledc/ws_ledc.h"
121 #include <Esp.h>
122 #endif
123 
124 // Display
125 #ifdef USE_DISPLAY
126 #include "display/ws_display_driver.h"
127 #include "display/ws_display_ui_helper.h"
128 #endif
129 
130 #include "components/ds18x20/ws_ds18x20.h"
131 #include "components/pixels/ws_pixels.h"
132 #include "components/pwm/ws_pwm.h"
133 #include "components/servo/ws_servo.h"
134 #include "components/uart/ws_uart.h"
135 
136 #if defined(USE_TINYUSB)
137 #include "provisioning/tinyusb/Wippersnapper_FS.h"
138 #endif
139 
140 #if defined(USE_LITTLEFS)
141 #include "provisioning/littlefs/WipperSnapper_LittleFS.h"
142 #endif
143 
144 #define WS_VERSION \
145  "1.0.0-beta.92"
146 
147 // Reserved Adafruit IO MQTT topics
148 #define TOPIC_IO_THROTTLE "/throttle"
149 #define TOPIC_IO_ERRORS "/errors"
150 
151 // Reserved Wippersnapper topics
152 #define TOPIC_WS "/wprsnpr/"
153 #define TOPIC_INFO "/info/"
154 #define TOPIC_SIGNALS "/signals/"
155 #define TOPIC_I2C "/i2c"
156 #define MQTT_TOPIC_PIXELS_DEVICE \
157  "/signals/device/pixel"
158 #define MQTT_TOPIC_PIXELS_BROKER \
159  "/signals/broker/pixel"
160 
161 
162 typedef enum {
163  WS_IDLE = 0, // Waiting for connection establishement
164  WS_NET_DISCONNECTED = 1, // Network disconnected
165  WS_DISCONNECTED = 2, // Disconnected from Adafruit IO
166  WS_FINGERPRINT_UNKOWN = 3, // Unknown WS_SSL_FINGERPRINT
167 
168  WS_NET_CONNECT_FAILED = 10, // Failed to connect to network
169  WS_CONNECT_FAILED = 11, // Failed to connect to Adafruit IO
170  WS_FINGERPRINT_INVALID = 12, // Unknown WS_SSL_FINGERPRINT
171  WS_AUTH_FAILED = 13, // Invalid Adafruit IO login credentials provided.
172  WS_SSID_INVALID =
173  14, // SSID is "" or otherwise invalid, connection not attempted
174 
175  WS_NET_CONNECTED = 20, // Connected to Adafruit IO
176  WS_CONNECTED = 21, // Connected to network
177  WS_CONNECTED_INSECURE = 22, // Insecurely (non-SSL) connected to network
178  WS_FINGERPRINT_UNSUPPORTED = 23, // Unsupported WS_SSL_FINGERPRINT
179  WS_FINGERPRINT_VALID = 24, // Valid WS_SSL_FINGERPRINT
180  WS_BOARD_DESC_INVALID = 25, // Unable to send board description
181  WS_BOARD_RESYNC_FAILED = 26 // Board sync failure
182 } ws_status_t;
183 
185 typedef enum {
186  WS_MQTT_CONNECTED = 0, // Connected
187  WS_MQTT_INVALID_PROTOCOL = 1, // Invalid mqtt protocol
188  WS_MQTT_INVALID_CID = 2, // Client id rejected
189  WS_MQTT_SERVICE_UNAVALIABLE = 3, // Malformed user/pass
190  WS_MQTT_INVALID_USER_PASS = 4, // Unauthorized access to resource
191  WS_MQTT_UNAUTHORIZED = 5, // MQTT service unavailable
192  WS_MQTT_THROTTLED = 6, // Account throttled
193  WS_MQTT_BANNED = 7 // Account banned
194 } ws_mqtt_status_t;
195 
197 typedef enum {
198  WS_BOARD_DEF_IDLE,
199  WS_BOARD_DEF_SEND_FAILED,
200  WS_BOARD_DEF_SENT,
201  WS_BOARD_DEF_OK,
202  WS_BOARD_DEF_INVALID,
203  WS_BOARD_DEF_UNSPECIFIED
204 } ws_board_status_t;
205 
207 typedef enum {
208  FSM_NET_IDLE,
209  FSM_NET_CONNECTED,
210  FSM_MQTT_CONNECTED,
211  FSM_NET_CHECK_MQTT,
212  FSM_NET_CHECK_NETWORK,
213  FSM_NET_ESTABLISH_NETWORK,
214  FSM_NET_ESTABLISH_MQTT,
215 } fsm_net_t;
216 
217 #define WS_WDT_TIMEOUT 60000
218 #define WS_MAX_ALT_WIFI_NETWORKS 3
219 /* MQTT Configuration */
220 #define WS_KEEPALIVE_INTERVAL_MS \
221  5000
222 
223 #define WS_MQTT_MAX_PAYLOAD_SIZE \
224  512
225 
226 class Wippersnapper_DigitalGPIO;
227 class Wippersnapper_AnalogIO;
228 class Wippersnapper_FS;
229 class WipperSnapper_LittleFS;
230 #ifdef USE_DISPLAY
231 class ws_display_driver;
232 class ws_display_ui_helper;
233 #endif
234 #ifdef ARDUINO_ARCH_ESP32
235 class ws_ledc;
236 #endif
237 class WipperSnapper_Component_I2C;
238 class ws_servo;
239 class ws_pwm;
240 class ws_ds18x20;
241 class ws_pixels;
242 class ws_uart;
243 
244 /**************************************************************************/
249 /**************************************************************************/
250 class Wippersnapper {
251 public:
252  Wippersnapper();
253  virtual ~Wippersnapper();
254 
255  void provision();
256 
257  bool lockStatusNeoPixel;
258  bool lockStatusDotStar;
259  bool lockStatusLED;
260  float status_pixel_brightness =
261  STATUS_PIXEL_BRIGHTNESS_DEFAULT;
262 
264  virtual void set_user_key();
265  virtual void set_ssid_pass(const char *ssid, const char *ssidPassword);
266  virtual void set_ssid_pass();
267  virtual bool check_valid_ssid();
268 
269  virtual void _connect();
270  virtual void _disconnect();
271  void connect();
272  void disconnect();
273 
274  virtual void getMacAddr();
275  virtual int32_t getRSSI();
276  virtual void setupMQTTClient(const char *clientID);
277 
278  virtual ws_status_t networkStatus();
279  ws_board_status_t getBoardStatus();
280 
281  bool generateDeviceUID();
282  bool generateWSTopics();
283  bool generateWSErrorTopics();
284 
285  // Registration API
286  bool registerBoard();
287  bool encodePubRegistrationReq();
288  void decodeRegistrationResp(char *data, uint16_t len);
289  void pollRegistrationResp();
290  // Configuration API
291  void publishPinConfigComplete();
292 
293  // run() loop
294  ws_status_t run();
295  void processPackets();
296  void publish(const char *topic, uint8_t *payload, uint16_t bLen,
297  uint8_t qos = 0);
298 
299  // Networking helpers
300  void pingBroker();
301  void runNetFSM();
302 
303  // WDT helpers
304  void enableWDT(int timeoutMS = 0);
305  void feedWDT();
306 
307  // Error handling helpers
308  void haltError(String error,
309  ws_led_status_t ledStatusColor = WS_LED_STATUS_ERROR_RUNTIME);
310  void errorWriteHang(String error);
311 
312  // MQTT topic callbacks //
313  // Decodes a signal message
314  bool decodeSignalMsg(
315  wippersnapper_signal_v1_CreateSignalRequest *encodedSignalMsg);
316 
317  // Encodes a pin event message
318  bool
319  encodePinEvent(wippersnapper_signal_v1_CreateSignalRequest *outgoingSignalMsg,
320  uint8_t pinName, int pinVal);
321 
322  // Pin configure message
323  bool configureDigitalPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg);
324  bool configAnalogInPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg);
325 
326  // I2C
327  std::vector<WipperSnapper_Component_I2C *>
328  i2cComponents;
329  WipperSnapper_Component_I2C *_i2cPort0 =
330  NULL;
331  WipperSnapper_Component_I2C *_i2cPort1 =
332  NULL;
333  bool _isI2CPort0Init =
334  false;
335  bool _isI2CPort1Init =
336  false;
337 
338  uint8_t _buffer[WS_MQTT_MAX_PAYLOAD_SIZE];
340  uint8_t
341  _buffer_outgoing[WS_MQTT_MAX_PAYLOAD_SIZE];
343  uint16_t bufSize;
345  ws_board_status_t _boardStatus =
346  WS_BOARD_DEF_IDLE;
347 
348  // TODO: We really should look at making these static definitions, not dynamic
349  // to free up space on the heap
350  Wippersnapper_DigitalGPIO *_digitalGPIO;
351  Wippersnapper_AnalogIO *_analogIO;
352  Wippersnapper_FS *_fileSystem;
353  WipperSnapper_LittleFS
354  *_littleFS;
355 #ifdef USE_DISPLAY
356  ws_display_driver *_display = nullptr;
357  ws_display_ui_helper *_ui_helper =
358  nullptr;
359 #endif
360  ws_pixels *_ws_pixelsComponent;
361  ws_pwm *_pwmComponent;
362  ws_servo *_servoComponent;
363  ws_ds18x20 *_ds18x20Component;
364  ws_uart *_uartComponent;
365 
366  // TODO: does this really need to be global?
367  uint8_t _macAddr[6];
368  char sUID[13];
369  const char *_boardId;
370  Adafruit_MQTT *_mqtt;
372  secretsConfig _config;
373  networkConfig _multiNetworks[3];
374  bool _isWiFiMulti = false;
376  // TODO: Does this need to be within this class?
377  int32_t totalDigitalPins;
379  char *_topic_description = NULL;
380  char *_topic_signal_device = NULL;
381  char *_topic_signal_i2c_brkr = NULL;
383  char *_topic_signal_i2c_device = NULL;
385  char *_topic_signal_servo_brkr = NULL;
387  char *_topic_signal_servo_device = NULL;
389  char *_topic_signal_pwm_brkr =
390  NULL;
391  char *_topic_signal_pwm_device =
392  NULL;
393  char *_topic_signal_ds18_brkr = NULL;
395  char *_topic_signal_ds18_device = NULL;
397  char *_topic_signal_pixels_brkr = NULL;
398  char *_topic_signal_pixels_device = NULL;
399  char *_topic_signal_uart_brkr = NULL;
400  char *_topic_signal_uart_device = NULL;
402  wippersnapper_signal_v1_CreateSignalRequest
403  _incomingSignalMsg;
404  wippersnapper_signal_v1_I2CRequest msgSignalI2C =
405  wippersnapper_signal_v1_I2CRequest_init_zero;
406 
408  // ds signal msg
409  wippersnapper_signal_v1_Ds18x20Request msgSignalDS =
410  wippersnapper_signal_v1_Ds18x20Request_init_zero;
411 
413  // servo message
414  wippersnapper_signal_v1_ServoRequest
415  msgServo;
416  wippersnapper_signal_v1_PWMRequest msgPWM =
417  wippersnapper_signal_v1_PWMRequest_init_zero;
418 
420  // pixels signal message
421  wippersnapper_signal_v1_PixelsRequest
422  msgPixels;
423 
424  wippersnapper_signal_v1_UARTRequest
425  msgSignalUART;
426 
427  char *throttleMessage;
428  int throttleTime;
431  bool pinCfgCompleted = false;
433 // enable LEDC if esp32
434 #ifdef ARDUINO_ARCH_ESP32
435  ws_ledc *_ledc = nullptr;
436 #endif
437 
438 private:
439  void _init();
440 
441 protected:
442  ws_status_t _status = WS_IDLE;
443  uint32_t _last_mqtt_connect = 0;
445  uint32_t _prv_ping = 0;
447  uint32_t _prvKATBlink = 0;
450  // Device information
451  const char *_deviceId;
452  char *_device_uid;
454  // MQTT topics
455  char *_topic_description_status =
456  NULL;
458  char *_topic_description_status_complete = NULL;
461  char *_topic_device_pin_config_complete =
462  NULL;
465  char *_topic_signal_brkr = NULL;
466  char *_err_topic = NULL;
467  char *_throttle_topic = NULL;
469  Adafruit_MQTT_Subscribe *_topic_description_sub;
471  Adafruit_MQTT_Publish *_topic_signal_device_pub;
473  Adafruit_MQTT_Subscribe *_topic_signal_brkr_sub;
475  Adafruit_MQTT_Subscribe
476  *_topic_signal_i2c_sub;
477  Adafruit_MQTT_Subscribe
478  *_topic_signal_servo_sub;
479  Adafruit_MQTT_Subscribe
480  *_topic_signal_pwm_sub;
481  Adafruit_MQTT_Subscribe
482  *_topic_signal_ds18_sub;
483  Adafruit_MQTT_Subscribe
484  *_topic_signal_pixels_sub;
485  Adafruit_MQTT_Subscribe
486  *_topic_signal_uart_sub;
488  Adafruit_MQTT_Subscribe
489  *_err_sub;
490  Adafruit_MQTT_Subscribe
491  *_throttle_sub;
493  wippersnapper_signal_v1_CreateSignalRequest
494  _outgoingSignalMsg;
495 };
496 extern Wippersnapper WS;
497 
498 #endif // ADAFRUIT_WIPPERSNAPPER_H
Wippersnapper_Boards.h
-
WipperSnapper_Component_I2C
Class that provides an interface with the I2C bus.
Definition: WipperSnapper_I2C.h:84
-
Wippersnapper::_topic_signal_pixels_brkr
char * _topic_signal_pixels_brkr
Definition: Wippersnapper.h:425
-
Wippersnapper::msgPWM
wippersnapper_signal_v1_PWMRequest msgPWM
Definition: Wippersnapper.h:444
+Go to the documentation of this file.
1 
18 #ifndef WIPPERSNAPPER_H
19 #define WIPPERSNAPPER_H
20 
21 // Cpp STD
22 #include <vector>
23 
24 // Nanopb dependencies
25 #include <nanopb/pb_common.h>
26 #include <nanopb/pb_decode.h>
27 #include <nanopb/pb_encode.h>
28 #include <pb.h>
29 
30 #include <wippersnapper/description/v1/description.pb.h> // description.proto
31 #include <wippersnapper/signal/v1/signal.pb.h> // signal.proto
32 
33 // External libraries
34 #include "Adafruit_MQTT.h" // MQTT Client
35 #include "Adafruit_SleepyDog.h" // Watchdog
36 #include "Arduino.h" // Wiring
37 #include <SPI.h> // SPI
38 
39 // Wippersnapper API Helpers
40 #include "Wippersnapper_Boards.h"
41 #include "components/statusLED/Wippersnapper_StatusLED.h"
42 #include "provisioning/ConfigJson.h"
43 
44 #define WS_DEBUG
45 #define WS_PRINTER Serial
46 
47 // Define actual debug output functions when necessary.
48 #ifdef WS_DEBUG
49 #define WS_DEBUG_PRINT(...) \
50  { WS_PRINTER.print(__VA_ARGS__); }
51 #define WS_DEBUG_PRINTLN(...) \
52  { WS_PRINTER.println(__VA_ARGS__); }
53 #define WS_DEBUG_PRINTHEX(...) \
54  { WS_PRINTER.print(__VA_ARGS__, HEX); }
55 #else
56 #define WS_DEBUG_PRINT(...) \
57  {}
58 #define WS_DEBUG_PRINTLN(...) \
59  {}
60 #endif
61 
62 #define WS_DELAY_WITH_WDT(timeout) \
63  { \
64  unsigned long start = millis(); \
65  while (millis() - start < timeout) { \
66  delay(10); \
67  yield(); \
68  feedWDT(); \
69  if (millis() < start) { \
70  start = millis(); /* if rollover */ \
71  } \
72  } \
73  }
74 
75 /**************************************************************************/
93 /**************************************************************************/
94 #define RETRY_FUNCTION_UNTIL_TIMEOUT(func, result_type, result_var, condition, \
95  timeout, interval, ...) \
96  { \
97  unsigned long startTime = millis(); \
98  while (millis() - startTime < timeout) { \
99  result_type result_var = func(__VA_ARGS__); \
100  if (condition(result_var)) { \
101  break; \
102  } \
103  if (startTime > millis()) { \
104  startTime = millis(); /* if rollover */ \
105  } \
106  WS_DELAY_WITH_WDT(interval); \
107  } \
108  }
109 
110 // Wippersnapper pb helpers
111 #include <nanopb/ws_pb_helpers.h>
112 
113 // Wippersnapper components
114 #include "components/analogIO/Wippersnapper_AnalogIO.h"
115 #include "components/digitalIO/Wippersnapper_DigitalGPIO.h"
116 #include "components/i2c/WipperSnapper_I2C.h"
117 
118 // Includes for ESP32-only
119 #ifdef ARDUINO_ARCH_ESP32
120 #include "components/ledc/ws_ledc.h"
121 #include <Esp.h>
122 #endif
123 
124 // Display
125 #ifdef USE_DISPLAY
126 #include "display/ws_display_driver.h"
127 #include "display/ws_display_ui_helper.h"
128 #endif
129 
130 #include "components/ds18x20/ws_ds18x20.h"
131 #include "components/pixels/ws_pixels.h"
132 #include "components/pwm/ws_pwm.h"
133 #include "components/servo/ws_servo.h"
134 #include "components/uart/ws_uart.h"
135 
136 #if defined(USE_TINYUSB)
137 #include "provisioning/tinyusb/Wippersnapper_FS.h"
138 #endif
139 
140 #if defined(USE_LITTLEFS)
141 #include "provisioning/littlefs/WipperSnapper_LittleFS.h"
142 #endif
143 
144 #define WS_VERSION \
145  "1.0.0-beta.95"
146 
147 // Reserved Adafruit IO MQTT topics
148 #define TOPIC_IO_THROTTLE "/throttle"
149 #define TOPIC_IO_ERRORS "/errors"
150 
151 // Reserved Wippersnapper topics
152 #define TOPIC_WS "/wprsnpr/"
153 #define TOPIC_INFO "/info/"
154 #define TOPIC_SIGNALS "/signals/"
155 #define TOPIC_I2C "/i2c"
156 #define MQTT_TOPIC_PIXELS_DEVICE \
157  "/signals/device/pixel"
158 #define MQTT_TOPIC_PIXELS_BROKER \
159  "/signals/broker/pixel"
160 
161 
162 typedef enum {
163  WS_IDLE = 0, // Waiting for connection establishement
164  WS_NET_DISCONNECTED = 1, // Network disconnected
165  WS_DISCONNECTED = 2, // Disconnected from Adafruit IO
166  WS_FINGERPRINT_UNKOWN = 3, // Unknown WS_SSL_FINGERPRINT
167 
168  WS_NET_CONNECT_FAILED = 10, // Failed to connect to network
169  WS_CONNECT_FAILED = 11, // Failed to connect to Adafruit IO
170  WS_FINGERPRINT_INVALID = 12, // Unknown WS_SSL_FINGERPRINT
171  WS_AUTH_FAILED = 13, // Invalid Adafruit IO login credentials provided.
172  WS_SSID_INVALID =
173  14, // SSID is "" or otherwise invalid, connection not attempted
174 
175  WS_NET_CONNECTED = 20, // Connected to Adafruit IO
176  WS_CONNECTED = 21, // Connected to network
177  WS_CONNECTED_INSECURE = 22, // Insecurely (non-SSL) connected to network
178  WS_FINGERPRINT_UNSUPPORTED = 23, // Unsupported WS_SSL_FINGERPRINT
179  WS_FINGERPRINT_VALID = 24, // Valid WS_SSL_FINGERPRINT
180  WS_BOARD_DESC_INVALID = 25, // Unable to send board description
181  WS_BOARD_RESYNC_FAILED = 26 // Board sync failure
182 } ws_status_t;
183 
185 typedef enum {
186  WS_MQTT_CONNECTED = 0, // Connected
187  WS_MQTT_INVALID_PROTOCOL = 1, // Invalid mqtt protocol
188  WS_MQTT_INVALID_CID = 2, // Client id rejected
189  WS_MQTT_SERVICE_UNAVALIABLE = 3, // Malformed user/pass
190  WS_MQTT_INVALID_USER_PASS = 4, // Unauthorized access to resource
191  WS_MQTT_UNAUTHORIZED = 5, // MQTT service unavailable
192  WS_MQTT_THROTTLED = 6, // Account throttled
193  WS_MQTT_BANNED = 7 // Account banned
194 } ws_mqtt_status_t;
195 
197 typedef enum {
198  WS_BOARD_DEF_IDLE,
199  WS_BOARD_DEF_SEND_FAILED,
200  WS_BOARD_DEF_SENT,
201  WS_BOARD_DEF_OK,
202  WS_BOARD_DEF_INVALID,
203  WS_BOARD_DEF_UNSPECIFIED
204 } ws_board_status_t;
205 
207 typedef enum {
208  FSM_NET_IDLE,
209  FSM_NET_CONNECTED,
210  FSM_MQTT_CONNECTED,
211  FSM_NET_CHECK_MQTT,
212  FSM_NET_CHECK_NETWORK,
213  FSM_NET_ESTABLISH_NETWORK,
214  FSM_NET_ESTABLISH_MQTT,
215 } fsm_net_t;
216 
217 #ifdef ARDUINO_ARCH_RP2040
218 #define WS_WDT_TIMEOUT 8388
219 #else
220 #define WS_WDT_TIMEOUT 60000
221 #endif
222 
223 #define WS_MAX_ALT_WIFI_NETWORKS 3
224 /* MQTT Configuration */
225 #define WS_KEEPALIVE_INTERVAL_MS \
226  5000
227 
228 #define WS_MQTT_MAX_PAYLOAD_SIZE \
229  512
230 
231 class Wippersnapper_DigitalGPIO;
232 class Wippersnapper_AnalogIO;
233 class Wippersnapper_FS;
234 class WipperSnapper_LittleFS;
235 #ifdef USE_DISPLAY
236 class ws_display_driver;
237 class ws_display_ui_helper;
238 #endif
239 #ifdef ARDUINO_ARCH_ESP32
240 class ws_ledc;
241 #endif
242 class WipperSnapper_Component_I2C;
243 class ws_servo;
244 class ws_pwm;
245 class ws_ds18x20;
246 class ws_pixels;
247 class ws_uart;
248 
249 /**************************************************************************/
254 /**************************************************************************/
255 class Wippersnapper {
256 public:
257  Wippersnapper();
258  virtual ~Wippersnapper();
259 
260  void provision();
261 
262  bool lockStatusNeoPixel;
263  bool lockStatusDotStar;
264  bool lockStatusLED;
265  float status_pixel_brightness =
266  STATUS_PIXEL_BRIGHTNESS_DEFAULT;
267 
269  virtual void set_user_key();
270  virtual void set_ssid_pass(const char *ssid, const char *ssidPassword);
271  virtual void set_ssid_pass();
272  virtual bool check_valid_ssid();
273 
274  virtual void _connect();
275  virtual void _disconnect();
276  void connect();
277  void disconnect();
278 
279  virtual void getMacAddr();
280  virtual int32_t getRSSI();
281  virtual void setupMQTTClient(const char *clientID);
282 
283  virtual ws_status_t networkStatus();
284  ws_board_status_t getBoardStatus();
285 
286  bool generateDeviceUID();
287  bool generateWSTopics();
288  bool generateWSErrorTopics();
289 
290  // Registration API
291  bool registerBoard();
292  bool encodePubRegistrationReq();
293  void decodeRegistrationResp(char *data, uint16_t len);
294  void pollRegistrationResp();
295  // Configuration API
296  void publishPinConfigComplete();
297 
298  // run() loop
299  ws_status_t run();
300  void processPackets();
301  void publish(const char *topic, uint8_t *payload, uint16_t bLen,
302  uint8_t qos = 0);
303 
304  // Networking helpers
305  void pingBroker();
306  void runNetFSM();
307 
308  // WDT helpers
309  void enableWDT(int timeoutMS = 0);
310  void feedWDT();
311 
312  // Error handling helpers
313  void haltError(String error,
314  ws_led_status_t ledStatusColor = WS_LED_STATUS_ERROR_RUNTIME,
315  uint8_t seconds_until_reboot = 25);
316  void errorWriteHang(String error);
317 
318  // MQTT topic callbacks //
319  // Decodes a signal message
320  bool decodeSignalMsg(
321  wippersnapper_signal_v1_CreateSignalRequest *encodedSignalMsg);
322 
323  // Encodes a pin event message
324  bool
325  encodePinEvent(wippersnapper_signal_v1_CreateSignalRequest *outgoingSignalMsg,
326  uint8_t pinName, int pinVal);
327 
328  // Pin configure message
329  bool configureDigitalPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg);
330  bool configAnalogInPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg);
331 
332  // I2C
333  std::vector<WipperSnapper_Component_I2C *>
334  i2cComponents;
335  WipperSnapper_Component_I2C *_i2cPort0 =
336  NULL;
337  WipperSnapper_Component_I2C *_i2cPort1 =
338  NULL;
339  bool _isI2CPort0Init =
340  false;
341  bool _isI2CPort1Init =
342  false;
343 
344  uint8_t _buffer[WS_MQTT_MAX_PAYLOAD_SIZE];
346  uint8_t
347  _buffer_outgoing[WS_MQTT_MAX_PAYLOAD_SIZE];
349  uint16_t bufSize;
351  ws_board_status_t _boardStatus =
352  WS_BOARD_DEF_IDLE;
353 
354  // TODO: We really should look at making these static definitions, not dynamic
355  // to free up space on the heap
356  Wippersnapper_DigitalGPIO *_digitalGPIO;
357  Wippersnapper_AnalogIO *_analogIO;
358  Wippersnapper_FS *_fileSystem;
359  WipperSnapper_LittleFS
360  *_littleFS;
361 #ifdef USE_DISPLAY
362  ws_display_driver *_display = nullptr;
363  ws_display_ui_helper *_ui_helper =
364  nullptr;
365 #endif
366  ws_pixels *_ws_pixelsComponent;
367  ws_pwm *_pwmComponent;
368  ws_servo *_servoComponent;
369  ws_ds18x20 *_ds18x20Component;
370  ws_uart *_uartComponent;
371 
372  // TODO: does this really need to be global?
373  uint8_t _macAddr[6];
374  char sUID[13];
375  const char *_boardId;
376  Adafruit_MQTT *_mqtt;
378  secretsConfig _config;
379  networkConfig _multiNetworks[3];
380  bool _isWiFiMulti = false;
382  // TODO: Does this need to be within this class?
383  int32_t totalDigitalPins;
385  char *_topic_description = NULL;
386  char *_topic_signal_device = NULL;
387  char *_topic_signal_i2c_brkr = NULL;
389  char *_topic_signal_i2c_device = NULL;
391  char *_topic_signal_servo_brkr = NULL;
393  char *_topic_signal_servo_device = NULL;
395  char *_topic_signal_pwm_brkr =
396  NULL;
397  char *_topic_signal_pwm_device =
398  NULL;
399  char *_topic_signal_ds18_brkr = NULL;
401  char *_topic_signal_ds18_device = NULL;
403  char *_topic_signal_pixels_brkr = NULL;
404  char *_topic_signal_pixels_device = NULL;
405  char *_topic_signal_uart_brkr = NULL;
406  char *_topic_signal_uart_device = NULL;
408  wippersnapper_signal_v1_CreateSignalRequest
409  _incomingSignalMsg;
410  wippersnapper_signal_v1_I2CRequest msgSignalI2C =
411  wippersnapper_signal_v1_I2CRequest_init_zero;
412 
414  // ds signal msg
415  wippersnapper_signal_v1_Ds18x20Request msgSignalDS =
416  wippersnapper_signal_v1_Ds18x20Request_init_zero;
417 
419  // servo message
420  wippersnapper_signal_v1_ServoRequest
421  msgServo;
422  wippersnapper_signal_v1_PWMRequest msgPWM =
423  wippersnapper_signal_v1_PWMRequest_init_zero;
424 
426  // pixels signal message
427  wippersnapper_signal_v1_PixelsRequest
428  msgPixels;
429 
430  wippersnapper_signal_v1_UARTRequest
431  msgSignalUART;
432 
433  char *throttleMessage;
434  int throttleTime;
437  bool pinCfgCompleted = false;
439 // enable LEDC if esp32
440 #ifdef ARDUINO_ARCH_ESP32
441  ws_ledc *_ledc = nullptr;
442 #endif
443 
444 private:
445  void _init();
446 
447 protected:
448  ws_status_t _status = WS_IDLE;
449  uint32_t _last_mqtt_connect = 0;
451  uint32_t _prv_ping = 0;
453  uint32_t _prvKATBlink = 0;
456  // Device information
457  const char *_deviceId;
458  char *_device_uid;
460  // MQTT topics
461  char *_topic_description_status =
462  NULL;
464  char *_topic_description_status_complete = NULL;
467  char *_topic_device_pin_config_complete =
468  NULL;
471  char *_topic_signal_brkr = NULL;
472  char *_err_topic = NULL;
473  char *_throttle_topic = NULL;
475  Adafruit_MQTT_Subscribe *_topic_description_sub;
477  Adafruit_MQTT_Publish *_topic_signal_device_pub;
479  Adafruit_MQTT_Subscribe *_topic_signal_brkr_sub;
481  Adafruit_MQTT_Subscribe
482  *_topic_signal_i2c_sub;
483  Adafruit_MQTT_Subscribe
484  *_topic_signal_servo_sub;
485  Adafruit_MQTT_Subscribe
486  *_topic_signal_pwm_sub;
487  Adafruit_MQTT_Subscribe
488  *_topic_signal_ds18_sub;
489  Adafruit_MQTT_Subscribe
490  *_topic_signal_pixels_sub;
491  Adafruit_MQTT_Subscribe
492  *_topic_signal_uart_sub;
494  Adafruit_MQTT_Subscribe
495  *_err_sub;
496  Adafruit_MQTT_Subscribe
497  *_throttle_sub;
499  wippersnapper_signal_v1_CreateSignalRequest
500  _outgoingSignalMsg;
501 };
502 extern Wippersnapper WS;
503 
504 #endif // ADAFRUIT_WIPPERSNAPPER_H
Wippersnapper_Boards.h
+
WipperSnapper_Component_I2C
Class that provides an interface with the I2C bus.
Definition: WipperSnapper_I2C.h:86
+
Wippersnapper::_topic_signal_pixels_brkr
char * _topic_signal_pixels_brkr
Definition: Wippersnapper.h:431
+
Wippersnapper::msgPWM
wippersnapper_signal_v1_PWMRequest msgPWM
Definition: Wippersnapper.h:450
Wippersnapper::disconnect
void disconnect()
Disconnects from Adafruit IO+ Wippersnapper.
Definition: Wippersnapper.cpp:153
-
Wippersnapper::_topic_signal_uart_brkr
char * _topic_signal_uart_brkr
Definition: Wippersnapper.h:427
+
Wippersnapper::_topic_signal_uart_brkr
char * _topic_signal_uart_brkr
Definition: Wippersnapper.h:433
Wippersnapper::setupMQTTClient
virtual void setupMQTTClient(const char *clientID)
Sets up the MQTT client session.
Definition: Wippersnapper.cpp:203
-
Wippersnapper::_boardId
const char * _boardId
Definition: Wippersnapper.h:397
+
Wippersnapper::_boardId
const char * _boardId
Definition: Wippersnapper.h:403
ws_pixels.h
ws_mqtt_status_t
ws_mqtt_status_t
Definition: Wippersnapper.h:213
Wippersnapper_DigitalGPIO.h
-
Wippersnapper::_throttle_sub
Adafruit_MQTT_Subscribe * _throttle_sub
Definition: Wippersnapper.h:519
+
Wippersnapper::_throttle_sub
Adafruit_MQTT_Subscribe * _throttle_sub
Definition: Wippersnapper.h:525
ws_ledc
High-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls.
Definition: ws_ledc.h:37
-
Wippersnapper::_isI2CPort1Init
bool _isI2CPort1Init
True if I2C port 1 has been initialized, False otherwise.
Definition: Wippersnapper.h:363
-
Wippersnapper::_ledc
ws_ledc * _ledc
Pointer to LEDC object.
Definition: Wippersnapper.h:463
+
Wippersnapper::_isI2CPort1Init
bool _isI2CPort1Init
True if I2C port 1 has been initialized, False otherwise.
Definition: Wippersnapper.h:369
+
Wippersnapper::_ledc
ws_ledc * _ledc
Pointer to LEDC object.
Definition: Wippersnapper.h:469
Wippersnapper::generateWSErrorTopics
bool generateWSErrorTopics()
Builds MQTT topics for handling errors returned from the Adafruit IO broker and subscribes to them...
Definition: Wippersnapper.cpp:1776
-
Wippersnapper::_ws_pixelsComponent
ws_pixels * _ws_pixelsComponent
ptr to instance of ws_pixels class
Definition: Wippersnapper.h:388
+
Wippersnapper::_ws_pixelsComponent
ws_pixels * _ws_pixelsComponent
ptr to instance of ws_pixels class
Definition: Wippersnapper.h:394
Wippersnapper_DigitalGPIO
Class that provides functions for reading and interacting with digital inputs and outputs...
Definition: Wippersnapper_DigitalGPIO.h:38
-
Wippersnapper::publish
void publish(const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos=0)
Publishes a message to the Adafruit IO MQTT broker. Handles network connectivity. ...
Definition: Wippersnapper.cpp:2637
-
Wippersnapper::_topic_signal_pwm_brkr
char * _topic_signal_pwm_brkr
Definition: Wippersnapper.h:417
-
Wippersnapper::processPackets
void processPackets()
Process all incoming packets from the Adafruit IO MQTT broker. Handles network connectivity.
Definition: Wippersnapper.cpp:2615
-
Wippersnapper::_deviceId
const char * _deviceId
Definition: Wippersnapper.h:479
-
Wippersnapper::_device_uid
char * _device_uid
Definition: Wippersnapper.h:480
+
Wippersnapper::publish
void publish(const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos=0)
Publishes a message to the Adafruit IO MQTT broker. Handles network connectivity. ...
Definition: Wippersnapper.cpp:2656
+
Wippersnapper::_topic_signal_pwm_brkr
char * _topic_signal_pwm_brkr
Definition: Wippersnapper.h:423
+
Wippersnapper::processPackets
void processPackets()
Process all incoming packets from the Adafruit IO MQTT broker. Handles network connectivity.
Definition: Wippersnapper.cpp:2634
+
Wippersnapper::_deviceId
const char * _deviceId
Definition: Wippersnapper.h:485
+
Wippersnapper::_device_uid
char * _device_uid
Definition: Wippersnapper.h:486
Wippersnapper_StatusLED.h
Wippersnapper::~Wippersnapper
virtual ~Wippersnapper()
Wippersnapper destructor.
Definition: Wippersnapper.cpp:79
ws_led_status_t
ws_led_status_t
Definition: Wippersnapper_StatusLED.h:34
-
WS_MQTT_MAX_PAYLOAD_SIZE
#define WS_MQTT_MAX_PAYLOAD_SIZE
MAXIMUM expected payload size, in bytes.
Definition: Wippersnapper.h:251
-
Wippersnapper::connect
void connect()
Connects to Adafruit IO+ Wippersnapper broker.
Definition: Wippersnapper.cpp:2745
+
WS_MQTT_MAX_PAYLOAD_SIZE
#define WS_MQTT_MAX_PAYLOAD_SIZE
MAXIMUM expected payload size, in bytes.
Definition: Wippersnapper.h:256
+
Wippersnapper::connect
void connect()
Connects to Adafruit IO+ Wippersnapper broker.
Definition: Wippersnapper.cpp:2764
Wippersnapper::encodePinEvent
bool encodePinEvent(wippersnapper_signal_v1_CreateSignalRequest *outgoingSignalMsg, uint8_t pinName, int pinVal)
Handles MQTT messages on signal topic until timeout.
Definition: Wippersnapper.cpp:1646
-
Wippersnapper::_topic_description_status
char * _topic_description_status
Definition: Wippersnapper.h:483
+
Wippersnapper::_topic_description_status
char * _topic_description_status
Definition: Wippersnapper.h:489
Wippersnapper::generateWSTopics
bool generateWSTopics()
Generates device-specific Wippersnapper control topics and subscribes to them.
Definition: Wippersnapper.cpp:1875
Wippersnapper_AnalogIO
Class that provides an interface for reading and controlling analog pins. Stores information about an...
Definition: Wippersnapper_AnalogIO.h:43
-
Wippersnapper::_littleFS
WipperSnapper_LittleFS * _littleFS
Instance of LittleFS Filesystem (non-native USB)
Definition: Wippersnapper.h:382
-
Wippersnapper::status_pixel_brightness
float status_pixel_brightness
Definition: Wippersnapper.h:288
-
Wippersnapper::_buffer_outgoing
uint8_t _buffer_outgoing[WS_MQTT_MAX_PAYLOAD_SIZE]
Definition: Wippersnapper.h:369
+
Wippersnapper::_littleFS
WipperSnapper_LittleFS * _littleFS
Instance of LittleFS Filesystem (non-native USB)
Definition: Wippersnapper.h:388
+
Wippersnapper::status_pixel_brightness
float status_pixel_brightness
Definition: Wippersnapper.h:293
+
Wippersnapper::_buffer_outgoing
uint8_t _buffer_outgoing[WS_MQTT_MAX_PAYLOAD_SIZE]
Definition: Wippersnapper.h:375
Wippersnapper::errorWriteHang
void errorWriteHang(String error)
Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern ...
Definition: Wippersnapper.cpp:2334
-
Wippersnapper::_topic_signal_ds18_sub
Adafruit_MQTT_Subscribe * _topic_signal_ds18_sub
Definition: Wippersnapper.h:510
+
Wippersnapper::_topic_signal_ds18_sub
Adafruit_MQTT_Subscribe * _topic_signal_ds18_sub
Definition: Wippersnapper.h:516
Wippersnapper::decodeSignalMsg
bool decodeSignalMsg(wippersnapper_signal_v1_CreateSignalRequest *encodedSignalMsg)
Decodes a signal buffer protobuf message. NOTE: Should be executed in-order after a new _buffer is re...
Definition: Wippersnapper.cpp:500
Wippersnapper::provision
void provision()
Provisions a WipperSnapper device with its network configuration and Adafruit IO credentials.
Definition: Wippersnapper.cpp:94
-
Wippersnapper::_topic_signal_i2c_sub
Adafruit_MQTT_Subscribe * _topic_signal_i2c_sub
Definition: Wippersnapper.h:504
-
Wippersnapper::_topic_signal_device
char * _topic_signal_device
Definition: Wippersnapper.h:408
-
Wippersnapper::_buffer
uint8_t _buffer[WS_MQTT_MAX_PAYLOAD_SIZE]
Definition: Wippersnapper.h:366
-
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:400
-
Wippersnapper::_last_mqtt_connect
uint32_t _last_mqtt_connect
Definition: Wippersnapper.h:471
+
Wippersnapper::_topic_signal_i2c_sub
Adafruit_MQTT_Subscribe * _topic_signal_i2c_sub
Definition: Wippersnapper.h:510
+
Wippersnapper::_topic_signal_device
char * _topic_signal_device
Definition: Wippersnapper.h:414
+
Wippersnapper::_buffer
uint8_t _buffer[WS_MQTT_MAX_PAYLOAD_SIZE]
Definition: Wippersnapper.h:372
+
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:406
+
Wippersnapper::_last_mqtt_connect
uint32_t _last_mqtt_connect
Definition: Wippersnapper.h:477
ws_servo.h
-
Wippersnapper::_topic_signal_i2c_device
char * _topic_signal_i2c_device
Definition: Wippersnapper.h:411
-
Wippersnapper::_topic_signal_pixels_device
char * _topic_signal_pixels_device
Definition: Wippersnapper.h:426
-
Wippersnapper::_ui_helper
ws_display_ui_helper * _ui_helper
Instance of display UI helper class.
Definition: Wippersnapper.h:385
-
Wippersnapper::msgSignalI2C
wippersnapper_signal_v1_I2CRequest msgSignalI2C
Definition: Wippersnapper.h:432
-
Wippersnapper::_digitalGPIO
Wippersnapper_DigitalGPIO * _digitalGPIO
Instance of digital gpio class.
Definition: Wippersnapper.h:378
+
Wippersnapper::_topic_signal_i2c_device
char * _topic_signal_i2c_device
Definition: Wippersnapper.h:417
+
Wippersnapper::_topic_signal_pixels_device
char * _topic_signal_pixels_device
Definition: Wippersnapper.h:432
+
Wippersnapper::_ui_helper
ws_display_ui_helper * _ui_helper
Instance of display UI helper class.
Definition: Wippersnapper.h:391
+
Wippersnapper::msgSignalI2C
wippersnapper_signal_v1_I2CRequest msgSignalI2C
Definition: Wippersnapper.h:438
+
Wippersnapper::_digitalGPIO
Wippersnapper_DigitalGPIO * _digitalGPIO
Instance of digital gpio class.
Definition: Wippersnapper.h:384
ws_status_t
ws_status_t
Definition: Wippersnapper.h:190
-
Wippersnapper::_i2cPort1
WipperSnapper_Component_I2C * _i2cPort1
WipperSnapper I2C Component for I2C port #1.
Definition: Wippersnapper.h:359
-
Wippersnapper::_incomingSignalMsg
wippersnapper_signal_v1_CreateSignalRequest _incomingSignalMsg
Definition: Wippersnapper.h:431
+
Wippersnapper::_i2cPort1
WipperSnapper_Component_I2C * _i2cPort1
WipperSnapper I2C Component for I2C port #1.
Definition: Wippersnapper.h:365
+
Wippersnapper::_incomingSignalMsg
wippersnapper_signal_v1_CreateSignalRequest _incomingSignalMsg
Definition: Wippersnapper.h:437
Wippersnapper::check_valid_ssid
virtual bool check_valid_ssid()
Performs a scan of local WiFi networks.
Definition: Wippersnapper.cpp:248
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
ws_servo
Interface for WipperSnapper servo control.
Definition: ws_servo.h:61
Wippersnapper::configureDigitalPinReq
bool configureDigitalPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)
Configures a pin according to a wippersnapper_pin_v1_ConfigurePinRequest message. ...
Definition: Wippersnapper.cpp:326
ws_pixels
friend class
Definition: ws_pixels.h:49
-
Wippersnapper::run
ws_status_t run()
Processes incoming commands and handles network connection.
Definition: Wippersnapper.cpp:2856
+
Wippersnapper::run
ws_status_t run()
Processes incoming commands and handles network connection.
Definition: Wippersnapper.cpp:2874
Wippersnapper::_connect
virtual void _connect()
Connects to wireless network.
Definition: Wippersnapper.cpp:162
-
Wippersnapper::_outgoingSignalMsg
wippersnapper_signal_v1_CreateSignalRequest _outgoingSignalMsg
Definition: Wippersnapper.h:522
-
Wippersnapper::_topic_signal_pwm_device
char * _topic_signal_pwm_device
Definition: Wippersnapper.h:419
+
Wippersnapper::_outgoingSignalMsg
wippersnapper_signal_v1_CreateSignalRequest _outgoingSignalMsg
Definition: Wippersnapper.h:528
+
Wippersnapper::_topic_signal_pwm_device
char * _topic_signal_pwm_device
Definition: Wippersnapper.h:425
Wippersnapper::encodePubRegistrationReq
bool encodePubRegistrationReq()
Encodes hardware registration request message and publishes the message to the Adafruit IO broker...
Definition: Wippersnapper_Register.cpp:27
-
Wippersnapper::throttleMessage
char * throttleMessage
Definition: Wippersnapper.h:455
-
Wippersnapper::_prv_ping
uint32_t _prv_ping
Definition: Wippersnapper.h:473
+
Wippersnapper::throttleMessage
char * throttleMessage
Definition: Wippersnapper.h:461
+
Wippersnapper::_prv_ping
uint32_t _prv_ping
Definition: Wippersnapper.h:479
Wippersnapper::getMacAddr
virtual void getMacAddr()
Sets the network interface&#39;s unique identifer, typically the MAC address.
Definition: Wippersnapper.cpp:181
WipperSnapper_I2C.h
Wippersnapper::generateDeviceUID
bool generateDeviceUID()
Attempts to generate unique device identifier.
Definition: Wippersnapper.cpp:1834
-
Wippersnapper::_topic_description_sub
Adafruit_MQTT_Subscribe * _topic_description_sub
Definition: Wippersnapper.h:497
-
Wippersnapper::sUID
char sUID[13]
Definition: Wippersnapper.h:396
+
Wippersnapper::_topic_description_sub
Adafruit_MQTT_Subscribe * _topic_description_sub
Definition: Wippersnapper.h:503
+
Wippersnapper::sUID
char sUID[13]
Definition: Wippersnapper.h:402
WS
Wippersnapper WS
Global member variable for callbacks.
Definition: Wippersnapper.cpp:36
Wippersnapper::set_ssid_pass
virtual void set_ssid_pass()
Sets the device&#39;s wireless network credentials from the secrets.json configuration file...
Definition: Wippersnapper.cpp:238
-
Wippersnapper::_err_topic
char * _err_topic
Definition: Wippersnapper.h:494
-
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2589
-
Wippersnapper::_prvKATBlink
uint32_t _prvKATBlink
Definition: Wippersnapper.h:475
-
Wippersnapper::_topic_signal_servo_device
char * _topic_signal_servo_device
Definition: Wippersnapper.h:415
+
Wippersnapper::_err_topic
char * _err_topic
Definition: Wippersnapper.h:500
+
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2608
+
Wippersnapper::_prvKATBlink
uint32_t _prvKATBlink
Definition: Wippersnapper.h:481
+
Wippersnapper::_topic_signal_servo_device
char * _topic_signal_servo_device
Definition: Wippersnapper.h:421
ws_display_driver
Display driver for LVGL and LVGL_Glue in WipperSnapper.
Definition: ws_display_driver.h:33
-
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:402
-
Wippersnapper::_topic_signal_pixels_sub
Adafruit_MQTT_Subscribe * _topic_signal_pixels_sub
Definition: Wippersnapper.h:512
+
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:408
+
Wippersnapper::_topic_signal_pixels_sub
Adafruit_MQTT_Subscribe * _topic_signal_pixels_sub
Definition: Wippersnapper.h:518
ws_display_ui_helper.h
-
Wippersnapper::_ds18x20Component
ws_ds18x20 * _ds18x20Component
Instance of DS18x20 class.
Definition: Wippersnapper.h:391
-
Wippersnapper::_boardStatus
ws_board_status_t _boardStatus
Hardware&#39;s registration status.
Definition: Wippersnapper.h:373
-
Wippersnapper::msgSignalUART
wippersnapper_signal_v1_UARTRequest msgSignalUART
UARTReq wrapper message.
Definition: Wippersnapper.h:453
+
Wippersnapper::_ds18x20Component
ws_ds18x20 * _ds18x20Component
Instance of DS18x20 class.
Definition: Wippersnapper.h:397
+
Wippersnapper::_boardStatus
ws_board_status_t _boardStatus
Hardware&#39;s registration status.
Definition: Wippersnapper.h:379
+
Wippersnapper::msgSignalUART
wippersnapper_signal_v1_UARTRequest msgSignalUART
UARTReq wrapper message.
Definition: Wippersnapper.h:459
ws_ledc.h
Wippersnapper::runNetFSM
void runNetFSM()
Checks network and MQTT connectivity. Handles network re-connection and mqtt re-establishment.
Definition: Wippersnapper.cpp:2358
-
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:401
-
Wippersnapper::pinCfgCompleted
bool pinCfgCompleted
Definition: Wippersnapper.h:459
-
Wippersnapper::_topic_signal_uart_device
char * _topic_signal_uart_device
Definition: Wippersnapper.h:428
-
Wippersnapper::pingBroker
void pingBroker()
Pings the MQTT broker within the keepalive interval to keep the connection alive. Blinks the keepaliv...
Definition: Wippersnapper.cpp:2557
-
Wippersnapper::msgSignalDS
wippersnapper_signal_v1_Ds18x20Request msgSignalDS
Definition: Wippersnapper.h:437
+
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:407
+
Wippersnapper::pinCfgCompleted
bool pinCfgCompleted
Definition: Wippersnapper.h:465
+
Wippersnapper::haltError
void haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25)
Prints an error to the serial and halts the hardware until the WDT bites.
Definition: Wippersnapper.cpp:2504
+
Wippersnapper::_topic_signal_uart_device
char * _topic_signal_uart_device
Definition: Wippersnapper.h:434
+
Wippersnapper::pingBroker
void pingBroker()
Pings the MQTT broker within the keepalive interval to keep the connection alive. Blinks the keepaliv...
Definition: Wippersnapper.cpp:2576
+
Wippersnapper::msgSignalDS
wippersnapper_signal_v1_Ds18x20Request msgSignalDS
Definition: Wippersnapper.h:443
ws_display_driver.h
-
Wippersnapper::_display
ws_display_driver * _display
Instance of display driver class.
Definition: Wippersnapper.h:384
-
Wippersnapper::msgPixels
wippersnapper_signal_v1_PixelsRequest msgPixels
PixelsRequest wrapper message.
Definition: Wippersnapper.h:450
-
Wippersnapper::enableWDT
void enableWDT(int timeoutMS=0)
Enables the watchdog timer.
Definition: Wippersnapper.cpp:2599
-
Wippersnapper::_topic_signal_pwm_sub
Adafruit_MQTT_Subscribe * _topic_signal_pwm_sub
Definition: Wippersnapper.h:508
+
Wippersnapper::_display
ws_display_driver * _display
Instance of display driver class.
Definition: Wippersnapper.h:390
+
Wippersnapper::msgPixels
wippersnapper_signal_v1_PixelsRequest msgPixels
PixelsRequest wrapper message.
Definition: Wippersnapper.h:456
+
Wippersnapper::enableWDT
void enableWDT(int timeoutMS=0)
Enables the watchdog timer.
Definition: Wippersnapper.cpp:2618
+
Wippersnapper::_topic_signal_pwm_sub
Adafruit_MQTT_Subscribe * _topic_signal_pwm_sub
Definition: Wippersnapper.h:514
ws_ds18x20
Class that provides an interface with DS18X20-compatible sensors.
Definition: ws_ds18x20.h:48
-
Wippersnapper::_topic_signal_ds18_brkr
char * _topic_signal_ds18_brkr
Definition: Wippersnapper.h:421
-
Wippersnapper::publishPinConfigComplete
void publishPinConfigComplete()
Publishes an ACK to the broker that the device has completed its hardware configuration.
Definition: Wippersnapper.cpp:2822
-
Wippersnapper::i2cComponents
std::vector< WipperSnapper_Component_I2C * > i2cComponents
Vector containing all I2C components.
Definition: Wippersnapper.h:356
+
Wippersnapper::_topic_signal_ds18_brkr
char * _topic_signal_ds18_brkr
Definition: Wippersnapper.h:427
+
Wippersnapper::publishPinConfigComplete
void publishPinConfigComplete()
Publishes an ACK to the broker that the device has completed its hardware configuration.
Definition: Wippersnapper.cpp:2840
+
Wippersnapper::i2cComponents
std::vector< WipperSnapper_Component_I2C * > i2cComponents
Vector containing all I2C components.
Definition: Wippersnapper.h:362
ws_display_ui_helper
Helps build and manage the LVGL objects and screens for the application code.
Definition: ws_display_ui_helper.h:63
-
Wippersnapper::bufSize
uint16_t bufSize
Definition: Wippersnapper.h:371
-
Wippersnapper::_topic_signal_i2c_brkr
char * _topic_signal_i2c_brkr
Definition: Wippersnapper.h:409
-
Wippersnapper::_topic_signal_brkr_sub
Adafruit_MQTT_Subscribe * _topic_signal_brkr_sub
Definition: Wippersnapper.h:501
-
Wippersnapper::_topic_signal_brkr
char * _topic_signal_brkr
Definition: Wippersnapper.h:493
-
Wippersnapper::totalDigitalPins
int32_t totalDigitalPins
Definition: Wippersnapper.h:405
+
Wippersnapper::bufSize
uint16_t bufSize
Definition: Wippersnapper.h:377
+
Wippersnapper::_topic_signal_i2c_brkr
char * _topic_signal_i2c_brkr
Definition: Wippersnapper.h:415
+
Wippersnapper::_topic_signal_brkr_sub
Adafruit_MQTT_Subscribe * _topic_signal_brkr_sub
Definition: Wippersnapper.h:507
+
Wippersnapper::_topic_signal_brkr
char * _topic_signal_brkr
Definition: Wippersnapper.h:499
+
Wippersnapper::totalDigitalPins
int32_t totalDigitalPins
Definition: Wippersnapper.h:411
ws_pwm
Interface for WipperSnapper PWM.
Definition: ws_pwm.h:34
-
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:470
+
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:476
ws_board_status_t
ws_board_status_t
Definition: Wippersnapper.h:225
-
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:395
-
Wippersnapper::_pwmComponent
ws_pwm * _pwmComponent
Instance of pwm class.
Definition: Wippersnapper.h:389
+
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:401
+
Wippersnapper::_pwmComponent
ws_pwm * _pwmComponent
Instance of pwm class.
Definition: Wippersnapper.h:395
fsm_net_t
fsm_net_t
Definition: Wippersnapper.h:235
-
Wippersnapper::lockStatusLED
bool lockStatusLED
True if status LED is using the built-in LED.
Definition: Wippersnapper.h:287
-
Wippersnapper::_fileSystem
Wippersnapper_FS * _fileSystem
Instance of Filesystem (native USB)
Definition: Wippersnapper.h:380
-
Wippersnapper::_topic_signal_uart_sub
Adafruit_MQTT_Subscribe * _topic_signal_uart_sub
Definition: Wippersnapper.h:514
-
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:398
+
Wippersnapper::lockStatusLED
bool lockStatusLED
True if status LED is using the built-in LED.
Definition: Wippersnapper.h:292
+
Wippersnapper::_fileSystem
Wippersnapper_FS * _fileSystem
Instance of Filesystem (native USB)
Definition: Wippersnapper.h:386
+
Wippersnapper::_topic_signal_uart_sub
Adafruit_MQTT_Subscribe * _topic_signal_uart_sub
Definition: Wippersnapper.h:520
+
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:404
STATUS_PIXEL_BRIGHTNESS_DEFAULT
#define STATUS_PIXEL_BRIGHTNESS_DEFAULT
Default status pixel brightness.
Definition: Wippersnapper_StatusLED.h:59
Wippersnapper::networkStatus
virtual ws_status_t networkStatus()
Returns the network&#39;s connection status.
Definition: Wippersnapper.cpp:213
-
Wippersnapper::_topic_device_pin_config_complete
char * _topic_device_pin_config_complete
Definition: Wippersnapper.h:489
-
Wippersnapper::_topic_signal_servo_brkr
char * _topic_signal_servo_brkr
Definition: Wippersnapper.h:413
-
Wippersnapper::_analogIO
Wippersnapper_AnalogIO * _analogIO
Instance of analog io class.
Definition: Wippersnapper.h:379
-
Wippersnapper::_topic_description_status_complete
char * _topic_description_status_complete
Definition: Wippersnapper.h:486
+
Wippersnapper::_topic_device_pin_config_complete
char * _topic_device_pin_config_complete
Definition: Wippersnapper.h:495
+
Wippersnapper::_topic_signal_servo_brkr
char * _topic_signal_servo_brkr
Definition: Wippersnapper.h:419
+
Wippersnapper::_analogIO
Wippersnapper_AnalogIO * _analogIO
Instance of analog io class.
Definition: Wippersnapper.h:385
+
Wippersnapper::_topic_description_status_complete
char * _topic_description_status_complete
Definition: Wippersnapper.h:492
Wippersnapper::pollRegistrationResp
void pollRegistrationResp()
Polls the broker for the hardware registration response message.
Definition: Wippersnapper_Register.cpp:78
-
Wippersnapper::getBoardStatus
ws_board_status_t getBoardStatus()
Returns the board definition status.
Definition: Wippersnapper.cpp:2548
+
Wippersnapper::getBoardStatus
ws_board_status_t getBoardStatus()
Returns the board definition status.
Definition: Wippersnapper.cpp:2567
Wippersnapper::configAnalogInPinReq
bool configAnalogInPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)
Configures an analog input pin according to a wippersnapper_pin_v1_ConfigurePinRequest message...
Definition: Wippersnapper.cpp:275
-
Wippersnapper::lockStatusDotStar
bool lockStatusDotStar
True if status LED is using the status dotstar.
Definition: Wippersnapper.h:286
-
Wippersnapper::msgServo
wippersnapper_signal_v1_ServoRequest msgServo
ServoRequest wrapper message.
Definition: Wippersnapper.h:443
-
Wippersnapper::_throttle_topic
char * _throttle_topic
Definition: Wippersnapper.h:495
+
Wippersnapper::lockStatusDotStar
bool lockStatusDotStar
True if status LED is using the status dotstar.
Definition: Wippersnapper.h:291
+
Wippersnapper::msgServo
wippersnapper_signal_v1_ServoRequest msgServo
ServoRequest wrapper message.
Definition: Wippersnapper.h:449
+
Wippersnapper::_throttle_topic
char * _throttle_topic
Definition: Wippersnapper.h:501
Wippersnapper::decodeRegistrationResp
void decodeRegistrationResp(char *data, uint16_t len)
Decodes hardware registration response message from the Adafruit IO MQTT broker and initializes hardw...
Definition: Wippersnapper_Register.cpp:98
-
Wippersnapper::lockStatusNeoPixel
bool lockStatusNeoPixel
True if status LED is using the status neopixel.
Definition: Wippersnapper.h:285
-
Wippersnapper::_topic_signal_servo_sub
Adafruit_MQTT_Subscribe * _topic_signal_servo_sub
Definition: Wippersnapper.h:506
-
Wippersnapper::_i2cPort0
WipperSnapper_Component_I2C * _i2cPort0
WipperSnapper I2C Component for I2C port #0.
Definition: Wippersnapper.h:357
-
Wippersnapper::registerBoard
bool registerBoard()
Attempts to register hardware with Adafruit.io WipperSnapper.
Definition: Wippersnapper.cpp:2524
-
Wippersnapper::throttleTime
int throttleTime
Definition: Wippersnapper.h:456
-
Wippersnapper::_err_sub
Adafruit_MQTT_Subscribe * _err_sub
Definition: Wippersnapper.h:517
-
Wippersnapper::haltError
void haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)
Prints an error to the serial and halts the hardware until the WDT bites.
Definition: Wippersnapper.cpp:2502
-
Wippersnapper::_topic_signal_ds18_device
char * _topic_signal_ds18_device
Definition: Wippersnapper.h:423
+
Wippersnapper::lockStatusNeoPixel
bool lockStatusNeoPixel
True if status LED is using the status neopixel.
Definition: Wippersnapper.h:290
+
Wippersnapper::_topic_signal_servo_sub
Adafruit_MQTT_Subscribe * _topic_signal_servo_sub
Definition: Wippersnapper.h:512
+
Wippersnapper::_i2cPort0
WipperSnapper_Component_I2C * _i2cPort0
WipperSnapper I2C Component for I2C port #0.
Definition: Wippersnapper.h:363
+
Wippersnapper::registerBoard
bool registerBoard()
Attempts to register hardware with Adafruit.io WipperSnapper.
Definition: Wippersnapper.cpp:2543
+
Wippersnapper::throttleTime
int throttleTime
Definition: Wippersnapper.h:462
+
Wippersnapper::_err_sub
Adafruit_MQTT_Subscribe * _err_sub
Definition: Wippersnapper.h:523
+
Wippersnapper::_topic_signal_ds18_device
char * _topic_signal_ds18_device
Definition: Wippersnapper.h:429
ws_ds18x20.h
-
Wippersnapper::_isI2CPort0Init
bool _isI2CPort0Init
True if I2C port 0 has been initialized, False otherwise.
Definition: Wippersnapper.h:361
+
Wippersnapper::_isI2CPort0Init
bool _isI2CPort0Init
True if I2C port 0 has been initialized, False otherwise.
Definition: Wippersnapper.h:367
Wippersnapper::getRSSI
virtual int32_t getRSSI()
Gets the network&#39;s RSSI.
Definition: Wippersnapper.cpp:191
Wippersnapper::_disconnect
virtual void _disconnect()
Disconnect Wippersnapper MQTT session and network.
Definition: Wippersnapper.cpp:171
ws_uart.h
-
Wippersnapper::_servoComponent
ws_servo * _servoComponent
Instance of servo class.
Definition: Wippersnapper.h:390
+
Wippersnapper::_servoComponent
ws_servo * _servoComponent
Instance of servo class.
Definition: Wippersnapper.h:396
Wippersnapper_AnalogIO.h
-
Wippersnapper::_topic_signal_device_pub
Adafruit_MQTT_Publish * _topic_signal_device_pub
Definition: Wippersnapper.h:499
-
Wippersnapper::_uartComponent
ws_uart * _uartComponent
Instance of UART class.
Definition: Wippersnapper.h:392
-
Wippersnapper::_topic_description
char * _topic_description
Definition: Wippersnapper.h:407
+
Wippersnapper::_topic_signal_device_pub
Adafruit_MQTT_Publish * _topic_signal_device_pub
Definition: Wippersnapper.h:505
+
Wippersnapper::_uartComponent
ws_uart * _uartComponent
Instance of UART class.
Definition: Wippersnapper.h:398
+
Wippersnapper::_topic_description
char * _topic_description
Definition: Wippersnapper.h:413
ws_uart
Class that provides an interface between WipperSnapper&#39;s app and the device&#39;s UART bus...
Definition: ws_uart.h:29
Wippersnapper::set_user_key
virtual void set_user_key()
Configures the device&#39;s Adafruit IO credentials. This method should be used only if filesystem-backed...
Definition: Wippersnapper.cpp:260
diff --git a/html/_wippersnapper___a_i_r_l_i_f_t_8h_source.html b/html/_wippersnapper___a_i_r_l_i_f_t_8h_source.html index 4c125db21..ad37d9731 100644 --- a/html/_wippersnapper___a_i_r_l_i_f_t_8h_source.html +++ b/html/_wippersnapper___a_i_r_l_i_f_t_8h_source.html @@ -66,51 +66,53 @@
Wippersnapper_AIRLIFT.h
-Go to the documentation of this file.
1 
20 #ifndef WIPPERSNAPPER_AIRLIFT_H
21 #define WIPPERSNAPPER_AIRLIFT_H
22 
23 #include "Adafruit_MQTT.h"
24 #include "Adafruit_MQTT_Client.h"
25 #include "Arduino.h"
26 #include "SPI.h"
27 #include "WiFiNINA.h"
28 #include "Wippersnapper.h"
29 
30 #define NINAFWVER \
31  "1.7.7"
32 #define AIRLIFT_CONNECT_TIMEOUT_MS 20000
33 #define AIRLIFT_CONNECT_RETRY_DELAY_MS 200
35 #define SPIWIFI SPI
37 extern Wippersnapper WS;
38 /****************************************************************************/
42 /****************************************************************************/
43 class Wippersnapper_AIRLIFT : public Wippersnapper {
44 
45 public:
46  /**************************************************************************/
50  /**************************************************************************/
51  Wippersnapper_AIRLIFT() : Wippersnapper() {
52  _ssPin = SPIWIFI_SS; // 10;
53  _ackPin = SPIWIFI_ACK; // 7;
54  _rstPin = SPIWIFI_RESET; // 5; // should be 7 on PyPortals
55 #ifdef ESP32_GPIO0
56  _gpio0Pin = ESP32_GPIO0;
57 #else
58  _gpio0Pin = -1;
59 #endif
60  _wifi = &SPIWIFI;
61  _ssid = 0;
62  _pass = 0;
63  _mqtt_client = new WiFiSSLClient;
64 
65  // setup ESP32 co-processor pins during init.
66  WiFi.setPins(_ssPin, _ackPin, _rstPin, _gpio0Pin, _wifi);
67  }
68 
69  /**************************************************************************/
73  /**************************************************************************/
74  ~Wippersnapper_AIRLIFT() {
75  if (_mqtt)
76  delete _mqtt;
77  }
78 
79  /**********************************************************/
87  /**********************************************************/
88  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
89  _ssid = ssid;
90  _pass = ssidPassword;
91  }
92 
93  /**********************************************************/
98  /**********************************************************/
99  void set_ssid_pass() {
100  _ssid = WS._config.network.ssid;
101  _pass = WS._config.network.pass;
102  }
103 
104  /***********************************************************/
109  /***********************************************************/
110  bool check_valid_ssid() {
111  // Disconnect WiFi from an AP if it was previously connected
112  WiFi.disconnect();
113  delay(100);
114 
115  // Perform a network scan
116  int n = WiFi.scanNetworks();
117  if (n == 0) {
118  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
119  return false;
120  }
121 
122  // Was the network within secrets.json found?
123  for (int i = 0; i < n; ++i) {
124  if (strcmp(_ssid, WiFi.SSID(i)) == 0) {
125  WS_DEBUG_PRINT("SSID found! RSSI: ");
126  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
127  return true;
128  }
129  }
130 
131  // User-set network not found, print scan results to serial console
132  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
133  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks: ");
134  for (int i = 0; i < n; ++i) {
135  WS_DEBUG_PRINT(WiFi.SSID(i));
136  WS_DEBUG_PRINT(" ");
137  WS_DEBUG_PRINT(WiFi.RSSI(i));
138  WS_DEBUG_PRINTLN("dB");
139  }
140 
141  return false;
142  }
143 
144  /********************************************************/
150  /********************************************************/
151  void set_wifi(SPIClass *wifi) {
152  _wifi = wifi;
153  _mqtt_client = new WiFiSSLClient;
154  }
155 
156  /********************************************************/
168  /********************************************************/
169  void set_airlift_pins(int ssPin, int ackPin, int rstPin, int gpio0Pin) {
170  _ssPin = ssPin;
171  _ackPin = ackPin;
172  _rstPin = rstPin;
173  _gpio0Pin = gpio0Pin;
174  }
175 
176  /********************************************************/
183  /********************************************************/
184  bool firmwareCheck() {
185  _fv = WiFi.firmwareVersion();
186  return compareVersions(_fv, NINAFWVER);
187  }
188 
189  /********************************************************/
199  /********************************************************/
200  bool compareVersions(const char *currentVersion,
201  const char *requiredVersion) {
202  int curMajor = 0, curMinor = 0, curPatch = 0;
203  int reqMajor = 0, reqMinor = 0, reqPatch = 0;
204 
205  if (!sscanf(currentVersion, "%d.%d.%d", &curMajor, &curMinor, &curPatch) ||
206  !sscanf(requiredVersion, "%d.%d.%d", &reqMajor, &reqMinor, &reqPatch)) {
207  WS_DEBUG_PRINTLN("Error parsing firmware version strings");
208  WS_PRINTER.flush();
209  WS_DEBUG_PRINT("Required version: ");
210  WS_DEBUG_PRINTLN(requiredVersion);
211  WS_PRINTER.flush();
212  WS_DEBUG_PRINT("Current version: ");
213  WS_DEBUG_PRINTLN(currentVersion);
214  WS_PRINTER.flush();
215  return false;
216  }
217 
218  if (curMajor != reqMajor)
219  return curMajor > reqMajor;
220  if (curMinor != reqMinor)
221  return curMinor > reqMinor;
222  return curPatch >= reqPatch;
223  }
224 
225  /********************************************************/
230  /********************************************************/
231  void getMacAddr() {
232  uint8_t mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
233  WiFi.macAddress(mac);
234  memcpy(WS._macAddr, mac, sizeof(mac));
235  }
236 
237  /********************************************************/
242  /********************************************************/
243  int32_t getRSSI() { return WiFi.RSSI(); }
244 
245  /********************************************************/
251  /********************************************************/
252  void setupMQTTClient(const char *clientID) {
253  WS._mqtt = new Adafruit_MQTT_Client(
254  _mqtt_client, WS._config.aio_url, WS._config.io_port, clientID,
255  WS._config.aio_user, WS._config.aio_key);
256  }
257 
258  /********************************************************/
263  /********************************************************/
264  ws_status_t networkStatus() {
265  switch (WiFi.status()) {
266  case WL_CONNECTED:
267  return WS_NET_CONNECTED;
268  case WL_CONNECT_FAILED:
269  return WS_NET_CONNECT_FAILED;
270  case WL_IDLE_STATUS:
271  return WS_IDLE;
272  default:
273  return WS_NET_DISCONNECTED;
274  }
275  }
276 
277  /*******************************************************************/
282  /*******************************************************************/
283  const char *connectionType() { return "AIRLIFT"; }
284 
285 protected:
286  const char *_ssid;
287  const char *_pass;
288  const char *_fv = "0.0.1";
289  int _ssPin = -1;
290  int _ackPin = -1;
291  int _rstPin = -1;
292  int _gpio0Pin = -1;
293  WiFiSSLClient *_mqtt_client;
294  SPIClass *_wifi;
296  /**************************************************************************/
300  /**************************************************************************/
301  void _connect() {
302  if (strlen(_ssid) == 0) {
303  _status = WS_SSID_INVALID; // possibly unneccesary as already checking
304  // elsewhere
305  } else {
306  // disconnect from possible previous connection
307  _disconnect();
308  delay(100);
309  WiFi.end();
310  _wifi->end();
311  delay(100);
312  _wifi->begin();
313  feedWDT();
314  // reset the esp32 if possible
315  resetAirLift();
316  feedWDT();
317 
318  WS_DEBUG_PRINT("ESP32 booted, version: ");
319  WS_PRINTER.flush();
320  WS_DEBUG_PRINTLN(WiFi.firmwareVersion());
321  WS_PRINTER.flush();
322  feedWDT();
323 
324  // validate co-processor's firmware version
325  if (!firmwareCheck()) {
326  WS_DEBUG_PRINTLN("Please upgrade the firmware on the ESP module to the "
327  "latest version.");
328  }
329 
330  WS_DEBUG_PRINT("Connecting to ");
331  WS_DEBUG_PRINTLN(_ssid);
332  WS_PRINTER.flush();
333  feedWDT();
334  WiFi.begin(_ssid, _pass);
335  _status = WS_NET_DISCONNECTED;
336 
337  // Use the macro to retry the status check until connected / timed out
338  int lastResult = -1;
339  RETRY_FUNCTION_UNTIL_TIMEOUT(
340  []() -> int { return WiFi.status(); }, // Function call each cycle
341  int, // return type
342  lastResult, // return variable
343  [](int status) { return status == WL_CONNECTED; }, // check
344  AIRLIFT_CONNECT_TIMEOUT_MS, // timeout interval (ms)
345  AIRLIFT_CONNECT_RETRY_DELAY_MS); // interval between retries
346 
347  if (lastResult == WL_CONNECTED) {
348  _status = WS_NET_CONNECTED;
349  // wait 2seconds for connection to stabilize
350  WS_DELAY_WITH_WDT(2000);
351  } else {
352  _status = WS_NET_DISCONNECTED; // maybe connect failed instead?
353  }
354  }
355  }
356 
357  /**************************************************************************/
361  /**************************************************************************/
362  void resetAirLift() {
363  if (_rstPin != -1) {
364  WS_DEBUG_PRINTLN("Resetting ESP32...");
365  WS_PRINTER.flush();
366  // Chip select for esp32
367  pinMode(_ssPin, OUTPUT);
368  digitalWrite(_ssPin, HIGH); // Do we need to set SS low again?
369  if (_gpio0Pin != -1) {
370  pinMode(_gpio0Pin, OUTPUT);
371  digitalWrite(_gpio0Pin, LOW);
372  }
373  pinMode(_rstPin, OUTPUT);
374  digitalWrite(_rstPin, LOW);
375  delay(50);
376  digitalWrite(_rstPin, HIGH);
377  delay(10);
378  if (_gpio0Pin != -1) {
379  pinMode(_gpio0Pin, INPUT);
380  }
381  // wait for the ESP32 to boot
382  delay(2000);
383  }
384  }
385 
386  /**************************************************************************/
390  /**************************************************************************/
391  void _disconnect() {
392  WiFi.disconnect();
393  delay(500);
394  }
395 };
396 
397 #endif // WIPPERSNAPPER_AIRLIFT_H
RETRY_FUNCTION_UNTIL_TIMEOUT
#define RETRY_FUNCTION_UNTIL_TIMEOUT(func, result_type, result_var, condition, timeout, interval,...)
Retry a function until a condition is met or a timeout is reached.
Definition: Wippersnapper.h:108
+Go to the documentation of this file.
1 
20 #ifndef WIPPERSNAPPER_AIRLIFT_H
21 #define WIPPERSNAPPER_AIRLIFT_H
22 
23 #include "Adafruit_MQTT.h"
24 #include "Adafruit_MQTT_Client.h"
25 #include "Arduino.h"
26 #include "SPI.h"
27 #include "WiFiNINA.h"
28 #include "Wippersnapper.h"
29 
30 #define NINAFWVER \
31  "1.7.7"
32 #define AIRLIFT_CONNECT_TIMEOUT_MS 20000
33 #define AIRLIFT_CONNECT_RETRY_DELAY_MS 200
35 #define SPIWIFI SPI
37 extern Wippersnapper WS;
38 /****************************************************************************/
42 /****************************************************************************/
43 class Wippersnapper_AIRLIFT : public Wippersnapper {
44 
45 public:
46  /**************************************************************************/
50  /**************************************************************************/
51  Wippersnapper_AIRLIFT() : Wippersnapper() {
52  _ssPin = SPIWIFI_SS; // 10;
53  _ackPin = SPIWIFI_ACK; // 7;
54  _rstPin = SPIWIFI_RESET; // 5; // should be 7 on PyPortals
55 #ifdef ESP32_GPIO0
56  _gpio0Pin = ESP32_GPIO0;
57 #else
58  _gpio0Pin = -1;
59 #endif
60  _wifi = &SPIWIFI;
61  _ssid = 0;
62  _pass = 0;
63  _mqtt_client = new WiFiSSLClient;
64 
65  // setup ESP32 co-processor pins during init.
66  WiFi.setPins(_ssPin, _ackPin, _rstPin, _gpio0Pin, _wifi);
67  }
68 
69  /**************************************************************************/
73  /**************************************************************************/
74  ~Wippersnapper_AIRLIFT() {
75  if (_mqtt)
76  delete _mqtt;
77  }
78 
79  /**********************************************************/
87  /**********************************************************/
88  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
89  _ssid = ssid;
90  _pass = ssidPassword;
91  }
92 
93  /**********************************************************/
98  /**********************************************************/
99  void set_ssid_pass() {
100  _ssid = WS._config.network.ssid;
101  _pass = WS._config.network.pass;
102  }
103 
104  /***********************************************************/
109  /***********************************************************/
110  bool check_valid_ssid() {
111  // Disconnect WiFi from an AP if it was previously connected
112  WiFi.disconnect();
113  delay(100);
114 
115  // Perform a network scan
116  int n = WiFi.scanNetworks();
117  if (n == 0) {
118  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
119  return false;
120  }
121 
122  bool foundNetwork = false;
123 
124  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks:");
125  for (uint8_t i = 0; i < n; i++) {
126  if (!foundNetwork && strcmp(WiFi.SSID(i), _ssid) == 0) {
127  foundNetwork = true;
128  }
129  WS_DEBUG_PRINT(WiFi.SSID(i));
130  WS_DEBUG_PRINT(" (");
131  uint8_t BSSID[WL_MAC_ADDR_LENGTH];
132  WiFi.BSSID(i, BSSID);
133  for (int m = 0; m < WL_MAC_ADDR_LENGTH; m++) {
134  if (m != 0)
135  WS_DEBUG_PRINT(":");
136  WS_DEBUG_PRINTHEX(BSSID[m]);
137  }
138  WS_DEBUG_PRINT(") ");
139  WS_DEBUG_PRINT(WiFi.RSSI(i));
140  WS_DEBUG_PRINT("dB (ch");
141  WS_DEBUG_PRINT(WiFi.channel(i))
142  WS_DEBUG_PRINTLN(")");
143  }
144 
145  if (!foundNetwork) {
146  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
147  }
148  return foundNetwork;
149  }
150 
151  /********************************************************/
157  /********************************************************/
158  void set_wifi(SPIClass *wifi) {
159  _wifi = wifi;
160  _mqtt_client = new WiFiSSLClient;
161  }
162 
163  /********************************************************/
175  /********************************************************/
176  void set_airlift_pins(int ssPin, int ackPin, int rstPin, int gpio0Pin) {
177  _ssPin = ssPin;
178  _ackPin = ackPin;
179  _rstPin = rstPin;
180  _gpio0Pin = gpio0Pin;
181  }
182 
183  /********************************************************/
190  /********************************************************/
191  bool firmwareCheck() {
192  _fv = WiFi.firmwareVersion();
193  return compareVersions(_fv, NINAFWVER);
194  }
195 
196  /********************************************************/
206  /********************************************************/
207  bool compareVersions(const char *currentVersion,
208  const char *requiredVersion) {
209  int curMajor = 0, curMinor = 0, curPatch = 0;
210  int reqMajor = 0, reqMinor = 0, reqPatch = 0;
211 
212  if (!sscanf(currentVersion, "%d.%d.%d", &curMajor, &curMinor, &curPatch) ||
213  !sscanf(requiredVersion, "%d.%d.%d", &reqMajor, &reqMinor, &reqPatch)) {
214  WS_DEBUG_PRINTLN("Error parsing firmware version strings");
215  WS_PRINTER.flush();
216  WS_DEBUG_PRINT("Required version: ");
217  WS_DEBUG_PRINTLN(requiredVersion);
218  WS_PRINTER.flush();
219  WS_DEBUG_PRINT("Current version: ");
220  WS_DEBUG_PRINTLN(currentVersion);
221  WS_PRINTER.flush();
222  return false;
223  }
224 
225  if (curMajor != reqMajor)
226  return curMajor > reqMajor;
227  if (curMinor != reqMinor)
228  return curMinor > reqMinor;
229  return curPatch >= reqPatch;
230  }
231 
232  /********************************************************/
237  /********************************************************/
238  void getMacAddr() {
239  uint8_t mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
240  WiFi.macAddress(mac);
241  memcpy(WS._macAddr, mac, sizeof(mac));
242  }
243 
244  /********************************************************/
249  /********************************************************/
250  int32_t getRSSI() { return WiFi.RSSI(); }
251 
252  /********************************************************/
258  /********************************************************/
259  void setupMQTTClient(const char *clientID) {
260  WS._mqtt = new Adafruit_MQTT_Client(
261  _mqtt_client, WS._config.aio_url, WS._config.io_port, clientID,
262  WS._config.aio_user, WS._config.aio_key);
263  }
264 
265  /********************************************************/
270  /********************************************************/
271  ws_status_t networkStatus() {
272  switch (WiFi.status()) {
273  case WL_CONNECTED:
274  return WS_NET_CONNECTED;
275  case WL_CONNECT_FAILED:
276  return WS_NET_CONNECT_FAILED;
277  case WL_IDLE_STATUS:
278  return WS_IDLE;
279  default:
280  return WS_NET_DISCONNECTED;
281  }
282  }
283 
284  /*******************************************************************/
289  /*******************************************************************/
290  const char *connectionType() { return "AIRLIFT"; }
291 
292 protected:
293  const char *_ssid;
294  const char *_pass;
295  const char *_fv = "0.0.1";
296  int _ssPin = -1;
297  int _ackPin = -1;
298  int _rstPin = -1;
299  int _gpio0Pin = -1;
300  WiFiSSLClient *_mqtt_client;
301  SPIClass *_wifi;
303  /**************************************************************************/
307  /**************************************************************************/
308  void _connect() {
309  if (strlen(_ssid) == 0) {
310  _status = WS_SSID_INVALID; // possibly unneccesary as already checking
311  // elsewhere
312  } else {
313  // disconnect from possible previous connection
314  _disconnect();
315  delay(100);
316  WiFi.end();
317  _wifi->end();
318  delay(100);
319  _wifi->begin();
320  feedWDT();
321  // reset the esp32 if possible
322  resetAirLift();
323  feedWDT();
324 
325  WS_DEBUG_PRINT("ESP32 booted, version: ");
326  WS_PRINTER.flush();
327  WS_DEBUG_PRINTLN(WiFi.firmwareVersion());
328  WS_PRINTER.flush();
329  feedWDT();
330 
331  // validate co-processor's firmware version
332  if (!firmwareCheck()) {
333  // TODO: see if there's a way to add to bootlog without usb reattach
334  WS_DEBUG_PRINTLN("Please upgrade the firmware on the ESP module to the "
335  "latest version.");
336  }
337 
338  WS_DEBUG_PRINT("Connecting to ");
339  WS_DEBUG_PRINTLN(_ssid);
340  WS_PRINTER.flush();
341  feedWDT();
342  WiFi.begin(_ssid, _pass);
343  _status = WS_NET_DISCONNECTED;
344 
345  // Use the macro to retry the status check until connected / timed out
346  int lastResult = -1;
347  RETRY_FUNCTION_UNTIL_TIMEOUT(
348  []() -> int { return WiFi.status(); }, // Function call each cycle
349  int, // return type
350  lastResult, // return variable
351  [](int status) { return status == WL_CONNECTED; }, // check
352  AIRLIFT_CONNECT_TIMEOUT_MS, // timeout interval (ms)
353  AIRLIFT_CONNECT_RETRY_DELAY_MS); // interval between retries
354 
355  if (lastResult == WL_CONNECTED) {
356  _status = WS_NET_CONNECTED;
357  // wait 2seconds for connection to stabilize
358  WS_DELAY_WITH_WDT(2000);
359  } else {
360  _status = WS_NET_DISCONNECTED; // maybe connect failed instead?
361  }
362  }
363  }
364 
365  /**************************************************************************/
369  /**************************************************************************/
370  void resetAirLift() {
371  if (_rstPin != -1) {
372  WS_DEBUG_PRINTLN("Resetting ESP32...");
373  WS_PRINTER.flush();
374  // Chip select for esp32
375  pinMode(_ssPin, OUTPUT);
376  digitalWrite(_ssPin, HIGH); // Do we need to set SS low again?
377  if (_gpio0Pin != -1) {
378  pinMode(_gpio0Pin, OUTPUT);
379  digitalWrite(_gpio0Pin, LOW);
380  }
381  pinMode(_rstPin, OUTPUT);
382  digitalWrite(_rstPin, LOW);
383  delay(50);
384  digitalWrite(_rstPin, HIGH);
385  delay(10);
386  if (_gpio0Pin != -1) {
387  pinMode(_gpio0Pin, INPUT);
388  }
389  // wait for the ESP32 to boot
390  delay(2000);
391  }
392  }
393 
394  /**************************************************************************/
398  /**************************************************************************/
399  void _disconnect() {
400  WiFi.disconnect();
401  delay(500);
402  }
403 };
404 
405 #endif // WIPPERSNAPPER_AIRLIFT_H
RETRY_FUNCTION_UNTIL_TIMEOUT
#define RETRY_FUNCTION_UNTIL_TIMEOUT(func, result_type, result_var, condition, timeout, interval,...)
Retry a function until a condition is met or a timeout is reached.
Definition: Wippersnapper.h:108
WS_DEBUG_PRINT
#define WS_DEBUG_PRINT(...)
Prints debug output.
Definition: Wippersnapper.h:49
-
Wippersnapper_AIRLIFT::_rstPin
int _rstPin
Definition: Wippersnapper_AIRLIFT.h:291
-
Wippersnapper_AIRLIFT::_disconnect
void _disconnect()
Disconnects from the wireless network.
Definition: Wippersnapper_AIRLIFT.h:391
-
Wippersnapper_AIRLIFT::_fv
const char * _fv
Definition: Wippersnapper_AIRLIFT.h:288
-
Wippersnapper_AIRLIFT::setupMQTTClient
void setupMQTTClient(const char *clientID)
Initializes the MQTT client.
Definition: Wippersnapper_AIRLIFT.h:252
-
Wippersnapper_AIRLIFT::_ackPin
int _ackPin
Definition: Wippersnapper_AIRLIFT.h:290
-
Wippersnapper_AIRLIFT::set_airlift_pins
void set_airlift_pins(int ssPin, int ackPin, int rstPin, int gpio0Pin)
Configures ESP32 "AirLift" pins.
Definition: Wippersnapper_AIRLIFT.h:169
+
Wippersnapper_AIRLIFT::_rstPin
int _rstPin
Definition: Wippersnapper_AIRLIFT.h:298
+
Wippersnapper_AIRLIFT::_disconnect
void _disconnect()
Disconnects from the wireless network.
Definition: Wippersnapper_AIRLIFT.h:399
+
Wippersnapper_AIRLIFT::_fv
const char * _fv
Definition: Wippersnapper_AIRLIFT.h:295
+
Wippersnapper_AIRLIFT::setupMQTTClient
void setupMQTTClient(const char *clientID)
Initializes the MQTT client.
Definition: Wippersnapper_AIRLIFT.h:259
+
Wippersnapper_AIRLIFT::_ackPin
int _ackPin
Definition: Wippersnapper_AIRLIFT.h:297
+
Wippersnapper_AIRLIFT::set_airlift_pins
void set_airlift_pins(int ssPin, int ackPin, int rstPin, int gpio0Pin)
Configures ESP32 "AirLift" pins.
Definition: Wippersnapper_AIRLIFT.h:176
Wippersnapper_AIRLIFT
Class for using the AirLift Co-Processor network iface.
Definition: Wippersnapper_AIRLIFT.h:43
-
Wippersnapper_AIRLIFT::connectionType
const char * connectionType()
Returns the type of network connection used by Wippersnapper.
Definition: Wippersnapper_AIRLIFT.h:283
+
Wippersnapper_AIRLIFT::connectionType
const char * connectionType()
Returns the type of network connection used by Wippersnapper.
Definition: Wippersnapper_AIRLIFT.h:290
+
WS_DEBUG_PRINTHEX
#define WS_DEBUG_PRINTHEX(...)
Prints debug output.
Definition: Wippersnapper.h:55
SPIWIFI
#define SPIWIFI
Definition: Wippersnapper_AIRLIFT.h:35
-
Wippersnapper_AIRLIFT::set_wifi
void set_wifi(SPIClass *wifi)
Sets the WiFi client.
Definition: Wippersnapper_AIRLIFT.h:151
-
Wippersnapper_AIRLIFT::_pass
const char * _pass
Definition: Wippersnapper_AIRLIFT.h:287
-
Wippersnapper_AIRLIFT::_gpio0Pin
int _gpio0Pin
Definition: Wippersnapper_AIRLIFT.h:292
+
Wippersnapper_AIRLIFT::set_wifi
void set_wifi(SPIClass *wifi)
Sets the WiFi client.
Definition: Wippersnapper_AIRLIFT.h:158
+
Wippersnapper_AIRLIFT::_pass
const char * _pass
Definition: Wippersnapper_AIRLIFT.h:294
+
Wippersnapper_AIRLIFT::_gpio0Pin
int _gpio0Pin
Definition: Wippersnapper_AIRLIFT.h:299
Wippersnapper_AIRLIFT::Wippersnapper_AIRLIFT
Wippersnapper_AIRLIFT()
Initializes the Adafruit IO class for AirLift devices.
Definition: Wippersnapper_AIRLIFT.h:51
-
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:400
+
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:406
AIRLIFT_CONNECT_RETRY_DELAY_MS
#define AIRLIFT_CONNECT_RETRY_DELAY_MS
Definition: Wippersnapper_AIRLIFT.h:33
-
Wippersnapper_AIRLIFT::_ssid
const char * _ssid
Definition: Wippersnapper_AIRLIFT.h:286
-
Wippersnapper_AIRLIFT::_connect
void _connect()
Establishes a connection with the wireless network.
Definition: Wippersnapper_AIRLIFT.h:301
+
WL_MAC_ADDR_LENGTH
#define WL_MAC_ADDR_LENGTH
MAC address length - from RP2040 BSP.
Definition: Wippersnapper_Networking.h:20
+
Wippersnapper_AIRLIFT::_ssid
const char * _ssid
Definition: Wippersnapper_AIRLIFT.h:293
+
Wippersnapper_AIRLIFT::_connect
void _connect()
Establishes a connection with the wireless network.
Definition: Wippersnapper_AIRLIFT.h:308
Wippersnapper_AIRLIFT::set_ssid_pass
void set_ssid_pass()
Sets the WiFi client&#39;s ssid and password from the secrets.json provisioning file. ...
Definition: Wippersnapper_AIRLIFT.h:99
ws_status_t
ws_status_t
Definition: Wippersnapper.h:190
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
-
Wippersnapper_AIRLIFT::_ssPin
int _ssPin
Definition: Wippersnapper_AIRLIFT.h:289
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
+
Wippersnapper_AIRLIFT::_ssPin
int _ssPin
Definition: Wippersnapper_AIRLIFT.h:296
NINAFWVER
#define NINAFWVER
Definition: Wippersnapper_AIRLIFT.h:30
Wippersnapper.h
Wippersnapper_AIRLIFT::~Wippersnapper_AIRLIFT
~Wippersnapper_AIRLIFT()
Destructor for the Adafruit IO AirLift class.
Definition: Wippersnapper_AIRLIFT.h:74
WS
Wippersnapper WS
Definition: Wippersnapper.cpp:36
WS_PRINTER
#define WS_PRINTER
Where debug messages will be printed.
Definition: Wippersnapper.h:45
AIRLIFT_CONNECT_TIMEOUT_MS
#define AIRLIFT_CONNECT_TIMEOUT_MS
Definition: Wippersnapper_AIRLIFT.h:32
-
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2589
-
Wippersnapper_AIRLIFT::_wifi
SPIClass * _wifi
Definition: Wippersnapper_AIRLIFT.h:294
+
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2608
+
Wippersnapper_AIRLIFT::_wifi
SPIClass * _wifi
Definition: Wippersnapper_AIRLIFT.h:301
Wippersnapper_AIRLIFT::set_ssid_pass
void set_ssid_pass(const char *ssid, const char *ssidPassword)
Sets the WiFi client&#39;s ssid and password.
Definition: Wippersnapper_AIRLIFT.h:88
WS_DEBUG_PRINTLN
#define WS_DEBUG_PRINTLN(...)
Prints line from debug output.
Definition: Wippersnapper.h:52
-
Wippersnapper_AIRLIFT::resetAirLift
void resetAirLift()
Resets the ESP32 module.
Definition: Wippersnapper_AIRLIFT.h:362
+
Wippersnapper_AIRLIFT::resetAirLift
void resetAirLift()
Resets the ESP32 module.
Definition: Wippersnapper_AIRLIFT.h:370
WS_DELAY_WITH_WDT
#define WS_DELAY_WITH_WDT(timeout)
Delay function.
Definition: Wippersnapper.h:65
-
Wippersnapper_AIRLIFT::networkStatus
ws_status_t networkStatus()
Returns the network status of an ESP32 module.
Definition: Wippersnapper_AIRLIFT.h:264
+
Wippersnapper_AIRLIFT::networkStatus
ws_status_t networkStatus()
Returns the network status of an ESP32 module.
Definition: Wippersnapper_AIRLIFT.h:271
Wippersnapper_AIRLIFT::check_valid_ssid
bool check_valid_ssid()
Performs a scan of local WiFi networks.
Definition: Wippersnapper_AIRLIFT.h:110
-
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:470
-
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:395
-
Wippersnapper_AIRLIFT::compareVersions
bool compareVersions(const char *currentVersion, const char *requiredVersion)
Compares two version strings.
Definition: Wippersnapper_AIRLIFT.h:200
-
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:398
-
Wippersnapper_AIRLIFT::getRSSI
int32_t getRSSI()
Gets the current network RSSI value.
Definition: Wippersnapper_AIRLIFT.h:243
-
Wippersnapper_AIRLIFT::firmwareCheck
bool firmwareCheck()
Checks the version of an ESP32 module running nina-fw.
Definition: Wippersnapper_AIRLIFT.h:184
-
Wippersnapper_AIRLIFT::getMacAddr
void getMacAddr()
Gets the ESP32&#39;s unique client identifier.
Definition: Wippersnapper_AIRLIFT.h:231
-
Wippersnapper_AIRLIFT::_mqtt_client
WiFiSSLClient * _mqtt_client
Definition: Wippersnapper_AIRLIFT.h:293
+
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:476
+
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:401
+
Wippersnapper_AIRLIFT::compareVersions
bool compareVersions(const char *currentVersion, const char *requiredVersion)
Compares two version strings.
Definition: Wippersnapper_AIRLIFT.h:207
+
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:404
+
Wippersnapper_AIRLIFT::getRSSI
int32_t getRSSI()
Gets the current network RSSI value.
Definition: Wippersnapper_AIRLIFT.h:250
+
Wippersnapper_AIRLIFT::firmwareCheck
bool firmwareCheck()
Checks the version of an ESP32 module running nina-fw.
Definition: Wippersnapper_AIRLIFT.h:191
+
Wippersnapper_AIRLIFT::getMacAddr
void getMacAddr()
Gets the ESP32&#39;s unique client identifier.
Definition: Wippersnapper_AIRLIFT.h:238
+
Wippersnapper_AIRLIFT::_mqtt_client
WiFiSSLClient * _mqtt_client
Definition: Wippersnapper_AIRLIFT.h:300
diff --git a/html/_wippersnapper___analog_i_o_8cpp.html b/html/_wippersnapper___analog_i_o_8cpp.html index cd93f25c6..4c728ee93 100644 --- a/html/_wippersnapper___analog_i_o_8cpp.html +++ b/html/_wippersnapper___analog_i_o_8cpp.html @@ -62,17 +62,78 @@
+
+Functions
Wippersnapper_AnalogIO.cpp File Reference
#include "Wippersnapper_AnalogIO.h"
-

Detailed Description

+
+ + + + +

+Functions

void calculateHysteresis (analogInputPin pin, uint16_t pinValRaw, uint16_t &pinValThreshHi, uint16_t &pinValThreshLow)
 Calculates the hysteresis for the pin value. More...
 
+

Detailed Description

This file provides an API for interacting with a board's analog IO pins.

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

Copyright (c) Brent Rubell 2020-2023 for Adafruit Industries.

BSD license, all text here must be included in any redistribution.

-
+

Function Documentation

+ +

◆ calculateHysteresis()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void calculateHysteresis (analogInputPin pin,
uint16_t pinValRaw,
uint16_t & pinValThreshHi,
uint16_t & pinValThreshLow 
)
+
+ +

Calculates the hysteresis for the pin value.

+
Parameters
+ + + + + +
pinThe desired analog pin to calculate hysteresis for.
pinValRawThe pin's raw value.
pinValThreshHiThe pin's high threshold value.
pinValThreshLowThe pin's low threshold value.
+
+
+ +
+
+
Generated by   diff --git a/html/_wippersnapper___analog_i_o_8h_source.html b/html/_wippersnapper___analog_i_o_8h_source.html index 5a76f9c28..7aaddff70 100644 --- a/html/_wippersnapper___analog_i_o_8h_source.html +++ b/html/_wippersnapper___analog_i_o_8h_source.html @@ -66,8 +66,8 @@
Wippersnapper_AnalogIO.h
-Go to the documentation of this file.
1 
16 #ifndef WIPPERSNAPPER_ANALOGIO_H
17 #define WIPPERSNAPPER_ANALOGIO_H
18 
19 #include "Wippersnapper.h"
20 
21 #define DEFAULT_HYSTERISIS 0.02
22 
23 
24 struct analogInputPin {
25  int pinName;
26  bool enabled;
27  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode
28  readMode;
29  long period;
30  long prvPeriod;
31  float prvPinVal;
32 };
33 
34 // forward decl.
35 class Wippersnapper;
36 
37 /**************************************************************************/
42 /**************************************************************************/
43 class Wippersnapper_AnalogIO {
44 public:
45  Wippersnapper_AnalogIO(int32_t totalAnalogInputPins, float aRef);
46  ~Wippersnapper_AnalogIO();
47 
48  void setAref(float refVoltage);
49  float getAref();
50 
51  void initAnalogInputPin(
52  int pin, float period,
53  wippersnapper_pin_v1_ConfigurePinRequest_Pull pullMode,
54  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode analogReadMode);
55  void
56  deinitAnalogPin(wippersnapper_pin_v1_ConfigurePinRequest_Direction direction,
57  int pin);
58  void disableAnalogInPin(int pin);
59 
60  uint16_t getPinValue(int pin);
61  float getPinValueVolts(int pin);
62 
63  void setADCResolution(int resolution);
64  int getADCresolution();
65  int getNativeResolution();
66  bool timerExpired(long currentTime, analogInputPin pin);
67 
68  void update();
69  bool encodePinEvent(
70  uint8_t pinName,
71  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode readMode,
72  uint16_t pinValRaw = 0, float pinValVolts = 0.0);
73 
74 private:
75  float _aRef;
76  int _adcResolution;
77  int _nativeResolution;
78  bool scaleAnalogRead = false;
80  int32_t _totalAnalogInputPins;
81  analogInputPin *_analog_input_pins;
82 };
83 extern Wippersnapper WS;
85 #endif // WIPPERSNAPPER_DIGITALGPIO_H
Wippersnapper_AnalogIO
Class that provides an interface for reading and controlling analog pins. Stores information about an...
Definition: Wippersnapper_AnalogIO.h:43
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+Go to the documentation of this file.
1 
16 #ifndef WIPPERSNAPPER_ANALOGIO_H
17 #define WIPPERSNAPPER_ANALOGIO_H
18 
19 #include "Wippersnapper.h"
20 
21 #define DEFAULT_HYSTERISIS 0.02
22 
23 
24 struct analogInputPin {
25  int pinName;
26  bool enabled;
27  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode
28  readMode;
29  long period;
30  long prvPeriod;
31  float prvPinVal;
32 };
33 
34 // forward decl.
35 class Wippersnapper;
36 
37 /**************************************************************************/
42 /**************************************************************************/
43 class Wippersnapper_AnalogIO {
44 public:
45  Wippersnapper_AnalogIO(int32_t totalAnalogInputPins, float aRef);
46  ~Wippersnapper_AnalogIO();
47 
48  void setAref(float refVoltage);
49  float getAref();
50 
51  void initAnalogInputPin(
52  int pin, float period,
53  wippersnapper_pin_v1_ConfigurePinRequest_Pull pullMode,
54  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode analogReadMode);
55  void
56  deinitAnalogPin(wippersnapper_pin_v1_ConfigurePinRequest_Direction direction,
57  int pin);
58  void disableAnalogInPin(int pin);
59 
60  uint16_t getPinValue(int pin);
61  float getPinValueVolts(int pin);
62 
63  void setADCResolution(int resolution);
64  int getADCresolution();
65  int getNativeResolution();
66  bool timerExpired(long currentTime, analogInputPin pin,
67  long periodOffset = 0);
68 
69  void update();
70  bool encodePinEvent(
71  uint8_t pinName,
72  wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode readMode,
73  uint16_t pinValRaw = 0, float pinValVolts = 0.0);
74 
75 private:
76  float _aRef;
77  int _adcResolution;
78  int _nativeResolution;
79  bool scaleAnalogRead = false;
81  int32_t _totalAnalogInputPins;
82  analogInputPin *_analog_input_pins;
83 };
84 extern Wippersnapper WS;
86 #endif // WIPPERSNAPPER_DIGITALGPIO_H
Wippersnapper_AnalogIO
Class that provides an interface for reading and controlling analog pins. Stores information about an...
Definition: Wippersnapper_AnalogIO.h:43
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
Wippersnapper.h
analogInputPin::pinName
int pinName
Pin name.
Definition: Wippersnapper_AnalogIO.h:25
analogInputPin::enabled
bool enabled
Pin is enabled for sampling.
Definition: Wippersnapper_AnalogIO.h:26
diff --git a/html/_wippersnapper___boards_8h_source.html b/html/_wippersnapper___boards_8h_source.html index 125288ff3..46a5371a0 100644 --- a/html/_wippersnapper___boards_8h_source.html +++ b/html/_wippersnapper___boards_8h_source.html @@ -66,7 +66,7 @@
Wippersnapper_Boards.h
-Go to the documentation of this file.
1 
16 #ifndef ADAFRUIT_WIPPERSNAPPER_BOARDS_H
17 #define ADAFRUIT_WIPPERSNAPPER_BOARDS_H
18 
19 #if defined(ADAFRUIT_PYPORTAL)
20 #define BOARD_ID "pyportal-tinyusb"
21 #define USE_TINYUSB
22 #define USE_STATUS_NEOPIXEL
23 #define STATUS_NEOPIXEL_PIN 2
24 #define STATUS_NEOPIXEL_NUM 1
25 #elif defined(ADAFRUIT_PYPORTAL_M4_TITANO)
26 #define BOARD_ID "pyportal-titano-tinyusb"
27 #define USE_TINYUSB
28 #define USE_STATUS_NEOPIXEL
29 #define STATUS_NEOPIXEL_PIN 2
30 #define STATUS_NEOPIXEL_NUM 1
31 #elif defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE)
32 #define BOARD_ID "metro-m4-airliftlite-tinyusb"
33 #define USE_TINYUSB
34 #define USE_STATUS_NEOPIXEL
35 #define STATUS_NEOPIXEL_PIN 40
36 #define STATUS_NEOPIXEL_NUM 1
37 #elif defined(ARDUINO_FUNHOUSE_ESP32S2)
38 #define BOARD_ID "funhouse"
39 #define USE_TINYUSB
40 #define USE_STATUS_DOTSTAR
41 #define USE_DISPLAY
42 #define STATUS_DOTSTAR_PIN_DATA PIN_DOTSTAR_DATA
43 #define STATUS_DOTSTAR_PIN_CLK PIN_DOTSTAR_CLOCK
44 #define STATUS_DOTSTAR_NUM 5
45 #define STATUS_DOTSTAR_COLOR_ORDER DOTSTAR_GBR
46 #define USE_PSRAM
47 #elif defined(ARDUINO_METRO_ESP32S2)
48 #define BOARD_ID "metroesp32s2"
49 #define USE_TINYUSB
50 #define USE_STATUS_NEOPIXEL
51 #define STATUS_NEOPIXEL_PIN 45
52 #define STATUS_NEOPIXEL_NUM 1
53 #define USE_PSRAM
54 #elif defined(ARDUINO_METRO_ESP32S3)
55 #define BOARD_ID "metroesp32s3"
56 #define USE_TINYUSB
57 #define USE_STATUS_NEOPIXEL
58 #define STATUS_NEOPIXEL_PIN 46
59 #define STATUS_NEOPIXEL_NUM 1
60 #define USE_PSRAM
61 #elif defined(ARDUINO_MAGTAG29_ESP32S2)
62 #define BOARD_ID "magtag"
63 #define USE_TINYUSB
64 #define USE_STATUS_NEOPIXEL
65 #define STATUS_NEOPIXEL_PIN 1
66 #define STATUS_NEOPIXEL_NUM 4
67 #define USE_PSRAM
68 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2)
69 #define BOARD_ID "feather-esp32s2"
70 #define USE_TINYUSB
71 #define USE_STATUS_NEOPIXEL
72 #define STATUS_NEOPIXEL_PIN 33
73 #define STATUS_NEOPIXEL_NUM 1
74 #define USE_PSRAM
75 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_TFT)
76 #define BOARD_ID "feather-esp32s2-tft"
77 #define USE_TINYUSB
78 #define USE_STATUS_NEOPIXEL
79 #define STATUS_NEOPIXEL_PIN 33
80 #define STATUS_NEOPIXEL_NUM 1
81 #define PIN_I2C_POWER_INVERTED 7
82 #define USE_PSRAM
83 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_REVTFT)
84 #define BOARD_ID "feather-esp32s2-reverse-tft"
85 #define USE_TINYUSB
86 #define USE_STATUS_NEOPIXEL
87 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
88 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
89 #define USE_PSRAM
90 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_NOPSRAM)
91 #define BOARD_ID "feather-esp32s3"
92 #define USE_TINYUSB
93 #define USE_STATUS_NEOPIXEL
94 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
95 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
96 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3)
97 #define BOARD_ID "feather-esp32s3-4mbflash-2mbpsram"
98 #define USE_TINYUSB
99 #define USE_STATUS_NEOPIXEL
100 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
101 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
102 #define USE_PSRAM
103 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_TFT)
104 #define BOARD_ID "feather-esp32s3-tft"
105 #define USE_TINYUSB
106 #define USE_STATUS_NEOPIXEL
107 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
108 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
109 #define USE_PSRAM
110 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_REVTFT)
111 #define BOARD_ID "feather-esp32s3-reverse-tft"
112 #define USE_TINYUSB
113 #define USE_STATUS_NEOPIXEL
114 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
115 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
116 #define USE_PSRAM
117 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S2)
118 #define BOARD_ID "qtpy-esp32s2"
119 #define USE_TINYUSB
120 #define USE_STATUS_NEOPIXEL
121 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
122 #define STATUS_NEOPIXEL_NUM 1
123 #define USE_PSRAM
124 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_NOPSRAM)
125 #define BOARD_ID "qtpy-esp32s3"
126 #define USE_TINYUSB
127 #define USE_STATUS_NEOPIXEL
128 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
129 #define STATUS_NEOPIXEL_NUM 1
130 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_N4R2)
131 #define BOARD_ID "qtpy-esp32s3-n4r2"
132 #define USE_TINYUSB
133 #define USE_STATUS_NEOPIXEL
134 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
135 #define STATUS_NEOPIXEL_NUM 1
136 #define USE_PSRAM
137 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32C3)
138 #define BOARD_ID "qtpy-esp32c3"
139 #define USE_LITTLEFS
140 #define USE_STATUS_NEOPIXEL
141 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
142 #define STATUS_NEOPIXEL_NUM 1
143 #elif defined(ARDUINO_ESP8266_ADAFRUIT_HUZZAH)
144 #define BOARD_ID "feather-esp8266"
145 #define USE_LITTLEFS
146 #define USE_STATUS_LED
147 #define STATUS_LED_PIN 0
148 #elif defined(ARDUINO_ADAFRUIT_ITSYBITSY_ESP32)
149 #define BOARD_ID "itsybitsy-esp32"
150 #define USE_LITTLEFS
151 #define USE_STATUS_NEOPIXEL
152 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
153 #define STATUS_NEOPIXEL_NUM 1
154 #define USE_PSRAM
155 #elif defined(ARDUINO_FEATHER_ESP32)
156 #define BOARD_ID "feather-esp32"
157 #define USE_LITTLEFS
158 #define USE_STATUS_LED
159 #define STATUS_LED_PIN 13
160 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32C6)
161 #define BOARD_ID "feather-esp32c6"
162 #define USE_LITTLEFS
163 #define USE_STATUS_NEOPIXEL
164 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
165 #define STATUS_NEOPIXEL_NUM 1
166 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32_V2)
167 #define BOARD_ID "feather-esp32-v2"
168 #define USE_LITTLEFS
169 #define USE_STATUS_NEOPIXEL
170 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
171 #define STATUS_NEOPIXEL_NUM 1
172 #define USE_PSRAM
173 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32_PICO)
174 #define BOARD_ID "qtpy-esp32"
175 #define USE_LITTLEFS
176 #define USE_STATUS_NEOPIXEL
177 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
178 #define STATUS_NEOPIXEL_NUM 1
179 #define USE_PSRAM
180 #elif defined(ARDUINO_SAMD_NANO_33_IOT)
181 #define BOARD_ID "nano-33-iot"
182 #define USE_STATUS_LED
183 #define STATUS_LED_PIN 13
184 #elif defined(ARDUINO_SAMD_MKRWIFI1010)
185 #define BOARD_ID "mkrwifi1010"
186 #define USE_STATUS_LED
187 #define STATUS_LED_PIN 6
188 #elif defined(ARDUINO_RASPBERRY_PI_PICO_W)
189 #define BOARD_ID "rpi-pico-w"
190 #define USE_TINYUSB
191 #define USE_STATUS_LED
192 #define STATUS_LED_PIN 32
193 #else
194 #warning "Board type not identified within Wippersnapper_Boards.h!"
195 #endif
196 
197 #endif // ADAFRUIT_WIPPERSNAPPER_BOARDS_H
+Go to the documentation of this file.
1 
16 #ifndef ADAFRUIT_WIPPERSNAPPER_BOARDS_H
17 #define ADAFRUIT_WIPPERSNAPPER_BOARDS_H
18 
19 #if defined(ADAFRUIT_PYPORTAL)
20 #define BOARD_ID "pyportal-tinyusb"
21 #define USE_TINYUSB
22 #define USE_STATUS_NEOPIXEL
23 #define STATUS_NEOPIXEL_PIN 2
24 #define STATUS_NEOPIXEL_NUM 1
25 #elif defined(ADAFRUIT_PYPORTAL_M4_TITANO)
26 #define BOARD_ID "pyportal-titano-tinyusb"
27 #define USE_TINYUSB
28 #define USE_STATUS_NEOPIXEL
29 #define STATUS_NEOPIXEL_PIN 2
30 #define STATUS_NEOPIXEL_NUM 1
31 #elif defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE)
32 #define BOARD_ID "metro-m4-airliftlite-tinyusb"
33 #define USE_TINYUSB
34 #define USE_STATUS_NEOPIXEL
35 #define STATUS_NEOPIXEL_PIN 40
36 #define STATUS_NEOPIXEL_NUM 1
37 #elif defined(ARDUINO_FUNHOUSE_ESP32S2)
38 #define BOARD_ID "funhouse"
39 #define USE_TINYUSB
40 #define USE_STATUS_DOTSTAR
41 #define USE_DISPLAY
42 #define STATUS_DOTSTAR_PIN_DATA PIN_DOTSTAR_DATA
43 #define STATUS_DOTSTAR_PIN_CLK PIN_DOTSTAR_CLOCK
44 #define STATUS_DOTSTAR_NUM 5
45 #define STATUS_DOTSTAR_COLOR_ORDER DOTSTAR_GBR
46 #define USE_PSRAM
47 #elif defined(ARDUINO_METRO_ESP32S2)
48 #define BOARD_ID "metroesp32s2"
49 #define USE_TINYUSB
50 #define USE_STATUS_NEOPIXEL
51 #define STATUS_NEOPIXEL_PIN 45
52 #define STATUS_NEOPIXEL_NUM 1
53 #define USE_PSRAM
54 #elif defined(ARDUINO_METRO_ESP32S3)
55 #define BOARD_ID "metroesp32s3"
56 #define USE_TINYUSB
57 #define USE_STATUS_NEOPIXEL
58 #define STATUS_NEOPIXEL_PIN 46
59 #define STATUS_NEOPIXEL_NUM 1
60 #define USE_PSRAM
61 #elif defined(ARDUINO_MAGTAG29_ESP32S2)
62 #define BOARD_ID "magtag"
63 #define USE_TINYUSB
64 #define USE_STATUS_NEOPIXEL
65 #define STATUS_NEOPIXEL_PIN 1
66 #define STATUS_NEOPIXEL_NUM 4
67 #define USE_PSRAM
68 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2)
69 #define BOARD_ID "feather-esp32s2"
70 #define USE_TINYUSB
71 #define USE_STATUS_NEOPIXEL
72 #define STATUS_NEOPIXEL_PIN 33
73 #define STATUS_NEOPIXEL_NUM 1
74 #define USE_PSRAM
75 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_TFT)
76 #define BOARD_ID "feather-esp32s2-tft"
77 #define USE_TINYUSB
78 #define USE_STATUS_NEOPIXEL
79 #define STATUS_NEOPIXEL_PIN 33
80 #define STATUS_NEOPIXEL_NUM 1
81 #define PIN_I2C_POWER_INVERTED 7
82 #define USE_PSRAM
83 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S2_REVTFT)
84 #define BOARD_ID "feather-esp32s2-reverse-tft"
85 #define USE_TINYUSB
86 #define USE_STATUS_NEOPIXEL
87 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
88 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
89 #define USE_PSRAM
90 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_NOPSRAM)
91 #define BOARD_ID "feather-esp32s3"
92 #define USE_TINYUSB
93 #define USE_STATUS_NEOPIXEL
94 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
95 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
96 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3)
97 #define BOARD_ID "feather-esp32s3-4mbflash-2mbpsram"
98 #define USE_TINYUSB
99 #define USE_STATUS_NEOPIXEL
100 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
101 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
102 #define USE_PSRAM
103 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_TFT)
104 #define BOARD_ID "feather-esp32s3-tft"
105 #define USE_TINYUSB
106 #define USE_STATUS_NEOPIXEL
107 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
108 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
109 #define USE_PSRAM
110 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32S3_REVTFT)
111 #define BOARD_ID "feather-esp32s3-reverse-tft"
112 #define USE_TINYUSB
113 #define USE_STATUS_NEOPIXEL
114 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
115 #define STATUS_NEOPIXEL_NUM NEOPIXEL_NUM
116 #define USE_PSRAM
117 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S2)
118 #define BOARD_ID "qtpy-esp32s2"
119 #define USE_TINYUSB
120 #define USE_STATUS_NEOPIXEL
121 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
122 #define STATUS_NEOPIXEL_NUM 1
123 #define USE_PSRAM
124 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_NOPSRAM)
125 #define BOARD_ID "qtpy-esp32s3"
126 #define USE_TINYUSB
127 #define USE_STATUS_NEOPIXEL
128 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
129 #define STATUS_NEOPIXEL_NUM 1
130 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32S3_N4R2)
131 #define BOARD_ID "qtpy-esp32s3-n4r2"
132 #define USE_TINYUSB
133 #define USE_STATUS_NEOPIXEL
134 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
135 #define STATUS_NEOPIXEL_NUM 1
136 #define USE_PSRAM
137 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32C3)
138 #define BOARD_ID "qtpy-esp32c3"
139 #define USE_LITTLEFS
140 #define USE_STATUS_NEOPIXEL
141 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
142 #define STATUS_NEOPIXEL_NUM 1
143 #elif defined(ARDUINO_ESP8266_ADAFRUIT_HUZZAH)
144 #define BOARD_ID "feather-esp8266"
145 #define USE_LITTLEFS
146 #define USE_STATUS_LED
147 #define STATUS_LED_PIN 0
148 #elif defined(ARDUINO_ADAFRUIT_ITSYBITSY_ESP32)
149 #define BOARD_ID "itsybitsy-esp32"
150 #define USE_LITTLEFS
151 #define USE_STATUS_NEOPIXEL
152 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
153 #define STATUS_NEOPIXEL_NUM 1
154 #define USE_PSRAM
155 #elif defined(ARDUINO_FEATHER_ESP32)
156 #define BOARD_ID "feather-esp32"
157 #define USE_LITTLEFS
158 #define USE_STATUS_LED
159 #define STATUS_LED_PIN 13
160 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32C6)
161 #define BOARD_ID "feather-esp32c6"
162 #define USE_LITTLEFS
163 #define USE_STATUS_NEOPIXEL
164 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
165 #define STATUS_NEOPIXEL_NUM 1
166 #elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32_V2)
167 #define BOARD_ID "feather-esp32-v2"
168 #define USE_LITTLEFS
169 #define USE_STATUS_NEOPIXEL
170 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
171 #define STATUS_NEOPIXEL_NUM 1
172 #define USE_PSRAM
173 #elif defined(ARDUINO_ADAFRUIT_QTPY_ESP32_PICO)
174 #define BOARD_ID "qtpy-esp32"
175 #define USE_LITTLEFS
176 #define USE_STATUS_NEOPIXEL
177 #define STATUS_NEOPIXEL_PIN PIN_NEOPIXEL
178 #define STATUS_NEOPIXEL_NUM 1
179 #define USE_PSRAM
180 #elif defined(ARDUINO_RASPBERRY_PI_PICO_W)
181 #define BOARD_ID "rpi-pico-w"
182 #define USE_TINYUSB
183 #define USE_STATUS_LED
184 #define STATUS_LED_PIN LED_BUILTIN
185 #elif defined(ARDUINO_RASPBERRY_PI_PICO_2W)
186 #define BOARD_ID "rpi-pico-2w"
187 #define USE_TINYUSB
188 #define USE_STATUS_LED
189 #define STATUS_LED_PIN LED_BUILTIN
190 #else
191 #warning "Board type not identified within Wippersnapper_Boards.h!"
192 #endif
193 
194 #endif // ADAFRUIT_WIPPERSNAPPER_BOARDS_H
Generated by   diff --git a/html/_wippersnapper___digital_g_p_i_o_8h_source.html b/html/_wippersnapper___digital_g_p_i_o_8h_source.html index 29ecd8d69..3e71c6ac0 100644 --- a/html/_wippersnapper___digital_g_p_i_o_8h_source.html +++ b/html/_wippersnapper___digital_g_p_i_o_8h_source.html @@ -70,7 +70,7 @@
Wippersnapper_DigitalGPIO
Class that provides functions for reading and interacting with digital inputs and outputs...
Definition: Wippersnapper_DigitalGPIO.h:38
digitalInputPin::pinName
uint8_t pinName
Pin name.
Definition: Wippersnapper_DigitalGPIO.h:23
Wippersnapper_DigitalGPIO::_digital_input_pins
digitalInputPin * _digital_input_pins
Definition: Wippersnapper_DigitalGPIO.h:55
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
Wippersnapper.h
digitalInputPin::period
long period
Timer interval, in millis, -1 if disabled.
Definition: Wippersnapper_DigitalGPIO.h:24
digitalInputPin
Definition: Wippersnapper_DigitalGPIO.h:22
diff --git a/html/_wippersnapper___e_s_p32_8h_source.html b/html/_wippersnapper___e_s_p32_8h_source.html index ffab067c6..f1323315b 100644 --- a/html/_wippersnapper___e_s_p32_8h_source.html +++ b/html/_wippersnapper___e_s_p32_8h_source.html @@ -66,39 +66,41 @@
Wippersnapper_ESP32.h
-Go to the documentation of this file.
1 
17 #ifndef Wippersnapper_ESP32_H
18 #define Wippersnapper_ESP32_H
19 
20 #ifdef ARDUINO_ARCH_ESP32
21 #include "Wippersnapper.h"
22 
23 #include "Adafruit_MQTT.h"
24 #include "Adafruit_MQTT_Client.h"
25 #include "Arduino.h"
26 #include "WiFi.h"
27 #include "WiFiMulti.h"
28 #include <NetworkClient.h>
29 #include <NetworkClientSecure.h>
30 extern Wippersnapper WS;
31 
32 /****************************************************************************/
36 /****************************************************************************/
37 class Wippersnapper_ESP32 : public Wippersnapper {
38 
39 public:
40  /**************************************************************************/
44  /**************************************************************************/
45  Wippersnapper_ESP32() : Wippersnapper() {
46  _ssid = 0;
47  _pass = 0;
48  }
49 
50  /**************************************************************************/
54  /**************************************************************************/
55  ~Wippersnapper_ESP32() {
56  if (_mqtt_client_secure)
57  delete _mqtt_client_secure;
58  if (_mqtt_client_insecure)
59  delete _mqtt_client_insecure;
60  }
61 
62  /********************************************************/
70  /********************************************************/
71  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
72  _ssid = ssid;
73 
74  // set the AP password
75  // check if ssidPassword was "" in secrets.json
76  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
77  _pass = NULL; // Set as NULL for open networks
78  } else {
79  _pass = ssidPassword;
80  }
81  }
82 
83  /**********************************************************/
87  /**********************************************************/
88  void set_ssid_pass() {
89  _ssid = WS._config.network.ssid;
90  _pass = WS._config.network.pass;
91  }
92 
93  /***********************************************************/
98  /***********************************************************/
99  bool check_valid_ssid() {
100  // Set WiFi to station mode and disconnect from an AP if it was previously
101  // connected
102  WiFi.mode(WIFI_STA);
103  WiFi.disconnect();
104  delay(100);
105 
106 // For boards with a "3D Antenna", we need to reduce the TX power
107 // to prevent flaky operation.
108 // NOTE: This is a known issue with the QT Py series of boards.
109 #ifdef ARDUINO_ADAFRUIT_QTPY_ESP32S2 || \
110  ARDUINO_ADAFRUIT_QTPY_ESP32S3_NOPSRAM || \
111  ARDUINO_ADAFRUIT_QTPY_ESP32S3_N4R2 || ARDUINO_ADAFRUIT_QTPY_ESP32C3 || \
112  ARDUINO_ADAFRUIT_QTPY_ESP32_PICO
113  WiFi.setTxPower(WIFI_POWER_15dBm);
114 #endif
115 
116  // Perform a network scan
117  int n = WiFi.scanNetworks();
118  if (n == 0) {
119  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
120  return false;
121  }
122 
123  // Was the network within secrets.json found?
124  for (int i = 0; i < n; ++i) {
125  if (strcmp(_ssid, WiFi.SSID(i).c_str()) == 0) {
126  WS_DEBUG_PRINT("SSID (");
127  WS_DEBUG_PRINT(_ssid);
128  WS_DEBUG_PRINT(") found! RSSI: ");
129  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
130  return true;
131  }
132  if (WS._isWiFiMulti) {
133  // multi network mode
134  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
135  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i).c_str()) == 0) {
136  WS_DEBUG_PRINT("SSID (");
137  WS_DEBUG_PRINT(WS._multiNetworks[j].ssid);
138  WS_DEBUG_PRINT(") found! RSSI: ");
139  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
140  return true;
141  }
142  }
143  }
144  }
145 
146  // User-set network not found, print scan results to serial console
147  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
148  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks: ");
149  for (int i = 0; i < n; ++i) {
150  WS_DEBUG_PRINT(WiFi.SSID(i));
151  WS_DEBUG_PRINT(" ");
152  WS_DEBUG_PRINT(WiFi.RSSI(i));
153  WS_DEBUG_PRINTLN("dB");
154  }
155 
156  return false;
157  }
158 
159  /********************************************************/
164  /********************************************************/
165  void getMacAddr() {
166  uint8_t mac[6] = {0};
167  Network.macAddress(mac);
168  memcpy(WS._macAddr, mac, sizeof(mac));
169  }
170 
171  /********************************************************/
176  /********************************************************/
177  int32_t getRSSI() { return WiFi.RSSI(); }
178 
179  /********************************************************/
185  /********************************************************/
186  void setupMQTTClient(const char *clientID) {
187  if (strcmp(WS._config.aio_url, "io.adafruit.com") == 0 ||
188  strcmp(WS._config.aio_url, "io.adafruit.us") == 0) {
189  _mqtt_client_secure = new NetworkClientSecure();
190  _mqtt_client_secure->setCACert(
191  strcmp(WS._config.aio_url, "io.adafruit.com") == 0
192  ? _aio_root_ca_prod
193  : _aio_root_ca_staging);
194  WS._mqtt = new Adafruit_MQTT_Client(
195  _mqtt_client_secure, WS._config.aio_url, WS._config.io_port, clientID,
196  WS._config.aio_user, WS._config.aio_key);
197  } else {
198  // Insecure connections require a NetworkClient object rather than a
199  // NetworkClientSecure object
200  _mqtt_client_insecure = new NetworkClient();
201  WS._mqtt = new Adafruit_MQTT_Client(
202  _mqtt_client_insecure, WS._config.aio_url, WS._config.io_port,
203  clientID, WS._config.aio_user, WS._config.aio_key);
204  }
205  }
206 
207  /********************************************************/
212  /********************************************************/
213  ws_status_t networkStatus() {
214  switch (WiFi.status()) {
215  case WL_CONNECTED:
216  return WS_NET_CONNECTED;
217  case WL_CONNECT_FAILED:
218  return WS_NET_CONNECT_FAILED;
219  case WL_IDLE_STATUS:
220  return WS_IDLE;
221  default:
222  return WS_NET_DISCONNECTED;
223  }
224  }
225 
226  /*******************************************************************/
231  /*******************************************************************/
232  const char *connectionType() { return "ESP32"; }
233 
234 protected:
235  const char *_ssid;
236  const char *_pass;
237  NetworkClientSecure
238  *_mqtt_client_secure;
239  NetworkClient
240  *_mqtt_client_insecure;
241  WiFiMulti _wifiMulti;
242 
243  const char *_aio_root_ca_staging =
244  "-----BEGIN CERTIFICATE-----\n"
245  "MIIEVzCCAj+gAwIBAgIRAIOPbGPOsTmMYgZigxXJ/d4wDQYJKoZIhvcNAQELBQAw\n"
246  "TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
247  "cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMjQwMzEzMDAwMDAw\n"
248  "WhcNMjcwMzEyMjM1OTU5WjAyMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNTGV0J3Mg\n"
249  "RW5jcnlwdDELMAkGA1UEAxMCRTUwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQNCzqK\n"
250  "a2GOtu/cX1jnxkJFVKtj9mZhSAouWXW0gQI3ULc/FnncmOyhKJdyIBwsz9V8UiBO\n"
251  "VHhbhBRrwJCuhezAUUE8Wod/Bk3U/mDR+mwt4X2VEIiiCFQPmRpM5uoKrNijgfgw\n"
252  "gfUwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcD\n"
253  "ATASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBSfK1/PPCFPnQS37SssxMZw\n"
254  "i9LXDTAfBgNVHSMEGDAWgBR5tFnme7bl5AFzgAiIyBpY9umbbjAyBggrBgEFBQcB\n"
255  "AQQmMCQwIgYIKwYBBQUHMAKGFmh0dHA6Ly94MS5pLmxlbmNyLm9yZy8wEwYDVR0g\n"
256  "BAwwCjAIBgZngQwBAgEwJwYDVR0fBCAwHjAcoBqgGIYWaHR0cDovL3gxLmMubGVu\n"
257  "Y3Iub3JnLzANBgkqhkiG9w0BAQsFAAOCAgEAH3KdNEVCQdqk0LKyuNImTKdRJY1C\n"
258  "2uw2SJajuhqkyGPY8C+zzsufZ+mgnhnq1A2KVQOSykOEnUbx1cy637rBAihx97r+\n"
259  "bcwbZM6sTDIaEriR/PLk6LKs9Be0uoVxgOKDcpG9svD33J+G9Lcfv1K9luDmSTgG\n"
260  "6XNFIN5vfI5gs/lMPyojEMdIzK9blcl2/1vKxO8WGCcjvsQ1nJ/Pwt8LQZBfOFyV\n"
261  "XP8ubAp/au3dc4EKWG9MO5zcx1qT9+NXRGdVWxGvmBFRAajciMfXME1ZuGmk3/GO\n"
262  "koAM7ZkjZmleyokP1LGzmfJcUd9s7eeu1/9/eg5XlXd/55GtYjAM+C4DG5i7eaNq\n"
263  "cm2F+yxYIPt6cbbtYVNJCGfHWqHEQ4FYStUyFnv8sjyqU8ypgZaNJ9aVcWSICLOI\n"
264  "E1/Qv/7oKsnZCWJ926wU6RqG1OYPGOi1zuABhLw61cuPVDT28nQS/e6z95cJXq0e\n"
265  "K1BcaJ6fJZsmbjRgD5p3mvEf5vdQM7MCEvU0tHbsx2I5mHHJoABHb8KVBgWp/lcX\n"
266  "GWiWaeOyB7RP+OfDtvi2OsapxXiV7vNVs7fMlrRjY1joKaqmmycnBvAq14AEbtyL\n"
267  "sVfOS66B8apkeFX2NY4XPEYV4ZSCe8VHPrdrERk2wILG3T/EGmSIkCYVUMSnjmJd\n"
268  "VQD9F6Na/+zmXCc=\n"
269  "-----END CERTIFICATE-----\n";
270 
271  const char *_aio_root_ca_prod =
272  "-----BEGIN CERTIFICATE-----\n"
273  "MIIEjTCCA3WgAwIBAgIQDQd4KhM/xvmlcpbhMf/ReTANBgkqhkiG9w0BAQsFADBh\n"
274  "MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n"
275  "d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH\n"
276  "MjAeFw0xNzExMDIxMjIzMzdaFw0yNzExMDIxMjIzMzdaMGAxCzAJBgNVBAYTAlVT\n"
277  "MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n"
278  "b20xHzAdBgNVBAMTFkdlb1RydXN0IFRMUyBSU0EgQ0EgRzEwggEiMA0GCSqGSIb3\n"
279  "DQEBAQUAA4IBDwAwggEKAoIBAQC+F+jsvikKy/65LWEx/TMkCDIuWegh1Ngwvm4Q\n"
280  "yISgP7oU5d79eoySG3vOhC3w/3jEMuipoH1fBtp7m0tTpsYbAhch4XA7rfuD6whU\n"
281  "gajeErLVxoiWMPkC/DnUvbgi74BJmdBiuGHQSd7LwsuXpTEGG9fYXcbTVN5SATYq\n"
282  "DfbexbYxTMwVJWoVb6lrBEgM3gBBqiiAiy800xu1Nq07JdCIQkBsNpFtZbIZhsDS\n"
283  "fzlGWP4wEmBQ3O67c+ZXkFr2DcrXBEtHam80Gp2SNhou2U5U7UesDL/xgLK6/0d7\n"
284  "6TnEVMSUVJkZ8VeZr+IUIlvoLrtjLbqugb0T3OYXW+CQU0kBAgMBAAGjggFAMIIB\n"
285  "PDAdBgNVHQ4EFgQUlE/UXYvkpOKmgP792PkA76O+AlcwHwYDVR0jBBgwFoAUTiJU\n"
286  "IBiV5uNu5g/6+rkS7QYXjzkwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsG\n"
287  "AQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMDQGCCsGAQUFBwEB\n"
288  "BCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tMEIGA1Ud\n"
289  "HwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEds\n"
290  "b2JhbFJvb3RHMi5jcmwwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUHAgEW\n"
291  "HGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwDQYJKoZIhvcNAQELBQADggEB\n"
292  "AIIcBDqC6cWpyGUSXAjjAcYwsK4iiGF7KweG97i1RJz1kwZhRoo6orU1JtBYnjzB\n"
293  "c4+/sXmnHJk3mlPyL1xuIAt9sMeC7+vreRIF5wFBC0MCN5sbHwhNN1JzKbifNeP5\n"
294  "ozpZdQFmkCo+neBiKR6HqIA+LMTMCMMuv2khGGuPHmtDze4GmEGZtYLyF8EQpa5Y\n"
295  "jPuV6k2Cr/N3XxFpT3hRpt/3usU/Zb9wfKPtWpoznZ4/44c1p9rzFcZYrWkj3A+7\n"
296  "TNBJE0GmP2fhXhP1D/XVfIW/h0yCJGEiV9Glm/uGOa3DXHlmbAcxSyCRraG+ZBkA\n"
297  "7h4SeM6Y8l/7MBRpPCz6l8Y=\n"
298  "-----END CERTIFICATE-----\n";
299 
300  /**************************************************************************/
304  /**************************************************************************/
305  void _connect() {
306 
307  if (WiFi.status() == WL_CONNECTED)
308  return;
309 
310  if (strlen(_ssid) == 0) {
311  _status = WS_SSID_INVALID;
312  } else {
313  WiFi.setAutoReconnect(false);
314  _disconnect();
315  delay(100);
316  if (WS._isWiFiMulti) {
317  // multi network mode
318  _wifiMulti.APlistClean();
319  _wifiMulti.setAllowOpenAP(false);
320  // add default network
321  _wifiMulti.addAP(_ssid, _pass);
322  // add array of alternative networks
323  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
324  if (strlen(WS._multiNetworks[i].ssid) > 0) {
325  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
326  WS._multiNetworks[i].pass);
327  }
328  }
329  if (_wifiMulti.run(20000) == WL_CONNECTED) {
330  _status = WS_NET_CONNECTED;
331  } else {
332  _status = WS_NET_DISCONNECTED;
333  }
334  } else {
335  // single network mode
336  WiFi.begin(_ssid, _pass);
337  _status = WS_NET_DISCONNECTED;
338  WS.feedWDT();
339  delay(5000);
340  }
341  WS.feedWDT();
342  }
343  }
344 
345  /**************************************************************************/
349  /**************************************************************************/
350  void _disconnect() {
351  WiFi.disconnect();
352  delay(500);
353  }
354 };
355 
356 #endif // ARDUINO_ARCH_ESP32_H
357 #endif // Wippersnapper_ESP32_H
Wippersnapper_ESP32::set_ssid_pass
void set_ssid_pass()
Sets the WiFi client&#39;s ssid and password.
Definition: Wippersnapper_ESP32.h:88
+Go to the documentation of this file.
1 
17 #ifndef Wippersnapper_ESP32_H
18 #define Wippersnapper_ESP32_H
19 
20 #ifdef ARDUINO_ARCH_ESP32
21 #include "Wippersnapper.h"
22 
23 #include "Adafruit_MQTT.h"
24 #include "Adafruit_MQTT_Client.h"
25 #include "Arduino.h"
26 #include "WiFi.h"
27 #include "WiFiMulti.h"
28 #include <NetworkClient.h>
29 #include <NetworkClientSecure.h>
30 extern Wippersnapper WS;
31 
32 /****************************************************************************/
36 /****************************************************************************/
37 class Wippersnapper_ESP32 : public Wippersnapper {
38 
39 public:
40  /**************************************************************************/
44  /**************************************************************************/
45  Wippersnapper_ESP32() : Wippersnapper() {
46  _ssid = 0;
47  _pass = 0;
48  }
49 
50  /**************************************************************************/
54  /**************************************************************************/
55  ~Wippersnapper_ESP32() {
56  if (_mqtt_client_secure)
57  delete _mqtt_client_secure;
58  if (_mqtt_client_insecure)
59  delete _mqtt_client_insecure;
60  }
61 
62  /********************************************************/
70  /********************************************************/
71  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
72  _ssid = ssid;
73 
74  // set the AP password
75  // check if ssidPassword was "" in secrets.json
76  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
77  _pass = NULL; // Set as NULL for open networks
78  } else {
79  _pass = ssidPassword;
80  }
81  }
82 
83  /**********************************************************/
87  /**********************************************************/
88  void set_ssid_pass() {
89  _ssid = WS._config.network.ssid;
90  _pass = WS._config.network.pass;
91  }
92 
93  /***********************************************************/
98  /***********************************************************/
99  bool check_valid_ssid() {
100  // Set WiFi to station mode and disconnect from an AP if it was previously
101  // connected
102  WiFi.mode(WIFI_STA);
103  WiFi.disconnect();
104  delay(100);
105 
106 // For boards with a "3D Antenna", we need to reduce the TX power
107 // to prevent flaky operation.
108 // NOTE: This is a known issue with the QT Py series of boards.
109 #ifdef ARDUINO_ADAFRUIT_QTPY_ESP32S2 || \
110  ARDUINO_ADAFRUIT_QTPY_ESP32S3_NOPSRAM || \
111  ARDUINO_ADAFRUIT_QTPY_ESP32S3_N4R2 || ARDUINO_ADAFRUIT_QTPY_ESP32C3 || \
112  ARDUINO_ADAFRUIT_QTPY_ESP32_PICO
113  WiFi.setTxPower(WIFI_POWER_15dBm);
114 #endif
115 
116  // Perform a network scan
117  int n = WiFi.scanNetworks();
118  if (n == 0) {
119  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
120  return false;
121  }
122 
123  bool foundNetwork = false;
124 
125  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks:");
126  for (uint8_t i = 0; i < n; i++) {
127  if (!foundNetwork && strcmp(WiFi.SSID(i).c_str(), _ssid) == 0) {
128  foundNetwork = true;
129  } else if (!foundNetwork && WS._isWiFiMulti) {
130  // multi network mode
131  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
132  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i).c_str()) == 0) {
133  foundNetwork = true;
134  }
135  }
136  }
137  WS_DEBUG_PRINT(WiFi.SSID(i));
138  WS_DEBUG_PRINT(" (");
139  uint8_t BSSID[WL_MAC_ADDR_LENGTH];
140  WiFi.BSSID(i, BSSID);
141  for (int m = 0; m < WL_MAC_ADDR_LENGTH; m++) {
142  if (m != 0)
143  WS_DEBUG_PRINT(":");
144  WS_DEBUG_PRINTHEX(BSSID[m]);
145  }
146  WS_DEBUG_PRINT(") ");
147  WS_DEBUG_PRINT(WiFi.RSSI(i));
148  WS_DEBUG_PRINT("dB (ch");
149  WS_DEBUG_PRINT(WiFi.channel(i))
150  WS_DEBUG_PRINTLN(")");
151  }
152 
153  if (!foundNetwork) {
154  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
155  }
156  return foundNetwork;
157  }
158 
159  /********************************************************/
164  /********************************************************/
165  void getMacAddr() {
166  uint8_t mac[6] = {0};
167  Network.macAddress(mac);
168  memcpy(WS._macAddr, mac, sizeof(mac));
169  }
170 
171  /********************************************************/
176  /********************************************************/
177  int32_t getRSSI() { return WiFi.RSSI(); }
178 
179  /********************************************************/
185  /********************************************************/
186  void setupMQTTClient(const char *clientID) {
187  if (strcmp(WS._config.aio_url, "io.adafruit.com") == 0 ||
188  strcmp(WS._config.aio_url, "io.adafruit.us") == 0) {
189  _mqtt_client_secure = new NetworkClientSecure();
190  _mqtt_client_secure->setCACert(
191  strcmp(WS._config.aio_url, "io.adafruit.com") == 0
192  ? _aio_root_ca_prod
193  : _aio_root_ca_staging);
194  WS._mqtt = new Adafruit_MQTT_Client(
195  _mqtt_client_secure, WS._config.aio_url, WS._config.io_port, clientID,
196  WS._config.aio_user, WS._config.aio_key);
197  } else {
198  // Insecure connections require a NetworkClient object rather than a
199  // NetworkClientSecure object
200  _mqtt_client_insecure = new NetworkClient();
201  WS._mqtt = new Adafruit_MQTT_Client(
202  _mqtt_client_insecure, WS._config.aio_url, WS._config.io_port,
203  clientID, WS._config.aio_user, WS._config.aio_key);
204  }
205  }
206 
207  /********************************************************/
212  /********************************************************/
213  ws_status_t networkStatus() {
214  switch (WiFi.status()) {
215  case WL_CONNECTED:
216  return WS_NET_CONNECTED;
217  case WL_CONNECT_FAILED:
218  return WS_NET_CONNECT_FAILED;
219  case WL_IDLE_STATUS:
220  return WS_IDLE;
221  default:
222  return WS_NET_DISCONNECTED;
223  }
224  }
225 
226  /*******************************************************************/
231  /*******************************************************************/
232  const char *connectionType() { return "ESP32"; }
233 
234 protected:
235  const char *_ssid;
236  const char *_pass;
237  NetworkClientSecure
238  *_mqtt_client_secure;
239  NetworkClient
240  *_mqtt_client_insecure;
241  WiFiMulti _wifiMulti;
242 
243  const char *_aio_root_ca_staging =
244  "-----BEGIN CERTIFICATE-----\n"
245  "MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw\n"
246  "TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
247  "cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4\n"
248  "WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu\n"
249  "ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY\n"
250  "MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc\n"
251  "h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+\n"
252  "0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U\n"
253  "A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW\n"
254  "T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH\n"
255  "B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC\n"
256  "B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv\n"
257  "KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn\n"
258  "OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn\n"
259  "jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw\n"
260  "qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI\n"
261  "rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\n"
262  "HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq\n"
263  "hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL\n"
264  "ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ\n"
265  "3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK\n"
266  "NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5\n"
267  "ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur\n"
268  "TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC\n"
269  "jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc\n"
270  "oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq\n"
271  "4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA\n"
272  "mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d\n"
273  "emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=\n"
274  "-----END CERTIFICATE-----\n";
275 
276  const char *_aio_root_ca_prod =
277  "-----BEGIN CERTIFICATE-----\n"
278  "MIIEjTCCA3WgAwIBAgIQDQd4KhM/xvmlcpbhMf/ReTANBgkqhkiG9w0BAQsFADBh\n"
279  "MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n"
280  "d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH\n"
281  "MjAeFw0xNzExMDIxMjIzMzdaFw0yNzExMDIxMjIzMzdaMGAxCzAJBgNVBAYTAlVT\n"
282  "MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n"
283  "b20xHzAdBgNVBAMTFkdlb1RydXN0IFRMUyBSU0EgQ0EgRzEwggEiMA0GCSqGSIb3\n"
284  "DQEBAQUAA4IBDwAwggEKAoIBAQC+F+jsvikKy/65LWEx/TMkCDIuWegh1Ngwvm4Q\n"
285  "yISgP7oU5d79eoySG3vOhC3w/3jEMuipoH1fBtp7m0tTpsYbAhch4XA7rfuD6whU\n"
286  "gajeErLVxoiWMPkC/DnUvbgi74BJmdBiuGHQSd7LwsuXpTEGG9fYXcbTVN5SATYq\n"
287  "DfbexbYxTMwVJWoVb6lrBEgM3gBBqiiAiy800xu1Nq07JdCIQkBsNpFtZbIZhsDS\n"
288  "fzlGWP4wEmBQ3O67c+ZXkFr2DcrXBEtHam80Gp2SNhou2U5U7UesDL/xgLK6/0d7\n"
289  "6TnEVMSUVJkZ8VeZr+IUIlvoLrtjLbqugb0T3OYXW+CQU0kBAgMBAAGjggFAMIIB\n"
290  "PDAdBgNVHQ4EFgQUlE/UXYvkpOKmgP792PkA76O+AlcwHwYDVR0jBBgwFoAUTiJU\n"
291  "IBiV5uNu5g/6+rkS7QYXjzkwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsG\n"
292  "AQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMDQGCCsGAQUFBwEB\n"
293  "BCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tMEIGA1Ud\n"
294  "HwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEds\n"
295  "b2JhbFJvb3RHMi5jcmwwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUHAgEW\n"
296  "HGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwDQYJKoZIhvcNAQELBQADggEB\n"
297  "AIIcBDqC6cWpyGUSXAjjAcYwsK4iiGF7KweG97i1RJz1kwZhRoo6orU1JtBYnjzB\n"
298  "c4+/sXmnHJk3mlPyL1xuIAt9sMeC7+vreRIF5wFBC0MCN5sbHwhNN1JzKbifNeP5\n"
299  "ozpZdQFmkCo+neBiKR6HqIA+LMTMCMMuv2khGGuPHmtDze4GmEGZtYLyF8EQpa5Y\n"
300  "jPuV6k2Cr/N3XxFpT3hRpt/3usU/Zb9wfKPtWpoznZ4/44c1p9rzFcZYrWkj3A+7\n"
301  "TNBJE0GmP2fhXhP1D/XVfIW/h0yCJGEiV9Glm/uGOa3DXHlmbAcxSyCRraG+ZBkA\n"
302  "7h4SeM6Y8l/7MBRpPCz6l8Y=\n"
303  "-----END CERTIFICATE-----\n";
304 
305  /**************************************************************************/
309  /**************************************************************************/
310  void _connect() {
311 
312  if (WiFi.status() == WL_CONNECTED)
313  return;
314 
315  if (strlen(_ssid) == 0) {
316  _status = WS_SSID_INVALID;
317  } else {
318  WiFi.setAutoReconnect(false);
319  _disconnect();
320  delay(100);
321  if (WS._isWiFiMulti) {
322  // multi network mode
323  _wifiMulti.APlistClean();
324  _wifiMulti.setAllowOpenAP(false);
325  // add default network
326  _wifiMulti.addAP(_ssid, _pass);
327  // add array of alternative networks
328  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
329  if (strlen(WS._multiNetworks[i].ssid) > 0) {
330  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
331  WS._multiNetworks[i].pass);
332  }
333  }
334  if (_wifiMulti.run(20000) == WL_CONNECTED) {
335  _status = WS_NET_CONNECTED;
336  } else {
337  _status = WS_NET_DISCONNECTED;
338  }
339  } else {
340  // single network mode
341  WiFi.begin(_ssid, _pass);
342  _status = WS_NET_DISCONNECTED;
343  WS.feedWDT();
344  delay(5000);
345  }
346  WS.feedWDT();
347  }
348  }
349 
350  /**************************************************************************/
354  /**************************************************************************/
355  void _disconnect() {
356  WiFi.disconnect();
357  delay(500);
358  }
359 };
360 
361 #endif // ARDUINO_ARCH_ESP32_H
362 #endif // Wippersnapper_ESP32_H
Wippersnapper_ESP32::set_ssid_pass
void set_ssid_pass()
Sets the WiFi client&#39;s ssid and password.
Definition: Wippersnapper_ESP32.h:88
WS_DEBUG_PRINT
#define WS_DEBUG_PRINT(...)
Prints debug output.
Definition: Wippersnapper.h:49
Wippersnapper_ESP32
Class for using the ESP32 network interface.
Definition: Wippersnapper_ESP32.h:37
Wippersnapper_ESP32::set_ssid_pass
void set_ssid_pass(const char *ssid, const char *ssidPassword)
Sets the WiFi client&#39;s ssid and password.
Definition: Wippersnapper_ESP32.h:71
-
Wippersnapper_ESP32::_connect
void _connect()
Establishes a connection with the wireless network.
Definition: Wippersnapper_ESP32.h:305
+
Wippersnapper_ESP32::_connect
void _connect()
Establishes a connection with the wireless network.
Definition: Wippersnapper_ESP32.h:310
Wippersnapper_ESP32::Wippersnapper_ESP32
Wippersnapper_ESP32()
Initializes the Adafruit IO class for ESP32 devices.
Definition: Wippersnapper_ESP32.h:45
Wippersnapper_ESP32::check_valid_ssid
bool check_valid_ssid()
Performs a scan of local WiFi networks.
Definition: Wippersnapper_ESP32.h:99
Wippersnapper_ESP32::getMacAddr
void getMacAddr()
Sets the ESP32&#39;s unique client identifier.
Definition: Wippersnapper_ESP32.h:165
Wippersnapper_ESP32::_ssid
const char * _ssid
WiFi SSID.
Definition: Wippersnapper_ESP32.h:235
-
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:400
+
WS_DEBUG_PRINTHEX
#define WS_DEBUG_PRINTHEX(...)
Prints debug output.
Definition: Wippersnapper.h:55
+
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:406
+
WL_MAC_ADDR_LENGTH
#define WL_MAC_ADDR_LENGTH
MAC address length - from RP2040 BSP.
Definition: Wippersnapper_Networking.h:20
Wippersnapper_ESP32::_mqtt_client_secure
NetworkClientSecure * _mqtt_client_secure
Pointer to a secure network client object.
Definition: Wippersnapper_ESP32.h:238
ws_status_t
ws_status_t
Definition: Wippersnapper.h:190
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
Wippersnapper_ESP32::getRSSI
int32_t getRSSI()
Gets the current network RSSI value.
Definition: Wippersnapper_ESP32.h:177
Wippersnapper_ESP32::networkStatus
ws_status_t networkStatus()
Returns the network status of an ESP32 module.
Definition: Wippersnapper_ESP32.h:213
Wippersnapper.h
-
WS_MAX_ALT_WIFI_NETWORKS
#define WS_MAX_ALT_WIFI_NETWORKS
Maximum number of alternative networks.
Definition: Wippersnapper.h:246
+
WS_MAX_ALT_WIFI_NETWORKS
#define WS_MAX_ALT_WIFI_NETWORKS
Maximum number of alternative networks.
Definition: Wippersnapper.h:251
Wippersnapper_ESP32::_pass
const char * _pass
WiFi password.
Definition: Wippersnapper_ESP32.h:236
-
Wippersnapper_ESP32::_disconnect
void _disconnect()
Disconnects from the wireless network.
Definition: Wippersnapper_ESP32.h:350
-
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2589
-
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:402
-
Wippersnapper_ESP32::_aio_root_ca_prod
const char * _aio_root_ca_prod
Root certificate for io.adafruit.com.
Definition: Wippersnapper_ESP32.h:271
-
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:401
+
Wippersnapper_ESP32::_disconnect
void _disconnect()
Disconnects from the wireless network.
Definition: Wippersnapper_ESP32.h:355
+
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2608
+
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:408
+
Wippersnapper_ESP32::_aio_root_ca_prod
const char * _aio_root_ca_prod
Root certificate for io.adafruit.com.
Definition: Wippersnapper_ESP32.h:276
+
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:407
WS
Wippersnapper WS
Definition: Wippersnapper.cpp:36
Wippersnapper_ESP32::_aio_root_ca_staging
const char * _aio_root_ca_staging
Root certificate for io.adafruit.us.
Definition: Wippersnapper_ESP32.h:243
WS_DEBUG_PRINTLN
#define WS_DEBUG_PRINTLN(...)
Prints line from debug output.
Definition: Wippersnapper.h:52
Wippersnapper_ESP32::setupMQTTClient
void setupMQTTClient(const char *clientID)
Initializes the MQTT client.
Definition: Wippersnapper_ESP32.h:186
Wippersnapper_ESP32::~Wippersnapper_ESP32
~Wippersnapper_ESP32()
Destructor for the Adafruit IO AirLift class.
Definition: Wippersnapper_ESP32.h:55
Wippersnapper_ESP32::_wifiMulti
WiFiMulti _wifiMulti
WiFiMulti object for multi-network mode.
Definition: Wippersnapper_ESP32.h:241
-
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:470
+
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:476
Wippersnapper_ESP32::_mqtt_client_insecure
NetworkClient * _mqtt_client_insecure
Pointer to an insecure network client object.
Definition: Wippersnapper_ESP32.h:240
-
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:395
-
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:398
+
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:401
+
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:404
Wippersnapper_ESP32::connectionType
const char * connectionType()
Returns the type of network connection used by Wippersnapper.
Definition: Wippersnapper_ESP32.h:232
diff --git a/html/_wippersnapper___e_s_p8266_8h_source.html b/html/_wippersnapper___e_s_p8266_8h_source.html index be042e118..4a6a89049 100644 --- a/html/_wippersnapper___e_s_p8266_8h_source.html +++ b/html/_wippersnapper___e_s_p8266_8h_source.html @@ -66,24 +66,26 @@
Wippersnapper_ESP8266.h
-Go to the documentation of this file.
1 
17 #ifndef WIPPERSNAPPER_ESP8266_H
18 #define WIPPERSNAPPER_ESP8266_H
19 
20 #ifdef ARDUINO_ARCH_ESP8266
21 #include "Adafruit_MQTT.h"
22 #include "Adafruit_MQTT_Client.h"
23 #include "ESP8266WiFi.h"
24 #include "ESP8266WiFiMulti.h"
25 #include "Wippersnapper.h"
26 
27 /* NOTE - Projects that require "Secure MQTT" (TLS/SSL) also require a new
28  * SSL certificate every year. If adding Secure MQTT to your ESP8266 project is
29  * important - please switch to using the modern ESP32 (and related models)
30  * instead of the ESP8266 to avoid updating the SSL fingerprint every year.
31  *
32  * If you've read through this and still want to use "Secure MQTT" with your
33  * ESP8266 project, we've left the "WiFiClientSecure" lines commented out. To
34  * use them, uncomment the commented out lines within this file and re-compile
35  * the library.
36  */
37 // static const char *fingerprint PROGMEM = "4E C1 52 73 24 A8 36 D6 7A 4C 67
38 // C7 91 0C 0A 22 B9 2D 5B CA";
39 
40 extern Wippersnapper WS;
41 
42 /******************************************************************************/
47 /******************************************************************************/
48 class Wippersnapper_ESP8266 : public Wippersnapper {
49 
50 public:
51  /**************************************************************************/
63  /**************************************************************************/
64  Wippersnapper_ESP8266() : Wippersnapper() {
65  _ssid = 0;
66  _pass = 0;
67  _wifi_client = new WiFiClient;
68  WiFi.persistent(false);
69  WiFi.mode(WIFI_STA);
70  }
71 
72  /**************************************************************************/
76  /**************************************************************************/
77  ~Wippersnapper_ESP8266() {
78  if (_wifi_client)
79  delete _wifi_client;
80  if (_mqtt)
81  delete _mqtt;
82  }
83 
84  /**********************************************************/
92  /**********************************************************/
93  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
94  _ssid = ssid;
95 
96  // set the AP password
97  // check if ssidPassword was "" in secrets.json
98  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
99  _pass = NULL; // Set as NULL for open networks
100  } else {
101  _pass = ssidPassword;
102  }
103  }
104 
105  /**********************************************************/
110  /**********************************************************/
111  void set_ssid_pass() {
112  _ssid = WS._config.network.ssid;
113  _pass = WS._config.network.pass;
114  }
115 
116  /***********************************************************/
121  /***********************************************************/
122  bool check_valid_ssid() {
123  // Set WiFi to station mode and disconnect from an AP if it was previously
124  // connected
125  WiFi.mode(WIFI_STA);
126  WiFi.disconnect();
127  delay(100);
128 
129  // Perform a network scan
130  int n = WiFi.scanNetworks();
131  if (n == 0) {
132  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
133  return false;
134  }
135 
136  // Was the network within secrets.json found?
137  for (int i = 0; i < n; ++i) {
138  if (strcmp(_ssid, WiFi.SSID(i).c_str()) == 0) {
139  WS_DEBUG_PRINT("SSID (");
140  WS_DEBUG_PRINT(_ssid);
141  WS_DEBUG_PRINT(") found! RSSI: ");
142  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
143  return true;
144  }
145  if (WS._isWiFiMulti) {
146  // multi network mode
147  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
148  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i).c_str()) == 0) {
149  WS_DEBUG_PRINT("SSID (");
150  WS_DEBUG_PRINT(WS._multiNetworks[j].ssid);
151  WS_DEBUG_PRINT(") found! RSSI: ");
152  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
153  return true;
154  }
155  }
156  }
157  }
158 
159  // User-set network not found, print scan results to serial console
160  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
161  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks: ");
162  for (int i = 0; i < n; ++i) {
163  WS_DEBUG_PRINT(WiFi.SSID(i));
164  WS_DEBUG_PRINT(" ");
165  WS_DEBUG_PRINT(WiFi.RSSI(i));
166  WS_DEBUG_PRINTLN("dB");
167  }
168 
169  return false;
170  }
171 
172  /********************************************************/
177  /********************************************************/
178  void getMacAddr() {
179  uint8_t mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
180  WiFi.macAddress(mac);
181  memcpy(WS._macAddr, mac, sizeof(mac));
182  }
183 
184  /********************************************************/
189  /********************************************************/
190  int32_t getRSSI() { return WiFi.RSSI(); }
191 
192  /*******************************************************************/
198  /*******************************************************************/
199  void setupMQTTClient(const char *clientID) {
200  // Uncomment the following lines to use MQTT/SSL. You will need to
201  // re-compile after. _wifi_client->setFingerprint(fingerprint); WS._mqtt =
202  // new Adafruit_MQTT_Client(_wifi_client, WS._config.aio_url,
203  // WS._config.io_port, clientID, WS._config.aio_user, WS._config.aio_key);
204  if (WS._config.io_port == 8883)
205  WS._config.io_port = 1883;
206  WS._mqtt = new Adafruit_MQTT_Client(
207  _wifi_client, WS._config.aio_url, WS._config.io_port, clientID,
208  WS._config.aio_user, WS._config.aio_key);
209  }
210 
211  /********************************************************/
216  /********************************************************/
217  ws_status_t networkStatus() {
218  switch (WiFi.status()) {
219  case WL_CONNECTED:
220  return WS_NET_CONNECTED;
221  case WL_CONNECT_FAILED:
222  return WS_NET_CONNECT_FAILED;
223  case WL_IDLE_STATUS:
224  return WS_IDLE;
225  default:
226  return WS_NET_DISCONNECTED;
227  }
228  }
229 
230  /*******************************************************************/
235  /*******************************************************************/
236  const char *connectionType() { return "ESP8266"; }
237 
238 protected:
239  const char *_ssid = NULL;
240  const char *_pass = NULL;
241  WiFiClient *_wifi_client;
242  ESP8266WiFiMulti _wifiMulti;
243 
244  /**************************************************************************/
248  /**************************************************************************/
249  void _connect() {
250 
251  if (WiFi.status() == WL_CONNECTED)
252  return;
253 
254  if (strlen(_ssid) == 0) {
255  _status = WS_SSID_INVALID;
256  } else {
257  WiFi.setAutoReconnect(false);
258  // Attempt connection
259  _disconnect();
260  delay(100);
261  // ESP8266 MUST be in STA mode to avoid device acting as client/server
262  WiFi.mode(WIFI_STA);
263  WiFi.begin(_ssid, _pass);
264  _status = WS_NET_DISCONNECTED;
265  delay(100);
266 
267  if (WS._isWiFiMulti) {
268  // multi network mode
269  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
270  if (strlen(WS._multiNetworks[i].ssid) > 0 &&
271  (_wifiMulti.existsAP(WS._multiNetworks[i].ssid) == false)) {
272  // doesn't exist, add it
273  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
274  WS._multiNetworks[i].pass);
275  }
276  }
277  // add default network
278  if (_wifiMulti.existsAP(_ssid) == false) {
279  _wifiMulti.addAP(_ssid, _pass);
280  }
281  long startRetry = millis();
282  WS_DEBUG_PRINTLN("CONNECTING");
283  while (_wifiMulti.run(5000) != WL_CONNECTED &&
284  millis() - startRetry < 10000) {
285  // ESP8266 WDT requires yield() during a busy-loop so it doesn't bite
286  yield();
287  }
288  if (WiFi.status() == WL_CONNECTED) {
289  _status = WS_NET_CONNECTED;
290  } else {
291  _status = WS_NET_DISCONNECTED;
292  }
293  } else {
294  // single network mode
295 
296  // wait for a connection to be established
297  long startRetry = millis();
298  WS_DEBUG_PRINTLN("CONNECTING");
299  while (WiFi.status() != WL_CONNECTED && millis() - startRetry < 10000) {
300  // ESP8266 WDT requires yield() during a busy-loop so it doesn't bite
301  yield();
302  }
303  if (WiFi.status() == WL_CONNECTED) {
304  _status = WS_NET_CONNECTED;
305  } else {
306  _status = WS_NET_DISCONNECTED;
307  }
308  }
309  WS.feedWDT();
310  }
311  }
312 
313  /**************************************************************************/
317  /**************************************************************************/
318  void _disconnect() {
319  WiFi.disconnect();
320  delay(500);
321  }
322 };
323 
324 #endif // ARDUINO_ARCH_ESP8266
325 #endif // WIPPERSNAPPER_ESP8266_H
Wippersnapper::setupMQTTClient
virtual void setupMQTTClient(const char *clientID)
Sets up the MQTT client session.
Definition: Wippersnapper.cpp:203
+Go to the documentation of this file.
1 
17 #ifndef WIPPERSNAPPER_ESP8266_H
18 #define WIPPERSNAPPER_ESP8266_H
19 
20 #ifdef ARDUINO_ARCH_ESP8266
21 #include "Adafruit_MQTT.h"
22 #include "Adafruit_MQTT_Client.h"
23 #include "ESP8266WiFi.h"
24 #include "ESP8266WiFiMulti.h"
25 #include "Wippersnapper.h"
26 
27 /* NOTE - Projects that require "Secure MQTT" (TLS/SSL) also require a new
28  * SSL certificate every year. If adding Secure MQTT to your ESP8266 project is
29  * important - please switch to using the modern ESP32 (and related models)
30  * instead of the ESP8266 to avoid updating the SSL fingerprint every year.
31  *
32  * If you've read through this and still want to use "Secure MQTT" with your
33  * ESP8266 project, we've left the "WiFiClientSecure" lines commented out. To
34  * use them, uncomment the commented out lines within this file and re-compile
35  * the library.
36  */
37 // static const char *fingerprint PROGMEM = "4E C1 52 73 24 A8 36 D6 7A 4C 67
38 // C7 91 0C 0A 22 B9 2D 5B CA";
39 
40 extern Wippersnapper WS;
41 
42 /******************************************************************************/
47 /******************************************************************************/
48 class Wippersnapper_ESP8266 : public Wippersnapper {
49 
50 public:
51  /**************************************************************************/
63  /**************************************************************************/
64  Wippersnapper_ESP8266() : Wippersnapper() {
65  _ssid = 0;
66  _pass = 0;
67  _wifi_client = new WiFiClient;
68  WiFi.persistent(false);
69  WiFi.mode(WIFI_STA);
70  }
71 
72  /**************************************************************************/
76  /**************************************************************************/
77  ~Wippersnapper_ESP8266() {
78  if (_wifi_client)
79  delete _wifi_client;
80  if (_mqtt)
81  delete _mqtt;
82  }
83 
84  /**********************************************************/
92  /**********************************************************/
93  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
94  _ssid = ssid;
95 
96  // set the AP password
97  // check if ssidPassword was "" in secrets.json
98  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
99  _pass = NULL; // Set as NULL for open networks
100  } else {
101  _pass = ssidPassword;
102  }
103  }
104 
105  /**********************************************************/
110  /**********************************************************/
111  void set_ssid_pass() {
112  _ssid = WS._config.network.ssid;
113  _pass = WS._config.network.pass;
114  }
115 
116  /***********************************************************/
121  /***********************************************************/
122  bool check_valid_ssid() {
123  // Set WiFi to station mode and disconnect from an AP if it was previously
124  // connected
125  WiFi.mode(WIFI_STA);
126  WiFi.disconnect();
127  delay(100);
128 
129  // Perform a network scan
130  int n = WiFi.scanNetworks();
131  if (n == 0) {
132  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
133  return false;
134  }
135 
136  bool foundNetwork = false;
137 
138  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks:");
139  for (uint8_t i = 0; i < n; i++) {
140  if (!foundNetwork && strcmp(WiFi.SSID(i).c_str(), _ssid) == 0) {
141  foundNetwork = true;
142  } else if (!foundNetwork && WS._isWiFiMulti) {
143  // multi network mode
144  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
145  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i).c_str()) == 0) {
146  foundNetwork = true;
147  }
148  }
149  }
150  WS_DEBUG_PRINT(WiFi.SSID(i));
151  WS_DEBUG_PRINT(" (");
152  uint8_t BSSID[WL_MAC_ADDR_LENGTH];
153  memcpy(BSSID, WiFi.BSSID(i), WL_MAC_ADDR_LENGTH);
154  for (int m = 0; m < WL_MAC_ADDR_LENGTH; m++) {
155  if (m != 0)
156  WS_DEBUG_PRINT(":");
157  WS_DEBUG_PRINTHEX(BSSID[m]);
158  }
159  WS_DEBUG_PRINT(") ");
160  WS_DEBUG_PRINT(WiFi.RSSI(i));
161  WS_DEBUG_PRINT("dB (ch");
162  WS_DEBUG_PRINT(WiFi.channel(i))
163  WS_DEBUG_PRINTLN(")");
164  }
165 
166  if (!foundNetwork) {
167  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
168  }
169  return foundNetwork;
170  }
171 
172  /********************************************************/
177  /********************************************************/
178  void getMacAddr() {
179  uint8_t mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
180  WiFi.macAddress(mac);
181  memcpy(WS._macAddr, mac, sizeof(mac));
182  }
183 
184  /********************************************************/
189  /********************************************************/
190  int32_t getRSSI() { return WiFi.RSSI(); }
191 
192  /*******************************************************************/
198  /*******************************************************************/
199  void setupMQTTClient(const char *clientID) {
200  // Uncomment the following lines to use MQTT/SSL. You will need to
201  // re-compile after. _wifi_client->setFingerprint(fingerprint); WS._mqtt =
202  // new Adafruit_MQTT_Client(_wifi_client, WS._config.aio_url,
203  // WS._config.io_port, clientID, WS._config.aio_user, WS._config.aio_key);
204  if (WS._config.io_port == 8883)
205  WS._config.io_port = 1883;
206  WS._mqtt = new Adafruit_MQTT_Client(
207  _wifi_client, WS._config.aio_url, WS._config.io_port, clientID,
208  WS._config.aio_user, WS._config.aio_key);
209  }
210 
211  /********************************************************/
216  /********************************************************/
217  ws_status_t networkStatus() {
218  switch (WiFi.status()) {
219  case WL_CONNECTED:
220  return WS_NET_CONNECTED;
221  case WL_CONNECT_FAILED:
222  return WS_NET_CONNECT_FAILED;
223  case WL_IDLE_STATUS:
224  return WS_IDLE;
225  default:
226  return WS_NET_DISCONNECTED;
227  }
228  }
229 
230  /*******************************************************************/
235  /*******************************************************************/
236  const char *connectionType() { return "ESP8266"; }
237 
238 protected:
239  const char *_ssid = NULL;
240  const char *_pass = NULL;
241  WiFiClient *_wifi_client;
242  ESP8266WiFiMulti _wifiMulti;
243 
244  /**************************************************************************/
248  /**************************************************************************/
249  void _connect() {
250 
251  if (WiFi.status() == WL_CONNECTED)
252  return;
253 
254  if (strlen(_ssid) == 0) {
255  _status = WS_SSID_INVALID;
256  } else {
257  WiFi.setAutoReconnect(false);
258  // Attempt connection
259  _disconnect();
260  delay(100);
261  // ESP8266 MUST be in STA mode to avoid device acting as client/server
262  WiFi.mode(WIFI_STA);
263  _status = WS_NET_DISCONNECTED;
264  delay(100);
265 
266  if (WS._isWiFiMulti) {
267  // multi network mode
268  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
269  if (strlen(WS._multiNetworks[i].ssid) > 0 &&
270  (_wifiMulti.existsAP(WS._multiNetworks[i].ssid) == false)) {
271  // doesn't exist, add it
272  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
273  WS._multiNetworks[i].pass);
274  }
275  }
276  }
277 
278  // add default network
279  if (_wifiMulti.existsAP(_ssid) == false) {
280  _wifiMulti.addAP(_ssid, _pass);
281  }
282 
283  long startRetry = millis();
284  WS_DEBUG_PRINTLN("CONNECTING");
285 
286  while (_wifiMulti.run(5000) != WL_CONNECTED &&
287  millis() - startRetry < 10000) {
288  // ESP8266 WDT requires yield() during a busy-loop so it doesn't bite
289  yield();
290  }
291 
292  if (WiFi.status() == WL_CONNECTED) {
293  _status = WS_NET_CONNECTED;
294  } else {
295  _status = WS_NET_DISCONNECTED;
296  }
297 
298  WS.feedWDT();
299  }
300  }
301 
302  /**************************************************************************/
306  /**************************************************************************/
307  void _disconnect() {
308  WiFi.disconnect();
309  delay(500);
310  }
311 };
312 
313 #endif // ARDUINO_ARCH_ESP8266
314 #endif // WIPPERSNAPPER_ESP8266_H
Wippersnapper::setupMQTTClient
virtual void setupMQTTClient(const char *clientID)
Sets up the MQTT client session.
Definition: Wippersnapper.cpp:203
WS_DEBUG_PRINT
#define WS_DEBUG_PRINT(...)
Prints debug output.
Definition: Wippersnapper.h:49
-
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:400
+
WS_DEBUG_PRINTHEX
#define WS_DEBUG_PRINTHEX(...)
Prints debug output.
Definition: Wippersnapper.h:55
+
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:406
+
WL_MAC_ADDR_LENGTH
#define WL_MAC_ADDR_LENGTH
MAC address length - from RP2040 BSP.
Definition: Wippersnapper_Networking.h:20
ws_status_t
ws_status_t
Definition: Wippersnapper.h:190
Wippersnapper::check_valid_ssid
virtual bool check_valid_ssid()
Performs a scan of local WiFi networks.
Definition: Wippersnapper.cpp:248
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
+
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:283
Wippersnapper.h
Wippersnapper::_connect
virtual void _connect()
Connects to wireless network.
Definition: Wippersnapper.cpp:162
-
WS_MAX_ALT_WIFI_NETWORKS
#define WS_MAX_ALT_WIFI_NETWORKS
Maximum number of alternative networks.
Definition: Wippersnapper.h:246
+
WS_MAX_ALT_WIFI_NETWORKS
#define WS_MAX_ALT_WIFI_NETWORKS
Maximum number of alternative networks.
Definition: Wippersnapper.h:251
Wippersnapper::getMacAddr
virtual void getMacAddr()
Sets the network interface&#39;s unique identifer, typically the MAC address.
Definition: Wippersnapper.cpp:181
Wippersnapper::set_ssid_pass
virtual void set_ssid_pass()
Sets the device&#39;s wireless network credentials from the secrets.json configuration file...
Definition: Wippersnapper.cpp:238
-
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2589
-
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:402
-
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:401
+
Wippersnapper::feedWDT
void feedWDT()
Feeds the WDT to prevent hardware reset.
Definition: Wippersnapper.cpp:2608
+
Wippersnapper::_isWiFiMulti
bool _isWiFiMulti
Definition: Wippersnapper.h:408
+
Wippersnapper::_multiNetworks
networkConfig _multiNetworks[3]
Definition: Wippersnapper.h:407
WS_DEBUG_PRINTLN
#define WS_DEBUG_PRINTLN(...)
Prints line from debug output.
Definition: Wippersnapper.h:52
WS
Wippersnapper WS
Definition: Wippersnapper.cpp:36
-
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:395
-
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:398
+
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:401
+
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:404
Wippersnapper::networkStatus
virtual ws_status_t networkStatus()
Returns the network&#39;s connection status.
Definition: Wippersnapper.cpp:213
Wippersnapper::getRSSI
virtual int32_t getRSSI()
Gets the network&#39;s RSSI.
Definition: Wippersnapper.cpp:191
Wippersnapper::_disconnect
virtual void _disconnect()
Disconnect Wippersnapper MQTT session and network.
Definition: Wippersnapper.cpp:171
diff --git a/html/_wippersnapper___networking_8h.html b/html/_wippersnapper___networking_8h.html index e1d51f824..02602b392 100644 --- a/html/_wippersnapper___networking_8h.html +++ b/html/_wippersnapper___networking_8h.html @@ -63,6 +63,7 @@
+Macros | Typedefs
Wippersnapper_Networking.h File Reference
@@ -72,6 +73,17 @@

Go to the source code of this file.

+ + + + + + + +

+Macros

+#define WL_MAC_ADDR_LENGTH   6
 MAC address length - from RP2040 BSP.
 
+#define WS_MAX_ALT_WIFI_NETWORKS   3
 Maximum number of alternative networks.
 
diff --git a/html/_wippersnapper___networking_8h_source.html b/html/_wippersnapper___networking_8h_source.html index d29ec8843..e2a2f7bcd 100644 --- a/html/_wippersnapper___networking_8h_source.html +++ b/html/_wippersnapper___networking_8h_source.html @@ -66,15 +66,13 @@
Wippersnapper_Networking.h
-Go to the documentation of this file.
1 
16 #ifndef WIPPERSNAPPER_NETWORKING_H
17 #define WIPPERSNAPPER_NETWORKING_H
18 
19 #if defined(ADAFRUIT_METRO_M4_EXPRESS) || \
20  defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE) || defined(ADAFRUIT_PYPORTAL) || \
21  defined(ADAFRUIT_PYPORTAL_M4_TITANO) || defined(USE_AIRLIFT)
22 #include "network_interfaces/Wippersnapper_AIRLIFT.h"
24 typedef Wippersnapper_AIRLIFT Wippersnapper_WiFi;
25 #elif defined(ARDUINO_ARCH_ESP8266)
26 #include "network_interfaces/Wippersnapper_ESP8266.h"
28 typedef Wippersnapper_ESP8266 Wippersnapper_WiFi;
29 #elif defined(ARDUINO_ARCH_ESP32)
30 #include "network_interfaces/Wippersnapper_ESP32.h"
32 typedef Wippersnapper_ESP32 Wippersnapper_WiFi;
33 #elif defined(ARDUINO_ARCH_RP2040)
34 #include "network_interfaces/ws_networking_pico.h"
35 typedef ws_networking_pico Wippersnapper_WiFi;
36 #elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_SAMD_MKRWIFI1010)
37 
38 #include "network_interfaces/Wippersnapper_WIFININA.h"
39 typedef Wippersnapper_WIFININA Wippersnapper_WiFi;
40 #else
41 #warning "Must define network interface in config.h!"
42 #endif
43 
44 #endif // WIPPERSNAPPER_NETWORKING_H
Wippersnapper_AIRLIFT.h
+Go to the documentation of this file.
1 
16 #ifndef WIPPERSNAPPER_NETWORKING_H
17 #define WIPPERSNAPPER_NETWORKING_H
18 
19 #ifndef WL_MAC_ADDR_LENGTH
20 #define WL_MAC_ADDR_LENGTH 6
21 #endif
22 #define WS_MAX_ALT_WIFI_NETWORKS 3
23 
24 #if defined(ADAFRUIT_METRO_M4_EXPRESS) || \
25  defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE) || defined(ADAFRUIT_PYPORTAL) || \
26  defined(ADAFRUIT_PYPORTAL_M4_TITANO) || defined(USE_AIRLIFT)
27 #include "network_interfaces/Wippersnapper_AIRLIFT.h"
29 typedef Wippersnapper_AIRLIFT Wippersnapper_WiFi;
30 #elif defined(ARDUINO_ARCH_ESP8266)
31 #include "network_interfaces/Wippersnapper_ESP8266.h"
33 typedef Wippersnapper_ESP8266 Wippersnapper_WiFi;
34 #elif defined(ARDUINO_ARCH_ESP32)
35 #include "network_interfaces/Wippersnapper_ESP32.h"
37 typedef Wippersnapper_ESP32 Wippersnapper_WiFi;
38 #elif defined(ARDUINO_ARCH_RP2040)
39 #include "network_interfaces/ws_networking_pico.h"
40 typedef ws_networking_pico Wippersnapper_WiFi;
41 #else
42 #warning "Must define network interface in config.h!"
43 #endif
44 
45 #endif // WIPPERSNAPPER_NETWORKING_H
Wippersnapper_AIRLIFT.h
Wippersnapper_ESP32
Class for using the ESP32 network interface.
Definition: Wippersnapper_ESP32.h:37
Wippersnapper_AIRLIFT
Class for using the AirLift Co-Processor network iface.
Definition: Wippersnapper_AIRLIFT.h:43
-
Wippersnapper_WIFININA.h
ws_networking_pico.h
Wippersnapper_ESP32.h
-
Wippersnapper_WIFININA
Class for using the AirLift Co-Processor network iface.
Definition: Wippersnapper_WIFININA.h:36
Wippersnapper_ESP8266.h
-
Wippersnapper_WiFi
Wippersnapper_ESP32 Wippersnapper_WiFi
Definition: Wippersnapper_Networking.h:32
+
Wippersnapper_WiFi
Wippersnapper_ESP32 Wippersnapper_WiFi
Definition: Wippersnapper_Networking.h:37
diff --git a/html/_wippersnapper___w_i_f_i_n_i_n_a_8h.html b/html/_wippersnapper___w_i_f_i_n_i_n_a_8h.html deleted file mode 100644 index b99bead08..000000000 --- a/html/_wippersnapper___w_i_f_i_n_i_n_a_8h.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - -Adafruit Library: src/network_interfaces/Wippersnapper_WIFININA.h File Reference - - - - - - - - - -
-
-

Typedefs

typedef Wippersnapper_ESP32 Wippersnapper_WiFi
- - - - - -
-
Adafruit Library -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Classes | -Macros | -Variables
-
-
Wippersnapper_WIFININA.h File Reference
-
-
-
#include <Adafruit_MQTT.h>
-#include <Adafruit_MQTT_Client.h>
-#include <Arduino.h>
-#include <SPI.h>
-#include <WiFiNINA.h>
-#include "Wippersnapper.h"
-
-

Go to the source code of this file.

- - - - - -

-Classes

class  Wippersnapper_WIFININA
 Class for using the AirLift Co-Processor network iface. More...
 
- - - -

-Macros

#define SPIWIFI   SPI
 
- - - -

-Variables

Wippersnapper WS
 
-

Detailed Description

-

Network interface for the ublox wifi module on the Arduino MKR WiFi 1010, Arduino Nano 33 IoT and Arduino UNO WiFi Rev.2.

-

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

-

Copyright (c) Brent Rubell 2021 for Adafruit Industries.

-

MIT license, all text here must be included in any redistribution.

-

Macro Definition Documentation

- -

◆ SPIWIFI

- -
-
- - - - -
#define SPIWIFI   SPI
-
-

Instance of SPI interface used by an external uBlox module.

- -
-
-

Variable Documentation

- -

◆ WS

- -
-
- - - - -
Wippersnapper WS
-
-

Wippersnapper variable.

- -
-
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/html/_wippersnapper___w_i_f_i_n_i_n_a_8h_source.html b/html/_wippersnapper___w_i_f_i_n_i_n_a_8h_source.html deleted file mode 100644 index 2307be318..000000000 --- a/html/_wippersnapper___w_i_f_i_n_i_n_a_8h_source.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - -Adafruit Library: src/network_interfaces/Wippersnapper_WIFININA.h Source File - - - - - - - - - -
-
- - - - - - -
-
Adafruit Library -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
Wippersnapper_WIFININA.h
-
-
-Go to the documentation of this file.
1 
17 #ifndef WIPPERSNAPPER_WIFININA_H
18 #define WIPPERSNAPPER_WIFININA_H
19 #include <Adafruit_MQTT.h>
20 #include <Adafruit_MQTT_Client.h>
21 #include <Arduino.h>
22 #include <SPI.h>
23 #include <WiFiNINA.h>
24 
25 #include "Wippersnapper.h"
26 
27 #define SPIWIFI \
28  SPI
30 extern Wippersnapper WS;
31 /****************************************************************************/
35 /****************************************************************************/
36 class Wippersnapper_WIFININA : public Wippersnapper {
37 
38 public:
39  /**************************************************************************/
51  /**************************************************************************/
52  Wippersnapper_WIFININA(const char *aioUsername, const char *aioKey,
53  const char *netSSID, const char *netPass)
54  : Wippersnapper() {
55  _ssid = netSSID;
56  _pass = netPass;
57  _username = aioUsername;
58  _key = aioKey;
59 
60  _wifi = &SPIWIFI;
61  _mqtt_client = new WiFiSSLClient;
62  }
63 
64  /**************************************************************************/
68  /**************************************************************************/
69  ~Wippersnapper_WIFININA() {
70  if (_mqtt)
71  delete _mqtt;
72  }
73 
74  /****************************************************************************/
80  /****************************************************************************/
81  void set_user_key() {
82  strlcpy(WS._config.aio_user, _username, sizeof(WS._config.aio_user));
83  strlcpy(WS._config.aio_key, _key, sizeof(WS._config.aio_key));
84  }
85 
86  /**********************************************************/
94  /**********************************************************/
95  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
96  strlcpy(WS._config.network.ssid, ssid, sizeof(WS._config.network.ssid));
97  strlcpy(WS._config.network.pass, ssidPassword,
98  sizeof(WS._config.network.pass));
99  }
100 
101  /**********************************************************/
106  /**********************************************************/
107  void set_ssid_pass() {
108  strlcpy(WS._config.network.ssid, _ssid, sizeof(WS._config.network.ssid));
109  strlcpy(WS._config.network.pass, _pass, sizeof(WS._config.network.pass));
110  }
111 
112  /***********************************************************/
117  /***********************************************************/
118  bool check_valid_ssid() {
119  // Set WiFi to station mode and disconnect from an AP if it was previously
120  // connected
121  WiFi.disconnect();
122  delay(100);
123 
124  // Perform a network scan
125  int n = WiFi.scanNetworks();
126  if (n == 0) {
127  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
128  return false;
129  }
130 
131  // Was the network within secrets.json found?
132  for (int i = 0; i < n; ++i) {
133  if (strcmp(_ssid, WiFi.SSID(i)) == 0) {
134  WS_DEBUG_PRINT("SSID found! RSSI: ");
135  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
136  return true;
137  }
138  }
139 
140  // User-set network not found, print scan results to serial console
141  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
142  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks: ");
143  for (int i = 0; i < n; ++i) {
144  WS_DEBUG_PRINT(WiFi.SSID(i));
145  WS_DEBUG_PRINT(" ");
146  WS_DEBUG_PRINT(WiFi.RSSI(i));
147  WS_DEBUG_PRINTLN("dB");
148  }
149 
150  return false;
151  }
152 
153  /********************************************************/
159  /********************************************************/
160  void set_wifi(SPIClass *wifi) {
161  _wifi = wifi;
162  _mqtt_client = new WiFiSSLClient;
163  }
164 
165  /***********************************************************/
171  /***********************************************************/
172  bool firmwareCheck() {
173  String fv = WiFi.firmwareVersion();
174  if (fv < WIFI_FIRMWARE_LATEST_VERSION)
175  return false;
176  return true;
177  }
178 
179  /********************************************************/
184  /********************************************************/
185  void getMacAddr() {
186  uint8_t mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
187  WiFi.macAddress(mac);
188  memcpy(WS._macAddr, mac, sizeof(mac));
189  }
190 
191  /********************************************************/
196  /********************************************************/
197  int32_t getRSSI() { return WiFi.RSSI(); }
198 
199  /********************************************************/
205  /********************************************************/
206  void setupMQTTClient(const char *clientID) {
207  WS._mqtt = new Adafruit_MQTT_Client(
208  _mqtt_client, WS._config.aio_url, WS._config.io_port, clientID,
209  WS._config.aio_user, WS._config.aio_key);
210  }
211 
212  /********************************************************/
217  /********************************************************/
218  ws_status_t networkStatus() {
219  switch (WiFi.status()) {
220  case WL_CONNECTED:
221  return WS_NET_CONNECTED;
222  case WL_CONNECT_FAILED:
223  return WS_NET_CONNECT_FAILED;
224  case WL_IDLE_STATUS:
225  return WS_IDLE;
226  default:
227  return WS_NET_DISCONNECTED;
228  }
229  }
230 
231  /*******************************************************************/
236  /*******************************************************************/
237  const char *connectionType() { return "AIRLIFT"; }
238 
239 protected:
240  const char *_ssid;
241  const char *_pass;
242  const char *_username;
243  const char *_key;
245  WiFiSSLClient *_mqtt_client;
246  SPIClass *_wifi;
248  /**************************************************************************/
252  /**************************************************************************/
253  void _connect() {
254 
255  // check if co-processor connected first
256  if (WiFi.status() == WL_NO_MODULE)
257  errorWriteHang("No WiFi Module Detected!");
258 
259  // validate the nina-fw version
260  if (!firmwareCheck())
261  errorWriteHang("Please upgrade the firmware on the ESP module to the "
262  "latest version.");
263 
264  if (strlen(_ssid) == 0) {
265  _status = WS_SSID_INVALID;
266  } else {
267  // disconnect from possible previous connection
268  _disconnect();
269 
270  WiFi.begin(_ssid, _pass);
271  _status = WS_NET_DISCONNECTED;
272  }
273  }
274 
275  /**************************************************************************/
279  /**************************************************************************/
280  void _disconnect() {
281  WiFi.disconnect();
282  delay(500);
283  }
284 };
285 
286 #endif // WIPPERSNAPPER_WIFININA_H
WS_DEBUG_PRINT
#define WS_DEBUG_PRINT(...)
Prints debug output.
Definition: Wippersnapper.h:49
-
Wippersnapper_WIFININA::_username
const char * _username
Definition: Wippersnapper_WIFININA.h:242
-
Wippersnapper_WIFININA::set_ssid_pass
void set_ssid_pass(const char *ssid, const char *ssidPassword)
Sets the WiFi client&#39;s ssid and password.
Definition: Wippersnapper_WIFININA.h:95
-
WS
Wippersnapper WS
Definition: Wippersnapper.cpp:36
-
Wippersnapper_WIFININA::set_wifi
void set_wifi(SPIClass *wifi)
Sets the WiFi client.
Definition: Wippersnapper_WIFININA.h:160
-
Wippersnapper_WIFININA::_wifi
SPIClass * _wifi
Definition: Wippersnapper_WIFININA.h:246
-
Wippersnapper_WIFININA::_ssid
const char * _ssid
Definition: Wippersnapper_WIFININA.h:240
-
Wippersnapper::errorWriteHang
void errorWriteHang(String error)
Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern ...
Definition: Wippersnapper.cpp:2334
-
Wippersnapper_WIFININA::firmwareCheck
bool firmwareCheck()
Checks the nina-fw version on the module.
Definition: Wippersnapper_WIFININA.h:172
-
Wippersnapper_WIFININA::_mqtt_client
WiFiSSLClient * _mqtt_client
Definition: Wippersnapper_WIFININA.h:245
-
Wippersnapper::_config
secretsConfig _config
Definition: Wippersnapper.h:400
-
Wippersnapper_WIFININA::_key
const char * _key
Definition: Wippersnapper_WIFININA.h:243
-
Wippersnapper_WIFININA::setupMQTTClient
void setupMQTTClient(const char *clientID)
Initializes the MQTT client.
Definition: Wippersnapper_WIFININA.h:206
-
ws_status_t
ws_status_t
Definition: Wippersnapper.h:190
-
Wippersnapper
Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
Definition: Wippersnapper.h:278
-
Wippersnapper_WIFININA::_connect
void _connect()
Establishes a connection with the wireless network.
Definition: Wippersnapper_WIFININA.h:253
-
Wippersnapper.h
-
Wippersnapper_WIFININA::networkStatus
ws_status_t networkStatus()
Returns the network status of an ESP32 module.
Definition: Wippersnapper_WIFININA.h:218
-
Wippersnapper_WIFININA::~Wippersnapper_WIFININA
~Wippersnapper_WIFININA()
Destructor for the Adafruit IO ublox class.
Definition: Wippersnapper_WIFININA.h:69
-
Wippersnapper_WIFININA::set_user_key
void set_user_key()
Configures the device&#39;s Adafruit IO credentials. This method should be used only if filesystem-backed...
Definition: Wippersnapper_WIFININA.h:81
-
Wippersnapper_WIFININA
Class for using the AirLift Co-Processor network iface.
Definition: Wippersnapper_WIFININA.h:36
-
Wippersnapper_WIFININA::Wippersnapper_WIFININA
Wippersnapper_WIFININA(const char *aioUsername, const char *aioKey, const char *netSSID, const char *netPass)
Initializes the Adafruit IO class for ublox devices.
Definition: Wippersnapper_WIFININA.h:52
-
Wippersnapper_WIFININA::getRSSI
int32_t getRSSI()
Gets the current network RSSI value.
Definition: Wippersnapper_WIFININA.h:197
-
WS_DEBUG_PRINTLN
#define WS_DEBUG_PRINTLN(...)
Prints line from debug output.
Definition: Wippersnapper.h:52
-
Wippersnapper::_status
ws_status_t _status
Definition: Wippersnapper.h:470
-
Wippersnapper_WIFININA::check_valid_ssid
bool check_valid_ssid()
Performs a scan of local WiFi networks.
Definition: Wippersnapper_WIFININA.h:118
-
Wippersnapper::_macAddr
uint8_t _macAddr[6]
Definition: Wippersnapper.h:395
-
Wippersnapper_WIFININA::_disconnect
void _disconnect()
Disconnects from the wireless network.
Definition: Wippersnapper_WIFININA.h:280
-
Wippersnapper::_mqtt
Adafruit_MQTT * _mqtt
Definition: Wippersnapper.h:398
-
Wippersnapper_WIFININA::connectionType
const char * connectionType()
Returns the type of network connection used by Wippersnapper.
Definition: Wippersnapper_WIFININA.h:237
-
Wippersnapper_WIFININA::getMacAddr
void getMacAddr()
Gets the ESP32&#39;s unique client identifier.
Definition: Wippersnapper_WIFININA.h:185
-
Wippersnapper_WIFININA::set_ssid_pass
void set_ssid_pass()
Sets the WiFi client&#39;s ssid and password from the header file&#39;s credentials.
Definition: Wippersnapper_WIFININA.h:107
-
Wippersnapper_WIFININA::_pass
const char * _pass
Definition: Wippersnapper_WIFININA.h:241
-
SPIWIFI
#define SPIWIFI
Definition: Wippersnapper_WIFININA.h:27
-
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/html/annotated.html b/html/annotated.html index 763cf5aad..d002e123d 100644 --- a/html/annotated.html +++ b/html/annotated.html @@ -111,35 +111,36 @@  CWipperSnapper_I2C_Driver_SCD30Class that provides a driver interface for the SCD30 sensor  CWipperSnapper_I2C_Driver_SCD4XClass that provides a driver interface for the SCD40 sensor  CWipperSnapper_I2C_Driver_SEN5XClass that provides a driver interface for the SEN5X sensor - CWipperSnapper_I2C_Driver_SGP30Class that provides a driver interface for a SGP30 sensor - CWipperSnapper_I2C_Driver_SGP40Class that provides a driver interface for the SGP40 sensor - CWipperSnapper_I2C_Driver_SHT3XClass that provides a driver interface for the SHT3X sensor - CWipperSnapper_I2C_Driver_SHT4XClass that provides a driver interface for the SHT4X sensor - CWipperSnapper_I2C_Driver_SHTC3Class that provides a driver interface for the SHTC3 sensor - CWipperSnapper_I2C_Driver_SI7021Class that provides a driver interface for the SI7021 sensor - CWipperSnapper_I2C_Driver_STEMMA_Soil_SensorClass that provides a driver interface for the STEMMA soil sensor - CWipperSnapper_I2C_Driver_TMP117Class that provides a driver interface for a TMP117 sensor - CWipperSnapper_I2C_Driver_TSL2591Class that provides a driver interface for a TSL2591 sensor - CWipperSnapper_I2C_Driver_VCNL4020Class that provides a driver interface for a VCNL4020 sensor - CWipperSnapper_I2C_Driver_VCNL4040Class that provides a driver interface for a VCNL4040 sensor - CWipperSnapper_I2C_Driver_VEML7700Class that provides a driver interface for a VEML7700 sensor - CWipperSnapper_I2C_Driver_VL53L0XClass that provides a driver interface for a VL53L0X sensor - CWipperSnapper_I2C_Driver_VL53L1XClass that provides a driver interface for a VL53L1X sensor - CWipperSnapper_I2C_Driver_VL53L4CDClass that provides a driver interface for a VL53L4CD sensor - CWipperSnapper_I2C_Driver_VL53L4CXClass that provides a driver interface for a VL53L4CX sensor - CWipperSnapper_I2C_Driver_VL6180XClass that provides a driver interface for a VL6180X sensor - CWippersnapper_WIFININAClass for using the AirLift Co-Processor network iface - Cws_display_driverDisplay driver for LVGL and LVGL_Glue in WipperSnapper - Cws_display_ui_helperHelps build and manage the LVGL objects and screens for the application code - Cws_ds18x20Class that provides an interface with DS18X20-compatible sensors - Cws_ledcHigh-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls - Cws_ledc_servoHigh-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h) - Cws_pixelsFriend class - Cws_pwmInterface for WipperSnapper PWM - Cws_servoInterface for WipperSnapper servo control - Cws_uartClass that provides an interface between WipperSnapper's app and the device's UART bus - Cws_uart_drvBase class for UART Device Drivers - Cws_uart_drv_pm25aqiClass that provides an interface for a PM25 AQI UART sensor + CWipperSnapper_I2C_Driver_SEN6XClass that provides a driver interface for the SEN6X sensor + CWipperSnapper_I2C_Driver_SGP30Class that provides a driver interface for a SGP30 sensor + CWipperSnapper_I2C_Driver_SGP40Class that provides a driver interface for the SGP40 sensor + CWipperSnapper_I2C_Driver_SHT3XClass that provides a driver interface for the SHT3X sensor + CWipperSnapper_I2C_Driver_SHT4XClass that provides a driver interface for the SHT4X sensor + CWipperSnapper_I2C_Driver_SHTC3Class that provides a driver interface for the SHTC3 sensor + CWipperSnapper_I2C_Driver_SI7021Class that provides a driver interface for the SI7021 sensor + CWipperSnapper_I2C_Driver_STEMMA_Soil_SensorClass that provides a driver interface for the STEMMA soil sensor + CWipperSnapper_I2C_Driver_TMP117Class that provides a driver interface for a TMP117 sensor + CWipperSnapper_I2C_Driver_TSL2591Class that provides a driver interface for a TSL2591 sensor + CWipperSnapper_I2C_Driver_VCNL4020Class that provides a driver interface for a VCNL4020 sensor + CWipperSnapper_I2C_Driver_VCNL4040Class that provides a driver interface for a VCNL4040 sensor + CWipperSnapper_I2C_Driver_VCNL4200Class that provides a driver interface for a VCNL4200 sensor + CWipperSnapper_I2C_Driver_VEML7700Class that provides a driver interface for a VEML7700 sensor + CWipperSnapper_I2C_Driver_VL53L0XClass that provides a driver interface for a VL53L0X sensor + CWipperSnapper_I2C_Driver_VL53L1XClass that provides a driver interface for a VL53L1X sensor + CWipperSnapper_I2C_Driver_VL53L4CDClass that provides a driver interface for a VL53L4CD sensor + CWipperSnapper_I2C_Driver_VL53L4CXClass that provides a driver interface for a VL53L4CX sensor + CWipperSnapper_I2C_Driver_VL6180XClass that provides a driver interface for a VL6180X sensor + Cws_display_driverDisplay driver for LVGL and LVGL_Glue in WipperSnapper + Cws_display_ui_helperHelps build and manage the LVGL objects and screens for the application code + Cws_ds18x20Class that provides an interface with DS18X20-compatible sensors + Cws_ledcHigh-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls + Cws_ledc_servoHigh-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h) + Cws_pixelsFriend class + Cws_pwmInterface for WipperSnapper PWM + Cws_servoInterface for WipperSnapper servo control + Cws_uartClass that provides an interface between WipperSnapper's app and the device's UART bus + Cws_uart_drvBase class for UART Device Drivers + Cws_uart_drv_pm25aqiClass that provides an interface for a PM25 AQI UART sensor diff --git a/html/class_wipper_snapper___i2_c___driver.html b/html/class_wipper_snapper___i2_c___driver.html index 7a2e51923..64bfc9921 100644 --- a/html/class_wipper_snapper___i2_c___driver.html +++ b/html/class_wipper_snapper___i2_c___driver.html @@ -110,23 +110,25 @@ WipperSnapper_I2C_Driver_SCD30 WipperSnapper_I2C_Driver_SCD4X WipperSnapper_I2C_Driver_SEN5X -WipperSnapper_I2C_Driver_SGP30 -WipperSnapper_I2C_Driver_SGP40 -WipperSnapper_I2C_Driver_SHT3X -WipperSnapper_I2C_Driver_SHT4X -WipperSnapper_I2C_Driver_SHTC3 -WipperSnapper_I2C_Driver_SI7021 -WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor -WipperSnapper_I2C_Driver_TMP117 -WipperSnapper_I2C_Driver_TSL2591 -WipperSnapper_I2C_Driver_VCNL4020 -WipperSnapper_I2C_Driver_VCNL4040 -WipperSnapper_I2C_Driver_VEML7700 -WipperSnapper_I2C_Driver_VL53L0X -WipperSnapper_I2C_Driver_VL53L1X -WipperSnapper_I2C_Driver_VL53L4CD -WipperSnapper_I2C_Driver_VL53L4CX -WipperSnapper_I2C_Driver_VL6180X +WipperSnapper_I2C_Driver_SEN6X +WipperSnapper_I2C_Driver_SGP30 +WipperSnapper_I2C_Driver_SGP40 +WipperSnapper_I2C_Driver_SHT3X +WipperSnapper_I2C_Driver_SHT4X +WipperSnapper_I2C_Driver_SHTC3 +WipperSnapper_I2C_Driver_SI7021 +WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor +WipperSnapper_I2C_Driver_TMP117 +WipperSnapper_I2C_Driver_TSL2591 +WipperSnapper_I2C_Driver_VCNL4020 +WipperSnapper_I2C_Driver_VCNL4040 +WipperSnapper_I2C_Driver_VCNL4200 +WipperSnapper_I2C_Driver_VEML7700 +WipperSnapper_I2C_Driver_VL53L0X +WipperSnapper_I2C_Driver_VL53L1X +WipperSnapper_I2C_Driver_VL53L4CD +WipperSnapper_I2C_Driver_VL53L4CX +WipperSnapper_I2C_Driver_VL6180X @@ -864,7 +866,7 @@

Returns
True if the sensor value was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SCD30, and WipperSnapper_I2C_Driver_SCD4X.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SCD30, and WipperSnapper_I2C_Driver_SCD4X.

@@ -1245,7 +1247,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_DS2484, WipperSnapper_I2C_Driver_SCD30, WipperSnapper_I2C_Driver_SCD4X, WipperSnapper_I2C_Driver_HDC302X, WipperSnapper_I2C_Driver_BME680, WipperSnapper_I2C_Driver_BMP280, WipperSnapper_I2C_Driver_DPS310, WipperSnapper_I2C_Driver_BMP3XX, WipperSnapper_I2C_Driver_AHTX0, WipperSnapper_I2C_Driver_BME280, WipperSnapper_I2C_Driver_LPS22HB, WipperSnapper_I2C_Driver_LPS25HB, WipperSnapper_I2C_Driver_LPS3XHW, WipperSnapper_I2C_Driver_SEN5X, WipperSnapper_I2C_Driver_MS8607, WipperSnapper_I2C_Driver_SI7021, WipperSnapper_I2C_Driver_HTS221, WipperSnapper_I2C_Driver_MPL115A2, WipperSnapper_I2C_Driver_SHT3X, WipperSnapper_I2C_Driver_SHT4X, WipperSnapper_I2C_Driver_ADT7410, WipperSnapper_I2C_Driver_MCP9808, WipperSnapper_I2C_Driver_PCT2075, WipperSnapper_I2C_Driver_TMP117, WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor, WipperSnapper_I2C_Driver_SHTC3, WipperSnapper_I2C_Driver_HTU21D, and WipperSnapper_I2C_Driver_HTU31D.

+

Reimplemented in WipperSnapper_I2C_Driver_DS2484, WipperSnapper_I2C_Driver_SCD30, WipperSnapper_I2C_Driver_SCD4X, WipperSnapper_I2C_Driver_HDC302X, WipperSnapper_I2C_Driver_BME680, WipperSnapper_I2C_Driver_BMP280, WipperSnapper_I2C_Driver_DPS310, WipperSnapper_I2C_Driver_BMP3XX, WipperSnapper_I2C_Driver_AHTX0, WipperSnapper_I2C_Driver_BME280, WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_LPS22HB, WipperSnapper_I2C_Driver_LPS25HB, WipperSnapper_I2C_Driver_LPS3XHW, WipperSnapper_I2C_Driver_SEN5X, WipperSnapper_I2C_Driver_MS8607, WipperSnapper_I2C_Driver_SI7021, WipperSnapper_I2C_Driver_HTS221, WipperSnapper_I2C_Driver_MPL115A2, WipperSnapper_I2C_Driver_SHT3X, WipperSnapper_I2C_Driver_SHT4X, WipperSnapper_I2C_Driver_ADT7410, WipperSnapper_I2C_Driver_MCP9808, WipperSnapper_I2C_Driver_PCT2075, WipperSnapper_I2C_Driver_TMP117, WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor, WipperSnapper_I2C_Driver_SHTC3, WipperSnapper_I2C_Driver_HTU21D, and WipperSnapper_I2C_Driver_HTU31D.

@@ -1372,7 +1374,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SCD30, WipperSnapper_I2C_Driver_SCD4X, WipperSnapper_I2C_Driver_HDC302X, WipperSnapper_I2C_Driver_BME680, WipperSnapper_I2C_Driver_SEN5X, WipperSnapper_I2C_Driver_AHTX0, WipperSnapper_I2C_Driver_BME280, WipperSnapper_I2C_Driver_MS8607, WipperSnapper_I2C_Driver_HTS221, WipperSnapper_I2C_Driver_SHT3X, WipperSnapper_I2C_Driver_SI7021, WipperSnapper_I2C_Driver_SHT4X, WipperSnapper_I2C_Driver_SHTC3, WipperSnapper_I2C_Driver_HTU21D, and WipperSnapper_I2C_Driver_HTU31D.

+

Reimplemented in WipperSnapper_I2C_Driver_SCD30, WipperSnapper_I2C_Driver_SCD4X, WipperSnapper_I2C_Driver_HDC302X, WipperSnapper_I2C_Driver_BME680, WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SEN5X, WipperSnapper_I2C_Driver_AHTX0, WipperSnapper_I2C_Driver_BME280, WipperSnapper_I2C_Driver_MS8607, WipperSnapper_I2C_Driver_HTS221, WipperSnapper_I2C_Driver_SHT3X, WipperSnapper_I2C_Driver_SI7021, WipperSnapper_I2C_Driver_SHT4X, WipperSnapper_I2C_Driver_SHTC3, WipperSnapper_I2C_Driver_HTU21D, and WipperSnapper_I2C_Driver_HTU31D.

@@ -1878,7 +1880,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_VL6180X, WipperSnapper_I2C_Driver_VCNL4040, WipperSnapper_I2C_Driver_LTR390, WipperSnapper_I2C_Driver_LTR329_LTR303, WipperSnapper_I2C_Driver_TSL2591, WipperSnapper_I2C_Driver_BH1750, WipperSnapper_I2C_Driver_VEML7700, and WipperSnapper_I2C_Driver_VCNL4020.

+

Reimplemented in WipperSnapper_I2C_Driver_VL6180X, WipperSnapper_I2C_Driver_VCNL4040, WipperSnapper_I2C_Driver_VCNL4200, WipperSnapper_I2C_Driver_LTR390, WipperSnapper_I2C_Driver_LTR329_LTR303, WipperSnapper_I2C_Driver_TSL2591, WipperSnapper_I2C_Driver_BH1750, WipperSnapper_I2C_Driver_VEML7700, and WipperSnapper_I2C_Driver_VCNL4020.

@@ -2005,7 +2007,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

@@ -2132,7 +2134,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

@@ -2259,7 +2261,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_PM25.

@@ -3271,7 +3273,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SEN5X.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, and WipperSnapper_I2C_Driver_SEN5X.

@@ -3398,7 +3400,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_SGP40.

+

Reimplemented in WipperSnapper_I2C_Driver_SEN6X, WipperSnapper_I2C_Driver_SEN5X, and WipperSnapper_I2C_Driver_SGP40.

@@ -3559,7 +3561,7 @@

Returns
True if the sensor event was obtained successfully, False otherwise.
-

Reimplemented in WipperSnapper_I2C_Driver_VL53L4CD, WipperSnapper_I2C_Driver_VCNL4040, WipperSnapper_I2C_Driver_VL53L4CX, WipperSnapper_I2C_Driver_VCNL4020, WipperSnapper_I2C_Driver_VL53L1X, WipperSnapper_I2C_Driver_VL53L0X, and WipperSnapper_I2C_Driver_VL6180X.

+

Reimplemented in WipperSnapper_I2C_Driver_VL53L4CD, WipperSnapper_I2C_Driver_VCNL4040, WipperSnapper_I2C_Driver_VL53L4CX, WipperSnapper_I2C_Driver_VCNL4200, WipperSnapper_I2C_Driver_VCNL4020, WipperSnapper_I2C_Driver_VL53L1X, WipperSnapper_I2C_Driver_VL53L0X, and WipperSnapper_I2C_Driver_VL6180X.

diff --git a/html/class_wipper_snapper___i2_c___driver.png b/html/class_wipper_snapper___i2_c___driver.png index 23efcc4d7..6e6f6de12 100644 Binary files a/html/class_wipper_snapper___i2_c___driver.png and b/html/class_wipper_snapper___i2_c___driver.png differ diff --git a/html/class_wipper_snapper___i2_c___driver___s_e_n6_x-members.html b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x-members.html new file mode 100644 index 000000000..aa395f3cc --- /dev/null +++ b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x-members.html @@ -0,0 +1,224 @@ + + + + + + + +Adafruit Library: Member List + + + + + + + + + +
+
+

+ + + + + +
+
Adafruit Library +
+
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
WipperSnapper_I2C_Driver_SEN6X Member List
+
+
+ +

This is the complete list of members for WipperSnapper_I2C_Driver_SEN6X, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
_altitudeSensorPeriodWipperSnapper_I2C_Driverprotected
_altitudeSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_ambientTempFPeriodWipperSnapper_I2C_Driverprotected
_ambientTempFPeriodPrvWipperSnapper_I2C_Driverprotected
_CO2SensorPeriodWipperSnapper_I2C_Driverprotected
_CO2SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_currentPeriodWipperSnapper_I2C_Driverprotected
_currentPeriodPrvWipperSnapper_I2C_Driverprotected
_ECO2SensorPeriodWipperSnapper_I2C_Driverprotected
_ECO2SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_gasResistancePeriodWipperSnapper_I2C_Driverprotected
_gasResistancePeriodPrvWipperSnapper_I2C_Driverprotected
_humidSensorPeriodWipperSnapper_I2C_Driverprotected
_humidSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_i2cWipperSnapper_I2C_Driverprotected
_lightSensorPeriodWipperSnapper_I2C_Driverprotected
_lightSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_NOxIndexPeriodWipperSnapper_I2C_Driverprotected
_NOxIndexPeriodPrvWipperSnapper_I2C_Driverprotected
_objectTempFPeriodWipperSnapper_I2C_Driverprotected
_objectTempFPeriodPrvWipperSnapper_I2C_Driverprotected
_objectTempSensorPeriodWipperSnapper_I2C_Driverprotected
_objectTempSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM100SensorPeriodWipperSnapper_I2C_Driverprotected
_PM100SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM10SensorPeriodWipperSnapper_I2C_Driverprotected
_PM10SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM25SensorPeriodWipperSnapper_I2C_Driverprotected
_PM25SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_pressureSensorPeriodWipperSnapper_I2C_Driverprotected
_pressureSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_proximitySensorPeriodWipperSnapper_I2C_Driverprotected
_proximitySensorPeriodPrvWipperSnapper_I2C_Driverprotected
_rawSensorPeriodWipperSnapper_I2C_Driverprotected
_rawSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_senWipperSnapper_I2C_Driver_SEN6Xprotected
_sensorAddressWipperSnapper_I2C_Driverprotected
_tempSensorPeriodWipperSnapper_I2C_Driverprotected
_tempSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_TVOCSensorPeriodWipperSnapper_I2C_Driverprotected
_TVOCSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_unitlessPercentPeriodWipperSnapper_I2C_Driverprotected
_unitlessPercentPeriodPrvWipperSnapper_I2C_Driverprotected
_VOCIndexPeriodWipperSnapper_I2C_Driverprotected
_VOCIndexPeriodPrvWipperSnapper_I2C_Driverprotected
_voltagePeriodWipperSnapper_I2C_Driverprotected
_voltagePeriodPrvWipperSnapper_I2C_Driverprotected
begin()WipperSnapper_I2C_Driver_SEN6Xinline
configureDriver(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq)WipperSnapper_I2C_Driverinline
disableAmbientTempF()WipperSnapper_I2C_Driverinlinevirtual
disableSensorProximity()WipperSnapper_I2C_Driverinlinevirtual
enableSensorProximity()WipperSnapper_I2C_Driverinlinevirtual
getEventAltitude(sensors_event_t *altitudeEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventAmbientTemp(sensors_event_t *tempEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventAmbientTempF(sensors_event_t *AmbientTempFEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventCO2(sensors_event_t *co2Event)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventCurrent(sensors_event_t *currentEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventECO2(sensors_event_t *eco2Event)WipperSnapper_I2C_Driverinlinevirtual
getEventGasResistance(sensors_event_t *gasEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventLight(sensors_event_t *lightEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventNOxIndex(sensors_event_t *noxIndexEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventObjectTemp(sensors_event_t *objectTempEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventObjectTempF(sensors_event_t *objectTempFEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventPM100_STD(sensors_event_t *pm100StdEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventPM10_STD(sensors_event_t *pm10StdEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventPM25_STD(sensors_event_t *pm25StdEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventPM40_STD(sensors_event_t *pm40StdEvent)WipperSnapper_I2C_Driver_SEN6Xinline
getEventPressure(sensors_event_t *pressureEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventProximity(sensors_event_t *proximityEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventRaw(sensors_event_t *rawEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventRelativeHumidity(sensors_event_t *humidEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventTVOC(sensors_event_t *tvocEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventUnitlessPercent(sensors_event_t *unitlessPercentEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventVOCIndex(sensors_event_t *vocIndexEvent)WipperSnapper_I2C_Driver_SEN6Xinlinevirtual
getEventVoltage(sensors_event_t *voltageEvent)WipperSnapper_I2C_Driverinlinevirtual
getI2CAddress()WipperSnapper_I2C_Driverinline
getSensorAltitudePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAltitudePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempFPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempFPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorCO2Period()WipperSnapper_I2C_Driverinlinevirtual
getSensorCO2PeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorCurrentPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorCurrentPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorECO2Period()WipperSnapper_I2C_Driverinlinevirtual
getSensorECO2PeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorGasResistancePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorGasResistancePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorLightPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorLightPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorNOxIndexPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorNOxIndexPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempFPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempFPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM100_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM100_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM10_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM10_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM25_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM25_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPressurePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPressurePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorRawPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorRawPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorRelativeHumidityPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorRelativeHumidityPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorTVOCPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorTVOCPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorUnitlessPercentPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorUnitlessPercentPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorVOCIndexPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorVOCIndexPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorVoltagePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorVoltagePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
sensorProximityPeriod()WipperSnapper_I2C_Driverinlinevirtual
SensorProximityPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
setSensorAltitudePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorAmbientTempFPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorAmbientTempPeriodPrv(long periodPrv)WipperSnapper_I2C_Driverinlinevirtual
setSensorCO2PeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorCurrentPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorECO2PeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorGasResistancePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorLightPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorNOxIndexPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorObjectTempFPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorObjectTempPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPeriod(float period, wippersnapper_i2c_v1_SensorType sensorType)WipperSnapper_I2C_Driverinline
setSensorPM100_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPM10_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPM25_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPressurePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorProximityPeriod(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorProximityPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorRawPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorRelativeHumidityPeriodPrv(long periodPrv)WipperSnapper_I2C_Driverinlinevirtual
setSensorTVOCPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorUnitlessPercentPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorVOCIndexPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorVoltagePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
updateSensorProximity(float period)WipperSnapper_I2C_Driverinlinevirtual
WipperSnapper_I2C_Driver(TwoWire *i2c, uint16_t sensorAddress)WipperSnapper_I2C_Driverinline
WipperSnapper_I2C_Driver_SEN6X(TwoWire *i2c, uint16_t sensorAddress)WipperSnapper_I2C_Driver_SEN6Xinline
~WipperSnapper_I2C_Driver()WipperSnapper_I2C_Driverinlinevirtual
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.html b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.html new file mode 100644 index 000000000..6d1684d1b --- /dev/null +++ b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.html @@ -0,0 +1,945 @@ + + + + + + + +Adafruit Library: WipperSnapper_I2C_Driver_SEN6X Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
WipperSnapper_I2C_Driver_SEN6X Class Reference
+
+
+ +

Class that provides a driver interface for the SEN6X sensor. + More...

+ +

#include <WipperSnapper_I2C_Driver_SEN6X.h>

+
+Inheritance diagram for WipperSnapper_I2C_Driver_SEN6X:
+
+
+ + +WipperSnapper_I2C_Driver + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 WipperSnapper_I2C_Driver_SEN6X (TwoWire *i2c, uint16_t sensorAddress)
 Constructor for a SEN6X sensor. More...
 
bool begin ()
 Initializes the SEN6X sensor and begins I2C. More...
 
bool getEventAmbientTemp (sensors_event_t *tempEvent)
 Gets the SEN6X's current temperature. More...
 
bool getEventRelativeHumidity (sensors_event_t *humidEvent)
 Gets the SEN6X's current relative humidity reading. More...
 
bool getEventNOxIndex (sensors_event_t *noxIndexEvent)
 Gets the SEN6X's current NOX reading. Note: If this value is unknown, which is true for SEN54, NAN is returned. During the first 10..11 seconds after power-on or device reset, this value will be NAN as well. More...
 
bool getEventVOCIndex (sensors_event_t *vocIndexEvent)
 Gets the SEN6X's current VOC reading. More...
 
bool getEventPM10_STD (sensors_event_t *pm10StdEvent)
 Gets the SEN6X sensor's PM1.0 STD reading. More...
 
bool getEventPM25_STD (sensors_event_t *pm25StdEvent)
 Gets the SEN6X sensor's PM2.5 STD reading. More...
 
bool getEventPM40_STD (sensors_event_t *pm40StdEvent)
 Gets the SEN6X sensor's PM4.0 STD reading. More...
 
bool getEventPM100_STD (sensors_event_t *pm100StdEvent)
 Gets the SEN6X sensor's PM10.0 STD reading. More...
 
bool getEventCO2 (sensors_event_t *co2Event)
 Gets the SEN6X sensor's CO2 reading. More...
 
- Public Member Functions inherited from WipperSnapper_I2C_Driver
 WipperSnapper_I2C_Driver (TwoWire *i2c, uint16_t sensorAddress)
 Instanciates an I2C sensor. More...
 
+virtual ~WipperSnapper_I2C_Driver ()
 Destructor for an I2C sensor.
 
bool begin ()
 Initializes the I2C sensor and begins I2C. More...
 
void setSensorPeriod (float period, wippersnapper_i2c_v1_SensorType sensorType)
 Sets the sensor's period, provided a wippersnapper_i2c_v1_SensorType. More...
 
void configureDriver (wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq)
 Uses an I2CDeviceInitRequest message to configure the sensors belonging to the driver. More...
 
uint16_t getI2CAddress ()
 Gets the I2C device's address. More...
 
virtual long getSensorCO2Period ()
 Base implementation - Returns the co2 sensor's period, if set. More...
 
virtual long getSensorCO2PeriodPrv ()
 Base implementation - Returns the previous time interval at which the co2 sensor was queried last. More...
 
virtual void setSensorCO2PeriodPrv (long period)
 Sets a timestamp for when the co2 sensor was queried. More...
 
virtual long getSensorECO2Period ()
 Base implementation - Returns the eCO2 sensor's period, if set. More...
 
virtual long getSensorECO2PeriodPrv ()
 Base implementation - Returns the previous time interval at which the eCO2 sensor was queried last. More...
 
virtual void setSensorECO2PeriodPrv (long period)
 Sets a timestamp for when the eCO2 sensor was queried. More...
 
virtual bool getEventECO2 (sensors_event_t *eco2Event)
 Gets a sensor's eCO2 value. More...
 
virtual long getSensorTVOCPeriod ()
 Base implementation - Returns the TVOC sensor's period, if set. More...
 
virtual long getSensorTVOCPeriodPrv ()
 Base implementation - Returns the previous time interval at which the TVOC sensor was queried last. More...
 
virtual void setSensorTVOCPeriodPrv (long period)
 Sets a timestamp for when the TVOC sensor was queried. More...
 
virtual bool getEventTVOC (sensors_event_t *tvocEvent)
 Gets a sensor's TVOC value. More...
 
virtual long getSensorAmbientTempPeriod ()
 Base implementation - Returns the ambient temperature (°C) sensor's period, if set. More...
 
virtual long getSensorAmbientTempPeriodPrv ()
 Base implementation - Returns the previous time interval at which the ambient temperature sensor (°C) was queried last. More...
 
virtual void setSensorAmbientTempPeriodPrv (long periodPrv)
 Sets a timestamp for when the ambient temperature sensor (°C) was queried. More...
 
virtual long getSensorRelativeHumidityPeriod ()
 Base implementation - Returns the humidity sensor's period, if set. More...
 
virtual long getSensorRelativeHumidityPeriodPrv ()
 Base implementation - Returns the previous time interval at which the humidity sensor was queried last. More...
 
virtual void setSensorRelativeHumidityPeriodPrv (long periodPrv)
 Sets a timestamp for when the temperature sensor was queried. More...
 
virtual long getSensorPressurePeriod ()
 Base implementation - Returns the pressure sensor's period, if set. More...
 
virtual long getSensorPressurePeriodPrv ()
 Base implementation - Returns the previous time interval at which the pressure sensor was queried last. More...
 
virtual void setSensorPressurePeriodPrv (long period)
 Sets a timestamp for when the pressure sensor was queried. More...
 
virtual bool getEventPressure (sensors_event_t *pressureEvent)
 Base implementation - Reads a pressure sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorAltitudePeriod ()
 Base implementation - Returns the Altitude sensor's period, if set. More...
 
virtual long getSensorAltitudePeriodPrv ()
 Base implementation - Returns the previous time interval at which the Altitude sensor was queried last. More...
 
virtual void setSensorAltitudePeriodPrv (long period)
 Sets a timestamp for when the Altitude sensor was queried. More...
 
virtual bool getEventAltitude (sensors_event_t *altitudeEvent)
 Base implementation - Reads a Altitude sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorObjectTempPeriod ()
 Base implementation - Returns the object temperature sensor's period, if set. More...
 
virtual long getSensorObjectTempPeriodPrv ()
 Base implementation - Returns the previous time interval at which the object temperature sensor was queried last. More...
 
virtual void setSensorObjectTempPeriodPrv (long period)
 Sets a timestamp for when the object temperature sensor was queried. More...
 
virtual bool getEventObjectTemp (sensors_event_t *objectTempEvent)
 Base implementation - Reads a object temperature sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorLightPeriod ()
 Base implementation - Returns the object light sensor's period, if set. More...
 
virtual long getSensorLightPeriodPrv ()
 Base implementation - Returns the previous time interval at which the light sensor was queried last. More...
 
virtual void setSensorLightPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual bool getEventLight (sensors_event_t *lightEvent)
 Base implementation - Reads a object light sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorPM10_STDPeriod ()
 Base implementation - Returns the object pm10 standard sensors' period, if set. More...
 
virtual long getSensorPM10_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm10 std. sensor was queried last. More...
 
virtual void setSensorPM10_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual long getSensorPM25_STDPeriod ()
 Base implementation - Returns the object pm25 standard sensors' period, if set. More...
 
virtual long getSensorPM25_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm25 std. sensor was queried last. More...
 
virtual void setSensorPM25_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual long getSensorPM100_STDPeriod ()
 Base implementation - Returns the object pm100 standard sensors' period, if set. More...
 
virtual long getSensorPM100_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm100 std. sensor was queried last. More...
 
virtual void setSensorPM100_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual long getSensorUnitlessPercentPeriod ()
 Base implementation - Returns the object unitless % sensor period, if set. More...
 
virtual long getSensorUnitlessPercentPeriodPrv ()
 Base implementation - Returns the previous time interval at which the unitless % sensor was queried last. More...
 
virtual void setSensorUnitlessPercentPeriodPrv (long period)
 Sets a timestamp for when the unitless % sensor was queried. More...
 
virtual bool getEventUnitlessPercent (sensors_event_t *unitlessPercentEvent)
 Base implementation - Reads a object unitless % std. sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorVoltagePeriod ()
 Base implementation - Returns the voltage sensor's period. More...
 
virtual long getSensorVoltagePeriodPrv ()
 Base implementation - Returns the previous time interval at which the voltage sensor was queried last. More...
 
virtual void setSensorVoltagePeriodPrv (long period)
 Sets a timestamp for when the voltage sensor was queried. More...
 
virtual bool getEventVoltage (sensors_event_t *voltageEvent)
 Base implementation - Reads a voltage sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorCurrentPeriod ()
 Base implementation - Returns the current sensor's period. More...
 
virtual long getSensorCurrentPeriodPrv ()
 Base implementation - Returns the previous time interval at which the current sensor was queried last. More...
 
virtual void setSensorCurrentPeriodPrv (long period)
 Sets a timestamp for when the current sensor was queried. More...
 
virtual bool getEventCurrent (sensors_event_t *currentEvent)
 Base implementation - Reads a current sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorRawPeriod ()
 Base implementation - Returns the raw sensor's period, if set. More...
 
virtual long getSensorRawPeriodPrv ()
 Base implementation - Returns the previous time interval at which the raw sensor was queried last. More...
 
virtual void setSensorRawPeriodPrv (long period)
 Sets a timestamp for when the raw sensor was queried. More...
 
virtual bool getEventRaw (sensors_event_t *rawEvent)
 Gets a sensor's Raw value. More...
 
+virtual void disableAmbientTempF ()
 Disables the device's ambient temperature (°F) sensor, if it exists.
 
virtual long getSensorAmbientTempFPeriod ()
 Base implementation - Returns the ambient temperature (°F) sensor's period, if set. More...
 
virtual long getSensorAmbientTempFPeriodPrv ()
 Base implementation - Returns the previous time interval at which the ambient temperature sensor (°F) was queried last. More...
 
virtual void setSensorAmbientTempFPeriodPrv (long period)
 Sets a timestamp for when the ambient temperature sensor (°F) was queried. More...
 
virtual bool getEventAmbientTempF (sensors_event_t *AmbientTempFEvent)
 Helper function to obtain a sensor's ambient temperature value in °F. Requires getEventAmbientTemp() to be fully implemented by a driver. More...
 
virtual long getSensorObjectTempFPeriod ()
 Base implementation - Returns the object temperature (°F) sensor's period, if set. More...
 
virtual long getSensorObjectTempFPeriodPrv ()
 Base implementation - Returns the previous time interval at which the object temperature sensor (°F) was queried last. More...
 
virtual void setSensorObjectTempFPeriodPrv (long period)
 Sets a timestamp for when the object temperature sensor (°F) was queried. More...
 
virtual bool getEventObjectTempF (sensors_event_t *objectTempFEvent)
 Helper function to obtain a sensor's object temperature value in °F. Requires getEventObjectTemp() to be fully implemented by a driver. More...
 
virtual long getSensorGasResistancePeriod ()
 Base implementation - Returns the gas resistance (ohms) sensor's period, if set. More...
 
virtual long getSensorGasResistancePeriodPrv ()
 Base implementation - Returns the previous time interval at which the gas resistance sensor (ohms) was queried last. More...
 
virtual void setSensorGasResistancePeriodPrv (long period)
 Sets a timestamp for when the object gas resistance sensor was queried. More...
 
virtual bool getEventGasResistance (sensors_event_t *gasEvent)
 Base implementation - Reads a gas resistance sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorNOxIndexPeriod ()
 Base implementation - Returns the NOx Index sensor's period, if set. More...
 
virtual long getSensorNOxIndexPeriodPrv ()
 Base implementation - Returns the previous time interval at which the NOx Index sensor was queried last. More...
 
virtual void setSensorNOxIndexPeriodPrv (long period)
 Sets a timestamp for when the object NOx Index sensor was queried. More...
 
virtual long getSensorVOCIndexPeriod ()
 Base implementation - Returns the VOC Index sensor's period, if set. More...
 
virtual long getSensorVOCIndexPeriodPrv ()
 Base implementation - Returns the previous time interval at which the VOC Index sensor was queried last. More...
 
virtual void setSensorVOCIndexPeriodPrv (long period)
 Sets a timestamp for when the object VOC Index sensor was queried. More...
 
+virtual void enableSensorProximity ()
 Enables the device's proximity sensor, if it exists.
 
+virtual void disableSensorProximity ()
 Disables the device's object proximity sensor, if it exists.
 
virtual long sensorProximityPeriod ()
 Base implementation - Returns the proximity sensor's period, if set. More...
 
virtual void setSensorProximityPeriod (long period)
 Set the proximity sensor's return frequency. More...
 
virtual long SensorProximityPeriodPrv ()
 Base implementation - Returns the previous time interval at which the proximity sensor was queried last. More...
 
virtual void setSensorProximityPeriodPrv (long period)
 Sets a timestamp for when the proximity sensor was queried. More...
 
virtual bool getEventProximity (sensors_event_t *proximityEvent)
 Base implementation - Reads a proximity sensor and converts the reading into the expected SI unit. More...
 
virtual void updateSensorProximity (float period)
 Updates the properties of a proximity sensor. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+SensirionI2cSen66 * _sen
 SEN6X driver object.
 
- Protected Attributes inherited from WipperSnapper_I2C_Driver
+TwoWire * _i2c
 Pointer to the I2C driver's Wire object.
 
+uint16_t _sensorAddress
 The I2C driver's unique I2C address.
 
long _tempSensorPeriod
 The time period between reading the temperature sensor's value. More...
 
long _tempSensorPeriodPrv
 
long _humidSensorPeriod
 The time period between reading the humidity sensor's value. More...
 
long _humidSensorPeriodPrv
 
long _pressureSensorPeriod
 The time period between reading the pressure sensor's value. More...
 
long _pressureSensorPeriodPrv
 
long _CO2SensorPeriod
 The time period between reading the CO2 sensor's value. More...
 
long _CO2SensorPeriodPrv
 The time when the CO2 sensor was last read. More...
 
long _ECO2SensorPeriod
 The time period between reading the eCO2 sensor's value. More...
 
long _ECO2SensorPeriodPrv
 The time when the eCO2 sensor was last read. More...
 
long _TVOCSensorPeriod
 The time period between reading the TVOC sensor's value. More...
 
long _TVOCSensorPeriodPrv
 The time when the TVOC sensor was last read. More...
 
long _altitudeSensorPeriod
 The time period between reading the altitude sensor's value. More...
 
long _altitudeSensorPeriodPrv
 
long _objectTempSensorPeriod = 0L
 
long _objectTempSensorPeriodPrv
 
long _lightSensorPeriod
 The time period between reading the light sensor's value. More...
 
long _lightSensorPeriodPrv
 
long _PM10SensorPeriod
 The time period between reading the pm25 sensor's value. More...
 
long _PM10SensorPeriodPrv
 The time when the pm25 sensor was last read. More...
 
long _PM25SensorPeriod
 The time period between reading the pm25 sensor's value. More...
 
long _PM25SensorPeriodPrv
 The time when the pm25 sensor was last read. More...
 
long _PM100SensorPeriod
 The time period between reading the pm100_std sensor's value. More...
 
long _PM100SensorPeriodPrv
 
long _unitlessPercentPeriod
 The time period between reading the unitless % sensor's value. More...
 
long _unitlessPercentPeriodPrv
 
long _voltagePeriod
 The time period between reading the voltage sensor's value. More...
 
long _voltagePeriodPrv
 
long _currentPeriod
 The time period between reading the current sensor's value. More...
 
long _currentPeriodPrv
 
long _rawSensorPeriod
 The time period between reading the Raw sensor's value. More...
 
long _rawSensorPeriodPrv
 The time when the Raw sensor was last read. More...
 
long _ambientTempFPeriod = 0L
 
long _ambientTempFPeriodPrv
 
long _objectTempFPeriod = 0L
 
long _objectTempFPeriodPrv
 
long _gasResistancePeriod = 0L
 
long _gasResistancePeriodPrv
 
long _NOxIndexPeriod
 The time period between reading the NOx Index sensor's value. More...
 
long _NOxIndexPeriodPrv
 
long _VOCIndexPeriod
 The time period between reading the VOC Index sensor's value. More...
 
long _VOCIndexPeriodPrv
 
long _proximitySensorPeriod
 The time period between reading the proximity sensor's value. More...
 
long _proximitySensorPeriodPrv
 
+

Detailed Description

+

Class that provides a driver interface for the SEN6X sensor.

+

Constructor & Destructor Documentation

+ +

◆ WipperSnapper_I2C_Driver_SEN6X()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
WipperSnapper_I2C_Driver_SEN6X::WipperSnapper_I2C_Driver_SEN6X (TwoWire * i2c,
uint16_t sensorAddress 
)
+ 		+inline
+
+ +

Constructor for a SEN6X sensor.

+
Parameters
+ + + +
i2cThe I2C interface.
sensorAddress7-bit device address.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ begin()

+ +
+
+ + + + + +
+ + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::begin ()
+ 		+inline
+
+ +

Initializes the SEN6X sensor and begins I2C.

+
Returns
True if initialized successfully, False otherwise.
+ +
+
+ +

◆ getEventAmbientTemp()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventAmbientTemp (sensors_event_t * tempEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X's current temperature.

+
Parameters
+ + +
tempEventPointer to an Adafruit_Sensor event.
+
+
+
Returns
True if the temperature was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventRelativeHumidity()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventRelativeHumidity (sensors_event_t * humidEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X's current relative humidity reading.

+
Parameters
+ + +
humidEventPointer to an Adafruit_Sensor event.
+
+
+
Returns
True if the humidity was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventNOxIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventNOxIndex (sensors_event_t * noxIndexEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X's current NOX reading. Note: If this value is unknown, which is true for SEN54, NAN is returned. During the first 10..11 seconds after power-on or device reset, this value will be NAN as well.

+
Parameters
+ + +
noxIndexEventAdafruit Sensor event for NOx Index (0-500, 1 is normal)
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventVOCIndex()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventVOCIndex (sensors_event_t * vocIndexEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X's current VOC reading.

+
Parameters
+ + +
vocIndexEventAdafruit Sensor event for VOC Index (1-500, 100 is normal)
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventPM10_STD()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventPM10_STD (sensors_event_t * pm10StdEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X sensor's PM1.0 STD reading.

+
Parameters
+ + +
pm10StdEventAdafruit Sensor event for PM1.0
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventPM25_STD()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventPM25_STD (sensors_event_t * pm25StdEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X sensor's PM2.5 STD reading.

+
Parameters
+ + +
pm25StdEventAdafruit Sensor event for PM2.5
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventPM40_STD()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventPM40_STD (sensors_event_t * pm40StdEvent)
+ 		+inline
+
+ +

Gets the SEN6X sensor's PM4.0 STD reading.

+
Parameters
+ + +
pm40StdEventAdafruit Sensor event for PM4.0
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +
+
+ +

◆ getEventPM100_STD()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventPM100_STD (sensors_event_t * pm100StdEvent)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X sensor's PM10.0 STD reading.

+
Parameters
+ + +
pm100StdEventAdafruit Sensor event for PM10.0
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventCO2()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_SEN6X::getEventCO2 (sensors_event_t * co2Event)
+ 		+inlinevirtual
+
+ +

Gets the SEN6X sensor's CO2 reading.

+
Parameters
+ + +
co2EventAdafruit Sensor event for CO2
+
+
+
Returns
True if the sensor value was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.png b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.png new file mode 100644 index 000000000..1ab7b700c Binary files /dev/null and b/html/class_wipper_snapper___i2_c___driver___s_e_n6_x.png differ diff --git a/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200-members.html b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200-members.html new file mode 100644 index 000000000..a8833c1d0 --- /dev/null +++ b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200-members.html @@ -0,0 +1,224 @@ + + + + + + + +Adafruit Library: Member List + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
WipperSnapper_I2C_Driver_VCNL4200 Member List
+
+
+ +

This is the complete list of members for WipperSnapper_I2C_Driver_VCNL4200, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
_altitudeSensorPeriodWipperSnapper_I2C_Driverprotected
_altitudeSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_ambientTempFPeriodWipperSnapper_I2C_Driverprotected
_ambientTempFPeriodPrvWipperSnapper_I2C_Driverprotected
_CO2SensorPeriodWipperSnapper_I2C_Driverprotected
_CO2SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_currentPeriodWipperSnapper_I2C_Driverprotected
_currentPeriodPrvWipperSnapper_I2C_Driverprotected
_ECO2SensorPeriodWipperSnapper_I2C_Driverprotected
_ECO2SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_gasResistancePeriodWipperSnapper_I2C_Driverprotected
_gasResistancePeriodPrvWipperSnapper_I2C_Driverprotected
_humidSensorPeriodWipperSnapper_I2C_Driverprotected
_humidSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_i2cWipperSnapper_I2C_Driverprotected
_lightSensorPeriodWipperSnapper_I2C_Driverprotected
_lightSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_NOxIndexPeriodWipperSnapper_I2C_Driverprotected
_NOxIndexPeriodPrvWipperSnapper_I2C_Driverprotected
_objectTempFPeriodWipperSnapper_I2C_Driverprotected
_objectTempFPeriodPrvWipperSnapper_I2C_Driverprotected
_objectTempSensorPeriodWipperSnapper_I2C_Driverprotected
_objectTempSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM100SensorPeriodWipperSnapper_I2C_Driverprotected
_PM100SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM10SensorPeriodWipperSnapper_I2C_Driverprotected
_PM10SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_PM25SensorPeriodWipperSnapper_I2C_Driverprotected
_PM25SensorPeriodPrvWipperSnapper_I2C_Driverprotected
_pressureSensorPeriodWipperSnapper_I2C_Driverprotected
_pressureSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_proximitySensorPeriodWipperSnapper_I2C_Driverprotected
_proximitySensorPeriodPrvWipperSnapper_I2C_Driverprotected
_rawSensorPeriodWipperSnapper_I2C_Driverprotected
_rawSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_sensorAddressWipperSnapper_I2C_Driverprotected
_tempSensorPeriodWipperSnapper_I2C_Driverprotected
_tempSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_TVOCSensorPeriodWipperSnapper_I2C_Driverprotected
_TVOCSensorPeriodPrvWipperSnapper_I2C_Driverprotected
_unitlessPercentPeriodWipperSnapper_I2C_Driverprotected
_unitlessPercentPeriodPrvWipperSnapper_I2C_Driverprotected
_vcnl4200WipperSnapper_I2C_Driver_VCNL4200protected
_VOCIndexPeriodWipperSnapper_I2C_Driverprotected
_VOCIndexPeriodPrvWipperSnapper_I2C_Driverprotected
_voltagePeriodWipperSnapper_I2C_Driverprotected
_voltagePeriodPrvWipperSnapper_I2C_Driverprotected
begin()WipperSnapper_I2C_Driver_VCNL4200inline
configureDriver(wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq)WipperSnapper_I2C_Driverinline
disableAmbientTempF()WipperSnapper_I2C_Driverinlinevirtual
disableSensorProximity()WipperSnapper_I2C_Driverinlinevirtual
enableSensorProximity()WipperSnapper_I2C_Driverinlinevirtual
getEventAltitude(sensors_event_t *altitudeEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventAmbientTemp(sensors_event_t *tempEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventAmbientTempF(sensors_event_t *AmbientTempFEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventCO2(sensors_event_t *co2Event)WipperSnapper_I2C_Driverinlinevirtual
getEventCurrent(sensors_event_t *currentEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventECO2(sensors_event_t *eco2Event)WipperSnapper_I2C_Driverinlinevirtual
getEventGasResistance(sensors_event_t *gasEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventLight(sensors_event_t *lightEvent)WipperSnapper_I2C_Driver_VCNL4200inlinevirtual
getEventNOxIndex(sensors_event_t *gasEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventObjectTemp(sensors_event_t *objectTempEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventObjectTempF(sensors_event_t *objectTempFEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventPM100_STD(sensors_event_t *pm100StdEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventPM10_STD(sensors_event_t *pm10StdEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventPM25_STD(sensors_event_t *pm25StdEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventPressure(sensors_event_t *pressureEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventProximity(sensors_event_t *proximityEvent)WipperSnapper_I2C_Driver_VCNL4200inlinevirtual
getEventRaw(sensors_event_t *rawEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventRelativeHumidity(sensors_event_t *humidEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventTVOC(sensors_event_t *tvocEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventUnitlessPercent(sensors_event_t *unitlessPercentEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventVOCIndex(sensors_event_t *gasEvent)WipperSnapper_I2C_Driverinlinevirtual
getEventVoltage(sensors_event_t *voltageEvent)WipperSnapper_I2C_Driverinlinevirtual
getI2CAddress()WipperSnapper_I2C_Driverinline
getSensorAltitudePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAltitudePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempFPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempFPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorAmbientTempPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorCO2Period()WipperSnapper_I2C_Driverinlinevirtual
getSensorCO2PeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorCurrentPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorCurrentPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorECO2Period()WipperSnapper_I2C_Driverinlinevirtual
getSensorECO2PeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorGasResistancePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorGasResistancePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorLightPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorLightPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorNOxIndexPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorNOxIndexPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempFPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempFPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorObjectTempPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM100_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM100_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM10_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM10_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM25_STDPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPM25_STDPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorPressurePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorPressurePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorRawPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorRawPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorRelativeHumidityPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorRelativeHumidityPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorTVOCPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorTVOCPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorUnitlessPercentPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorUnitlessPercentPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorVOCIndexPeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorVOCIndexPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
getSensorVoltagePeriod()WipperSnapper_I2C_Driverinlinevirtual
getSensorVoltagePeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
sensorProximityPeriod()WipperSnapper_I2C_Driverinlinevirtual
SensorProximityPeriodPrv()WipperSnapper_I2C_Driverinlinevirtual
setSensorAltitudePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorAmbientTempFPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorAmbientTempPeriodPrv(long periodPrv)WipperSnapper_I2C_Driverinlinevirtual
setSensorCO2PeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorCurrentPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorECO2PeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorGasResistancePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorLightPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorNOxIndexPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorObjectTempFPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorObjectTempPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPeriod(float period, wippersnapper_i2c_v1_SensorType sensorType)WipperSnapper_I2C_Driverinline
setSensorPM100_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPM10_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPM25_STDPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorPressurePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorProximityPeriod(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorProximityPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorRawPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorRelativeHumidityPeriodPrv(long periodPrv)WipperSnapper_I2C_Driverinlinevirtual
setSensorTVOCPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorUnitlessPercentPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorVOCIndexPeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
setSensorVoltagePeriodPrv(long period)WipperSnapper_I2C_Driverinlinevirtual
updateSensorProximity(float period)WipperSnapper_I2C_Driverinlinevirtual
WipperSnapper_I2C_Driver(TwoWire *i2c, uint16_t sensorAddress)WipperSnapper_I2C_Driverinline
WipperSnapper_I2C_Driver_VCNL4200(TwoWire *i2c, uint16_t sensorAddress)WipperSnapper_I2C_Driver_VCNL4200inline
~WipperSnapper_I2C_Driver()WipperSnapper_I2C_Driverinlinevirtual
~WipperSnapper_I2C_Driver_VCNL4200()WipperSnapper_I2C_Driver_VCNL4200inline
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.html b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.html new file mode 100644 index 000000000..819d26812 --- /dev/null +++ b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.html @@ -0,0 +1,689 @@ + + + + + + + +Adafruit Library: WipperSnapper_I2C_Driver_VCNL4200 Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Adafruit Library +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
WipperSnapper_I2C_Driver_VCNL4200 Class Reference
+
+
+ +

Class that provides a driver interface for a VCNL4200 sensor. + More...

+ +

#include <WipperSnapper_I2C_Driver_VCNL4200.h>

+
+Inheritance diagram for WipperSnapper_I2C_Driver_VCNL4200:
+
+
+ + +WipperSnapper_I2C_Driver + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 WipperSnapper_I2C_Driver_VCNL4200 (TwoWire *i2c, uint16_t sensorAddress)
 Constructor for a VCNL4200 sensor. More...
 
+ ~WipperSnapper_I2C_Driver_VCNL4200 ()
 Destructor for an VCNL4200 sensor.
 
bool begin ()
 Initializes the VCNL4200 sensor and begins I2C. More...
 
bool getEventLight (sensors_event_t *lightEvent)
 Performs a light sensor read using the Adafruit Unified Sensor API. More...
 
bool getEventProximity (sensors_event_t *proximityEvent)
 Reads the VCNL4200's proximity value into an event (no unit). More...
 
- Public Member Functions inherited from WipperSnapper_I2C_Driver
 WipperSnapper_I2C_Driver (TwoWire *i2c, uint16_t sensorAddress)
 Instanciates an I2C sensor. More...
 
+virtual ~WipperSnapper_I2C_Driver ()
 Destructor for an I2C sensor.
 
bool begin ()
 Initializes the I2C sensor and begins I2C. More...
 
void setSensorPeriod (float period, wippersnapper_i2c_v1_SensorType sensorType)
 Sets the sensor's period, provided a wippersnapper_i2c_v1_SensorType. More...
 
void configureDriver (wippersnapper_i2c_v1_I2CDeviceInitRequest *msgDeviceInitReq)
 Uses an I2CDeviceInitRequest message to configure the sensors belonging to the driver. More...
 
uint16_t getI2CAddress ()
 Gets the I2C device's address. More...
 
virtual long getSensorCO2Period ()
 Base implementation - Returns the co2 sensor's period, if set. More...
 
virtual long getSensorCO2PeriodPrv ()
 Base implementation - Returns the previous time interval at which the co2 sensor was queried last. More...
 
virtual void setSensorCO2PeriodPrv (long period)
 Sets a timestamp for when the co2 sensor was queried. More...
 
virtual bool getEventCO2 (sensors_event_t *co2Event)
 Gets a sensor's CO2 value. More...
 
virtual long getSensorECO2Period ()
 Base implementation - Returns the eCO2 sensor's period, if set. More...
 
virtual long getSensorECO2PeriodPrv ()
 Base implementation - Returns the previous time interval at which the eCO2 sensor was queried last. More...
 
virtual void setSensorECO2PeriodPrv (long period)
 Sets a timestamp for when the eCO2 sensor was queried. More...
 
virtual bool getEventECO2 (sensors_event_t *eco2Event)
 Gets a sensor's eCO2 value. More...
 
virtual long getSensorTVOCPeriod ()
 Base implementation - Returns the TVOC sensor's period, if set. More...
 
virtual long getSensorTVOCPeriodPrv ()
 Base implementation - Returns the previous time interval at which the TVOC sensor was queried last. More...
 
virtual void setSensorTVOCPeriodPrv (long period)
 Sets a timestamp for when the TVOC sensor was queried. More...
 
virtual bool getEventTVOC (sensors_event_t *tvocEvent)
 Gets a sensor's TVOC value. More...
 
virtual long getSensorAmbientTempPeriod ()
 Base implementation - Returns the ambient temperature (°C) sensor's period, if set. More...
 
virtual long getSensorAmbientTempPeriodPrv ()
 Base implementation - Returns the previous time interval at which the ambient temperature sensor (°C) was queried last. More...
 
virtual void setSensorAmbientTempPeriodPrv (long periodPrv)
 Sets a timestamp for when the ambient temperature sensor (°C) was queried. More...
 
virtual bool getEventAmbientTemp (sensors_event_t *tempEvent)
 Base implementation - Reads an ambient temperature sensor (°C). Expects value to return in the proper SI unit. More...
 
virtual long getSensorRelativeHumidityPeriod ()
 Base implementation - Returns the humidity sensor's period, if set. More...
 
virtual long getSensorRelativeHumidityPeriodPrv ()
 Base implementation - Returns the previous time interval at which the humidity sensor was queried last. More...
 
virtual void setSensorRelativeHumidityPeriodPrv (long periodPrv)
 Sets a timestamp for when the temperature sensor was queried. More...
 
virtual bool getEventRelativeHumidity (sensors_event_t *humidEvent)
 Base implementation - Reads a humidity sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorPressurePeriod ()
 Base implementation - Returns the pressure sensor's period, if set. More...
 
virtual long getSensorPressurePeriodPrv ()
 Base implementation - Returns the previous time interval at which the pressure sensor was queried last. More...
 
virtual void setSensorPressurePeriodPrv (long period)
 Sets a timestamp for when the pressure sensor was queried. More...
 
virtual bool getEventPressure (sensors_event_t *pressureEvent)
 Base implementation - Reads a pressure sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorAltitudePeriod ()
 Base implementation - Returns the Altitude sensor's period, if set. More...
 
virtual long getSensorAltitudePeriodPrv ()
 Base implementation - Returns the previous time interval at which the Altitude sensor was queried last. More...
 
virtual void setSensorAltitudePeriodPrv (long period)
 Sets a timestamp for when the Altitude sensor was queried. More...
 
virtual bool getEventAltitude (sensors_event_t *altitudeEvent)
 Base implementation - Reads a Altitude sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorObjectTempPeriod ()
 Base implementation - Returns the object temperature sensor's period, if set. More...
 
virtual long getSensorObjectTempPeriodPrv ()
 Base implementation - Returns the previous time interval at which the object temperature sensor was queried last. More...
 
virtual void setSensorObjectTempPeriodPrv (long period)
 Sets a timestamp for when the object temperature sensor was queried. More...
 
virtual bool getEventObjectTemp (sensors_event_t *objectTempEvent)
 Base implementation - Reads a object temperature sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorLightPeriod ()
 Base implementation - Returns the object light sensor's period, if set. More...
 
virtual long getSensorLightPeriodPrv ()
 Base implementation - Returns the previous time interval at which the light sensor was queried last. More...
 
virtual void setSensorLightPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual long getSensorPM10_STDPeriod ()
 Base implementation - Returns the object pm10 standard sensors' period, if set. More...
 
virtual long getSensorPM10_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm10 std. sensor was queried last. More...
 
virtual void setSensorPM10_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual bool getEventPM10_STD (sensors_event_t *pm10StdEvent)
 Base implementation - Reads a object pm10 std. sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorPM25_STDPeriod ()
 Base implementation - Returns the object pm25 standard sensors' period, if set. More...
 
virtual long getSensorPM25_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm25 std. sensor was queried last. More...
 
virtual void setSensorPM25_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual bool getEventPM25_STD (sensors_event_t *pm25StdEvent)
 Base implementation - Reads a object pm25 std. sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorPM100_STDPeriod ()
 Base implementation - Returns the object pm100 standard sensors' period, if set. More...
 
virtual long getSensorPM100_STDPeriodPrv ()
 Base implementation - Returns the previous time interval at which the pm100 std. sensor was queried last. More...
 
virtual void setSensorPM100_STDPeriodPrv (long period)
 Sets a timestamp for when the light sensor was queried. More...
 
virtual bool getEventPM100_STD (sensors_event_t *pm100StdEvent)
 Base implementation - Reads a object pm100 std. sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorUnitlessPercentPeriod ()
 Base implementation - Returns the object unitless % sensor period, if set. More...
 
virtual long getSensorUnitlessPercentPeriodPrv ()
 Base implementation - Returns the previous time interval at which the unitless % sensor was queried last. More...
 
virtual void setSensorUnitlessPercentPeriodPrv (long period)
 Sets a timestamp for when the unitless % sensor was queried. More...
 
virtual bool getEventUnitlessPercent (sensors_event_t *unitlessPercentEvent)
 Base implementation - Reads a object unitless % std. sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorVoltagePeriod ()
 Base implementation - Returns the voltage sensor's period. More...
 
virtual long getSensorVoltagePeriodPrv ()
 Base implementation - Returns the previous time interval at which the voltage sensor was queried last. More...
 
virtual void setSensorVoltagePeriodPrv (long period)
 Sets a timestamp for when the voltage sensor was queried. More...
 
virtual bool getEventVoltage (sensors_event_t *voltageEvent)
 Base implementation - Reads a voltage sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorCurrentPeriod ()
 Base implementation - Returns the current sensor's period. More...
 
virtual long getSensorCurrentPeriodPrv ()
 Base implementation - Returns the previous time interval at which the current sensor was queried last. More...
 
virtual void setSensorCurrentPeriodPrv (long period)
 Sets a timestamp for when the current sensor was queried. More...
 
virtual bool getEventCurrent (sensors_event_t *currentEvent)
 Base implementation - Reads a current sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorRawPeriod ()
 Base implementation - Returns the raw sensor's period, if set. More...
 
virtual long getSensorRawPeriodPrv ()
 Base implementation - Returns the previous time interval at which the raw sensor was queried last. More...
 
virtual void setSensorRawPeriodPrv (long period)
 Sets a timestamp for when the raw sensor was queried. More...
 
virtual bool getEventRaw (sensors_event_t *rawEvent)
 Gets a sensor's Raw value. More...
 
+virtual void disableAmbientTempF ()
 Disables the device's ambient temperature (°F) sensor, if it exists.
 
virtual long getSensorAmbientTempFPeriod ()
 Base implementation - Returns the ambient temperature (°F) sensor's period, if set. More...
 
virtual long getSensorAmbientTempFPeriodPrv ()
 Base implementation - Returns the previous time interval at which the ambient temperature sensor (°F) was queried last. More...
 
virtual void setSensorAmbientTempFPeriodPrv (long period)
 Sets a timestamp for when the ambient temperature sensor (°F) was queried. More...
 
virtual bool getEventAmbientTempF (sensors_event_t *AmbientTempFEvent)
 Helper function to obtain a sensor's ambient temperature value in °F. Requires getEventAmbientTemp() to be fully implemented by a driver. More...
 
virtual long getSensorObjectTempFPeriod ()
 Base implementation - Returns the object temperature (°F) sensor's period, if set. More...
 
virtual long getSensorObjectTempFPeriodPrv ()
 Base implementation - Returns the previous time interval at which the object temperature sensor (°F) was queried last. More...
 
virtual void setSensorObjectTempFPeriodPrv (long period)
 Sets a timestamp for when the object temperature sensor (°F) was queried. More...
 
virtual bool getEventObjectTempF (sensors_event_t *objectTempFEvent)
 Helper function to obtain a sensor's object temperature value in °F. Requires getEventObjectTemp() to be fully implemented by a driver. More...
 
virtual long getSensorGasResistancePeriod ()
 Base implementation - Returns the gas resistance (ohms) sensor's period, if set. More...
 
virtual long getSensorGasResistancePeriodPrv ()
 Base implementation - Returns the previous time interval at which the gas resistance sensor (ohms) was queried last. More...
 
virtual void setSensorGasResistancePeriodPrv (long period)
 Sets a timestamp for when the object gas resistance sensor was queried. More...
 
virtual bool getEventGasResistance (sensors_event_t *gasEvent)
 Base implementation - Reads a gas resistance sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorNOxIndexPeriod ()
 Base implementation - Returns the NOx Index sensor's period, if set. More...
 
virtual long getSensorNOxIndexPeriodPrv ()
 Base implementation - Returns the previous time interval at which the NOx Index sensor was queried last. More...
 
virtual void setSensorNOxIndexPeriodPrv (long period)
 Sets a timestamp for when the object NOx Index sensor was queried. More...
 
virtual bool getEventNOxIndex (sensors_event_t *gasEvent)
 Base implementation - Reads a NOx Index sensor and converts the reading into the expected SI unit. More...
 
virtual long getSensorVOCIndexPeriod ()
 Base implementation - Returns the VOC Index sensor's period, if set. More...
 
virtual long getSensorVOCIndexPeriodPrv ()
 Base implementation - Returns the previous time interval at which the VOC Index sensor was queried last. More...
 
virtual void setSensorVOCIndexPeriodPrv (long period)
 Sets a timestamp for when the object VOC Index sensor was queried. More...
 
virtual bool getEventVOCIndex (sensors_event_t *gasEvent)
 Base implementation - Reads a VOC Index sensor and converts the reading into the expected SI unit. More...
 
+virtual void enableSensorProximity ()
 Enables the device's proximity sensor, if it exists.
 
+virtual void disableSensorProximity ()
 Disables the device's object proximity sensor, if it exists.
 
virtual long sensorProximityPeriod ()
 Base implementation - Returns the proximity sensor's period, if set. More...
 
virtual void setSensorProximityPeriod (long period)
 Set the proximity sensor's return frequency. More...
 
virtual long SensorProximityPeriodPrv ()
 Base implementation - Returns the previous time interval at which the proximity sensor was queried last. More...
 
virtual void setSensorProximityPeriodPrv (long period)
 Sets a timestamp for when the proximity sensor was queried. More...
 
virtual void updateSensorProximity (float period)
 Updates the properties of a proximity sensor. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+Adafruit_VCNL4200 * _vcnl4200
 Pointer to VCNL4200 light sensor object.
 
- Protected Attributes inherited from WipperSnapper_I2C_Driver
+TwoWire * _i2c
 Pointer to the I2C driver's Wire object.
 
+uint16_t _sensorAddress
 The I2C driver's unique I2C address.
 
long _tempSensorPeriod
 The time period between reading the temperature sensor's value. More...
 
long _tempSensorPeriodPrv
 
long _humidSensorPeriod
 The time period between reading the humidity sensor's value. More...
 
long _humidSensorPeriodPrv
 
long _pressureSensorPeriod
 The time period between reading the pressure sensor's value. More...
 
long _pressureSensorPeriodPrv
 
long _CO2SensorPeriod
 The time period between reading the CO2 sensor's value. More...
 
long _CO2SensorPeriodPrv
 The time when the CO2 sensor was last read. More...
 
long _ECO2SensorPeriod
 The time period between reading the eCO2 sensor's value. More...
 
long _ECO2SensorPeriodPrv
 The time when the eCO2 sensor was last read. More...
 
long _TVOCSensorPeriod
 The time period between reading the TVOC sensor's value. More...
 
long _TVOCSensorPeriodPrv
 The time when the TVOC sensor was last read. More...
 
long _altitudeSensorPeriod
 The time period between reading the altitude sensor's value. More...
 
long _altitudeSensorPeriodPrv
 
long _objectTempSensorPeriod = 0L
 
long _objectTempSensorPeriodPrv
 
long _lightSensorPeriod
 The time period between reading the light sensor's value. More...
 
long _lightSensorPeriodPrv
 
long _PM10SensorPeriod
 The time period between reading the pm25 sensor's value. More...
 
long _PM10SensorPeriodPrv
 The time when the pm25 sensor was last read. More...
 
long _PM25SensorPeriod
 The time period between reading the pm25 sensor's value. More...
 
long _PM25SensorPeriodPrv
 The time when the pm25 sensor was last read. More...
 
long _PM100SensorPeriod
 The time period between reading the pm100_std sensor's value. More...
 
long _PM100SensorPeriodPrv
 
long _unitlessPercentPeriod
 The time period between reading the unitless % sensor's value. More...
 
long _unitlessPercentPeriodPrv
 
long _voltagePeriod
 The time period between reading the voltage sensor's value. More...
 
long _voltagePeriodPrv
 
long _currentPeriod
 The time period between reading the current sensor's value. More...
 
long _currentPeriodPrv
 
long _rawSensorPeriod
 The time period between reading the Raw sensor's value. More...
 
long _rawSensorPeriodPrv
 The time when the Raw sensor was last read. More...
 
long _ambientTempFPeriod = 0L
 
long _ambientTempFPeriodPrv
 
long _objectTempFPeriod = 0L
 
long _objectTempFPeriodPrv
 
long _gasResistancePeriod = 0L
 
long _gasResistancePeriodPrv
 
long _NOxIndexPeriod
 The time period between reading the NOx Index sensor's value. More...
 
long _NOxIndexPeriodPrv
 
long _VOCIndexPeriod
 The time period between reading the VOC Index sensor's value. More...
 
long _VOCIndexPeriodPrv
 
long _proximitySensorPeriod
 The time period between reading the proximity sensor's value. More...
 
long _proximitySensorPeriodPrv
 
+

Detailed Description

+

Class that provides a driver interface for a VCNL4200 sensor.

+

Constructor & Destructor Documentation

+ +

◆ WipperSnapper_I2C_Driver_VCNL4200()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
WipperSnapper_I2C_Driver_VCNL4200::WipperSnapper_I2C_Driver_VCNL4200 (TwoWire * i2c,
uint16_t sensorAddress 
)
+ 		+inline
+
+ +

Constructor for a VCNL4200 sensor.

+
Parameters
+ + + +
i2cThe I2C interface.
sensorAddressThe 7-bit I2C address of the sensor.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ begin()

+ +
+
+ + + + + +
+ + + + + + + +
bool WipperSnapper_I2C_Driver_VCNL4200::begin ()
+ 		+inline
+
+ +

Initializes the VCNL4200 sensor and begins I2C.

+
Returns
True if initialized successfully, False otherwise.
+ +
+
+ +

◆ getEventLight()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_VCNL4200::getEventLight (sensors_event_t * lightEvent)
+ 		+inlinevirtual
+
+ +

Performs a light sensor read using the Adafruit Unified Sensor API.

+
Parameters
+ + +
lightEventLight sensor reading, in lux.
+
+
+
Returns
True if the sensor event was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+ +

◆ getEventProximity()

+ +
+
+ + + + + +
+ + + + + + + + +
bool WipperSnapper_I2C_Driver_VCNL4200::getEventProximity (sensors_event_t * proximityEvent)
+ 		+inlinevirtual
+
+ +

Reads the VCNL4200's proximity value into an event (no unit).

+
Parameters
+ + +
proximityEventPointer to an Adafruit_Sensor event.
+
+
+
Returns
True if the proximity was obtained successfully, False otherwise.
+ +

Reimplemented from WipperSnapper_I2C_Driver.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.png b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.png new file mode 100644 index 000000000..0dab927da Binary files /dev/null and b/html/class_wipper_snapper___i2_c___driver___v_c_n_l4200.png differ diff --git a/html/class_wippersnapper-members.html b/html/class_wippersnapper-members.html index 6d312fd69..85582ec9c 100644 --- a/html/class_wippersnapper-members.html +++ b/html/class_wippersnapper-members.html @@ -150,7 +150,7 @@ getBoardStatus()Wippersnapper getMacAddr()Wippersnappervirtual getRSSI()Wippersnappervirtual - haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)Wippersnapper + haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25)Wippersnapper i2cComponentsWippersnapper lockStatusDotStarWippersnapper lockStatusLEDWippersnapper diff --git a/html/class_wippersnapper.html b/html/class_wippersnapper.html index d630c9706..299d72f90 100644 --- a/html/class_wippersnapper.html +++ b/html/class_wippersnapper.html @@ -78,9 +78,8 @@
-Wippersnapper_AIRLIFT -Wippersnapper_ESP32 -Wippersnapper_WIFININA +Wippersnapper_AIRLIFT +Wippersnapper_ESP32
@@ -190,9 +189,9 @@ void  - - - + + + @@ -465,7 +464,7 @@

Wippersnapper_WIFININA, Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

+

Reimplemented in Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

@@ -495,7 +494,7 @@

Returns
True if _network_ssid is found, False otherwise.
-

Reimplemented in Wippersnapper_WIFININA, Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

+

Reimplemented in Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

@@ -525,7 +524,7 @@

Returns
int32_t RSSI value, 0 to 255, in dB
-

Reimplemented in Wippersnapper_AIRLIFT, Wippersnapper_WIFININA, and Wippersnapper_ESP32.

+

Reimplemented in Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

@@ -561,7 +560,7 @@

Wippersnapper_AIRLIFT, Wippersnapper_WIFININA, and Wippersnapper_ESP32.

+

Reimplemented in Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

@@ -591,7 +590,7 @@

Returns
Network status as ws_status_t.
-

Reimplemented in Wippersnapper_AIRLIFT, Wippersnapper_WIFININA, and Wippersnapper_ESP32.

+

Reimplemented in Wippersnapper_AIRLIFT, and Wippersnapper_ESP32.

@@ -870,8 +869,8 @@

-

◆ haltError()

+ +

◆ haltError()

@@ -886,7 +885,13 @@

- + + + + + + + @@ -899,8 +904,9 @@

Parameters

feedWDT ()
 Feeds the WDT to prevent hardware reset.
 
void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)
 Prints an error to the serial and halts the hardware until the WDT bites. More...
 
void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25)
 Prints an error to the serial and halts the hardware until the WDT bites. More...
 
void errorWriteHang (String error)
 Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern and hangs. More...
 
ws_led_status_t ledStatusColor = WS_LED_STATUS_ERROR_RUNTIME ledStatusColor = WS_LED_STATUS_ERROR_RUNTIME,
uint8_t seconds_until_reboot = 25 
- - + + +
errorThe desired error to print to serial.
ledStatusColorThe desired color to blink.
errorThe error to print to serial.
ledStatusColorThe color to blink.
seconds_until_rebootThe amount of time to wait before rebooting.
diff --git a/html/class_wippersnapper.png b/html/class_wippersnapper.png index b71383f4b..96d9e3f23 100644 Binary files a/html/class_wippersnapper.png and b/html/class_wippersnapper.png differ diff --git a/html/class_wippersnapper___a_i_r_l_i_f_t-members.html b/html/class_wippersnapper___a_i_r_l_i_f_t-members.html index f70ad1117..3daeb49d8 100644 --- a/html/class_wippersnapper___a_i_r_l_i_f_t-members.html +++ b/html/class_wippersnapper___a_i_r_l_i_f_t-members.html @@ -162,7 +162,7 @@ getBoardStatus()Wippersnapper getMacAddr()Wippersnapper_AIRLIFTinlinevirtual getRSSI()Wippersnapper_AIRLIFTinlinevirtual - haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)Wippersnapper + haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25)Wippersnapper i2cComponentsWippersnapper lockStatusDotStarWippersnapper lockStatusLEDWippersnapper diff --git a/html/class_wippersnapper___a_i_r_l_i_f_t.html b/html/class_wippersnapper___a_i_r_l_i_f_t.html index f86a3fc38..08274328f 100644 --- a/html/class_wippersnapper___a_i_r_l_i_f_t.html +++ b/html/class_wippersnapper___a_i_r_l_i_f_t.html @@ -203,9 +203,9 @@ void feedWDT ()  Feeds the WDT to prevent hardware reset.
  -void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME) - Prints an error to the serial and halts the hardware until the WDT bites. More...
-  +void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25) + Prints an error to the serial and halts the hardware until the WDT bites. More...
+  void errorWriteHang (String error)  Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern and hangs. More...
  diff --git a/html/class_wippersnapper___analog_i_o-members.html b/html/class_wippersnapper___analog_i_o-members.html index 586ab4792..af27cfaa6 100644 --- a/html/class_wippersnapper___analog_i_o-members.html +++ b/html/class_wippersnapper___analog_i_o-members.html @@ -76,7 +76,7 @@ initAnalogInputPin(int pin, float period, wippersnapper_pin_v1_ConfigurePinRequest_Pull pullMode, wippersnapper_pin_v1_ConfigurePinRequest_AnalogReadMode analogReadMode)Wippersnapper_AnalogIO setADCResolution(int resolution)Wippersnapper_AnalogIO setAref(float refVoltage)Wippersnapper_AnalogIO - timerExpired(long currentTime, analogInputPin pin)Wippersnapper_AnalogIO + timerExpired(long currentTime, analogInputPin pin, long periodOffset=0)Wippersnapper_AnalogIO update()Wippersnapper_AnalogIO Wippersnapper_AnalogIO(int32_t totalAnalogInputPins, float aRef)Wippersnapper_AnalogIO ~Wippersnapper_AnalogIO()Wippersnapper_AnalogIO diff --git a/html/class_wippersnapper___analog_i_o.html b/html/class_wippersnapper___analog_i_o.html index 4d97c5de5..6a5563a99 100644 --- a/html/class_wippersnapper___analog_i_o.html +++ b/html/class_wippersnapper___analog_i_o.html @@ -110,9 +110,9 @@ int getNativeResolution ()  Gets the device's native ADC resolution. More...
  -bool timerExpired (long currentTime, analogInputPin pin) - Checks if pin's period is expired. More...
-  +bool timerExpired (long currentTime, analogInputPin pin, long periodOffset=0) + Checks if pin's period is expired. More...
+  void update ()  Iterates thru analog inputs.
@@ -442,8 +442,8 @@

-

◆ timerExpired()

+ +

◆ timerExpired()

@@ -458,7 +458,13 @@

analogInputPin  - pin  + pin, + + + + + long  + periodOffset = 0  @@ -473,6 +479,7 @@

currentTimeThe current software timer value. pinThe desired analog pin to check + periodOffsetOffset to add to the pin's period (used for on_change). diff --git a/html/class_wippersnapper___e_s_p32-members.html b/html/class_wippersnapper___e_s_p32-members.html index cf53abfb9..1d86fd185 100644 --- a/html/class_wippersnapper___e_s_p32-members.html +++ b/html/class_wippersnapper___e_s_p32-members.html @@ -158,7 +158,7 @@ getBoardStatus()Wippersnapper getMacAddr()Wippersnapper_ESP32inlinevirtual getRSSI()Wippersnapper_ESP32inlinevirtual - haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)Wippersnapper + haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25)Wippersnapper i2cComponentsWippersnapper lockStatusDotStarWippersnapper lockStatusLEDWippersnapper diff --git a/html/class_wippersnapper___e_s_p32.html b/html/class_wippersnapper___e_s_p32.html index cbe4b56e3..3a155adfc 100644 --- a/html/class_wippersnapper___e_s_p32.html +++ b/html/class_wippersnapper___e_s_p32.html @@ -191,9 +191,9 @@ void feedWDT ()  Feeds the WDT to prevent hardware reset.
  -void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME) - Prints an error to the serial and halts the hardware until the WDT bites. More...
-  +void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME, uint8_t seconds_until_reboot=25) + Prints an error to the serial and halts the hardware until the WDT bites. More...
+  void errorWriteHang (String error)  Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern and hangs. More...
  @@ -243,8 +243,9 @@ WiFiMulti _wifiMulti  WiFiMulti object for multi-network mode.
  -const char * _aio_root_ca_staging - Root certificate for io.adafruit.us. More...
+ +const char * _aio_root_ca_staging + Root certificate for io.adafruit.us.
  const char * _aio_root_ca_prod  Root certificate for io.adafruit.com. More...
@@ -694,30 +695,6 @@

Member Data Documentation

- -

◆ _aio_root_ca_staging

- -
-
- - - - - -
- - - - -
const char* Wippersnapper_ESP32::_aio_root_ca_staging
- 		-protected
-
-Initial value:
=
"-----BEGIN CERTIFICATE-----\n"
"MIIEVzCCAj+gAwIBAgIRAIOPbGPOsTmMYgZigxXJ/d4wDQYJKoZIhvcNAQELBQAw\n"
"TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
"cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMjQwMzEzMDAwMDAw\n"
"WhcNMjcwMzEyMjM1OTU5WjAyMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNTGV0J3Mg\n"
"RW5jcnlwdDELMAkGA1UEAxMCRTUwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQNCzqK\n"
"a2GOtu/cX1jnxkJFVKtj9mZhSAouWXW0gQI3ULc/FnncmOyhKJdyIBwsz9V8UiBO\n"
"VHhbhBRrwJCuhezAUUE8Wod/Bk3U/mDR+mwt4X2VEIiiCFQPmRpM5uoKrNijgfgw\n"
"gfUwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcD\n"
"ATASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBSfK1/PPCFPnQS37SssxMZw\n"
"i9LXDTAfBgNVHSMEGDAWgBR5tFnme7bl5AFzgAiIyBpY9umbbjAyBggrBgEFBQcB\n"
"AQQmMCQwIgYIKwYBBQUHMAKGFmh0dHA6Ly94MS5pLmxlbmNyLm9yZy8wEwYDVR0g\n"
"BAwwCjAIBgZngQwBAgEwJwYDVR0fBCAwHjAcoBqgGIYWaHR0cDovL3gxLmMubGVu\n"
"Y3Iub3JnLzANBgkqhkiG9w0BAQsFAAOCAgEAH3KdNEVCQdqk0LKyuNImTKdRJY1C\n"
"2uw2SJajuhqkyGPY8C+zzsufZ+mgnhnq1A2KVQOSykOEnUbx1cy637rBAihx97r+\n"
"bcwbZM6sTDIaEriR/PLk6LKs9Be0uoVxgOKDcpG9svD33J+G9Lcfv1K9luDmSTgG\n"
"6XNFIN5vfI5gs/lMPyojEMdIzK9blcl2/1vKxO8WGCcjvsQ1nJ/Pwt8LQZBfOFyV\n"
"XP8ubAp/au3dc4EKWG9MO5zcx1qT9+NXRGdVWxGvmBFRAajciMfXME1ZuGmk3/GO\n"
"koAM7ZkjZmleyokP1LGzmfJcUd9s7eeu1/9/eg5XlXd/55GtYjAM+C4DG5i7eaNq\n"
"cm2F+yxYIPt6cbbtYVNJCGfHWqHEQ4FYStUyFnv8sjyqU8ypgZaNJ9aVcWSICLOI\n"
"E1/Qv/7oKsnZCWJ926wU6RqG1OYPGOi1zuABhLw61cuPVDT28nQS/e6z95cJXq0e\n"
"K1BcaJ6fJZsmbjRgD5p3mvEf5vdQM7MCEvU0tHbsx2I5mHHJoABHb8KVBgWp/lcX\n"
"GWiWaeOyB7RP+OfDtvi2OsapxXiV7vNVs7fMlrRjY1joKaqmmycnBvAq14AEbtyL\n"
"sVfOS66B8apkeFX2NY4XPEYV4ZSCe8VHPrdrERk2wILG3T/EGmSIkCYVUMSnjmJd\n"
"VQD9F6Na/+zmXCc=\n"
"-----END CERTIFICATE-----\n"
-

Root certificate for io.adafruit.us.

- -
-

◆ _aio_root_ca_prod

diff --git a/html/class_wippersnapper___w_i_f_i_n_i_n_a-members.html b/html/class_wippersnapper___w_i_f_i_n_i_n_a-members.html deleted file mode 100644 index 6b6b34177..000000000 --- a/html/class_wippersnapper___w_i_f_i_n_i_n_a-members.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - - -Adafruit Library: Member List - - - - - - - - - -
-
- - - - - - -
-
Adafruit Library -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
-
Wippersnapper_WIFININA Member List
-
-
- -

This is the complete list of members for Wippersnapper_WIFININA, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_analogIOWippersnapper
_boardIdWippersnapper
_boardStatusWippersnapper
_bufferWippersnapper
_buffer_outgoingWippersnapper
_configWippersnapper
_connect()Wippersnapper_WIFININAinlineprotectedvirtual
_device_uidWippersnapperprotected
_deviceIdWippersnapperprotected
_digitalGPIOWippersnapper
_disconnect()Wippersnapper_WIFININAinlineprotectedvirtual
_displayWippersnapper
_ds18x20ComponentWippersnapper
_err_subWippersnapperprotected
_err_topicWippersnapperprotected
_fileSystemWippersnapper
_i2cPort0Wippersnapper
_i2cPort1Wippersnapper
_incomingSignalMsgWippersnapper
_isI2CPort0InitWippersnapper
_isI2CPort1InitWippersnapper
_isWiFiMultiWippersnapper
_keyWippersnapper_WIFININAprotected
_last_mqtt_connectWippersnapperprotected
_ledcWippersnapper
_littleFSWippersnapper
_macAddrWippersnapper
_mqttWippersnapper
_mqtt_clientWippersnapper_WIFININAprotected
_multiNetworksWippersnapper
_outgoingSignalMsgWippersnapperprotected
_passWippersnapper_WIFININAprotected
_prv_pingWippersnapperprotected
_prvKATBlinkWippersnapperprotected
_pwmComponentWippersnapper
_servoComponentWippersnapper
_ssidWippersnapper_WIFININAprotected
_statusWippersnapperprotected
_throttle_subWippersnapperprotected
_throttle_topicWippersnapperprotected
_topic_descriptionWippersnapper
_topic_description_statusWippersnapperprotected
_topic_description_status_completeWippersnapperprotected
_topic_description_subWippersnapperprotected
_topic_device_pin_config_completeWippersnapperprotected
_topic_signal_brkrWippersnapperprotected
_topic_signal_brkr_subWippersnapperprotected
_topic_signal_deviceWippersnapper
_topic_signal_device_pubWippersnapperprotected
_topic_signal_ds18_brkrWippersnapper
_topic_signal_ds18_deviceWippersnapper
_topic_signal_ds18_subWippersnapperprotected
_topic_signal_i2c_brkrWippersnapper
_topic_signal_i2c_deviceWippersnapper
_topic_signal_i2c_subWippersnapperprotected
_topic_signal_pixels_brkrWippersnapper
_topic_signal_pixels_deviceWippersnapper
_topic_signal_pixels_subWippersnapperprotected
_topic_signal_pwm_brkrWippersnapper
_topic_signal_pwm_deviceWippersnapper
_topic_signal_pwm_subWippersnapperprotected
_topic_signal_servo_brkrWippersnapper
_topic_signal_servo_deviceWippersnapper
_topic_signal_servo_subWippersnapperprotected
_topic_signal_uart_brkrWippersnapper
_topic_signal_uart_deviceWippersnapper
_topic_signal_uart_subWippersnapperprotected
_uartComponentWippersnapper
_ui_helperWippersnapper
_usernameWippersnapper_WIFININAprotected
_wifiWippersnapper_WIFININAprotected
_ws_pixelsComponentWippersnapper
bufSizeWippersnapper
check_valid_ssid()Wippersnapper_WIFININAinlinevirtual
configAnalogInPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)Wippersnapper
configureDigitalPinReq(wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)Wippersnapper
connect()Wippersnapper
connectionType()Wippersnapper_WIFININAinline
decodeRegistrationResp(char *data, uint16_t len)Wippersnapper
decodeSignalMsg(wippersnapper_signal_v1_CreateSignalRequest *encodedSignalMsg)Wippersnapper
disconnect()Wippersnapper
enableWDT(int timeoutMS=0)Wippersnapper
encodePinEvent(wippersnapper_signal_v1_CreateSignalRequest *outgoingSignalMsg, uint8_t pinName, int pinVal)Wippersnapper
encodePubRegistrationReq()Wippersnapper
errorWriteHang(String error)Wippersnapper
feedWDT()Wippersnapper
firmwareCheck()Wippersnapper_WIFININAinline
generateDeviceUID()Wippersnapper
generateWSErrorTopics()Wippersnapper
generateWSTopics()Wippersnapper
getBoardStatus()Wippersnapper
getMacAddr()Wippersnapper_WIFININAinlinevirtual
getRSSI()Wippersnapper_WIFININAinlinevirtual
haltError(String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)Wippersnapper
i2cComponentsWippersnapper
lockStatusDotStarWippersnapper
lockStatusLEDWippersnapper
lockStatusNeoPixelWippersnapper
msgPixelsWippersnapper
msgPWMWippersnapper
msgServoWippersnapper
msgSignalDSWippersnapper
msgSignalI2CWippersnapper
msgSignalUARTWippersnapper
networkStatus()Wippersnapper_WIFININAinlinevirtual
pinCfgCompletedWippersnapper
pingBroker()Wippersnapper
pollRegistrationResp()Wippersnapper
processPackets()Wippersnapper
provision()Wippersnapper
publish(const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos=0)Wippersnapper
publishPinConfigComplete()Wippersnapper
registerBoard()Wippersnapper
run()Wippersnapper
runNetFSM()Wippersnapper
set_ssid_pass(const char *ssid, const char *ssidPassword)Wippersnapper_WIFININAinlinevirtual
set_ssid_pass()Wippersnapper_WIFININAinlinevirtual
set_user_key()Wippersnapper_WIFININAinlinevirtual
set_wifi(SPIClass *wifi)Wippersnapper_WIFININAinline
setupMQTTClient(const char *clientID)Wippersnapper_WIFININAinlinevirtual
status_pixel_brightnessWippersnapper
sUIDWippersnapper
throttleMessageWippersnapper
throttleTimeWippersnapper
totalDigitalPinsWippersnapper
Wippersnapper() (defined in Wippersnapper)Wippersnapper
Wippersnapper_WIFININA(const char *aioUsername, const char *aioKey, const char *netSSID, const char *netPass)Wippersnapper_WIFININAinline
~Wippersnapper()Wippersnappervirtual
~Wippersnapper_WIFININA()Wippersnapper_WIFININAinline
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/html/class_wippersnapper___w_i_f_i_n_i_n_a.html b/html/class_wippersnapper___w_i_f_i_n_i_n_a.html deleted file mode 100644 index ead43192b..000000000 --- a/html/class_wippersnapper___w_i_f_i_n_i_n_a.html +++ /dev/null @@ -1,959 +0,0 @@ - - - - - - - -Adafruit Library: Wippersnapper_WIFININA Class Reference - - - - - - - - - -
-
- - - - - - -
-
Adafruit Library -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
-Public Member Functions | -Protected Member Functions | -Protected Attributes | -List of all members
-
-
Wippersnapper_WIFININA Class Reference
-
-
- -

Class for using the AirLift Co-Processor network iface. - More...

- -

#include <Wippersnapper_WIFININA.h>

-
-Inheritance diagram for Wippersnapper_WIFININA:
-
-
- - -Wippersnapper - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

 Wippersnapper_WIFININA (const char *aioUsername, const char *aioKey, const char *netSSID, const char *netPass)
 Initializes the Adafruit IO class for ublox devices. More...
 
- ~Wippersnapper_WIFININA ()
 Destructor for the Adafruit IO ublox class.
 
-void set_user_key ()
 Configures the device's Adafruit IO credentials. This method should be used only if filesystem-backed provisioning is not avaliable.
 
void set_ssid_pass (const char *ssid, const char *ssidPassword)
 Sets the WiFi client's ssid and password. More...
 
-void set_ssid_pass ()
 Sets the WiFi client's ssid and password from the header file's credentials.
 
bool check_valid_ssid ()
 Performs a scan of local WiFi networks. More...
 
void set_wifi (SPIClass *wifi)
 Sets the WiFi client. More...
 
bool firmwareCheck ()
 Checks the nina-fw version on the module. More...
 
void getMacAddr ()
 Gets the ESP32's unique client identifier. More...
 
int32_t getRSSI ()
 Gets the current network RSSI value. More...
 
void setupMQTTClient (const char *clientID)
 Initializes the MQTT client. More...
 
ws_status_t networkStatus ()
 Returns the network status of an ESP32 module. More...
 
const char * connectionType ()
 Returns the type of network connection used by Wippersnapper. More...
 
- Public Member Functions inherited from Wippersnapper
-virtual ~Wippersnapper ()
 Wippersnapper destructor.
 
-void provision ()
 Provisions a WipperSnapper device with its network configuration and Adafruit IO credentials.
 
-void connect ()
 Connects to Adafruit IO+ Wippersnapper broker.
 
-void disconnect ()
 Disconnects from Adafruit IO+ Wippersnapper.
 
ws_board_status_t getBoardStatus ()
 Returns the board definition status. More...
 
bool generateDeviceUID ()
 Attempts to generate unique device identifier. More...
 
bool generateWSTopics ()
 Generates device-specific Wippersnapper control topics and subscribes to them. More...
 
bool generateWSErrorTopics ()
 Builds MQTT topics for handling errors returned from the Adafruit IO broker and subscribes to them. More...
 
bool registerBoard ()
 Attempts to register hardware with Adafruit.io WipperSnapper. More...
 
bool encodePubRegistrationReq ()
 Encodes hardware registration request message and publishes the message to the Adafruit IO broker. More...
 
void decodeRegistrationResp (char *data, uint16_t len)
 Decodes hardware registration response message from the Adafruit IO MQTT broker and initializes hardware components. More...
 
void pollRegistrationResp ()
 Polls the broker for the hardware registration response message. More...
 
-void publishPinConfigComplete ()
 Publishes an ACK to the broker that the device has completed its hardware configuration.
 
ws_status_t run ()
 Processes incoming commands and handles network connection. More...
 
-void processPackets ()
 Process all incoming packets from the Adafruit IO MQTT broker. Handles network connectivity.
 
void publish (const char *topic, uint8_t *payload, uint16_t bLen, uint8_t qos=0)
 Publishes a message to the Adafruit IO MQTT broker. Handles network connectivity. More...
 
-void pingBroker ()
 Pings the MQTT broker within the keepalive interval to keep the connection alive. Blinks the keepalive LED every STATUS_LED_KAT_BLINK_TIME milliseconds.
 
-void runNetFSM ()
 Checks network and MQTT connectivity. Handles network re-connection and mqtt re-establishment.
 
void enableWDT (int timeoutMS=0)
 Enables the watchdog timer. More...
 
-void feedWDT ()
 Feeds the WDT to prevent hardware reset.
 
void haltError (String error, ws_led_status_t ledStatusColor=WS_LED_STATUS_ERROR_RUNTIME)
 Prints an error to the serial and halts the hardware until the WDT bites. More...
 
void errorWriteHang (String error)
 Writes an error message to the serial and the filesystem, blinks WS_LED_STATUS_ERROR_RUNTIME pattern and hangs. More...
 
bool decodeSignalMsg (wippersnapper_signal_v1_CreateSignalRequest *encodedSignalMsg)
 Decodes a signal buffer protobuf message. NOTE: Should be executed in-order after a new _buffer is recieved. More...
 
bool encodePinEvent (wippersnapper_signal_v1_CreateSignalRequest *outgoingSignalMsg, uint8_t pinName, int pinVal)
 Handles MQTT messages on signal topic until timeout. More...
 
bool configureDigitalPinReq (wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)
 Configures a pin according to a wippersnapper_pin_v1_ConfigurePinRequest message. More...
 
bool configAnalogInPinReq (wippersnapper_pin_v1_ConfigurePinRequest *pinMsg)
 Configures an analog input pin according to a wippersnapper_pin_v1_ConfigurePinRequest message. More...
 
- - - - - - - -

-Protected Member Functions

-void _connect ()
 Establishes a connection with the wireless network.
 
-void _disconnect ()
 Disconnects from the wireless network.
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Protected Attributes

const char * _ssid
 
const char * _pass
 
const char * _username
 
const char * _key
 
WiFiSSLClient * _mqtt_client
 
SPIClass * _wifi
 
- Protected Attributes inherited from Wippersnapper
ws_status_t _status = WS_IDLE
 
uint32_t _last_mqtt_connect = 0
 
uint32_t _prv_ping = 0
 
uint32_t _prvKATBlink = 0
 
const char * _deviceId
 
char * _device_uid
 
char * _topic_description_status
 
char * _topic_description_status_complete = NULL
 
char * _topic_device_pin_config_complete
 
char * _topic_signal_brkr = NULL
 
char * _err_topic = NULL
 
char * _throttle_topic = NULL
 
Adafruit_MQTT_Subscribe * _topic_description_sub
 
Adafruit_MQTT_Publish * _topic_signal_device_pub
 
Adafruit_MQTT_Subscribe * _topic_signal_brkr_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_i2c_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_servo_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_pwm_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_ds18_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_pixels_sub
 
Adafruit_MQTT_Subscribe * _topic_signal_uart_sub
 
Adafruit_MQTT_Subscribe * _err_sub
 
Adafruit_MQTT_Subscribe * _throttle_sub
 
wippersnapper_signal_v1_CreateSignalRequest _outgoingSignalMsg
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Additional Inherited Members

- Public Attributes inherited from Wippersnapper
-bool lockStatusNeoPixel
 True if status LED is using the status neopixel.
 
-bool lockStatusDotStar
 True if status LED is using the status dotstar.
 
-bool lockStatusLED
 True if status LED is using the built-in LED.
 
float status_pixel_brightness
 
-std::vector< WipperSnapper_Component_I2C * > i2cComponents
 Vector containing all I2C components.
 
WipperSnapper_Component_I2C * _i2cPort0
 WipperSnapper I2C Component for I2C port #0. More...
 
WipperSnapper_Component_I2C * _i2cPort1
 WipperSnapper I2C Component for I2C port #1. More...
 
bool _isI2CPort0Init
 True if I2C port 0 has been initialized, False otherwise. More...
 
bool _isI2CPort1Init
 True if I2C port 1 has been initialized, False otherwise. More...
 
uint8_t _buffer [WS_MQTT_MAX_PAYLOAD_SIZE]
 
uint8_t _buffer_outgoing [WS_MQTT_MAX_PAYLOAD_SIZE]
 
uint16_t bufSize
 
ws_board_status_t _boardStatus
 Hardware's registration status. More...
 
-Wippersnapper_DigitalGPIO * _digitalGPIO
 Instance of digital gpio class.
 
-Wippersnapper_AnalogIO * _analogIO
 Instance of analog io class.
 
-Wippersnapper_FS * _fileSystem
 Instance of Filesystem (native USB)
 
-WipperSnapper_LittleFS * _littleFS
 Instance of LittleFS Filesystem (non-native USB)
 
-ws_display_driver * _display = nullptr
 Instance of display driver class.
 
ws_display_ui_helper * _ui_helper
 Instance of display UI helper class. More...
 
-ws_pixels * _ws_pixelsComponent
 ptr to instance of ws_pixels class
 
-ws_pwm * _pwmComponent
 Instance of pwm class.
 
-ws_servo * _servoComponent
 Instance of servo class.
 
-ws_ds18x20 * _ds18x20Component
 Instance of DS18x20 class.
 
-ws_uart * _uartComponent
 Instance of UART class.
 
uint8_t _macAddr [6]
 
char sUID [13]
 
const char * _boardId
 
Adafruit_MQTT * _mqtt
 
secretsConfig _config
 
networkConfig _multiNetworks [3]
 
bool _isWiFiMulti = false
 
int32_t totalDigitalPins
 
char * _topic_description = NULL
 
char * _topic_signal_device = NULL
 
char * _topic_signal_i2c_brkr = NULL
 
char * _topic_signal_i2c_device = NULL
 
char * _topic_signal_servo_brkr = NULL
 
char * _topic_signal_servo_device = NULL
 
char * _topic_signal_pwm_brkr
 
char * _topic_signal_pwm_device
 
char * _topic_signal_ds18_brkr = NULL
 
char * _topic_signal_ds18_device = NULL
 
char * _topic_signal_pixels_brkr = NULL
 
char * _topic_signal_pixels_device = NULL
 
char * _topic_signal_uart_brkr = NULL
 
char * _topic_signal_uart_device = NULL
 
wippersnapper_signal_v1_CreateSignalRequest _incomingSignalMsg
 
wippersnapper_signal_v1_I2CRequest msgSignalI2C
 
wippersnapper_signal_v1_Ds18x20Request msgSignalDS
 
-wippersnapper_signal_v1_ServoRequest msgServo
 ServoRequest wrapper message.
 
wippersnapper_signal_v1_PWMRequest msgPWM
 
-wippersnapper_signal_v1_PixelsRequest msgPixels
 PixelsRequest wrapper message.
 
-wippersnapper_signal_v1_UARTRequest msgSignalUART
 UARTReq wrapper message.
 
char * throttleMessage
 
int throttleTime
 
bool pinCfgCompleted = false
 
-ws_ledc * _ledc = nullptr
 Pointer to LEDC object.
 
-

Detailed Description

-

Class for using the AirLift Co-Processor network iface.

-

Constructor & Destructor Documentation

- -

◆ Wippersnapper_WIFININA()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Wippersnapper_WIFININA::Wippersnapper_WIFININA (const char * aioUsername,
const char * aioKey,
const char * netSSID,
const char * netPass 
)
- 		-inline
-
- -

Initializes the Adafruit IO class for ublox devices.

-
Parameters
- - - - - -
aioUsernameAdafruit IO username
aioKeyAdafruit IO key
netSSIDWireless Network SSID
netPassWireless Network password
-
-
- -
-
-

Member Function Documentation

- -

◆ set_ssid_pass()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void Wippersnapper_WIFININA::set_ssid_pass (const char * ssid,
const char * ssidPassword 
)
- 		-inlinevirtual
-
- -

Sets the WiFi client's ssid and password.

-
Parameters
- - - -
ssidWireless network's SSID.
ssidPasswordWireless network's password.
-
-
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ check_valid_ssid()

- -
-
- - - - - -
- - - - - - - -
bool Wippersnapper_WIFININA::check_valid_ssid ()
- 		-inlinevirtual
-
- -

Performs a scan of local WiFi networks.

-
Returns
True if _network_ssid is found, False otherwise.
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ set_wifi()

- -
-
- - - - - -
- - - - - - - - -
void Wippersnapper_WIFININA::set_wifi (SPIClass * wifi)
- 		-inline
-
- -

Sets the WiFi client.

-
Parameters
- - -
wifiInstance of SPIClass.
-
-
- -
-
- -

◆ firmwareCheck()

- -
-
- - - - - -
- - - - - - - -
bool Wippersnapper_WIFININA::firmwareCheck ()
- 		-inline
-
- -

Checks the nina-fw version on the module.

-
Returns
True if firmware on the ublox module matches the latest version of the library, False otherwise.
- -
-
- -

◆ getMacAddr()

- -
-
- - - - - -
- - - - - - - -
void Wippersnapper_WIFININA::getMacAddr ()
- 		-inlinevirtual
-
- -

Gets the ESP32's unique client identifier.

-
Note
For the ESP32, the UID is the MAC address.
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ getRSSI()

- -
-
- - - - - -
- - - - - - - -
int32_t Wippersnapper_WIFININA::getRSSI ()
- 		-inlinevirtual
-
- -

Gets the current network RSSI value.

-
Returns
int32_t RSSI value
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ setupMQTTClient()

- -
-
- - - - - -
- - - - - - - - -
void Wippersnapper_WIFININA::setupMQTTClient (const char * clientID)
- 		-inlinevirtual
-
- -

Initializes the MQTT client.

-
Parameters
- - -
clientIDMQTT client identifier
-
-
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ networkStatus()

- -
-
- - - - - -
- - - - - - - -
ws_status_t Wippersnapper_WIFININA::networkStatus ()
- 		-inlinevirtual
-
- -

Returns the network status of an ESP32 module.

-
Returns
ws_status_t
- -

Reimplemented from Wippersnapper.

- -
-
- -

◆ connectionType()

- -
-
- - - - - -
- - - - - - - -
const char* Wippersnapper_WIFININA::connectionType ()
- 		-inline
-
- -

Returns the type of network connection used by Wippersnapper.

-
Returns
AIRLIFT
- -
-
-

Member Data Documentation

- -

◆ _ssid

- -
-
- - - - - -
- - - - -
const char* Wippersnapper_WIFININA::_ssid
- 		-protected
-
-

Network SSID.

- -
-
- -

◆ _pass

- -
-
- - - - - -
- - - - -
const char* Wippersnapper_WIFININA::_pass
- 		-protected
-
-

Network password.

- -
-
- -

◆ _username

- -
-
- - - - - -
- - - - -
const char* Wippersnapper_WIFININA::_username
- 		-protected
-
-

Adafruit IO username.

- -
-
- -

◆ _key

- -
-
- - - - - -
- - - - -
const char* Wippersnapper_WIFININA::_key
- 		-protected
-
-

Adafruit IO key.

- -
-
- -

◆ _mqtt_client

- -
-
- - - - - -
- - - - -
WiFiSSLClient* Wippersnapper_WIFININA::_mqtt_client
- 		-protected
-
-

Instance of a secure WiFi client.

- -
-
- -

◆ _wifi

- -
-
- - - - - -
- - - - -
SPIClass* Wippersnapper_WIFININA::_wifi
- 		-protected
-
-

Instance of the SPI bus used by the ublox.

- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated by   -doxygen - 1.8.13 -
- - diff --git a/html/class_wippersnapper___w_i_f_i_n_i_n_a.png b/html/class_wippersnapper___w_i_f_i_n_i_n_a.png deleted file mode 100644 index f32122ff2..000000000 Binary files a/html/class_wippersnapper___w_i_f_i_n_i_n_a.png and /dev/null differ diff --git a/html/classes.html b/html/classes.html index dac9bd738..e0e15a40b 100644 --- a/html/classes.html +++ b/html/classes.html @@ -65,26 +65,26 @@
a | d | s | w
- - + + + - - - + + + + - - - - - + + + + + + - - - + + + +
  a  
-		Wippersnapper_AnalogIO   WipperSnapper_I2C_Driver_HTU21D   WipperSnapper_I2C_Driver_PM25   WipperSnapper_I2C_Driver_VL53L1X   
WipperSnapper_Component_I2C   WipperSnapper_I2C_Driver_HTU31D   WipperSnapper_I2C_Driver_SCD30   WipperSnapper_I2C_Driver_VL53L4CD   
analogInputPin   Wippersnapper_DigitalGPIO   WipperSnapper_I2C_Driver_INA219   WipperSnapper_I2C_Driver_SCD4X   WipperSnapper_I2C_Driver_VL53L4CX   
Wippersnapper_AnalogIO   WipperSnapper_I2C_Driver_HTU21D   WipperSnapper_I2C_Driver_PM25   WipperSnapper_I2C_Driver_VEML7700   
WipperSnapper_Component_I2C   WipperSnapper_I2C_Driver_HTU31D   WipperSnapper_I2C_Driver_SCD30   WipperSnapper_I2C_Driver_VL53L0X   
analogInputPin   Wippersnapper_DigitalGPIO   WipperSnapper_I2C_Driver_INA219   WipperSnapper_I2C_Driver_SCD4X   WipperSnapper_I2C_Driver_VL53L1X   
  d  
-		Wippersnapper_ESP32   WipperSnapper_I2C_Driver_LC709203F   WipperSnapper_I2C_Driver_SEN5X   WipperSnapper_I2C_Driver_VL6180X   
WipperSnapper_I2C_Driver   WipperSnapper_I2C_Driver_LPS22HB   WipperSnapper_I2C_Driver_SGP30   Wippersnapper_WIFININA   
digitalInputPin   WipperSnapper_I2C_Driver_ADT7410   WipperSnapper_I2C_Driver_LPS25HB   WipperSnapper_I2C_Driver_SGP40   ws_display_driver   
ds18x20Obj   WipperSnapper_I2C_Driver_AHTX0   WipperSnapper_I2C_Driver_LPS3XHW   WipperSnapper_I2C_Driver_SHT3X   ws_display_ui_helper   
Wippersnapper_ESP32   WipperSnapper_I2C_Driver_LC709203F   WipperSnapper_I2C_Driver_SEN5X   WipperSnapper_I2C_Driver_VL53L4CD   
WipperSnapper_I2C_Driver   WipperSnapper_I2C_Driver_LPS22HB   WipperSnapper_I2C_Driver_SEN6X   WipperSnapper_I2C_Driver_VL53L4CX   
digitalInputPin   WipperSnapper_I2C_Driver_ADT7410   WipperSnapper_I2C_Driver_LPS25HB   WipperSnapper_I2C_Driver_SGP30   WipperSnapper_I2C_Driver_VL6180X   
ds18x20Obj   WipperSnapper_I2C_Driver_AHTX0   WipperSnapper_I2C_Driver_LPS3XHW   WipperSnapper_I2C_Driver_SGP40   ws_display_driver   
  s  
-		WipperSnapper_I2C_Driver_BH1750   WipperSnapper_I2C_Driver_LTR329_LTR303   WipperSnapper_I2C_Driver_SHT4X   ws_ds18x20   
WipperSnapper_I2C_Driver_BME280   WipperSnapper_I2C_Driver_LTR390   WipperSnapper_I2C_Driver_SHTC3   ws_ledc   
servo_t   WipperSnapper_I2C_Driver_BME680   WipperSnapper_I2C_Driver_MAX17048   WipperSnapper_I2C_Driver_SI7021   ws_ledc_servo   
servoComponent   WipperSnapper_I2C_Driver_BMP280   WipperSnapper_I2C_Driver_MCP3421   WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor   ws_pixels   
ServoPin_t   WipperSnapper_I2C_Driver_BMP3XX   WipperSnapper_I2C_Driver_MCP9808   WipperSnapper_I2C_Driver_TMP117   ws_pwm   
strand_s   WipperSnapper_I2C_Driver_DPS310   WipperSnapper_I2C_Driver_MPL115A2   WipperSnapper_I2C_Driver_TSL2591   ws_servo   
WipperSnapper_I2C_Driver_BH1750   WipperSnapper_I2C_Driver_LTR329_LTR303   WipperSnapper_I2C_Driver_SHT3X   ws_display_ui_helper   
WipperSnapper_I2C_Driver_BME280   WipperSnapper_I2C_Driver_LTR390   WipperSnapper_I2C_Driver_SHT4X   ws_ds18x20   
servo_t   WipperSnapper_I2C_Driver_BME680   WipperSnapper_I2C_Driver_MAX17048   WipperSnapper_I2C_Driver_SHTC3   ws_ledc   
servoComponent   WipperSnapper_I2C_Driver_BMP280   WipperSnapper_I2C_Driver_MCP3421   WipperSnapper_I2C_Driver_SI7021   ws_ledc_servo   
ServoPin_t   WipperSnapper_I2C_Driver_BMP3XX   WipperSnapper_I2C_Driver_MCP9808   WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor   ws_pixels   
strand_s   WipperSnapper_I2C_Driver_DPS310   WipperSnapper_I2C_Driver_MPL115A2   WipperSnapper_I2C_Driver_TMP117   ws_pwm   
  w  
-		WipperSnapper_I2C_Driver_DS2484   WipperSnapper_I2C_Driver_MPRLS   WipperSnapper_I2C_Driver_VCNL4020   ws_uart   
WipperSnapper_I2C_Driver_ENS160   WipperSnapper_I2C_Driver_MS8607   WipperSnapper_I2C_Driver_VCNL4040   ws_uart_drv   
Wippersnapper   WipperSnapper_I2C_Driver_HDC302X   WipperSnapper_I2C_Driver_NAU7802   WipperSnapper_I2C_Driver_VEML7700   ws_uart_drv_pm25aqi   
Wippersnapper_AIRLIFT   WipperSnapper_I2C_Driver_HTS221   WipperSnapper_I2C_Driver_PCT2075   WipperSnapper_I2C_Driver_VL53L0X   
WipperSnapper_I2C_Driver_DS2484   WipperSnapper_I2C_Driver_MPRLS   WipperSnapper_I2C_Driver_TSL2591   ws_servo   
WipperSnapper_I2C_Driver_ENS160   WipperSnapper_I2C_Driver_MS8607   WipperSnapper_I2C_Driver_VCNL4020   ws_uart   
Wippersnapper   WipperSnapper_I2C_Driver_HDC302X   WipperSnapper_I2C_Driver_NAU7802   WipperSnapper_I2C_Driver_VCNL4040   ws_uart_drv   
Wippersnapper_AIRLIFT   WipperSnapper_I2C_Driver_HTS221   WipperSnapper_I2C_Driver_PCT2075   WipperSnapper_I2C_Driver_VCNL4200   ws_uart_drv_pm25aqi   
a | d | s | w
diff --git a/html/dir_7e0264f5491619e7733fa0e2608679bb.html b/html/dir_7e0264f5491619e7733fa0e2608679bb.html index 24916faba..af02e7ebf 100644 --- a/html/dir_7e0264f5491619e7733fa0e2608679bb.html +++ b/html/dir_7e0264f5491619e7733fa0e2608679bb.html @@ -75,8 +75,6 @@   file  Wippersnapper_ESP8266.h [code]   -file  Wippersnapper_WIFININA.h [code] -  file  ws_networking_pico.h [code]   diff --git a/html/dir_fcb6e4fbca5bd9aa8323205978345f78.html b/html/dir_fcb6e4fbca5bd9aa8323205978345f78.html index eb9e38c47..2dd5a64c2 100644 --- a/html/dir_fcb6e4fbca5bd9aa8323205978345f78.html +++ b/html/dir_fcb6e4fbca5bd9aa8323205978345f78.html @@ -135,6 +135,8 @@   file  WipperSnapper_I2C_Driver_SEN5X.h [code]   +file  WipperSnapper_I2C_Driver_SEN6X.h [code] +  file  WipperSnapper_I2C_Driver_SGP40.h [code]   file  WipperSnapper_I2C_Driver_SHT3X.h [code] @@ -155,6 +157,8 @@   file  WipperSnapper_I2C_Driver_VCNL4040.h [code]   +file  WipperSnapper_I2C_Driver_VCNL4200.h [code] +  file  WipperSnapper_I2C_Driver_VEML7700.h [code]   file  WipperSnapper_I2C_Driver_VL53L0X.h [code] diff --git a/html/files.html b/html/files.html index 56cf35852..b4265435f 100644 --- a/html/files.html +++ b/html/files.html @@ -111,23 +111,25 @@  WipperSnapper_I2C_Driver_SCD30.h  WipperSnapper_I2C_Driver_SCD4X.h  WipperSnapper_I2C_Driver_SEN5X.h - WipperSnapper_I2C_Driver_SGP30.h - WipperSnapper_I2C_Driver_SGP40.h - WipperSnapper_I2C_Driver_SHT3X.h - WipperSnapper_I2C_Driver_SHT4X.h - WipperSnapper_I2C_Driver_SHTC3.h - WipperSnapper_I2C_Driver_SI7021.h - WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor.h - WipperSnapper_I2C_Driver_TMP117.h - WipperSnapper_I2C_Driver_TSL2591.h - WipperSnapper_I2C_Driver_VCNL4020.h - WipperSnapper_I2C_Driver_VCNL4040.h - WipperSnapper_I2C_Driver_VEML7700.h - WipperSnapper_I2C_Driver_VL53L0X.h - WipperSnapper_I2C_Driver_VL53L1X.h - WipperSnapper_I2C_Driver_VL53L4CD.h - WipperSnapper_I2C_Driver_VL53L4CX.h - WipperSnapper_I2C_Driver_VL6180X.h + WipperSnapper_I2C_Driver_SEN6X.h + WipperSnapper_I2C_Driver_SGP30.h + WipperSnapper_I2C_Driver_SGP40.h + WipperSnapper_I2C_Driver_SHT3X.h + WipperSnapper_I2C_Driver_SHT4X.h + WipperSnapper_I2C_Driver_SHTC3.h + WipperSnapper_I2C_Driver_SI7021.h + WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor.h + WipperSnapper_I2C_Driver_TMP117.h + WipperSnapper_I2C_Driver_TSL2591.h + WipperSnapper_I2C_Driver_VCNL4020.h + WipperSnapper_I2C_Driver_VCNL4040.h + WipperSnapper_I2C_Driver_VCNL4200.h + WipperSnapper_I2C_Driver_VEML7700.h + WipperSnapper_I2C_Driver_VL53L0X.h + WipperSnapper_I2C_Driver_VL53L1X.h + WipperSnapper_I2C_Driver_VL53L4CD.h + WipperSnapper_I2C_Driver_VL53L4CX.h + WipperSnapper_I2C_Driver_VL6180X.h  WipperSnapper_I2C.cpp  WipperSnapper_I2C.h  ▼ ledc @@ -167,13 +169,12 @@  Wippersnapper_AIRLIFT.h  Wippersnapper_ESP32.h  Wippersnapper_ESP8266.h - Wippersnapper_WIFININA.h - ws_networking_pico.h - print_dependencies.h - Wippersnapper.cpp - Wippersnapper.h - Wippersnapper_Boards.h - Wippersnapper_Networking.h + ws_networking_pico.h + print_dependencies.h + Wippersnapper.cpp + Wippersnapper.h + Wippersnapper_Boards.h + Wippersnapper_Networking.h

diff --git a/html/functions.html b/html/functions.html index 00f75e466..96b7ad7a3 100644 --- a/html/functions.html +++ b/html/functions.html @@ -162,7 +162,6 @@

- _ -

    : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
  • _currentPeriod : WipperSnapper_I2C_Driver @@ -192,7 +191,6 @@

    - _ -

      : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
    • _display : Wippersnapper @@ -301,9 +299,6 @@

      - _ -

      • _isWiFiMulti : Wippersnapper
        • -
      • _key -: Wippersnapper_WIFININA -
      • _last_mqtt_connect : Wippersnapper
        • @@ -363,7 +358,6 @@

        - _ -

        • _mqtt_client : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
        • _mqtt_client_insecure : Wippersnapper_ESP32 @@ -413,7 +407,6 @@

          - _ -

          • _pass : Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
          • _pct2075 : WipperSnapper_I2C_Driver_PCT2075 @@ -485,6 +478,7 @@

            - _ -

            • _sen : WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
            • _sensorAddress : WipperSnapper_I2C_Driver @@ -513,7 +507,6 @@

              - _ -

              • _ssid : Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
              • _ssPin : Wippersnapper_AIRLIFT @@ -647,15 +640,15 @@

                - _ -

                • _unitlessPercentPeriodPrv : WipperSnapper_I2C_Driver
                  • -
                • _username -: Wippersnapper_WIFININA -
                • _vcnl4020 : WipperSnapper_I2C_Driver_VCNL4020
                • _vcnl4040 : WipperSnapper_I2C_Driver_VCNL4040
                  • +
                • _vcnl4200 +: WipperSnapper_I2C_Driver_VCNL4200 +
                • _veml : WipperSnapper_I2C_Driver_VEML7700
                  • @@ -688,7 +681,6 @@

                  - _ -

                  • _wifi : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                  • _wifiMulti : Wippersnapper_ESP32 diff --git a/html/functions_0x7e.html b/html/functions_0x7e.html index 3df10eee4..af5e6981e 100644 --- a/html/functions_0x7e.html +++ b/html/functions_0x7e.html @@ -190,6 +190,9 @@

                    - ~ -

                    • ~WipperSnapper_I2C_Driver_VCNL4040() : WipperSnapper_I2C_Driver_VCNL4040
                      • +
                    • ~WipperSnapper_I2C_Driver_VCNL4200() +: WipperSnapper_I2C_Driver_VCNL4200 +
                    • ~WipperSnapper_I2C_Driver_VEML7700() : WipperSnapper_I2C_Driver_VEML7700
                      • @@ -208,9 +211,6 @@

                      - ~ -

                      • ~WipperSnapper_I2C_Driver_VL6180X() : WipperSnapper_I2C_Driver_VL6180X
                        • -
                      • ~Wippersnapper_WIFININA() -: Wippersnapper_WIFININA -
                      • ~ws_display_driver() : ws_display_driver
                        • diff --git a/html/functions_b.html b/html/functions_b.html index 791281baa..7ed468bac 100644 --- a/html/functions_b.html +++ b/html/functions_b.html @@ -96,6 +96,7 @@

                        - b -

                          , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SGP30 , WipperSnapper_I2C_Driver_SGP40 , WipperSnapper_I2C_Driver_SHT3X @@ -107,6 +108,7 @@

                          - b -

                            , WipperSnapper_I2C_Driver_TSL2591 , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VEML7700 , WipperSnapper_I2C_Driver_VL53L0X , WipperSnapper_I2C_Driver_VL53L1X diff --git a/html/functions_c.html b/html/functions_c.html index 973cd10b3..76709fa48 100644 --- a/html/functions_c.html +++ b/html/functions_c.html @@ -65,7 +65,6 @@

                            - c -

                              : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                            • clear_scr_load() : ws_display_ui_helper @@ -94,7 +93,6 @@

                              - c -

                              diff --git a/html/functions_f.html b/html/functions_f.html index 5b7fe8c08..e8997953f 100644 --- a/html/functions_f.html +++ b/html/functions_f.html @@ -72,7 +72,6 @@

                              - f -

                              • firmwareCheck() : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                              • flushNAU7802() : WipperSnapper_I2C_Driver_NAU7802 diff --git a/html/functions_func.html b/html/functions_func.html index 0c4119c23..d571d8072 100644 --- a/html/functions_func.html +++ b/html/functions_func.html @@ -65,13 +65,11 @@

                                - _ -

                                diff --git a/html/functions_func_0x7e.html b/html/functions_func_0x7e.html index 1d5a32c39..63f0f8506 100644 --- a/html/functions_func_0x7e.html +++ b/html/functions_func_0x7e.html @@ -190,6 +190,9 @@

                                - ~ -

                                • ~WipperSnapper_I2C_Driver_VCNL4040() : WipperSnapper_I2C_Driver_VCNL4040
                                  • +
                                • ~WipperSnapper_I2C_Driver_VCNL4200() +: WipperSnapper_I2C_Driver_VCNL4200 +
                                • ~WipperSnapper_I2C_Driver_VEML7700() : WipperSnapper_I2C_Driver_VEML7700
                                  • @@ -208,9 +211,6 @@

                                  - ~ -

                                  • ~WipperSnapper_I2C_Driver_VL6180X() : WipperSnapper_I2C_Driver_VL6180X
                                    • -
                                  • ~Wippersnapper_WIFININA() -: Wippersnapper_WIFININA -
                                  • ~ws_display_driver() : ws_display_driver
                                    • diff --git a/html/functions_func_b.html b/html/functions_func_b.html index 1012a98cb..e3e4f9092 100644 --- a/html/functions_func_b.html +++ b/html/functions_func_b.html @@ -96,6 +96,7 @@

                                    - b -

                                      , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SGP30 , WipperSnapper_I2C_Driver_SGP40 , WipperSnapper_I2C_Driver_SHT3X @@ -107,6 +108,7 @@

                                      - b -

                                        , WipperSnapper_I2C_Driver_TSL2591 , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VEML7700 , WipperSnapper_I2C_Driver_VL53L0X , WipperSnapper_I2C_Driver_VL53L1X diff --git a/html/functions_func_c.html b/html/functions_func_c.html index 95cd40a04..512b725b6 100644 --- a/html/functions_func_c.html +++ b/html/functions_func_c.html @@ -65,7 +65,6 @@

                                        - c -

                                          : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                        • clear_scr_load() : ws_display_ui_helper @@ -94,7 +93,6 @@

                                          - c -

                                          diff --git a/html/functions_func_f.html b/html/functions_func_f.html index 659e49c54..2a18999f3 100644 --- a/html/functions_func_f.html +++ b/html/functions_func_f.html @@ -72,7 +72,6 @@

                                          - f -

                                          • firmwareCheck() : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                                          • flushNAU7802() : WipperSnapper_I2C_Driver_NAU7802 diff --git a/html/functions_func_g.html b/html/functions_func_g.html index 207aba3d1..a927a6bb8 100644 --- a/html/functions_func_g.html +++ b/html/functions_func_g.html @@ -119,6 +119,7 @@

                                            - g -

                                              , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SHT3X , WipperSnapper_I2C_Driver_SHT4X , WipperSnapper_I2C_Driver_SHTC3 @@ -133,6 +134,7 @@

                                              - g -

                                                : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X +, WipperSnapper_I2C_Driver_SEN6X
                                              • getEventCurrent() : WipperSnapper_I2C_Driver @@ -155,12 +157,14 @@

                                                - g -

                                                  , WipperSnapper_I2C_Driver_TSL2591 , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VEML7700 , WipperSnapper_I2C_Driver_VL6180X
                                                • getEventNOxIndex() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                • getEventObjectTemp() : WipperSnapper_I2C_Driver @@ -172,19 +176,23 @@

                                                  - g -

                                                    : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                  • getEventPM10_STD() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                  • getEventPM25_STD() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                  • getEventPM40_STD() : WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                  • getEventPressure() : WipperSnapper_I2C_Driver @@ -204,6 +212,7 @@

                                                    - g -

                                                      : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VL53L0X , WipperSnapper_I2C_Driver_VL53L1X , WipperSnapper_I2C_Driver_VL53L4CD @@ -234,6 +243,7 @@

                                                      - g -

                                                        , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SHT3X , WipperSnapper_I2C_Driver_SHT4X , WipperSnapper_I2C_Driver_SHTC3 @@ -252,6 +262,7 @@

                                                        - g -

                                                        • getEventVOCIndex() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SGP40
                                                        • getEventVoltage() @@ -273,7 +284,6 @@

                                                          - g -

                                                            : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                          • getNativeResolution() : Wippersnapper_AnalogIO @@ -294,7 +304,6 @@

                                                            - g -

                                                              : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                            • getSensorAltitudePeriod() : WipperSnapper_I2C_Driver diff --git a/html/functions_func_h.html b/html/functions_func_h.html index 7a3eb7f4c..2d32026ba 100644 --- a/html/functions_func_h.html +++ b/html/functions_func_h.html @@ -62,7 +62,7 @@

                                                              - h -

                                                              diff --git a/html/functions_func_n.html b/html/functions_func_n.html index 86c714958..769d0b8fc 100644 --- a/html/functions_func_n.html +++ b/html/functions_func_n.html @@ -65,7 +65,6 @@

                                                              - n -

                                                                : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                              • noTone() : ws_pwm diff --git a/html/functions_func_s.html b/html/functions_func_s.html index 0063edea7..44092e2dd 100644 --- a/html/functions_func_s.html +++ b/html/functions_func_s.html @@ -108,15 +108,12 @@

                                                                - s -

                                                                  : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                • set_user_key() : Wippersnapper -, Wippersnapper_WIFININA
                                                                • set_wifi() : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                                                                • setADCResolution() : Wippersnapper_AnalogIO @@ -218,7 +215,6 @@

                                                                  - s -

                                                                    : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                  • show_scr_error() : ws_display_ui_helper diff --git a/html/functions_func_t.html b/html/functions_func_t.html index 2b74f0032..097b77272 100644 --- a/html/functions_func_t.html +++ b/html/functions_func_t.html @@ -62,7 +62,7 @@

                                                                    - t -

                                                                    • timerExpired() -: Wippersnapper_AnalogIO +: Wippersnapper_AnalogIO
                                                                    • tone() : ws_ledc diff --git a/html/functions_func_w.html b/html/functions_func_w.html index 184c4257b..696745ed0 100644 --- a/html/functions_func_w.html +++ b/html/functions_func_w.html @@ -178,6 +178,9 @@

                                                                      - w -

                                                                      • WipperSnapper_I2C_Driver_SEN5X() : WipperSnapper_I2C_Driver_SEN5X
                                                                        • +
                                                                      • WipperSnapper_I2C_Driver_SEN6X() +: WipperSnapper_I2C_Driver_SEN6X +
                                                                      • WipperSnapper_I2C_Driver_SGP30() : WipperSnapper_I2C_Driver_SGP30
                                                                        • @@ -211,6 +214,9 @@

                                                                        - w -

                                                                        • WipperSnapper_I2C_Driver_VCNL4040() : WipperSnapper_I2C_Driver_VCNL4040
                                                                          • +
                                                                        • WipperSnapper_I2C_Driver_VCNL4200() +: WipperSnapper_I2C_Driver_VCNL4200 +
                                                                        • WipperSnapper_I2C_Driver_VEML7700() : WipperSnapper_I2C_Driver_VEML7700
                                                                          • @@ -229,9 +235,6 @@

                                                                          - w -

                                                                          • WipperSnapper_I2C_Driver_VL6180X() : WipperSnapper_I2C_Driver_VL6180X
                                                                            • -
                                                                          • Wippersnapper_WIFININA() -: Wippersnapper_WIFININA -
                                                                          • writeDutyCycle() : ws_pwm
                                                                            • diff --git a/html/functions_g.html b/html/functions_g.html index 8736e3295..9bdb5bca4 100644 --- a/html/functions_g.html +++ b/html/functions_g.html @@ -119,6 +119,7 @@

                                                                            - g -

                                                                              , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SHT3X , WipperSnapper_I2C_Driver_SHT4X , WipperSnapper_I2C_Driver_SHTC3 @@ -133,6 +134,7 @@

                                                                              - g -

                                                                                : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X +, WipperSnapper_I2C_Driver_SEN6X
                                                                              • getEventCurrent() : WipperSnapper_I2C_Driver @@ -155,12 +157,14 @@

                                                                                - g -

                                                                                  , WipperSnapper_I2C_Driver_TSL2591 , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VEML7700 , WipperSnapper_I2C_Driver_VL6180X
                                                                                • getEventNOxIndex() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                • getEventObjectTemp() : WipperSnapper_I2C_Driver @@ -172,19 +176,23 @@

                                                                                  - g -

                                                                                    : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                  • getEventPM10_STD() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                  • getEventPM25_STD() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_PM25 , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                  • getEventPM40_STD() : WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                  • getEventPressure() : WipperSnapper_I2C_Driver @@ -204,6 +212,7 @@

                                                                                    - g -

                                                                                      : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_VCNL4020 , WipperSnapper_I2C_Driver_VCNL4040 +, WipperSnapper_I2C_Driver_VCNL4200 , WipperSnapper_I2C_Driver_VL53L0X , WipperSnapper_I2C_Driver_VL53L1X , WipperSnapper_I2C_Driver_VL53L4CD @@ -234,6 +243,7 @@

                                                                                      - g -

                                                                                        , WipperSnapper_I2C_Driver_SCD30 , WipperSnapper_I2C_Driver_SCD4X , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SHT3X , WipperSnapper_I2C_Driver_SHT4X , WipperSnapper_I2C_Driver_SHTC3 @@ -252,6 +262,7 @@

                                                                                        - g -

                                                                                        • getEventVOCIndex() : WipperSnapper_I2C_Driver , WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X , WipperSnapper_I2C_Driver_SGP40
                                                                                        • getEventVoltage() @@ -273,7 +284,6 @@

                                                                                          - g -

                                                                                            : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                          • getNativeResolution() : Wippersnapper_AnalogIO @@ -294,7 +304,6 @@

                                                                                            - g -

                                                                                              : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                            • getSensorAltitudePeriod() : WipperSnapper_I2C_Driver diff --git a/html/functions_h.html b/html/functions_h.html index 0356fe883..154eb73bc 100644 --- a/html/functions_h.html +++ b/html/functions_h.html @@ -62,7 +62,7 @@

                                                                                              - h -

                                                                                              diff --git a/html/functions_n.html b/html/functions_n.html index bb3da7feb..d7922675b 100644 --- a/html/functions_n.html +++ b/html/functions_n.html @@ -71,7 +71,6 @@

                                                                                              - n -

                                                                                                : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                              • noTone() : ws_pwm diff --git a/html/functions_s.html b/html/functions_s.html index d5ddf5107..ff8c41eff 100644 --- a/html/functions_s.html +++ b/html/functions_s.html @@ -120,15 +120,12 @@

                                                                                                - s -

                                                                                                  : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                                • set_user_key() : Wippersnapper -, Wippersnapper_WIFININA
                                                                                                • set_wifi() : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                                                                                                • setADCResolution() : Wippersnapper_AnalogIO @@ -230,7 +227,6 @@

                                                                                                  - s -

                                                                                                    : Wippersnapper , Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                                  • show_scr_error() : ws_display_ui_helper diff --git a/html/functions_t.html b/html/functions_t.html index ab04be783..cd62c1884 100644 --- a/html/functions_t.html +++ b/html/functions_t.html @@ -68,7 +68,7 @@

                                                                                                    - t -

                                                                                                      : Wippersnapper
                                                                                                    • timerExpired() -: Wippersnapper_AnalogIO +: Wippersnapper_AnalogIO
                                                                                                    • tone() : ws_ledc diff --git a/html/functions_vars.html b/html/functions_vars.html index b96dc765d..2cca9923c 100644 --- a/html/functions_vars.html +++ b/html/functions_vars.html @@ -289,9 +289,6 @@

                                                                                                      - _ -

                                                                                                      • _isWiFiMulti : Wippersnapper
                                                                                                        • -
                                                                                                      • _key -: Wippersnapper_WIFININA -
                                                                                                      • _last_mqtt_connect : Wippersnapper
                                                                                                        • @@ -351,7 +348,6 @@

                                                                                                        - _ -

                                                                                                        • _mqtt_client : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                                                                                                        • _mqtt_client_insecure : Wippersnapper_ESP32 @@ -401,7 +397,6 @@

                                                                                                          - _ -

                                                                                                          • _pass : Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                                          • _pct2075 : WipperSnapper_I2C_Driver_PCT2075 @@ -473,6 +468,7 @@

                                                                                                            - _ -

                                                                                                            • _sen : WipperSnapper_I2C_Driver_SEN5X +, WipperSnapper_I2C_Driver_SEN6X
                                                                                                            • _sensorAddress : WipperSnapper_I2C_Driver @@ -501,7 +497,6 @@

                                                                                                              - _ -

                                                                                                              • _ssid : Wippersnapper_AIRLIFT , Wippersnapper_ESP32 -, Wippersnapper_WIFININA
                                                                                                              • _ssPin : Wippersnapper_AIRLIFT @@ -635,15 +630,15 @@

                                                                                                                - _ -

                                                                                                                • _unitlessPercentPeriodPrv : WipperSnapper_I2C_Driver
                                                                                                                  • -
                                                                                                                • _username -: Wippersnapper_WIFININA -
                                                                                                                • _vcnl4020 : WipperSnapper_I2C_Driver_VCNL4020
                                                                                                                • _vcnl4040 : WipperSnapper_I2C_Driver_VCNL4040
                                                                                                                  • +
                                                                                                                • _vcnl4200 +: WipperSnapper_I2C_Driver_VCNL4200 +
                                                                                                                • _veml : WipperSnapper_I2C_Driver_VEML7700
                                                                                                                  • @@ -676,7 +671,6 @@

                                                                                                                  - _ -

                                                                                                                  • _wifi : Wippersnapper_AIRLIFT -, Wippersnapper_WIFININA
                                                                                                                  • _wifiMulti : Wippersnapper_ESP32 diff --git a/html/functions_w.html b/html/functions_w.html index e564fd790..5d6d31209 100644 --- a/html/functions_w.html +++ b/html/functions_w.html @@ -178,6 +178,9 @@

                                                                                                                    - w -

                                                                                                                    • WipperSnapper_I2C_Driver_SEN5X() : WipperSnapper_I2C_Driver_SEN5X
                                                                                                                      • +
                                                                                                                    • WipperSnapper_I2C_Driver_SEN6X() +: WipperSnapper_I2C_Driver_SEN6X +
                                                                                                                    • WipperSnapper_I2C_Driver_SGP30() : WipperSnapper_I2C_Driver_SGP30
                                                                                                                      • @@ -211,6 +214,9 @@

                                                                                                                      - w -

                                                                                                                      • WipperSnapper_I2C_Driver_VCNL4040() : WipperSnapper_I2C_Driver_VCNL4040
                                                                                                                        • +
                                                                                                                      • WipperSnapper_I2C_Driver_VCNL4200() +: WipperSnapper_I2C_Driver_VCNL4200 +
                                                                                                                      • WipperSnapper_I2C_Driver_VEML7700() : WipperSnapper_I2C_Driver_VEML7700
                                                                                                                        • @@ -229,9 +235,6 @@

                                                                                                                        - w -

                                                                                                                        • WipperSnapper_I2C_Driver_VL6180X() : WipperSnapper_I2C_Driver_VL6180X
                                                                                                                          • -
                                                                                                                        • Wippersnapper_WIFININA() -: Wippersnapper_WIFININA -
                                                                                                                        • writeDutyCycle() : ws_pwm
                                                                                                                          • diff --git a/html/globals.html b/html/globals.html index 41b27351c..669c23e46 100644 --- a/html/globals.html +++ b/html/globals.html @@ -87,6 +87,9 @@

                                                                                                                          - b -

                                                                                                                            - c -

                                                                                                                              +
                                                                                                                            • calculateHysteresis() +: Wippersnapper_AnalogIO.cpp +
                                                                                                                            • cbDecodeDigitalPinWriteMsg() : Wippersnapper.cpp
                                                                                                                              • @@ -377,7 +380,6 @@

                                                                                                                              - s -

                                                                                                                              • SPIWIFI : Wippersnapper_AIRLIFT.h -, Wippersnapper_WIFININA.h
                                                                                                                              • STATUS_DOTSTAR_COLOR_ORDER : Wippersnapper_Boards.h @@ -398,16 +400,16 @@

                                                                                                                                - s -

                                                                                                                                  : Wippersnapper_StatusLED.h
                                                                                                                                • statusLEDBlink() -: Wippersnapper_StatusLED.cpp -, Wippersnapper_StatusLED.h +: Wippersnapper_StatusLED.h +, Wippersnapper_StatusLED.cpp
                                                                                                                                • statusLEDFade() : Wippersnapper_StatusLED.cpp , Wippersnapper_StatusLED.h
                                                                                                                                • statusLEDSolid() -: Wippersnapper_StatusLED.h -, Wippersnapper_StatusLED.cpp +: Wippersnapper_StatusLED.cpp +, Wippersnapper_StatusLED.h
                                                                                                                                • strands : ws_pixels.cpp @@ -485,22 +487,24 @@

                                                                                                                                  - w -

                                                                                                                                  • Wippersnapper_WiFi : Wippersnapper_Networking.h
                                                                                                                                    • +
                                                                                                                                  • WL_MAC_ADDR_LENGTH +: Wippersnapper_Networking.h +
                                                                                                                                  • WS -: Wippersnapper_AnalogIO.h -, Wippersnapper_StatusLED.cpp +: ws_servo.h +, Wippersnapper_AnalogIO.h +, ws_ledc.h +, Wippersnapper_Register.cpp +, Wippersnapper_ESP32.h , Wippersnapper_DigitalGPIO.h +, Wippersnapper_StatusLED.cpp , ws_pixels.h -, ws_servo.h -, Wippersnapper_WIFININA.h -, ws_ds18x20.h +, WipperSnapper_I2C.h , ws_display_driver.h -, Wippersnapper_Register.cpp -, ws_ledc.h , Wippersnapper_AIRLIFT.h -, Wippersnapper_ESP32.h , Wippersnapper.cpp , Wippersnapper.h -, WipperSnapper_I2C.h +, ws_ds18x20.h
                                                                                                                                  • ws_board_status_t : Wippersnapper.h @@ -539,7 +543,8 @@

                                                                                                                                    - w -

                                                                                                                                      : ws_display_tooltips.h
                                                                                                                                    • WS_MAX_ALT_WIFI_NETWORKS -: Wippersnapper.h +: Wippersnapper_Networking.h +, Wippersnapper.h
                                                                                                                                    • WS_MQTT_MAX_PAYLOAD_SIZE : Wippersnapper.h diff --git a/html/globals_defs.html b/html/globals_defs.html index 539ab4156..48b3da928 100644 --- a/html/globals_defs.html +++ b/html/globals_defs.html @@ -241,7 +241,6 @@

                                                                                                                                      - s -

                                                                                                                                      • SPIWIFI : Wippersnapper_AIRLIFT.h -, Wippersnapper_WIFININA.h
                                                                                                                                      • STATUS_DOTSTAR_COLOR_ORDER : Wippersnapper_Boards.h @@ -331,6 +330,9 @@

                                                                                                                                        - v -

                                                                                                                                          - w -

                                                                                                                                            +
                                                                                                                                          • WL_MAC_ADDR_LENGTH +: Wippersnapper_Networking.h +
                                                                                                                                          • WS_DEBUG : Wippersnapper.h
                                                                                                                                            • @@ -363,6 +365,7 @@

                                                                                                                                            - w -

                                                                                                                                            • WS_MAX_ALT_WIFI_NETWORKS : Wippersnapper.h +, Wippersnapper_Networking.h
                                                                                                                                            • WS_MQTT_MAX_PAYLOAD_SIZE : Wippersnapper.h diff --git a/html/globals_func.html b/html/globals_func.html index aac977fe9..5532a2ee0 100644 --- a/html/globals_func.html +++ b/html/globals_func.html @@ -61,6 +61,9 @@  

                                                                                                                                              - c -

                                                                                                                                                +
                                                                                                                                              • calculateHysteresis() +: Wippersnapper_AnalogIO.cpp +
                                                                                                                                              • cbDecodeDigitalPinWriteMsg() : Wippersnapper.cpp
                                                                                                                                                • diff --git a/html/globals_vars.html b/html/globals_vars.html index bc24379bb..1046c0fa6 100644 --- a/html/globals_vars.html +++ b/html/globals_vars.html @@ -75,7 +75,6 @@ , ws_display_driver.h , Wippersnapper_AIRLIFT.h , Wippersnapper_ESP32.h -, Wippersnapper_WIFININA.h , Wippersnapper.cpp , Wippersnapper.h diff --git a/html/hierarchy.html b/html/hierarchy.html index 3ccda048d..270e24e7a 100644 --- a/html/hierarchy.html +++ b/html/hierarchy.html @@ -74,72 +74,73 @@  ▼CWippersnapperClass that provides storage and functions for the Adafruit IO Wippersnapper interface  CWippersnapper_AIRLIFTClass for using the AirLift Co-Processor network iface  CWippersnapper_ESP32Class for using the ESP32 network interface - CWippersnapper_WIFININAClass for using the AirLift Co-Processor network iface - CWippersnapper_AnalogIOClass that provides an interface for reading and controlling analog pins. Stores information about analog input pins - CWipperSnapper_Component_I2CClass that provides an interface with the I2C bus - CWippersnapper_DigitalGPIOClass that provides functions for reading and interacting with digital inputs and outputs - ▼CWipperSnapper_I2C_DriverBase class for I2C Drivers - CWipperSnapper_I2C_Driver_ADT7410Class that provides a driver interface for a ADT7410 sensor - CWipperSnapper_I2C_Driver_AHTX0Class that provides a sensor driver for the AHTX0 temperature and humidity sensor - CWipperSnapper_I2C_Driver_BH1750Class that provides a driver interface for a BH1750 Light sensor - CWipperSnapper_I2C_Driver_BME280Class that provides a sensor driver for the BME280 temperature and humidity sensor - CWipperSnapper_I2C_Driver_BME680Class that provides a sensor driver for the BME680 temperature and humidity sensor - CWipperSnapper_I2C_Driver_BMP280Class that provides a sensor driver for the BMP280 temperature and pressure sensor - CWipperSnapper_I2C_Driver_BMP3XXClass that provides a sensor driver for the BMP3XX temperature and pressure sensor - CWipperSnapper_I2C_Driver_DPS310Class that provides a sensor driver for the DPS310 barometric pressure sensor - CWipperSnapper_I2C_Driver_DS2484Class that provides a sensor driver for the DS2484 I2C OneWire converter hosting a DS18b20 temperature sensor - CWipperSnapper_I2C_Driver_ENS160Class that provides a sensor driver for the ENS160 temperature and humidity sensor - CWipperSnapper_I2C_Driver_HDC302XClass that provides a sensor driver for the HDC302X humidity and temperature sensor. This implementation uses the 1 Hz data rate - CWipperSnapper_I2C_Driver_HTS221Class that provides a sensor driver for the HTS221 humidity and temperature sensor. This implementation uses the 1 Hz data rate - CWipperSnapper_I2C_Driver_HTU21DClass that provides a sensor driver for the HTU21D humidity and temperature sensor - CWipperSnapper_I2C_Driver_HTU31DClass that provides a sensor driver for the HTU31D humidity and temperature sensor - CWipperSnapper_I2C_Driver_INA219Class that provides a driver interface for a INA219 sensor - CWipperSnapper_I2C_Driver_LC709203FClass that provides a driver interface for a LC709203F sensor - CWipperSnapper_I2C_Driver_LPS22HBClass that provides a sensor driver for the LPS22HB temperature and pressure sensor - CWipperSnapper_I2C_Driver_LPS25HBClass that provides a sensor driver for the LPS25HB temperature and pressure sensor - CWipperSnapper_I2C_Driver_LPS3XHWClass that provides a sensor driver for the LPS3XHW temperature and pressure sensor - CWipperSnapper_I2C_Driver_LTR329_LTR303Class that provides a driver interface for a LTR329/303 sensor - CWipperSnapper_I2C_Driver_LTR390Class that provides a driver interface for a LTR390 sensor - CWipperSnapper_I2C_Driver_MAX17048Class that provides a driver interface for a MAX17048 sensor - CWipperSnapper_I2C_Driver_MCP3421Class that provides a driver interface for a MCP3421 sensor - CWipperSnapper_I2C_Driver_MCP9808Class that provides a driver interface for a MCP9808 sensor - CWipperSnapper_I2C_Driver_MPL115A2Class that provides a sensor driver for the MPL115A2 temperature and pressure sensor - CWipperSnapper_I2C_Driver_MPRLSClass that provides a sensor driver for the MPRLS sensor - CWipperSnapper_I2C_Driver_MS8607Class that provides a sensor driver for the MS8607 PHT sensor - CWipperSnapper_I2C_Driver_NAU7802Class that provides a driver interface for the NAU7802 - CWipperSnapper_I2C_Driver_PCT2075Class that provides a driver interface for a PCT2075 sensor - CWipperSnapper_I2C_Driver_PM25Class that provides a driver interface for the PM25 sensor - CWipperSnapper_I2C_Driver_SCD30Class that provides a driver interface for the SCD30 sensor - CWipperSnapper_I2C_Driver_SCD4XClass that provides a driver interface for the SCD40 sensor - CWipperSnapper_I2C_Driver_SEN5XClass that provides a driver interface for the SEN5X sensor - CWipperSnapper_I2C_Driver_SGP30Class that provides a driver interface for a SGP30 sensor - CWipperSnapper_I2C_Driver_SGP40Class that provides a driver interface for the SGP40 sensor - CWipperSnapper_I2C_Driver_SHT3XClass that provides a driver interface for the SHT3X sensor - CWipperSnapper_I2C_Driver_SHT4XClass that provides a driver interface for the SHT4X sensor - CWipperSnapper_I2C_Driver_SHTC3Class that provides a driver interface for the SHTC3 sensor - CWipperSnapper_I2C_Driver_SI7021Class that provides a driver interface for the SI7021 sensor - CWipperSnapper_I2C_Driver_STEMMA_Soil_SensorClass that provides a driver interface for the STEMMA soil sensor - CWipperSnapper_I2C_Driver_TMP117Class that provides a driver interface for a TMP117 sensor - CWipperSnapper_I2C_Driver_TSL2591Class that provides a driver interface for a TSL2591 sensor - CWipperSnapper_I2C_Driver_VCNL4020Class that provides a driver interface for a VCNL4020 sensor - CWipperSnapper_I2C_Driver_VCNL4040Class that provides a driver interface for a VCNL4040 sensor - CWipperSnapper_I2C_Driver_VEML7700Class that provides a driver interface for a VEML7700 sensor - CWipperSnapper_I2C_Driver_VL53L0XClass that provides a driver interface for a VL53L0X sensor - CWipperSnapper_I2C_Driver_VL53L1XClass that provides a driver interface for a VL53L1X sensor - CWipperSnapper_I2C_Driver_VL53L4CDClass that provides a driver interface for a VL53L4CD sensor - CWipperSnapper_I2C_Driver_VL53L4CXClass that provides a driver interface for a VL53L4CX sensor - CWipperSnapper_I2C_Driver_VL6180XClass that provides a driver interface for a VL6180X sensor - Cws_display_driverDisplay driver for LVGL and LVGL_Glue in WipperSnapper - Cws_display_ui_helperHelps build and manage the LVGL objects and screens for the application code - Cws_ds18x20Class that provides an interface with DS18X20-compatible sensors - Cws_ledcHigh-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls - Cws_ledc_servoHigh-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h) - Cws_pixelsFriend class - Cws_pwmInterface for WipperSnapper PWM - Cws_servoInterface for WipperSnapper servo control - Cws_uartClass that provides an interface between WipperSnapper's app and the device's UART bus - ▼Cws_uart_drvBase class for UART Device Drivers - Cws_uart_drv_pm25aqiClass that provides an interface for a PM25 AQI UART sensor + CWippersnapper_AnalogIOClass that provides an interface for reading and controlling analog pins. Stores information about analog input pins + CWipperSnapper_Component_I2CClass that provides an interface with the I2C bus + CWippersnapper_DigitalGPIOClass that provides functions for reading and interacting with digital inputs and outputs + ▼CWipperSnapper_I2C_DriverBase class for I2C Drivers + CWipperSnapper_I2C_Driver_ADT7410Class that provides a driver interface for a ADT7410 sensor + CWipperSnapper_I2C_Driver_AHTX0Class that provides a sensor driver for the AHTX0 temperature and humidity sensor + CWipperSnapper_I2C_Driver_BH1750Class that provides a driver interface for a BH1750 Light sensor + CWipperSnapper_I2C_Driver_BME280Class that provides a sensor driver for the BME280 temperature and humidity sensor + CWipperSnapper_I2C_Driver_BME680Class that provides a sensor driver for the BME680 temperature and humidity sensor + CWipperSnapper_I2C_Driver_BMP280Class that provides a sensor driver for the BMP280 temperature and pressure sensor + CWipperSnapper_I2C_Driver_BMP3XXClass that provides a sensor driver for the BMP3XX temperature and pressure sensor + CWipperSnapper_I2C_Driver_DPS310Class that provides a sensor driver for the DPS310 barometric pressure sensor + CWipperSnapper_I2C_Driver_DS2484Class that provides a sensor driver for the DS2484 I2C OneWire converter hosting a DS18b20 temperature sensor + CWipperSnapper_I2C_Driver_ENS160Class that provides a sensor driver for the ENS160 temperature and humidity sensor + CWipperSnapper_I2C_Driver_HDC302XClass that provides a sensor driver for the HDC302X humidity and temperature sensor. This implementation uses the 1 Hz data rate + CWipperSnapper_I2C_Driver_HTS221Class that provides a sensor driver for the HTS221 humidity and temperature sensor. This implementation uses the 1 Hz data rate + CWipperSnapper_I2C_Driver_HTU21DClass that provides a sensor driver for the HTU21D humidity and temperature sensor + CWipperSnapper_I2C_Driver_HTU31DClass that provides a sensor driver for the HTU31D humidity and temperature sensor + CWipperSnapper_I2C_Driver_INA219Class that provides a driver interface for a INA219 sensor + CWipperSnapper_I2C_Driver_LC709203FClass that provides a driver interface for a LC709203F sensor + CWipperSnapper_I2C_Driver_LPS22HBClass that provides a sensor driver for the LPS22HB temperature and pressure sensor + CWipperSnapper_I2C_Driver_LPS25HBClass that provides a sensor driver for the LPS25HB temperature and pressure sensor + CWipperSnapper_I2C_Driver_LPS3XHWClass that provides a sensor driver for the LPS3XHW temperature and pressure sensor + CWipperSnapper_I2C_Driver_LTR329_LTR303Class that provides a driver interface for a LTR329/303 sensor + CWipperSnapper_I2C_Driver_LTR390Class that provides a driver interface for a LTR390 sensor + CWipperSnapper_I2C_Driver_MAX17048Class that provides a driver interface for a MAX17048 sensor + CWipperSnapper_I2C_Driver_MCP3421Class that provides a driver interface for a MCP3421 sensor + CWipperSnapper_I2C_Driver_MCP9808Class that provides a driver interface for a MCP9808 sensor + CWipperSnapper_I2C_Driver_MPL115A2Class that provides a sensor driver for the MPL115A2 temperature and pressure sensor + CWipperSnapper_I2C_Driver_MPRLSClass that provides a sensor driver for the MPRLS sensor + CWipperSnapper_I2C_Driver_MS8607Class that provides a sensor driver for the MS8607 PHT sensor + CWipperSnapper_I2C_Driver_NAU7802Class that provides a driver interface for the NAU7802 + CWipperSnapper_I2C_Driver_PCT2075Class that provides a driver interface for a PCT2075 sensor + CWipperSnapper_I2C_Driver_PM25Class that provides a driver interface for the PM25 sensor + CWipperSnapper_I2C_Driver_SCD30Class that provides a driver interface for the SCD30 sensor + CWipperSnapper_I2C_Driver_SCD4XClass that provides a driver interface for the SCD40 sensor + CWipperSnapper_I2C_Driver_SEN5XClass that provides a driver interface for the SEN5X sensor + CWipperSnapper_I2C_Driver_SEN6XClass that provides a driver interface for the SEN6X sensor + CWipperSnapper_I2C_Driver_SGP30Class that provides a driver interface for a SGP30 sensor + CWipperSnapper_I2C_Driver_SGP40Class that provides a driver interface for the SGP40 sensor + CWipperSnapper_I2C_Driver_SHT3XClass that provides a driver interface for the SHT3X sensor + CWipperSnapper_I2C_Driver_SHT4XClass that provides a driver interface for the SHT4X sensor + CWipperSnapper_I2C_Driver_SHTC3Class that provides a driver interface for the SHTC3 sensor + CWipperSnapper_I2C_Driver_SI7021Class that provides a driver interface for the SI7021 sensor + CWipperSnapper_I2C_Driver_STEMMA_Soil_SensorClass that provides a driver interface for the STEMMA soil sensor + CWipperSnapper_I2C_Driver_TMP117Class that provides a driver interface for a TMP117 sensor + CWipperSnapper_I2C_Driver_TSL2591Class that provides a driver interface for a TSL2591 sensor + CWipperSnapper_I2C_Driver_VCNL4020Class that provides a driver interface for a VCNL4020 sensor + CWipperSnapper_I2C_Driver_VCNL4040Class that provides a driver interface for a VCNL4040 sensor + CWipperSnapper_I2C_Driver_VCNL4200Class that provides a driver interface for a VCNL4200 sensor + CWipperSnapper_I2C_Driver_VEML7700Class that provides a driver interface for a VEML7700 sensor + CWipperSnapper_I2C_Driver_VL53L0XClass that provides a driver interface for a VL53L0X sensor + CWipperSnapper_I2C_Driver_VL53L1XClass that provides a driver interface for a VL53L1X sensor + CWipperSnapper_I2C_Driver_VL53L4CDClass that provides a driver interface for a VL53L4CD sensor + CWipperSnapper_I2C_Driver_VL53L4CXClass that provides a driver interface for a VL53L4CX sensor + CWipperSnapper_I2C_Driver_VL6180XClass that provides a driver interface for a VL6180X sensor + Cws_display_driverDisplay driver for LVGL and LVGL_Glue in WipperSnapper + Cws_display_ui_helperHelps build and manage the LVGL objects and screens for the application code + Cws_ds18x20Class that provides an interface with DS18X20-compatible sensors + Cws_ledcHigh-level interface for the ESP32/ESP32-Sx/ESP32-Cx LED Control (LEDC) peripheral. Instead of specifying a timer or channel, this class automatically allocates a channel and associates it with a pin. Underlying esp32-hal-ledc performs timer management and handles the low-level LEDC peripheral API calls + Cws_ledc_servoHigh-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the functions within the Arduino servo library, (https://github.com/arduino-libraries/Servo/blob/master/src/Servo.h) + Cws_pixelsFriend class + Cws_pwmInterface for WipperSnapper PWM + Cws_servoInterface for WipperSnapper servo control + Cws_uartClass that provides an interface between WipperSnapper's app and the device's UART bus + ▼Cws_uart_drvBase class for UART Device Drivers + Cws_uart_drv_pm25aqiClass that provides an interface for a PM25 AQI UART sensor diff --git a/html/search/all_0.js b/html/search/all_0.js index 28551067a..741d09bf2 100644 --- a/html/search/all_0.js +++ b/html/search/all_0.js @@ -31,7 +31,7 @@ var searchData= ['_5fco2sensorperiod',['_CO2SensorPeriod',['../class_wipper_snapper___i2_c___driver.html#a5abe2283cf41155b99c33a30536a6d43',1,'WipperSnapper_I2C_Driver']]], ['_5fco2sensorperiodprv',['_CO2SensorPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a1957aa4b7e8e9d6ac0947e465b2703ee',1,'WipperSnapper_I2C_Driver']]], ['_5fconfig',['_config',['../class_wippersnapper.html#a7c96d5d9235b21de6dc3dd33362c5c56',1,'Wippersnapper']]], - ['_5fconnect',['_connect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a47f15e4f94c2fa403ff8c70be97156c3',1,'Wippersnapper_AIRLIFT::_connect()'],['../class_wippersnapper___e_s_p32.html#a6b4b61de089e76200f78ecfee79ff741',1,'Wippersnapper_ESP32::_connect()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a37499d40e4c1258c68bf332dd20a0947',1,'Wippersnapper_WIFININA::_connect()'],['../class_wippersnapper.html#ad87ad173ce1969274e5d83af2621c265',1,'Wippersnapper::_connect()']]], + ['_5fconnect',['_connect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a47f15e4f94c2fa403ff8c70be97156c3',1,'Wippersnapper_AIRLIFT::_connect()'],['../class_wippersnapper___e_s_p32.html#a6b4b61de089e76200f78ecfee79ff741',1,'Wippersnapper_ESP32::_connect()'],['../class_wippersnapper.html#ad87ad173ce1969274e5d83af2621c265',1,'Wippersnapper::_connect()']]], ['_5fcurrentperiod',['_currentPeriod',['../class_wipper_snapper___i2_c___driver.html#a8d143ec190484ebb2c5ddce93094d5c2',1,'WipperSnapper_I2C_Driver']]], ['_5fcurrentperiodprv',['_currentPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#ab8d85a728435adec41e3c60669a635cd',1,'WipperSnapper_I2C_Driver']]], ['_5fdata',['_data',['../classws__uart__drv__pm25aqi.html#a645a076aaa0bac6c9e0c19ccf417aa74',1,'ws_uart_drv_pm25aqi']]], @@ -40,7 +40,7 @@ var searchData= ['_5fdeviceid',['_deviceId',['../class_wippersnapper.html#a9aae6871fe2f29d6a9c61c504d47f100',1,'Wippersnapper']]], ['_5fdigital_5finput_5fpins',['_digital_input_pins',['../class_wippersnapper___digital_g_p_i_o.html#a70858f8fcd056c4c6d13ea049d556cee',1,'Wippersnapper_DigitalGPIO']]], ['_5fdigitalgpio',['_digitalGPIO',['../class_wippersnapper.html#a7b20da8a2d56194d6d8d08a15c3d1ea5',1,'Wippersnapper']]], - ['_5fdisconnect',['_disconnect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a03105722dccd0573b2c505abcc44020e',1,'Wippersnapper_AIRLIFT::_disconnect()'],['../class_wippersnapper___e_s_p32.html#a979ca637505009d2cca04524665931e4',1,'Wippersnapper_ESP32::_disconnect()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a4f1d178172a418dc1ba7df6ff4ded92c',1,'Wippersnapper_WIFININA::_disconnect()'],['../class_wippersnapper.html#a5ba2ef7071046c072b644d56c71b31d3',1,'Wippersnapper::_disconnect()']]], + ['_5fdisconnect',['_disconnect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a03105722dccd0573b2c505abcc44020e',1,'Wippersnapper_AIRLIFT::_disconnect()'],['../class_wippersnapper___e_s_p32.html#a979ca637505009d2cca04524665931e4',1,'Wippersnapper_ESP32::_disconnect()'],['../class_wippersnapper.html#a5ba2ef7071046c072b644d56c71b31d3',1,'Wippersnapper::_disconnect()']]], ['_5fdisplay',['_display',['../class_wippersnapper.html#abd97f2e25ddcb123759f1bb417c761b6',1,'Wippersnapper']]], ['_5fdps310',['_dps310',['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a1d3d79a1d15ab26da1a4a88ed85194b9',1,'WipperSnapper_I2C_Driver_DPS310']]], ['_5fdps_5fpressure',['_dps_pressure',['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a0c80d8d91c76454845bfd70fc1e128de',1,'WipperSnapper_I2C_Driver_DPS310']]], @@ -76,7 +76,6 @@ var searchData= ['_5fisi2cport0init',['_isI2CPort0Init',['../class_wippersnapper.html#a6386fe27a2b8f17d6dadcd5e18ebe4f7',1,'Wippersnapper']]], ['_5fisi2cport1init',['_isI2CPort1Init',['../class_wippersnapper.html#a486962cdb0c74670b8888497695b3987',1,'Wippersnapper']]], ['_5fiswifimulti',['_isWiFiMulti',['../class_wippersnapper.html#aaae962d10a8621ea632bee4045194734',1,'Wippersnapper']]], - ['_5fkey',['_key',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ace1daabe52f7a5f3b706fe74193d0b84',1,'Wippersnapper_WIFININA']]], ['_5flast_5fmqtt_5fconnect',['_last_mqtt_connect',['../class_wippersnapper.html#ad91ea7ed5595bd655f0a8719a7216a45',1,'Wippersnapper']]], ['_5flastread',['_lastRead',['../class_wipper_snapper___i2_c___driver___s_c_d30.html#abb830197d2c8b5be45f2bd2fc36c365b',1,'WipperSnapper_I2C_Driver_SCD30']]], ['_5flc',['_lc',['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a2f963f4bd08c6ab7132242eb239a12e1',1,'WipperSnapper_I2C_Driver_LC709203F']]], @@ -96,7 +95,7 @@ var searchData= ['_5fmpl115a2',['_mpl115a2',['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#af6d6a1b39f29b21286f0a19d1cedeb18',1,'WipperSnapper_I2C_Driver_MPL115A2']]], ['_5fmprls',['_mprls',['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#a122da94ed5f65ec0b0344e580e282cfb',1,'WipperSnapper_I2C_Driver_MPRLS']]], ['_5fmqtt',['_mqtt',['../class_wippersnapper.html#a4aae92d295fa7740aef1bd6e45a13349',1,'Wippersnapper']]], - ['_5fmqtt_5fclient',['_mqtt_client',['../class_wippersnapper___a_i_r_l_i_f_t.html#af56696c5a407755fb5a998747250f116',1,'Wippersnapper_AIRLIFT::_mqtt_client()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#af1e950739e88ebe968346be3a6d54c57',1,'Wippersnapper_WIFININA::_mqtt_client()']]], + ['_5fmqtt_5fclient',['_mqtt_client',['../class_wippersnapper___a_i_r_l_i_f_t.html#af56696c5a407755fb5a998747250f116',1,'Wippersnapper_AIRLIFT']]], ['_5fmqtt_5fclient_5finsecure',['_mqtt_client_insecure',['../class_wippersnapper___e_s_p32.html#aeb38f3f6b82a53c00e21851170c407b1',1,'Wippersnapper_ESP32']]], ['_5fmqtt_5fclient_5fsecure',['_mqtt_client_secure',['../class_wippersnapper___e_s_p32.html#a0c459cc04c4535a74651c4b2e8b02613',1,'Wippersnapper_ESP32']]], ['_5fms8607',['_ms8607',['../class_wipper_snapper___i2_c___driver___m_s8607.html#a55897c4491bcdebb148655e6bd492e0b',1,'WipperSnapper_I2C_Driver_MS8607']]], @@ -112,7 +111,7 @@ var searchData= ['_5fobjecttempsensorperiod',['_objectTempSensorPeriod',['../class_wipper_snapper___i2_c___driver.html#a8d7e58b7a4a7ff699704a32129f7a9c3',1,'WipperSnapper_I2C_Driver']]], ['_5fobjecttempsensorperiodprv',['_objectTempSensorPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a738f4988bef3af61be5d6c07076a8ea4',1,'WipperSnapper_I2C_Driver']]], ['_5foutgoingsignalmsg',['_outgoingSignalMsg',['../class_wippersnapper.html#a3c5eb7a0b81de9ca7472e4a37b3d27fe',1,'Wippersnapper']]], - ['_5fpass',['_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a60b11a804f697efcb2958126eb280b53',1,'Wippersnapper_AIRLIFT::_pass()'],['../class_wippersnapper___e_s_p32.html#a55257dfc5d30811ed8c9c95ae09e797f',1,'Wippersnapper_ESP32::_pass()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#addedfe0336fb0c28f0d9a781ceb51e90',1,'Wippersnapper_WIFININA::_pass()']]], + ['_5fpass',['_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a60b11a804f697efcb2958126eb280b53',1,'Wippersnapper_AIRLIFT::_pass()'],['../class_wippersnapper___e_s_p32.html#a55257dfc5d30811ed8c9c95ae09e797f',1,'Wippersnapper_ESP32::_pass()']]], ['_5fpct2075',['_pct2075',['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a6a17137d1bbd9e9cf77b161a47e38f4e',1,'WipperSnapper_I2C_Driver_PCT2075']]], ['_5fpm100sensorperiod',['_PM100SensorPeriod',['../class_wipper_snapper___i2_c___driver.html#a6cc8417bd7488f67b40ab0cb7fa4ae2b',1,'WipperSnapper_I2C_Driver']]], ['_5fpm100sensorperiodprv',['_PM100SensorPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a24acc438f04269354675149cd192c107',1,'WipperSnapper_I2C_Driver']]], @@ -135,7 +134,7 @@ var searchData= ['_5frstpin',['_rstPin',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6c28583752d13621a35bedc67e4e4913',1,'Wippersnapper_AIRLIFT']]], ['_5fscd',['_scd',['../class_wipper_snapper___i2_c___driver___s_c_d30.html#adcefb7aac525eb79073e50392ea7fe16',1,'WipperSnapper_I2C_Driver_SCD30::_scd()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a8e49ec7f6bdf9920d1c0c04026c8639a',1,'WipperSnapper_I2C_Driver_SCD4X::_scd()']]], ['_5fseesaw',['_seesaw',['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a9c970df33787ee1ecf2b54a3214d72d2',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor']]], - ['_5fsen',['_sen',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ae20509ae9eb3779f58cb848a5dc0487f',1,'WipperSnapper_I2C_Driver_SEN5X']]], + ['_5fsen',['_sen',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ae20509ae9eb3779f58cb848a5dc0487f',1,'WipperSnapper_I2C_Driver_SEN5X::_sen()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a4fff95dbd373356a0b0d846ddfa5e9d6',1,'WipperSnapper_I2C_Driver_SEN6X::_sen()']]], ['_5fsensoraddress',['_sensorAddress',['../class_wipper_snapper___i2_c___driver.html#a504fa3d1869f741dbb46a8e5f5f5e281',1,'WipperSnapper_I2C_Driver']]], ['_5fservocomponent',['_servoComponent',['../class_wippersnapper.html#acb20c02d9bbe7ed659a0d75de7fba140',1,'Wippersnapper']]], ['_5fsgp30',['_sgp30',['../class_wipper_snapper___i2_c___driver___s_g_p30.html#a6d59a65978abd3e6984dd25a82913740',1,'WipperSnapper_I2C_Driver_SGP30']]], @@ -144,7 +143,7 @@ var searchData= ['_5fsht4x',['_sht4x',['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#af96c1dc36d17a65fc2bc55c980afb85f',1,'WipperSnapper_I2C_Driver_SHT4X']]], ['_5fshtc3',['_shtc3',['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#aa4e217af3d48bcc008c50e51ee004c9c',1,'WipperSnapper_I2C_Driver_SHTC3']]], ['_5fsi7021',['_si7021',['../class_wipper_snapper___i2_c___driver___s_i7021.html#acd884eab3fd217ec4172e68ba53cebd4',1,'WipperSnapper_I2C_Driver_SI7021']]], - ['_5fssid',['_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6ec6435a676ba335c86f47bc373ac2e6',1,'Wippersnapper_AIRLIFT::_ssid()'],['../class_wippersnapper___e_s_p32.html#a2ada973343e53f2496910ab4069e0dba',1,'Wippersnapper_ESP32::_ssid()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a7b2129e4a4691c6b57a2a78719929cd9',1,'Wippersnapper_WIFININA::_ssid()']]], + ['_5fssid',['_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6ec6435a676ba335c86f47bc373ac2e6',1,'Wippersnapper_AIRLIFT::_ssid()'],['../class_wippersnapper___e_s_p32.html#a2ada973343e53f2496910ab4069e0dba',1,'Wippersnapper_ESP32::_ssid()']]], ['_5fsspin',['_ssPin',['../class_wippersnapper___a_i_r_l_i_f_t.html#ae0fb6f803b4a9f81d9a4b15ffa46a9ee',1,'Wippersnapper_AIRLIFT']]], ['_5fstatus',['_status',['../class_wippersnapper.html#a9a1b5d8342f11f48567092a643d9cd94',1,'Wippersnapper']]], ['_5ftemp',['_temp',['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a6f889cd621eae8dec94be48137f79611',1,'WipperSnapper_I2C_Driver_HDC302X::_temp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a61ced59bf908a05b59277459589154e4',1,'WipperSnapper_I2C_Driver_LPS22HB::_temp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a3850f4282d6ea200b18a92120ae102d4',1,'WipperSnapper_I2C_Driver_LPS25HB::_temp()']]], @@ -188,9 +187,9 @@ var searchData= ['_5fui_5fhelper',['_ui_helper',['../class_wippersnapper.html#ac82ed8f8ce5f18a34f696cfc385038de',1,'Wippersnapper']]], ['_5funitlesspercentperiod',['_unitlessPercentPeriod',['../class_wipper_snapper___i2_c___driver.html#ae62156acc732bcebe5652dadd87ee459',1,'WipperSnapper_I2C_Driver']]], ['_5funitlesspercentperiodprv',['_unitlessPercentPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#aba6581748d333e113d208a467edaee03',1,'WipperSnapper_I2C_Driver']]], - ['_5fusername',['_username',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a22ef7feaaecda8b135f3cccdae583218',1,'Wippersnapper_WIFININA']]], ['_5fvcnl4020',['_vcnl4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a6ded33fbd8b2db1a1805d878b8cceeb1',1,'WipperSnapper_I2C_Driver_VCNL4020']]], ['_5fvcnl4040',['_vcnl4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#ab0d70da76123cc6eb97d6a26fcde4724',1,'WipperSnapper_I2C_Driver_VCNL4040']]], + ['_5fvcnl4200',['_vcnl4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a0066360d4651e405d0501f3ee5ac884a',1,'WipperSnapper_I2C_Driver_VCNL4200']]], ['_5fveml',['_veml',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a9b1e691b1b4ed22c7439ae577858a93c',1,'WipperSnapper_I2C_Driver_VEML7700']]], ['_5fvl53l0x',['_vl53l0x',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#ad3c6acc57106862138f4974b9ad76b31',1,'WipperSnapper_I2C_Driver_VL53L0X']]], ['_5fvl53l1x',['_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a3dfd5af1e3e99b6bff347eeda39a0185',1,'WipperSnapper_I2C_Driver_VL53L1X']]], @@ -201,7 +200,7 @@ var searchData= ['_5fvocindexperiodprv',['_VOCIndexPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a4cee6abb91a33770472b4db891f39b06',1,'WipperSnapper_I2C_Driver']]], ['_5fvoltageperiod',['_voltagePeriod',['../class_wipper_snapper___i2_c___driver.html#a3c0b67eb3397dd2e439cdcffc3c8db74',1,'WipperSnapper_I2C_Driver']]], ['_5fvoltageperiodprv',['_voltagePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a2b3343936adcbad3ac36827b8d6e71ab',1,'WipperSnapper_I2C_Driver']]], - ['_5fwifi',['_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#a583121d8e9177c59463b815ceac98ea6',1,'Wippersnapper_AIRLIFT::_wifi()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a0543a08ce2fdf662678eb69a9f6145ee',1,'Wippersnapper_WIFININA::_wifi()']]], + ['_5fwifi',['_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#a583121d8e9177c59463b815ceac98ea6',1,'Wippersnapper_AIRLIFT']]], ['_5fwifimulti',['_wifiMulti',['../class_wippersnapper___e_s_p32.html#a3bb14b42e597e2ac2a78df5fd32ea6c4',1,'Wippersnapper_ESP32']]], ['_5fws_5fpixelscomponent',['_ws_pixelsComponent',['../class_wippersnapper.html#acba8bb65ab39d1adc9c40890dddad99f',1,'Wippersnapper']]] ]; diff --git a/html/search/all_10.js b/html/search/all_10.js index c96e0763d..f015db0c7 100644 --- a/html/search/all_10.js +++ b/html/search/all_10.js @@ -22,9 +22,9 @@ var searchData= ['set_5flabel_5fstatus',['set_label_status',['../classws__display__ui__helper.html#af65c0213180b7371ab4c1022b46e08f4',1,'ws_display_ui_helper']]], ['set_5fload_5fbar_5ficon_5fcomplete',['set_load_bar_icon_complete',['../classws__display__ui__helper.html#aa37063cd4c304113e7f128daa5adbc51',1,'ws_display_ui_helper']]], ['set_5fmqtt_5fclient',['set_mqtt_client',['../classws__uart__drv.html#af6b65c78ca79a65654612ab6320fcdfa',1,'ws_uart_drv']]], - ['set_5fssid_5fpass',['set_ssid_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5d98c8d0158c551f78c242ed57e42165',1,'Wippersnapper_AIRLIFT::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___a_i_r_l_i_f_t.html#a9e842381c45f33016ab030a875b25a76',1,'Wippersnapper_AIRLIFT::set_ssid_pass()'],['../class_wippersnapper___e_s_p32.html#a6e93f243e49a45ad4a41a1e1f48a9bcf',1,'Wippersnapper_ESP32::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___e_s_p32.html#a5f079d18dd8e8bfbc452c6574f38df23',1,'Wippersnapper_ESP32::set_ssid_pass()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a12f2c625c55546f1cc318ed352db7be4',1,'Wippersnapper_WIFININA::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a58891176b851ade0d5c563c609cbee59',1,'Wippersnapper_WIFININA::set_ssid_pass()'],['../class_wippersnapper.html#a50aca7f9bc2ced0a2928c1f85624c9b8',1,'Wippersnapper::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper.html#aed020a82571d3b7fc1ee9038b857f9fa',1,'Wippersnapper::set_ssid_pass()']]], - ['set_5fuser_5fkey',['set_user_key',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a0861f453a20f78a3c6b8e6667c468cbe',1,'Wippersnapper_WIFININA::set_user_key()'],['../class_wippersnapper.html#ae17c82aa45ff311c9cc8a23b98acca92',1,'Wippersnapper::set_user_key()']]], - ['set_5fwifi',['set_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#aab1d7de6deaed143f3cbdaf85ec46294',1,'Wippersnapper_AIRLIFT::set_wifi()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aeb13046386ec0dd146153fec95845eea',1,'Wippersnapper_WIFININA::set_wifi()']]], + ['set_5fssid_5fpass',['set_ssid_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5d98c8d0158c551f78c242ed57e42165',1,'Wippersnapper_AIRLIFT::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___a_i_r_l_i_f_t.html#a9e842381c45f33016ab030a875b25a76',1,'Wippersnapper_AIRLIFT::set_ssid_pass()'],['../class_wippersnapper___e_s_p32.html#a6e93f243e49a45ad4a41a1e1f48a9bcf',1,'Wippersnapper_ESP32::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___e_s_p32.html#a5f079d18dd8e8bfbc452c6574f38df23',1,'Wippersnapper_ESP32::set_ssid_pass()'],['../class_wippersnapper.html#a50aca7f9bc2ced0a2928c1f85624c9b8',1,'Wippersnapper::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper.html#aed020a82571d3b7fc1ee9038b857f9fa',1,'Wippersnapper::set_ssid_pass()']]], + ['set_5fuser_5fkey',['set_user_key',['../class_wippersnapper.html#ae17c82aa45ff311c9cc8a23b98acca92',1,'Wippersnapper']]], + ['set_5fwifi',['set_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#aab1d7de6deaed143f3cbdaf85ec46294',1,'Wippersnapper_AIRLIFT']]], ['setadcresolution',['setADCResolution',['../class_wippersnapper___analog_i_o.html#a883d16afad81abb3b8fe6398427580cb',1,'Wippersnapper_AnalogIO']]], ['setaref',['setAref',['../class_wippersnapper___analog_i_o.html#ae715f810b324c90bca4d4bc2dbccb408',1,'Wippersnapper_AnalogIO']]], ['setdriverid',['setDriverID',['../classws__uart__drv.html#a91fab7684041e996ef713362740c7af4',1,'ws_uart_drv']]], @@ -59,10 +59,10 @@ var searchData= ['setsensorvoltageperiodprv',['setSensorVoltagePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#abc393b0d4db17e527ea70599d2a9df05',1,'WipperSnapper_I2C_Driver']]], ['setstatusledbrightness',['setStatusLEDBrightness',['../_wippersnapper___status_l_e_d_8cpp.html#af728f778c367e553747cd874c97ebdda',1,'setStatusLEDBrightness(float brightness): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#af728f778c367e553747cd874c97ebdda',1,'setStatusLEDBrightness(float brightness): Wippersnapper_StatusLED.cpp']]], ['setstatusledcolor',['setStatusLEDColor',['../_wippersnapper___status_l_e_d_8cpp.html#ad184a104afaf5e287efca9792e8d57c1',1,'setStatusLEDColor(uint32_t color): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#a8da24cc4b6b91b784e7a35a6f4058e75',1,'setStatusLEDColor(uint32_t color, int brightness): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#ad184a104afaf5e287efca9792e8d57c1',1,'setStatusLEDColor(uint32_t color): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#a8da24cc4b6b91b784e7a35a6f4058e75',1,'setStatusLEDColor(uint32_t color, int brightness): Wippersnapper_StatusLED.cpp']]], - ['setupmqttclient',['setupMQTTClient',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac05433b076a739d94e07222d926a0045',1,'Wippersnapper_AIRLIFT::setupMQTTClient()'],['../class_wippersnapper___e_s_p32.html#a7b0795b00c8de7f3f3523a6ef567700b',1,'Wippersnapper_ESP32::setupMQTTClient()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#af93ea859ff730b169c2ff1bfec455e11',1,'Wippersnapper_WIFININA::setupMQTTClient()'],['../class_wippersnapper.html#a95627d13a469876e0aefb8a120a18732',1,'Wippersnapper::setupMQTTClient()']]], + ['setupmqttclient',['setupMQTTClient',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac05433b076a739d94e07222d926a0045',1,'Wippersnapper_AIRLIFT::setupMQTTClient()'],['../class_wippersnapper___e_s_p32.html#a7b0795b00c8de7f3f3523a6ef567700b',1,'Wippersnapper_ESP32::setupMQTTClient()'],['../class_wippersnapper.html#a95627d13a469876e0aefb8a120a18732',1,'Wippersnapper::setupMQTTClient()']]], ['show_5fscr_5ferror',['show_scr_error',['../classws__display__ui__helper.html#a09e1f336b5185629240e096065352d75',1,'ws_display_ui_helper']]], ['show_5fscr_5fload',['show_scr_load',['../classws__display__ui__helper.html#a971a267aba0d230d7c9a609bd559ed13',1,'ws_display_ui_helper']]], - ['spiwifi',['SPIWIFI',['../_wippersnapper___a_i_r_l_i_f_t_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'SPIWIFI(): Wippersnapper_AIRLIFT.h'],['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'SPIWIFI(): Wippersnapper_WIFININA.h']]], + ['spiwifi',['SPIWIFI',['../_wippersnapper___a_i_r_l_i_f_t_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'Wippersnapper_AIRLIFT.h']]], ['status_5fdotstar_5fcolor_5forder',['STATUS_DOTSTAR_COLOR_ORDER',['../_wippersnapper___boards_8h.html#a8bf6b21e770886d409a5266b34dbc40b',1,'Wippersnapper_Boards.h']]], ['status_5fdotstar_5fnum',['STATUS_DOTSTAR_NUM',['../_wippersnapper___boards_8h.html#a064728df19116a95cb2b2672e85c01bc',1,'Wippersnapper_Boards.h']]], ['status_5fdotstar_5fpin_5fclk',['STATUS_DOTSTAR_PIN_CLK',['../_wippersnapper___boards_8h.html#a882cdccd2b9725880419c51137a383fd',1,'Wippersnapper_Boards.h']]], diff --git a/html/search/all_11.js b/html/search/all_11.js index 4bb0c35b0..598207050 100644 --- a/html/search/all_11.js +++ b/html/search/all_11.js @@ -2,7 +2,7 @@ var searchData= [ ['throttlemessage',['throttleMessage',['../class_wippersnapper.html#a4143bb10fd2cc88f19c79cfc61cbf16f',1,'Wippersnapper']]], ['throttletime',['throttleTime',['../class_wippersnapper.html#a192df644cf517a81649fe5a4f8b32d4b',1,'Wippersnapper']]], - ['timerexpired',['timerExpired',['../class_wippersnapper___analog_i_o.html#a7b9a2a52d3d0ffac5c8a21ef8b74e43b',1,'Wippersnapper_AnalogIO']]], + ['timerexpired',['timerExpired',['../class_wippersnapper___analog_i_o.html#aa59bc605a9a601452b708d716f43923a',1,'Wippersnapper_AnalogIO']]], ['tone',['tone',['../classws__ledc.html#ae30ec473c16e0c787f519dc0fdc81b90',1,'ws_ledc']]], ['topic_5fi2c',['TOPIC_I2C',['../_wippersnapper_8h.html#a32a0a525a3293ab5a136d3cfbb077b87',1,'Wippersnapper.h']]], ['topic_5finfo',['TOPIC_INFO',['../_wippersnapper_8h.html#aca5c392d3a0fc61da9336eccb6d590b0',1,'Wippersnapper.h']]], diff --git a/html/search/all_14.js b/html/search/all_14.js index 31f9102b2..be806d8ac 100644 --- a/html/search/all_14.js +++ b/html/search/all_14.js @@ -85,6 +85,8 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5fscd4x_2eh',['WipperSnapper_I2C_Driver_SCD4X.h',['../_wipper_snapper___i2_c___driver___s_c_d4_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsen5x',['WipperSnapper_I2C_Driver_SEN5X',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html',1,'WipperSnapper_I2C_Driver_SEN5X'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af3138b9f21091b5be1abed29ecc6fd20',1,'WipperSnapper_I2C_Driver_SEN5X::WipperSnapper_I2C_Driver_SEN5X()']]], ['wippersnapper_5fi2c_5fdriver_5fsen5x_2eh',['WipperSnapper_I2C_Driver_SEN5X.h',['../_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fsen6x',['WipperSnapper_I2C_Driver_SEN6X',['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html',1,'WipperSnapper_I2C_Driver_SEN6X'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a5cb6acd8e53bd681aef676af11c5b2aa',1,'WipperSnapper_I2C_Driver_SEN6X::WipperSnapper_I2C_Driver_SEN6X()']]], + ['wippersnapper_5fi2c_5fdriver_5fsen6x_2eh',['WipperSnapper_I2C_Driver_SEN6X.h',['../_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsgp30',['WipperSnapper_I2C_Driver_SGP30',['../class_wipper_snapper___i2_c___driver___s_g_p30.html',1,'WipperSnapper_I2C_Driver_SGP30'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af9fd8d9b94396daf24a92bf89137cebb',1,'WipperSnapper_I2C_Driver_SGP30::WipperSnapper_I2C_Driver_SGP30()']]], ['wippersnapper_5fi2c_5fdriver_5fsgp40',['WipperSnapper_I2C_Driver_SGP40',['../class_wipper_snapper___i2_c___driver___s_g_p40.html',1,'WipperSnapper_I2C_Driver_SGP40'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#af272b01ebcd44fde75f05cb2d899bfac',1,'WipperSnapper_I2C_Driver_SGP40::WipperSnapper_I2C_Driver_SGP40()']]], ['wippersnapper_5fi2c_5fdriver_5fsgp40_2eh',['WipperSnapper_I2C_Driver_SGP40.h',['../_wipper_snapper___i2_c___driver___s_g_p40_8h.html',1,'']]], @@ -106,6 +108,8 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5fvcnl4020_2eh',['WipperSnapper_I2C_Driver_VCNL4020.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4020_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4040',['WipperSnapper_I2C_Driver_VCNL4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html',1,'WipperSnapper_I2C_Driver_VCNL4040'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2ddf9a074faeea9626a351844ea92d19',1,'WipperSnapper_I2C_Driver_VCNL4040::WipperSnapper_I2C_Driver_VCNL4040()']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4040_2eh',['WipperSnapper_I2C_Driver_VCNL4040.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4040_8h.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fvcnl4200',['WipperSnapper_I2C_Driver_VCNL4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html',1,'WipperSnapper_I2C_Driver_VCNL4200'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a08cbed6a83f55ed45e7883f0dbdd7b93',1,'WipperSnapper_I2C_Driver_VCNL4200::WipperSnapper_I2C_Driver_VCNL4200()']]], + ['wippersnapper_5fi2c_5fdriver_5fvcnl4200_2eh',['WipperSnapper_I2C_Driver_VCNL4200.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fveml7700',['WipperSnapper_I2C_Driver_VEML7700',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html',1,'WipperSnapper_I2C_Driver_VEML7700'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#aeb5df38f4d8d59e21a4627f516d0e154',1,'WipperSnapper_I2C_Driver_VEML7700::WipperSnapper_I2C_Driver_VEML7700()']]], ['wippersnapper_5fi2c_5fdriver_5fveml7700_2eh',['WipperSnapper_I2C_Driver_VEML7700.h',['../_wipper_snapper___i2_c___driver___v_e_m_l7700_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l0x',['WipperSnapper_I2C_Driver_VL53L0X',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html',1,'WipperSnapper_I2C_Driver_VL53L0X'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a01032dcb31d0ca9346415fffb0df3121',1,'WipperSnapper_I2C_Driver_VL53L0X::WipperSnapper_I2C_Driver_VL53L0X()']]], @@ -123,12 +127,11 @@ var searchData= ['wippersnapper_5fstatusled_2ecpp',['Wippersnapper_StatusLED.cpp',['../_wippersnapper___status_l_e_d_8cpp.html',1,'']]], ['wippersnapper_5fstatusled_2eh',['Wippersnapper_StatusLED.h',['../_wippersnapper___status_l_e_d_8h.html',1,'']]], ['wippersnapper_5fwifi',['Wippersnapper_WiFi',['../_wippersnapper___networking_8h.html#a9dc805744e5eab98d4e7da12c966744c',1,'Wippersnapper_Networking.h']]], - ['wippersnapper_5fwifinina',['Wippersnapper_WIFININA',['../class_wippersnapper___w_i_f_i_n_i_n_a.html',1,'Wippersnapper_WIFININA'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a788d21129715868932c6526d08e52b90',1,'Wippersnapper_WIFININA::Wippersnapper_WIFININA()']]], - ['wippersnapper_5fwifinina_2eh',['Wippersnapper_WIFININA.h',['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html',1,'']]], + ['wl_5fmac_5faddr_5flength',['WL_MAC_ADDR_LENGTH',['../_wippersnapper___networking_8h.html#ac2f11055182e226f041b9a71e352569f',1,'Wippersnapper_Networking.h']]], ['writedutycycle',['writeDutyCycle',['../classws__pwm.html#a0e9d0fe12cf0cae6b86667863ee3f62c',1,'ws_pwm']]], ['writemicroseconds',['writeMicroseconds',['../classws__ledc__servo.html#a308fb04a26586aeb98a6df344f36476c',1,'ws_ledc_servo']]], ['writetone',['writeTone',['../classws__pwm.html#a81c006b8166c39f183d2ec1636d23a9b',1,'ws_pwm']]], - ['ws',['WS',['../_wippersnapper___analog_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___digital_g_p_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ds18x20_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wipper_snapper___i2_c_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ledc_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__pixels_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___register_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__servo_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__display__driver_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___a_i_r_l_i_f_t_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___e_s_p32_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp']]], + ['ws',['WS',['../_wippersnapper___analog_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___digital_g_p_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ds18x20_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wipper_snapper___i2_c_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ledc_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__pixels_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___register_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__servo_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__display__driver_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___a_i_r_l_i_f_t_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___e_s_p32_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp']]], ['ws_5fboard_5fstatus_5ft',['ws_board_status_t',['../_wippersnapper_8h.html#ae5fa98c35b5a16565b5b06cd75008b2d',1,'Wippersnapper.h']]], ['ws_5fdebug',['WS_DEBUG',['../_wippersnapper_8h.html#a588e957b4cb40edf5d7ce01584a1793e',1,'Wippersnapper.h']]], ['ws_5fdebug_5fprint',['WS_DEBUG_PRINT',['../_wippersnapper_8h.html#a4b57776de6f8948ef3dc51df4d35e0d3',1,'Wippersnapper.h']]], @@ -157,7 +160,7 @@ var searchData= ['ws_5floading_5ftip_5f2',['WS_LOADING_TIP_2',['../ws__display__tooltips_8h.html#a14653df154797daa80ccdfe661092da9',1,'ws_display_tooltips.h']]], ['ws_5floading_5ftip_5f3',['WS_LOADING_TIP_3',['../ws__display__tooltips_8h.html#a660990ba37ce4113039144e1394d1f94',1,'ws_display_tooltips.h']]], ['ws_5floading_5ftip_5f4',['WS_LOADING_TIP_4',['../ws__display__tooltips_8h.html#af79f7a2eebf25d357d4251998966ac79',1,'ws_display_tooltips.h']]], - ['ws_5fmax_5falt_5fwifi_5fnetworks',['WS_MAX_ALT_WIFI_NETWORKS',['../_wippersnapper_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'Wippersnapper.h']]], + ['ws_5fmax_5falt_5fwifi_5fnetworks',['WS_MAX_ALT_WIFI_NETWORKS',['../_wippersnapper_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'WS_MAX_ALT_WIFI_NETWORKS(): Wippersnapper.h'],['../_wippersnapper___networking_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'WS_MAX_ALT_WIFI_NETWORKS(): Wippersnapper_Networking.h']]], ['ws_5fmqtt_5fmax_5fpayload_5fsize',['WS_MQTT_MAX_PAYLOAD_SIZE',['../_wippersnapper_8h.html#a07b8444860c318fdff531a3d0c4f2e4a',1,'Wippersnapper.h']]], ['ws_5fmqtt_5fstatus_5ft',['ws_mqtt_status_t',['../_wippersnapper_8h.html#affb7a9544e077a98a37c67e2c344a9c0',1,'Wippersnapper.h']]], ['ws_5fnetworking_5fpico_2eh',['ws_networking_pico.h',['../ws__networking__pico_8h.html',1,'']]], diff --git a/html/search/all_16.js b/html/search/all_16.js index 1a019342d..4c67d52a0 100644 --- a/html/search/all_16.js +++ b/html/search/all_16.js @@ -43,13 +43,13 @@ var searchData= ['_7ewippersnapper_5fi2c_5fdriver_5ftsl2591',['~WipperSnapper_I2C_Driver_TSL2591',['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a679ec07e6ef21915457edd04ac5d4878',1,'WipperSnapper_I2C_Driver_TSL2591']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4020',['~WipperSnapper_I2C_Driver_VCNL4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#aa2063196436869dbad2ec23846a692fc',1,'WipperSnapper_I2C_Driver_VCNL4020']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4040',['~WipperSnapper_I2C_Driver_VCNL4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f4d84d0e86e00991eb367e86ce55936',1,'WipperSnapper_I2C_Driver_VCNL4040']]], + ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4200',['~WipperSnapper_I2C_Driver_VCNL4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a737bcafff65049cbc43f1d36994282e1',1,'WipperSnapper_I2C_Driver_VCNL4200']]], ['_7ewippersnapper_5fi2c_5fdriver_5fveml7700',['~WipperSnapper_I2C_Driver_VEML7700',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a8f66b3d2338c4f5415f862c3efa64d0f',1,'WipperSnapper_I2C_Driver_VEML7700']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l0x',['~WipperSnapper_I2C_Driver_VL53L0X',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a8e6764523ccf775a1275675bdb639186',1,'WipperSnapper_I2C_Driver_VL53L0X']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l1x',['~WipperSnapper_I2C_Driver_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#ab732dde3282be2ad77b38d92f09178af',1,'WipperSnapper_I2C_Driver_VL53L1X']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l4cd',['~WipperSnapper_I2C_Driver_VL53L4CD',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a31cd18c62ccc325abe5179bfc2fe3ef2',1,'WipperSnapper_I2C_Driver_VL53L4CD']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l4cx',['~WipperSnapper_I2C_Driver_VL53L4CX',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a28ba3689927e192e75691586e4196617',1,'WipperSnapper_I2C_Driver_VL53L4CX']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl6180x',['~WipperSnapper_I2C_Driver_VL6180X',['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a45365feac8bd0a7af3fc1808d4a62e29',1,'WipperSnapper_I2C_Driver_VL6180X']]], - ['_7ewippersnapper_5fwifinina',['~Wippersnapper_WIFININA',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a3b0e76c06bba9199b97ad4ee925e0a50',1,'Wippersnapper_WIFININA']]], ['_7ews_5fdisplay_5fdriver',['~ws_display_driver',['../classws__display__driver.html#abd82ed5b45f055174bcf1e2fe2b68da1',1,'ws_display_driver']]], ['_7ews_5fds18x20',['~ws_ds18x20',['../classws__ds18x20.html#a0f71b4cb1b4b889d6dfad824912a0dd8',1,'ws_ds18x20']]], ['_7ews_5fledc',['~ws_ledc',['../classws__ledc.html#a7c7699415c97d2b26b6fb5f1fe757910',1,'ws_ledc']]], diff --git a/html/search/all_2.js b/html/search/all_2.js index fcc92c5c1..a6ba1b3b4 100644 --- a/html/search/all_2.js +++ b/html/search/all_2.js @@ -1,6 +1,6 @@ var searchData= [ - ['begin',['begin',['../class_wipper_snapper___i2_c___driver.html#af5039680b612fa873f0744b36532452d',1,'WipperSnapper_I2C_Driver::begin()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#aeeea35799a46f425efcf1282669d8d98',1,'WipperSnapper_I2C_Driver_ADT7410::begin()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#adefde55b4ca1c2fae521c13789823e8e',1,'WipperSnapper_I2C_Driver_AHTX0::begin()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#af8669d6ccf558572210844e83defea9a',1,'WipperSnapper_I2C_Driver_BH1750::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a62d8a7baa2dbe0b4669ee45453a3aa96',1,'WipperSnapper_I2C_Driver_BME280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a58a85310b6ef442550ee9b8efa4acc6b',1,'WipperSnapper_I2C_Driver_BME680::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#aa9b4760fa47a515031b480a29edef73c',1,'WipperSnapper_I2C_Driver_BMP280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a6cad94a9c555a947d63c6e7519425de7',1,'WipperSnapper_I2C_Driver_BMP3XX::begin()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a5522ff5e7c35d6c70806c3916c8e19d6',1,'WipperSnapper_I2C_Driver_DPS310::begin()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#a0b4689bab708accfcbf579b325149cd4',1,'WipperSnapper_I2C_Driver_DS2484::begin()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#afbf4a6f70a454b7afa533d3eb61c8e2f',1,'WipperSnapper_I2C_Driver_ENS160::begin()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aed7594b4ba7acb1a34c73340263795f9',1,'WipperSnapper_I2C_Driver_HDC302X::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#a7898f38b582894379ff70fdedffec3fd',1,'WipperSnapper_I2C_Driver_HTS221::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#ae4859c72fcfe012a807a76b08dbca601',1,'WipperSnapper_I2C_Driver_HTU21D::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#aa124e9779a1a329bf6f2967603b4c30f',1,'WipperSnapper_I2C_Driver_HTU31D::begin()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a95a2de6c5bca236c79dd70b49d969442',1,'WipperSnapper_I2C_Driver_INA219::begin()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#ad02364a15c27b33143d3d32ebc527b1d',1,'WipperSnapper_I2C_Driver_LC709203F::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a19e8b8bb16e8527c16a233f8f044f90d',1,'WipperSnapper_I2C_Driver_LPS22HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a96a329c01817a1f102fec819355db6f0',1,'WipperSnapper_I2C_Driver_LPS25HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a5bf52913f5963afac1a95c9421dee447',1,'WipperSnapper_I2C_Driver_LPS3XHW::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a365a8b22b488c528db41eed8f975185f',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#aff5df0adcbc3b03ec4cb67875ca8cf2e',1,'WipperSnapper_I2C_Driver_LTR390::begin()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a369ce4f627702980944e06d59d49e5f1',1,'WipperSnapper_I2C_Driver_MAX17048::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a191d5c9311b8178cf8a3a80d1ab67f5e',1,'WipperSnapper_I2C_Driver_MCP3421::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ac58ac764e00863146b0157da3024947e',1,'WipperSnapper_I2C_Driver_MCP9808::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aa15f1c425a04137bd01d9f68b3f99b0d',1,'WipperSnapper_I2C_Driver_MPL115A2::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#aca515aa0265e22424dc6aa92110a6a60',1,'WipperSnapper_I2C_Driver_MPRLS::begin()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#af22e43ddd4d637292a51847800feb286',1,'WipperSnapper_I2C_Driver_MS8607::begin()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a45d3f67bb17647243cad84b6a9c89c52',1,'WipperSnapper_I2C_Driver_NAU7802::begin()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a3fb78436695952ab1a25e5bc4611fc36',1,'WipperSnapper_I2C_Driver_PCT2075::begin()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ae87bbd82a49d9c612c422ccdda198dbb',1,'WipperSnapper_I2C_Driver_PM25::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad52ff6ab5b99d56d286772754693e2ad',1,'WipperSnapper_I2C_Driver_SCD30::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a2952d397728ae5b6b70869d9ebd49502',1,'WipperSnapper_I2C_Driver_SCD4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a88c5014ec6b3d14daa863ff3e347ab97',1,'WipperSnapper_I2C_Driver_SEN5X::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af05b38becd004e747d466fc5e6e07228',1,'WipperSnapper_I2C_Driver_SGP30::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a540f4edb0a5a2c9809bf9fc4426dcb9f',1,'WipperSnapper_I2C_Driver_SGP40::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a728a62e06e9b16a091f1d939b2bd770f',1,'WipperSnapper_I2C_Driver_SHT3X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#a5ab9a8f6204b6f6b194932f83e143379',1,'WipperSnapper_I2C_Driver_SHT4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a9f1d6d560bc6b150269be262b0cee531',1,'WipperSnapper_I2C_Driver_SHTC3::begin()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#a4ad36fbae51a51edd4fddea69490992d',1,'WipperSnapper_I2C_Driver_SI7021::begin()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a2d334fd5292f26cffa273d35bddb94a8',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::begin()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#a78abb93cb0e4b97621338394fe77e38e',1,'WipperSnapper_I2C_Driver_TMP117::begin()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a78fb1b313f36639f86d51a5438e9222d',1,'WipperSnapper_I2C_Driver_TSL2591::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a9fc87f93acd6e9bd3275bb38718ef094',1,'WipperSnapper_I2C_Driver_VCNL4020::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a572eff02ee82cda55461872762e64f86',1,'WipperSnapper_I2C_Driver_VCNL4040::begin()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#abc837dfece950d0ed05c6c61d95b1510',1,'WipperSnapper_I2C_Driver_VEML7700::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a1c69bf38d3a39edf1780f7534669d837',1,'WipperSnapper_I2C_Driver_VL53L0X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a24bf2d135d0251b70c07508ba02ab200',1,'WipperSnapper_I2C_Driver_VL53L1X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a4f575c65c1f1eb650397564d4903477c',1,'WipperSnapper_I2C_Driver_VL53L4CD::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a9abe6a74347d09ebf3135600cdbabd64',1,'WipperSnapper_I2C_Driver_VL53L4CX::begin()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a318d8c5da799ee9e98a9acd70a016524',1,'WipperSnapper_I2C_Driver_VL6180X::begin()'],['../classws__uart__drv.html#a2a9f0f39f140d5fe82b64cb105963a94',1,'ws_uart_drv::begin()'],['../classws__uart__drv__pm25aqi.html#a869e42ee2757aa9a46e1ecc6d3192a2b',1,'ws_uart_drv_pm25aqi::begin()'],['../classws__display__driver.html#a7d6f973d0ef9b6241488afba2878485f',1,'ws_display_driver::begin()']]], + ['begin',['begin',['../class_wipper_snapper___i2_c___driver.html#af5039680b612fa873f0744b36532452d',1,'WipperSnapper_I2C_Driver::begin()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#aeeea35799a46f425efcf1282669d8d98',1,'WipperSnapper_I2C_Driver_ADT7410::begin()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#adefde55b4ca1c2fae521c13789823e8e',1,'WipperSnapper_I2C_Driver_AHTX0::begin()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#af8669d6ccf558572210844e83defea9a',1,'WipperSnapper_I2C_Driver_BH1750::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a62d8a7baa2dbe0b4669ee45453a3aa96',1,'WipperSnapper_I2C_Driver_BME280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a58a85310b6ef442550ee9b8efa4acc6b',1,'WipperSnapper_I2C_Driver_BME680::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#aa9b4760fa47a515031b480a29edef73c',1,'WipperSnapper_I2C_Driver_BMP280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a6cad94a9c555a947d63c6e7519425de7',1,'WipperSnapper_I2C_Driver_BMP3XX::begin()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a5522ff5e7c35d6c70806c3916c8e19d6',1,'WipperSnapper_I2C_Driver_DPS310::begin()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#a0b4689bab708accfcbf579b325149cd4',1,'WipperSnapper_I2C_Driver_DS2484::begin()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#afbf4a6f70a454b7afa533d3eb61c8e2f',1,'WipperSnapper_I2C_Driver_ENS160::begin()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aed7594b4ba7acb1a34c73340263795f9',1,'WipperSnapper_I2C_Driver_HDC302X::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#a7898f38b582894379ff70fdedffec3fd',1,'WipperSnapper_I2C_Driver_HTS221::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#ae4859c72fcfe012a807a76b08dbca601',1,'WipperSnapper_I2C_Driver_HTU21D::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#aa124e9779a1a329bf6f2967603b4c30f',1,'WipperSnapper_I2C_Driver_HTU31D::begin()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a95a2de6c5bca236c79dd70b49d969442',1,'WipperSnapper_I2C_Driver_INA219::begin()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#ad02364a15c27b33143d3d32ebc527b1d',1,'WipperSnapper_I2C_Driver_LC709203F::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a19e8b8bb16e8527c16a233f8f044f90d',1,'WipperSnapper_I2C_Driver_LPS22HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a96a329c01817a1f102fec819355db6f0',1,'WipperSnapper_I2C_Driver_LPS25HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a5bf52913f5963afac1a95c9421dee447',1,'WipperSnapper_I2C_Driver_LPS3XHW::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a365a8b22b488c528db41eed8f975185f',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#aff5df0adcbc3b03ec4cb67875ca8cf2e',1,'WipperSnapper_I2C_Driver_LTR390::begin()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a369ce4f627702980944e06d59d49e5f1',1,'WipperSnapper_I2C_Driver_MAX17048::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a191d5c9311b8178cf8a3a80d1ab67f5e',1,'WipperSnapper_I2C_Driver_MCP3421::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ac58ac764e00863146b0157da3024947e',1,'WipperSnapper_I2C_Driver_MCP9808::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aa15f1c425a04137bd01d9f68b3f99b0d',1,'WipperSnapper_I2C_Driver_MPL115A2::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#aca515aa0265e22424dc6aa92110a6a60',1,'WipperSnapper_I2C_Driver_MPRLS::begin()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#af22e43ddd4d637292a51847800feb286',1,'WipperSnapper_I2C_Driver_MS8607::begin()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a45d3f67bb17647243cad84b6a9c89c52',1,'WipperSnapper_I2C_Driver_NAU7802::begin()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a3fb78436695952ab1a25e5bc4611fc36',1,'WipperSnapper_I2C_Driver_PCT2075::begin()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ae87bbd82a49d9c612c422ccdda198dbb',1,'WipperSnapper_I2C_Driver_PM25::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad52ff6ab5b99d56d286772754693e2ad',1,'WipperSnapper_I2C_Driver_SCD30::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a2952d397728ae5b6b70869d9ebd49502',1,'WipperSnapper_I2C_Driver_SCD4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a88c5014ec6b3d14daa863ff3e347ab97',1,'WipperSnapper_I2C_Driver_SEN5X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a3f9b9eca2742a40fe057ba6594f50f80',1,'WipperSnapper_I2C_Driver_SEN6X::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af05b38becd004e747d466fc5e6e07228',1,'WipperSnapper_I2C_Driver_SGP30::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a540f4edb0a5a2c9809bf9fc4426dcb9f',1,'WipperSnapper_I2C_Driver_SGP40::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a728a62e06e9b16a091f1d939b2bd770f',1,'WipperSnapper_I2C_Driver_SHT3X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#a5ab9a8f6204b6f6b194932f83e143379',1,'WipperSnapper_I2C_Driver_SHT4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a9f1d6d560bc6b150269be262b0cee531',1,'WipperSnapper_I2C_Driver_SHTC3::begin()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#a4ad36fbae51a51edd4fddea69490992d',1,'WipperSnapper_I2C_Driver_SI7021::begin()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a2d334fd5292f26cffa273d35bddb94a8',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::begin()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#a78abb93cb0e4b97621338394fe77e38e',1,'WipperSnapper_I2C_Driver_TMP117::begin()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a78fb1b313f36639f86d51a5438e9222d',1,'WipperSnapper_I2C_Driver_TSL2591::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a9fc87f93acd6e9bd3275bb38718ef094',1,'WipperSnapper_I2C_Driver_VCNL4020::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a572eff02ee82cda55461872762e64f86',1,'WipperSnapper_I2C_Driver_VCNL4040::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#aca5d5527a0bb963c9a307f0731641a1d',1,'WipperSnapper_I2C_Driver_VCNL4200::begin()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#abc837dfece950d0ed05c6c61d95b1510',1,'WipperSnapper_I2C_Driver_VEML7700::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a1c69bf38d3a39edf1780f7534669d837',1,'WipperSnapper_I2C_Driver_VL53L0X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a24bf2d135d0251b70c07508ba02ab200',1,'WipperSnapper_I2C_Driver_VL53L1X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a4f575c65c1f1eb650397564d4903477c',1,'WipperSnapper_I2C_Driver_VL53L4CD::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a9abe6a74347d09ebf3135600cdbabd64',1,'WipperSnapper_I2C_Driver_VL53L4CX::begin()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a318d8c5da799ee9e98a9acd70a016524',1,'WipperSnapper_I2C_Driver_VL6180X::begin()'],['../classws__uart__drv.html#a2a9f0f39f140d5fe82b64cb105963a94',1,'ws_uart_drv::begin()'],['../classws__uart__drv__pm25aqi.html#a869e42ee2757aa9a46e1ecc6d3192a2b',1,'ws_uart_drv_pm25aqi::begin()'],['../classws__display__driver.html#a7d6f973d0ef9b6241488afba2878485f',1,'ws_display_driver::begin()']]], ['black',['BLACK',['../_wippersnapper___status_l_e_d_8h.html#a7b3b25cba33b07c303f3060fe41887f6',1,'Wippersnapper_StatusLED.h']]], ['blue',['BLUE',['../_wippersnapper___status_l_e_d_8h.html#a79d10e672abb49ad63eeaa8aaef57c38',1,'Wippersnapper_StatusLED.h']]], ['bmeperformreading',['bmePerformReading',['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a52203d106dd9ba4625301ad958c87997',1,'WipperSnapper_I2C_Driver_BME680']]], diff --git a/html/search/all_3.js b/html/search/all_3.js index a4833e2bd..ea0bd55d5 100644 --- a/html/search/all_3.js +++ b/html/search/all_3.js @@ -1,5 +1,6 @@ var searchData= [ + ['calculatehysteresis',['calculateHysteresis',['../_wippersnapper___analog_i_o_8cpp.html#a090ac9aa22bca6965e84a97ea3048bc1',1,'Wippersnapper_AnalogIO.cpp']]], ['cbdecodedigitalpinwritemsg',['cbDecodeDigitalPinWriteMsg',['../_wippersnapper_8cpp.html#a10bcdf641a00178a2051f9c913c3ce1b',1,'Wippersnapper.cpp']]], ['cbdecodeds18x20msg',['cbDecodeDs18x20Msg',['../_wippersnapper_8cpp.html#ae9f35382d74f2d8914948038f9fc6d24',1,'Wippersnapper.cpp']]], ['cbdecodei2cdeviceinitrequestlist',['cbDecodeI2CDeviceInitRequestList',['../_wippersnapper_8cpp.html#a847c2a4449caffd9e61983089a72a3ed',1,'Wippersnapper.cpp']]], @@ -20,7 +21,7 @@ var searchData= ['cbsignaltopic',['cbSignalTopic',['../_wippersnapper_8cpp.html#adf3bf6470c06cad9086c3a8556474dbe',1,'Wippersnapper.cpp']]], ['cbsignaluartreq',['cbSignalUARTReq',['../_wippersnapper_8cpp.html#afbca6f75bec609c0af55ff815be2e964',1,'Wippersnapper.cpp']]], ['cbthrottletopic',['cbThrottleTopic',['../_wippersnapper_8cpp.html#aa1e37658221dffced66cc9e1548e5be1',1,'Wippersnapper.cpp']]], - ['check_5fvalid_5fssid',['check_valid_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#ad7a4443676e200227a9dc661f263c52a',1,'Wippersnapper_AIRLIFT::check_valid_ssid()'],['../class_wippersnapper___e_s_p32.html#a36994b82d22db88f67777aaf4e097f1b',1,'Wippersnapper_ESP32::check_valid_ssid()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aaee5680c8abe5ec08f34166f1d669adf',1,'Wippersnapper_WIFININA::check_valid_ssid()'],['../class_wippersnapper.html#a288ccdd64ddcec63c3cd2b7a74182a66',1,'Wippersnapper::check_valid_ssid()']]], + ['check_5fvalid_5fssid',['check_valid_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#ad7a4443676e200227a9dc661f263c52a',1,'Wippersnapper_AIRLIFT::check_valid_ssid()'],['../class_wippersnapper___e_s_p32.html#a36994b82d22db88f67777aaf4e097f1b',1,'Wippersnapper_ESP32::check_valid_ssid()'],['../class_wippersnapper.html#a288ccdd64ddcec63c3cd2b7a74182a66',1,'Wippersnapper::check_valid_ssid()']]], ['clear_5fscr_5fload',['clear_scr_load',['../classws__display__ui__helper.html#a9afaed92b8e6de31aa5b87cc58e615d8',1,'ws_display_ui_helper']]], ['compareversions',['compareVersions',['../class_wippersnapper___a_i_r_l_i_f_t.html#abc598a748031959da5643da3b9935834',1,'Wippersnapper_AIRLIFT']]], ['configanaloginpinreq',['configAnalogInPinReq',['../class_wippersnapper.html#a089cb6c8b641aa22762f00dda783bb12',1,'Wippersnapper']]], @@ -29,6 +30,6 @@ var searchData= ['configuredriver',['configureDriver',['../class_wipper_snapper___i2_c___driver.html#a86ede95ee6f5495739c16a3cf47a8c5a',1,'WipperSnapper_I2C_Driver']]], ['configuresensor',['configureSensor',['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a06d957e925f7505b2e3cc4c0d017ad3d',1,'WipperSnapper_I2C_Driver_MCP3421']]], ['connect',['connect',['../class_wippersnapper.html#add749b3d330161a132fd7e0114618ec0',1,'Wippersnapper']]], - ['connectiontype',['connectionType',['../class_wippersnapper___a_i_r_l_i_f_t.html#adf8d75a7530ff367f8a03e8e9afca7b1',1,'Wippersnapper_AIRLIFT::connectionType()'],['../class_wippersnapper___e_s_p32.html#a3ae46effd5e7bd00898ed5967898a58a',1,'Wippersnapper_ESP32::connectionType()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ab003b4b439f438ffef72779b0adb179f',1,'Wippersnapper_WIFININA::connectionType()']]], + ['connectiontype',['connectionType',['../class_wippersnapper___a_i_r_l_i_f_t.html#adf8d75a7530ff367f8a03e8e9afca7b1',1,'Wippersnapper_AIRLIFT::connectionType()'],['../class_wippersnapper___e_s_p32.html#a3ae46effd5e7bd00898ed5967898a58a',1,'Wippersnapper_ESP32::connectionType()']]], ['cyan',['CYAN',['../_wippersnapper___status_l_e_d_8h.html#ad243f93c16bc4c1d3e0a13b84421d760',1,'Wippersnapper_StatusLED.h']]] ]; diff --git a/html/search/all_6.js b/html/search/all_6.js index 339d3d2a2..154c9c0fa 100644 --- a/html/search/all_6.js +++ b/html/search/all_6.js @@ -3,7 +3,7 @@ var searchData= ['feedwdt',['feedWDT',['../class_wippersnapper.html#ab3e122ca0d602d5ee3e2a0b82bbc32ad',1,'Wippersnapper']]], ['filleventmessage',['fillEventMessage',['../class_wipper_snapper___component___i2_c.html#a85c0bb433ab661de67889ef12070c51b',1,'WipperSnapper_Component_I2C']]], ['fillstrand',['fillStrand',['../classws__pixels.html#affc6e43365ed7ae568ee26bf492fe11d',1,'ws_pixels']]], - ['firmwarecheck',['firmwareCheck',['../class_wippersnapper___a_i_r_l_i_f_t.html#accdf5d5a8cf24ff783816d901a75249f',1,'Wippersnapper_AIRLIFT::firmwareCheck()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ad7f52d4e776fff650aa246feca34d122',1,'Wippersnapper_WIFININA::firmwareCheck()']]], + ['firmwarecheck',['firmwareCheck',['../class_wippersnapper___a_i_r_l_i_f_t.html#accdf5d5a8cf24ff783816d901a75249f',1,'Wippersnapper_AIRLIFT']]], ['flushnau7802',['flushNAU7802',['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a7912624c214837c9c8ad35bd37dead85',1,'WipperSnapper_I2C_Driver_NAU7802']]], ['fsm_5fnet_5ft',['fsm_net_t',['../_wippersnapper_8h.html#acde124ab66d704b427ae8aade3131fff',1,'Wippersnapper.h']]] ]; diff --git a/html/search/all_7.js b/html/search/all_7.js index 0bd047fec..6eb2ea661 100644 --- a/html/search/all_7.js +++ b/html/search/all_7.js @@ -10,38 +10,38 @@ var searchData= ['getdotstarstrandorder',['getDotStarStrandOrder',['../classws__pixels.html#a7b7aefe5c8b65143c0d0a934b313c654',1,'ws_pixels']]], ['getdriverid',['getDriverID',['../classws__uart__drv.html#a2681c521f0960c8808f276ac4a093cec',1,'ws_uart_drv']]], ['geteventaltitude',['getEventAltitude',['../class_wipper_snapper___i2_c___driver.html#a9a4596c2fe21aff2da04923f56b7f5a5',1,'WipperSnapper_I2C_Driver::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#aa69f5a0b330f75479b5090eaeb7719f4',1,'WipperSnapper_I2C_Driver_BME280::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a88d91797e9b9bc81554417c212df5333',1,'WipperSnapper_I2C_Driver_BME680::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a27972b7a9fe7e2dd6eba85dd3a2ab4a5',1,'WipperSnapper_I2C_Driver_BMP280::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#ad18c0614a1164050bee69b18b72349f0',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAltitude()']]], - ['geteventambienttemp',['getEventAmbientTemp',['../class_wipper_snapper___i2_c___driver.html#a13de4eca74a2d66e9e6bb2205cc9f390',1,'WipperSnapper_I2C_Driver::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#a242afcf8828bc32e59a17ed749caff89',1,'WipperSnapper_I2C_Driver_ADT7410::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#ab266e45a7ba0024874319f38a42256f3',1,'WipperSnapper_I2C_Driver_AHTX0::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a1f2dbf2e71b3dd54e1e2a7328b936550',1,'WipperSnapper_I2C_Driver_BME280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acb4c85fc99496242a6a18dbc03d95b7c',1,'WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a2ac9fd849bf26a7f7b59ced85f71cec6',1,'WipperSnapper_I2C_Driver_BMP280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#aa0fc4c9f9a32641b37bf90b9407a3acc',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a646e10f3df16756573bcdad0fa72d13a',1,'WipperSnapper_I2C_Driver_DPS310::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#ab5031cb684c03e853e0c7ea4156d8783',1,'WipperSnapper_I2C_Driver_DS2484::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a8d730c98b6394f5b02bc6c57efc848d7',1,'WipperSnapper_I2C_Driver_HDC302X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#adb6e95f68668bd959653953f10b3b42d',1,'WipperSnapper_I2C_Driver_HTS221::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a69013d12c2ac3a29f57d1cd16b55cf35',1,'WipperSnapper_I2C_Driver_HTU21D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#a8837b571afcf7eb12adadc063ba453a8',1,'WipperSnapper_I2C_Driver_HTU31D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a289c035a620efd9faf0ea29486b68bec',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#ada1b31c034da98c2d057049ef52ea71c',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a4be7ae5ba414f459289d93084895250a',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ad2faf1c27d8373e0e268c663fb2eb579',1,'WipperSnapper_I2C_Driver_MCP9808::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aaa2d39c025e0ac4ffc166bc251fddc1c',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#a20f17ca276212bcfb9fad72a22518600',1,'WipperSnapper_I2C_Driver_MS8607::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a4dc74371645120b6b62a5b2c0f557751',1,'WipperSnapper_I2C_Driver_PCT2075::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a2a9dc8d88af0d319096c83fa39f30fd8',1,'WipperSnapper_I2C_Driver_SCD30::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a0080a44575de0f6722fba8b96aff18f0',1,'WipperSnapper_I2C_Driver_SCD4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af9bb46a3a495fc8d6d1f8ee890aa4da4',1,'WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a2dedd64cbf092a450224e9efbc606313',1,'WipperSnapper_I2C_Driver_SHT3X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#ac771a5542527ea1fc95c26af827fb952',1,'WipperSnapper_I2C_Driver_SHT4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a43d09895398b559dc3b5b3ebf58788a6',1,'WipperSnapper_I2C_Driver_SHTC3::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#af99e7ab7b7f901d5c1ccb0c476067361',1,'WipperSnapper_I2C_Driver_SI7021::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#aab2ccd5c99dc8c33547102b902aa4da4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#adcb007ae25ecffbf4a3f429ded9d861f',1,'WipperSnapper_I2C_Driver_TMP117::getEventAmbientTemp()']]], + ['geteventambienttemp',['getEventAmbientTemp',['../class_wipper_snapper___i2_c___driver.html#a13de4eca74a2d66e9e6bb2205cc9f390',1,'WipperSnapper_I2C_Driver::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#a242afcf8828bc32e59a17ed749caff89',1,'WipperSnapper_I2C_Driver_ADT7410::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#ab266e45a7ba0024874319f38a42256f3',1,'WipperSnapper_I2C_Driver_AHTX0::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a1f2dbf2e71b3dd54e1e2a7328b936550',1,'WipperSnapper_I2C_Driver_BME280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acb4c85fc99496242a6a18dbc03d95b7c',1,'WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a2ac9fd849bf26a7f7b59ced85f71cec6',1,'WipperSnapper_I2C_Driver_BMP280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#aa0fc4c9f9a32641b37bf90b9407a3acc',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a646e10f3df16756573bcdad0fa72d13a',1,'WipperSnapper_I2C_Driver_DPS310::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#ab5031cb684c03e853e0c7ea4156d8783',1,'WipperSnapper_I2C_Driver_DS2484::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a8d730c98b6394f5b02bc6c57efc848d7',1,'WipperSnapper_I2C_Driver_HDC302X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#adb6e95f68668bd959653953f10b3b42d',1,'WipperSnapper_I2C_Driver_HTS221::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a69013d12c2ac3a29f57d1cd16b55cf35',1,'WipperSnapper_I2C_Driver_HTU21D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#a8837b571afcf7eb12adadc063ba453a8',1,'WipperSnapper_I2C_Driver_HTU31D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a289c035a620efd9faf0ea29486b68bec',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#ada1b31c034da98c2d057049ef52ea71c',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a4be7ae5ba414f459289d93084895250a',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ad2faf1c27d8373e0e268c663fb2eb579',1,'WipperSnapper_I2C_Driver_MCP9808::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aaa2d39c025e0ac4ffc166bc251fddc1c',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#a20f17ca276212bcfb9fad72a22518600',1,'WipperSnapper_I2C_Driver_MS8607::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a4dc74371645120b6b62a5b2c0f557751',1,'WipperSnapper_I2C_Driver_PCT2075::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a2a9dc8d88af0d319096c83fa39f30fd8',1,'WipperSnapper_I2C_Driver_SCD30::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a0080a44575de0f6722fba8b96aff18f0',1,'WipperSnapper_I2C_Driver_SCD4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af9bb46a3a495fc8d6d1f8ee890aa4da4',1,'WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a0de4e3490e60c4ddbcf7cd79dc1265c5',1,'WipperSnapper_I2C_Driver_SEN6X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a2dedd64cbf092a450224e9efbc606313',1,'WipperSnapper_I2C_Driver_SHT3X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#ac771a5542527ea1fc95c26af827fb952',1,'WipperSnapper_I2C_Driver_SHT4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a43d09895398b559dc3b5b3ebf58788a6',1,'WipperSnapper_I2C_Driver_SHTC3::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#af99e7ab7b7f901d5c1ccb0c476067361',1,'WipperSnapper_I2C_Driver_SI7021::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#aab2ccd5c99dc8c33547102b902aa4da4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#adcb007ae25ecffbf4a3f429ded9d861f',1,'WipperSnapper_I2C_Driver_TMP117::getEventAmbientTemp()']]], ['geteventambienttempf',['getEventAmbientTempF',['../class_wipper_snapper___i2_c___driver.html#aa621cddfaddfe59c09836852f52a6ee9',1,'WipperSnapper_I2C_Driver']]], - ['geteventco2',['getEventCO2',['../class_wipper_snapper___i2_c___driver.html#a7575cd2c725d2cb6d5ac683bbc7b8cda',1,'WipperSnapper_I2C_Driver::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a0d0b0d1bfdfc533785270c617392cd2b',1,'WipperSnapper_I2C_Driver_SCD30::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4d0901b433474c60198e697f328ea0be',1,'WipperSnapper_I2C_Driver_SCD4X::getEventCO2()']]], + ['geteventco2',['getEventCO2',['../class_wipper_snapper___i2_c___driver.html#a7575cd2c725d2cb6d5ac683bbc7b8cda',1,'WipperSnapper_I2C_Driver::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a0d0b0d1bfdfc533785270c617392cd2b',1,'WipperSnapper_I2C_Driver_SCD30::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4d0901b433474c60198e697f328ea0be',1,'WipperSnapper_I2C_Driver_SCD4X::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a5e1debd9d34ba9ef6bfddb6180e05139',1,'WipperSnapper_I2C_Driver_SEN6X::getEventCO2()']]], ['geteventcurrent',['getEventCurrent',['../class_wipper_snapper___i2_c___driver.html#a1b1079053c8d8a9117887e9997e2fe0c',1,'WipperSnapper_I2C_Driver::getEventCurrent()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#ab990acd471dfc4b7d1eb13b611a4cb27',1,'WipperSnapper_I2C_Driver_INA219::getEventCurrent()']]], ['geteventeco2',['getEventECO2',['../class_wipper_snapper___i2_c___driver.html#a34f86a1d55cb236b4f509196451f3dff',1,'WipperSnapper_I2C_Driver::getEventECO2()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#a1479ca40bba3b47a20429b2b92ba9490',1,'WipperSnapper_I2C_Driver_ENS160::getEventECO2()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#aac34ebb703e7863bfeebfa5d3cfe31e7',1,'WipperSnapper_I2C_Driver_SGP30::getEventECO2()']]], ['geteventgasresistance',['getEventGasResistance',['../class_wipper_snapper___i2_c___driver.html#a5a9d3e73c2453ba1c25c44162f0aba28',1,'WipperSnapper_I2C_Driver::getEventGasResistance()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a307ea831e8cd27c9636a952f6dacc67b',1,'WipperSnapper_I2C_Driver_BME680::getEventGasResistance()']]], - ['geteventlight',['getEventLight',['../class_wipper_snapper___i2_c___driver.html#ae063acb623d277fab67e2a0efb8bb5ca',1,'WipperSnapper_I2C_Driver::getEventLight()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#ad5f06e9d1b78a1607598747151695564',1,'WipperSnapper_I2C_Driver_BH1750::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a5acce7e34dad300a23d4b3d92e7cbcb0',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#ac6199e7c82e98c9ec7d2be0ba61c0e43',1,'WipperSnapper_I2C_Driver_LTR390::getEventLight()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#ab4330f001ca8576190cfd1b862153d40',1,'WipperSnapper_I2C_Driver_TSL2591::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a841c18d25441ba48eb75f355b7de4d47',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f2e168de21efe4c9ab5f9e80f3e0f9a',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a822d7f5571b361c9ff2e078a093b4865',1,'WipperSnapper_I2C_Driver_VEML7700::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a955b0a138358c5928946477a5bca54fa',1,'WipperSnapper_I2C_Driver_VL6180X::getEventLight()']]], - ['geteventnoxindex',['getEventNOxIndex',['../class_wipper_snapper___i2_c___driver.html#ab87a78eea2ae6e2b629dcaf5fdaafad4',1,'WipperSnapper_I2C_Driver::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#adbafae4e35defc5595a4a64a62cae9a8',1,'WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex()']]], + ['geteventlight',['getEventLight',['../class_wipper_snapper___i2_c___driver.html#ae063acb623d277fab67e2a0efb8bb5ca',1,'WipperSnapper_I2C_Driver::getEventLight()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#ad5f06e9d1b78a1607598747151695564',1,'WipperSnapper_I2C_Driver_BH1750::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a5acce7e34dad300a23d4b3d92e7cbcb0',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#ac6199e7c82e98c9ec7d2be0ba61c0e43',1,'WipperSnapper_I2C_Driver_LTR390::getEventLight()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#ab4330f001ca8576190cfd1b862153d40',1,'WipperSnapper_I2C_Driver_TSL2591::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a841c18d25441ba48eb75f355b7de4d47',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f2e168de21efe4c9ab5f9e80f3e0f9a',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#abf9139a9eef75a6cb5da77eef03f3c63',1,'WipperSnapper_I2C_Driver_VCNL4200::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a822d7f5571b361c9ff2e078a093b4865',1,'WipperSnapper_I2C_Driver_VEML7700::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a955b0a138358c5928946477a5bca54fa',1,'WipperSnapper_I2C_Driver_VL6180X::getEventLight()']]], + ['geteventnoxindex',['getEventNOxIndex',['../class_wipper_snapper___i2_c___driver.html#ab87a78eea2ae6e2b629dcaf5fdaafad4',1,'WipperSnapper_I2C_Driver::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#adbafae4e35defc5595a4a64a62cae9a8',1,'WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a43b2dabb22d67616c078a47c805f7846',1,'WipperSnapper_I2C_Driver_SEN6X::getEventNOxIndex()']]], ['geteventobjecttemp',['getEventObjectTemp',['../class_wipper_snapper___i2_c___driver.html#ae13af4c9959dc822e9b1c62d772e0c40',1,'WipperSnapper_I2C_Driver']]], ['geteventobjecttempf',['getEventObjectTempF',['../class_wipper_snapper___i2_c___driver.html#a92ab748eac0e11445c5474fc03d1e267',1,'WipperSnapper_I2C_Driver']]], - ['geteventpm100_5fstd',['getEventPM100_STD',['../class_wipper_snapper___i2_c___driver.html#a1a12b2c78ed99e67bbe206d54cc4b50a',1,'WipperSnapper_I2C_Driver::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#a59d595e14906759668fefd153297de91',1,'WipperSnapper_I2C_Driver_PM25::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a57d08123f0685274aab3919ed9af477f',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD()']]], - ['geteventpm10_5fstd',['getEventPM10_STD',['../class_wipper_snapper___i2_c___driver.html#af30bc9ae36c032ee6c8ddd5d5e3a8ffe',1,'WipperSnapper_I2C_Driver::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ac3c167f2bbaadc2d3bc15ef82c755484',1,'WipperSnapper_I2C_Driver_PM25::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ad446fcce51f32eada38a297a09a9ab27',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD()']]], - ['geteventpm25_5fstd',['getEventPM25_STD',['../class_wipper_snapper___i2_c___driver.html#ad2bad6c048564c3472427f1a661873fb',1,'WipperSnapper_I2C_Driver::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#adbe144cd72ecd1d9ef0cab6ac157b7b1',1,'WipperSnapper_I2C_Driver_PM25::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a8c0bc026367aba1a63fa389a20305c1c',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD()']]], - ['geteventpm40_5fstd',['getEventPM40_STD',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a4a25a13645b2d8cbf6dc3157b1f96232',1,'WipperSnapper_I2C_Driver_SEN5X']]], + ['geteventpm100_5fstd',['getEventPM100_STD',['../class_wipper_snapper___i2_c___driver.html#a1a12b2c78ed99e67bbe206d54cc4b50a',1,'WipperSnapper_I2C_Driver::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#a59d595e14906759668fefd153297de91',1,'WipperSnapper_I2C_Driver_PM25::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a57d08123f0685274aab3919ed9af477f',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a02b1cd26b0e13734eec2613eed6d1fce',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM100_STD()']]], + ['geteventpm10_5fstd',['getEventPM10_STD',['../class_wipper_snapper___i2_c___driver.html#af30bc9ae36c032ee6c8ddd5d5e3a8ffe',1,'WipperSnapper_I2C_Driver::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ac3c167f2bbaadc2d3bc15ef82c755484',1,'WipperSnapper_I2C_Driver_PM25::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ad446fcce51f32eada38a297a09a9ab27',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#ad7bc82d8a4314697ef8dca793d9c8d60',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM10_STD()']]], + ['geteventpm25_5fstd',['getEventPM25_STD',['../class_wipper_snapper___i2_c___driver.html#ad2bad6c048564c3472427f1a661873fb',1,'WipperSnapper_I2C_Driver::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#adbe144cd72ecd1d9ef0cab6ac157b7b1',1,'WipperSnapper_I2C_Driver_PM25::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a8c0bc026367aba1a63fa389a20305c1c',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a9521500d720664e7bde4a01c4ce83a62',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM25_STD()']]], + ['geteventpm40_5fstd',['getEventPM40_STD',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a4a25a13645b2d8cbf6dc3157b1f96232',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM40_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a76f040ef62489c503e978e7305a7b7da',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM40_STD()']]], ['geteventpressure',['getEventPressure',['../class_wipper_snapper___i2_c___driver.html#a7a2da3fae0d97872416c24066720276d',1,'WipperSnapper_I2C_Driver::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a58e26c19effac4be6d41c199f154b0b8',1,'WipperSnapper_I2C_Driver_BME280::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a3873bb989e53c57a5b354b0d30402793',1,'WipperSnapper_I2C_Driver_BME680::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a03a626388a9f6f98a671bb55b259a758',1,'WipperSnapper_I2C_Driver_BMP280::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a77ce4d038c17debc63569d0ea143bc3e',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#ae289e008f8c00825470d8612923e382f',1,'WipperSnapper_I2C_Driver_DPS310::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a085af6656ab51694dd3901eb5457d8e8',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a4946bebb8da0ce832f307ddfa47d2ab5',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a11725eb31309bc542753310f5de135e8',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#acd19f50e18038b53ea8450b1a34a10cf',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#ab0037bcf69b527203445be8938705690',1,'WipperSnapper_I2C_Driver_MPRLS::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad3792eb918e3cbfc3e1d760e216bdb9e',1,'WipperSnapper_I2C_Driver_MS8607::getEventPressure()']]], - ['geteventproximity',['getEventProximity',['../class_wipper_snapper___i2_c___driver.html#a7d9543490469c686a840c98dae35d79f',1,'WipperSnapper_I2C_Driver::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#ad513c054e926a08d4c475dd3081c7412',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2a78442326ef7f1eaa3f7cd84bc05bf9',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#aac68ee5e75ac9cded200f85942583957',1,'WipperSnapper_I2C_Driver_VL53L0X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#aeb6e89f863f10a0a1523ca2b5f42be1a',1,'WipperSnapper_I2C_Driver_VL53L1X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a7bc926f9b54b1624077b8d4dcadeab9e',1,'WipperSnapper_I2C_Driver_VL53L4CD::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a3b651566d61dc4b7a02af5bfee9ae4d7',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a55fa805c11f434f0838840f3154a108b',1,'WipperSnapper_I2C_Driver_VL6180X::getEventProximity()']]], + ['geteventproximity',['getEventProximity',['../class_wipper_snapper___i2_c___driver.html#a7d9543490469c686a840c98dae35d79f',1,'WipperSnapper_I2C_Driver::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#ad513c054e926a08d4c475dd3081c7412',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2a78442326ef7f1eaa3f7cd84bc05bf9',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a17331fc166fd01bc44a0534c8612a598',1,'WipperSnapper_I2C_Driver_VCNL4200::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#aac68ee5e75ac9cded200f85942583957',1,'WipperSnapper_I2C_Driver_VL53L0X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#aeb6e89f863f10a0a1523ca2b5f42be1a',1,'WipperSnapper_I2C_Driver_VL53L1X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a7bc926f9b54b1624077b8d4dcadeab9e',1,'WipperSnapper_I2C_Driver_VL53L4CD::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a3b651566d61dc4b7a02af5bfee9ae4d7',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a55fa805c11f434f0838840f3154a108b',1,'WipperSnapper_I2C_Driver_VL6180X::getEventProximity()']]], ['geteventraw',['getEventRaw',['../class_wipper_snapper___i2_c___driver.html#a82b80136f66f6f45b6d590bb694d670a',1,'WipperSnapper_I2C_Driver::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#ad76418f2a2680ae3691e292646fcd47a',1,'WipperSnapper_I2C_Driver_ENS160::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a7fca25ea7312dd13ab433e2d53eb4214',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#a332c17b172ccaca4047c12604c7c01ea',1,'WipperSnapper_I2C_Driver_LTR390::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a395cee03ac616bab232b1bfca1de860e',1,'WipperSnapper_I2C_Driver_MCP3421::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a528b16bfc54ad27d4f2eed915e5f39bc',1,'WipperSnapper_I2C_Driver_NAU7802::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a0c4d07b6f93ba859c79bdf18c55f81a9',1,'WipperSnapper_I2C_Driver_SGP40::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#af671c08963756f710ccecca6c82520d4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a945f8c9276b5dc6dedca6c71a1f5abd9',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventRaw()']]], - ['geteventrelativehumidity',['getEventRelativeHumidity',['../class_wipper_snapper___i2_c___driver.html#a64254b7895801dc14e8d792e7d997f0f',1,'WipperSnapper_I2C_Driver::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#a829041ed0eaaac49819872de32640f66',1,'WipperSnapper_I2C_Driver_AHTX0::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#ae865c5c2bc7aaa759ceacb56f93c6997',1,'WipperSnapper_I2C_Driver_BME280::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acfda397c53ccc1e21123f6d41c1b859d',1,'WipperSnapper_I2C_Driver_BME680::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aaa8e692371176c22572fcbd95081d937',1,'WipperSnapper_I2C_Driver_HDC302X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#ab96618bd164218991a1b80e9bf9fbb8d',1,'WipperSnapper_I2C_Driver_HTS221::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a44d4e7365069bad3a046bb7e757c7a36',1,'WipperSnapper_I2C_Driver_HTU21D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#acb2fe3f0ebd8dd24a2e39c56db82618e',1,'WipperSnapper_I2C_Driver_HTU31D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad97c0a522f75b201b1ff45adc3d03b18',1,'WipperSnapper_I2C_Driver_MS8607::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad591fdc0ecfa2697177a0a86db68884f',1,'WipperSnapper_I2C_Driver_SCD30::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4f8f51b9ba4fc6dd763cc07d6d4024fa',1,'WipperSnapper_I2C_Driver_SCD4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a585d0f06fd9f353c075d0ebd9572c952',1,'WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#aa7124e2bf4e83b6b24a9df60966d8d98',1,'WipperSnapper_I2C_Driver_SHT3X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#afc01d4300e4226a06b8a3a3f5f34e10c',1,'WipperSnapper_I2C_Driver_SHT4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a8863db8c2476797c5b648f8fc65b86bc',1,'WipperSnapper_I2C_Driver_SHTC3::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#aafa45f134fe4de304bcab741c3ab765b',1,'WipperSnapper_I2C_Driver_SI7021::getEventRelativeHumidity()']]], + ['geteventrelativehumidity',['getEventRelativeHumidity',['../class_wipper_snapper___i2_c___driver.html#a64254b7895801dc14e8d792e7d997f0f',1,'WipperSnapper_I2C_Driver::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#a829041ed0eaaac49819872de32640f66',1,'WipperSnapper_I2C_Driver_AHTX0::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#ae865c5c2bc7aaa759ceacb56f93c6997',1,'WipperSnapper_I2C_Driver_BME280::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acfda397c53ccc1e21123f6d41c1b859d',1,'WipperSnapper_I2C_Driver_BME680::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aaa8e692371176c22572fcbd95081d937',1,'WipperSnapper_I2C_Driver_HDC302X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#ab96618bd164218991a1b80e9bf9fbb8d',1,'WipperSnapper_I2C_Driver_HTS221::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a44d4e7365069bad3a046bb7e757c7a36',1,'WipperSnapper_I2C_Driver_HTU21D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#acb2fe3f0ebd8dd24a2e39c56db82618e',1,'WipperSnapper_I2C_Driver_HTU31D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad97c0a522f75b201b1ff45adc3d03b18',1,'WipperSnapper_I2C_Driver_MS8607::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad591fdc0ecfa2697177a0a86db68884f',1,'WipperSnapper_I2C_Driver_SCD30::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4f8f51b9ba4fc6dd763cc07d6d4024fa',1,'WipperSnapper_I2C_Driver_SCD4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a585d0f06fd9f353c075d0ebd9572c952',1,'WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a344ad167dffe959697b3c4db4ea4a07e',1,'WipperSnapper_I2C_Driver_SEN6X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#aa7124e2bf4e83b6b24a9df60966d8d98',1,'WipperSnapper_I2C_Driver_SHT3X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#afc01d4300e4226a06b8a3a3f5f34e10c',1,'WipperSnapper_I2C_Driver_SHT4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a8863db8c2476797c5b648f8fc65b86bc',1,'WipperSnapper_I2C_Driver_SHTC3::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#aafa45f134fe4de304bcab741c3ab765b',1,'WipperSnapper_I2C_Driver_SI7021::getEventRelativeHumidity()']]], ['geteventtvoc',['getEventTVOC',['../class_wipper_snapper___i2_c___driver.html#a22a56a7ce38b3a84116dc96524f66cd6',1,'WipperSnapper_I2C_Driver::getEventTVOC()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#ac33016fa8bac05e7784a2644c35bdc47',1,'WipperSnapper_I2C_Driver_ENS160::getEventTVOC()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#add2d23e549c6b6f2b0a00fb7bcd79486',1,'WipperSnapper_I2C_Driver_SGP30::getEventTVOC()']]], ['geteventunitlesspercent',['getEventUnitlessPercent',['../class_wipper_snapper___i2_c___driver.html#ae50567a51f9a6602261aeec7670998a2',1,'WipperSnapper_I2C_Driver::getEventUnitlessPercent()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a7a5933073e01626be9ff7403025c4d61',1,'WipperSnapper_I2C_Driver_LC709203F::getEventUnitlessPercent()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a9e7956e6af41e41eefe4d1908ca86010',1,'WipperSnapper_I2C_Driver_MAX17048::getEventUnitlessPercent()']]], - ['geteventvocindex',['getEventVOCIndex',['../class_wipper_snapper___i2_c___driver.html#a782655a0ff3100814b6ca523bd38eb43',1,'WipperSnapper_I2C_Driver::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a5faaf81d2470592827b665e67b08d867',1,'WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a6b086be397885bd6d6d6faeecfa88d67',1,'WipperSnapper_I2C_Driver_SGP40::getEventVOCIndex()']]], + ['geteventvocindex',['getEventVOCIndex',['../class_wipper_snapper___i2_c___driver.html#a782655a0ff3100814b6ca523bd38eb43',1,'WipperSnapper_I2C_Driver::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a5faaf81d2470592827b665e67b08d867',1,'WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#aa20985c869910356e356cc14fabdd968',1,'WipperSnapper_I2C_Driver_SEN6X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a6b086be397885bd6d6d6faeecfa88d67',1,'WipperSnapper_I2C_Driver_SGP40::getEventVOCIndex()']]], ['geteventvoltage',['getEventVoltage',['../class_wipper_snapper___i2_c___driver.html#aa8eb929642f1f8506909311d07fd8674',1,'WipperSnapper_I2C_Driver::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a6d3bfb0523bbb623ad16196882770cce',1,'WipperSnapper_I2C_Driver_INA219::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a24c5897fc9eaeb2940a3d21efd421b69',1,'WipperSnapper_I2C_Driver_LC709203F::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#af0a6530168a29b47931d42447b589074',1,'WipperSnapper_I2C_Driver_MAX17048::getEventVoltage()']]], ['getgammacorrectedcolor',['getGammaCorrectedColor',['../classws__pixels.html#aafb5c100fbaaafdfd0d312968fac1a95',1,'ws_pixels']]], ['geti2caddress',['getI2CAddress',['../class_wipper_snapper___i2_c___driver.html#aef9934f4bbcf8faee9a9ce4371ae5988',1,'WipperSnapper_I2C_Driver']]], ['getloadingstate',['getLoadingState',['../classws__display__ui__helper.html#aebb5690c8b1c6a0e120bf8962e469d68',1,'ws_display_ui_helper']]], - ['getmacaddr',['getMacAddr',['../class_wippersnapper___a_i_r_l_i_f_t.html#ab8967a619a24f16975b98069a052317e',1,'Wippersnapper_AIRLIFT::getMacAddr()'],['../class_wippersnapper___e_s_p32.html#ab57f54dbcff0e24dbf9263100b887070',1,'Wippersnapper_ESP32::getMacAddr()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a2d4be62781db359524c53d3d696695f2',1,'Wippersnapper_WIFININA::getMacAddr()'],['../class_wippersnapper.html#a1034172df196bc9db1f5e390c785c0f8',1,'Wippersnapper::getMacAddr()']]], + ['getmacaddr',['getMacAddr',['../class_wippersnapper___a_i_r_l_i_f_t.html#ab8967a619a24f16975b98069a052317e',1,'Wippersnapper_AIRLIFT::getMacAddr()'],['../class_wippersnapper___e_s_p32.html#ab57f54dbcff0e24dbf9263100b887070',1,'Wippersnapper_ESP32::getMacAddr()'],['../class_wippersnapper.html#a1034172df196bc9db1f5e390c785c0f8',1,'Wippersnapper::getMacAddr()']]], ['getnativeresolution',['getNativeResolution',['../class_wippersnapper___analog_i_o.html#a79251a27be95ce1ba49fa8421f5c14cf',1,'Wippersnapper_AnalogIO']]], ['getneopixelstrandorder',['getNeoPixelStrandOrder',['../classws__pixels.html#afdadef5a9176a7bbfc826c4882665205',1,'ws_pixels']]], ['getpinvalue',['getPinValue',['../class_wippersnapper___analog_i_o.html#ab915060e10cc7808d27e3a983d62b027',1,'Wippersnapper_AnalogIO']]], ['getpinvaluevolts',['getPinValueVolts',['../class_wippersnapper___analog_i_o.html#a06a1f019ab0b2dac68e46c6a5901abb0',1,'Wippersnapper_AnalogIO']]], ['getproximity',['getProximity',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a8371d695526d04e136fe617d1ec4da49',1,'WipperSnapper_I2C_Driver_VL53L4CX']]], - ['getrssi',['getRSSI',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5a8ac4e59e125a2c3d13d8bed12efa9f',1,'Wippersnapper_AIRLIFT::getRSSI()'],['../class_wippersnapper___e_s_p32.html#ae2c425e0feaf49bf794eac887f95a4cb',1,'Wippersnapper_ESP32::getRSSI()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ae09df9ca5a275779929b76bc8d286de7',1,'Wippersnapper_WIFININA::getRSSI()'],['../class_wippersnapper.html#a260a0747d76d6cdcf6be849805c27a17',1,'Wippersnapper::getRSSI()']]], + ['getrssi',['getRSSI',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5a8ac4e59e125a2c3d13d8bed12efa9f',1,'Wippersnapper_AIRLIFT::getRSSI()'],['../class_wippersnapper___e_s_p32.html#ae2c425e0feaf49bf794eac887f95a4cb',1,'Wippersnapper_ESP32::getRSSI()'],['../class_wippersnapper.html#a260a0747d76d6cdcf6be849805c27a17',1,'Wippersnapper::getRSSI()']]], ['getsensoraltitudeperiod',['getSensorAltitudePeriod',['../class_wipper_snapper___i2_c___driver.html#a455cfe493e63106ae2e7d663c4c74dee',1,'WipperSnapper_I2C_Driver']]], ['getsensoraltitudeperiodprv',['getSensorAltitudePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a46fb934d4cf578a4743a7cee2060fddb',1,'WipperSnapper_I2C_Driver']]], ['getsensorambienttempfperiod',['getSensorAmbientTempFPeriod',['../class_wipper_snapper___i2_c___driver.html#ac8e7cf9347d0acb91bf79e28c33f03d0',1,'WipperSnapper_I2C_Driver']]], diff --git a/html/search/all_8.js b/html/search/all_8.js index 765232b98..57ba8e72c 100644 --- a/html/search/all_8.js +++ b/html/search/all_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['halterror',['haltError',['../class_wippersnapper.html#ad1ea32dd9cbe0b9e0c05ad1ad1dc4835',1,'Wippersnapper']]] + ['halterror',['haltError',['../class_wippersnapper.html#aa46f91b35371db5169facea47456854d',1,'Wippersnapper']]] ]; diff --git a/html/search/all_c.js b/html/search/all_c.js index cb7d64832..e853cf9e5 100644 --- a/html/search/all_c.js +++ b/html/search/all_c.js @@ -3,7 +3,7 @@ var searchData= ['nau7802_5ftimeout_5fms',['NAU7802_TIMEOUT_MS',['../_wipper_snapper___i2_c___driver___n_a_u7802_8h.html#adecbc21682ae4c18323da5a053ddf191',1,'WipperSnapper_I2C_Driver_NAU7802.h']]], ['nbr',['nbr',['../struct_servo_pin__t.html#ad2ff0e34820e04a276e38d359021b03c',1,'ServoPin_t']]], ['neopixelptr',['neoPixelPtr',['../structstrand__s.html#acdafa15f8f9e5e1efae553da48c96e4b',1,'strand_s']]], - ['networkstatus',['networkStatus',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac238fc561ddcd654a47b474f74ec37fb',1,'Wippersnapper_AIRLIFT::networkStatus()'],['../class_wippersnapper___e_s_p32.html#aa8d043c0f7516489964bd4eeb465bb6d',1,'Wippersnapper_ESP32::networkStatus()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aa33a4dfb0f3d2857deafdd4847baa07c',1,'Wippersnapper_WIFININA::networkStatus()'],['../class_wippersnapper.html#acc057cbc63fec2d0da8ac529aa202e4c',1,'Wippersnapper::networkStatus()']]], + ['networkstatus',['networkStatus',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac238fc561ddcd654a47b474f74ec37fb',1,'Wippersnapper_AIRLIFT::networkStatus()'],['../class_wippersnapper___e_s_p32.html#aa8d043c0f7516489964bd4eeb465bb6d',1,'Wippersnapper_ESP32::networkStatus()'],['../class_wippersnapper.html#acc057cbc63fec2d0da8ac529aa202e4c',1,'Wippersnapper::networkStatus()']]], ['ninafwver',['NINAFWVER',['../_wippersnapper___a_i_r_l_i_f_t_8h.html#a7a7f6b12d2e1ea5d55d80bb4a239daae',1,'Wippersnapper_AIRLIFT.h']]], ['notone',['noTone',['../classws__pwm.html#a41810aaf962463a9b2301f252cc45d01',1,'ws_pwm']]], ['numpixels',['numPixels',['../structstrand__s.html#a30f956af287314c28c6cde1328010ef3',1,'strand_s']]] diff --git a/html/search/all_e.js b/html/search/all_e.js index 95290a787..5dcd3cdc7 100644 --- a/html/search/all_e.js +++ b/html/search/all_e.js @@ -3,7 +3,7 @@ var searchData= ['packuartresponse',['packUARTResponse',['../classws__uart__drv.html#a2d212426ce77b3d166ce8f8ee26d9126',1,'ws_uart_drv']]], ['period',['period',['../structanalog_input_pin.html#a9c802b98c645728111732287daedea2b',1,'analogInputPin::period()'],['../structdigital_input_pin.html#a5c96669839f0ee5be8579726497240f8',1,'digitalInputPin::period()']]], ['period_5f24hrs_5fago_5fmillis',['PERIOD_24HRS_AGO_MILLIS',['../_wipper_snapper___i2_c___driver_8h.html#a77f07f886a8d851d45d1046599df7eeb',1,'WipperSnapper_I2C_Driver.h']]], - ['pin',['Pin',['../structservo__t.html#a04bcc6cf13ea5cd2c4dabdc977e054cb',1,'servo_t::Pin()'],['../structservo_component.html#a10177caa27f60f6bff9dbdad120afbc6',1,'servoComponent::pin()']]], + ['pin',['pin',['../structservo_component.html#a10177caa27f60f6bff9dbdad120afbc6',1,'servoComponent::pin()'],['../structservo__t.html#a04bcc6cf13ea5cd2c4dabdc977e054cb',1,'servo_t::Pin()']]], ['pincfgcompleted',['pinCfgCompleted',['../class_wippersnapper.html#ae625ae372c5aa19eb0a8713f25b1fca9',1,'Wippersnapper']]], ['pindotstarclock',['pinDotStarClock',['../structstrand__s.html#ad7c7f86db3afb63cbb8261179cc4d7be',1,'strand_s']]], ['pindotstardata',['pinDotStarData',['../structstrand__s.html#a0c314d917738e634288685b4c3ebad55',1,'strand_s']]], diff --git a/html/search/classes_3.js b/html/search/classes_3.js index 2782a552f..c5e8ee624 100644 --- a/html/search/classes_3.js +++ b/html/search/classes_3.js @@ -40,6 +40,7 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5fscd30',['WipperSnapper_I2C_Driver_SCD30',['../class_wipper_snapper___i2_c___driver___s_c_d30.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fscd4x',['WipperSnapper_I2C_Driver_SCD4X',['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsen5x',['WipperSnapper_I2C_Driver_SEN5X',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fsen6x',['WipperSnapper_I2C_Driver_SEN6X',['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsgp30',['WipperSnapper_I2C_Driver_SGP30',['../class_wipper_snapper___i2_c___driver___s_g_p30.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsgp40',['WipperSnapper_I2C_Driver_SGP40',['../class_wipper_snapper___i2_c___driver___s_g_p40.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsht3x',['WipperSnapper_I2C_Driver_SHT3X',['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html',1,'']]], @@ -51,13 +52,13 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5ftsl2591',['WipperSnapper_I2C_Driver_TSL2591',['../class_wipper_snapper___i2_c___driver___t_s_l2591.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4020',['WipperSnapper_I2C_Driver_VCNL4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4040',['WipperSnapper_I2C_Driver_VCNL4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fvcnl4200',['WipperSnapper_I2C_Driver_VCNL4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fveml7700',['WipperSnapper_I2C_Driver_VEML7700',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l0x',['WipperSnapper_I2C_Driver_VL53L0X',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l1x',['WipperSnapper_I2C_Driver_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l4cd',['WipperSnapper_I2C_Driver_VL53L4CD',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l4cx',['WipperSnapper_I2C_Driver_VL53L4CX',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl6180x',['WipperSnapper_I2C_Driver_VL6180X',['../class_wipper_snapper___i2_c___driver___v_l6180_x.html',1,'']]], - ['wippersnapper_5fwifinina',['Wippersnapper_WIFININA',['../class_wippersnapper___w_i_f_i_n_i_n_a.html',1,'']]], ['ws_5fdisplay_5fdriver',['ws_display_driver',['../classws__display__driver.html',1,'']]], ['ws_5fdisplay_5fui_5fhelper',['ws_display_ui_helper',['../classws__display__ui__helper.html',1,'']]], ['ws_5fds18x20',['ws_ds18x20',['../classws__ds18x20.html',1,'']]], diff --git a/html/search/defines_10.js b/html/search/defines_10.js index ac354a263..5ae2b5e43 100644 --- a/html/search/defines_10.js +++ b/html/search/defines_10.js @@ -1,5 +1,6 @@ var searchData= [ + ['wl_5fmac_5faddr_5flength',['WL_MAC_ADDR_LENGTH',['../_wippersnapper___networking_8h.html#ac2f11055182e226f041b9a71e352569f',1,'Wippersnapper_Networking.h']]], ['ws_5fdebug',['WS_DEBUG',['../_wippersnapper_8h.html#a588e957b4cb40edf5d7ce01584a1793e',1,'Wippersnapper.h']]], ['ws_5fdebug_5fprint',['WS_DEBUG_PRINT',['../_wippersnapper_8h.html#a4b57776de6f8948ef3dc51df4d35e0d3',1,'Wippersnapper.h']]], ['ws_5fdebug_5fprinthex',['WS_DEBUG_PRINTHEX',['../_wippersnapper_8h.html#a217ae461d78158c231756891179debb6',1,'Wippersnapper.h']]], @@ -10,7 +11,7 @@ var searchData= ['ws_5floading_5ftip_5f2',['WS_LOADING_TIP_2',['../ws__display__tooltips_8h.html#a14653df154797daa80ccdfe661092da9',1,'ws_display_tooltips.h']]], ['ws_5floading_5ftip_5f3',['WS_LOADING_TIP_3',['../ws__display__tooltips_8h.html#a660990ba37ce4113039144e1394d1f94',1,'ws_display_tooltips.h']]], ['ws_5floading_5ftip_5f4',['WS_LOADING_TIP_4',['../ws__display__tooltips_8h.html#af79f7a2eebf25d357d4251998966ac79',1,'ws_display_tooltips.h']]], - ['ws_5fmax_5falt_5fwifi_5fnetworks',['WS_MAX_ALT_WIFI_NETWORKS',['../_wippersnapper_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'Wippersnapper.h']]], + ['ws_5fmax_5falt_5fwifi_5fnetworks',['WS_MAX_ALT_WIFI_NETWORKS',['../_wippersnapper_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'WS_MAX_ALT_WIFI_NETWORKS(): Wippersnapper.h'],['../_wippersnapper___networking_8h.html#aea2c26f43877d3af007f74eb502c97ea',1,'WS_MAX_ALT_WIFI_NETWORKS(): Wippersnapper_Networking.h']]], ['ws_5fmqtt_5fmax_5fpayload_5fsize',['WS_MQTT_MAX_PAYLOAD_SIZE',['../_wippersnapper_8h.html#a07b8444860c318fdff531a3d0c4f2e4a',1,'Wippersnapper.h']]], ['ws_5fprinter',['WS_PRINTER',['../_wippersnapper_8h.html#ae04b6b322705e95cdf2d837493a55a57',1,'Wippersnapper.h']]], ['ws_5fversion',['WS_VERSION',['../_wippersnapper_8h.html#aea527b2900703a26fe8c38d065b4f9e7',1,'Wippersnapper.h']]], diff --git a/html/search/defines_c.js b/html/search/defines_c.js index ac4eddc04..5557d13f6 100644 --- a/html/search/defines_c.js +++ b/html/search/defines_c.js @@ -1,7 +1,7 @@ var searchData= [ ['sealevelpressure_5fhpa',['SEALEVELPRESSURE_HPA',['../_wipper_snapper___i2_c___driver___b_m_e280_8h.html#a3fd1be5675628ccdd1cd809ee995b2e7',1,'SEALEVELPRESSURE_HPA(): WipperSnapper_I2C_Driver_BME280.h'],['../_wipper_snapper___i2_c___driver___b_m_e680_8h.html#a3fd1be5675628ccdd1cd809ee995b2e7',1,'SEALEVELPRESSURE_HPA(): WipperSnapper_I2C_Driver_BME680.h'],['../_wipper_snapper___i2_c___driver___b_m_p280_8h.html#a3fd1be5675628ccdd1cd809ee995b2e7',1,'SEALEVELPRESSURE_HPA(): WipperSnapper_I2C_Driver_BMP280.h'],['../_wipper_snapper___i2_c___driver___b_m_p3_x_x_8h.html#a3fd1be5675628ccdd1cd809ee995b2e7',1,'SEALEVELPRESSURE_HPA(): WipperSnapper_I2C_Driver_BMP3XX.h'],['../_wipper_snapper___i2_c___driver___e_n_s160_8h.html#a3fd1be5675628ccdd1cd809ee995b2e7',1,'SEALEVELPRESSURE_HPA(): WipperSnapper_I2C_Driver_ENS160.h']]], - ['spiwifi',['SPIWIFI',['../_wippersnapper___a_i_r_l_i_f_t_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'SPIWIFI(): Wippersnapper_AIRLIFT.h'],['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'SPIWIFI(): Wippersnapper_WIFININA.h']]], + ['spiwifi',['SPIWIFI',['../_wippersnapper___a_i_r_l_i_f_t_8h.html#a02a0537d71f1fad2ceb5cef4950f4f18',1,'Wippersnapper_AIRLIFT.h']]], ['status_5fdotstar_5fcolor_5forder',['STATUS_DOTSTAR_COLOR_ORDER',['../_wippersnapper___boards_8h.html#a8bf6b21e770886d409a5266b34dbc40b',1,'Wippersnapper_Boards.h']]], ['status_5fdotstar_5fnum',['STATUS_DOTSTAR_NUM',['../_wippersnapper___boards_8h.html#a064728df19116a95cb2b2672e85c01bc',1,'Wippersnapper_Boards.h']]], ['status_5fdotstar_5fpin_5fclk',['STATUS_DOTSTAR_PIN_CLK',['../_wippersnapper___boards_8h.html#a882cdccd2b9725880419c51137a383fd',1,'Wippersnapper_Boards.h']]], diff --git a/html/search/files_0.js b/html/search/files_0.js index e0a4c9bba..453558690 100644 --- a/html/search/files_0.js +++ b/html/search/files_0.js @@ -45,6 +45,7 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5fscd30_2eh',['WipperSnapper_I2C_Driver_SCD30.h',['../_wipper_snapper___i2_c___driver___s_c_d30_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fscd4x_2eh',['WipperSnapper_I2C_Driver_SCD4X.h',['../_wipper_snapper___i2_c___driver___s_c_d4_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsen5x_2eh',['WipperSnapper_I2C_Driver_SEN5X.h',['../_wipper_snapper___i2_c___driver___s_e_n5_x_8h.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fsen6x_2eh',['WipperSnapper_I2C_Driver_SEN6X.h',['../_wipper_snapper___i2_c___driver___s_e_n6_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsgp40_2eh',['WipperSnapper_I2C_Driver_SGP40.h',['../_wipper_snapper___i2_c___driver___s_g_p40_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsht3x_2eh',['WipperSnapper_I2C_Driver_SHT3X.h',['../_wipper_snapper___i2_c___driver___s_h_t3_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fsht4x_2eh',['WipperSnapper_I2C_Driver_SHT4X.h',['../_wipper_snapper___i2_c___driver___s_h_t4_x_8h.html',1,'']]], @@ -55,6 +56,7 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5ftsl2591_2eh',['WipperSnapper_I2C_Driver_TSL2591.h',['../_wipper_snapper___i2_c___driver___t_s_l2591_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4020_2eh',['WipperSnapper_I2C_Driver_VCNL4020.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4020_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4040_2eh',['WipperSnapper_I2C_Driver_VCNL4040.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4040_8h.html',1,'']]], + ['wippersnapper_5fi2c_5fdriver_5fvcnl4200_2eh',['WipperSnapper_I2C_Driver_VCNL4200.h',['../_wipper_snapper___i2_c___driver___v_c_n_l4200_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fveml7700_2eh',['WipperSnapper_I2C_Driver_VEML7700.h',['../_wipper_snapper___i2_c___driver___v_e_m_l7700_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l0x_2eh',['WipperSnapper_I2C_Driver_VL53L0X.h',['../_wipper_snapper___i2_c___driver___v_l53_l0_x_8h.html',1,'']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l1x_2eh',['WipperSnapper_I2C_Driver_VL53L1X.h',['../_wipper_snapper___i2_c___driver___v_l53_l1_x_8h.html',1,'']]], @@ -65,7 +67,6 @@ var searchData= ['wippersnapper_5fregister_2ecpp',['Wippersnapper_Register.cpp',['../_wippersnapper___register_8cpp.html',1,'']]], ['wippersnapper_5fstatusled_2ecpp',['Wippersnapper_StatusLED.cpp',['../_wippersnapper___status_l_e_d_8cpp.html',1,'']]], ['wippersnapper_5fstatusled_2eh',['Wippersnapper_StatusLED.h',['../_wippersnapper___status_l_e_d_8h.html',1,'']]], - ['wippersnapper_5fwifinina_2eh',['Wippersnapper_WIFININA.h',['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html',1,'']]], ['ws_5fdisplay_5fdriver_2ecpp',['ws_display_driver.cpp',['../ws__display__driver_8cpp.html',1,'']]], ['ws_5fdisplay_5fdriver_2eh',['ws_display_driver.h',['../ws__display__driver_8h.html',1,'']]], ['ws_5fdisplay_5ftooltips_2eh',['ws_display_tooltips.h',['../ws__display__tooltips_8h.html',1,'']]], diff --git a/html/search/functions_0.js b/html/search/functions_0.js index e58306e40..b3879e28c 100644 --- a/html/search/functions_0.js +++ b/html/search/functions_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['_5fconnect',['_connect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a47f15e4f94c2fa403ff8c70be97156c3',1,'Wippersnapper_AIRLIFT::_connect()'],['../class_wippersnapper___e_s_p32.html#a6b4b61de089e76200f78ecfee79ff741',1,'Wippersnapper_ESP32::_connect()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a37499d40e4c1258c68bf332dd20a0947',1,'Wippersnapper_WIFININA::_connect()'],['../class_wippersnapper.html#ad87ad173ce1969274e5d83af2621c265',1,'Wippersnapper::_connect()']]], - ['_5fdisconnect',['_disconnect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a03105722dccd0573b2c505abcc44020e',1,'Wippersnapper_AIRLIFT::_disconnect()'],['../class_wippersnapper___e_s_p32.html#a979ca637505009d2cca04524665931e4',1,'Wippersnapper_ESP32::_disconnect()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a4f1d178172a418dc1ba7df6ff4ded92c',1,'Wippersnapper_WIFININA::_disconnect()'],['../class_wippersnapper.html#a5ba2ef7071046c072b644d56c71b31d3',1,'Wippersnapper::_disconnect()']]] + ['_5fconnect',['_connect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a47f15e4f94c2fa403ff8c70be97156c3',1,'Wippersnapper_AIRLIFT::_connect()'],['../class_wippersnapper___e_s_p32.html#a6b4b61de089e76200f78ecfee79ff741',1,'Wippersnapper_ESP32::_connect()'],['../class_wippersnapper.html#ad87ad173ce1969274e5d83af2621c265',1,'Wippersnapper::_connect()']]], + ['_5fdisconnect',['_disconnect',['../class_wippersnapper___a_i_r_l_i_f_t.html#a03105722dccd0573b2c505abcc44020e',1,'Wippersnapper_AIRLIFT::_disconnect()'],['../class_wippersnapper___e_s_p32.html#a979ca637505009d2cca04524665931e4',1,'Wippersnapper_ESP32::_disconnect()'],['../class_wippersnapper.html#a5ba2ef7071046c072b644d56c71b31d3',1,'Wippersnapper::_disconnect()']]] ]; diff --git a/html/search/functions_11.js b/html/search/functions_11.js index 49fd408e0..035bd2ea8 100644 --- a/html/search/functions_11.js +++ b/html/search/functions_11.js @@ -39,6 +39,7 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5fscd30',['WipperSnapper_I2C_Driver_SCD30',['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ab6a369621e4c40a5543caacd84cae708',1,'WipperSnapper_I2C_Driver_SCD30']]], ['wippersnapper_5fi2c_5fdriver_5fscd4x',['WipperSnapper_I2C_Driver_SCD4X',['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#aa920aa4ff9f2a2c8b421273ca11b40c9',1,'WipperSnapper_I2C_Driver_SCD4X']]], ['wippersnapper_5fi2c_5fdriver_5fsen5x',['WipperSnapper_I2C_Driver_SEN5X',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af3138b9f21091b5be1abed29ecc6fd20',1,'WipperSnapper_I2C_Driver_SEN5X']]], + ['wippersnapper_5fi2c_5fdriver_5fsen6x',['WipperSnapper_I2C_Driver_SEN6X',['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a5cb6acd8e53bd681aef676af11c5b2aa',1,'WipperSnapper_I2C_Driver_SEN6X']]], ['wippersnapper_5fi2c_5fdriver_5fsgp30',['WipperSnapper_I2C_Driver_SGP30',['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af9fd8d9b94396daf24a92bf89137cebb',1,'WipperSnapper_I2C_Driver_SGP30']]], ['wippersnapper_5fi2c_5fdriver_5fsgp40',['WipperSnapper_I2C_Driver_SGP40',['../class_wipper_snapper___i2_c___driver___s_g_p40.html#af272b01ebcd44fde75f05cb2d899bfac',1,'WipperSnapper_I2C_Driver_SGP40']]], ['wippersnapper_5fi2c_5fdriver_5fsht3x',['WipperSnapper_I2C_Driver_SHT3X',['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a500718b78302f030c944cdeddd7eb887',1,'WipperSnapper_I2C_Driver_SHT3X']]], @@ -50,13 +51,13 @@ var searchData= ['wippersnapper_5fi2c_5fdriver_5ftsl2591',['WipperSnapper_I2C_Driver_TSL2591',['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a32d2203b22289c8c2992e6cc88b4343e',1,'WipperSnapper_I2C_Driver_TSL2591']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4020',['WipperSnapper_I2C_Driver_VCNL4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a3919aff4bd030570f82753d9af36a245',1,'WipperSnapper_I2C_Driver_VCNL4020']]], ['wippersnapper_5fi2c_5fdriver_5fvcnl4040',['WipperSnapper_I2C_Driver_VCNL4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2ddf9a074faeea9626a351844ea92d19',1,'WipperSnapper_I2C_Driver_VCNL4040']]], + ['wippersnapper_5fi2c_5fdriver_5fvcnl4200',['WipperSnapper_I2C_Driver_VCNL4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a08cbed6a83f55ed45e7883f0dbdd7b93',1,'WipperSnapper_I2C_Driver_VCNL4200']]], ['wippersnapper_5fi2c_5fdriver_5fveml7700',['WipperSnapper_I2C_Driver_VEML7700',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#aeb5df38f4d8d59e21a4627f516d0e154',1,'WipperSnapper_I2C_Driver_VEML7700']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l0x',['WipperSnapper_I2C_Driver_VL53L0X',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a01032dcb31d0ca9346415fffb0df3121',1,'WipperSnapper_I2C_Driver_VL53L0X']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l1x',['WipperSnapper_I2C_Driver_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a7fe997d05928bdab3038721fb623703c',1,'WipperSnapper_I2C_Driver_VL53L1X']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l4cd',['WipperSnapper_I2C_Driver_VL53L4CD',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#ad99af93df4fcce787e0cb75a677be55f',1,'WipperSnapper_I2C_Driver_VL53L4CD']]], ['wippersnapper_5fi2c_5fdriver_5fvl53l4cx',['WipperSnapper_I2C_Driver_VL53L4CX',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a6a4ce52c1cb38744c965457a1a5322fe',1,'WipperSnapper_I2C_Driver_VL53L4CX']]], ['wippersnapper_5fi2c_5fdriver_5fvl6180x',['WipperSnapper_I2C_Driver_VL6180X',['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#aab3da253a8a5e9dfbcfec16142f6558f',1,'WipperSnapper_I2C_Driver_VL6180X']]], - ['wippersnapper_5fwifinina',['Wippersnapper_WIFININA',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a788d21129715868932c6526d08e52b90',1,'Wippersnapper_WIFININA']]], ['writedutycycle',['writeDutyCycle',['../classws__pwm.html#a0e9d0fe12cf0cae6b86667863ee3f62c',1,'ws_pwm']]], ['writemicroseconds',['writeMicroseconds',['../classws__ledc__servo.html#a308fb04a26586aeb98a6df344f36476c',1,'ws_ledc_servo']]], ['writetone',['writeTone',['../classws__pwm.html#a81c006b8166c39f183d2ec1636d23a9b',1,'ws_pwm']]], diff --git a/html/search/functions_12.js b/html/search/functions_12.js index 1a019342d..4c67d52a0 100644 --- a/html/search/functions_12.js +++ b/html/search/functions_12.js @@ -43,13 +43,13 @@ var searchData= ['_7ewippersnapper_5fi2c_5fdriver_5ftsl2591',['~WipperSnapper_I2C_Driver_TSL2591',['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a679ec07e6ef21915457edd04ac5d4878',1,'WipperSnapper_I2C_Driver_TSL2591']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4020',['~WipperSnapper_I2C_Driver_VCNL4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#aa2063196436869dbad2ec23846a692fc',1,'WipperSnapper_I2C_Driver_VCNL4020']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4040',['~WipperSnapper_I2C_Driver_VCNL4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f4d84d0e86e00991eb367e86ce55936',1,'WipperSnapper_I2C_Driver_VCNL4040']]], + ['_7ewippersnapper_5fi2c_5fdriver_5fvcnl4200',['~WipperSnapper_I2C_Driver_VCNL4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a737bcafff65049cbc43f1d36994282e1',1,'WipperSnapper_I2C_Driver_VCNL4200']]], ['_7ewippersnapper_5fi2c_5fdriver_5fveml7700',['~WipperSnapper_I2C_Driver_VEML7700',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a8f66b3d2338c4f5415f862c3efa64d0f',1,'WipperSnapper_I2C_Driver_VEML7700']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l0x',['~WipperSnapper_I2C_Driver_VL53L0X',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a8e6764523ccf775a1275675bdb639186',1,'WipperSnapper_I2C_Driver_VL53L0X']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l1x',['~WipperSnapper_I2C_Driver_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#ab732dde3282be2ad77b38d92f09178af',1,'WipperSnapper_I2C_Driver_VL53L1X']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l4cd',['~WipperSnapper_I2C_Driver_VL53L4CD',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a31cd18c62ccc325abe5179bfc2fe3ef2',1,'WipperSnapper_I2C_Driver_VL53L4CD']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl53l4cx',['~WipperSnapper_I2C_Driver_VL53L4CX',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a28ba3689927e192e75691586e4196617',1,'WipperSnapper_I2C_Driver_VL53L4CX']]], ['_7ewippersnapper_5fi2c_5fdriver_5fvl6180x',['~WipperSnapper_I2C_Driver_VL6180X',['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a45365feac8bd0a7af3fc1808d4a62e29',1,'WipperSnapper_I2C_Driver_VL6180X']]], - ['_7ewippersnapper_5fwifinina',['~Wippersnapper_WIFININA',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a3b0e76c06bba9199b97ad4ee925e0a50',1,'Wippersnapper_WIFININA']]], ['_7ews_5fdisplay_5fdriver',['~ws_display_driver',['../classws__display__driver.html#abd82ed5b45f055174bcf1e2fe2b68da1',1,'ws_display_driver']]], ['_7ews_5fds18x20',['~ws_ds18x20',['../classws__ds18x20.html#a0f71b4cb1b4b889d6dfad824912a0dd8',1,'ws_ds18x20']]], ['_7ews_5fledc',['~ws_ledc',['../classws__ledc.html#a7c7699415c97d2b26b6fb5f1fe757910',1,'ws_ledc']]], diff --git a/html/search/functions_2.js b/html/search/functions_2.js index 93bb33f35..fd74d5546 100644 --- a/html/search/functions_2.js +++ b/html/search/functions_2.js @@ -1,6 +1,6 @@ var searchData= [ - ['begin',['begin',['../class_wipper_snapper___i2_c___driver.html#af5039680b612fa873f0744b36532452d',1,'WipperSnapper_I2C_Driver::begin()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#aeeea35799a46f425efcf1282669d8d98',1,'WipperSnapper_I2C_Driver_ADT7410::begin()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#adefde55b4ca1c2fae521c13789823e8e',1,'WipperSnapper_I2C_Driver_AHTX0::begin()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#af8669d6ccf558572210844e83defea9a',1,'WipperSnapper_I2C_Driver_BH1750::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a62d8a7baa2dbe0b4669ee45453a3aa96',1,'WipperSnapper_I2C_Driver_BME280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a58a85310b6ef442550ee9b8efa4acc6b',1,'WipperSnapper_I2C_Driver_BME680::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#aa9b4760fa47a515031b480a29edef73c',1,'WipperSnapper_I2C_Driver_BMP280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a6cad94a9c555a947d63c6e7519425de7',1,'WipperSnapper_I2C_Driver_BMP3XX::begin()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a5522ff5e7c35d6c70806c3916c8e19d6',1,'WipperSnapper_I2C_Driver_DPS310::begin()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#a0b4689bab708accfcbf579b325149cd4',1,'WipperSnapper_I2C_Driver_DS2484::begin()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#afbf4a6f70a454b7afa533d3eb61c8e2f',1,'WipperSnapper_I2C_Driver_ENS160::begin()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aed7594b4ba7acb1a34c73340263795f9',1,'WipperSnapper_I2C_Driver_HDC302X::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#a7898f38b582894379ff70fdedffec3fd',1,'WipperSnapper_I2C_Driver_HTS221::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#ae4859c72fcfe012a807a76b08dbca601',1,'WipperSnapper_I2C_Driver_HTU21D::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#aa124e9779a1a329bf6f2967603b4c30f',1,'WipperSnapper_I2C_Driver_HTU31D::begin()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a95a2de6c5bca236c79dd70b49d969442',1,'WipperSnapper_I2C_Driver_INA219::begin()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#ad02364a15c27b33143d3d32ebc527b1d',1,'WipperSnapper_I2C_Driver_LC709203F::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a19e8b8bb16e8527c16a233f8f044f90d',1,'WipperSnapper_I2C_Driver_LPS22HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a96a329c01817a1f102fec819355db6f0',1,'WipperSnapper_I2C_Driver_LPS25HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a5bf52913f5963afac1a95c9421dee447',1,'WipperSnapper_I2C_Driver_LPS3XHW::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a365a8b22b488c528db41eed8f975185f',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#aff5df0adcbc3b03ec4cb67875ca8cf2e',1,'WipperSnapper_I2C_Driver_LTR390::begin()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a369ce4f627702980944e06d59d49e5f1',1,'WipperSnapper_I2C_Driver_MAX17048::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a191d5c9311b8178cf8a3a80d1ab67f5e',1,'WipperSnapper_I2C_Driver_MCP3421::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ac58ac764e00863146b0157da3024947e',1,'WipperSnapper_I2C_Driver_MCP9808::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aa15f1c425a04137bd01d9f68b3f99b0d',1,'WipperSnapper_I2C_Driver_MPL115A2::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#aca515aa0265e22424dc6aa92110a6a60',1,'WipperSnapper_I2C_Driver_MPRLS::begin()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#af22e43ddd4d637292a51847800feb286',1,'WipperSnapper_I2C_Driver_MS8607::begin()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a45d3f67bb17647243cad84b6a9c89c52',1,'WipperSnapper_I2C_Driver_NAU7802::begin()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a3fb78436695952ab1a25e5bc4611fc36',1,'WipperSnapper_I2C_Driver_PCT2075::begin()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ae87bbd82a49d9c612c422ccdda198dbb',1,'WipperSnapper_I2C_Driver_PM25::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad52ff6ab5b99d56d286772754693e2ad',1,'WipperSnapper_I2C_Driver_SCD30::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a2952d397728ae5b6b70869d9ebd49502',1,'WipperSnapper_I2C_Driver_SCD4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a88c5014ec6b3d14daa863ff3e347ab97',1,'WipperSnapper_I2C_Driver_SEN5X::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af05b38becd004e747d466fc5e6e07228',1,'WipperSnapper_I2C_Driver_SGP30::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a540f4edb0a5a2c9809bf9fc4426dcb9f',1,'WipperSnapper_I2C_Driver_SGP40::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a728a62e06e9b16a091f1d939b2bd770f',1,'WipperSnapper_I2C_Driver_SHT3X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#a5ab9a8f6204b6f6b194932f83e143379',1,'WipperSnapper_I2C_Driver_SHT4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a9f1d6d560bc6b150269be262b0cee531',1,'WipperSnapper_I2C_Driver_SHTC3::begin()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#a4ad36fbae51a51edd4fddea69490992d',1,'WipperSnapper_I2C_Driver_SI7021::begin()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a2d334fd5292f26cffa273d35bddb94a8',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::begin()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#a78abb93cb0e4b97621338394fe77e38e',1,'WipperSnapper_I2C_Driver_TMP117::begin()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a78fb1b313f36639f86d51a5438e9222d',1,'WipperSnapper_I2C_Driver_TSL2591::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a9fc87f93acd6e9bd3275bb38718ef094',1,'WipperSnapper_I2C_Driver_VCNL4020::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a572eff02ee82cda55461872762e64f86',1,'WipperSnapper_I2C_Driver_VCNL4040::begin()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#abc837dfece950d0ed05c6c61d95b1510',1,'WipperSnapper_I2C_Driver_VEML7700::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a1c69bf38d3a39edf1780f7534669d837',1,'WipperSnapper_I2C_Driver_VL53L0X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a24bf2d135d0251b70c07508ba02ab200',1,'WipperSnapper_I2C_Driver_VL53L1X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a4f575c65c1f1eb650397564d4903477c',1,'WipperSnapper_I2C_Driver_VL53L4CD::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a9abe6a74347d09ebf3135600cdbabd64',1,'WipperSnapper_I2C_Driver_VL53L4CX::begin()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a318d8c5da799ee9e98a9acd70a016524',1,'WipperSnapper_I2C_Driver_VL6180X::begin()'],['../classws__uart__drv.html#a2a9f0f39f140d5fe82b64cb105963a94',1,'ws_uart_drv::begin()'],['../classws__uart__drv__pm25aqi.html#a869e42ee2757aa9a46e1ecc6d3192a2b',1,'ws_uart_drv_pm25aqi::begin()'],['../classws__display__driver.html#a7d6f973d0ef9b6241488afba2878485f',1,'ws_display_driver::begin()']]], + ['begin',['begin',['../class_wipper_snapper___i2_c___driver.html#af5039680b612fa873f0744b36532452d',1,'WipperSnapper_I2C_Driver::begin()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#aeeea35799a46f425efcf1282669d8d98',1,'WipperSnapper_I2C_Driver_ADT7410::begin()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#adefde55b4ca1c2fae521c13789823e8e',1,'WipperSnapper_I2C_Driver_AHTX0::begin()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#af8669d6ccf558572210844e83defea9a',1,'WipperSnapper_I2C_Driver_BH1750::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a62d8a7baa2dbe0b4669ee45453a3aa96',1,'WipperSnapper_I2C_Driver_BME280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a58a85310b6ef442550ee9b8efa4acc6b',1,'WipperSnapper_I2C_Driver_BME680::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#aa9b4760fa47a515031b480a29edef73c',1,'WipperSnapper_I2C_Driver_BMP280::begin()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a6cad94a9c555a947d63c6e7519425de7',1,'WipperSnapper_I2C_Driver_BMP3XX::begin()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a5522ff5e7c35d6c70806c3916c8e19d6',1,'WipperSnapper_I2C_Driver_DPS310::begin()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#a0b4689bab708accfcbf579b325149cd4',1,'WipperSnapper_I2C_Driver_DS2484::begin()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#afbf4a6f70a454b7afa533d3eb61c8e2f',1,'WipperSnapper_I2C_Driver_ENS160::begin()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aed7594b4ba7acb1a34c73340263795f9',1,'WipperSnapper_I2C_Driver_HDC302X::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#a7898f38b582894379ff70fdedffec3fd',1,'WipperSnapper_I2C_Driver_HTS221::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#ae4859c72fcfe012a807a76b08dbca601',1,'WipperSnapper_I2C_Driver_HTU21D::begin()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#aa124e9779a1a329bf6f2967603b4c30f',1,'WipperSnapper_I2C_Driver_HTU31D::begin()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a95a2de6c5bca236c79dd70b49d969442',1,'WipperSnapper_I2C_Driver_INA219::begin()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#ad02364a15c27b33143d3d32ebc527b1d',1,'WipperSnapper_I2C_Driver_LC709203F::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a19e8b8bb16e8527c16a233f8f044f90d',1,'WipperSnapper_I2C_Driver_LPS22HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a96a329c01817a1f102fec819355db6f0',1,'WipperSnapper_I2C_Driver_LPS25HB::begin()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a5bf52913f5963afac1a95c9421dee447',1,'WipperSnapper_I2C_Driver_LPS3XHW::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a365a8b22b488c528db41eed8f975185f',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::begin()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#aff5df0adcbc3b03ec4cb67875ca8cf2e',1,'WipperSnapper_I2C_Driver_LTR390::begin()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a369ce4f627702980944e06d59d49e5f1',1,'WipperSnapper_I2C_Driver_MAX17048::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a191d5c9311b8178cf8a3a80d1ab67f5e',1,'WipperSnapper_I2C_Driver_MCP3421::begin()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ac58ac764e00863146b0157da3024947e',1,'WipperSnapper_I2C_Driver_MCP9808::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aa15f1c425a04137bd01d9f68b3f99b0d',1,'WipperSnapper_I2C_Driver_MPL115A2::begin()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#aca515aa0265e22424dc6aa92110a6a60',1,'WipperSnapper_I2C_Driver_MPRLS::begin()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#af22e43ddd4d637292a51847800feb286',1,'WipperSnapper_I2C_Driver_MS8607::begin()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a45d3f67bb17647243cad84b6a9c89c52',1,'WipperSnapper_I2C_Driver_NAU7802::begin()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a3fb78436695952ab1a25e5bc4611fc36',1,'WipperSnapper_I2C_Driver_PCT2075::begin()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ae87bbd82a49d9c612c422ccdda198dbb',1,'WipperSnapper_I2C_Driver_PM25::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad52ff6ab5b99d56d286772754693e2ad',1,'WipperSnapper_I2C_Driver_SCD30::begin()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a2952d397728ae5b6b70869d9ebd49502',1,'WipperSnapper_I2C_Driver_SCD4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a88c5014ec6b3d14daa863ff3e347ab97',1,'WipperSnapper_I2C_Driver_SEN5X::begin()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a3f9b9eca2742a40fe057ba6594f50f80',1,'WipperSnapper_I2C_Driver_SEN6X::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#af05b38becd004e747d466fc5e6e07228',1,'WipperSnapper_I2C_Driver_SGP30::begin()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a540f4edb0a5a2c9809bf9fc4426dcb9f',1,'WipperSnapper_I2C_Driver_SGP40::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a728a62e06e9b16a091f1d939b2bd770f',1,'WipperSnapper_I2C_Driver_SHT3X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#a5ab9a8f6204b6f6b194932f83e143379',1,'WipperSnapper_I2C_Driver_SHT4X::begin()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a9f1d6d560bc6b150269be262b0cee531',1,'WipperSnapper_I2C_Driver_SHTC3::begin()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#a4ad36fbae51a51edd4fddea69490992d',1,'WipperSnapper_I2C_Driver_SI7021::begin()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a2d334fd5292f26cffa273d35bddb94a8',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::begin()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#a78abb93cb0e4b97621338394fe77e38e',1,'WipperSnapper_I2C_Driver_TMP117::begin()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#a78fb1b313f36639f86d51a5438e9222d',1,'WipperSnapper_I2C_Driver_TSL2591::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a9fc87f93acd6e9bd3275bb38718ef094',1,'WipperSnapper_I2C_Driver_VCNL4020::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a572eff02ee82cda55461872762e64f86',1,'WipperSnapper_I2C_Driver_VCNL4040::begin()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#aca5d5527a0bb963c9a307f0731641a1d',1,'WipperSnapper_I2C_Driver_VCNL4200::begin()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#abc837dfece950d0ed05c6c61d95b1510',1,'WipperSnapper_I2C_Driver_VEML7700::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#a1c69bf38d3a39edf1780f7534669d837',1,'WipperSnapper_I2C_Driver_VL53L0X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a24bf2d135d0251b70c07508ba02ab200',1,'WipperSnapper_I2C_Driver_VL53L1X::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a4f575c65c1f1eb650397564d4903477c',1,'WipperSnapper_I2C_Driver_VL53L4CD::begin()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a9abe6a74347d09ebf3135600cdbabd64',1,'WipperSnapper_I2C_Driver_VL53L4CX::begin()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a318d8c5da799ee9e98a9acd70a016524',1,'WipperSnapper_I2C_Driver_VL6180X::begin()'],['../classws__uart__drv.html#a2a9f0f39f140d5fe82b64cb105963a94',1,'ws_uart_drv::begin()'],['../classws__uart__drv__pm25aqi.html#a869e42ee2757aa9a46e1ecc6d3192a2b',1,'ws_uart_drv_pm25aqi::begin()'],['../classws__display__driver.html#a7d6f973d0ef9b6241488afba2878485f',1,'ws_display_driver::begin()']]], ['bmeperformreading',['bmePerformReading',['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a52203d106dd9ba4625301ad958c87997',1,'WipperSnapper_I2C_Driver_BME680']]], ['build_5fscr_5fmonitor',['build_scr_monitor',['../classws__display__ui__helper.html#ac79701a03a3a6e492fafeeb264550c88',1,'ws_display_ui_helper']]] ]; diff --git a/html/search/functions_3.js b/html/search/functions_3.js index 935e54efb..3ca7050a7 100644 --- a/html/search/functions_3.js +++ b/html/search/functions_3.js @@ -1,5 +1,6 @@ var searchData= [ + ['calculatehysteresis',['calculateHysteresis',['../_wippersnapper___analog_i_o_8cpp.html#a090ac9aa22bca6965e84a97ea3048bc1',1,'Wippersnapper_AnalogIO.cpp']]], ['cbdecodedigitalpinwritemsg',['cbDecodeDigitalPinWriteMsg',['../_wippersnapper_8cpp.html#a10bcdf641a00178a2051f9c913c3ce1b',1,'Wippersnapper.cpp']]], ['cbdecodeds18x20msg',['cbDecodeDs18x20Msg',['../_wippersnapper_8cpp.html#ae9f35382d74f2d8914948038f9fc6d24',1,'Wippersnapper.cpp']]], ['cbdecodei2cdeviceinitrequestlist',['cbDecodeI2CDeviceInitRequestList',['../_wippersnapper_8cpp.html#a847c2a4449caffd9e61983089a72a3ed',1,'Wippersnapper.cpp']]], @@ -20,7 +21,7 @@ var searchData= ['cbsignaltopic',['cbSignalTopic',['../_wippersnapper_8cpp.html#adf3bf6470c06cad9086c3a8556474dbe',1,'Wippersnapper.cpp']]], ['cbsignaluartreq',['cbSignalUARTReq',['../_wippersnapper_8cpp.html#afbca6f75bec609c0af55ff815be2e964',1,'Wippersnapper.cpp']]], ['cbthrottletopic',['cbThrottleTopic',['../_wippersnapper_8cpp.html#aa1e37658221dffced66cc9e1548e5be1',1,'Wippersnapper.cpp']]], - ['check_5fvalid_5fssid',['check_valid_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#ad7a4443676e200227a9dc661f263c52a',1,'Wippersnapper_AIRLIFT::check_valid_ssid()'],['../class_wippersnapper___e_s_p32.html#a36994b82d22db88f67777aaf4e097f1b',1,'Wippersnapper_ESP32::check_valid_ssid()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aaee5680c8abe5ec08f34166f1d669adf',1,'Wippersnapper_WIFININA::check_valid_ssid()'],['../class_wippersnapper.html#a288ccdd64ddcec63c3cd2b7a74182a66',1,'Wippersnapper::check_valid_ssid()']]], + ['check_5fvalid_5fssid',['check_valid_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#ad7a4443676e200227a9dc661f263c52a',1,'Wippersnapper_AIRLIFT::check_valid_ssid()'],['../class_wippersnapper___e_s_p32.html#a36994b82d22db88f67777aaf4e097f1b',1,'Wippersnapper_ESP32::check_valid_ssid()'],['../class_wippersnapper.html#a288ccdd64ddcec63c3cd2b7a74182a66',1,'Wippersnapper::check_valid_ssid()']]], ['clear_5fscr_5fload',['clear_scr_load',['../classws__display__ui__helper.html#a9afaed92b8e6de31aa5b87cc58e615d8',1,'ws_display_ui_helper']]], ['compareversions',['compareVersions',['../class_wippersnapper___a_i_r_l_i_f_t.html#abc598a748031959da5643da3b9935834',1,'Wippersnapper_AIRLIFT']]], ['configanaloginpinreq',['configAnalogInPinReq',['../class_wippersnapper.html#a089cb6c8b641aa22762f00dda783bb12',1,'Wippersnapper']]], @@ -29,5 +30,5 @@ var searchData= ['configuredriver',['configureDriver',['../class_wipper_snapper___i2_c___driver.html#a86ede95ee6f5495739c16a3cf47a8c5a',1,'WipperSnapper_I2C_Driver']]], ['configuresensor',['configureSensor',['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a06d957e925f7505b2e3cc4c0d017ad3d',1,'WipperSnapper_I2C_Driver_MCP3421']]], ['connect',['connect',['../class_wippersnapper.html#add749b3d330161a132fd7e0114618ec0',1,'Wippersnapper']]], - ['connectiontype',['connectionType',['../class_wippersnapper___a_i_r_l_i_f_t.html#adf8d75a7530ff367f8a03e8e9afca7b1',1,'Wippersnapper_AIRLIFT::connectionType()'],['../class_wippersnapper___e_s_p32.html#a3ae46effd5e7bd00898ed5967898a58a',1,'Wippersnapper_ESP32::connectionType()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ab003b4b439f438ffef72779b0adb179f',1,'Wippersnapper_WIFININA::connectionType()']]] + ['connectiontype',['connectionType',['../class_wippersnapper___a_i_r_l_i_f_t.html#adf8d75a7530ff367f8a03e8e9afca7b1',1,'Wippersnapper_AIRLIFT::connectionType()'],['../class_wippersnapper___e_s_p32.html#a3ae46effd5e7bd00898ed5967898a58a',1,'Wippersnapper_ESP32::connectionType()']]] ]; diff --git a/html/search/functions_6.js b/html/search/functions_6.js index cbe4cae42..53d4b5a4f 100644 --- a/html/search/functions_6.js +++ b/html/search/functions_6.js @@ -3,6 +3,6 @@ var searchData= ['feedwdt',['feedWDT',['../class_wippersnapper.html#ab3e122ca0d602d5ee3e2a0b82bbc32ad',1,'Wippersnapper']]], ['filleventmessage',['fillEventMessage',['../class_wipper_snapper___component___i2_c.html#a85c0bb433ab661de67889ef12070c51b',1,'WipperSnapper_Component_I2C']]], ['fillstrand',['fillStrand',['../classws__pixels.html#affc6e43365ed7ae568ee26bf492fe11d',1,'ws_pixels']]], - ['firmwarecheck',['firmwareCheck',['../class_wippersnapper___a_i_r_l_i_f_t.html#accdf5d5a8cf24ff783816d901a75249f',1,'Wippersnapper_AIRLIFT::firmwareCheck()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ad7f52d4e776fff650aa246feca34d122',1,'Wippersnapper_WIFININA::firmwareCheck()']]], + ['firmwarecheck',['firmwareCheck',['../class_wippersnapper___a_i_r_l_i_f_t.html#accdf5d5a8cf24ff783816d901a75249f',1,'Wippersnapper_AIRLIFT']]], ['flushnau7802',['flushNAU7802',['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a7912624c214837c9c8ad35bd37dead85',1,'WipperSnapper_I2C_Driver_NAU7802']]] ]; diff --git a/html/search/functions_7.js b/html/search/functions_7.js index 94f4f8a06..dcbf25790 100644 --- a/html/search/functions_7.js +++ b/html/search/functions_7.js @@ -10,38 +10,38 @@ var searchData= ['getdotstarstrandorder',['getDotStarStrandOrder',['../classws__pixels.html#a7b7aefe5c8b65143c0d0a934b313c654',1,'ws_pixels']]], ['getdriverid',['getDriverID',['../classws__uart__drv.html#a2681c521f0960c8808f276ac4a093cec',1,'ws_uart_drv']]], ['geteventaltitude',['getEventAltitude',['../class_wipper_snapper___i2_c___driver.html#a9a4596c2fe21aff2da04923f56b7f5a5',1,'WipperSnapper_I2C_Driver::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#aa69f5a0b330f75479b5090eaeb7719f4',1,'WipperSnapper_I2C_Driver_BME280::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a88d91797e9b9bc81554417c212df5333',1,'WipperSnapper_I2C_Driver_BME680::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a27972b7a9fe7e2dd6eba85dd3a2ab4a5',1,'WipperSnapper_I2C_Driver_BMP280::getEventAltitude()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#ad18c0614a1164050bee69b18b72349f0',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAltitude()']]], - ['geteventambienttemp',['getEventAmbientTemp',['../class_wipper_snapper___i2_c___driver.html#a13de4eca74a2d66e9e6bb2205cc9f390',1,'WipperSnapper_I2C_Driver::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#a242afcf8828bc32e59a17ed749caff89',1,'WipperSnapper_I2C_Driver_ADT7410::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#ab266e45a7ba0024874319f38a42256f3',1,'WipperSnapper_I2C_Driver_AHTX0::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a1f2dbf2e71b3dd54e1e2a7328b936550',1,'WipperSnapper_I2C_Driver_BME280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acb4c85fc99496242a6a18dbc03d95b7c',1,'WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a2ac9fd849bf26a7f7b59ced85f71cec6',1,'WipperSnapper_I2C_Driver_BMP280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#aa0fc4c9f9a32641b37bf90b9407a3acc',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a646e10f3df16756573bcdad0fa72d13a',1,'WipperSnapper_I2C_Driver_DPS310::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#ab5031cb684c03e853e0c7ea4156d8783',1,'WipperSnapper_I2C_Driver_DS2484::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a8d730c98b6394f5b02bc6c57efc848d7',1,'WipperSnapper_I2C_Driver_HDC302X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#adb6e95f68668bd959653953f10b3b42d',1,'WipperSnapper_I2C_Driver_HTS221::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a69013d12c2ac3a29f57d1cd16b55cf35',1,'WipperSnapper_I2C_Driver_HTU21D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#a8837b571afcf7eb12adadc063ba453a8',1,'WipperSnapper_I2C_Driver_HTU31D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a289c035a620efd9faf0ea29486b68bec',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#ada1b31c034da98c2d057049ef52ea71c',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a4be7ae5ba414f459289d93084895250a',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ad2faf1c27d8373e0e268c663fb2eb579',1,'WipperSnapper_I2C_Driver_MCP9808::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aaa2d39c025e0ac4ffc166bc251fddc1c',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#a20f17ca276212bcfb9fad72a22518600',1,'WipperSnapper_I2C_Driver_MS8607::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a4dc74371645120b6b62a5b2c0f557751',1,'WipperSnapper_I2C_Driver_PCT2075::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a2a9dc8d88af0d319096c83fa39f30fd8',1,'WipperSnapper_I2C_Driver_SCD30::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a0080a44575de0f6722fba8b96aff18f0',1,'WipperSnapper_I2C_Driver_SCD4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af9bb46a3a495fc8d6d1f8ee890aa4da4',1,'WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a2dedd64cbf092a450224e9efbc606313',1,'WipperSnapper_I2C_Driver_SHT3X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#ac771a5542527ea1fc95c26af827fb952',1,'WipperSnapper_I2C_Driver_SHT4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a43d09895398b559dc3b5b3ebf58788a6',1,'WipperSnapper_I2C_Driver_SHTC3::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#af99e7ab7b7f901d5c1ccb0c476067361',1,'WipperSnapper_I2C_Driver_SI7021::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#aab2ccd5c99dc8c33547102b902aa4da4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#adcb007ae25ecffbf4a3f429ded9d861f',1,'WipperSnapper_I2C_Driver_TMP117::getEventAmbientTemp()']]], + ['geteventambienttemp',['getEventAmbientTemp',['../class_wipper_snapper___i2_c___driver.html#a13de4eca74a2d66e9e6bb2205cc9f390',1,'WipperSnapper_I2C_Driver::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_d_t7410.html#a242afcf8828bc32e59a17ed749caff89',1,'WipperSnapper_I2C_Driver_ADT7410::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#ab266e45a7ba0024874319f38a42256f3',1,'WipperSnapper_I2C_Driver_AHTX0::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a1f2dbf2e71b3dd54e1e2a7328b936550',1,'WipperSnapper_I2C_Driver_BME280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acb4c85fc99496242a6a18dbc03d95b7c',1,'WipperSnapper_I2C_Driver_BME680::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a2ac9fd849bf26a7f7b59ced85f71cec6',1,'WipperSnapper_I2C_Driver_BMP280::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#aa0fc4c9f9a32641b37bf90b9407a3acc',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#a646e10f3df16756573bcdad0fa72d13a',1,'WipperSnapper_I2C_Driver_DPS310::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___d_s2484.html#ab5031cb684c03e853e0c7ea4156d8783',1,'WipperSnapper_I2C_Driver_DS2484::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a8d730c98b6394f5b02bc6c57efc848d7',1,'WipperSnapper_I2C_Driver_HDC302X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#adb6e95f68668bd959653953f10b3b42d',1,'WipperSnapper_I2C_Driver_HTS221::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a69013d12c2ac3a29f57d1cd16b55cf35',1,'WipperSnapper_I2C_Driver_HTU21D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#a8837b571afcf7eb12adadc063ba453a8',1,'WipperSnapper_I2C_Driver_HTU31D::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a289c035a620efd9faf0ea29486b68bec',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#ada1b31c034da98c2d057049ef52ea71c',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a4be7ae5ba414f459289d93084895250a',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_c_p9808.html#ad2faf1c27d8373e0e268c663fb2eb579',1,'WipperSnapper_I2C_Driver_MCP9808::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#aaa2d39c025e0ac4ffc166bc251fddc1c',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#a20f17ca276212bcfb9fad72a22518600',1,'WipperSnapper_I2C_Driver_MS8607::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a4dc74371645120b6b62a5b2c0f557751',1,'WipperSnapper_I2C_Driver_PCT2075::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a2a9dc8d88af0d319096c83fa39f30fd8',1,'WipperSnapper_I2C_Driver_SCD30::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a0080a44575de0f6722fba8b96aff18f0',1,'WipperSnapper_I2C_Driver_SCD4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#af9bb46a3a495fc8d6d1f8ee890aa4da4',1,'WipperSnapper_I2C_Driver_SEN5X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a0de4e3490e60c4ddbcf7cd79dc1265c5',1,'WipperSnapper_I2C_Driver_SEN6X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#a2dedd64cbf092a450224e9efbc606313',1,'WipperSnapper_I2C_Driver_SHT3X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#ac771a5542527ea1fc95c26af827fb952',1,'WipperSnapper_I2C_Driver_SHT4X::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a43d09895398b559dc3b5b3ebf58788a6',1,'WipperSnapper_I2C_Driver_SHTC3::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#af99e7ab7b7f901d5c1ccb0c476067361',1,'WipperSnapper_I2C_Driver_SI7021::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#aab2ccd5c99dc8c33547102b902aa4da4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventAmbientTemp()'],['../class_wipper_snapper___i2_c___driver___t_m_p117.html#adcb007ae25ecffbf4a3f429ded9d861f',1,'WipperSnapper_I2C_Driver_TMP117::getEventAmbientTemp()']]], ['geteventambienttempf',['getEventAmbientTempF',['../class_wipper_snapper___i2_c___driver.html#aa621cddfaddfe59c09836852f52a6ee9',1,'WipperSnapper_I2C_Driver']]], - ['geteventco2',['getEventCO2',['../class_wipper_snapper___i2_c___driver.html#a7575cd2c725d2cb6d5ac683bbc7b8cda',1,'WipperSnapper_I2C_Driver::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a0d0b0d1bfdfc533785270c617392cd2b',1,'WipperSnapper_I2C_Driver_SCD30::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4d0901b433474c60198e697f328ea0be',1,'WipperSnapper_I2C_Driver_SCD4X::getEventCO2()']]], + ['geteventco2',['getEventCO2',['../class_wipper_snapper___i2_c___driver.html#a7575cd2c725d2cb6d5ac683bbc7b8cda',1,'WipperSnapper_I2C_Driver::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#a0d0b0d1bfdfc533785270c617392cd2b',1,'WipperSnapper_I2C_Driver_SCD30::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4d0901b433474c60198e697f328ea0be',1,'WipperSnapper_I2C_Driver_SCD4X::getEventCO2()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a5e1debd9d34ba9ef6bfddb6180e05139',1,'WipperSnapper_I2C_Driver_SEN6X::getEventCO2()']]], ['geteventcurrent',['getEventCurrent',['../class_wipper_snapper___i2_c___driver.html#a1b1079053c8d8a9117887e9997e2fe0c',1,'WipperSnapper_I2C_Driver::getEventCurrent()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#ab990acd471dfc4b7d1eb13b611a4cb27',1,'WipperSnapper_I2C_Driver_INA219::getEventCurrent()']]], ['geteventeco2',['getEventECO2',['../class_wipper_snapper___i2_c___driver.html#a34f86a1d55cb236b4f509196451f3dff',1,'WipperSnapper_I2C_Driver::getEventECO2()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#a1479ca40bba3b47a20429b2b92ba9490',1,'WipperSnapper_I2C_Driver_ENS160::getEventECO2()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#aac34ebb703e7863bfeebfa5d3cfe31e7',1,'WipperSnapper_I2C_Driver_SGP30::getEventECO2()']]], ['geteventgasresistance',['getEventGasResistance',['../class_wipper_snapper___i2_c___driver.html#a5a9d3e73c2453ba1c25c44162f0aba28',1,'WipperSnapper_I2C_Driver::getEventGasResistance()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a307ea831e8cd27c9636a952f6dacc67b',1,'WipperSnapper_I2C_Driver_BME680::getEventGasResistance()']]], - ['geteventlight',['getEventLight',['../class_wipper_snapper___i2_c___driver.html#ae063acb623d277fab67e2a0efb8bb5ca',1,'WipperSnapper_I2C_Driver::getEventLight()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#ad5f06e9d1b78a1607598747151695564',1,'WipperSnapper_I2C_Driver_BH1750::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a5acce7e34dad300a23d4b3d92e7cbcb0',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#ac6199e7c82e98c9ec7d2be0ba61c0e43',1,'WipperSnapper_I2C_Driver_LTR390::getEventLight()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#ab4330f001ca8576190cfd1b862153d40',1,'WipperSnapper_I2C_Driver_TSL2591::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a841c18d25441ba48eb75f355b7de4d47',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f2e168de21efe4c9ab5f9e80f3e0f9a',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a822d7f5571b361c9ff2e078a093b4865',1,'WipperSnapper_I2C_Driver_VEML7700::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a955b0a138358c5928946477a5bca54fa',1,'WipperSnapper_I2C_Driver_VL6180X::getEventLight()']]], - ['geteventnoxindex',['getEventNOxIndex',['../class_wipper_snapper___i2_c___driver.html#ab87a78eea2ae6e2b629dcaf5fdaafad4',1,'WipperSnapper_I2C_Driver::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#adbafae4e35defc5595a4a64a62cae9a8',1,'WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex()']]], + ['geteventlight',['getEventLight',['../class_wipper_snapper___i2_c___driver.html#ae063acb623d277fab67e2a0efb8bb5ca',1,'WipperSnapper_I2C_Driver::getEventLight()'],['../class_wipper_snapper___i2_c___driver___b_h1750.html#ad5f06e9d1b78a1607598747151695564',1,'WipperSnapper_I2C_Driver_BH1750::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a5acce7e34dad300a23d4b3d92e7cbcb0',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventLight()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#ac6199e7c82e98c9ec7d2be0ba61c0e43',1,'WipperSnapper_I2C_Driver_LTR390::getEventLight()'],['../class_wipper_snapper___i2_c___driver___t_s_l2591.html#ab4330f001ca8576190cfd1b862153d40',1,'WipperSnapper_I2C_Driver_TSL2591::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a841c18d25441ba48eb75f355b7de4d47',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a8f2e168de21efe4c9ab5f9e80f3e0f9a',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#abf9139a9eef75a6cb5da77eef03f3c63',1,'WipperSnapper_I2C_Driver_VCNL4200::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a822d7f5571b361c9ff2e078a093b4865',1,'WipperSnapper_I2C_Driver_VEML7700::getEventLight()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a955b0a138358c5928946477a5bca54fa',1,'WipperSnapper_I2C_Driver_VL6180X::getEventLight()']]], + ['geteventnoxindex',['getEventNOxIndex',['../class_wipper_snapper___i2_c___driver.html#ab87a78eea2ae6e2b629dcaf5fdaafad4',1,'WipperSnapper_I2C_Driver::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#adbafae4e35defc5595a4a64a62cae9a8',1,'WipperSnapper_I2C_Driver_SEN5X::getEventNOxIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a43b2dabb22d67616c078a47c805f7846',1,'WipperSnapper_I2C_Driver_SEN6X::getEventNOxIndex()']]], ['geteventobjecttemp',['getEventObjectTemp',['../class_wipper_snapper___i2_c___driver.html#ae13af4c9959dc822e9b1c62d772e0c40',1,'WipperSnapper_I2C_Driver']]], ['geteventobjecttempf',['getEventObjectTempF',['../class_wipper_snapper___i2_c___driver.html#a92ab748eac0e11445c5474fc03d1e267',1,'WipperSnapper_I2C_Driver']]], - ['geteventpm100_5fstd',['getEventPM100_STD',['../class_wipper_snapper___i2_c___driver.html#a1a12b2c78ed99e67bbe206d54cc4b50a',1,'WipperSnapper_I2C_Driver::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#a59d595e14906759668fefd153297de91',1,'WipperSnapper_I2C_Driver_PM25::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a57d08123f0685274aab3919ed9af477f',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD()']]], - ['geteventpm10_5fstd',['getEventPM10_STD',['../class_wipper_snapper___i2_c___driver.html#af30bc9ae36c032ee6c8ddd5d5e3a8ffe',1,'WipperSnapper_I2C_Driver::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ac3c167f2bbaadc2d3bc15ef82c755484',1,'WipperSnapper_I2C_Driver_PM25::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ad446fcce51f32eada38a297a09a9ab27',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD()']]], - ['geteventpm25_5fstd',['getEventPM25_STD',['../class_wipper_snapper___i2_c___driver.html#ad2bad6c048564c3472427f1a661873fb',1,'WipperSnapper_I2C_Driver::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#adbe144cd72ecd1d9ef0cab6ac157b7b1',1,'WipperSnapper_I2C_Driver_PM25::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a8c0bc026367aba1a63fa389a20305c1c',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD()']]], - ['geteventpm40_5fstd',['getEventPM40_STD',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a4a25a13645b2d8cbf6dc3157b1f96232',1,'WipperSnapper_I2C_Driver_SEN5X']]], + ['geteventpm100_5fstd',['getEventPM100_STD',['../class_wipper_snapper___i2_c___driver.html#a1a12b2c78ed99e67bbe206d54cc4b50a',1,'WipperSnapper_I2C_Driver::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#a59d595e14906759668fefd153297de91',1,'WipperSnapper_I2C_Driver_PM25::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a57d08123f0685274aab3919ed9af477f',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM100_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a02b1cd26b0e13734eec2613eed6d1fce',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM100_STD()']]], + ['geteventpm10_5fstd',['getEventPM10_STD',['../class_wipper_snapper___i2_c___driver.html#af30bc9ae36c032ee6c8ddd5d5e3a8ffe',1,'WipperSnapper_I2C_Driver::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#ac3c167f2bbaadc2d3bc15ef82c755484',1,'WipperSnapper_I2C_Driver_PM25::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ad446fcce51f32eada38a297a09a9ab27',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM10_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#ad7bc82d8a4314697ef8dca793d9c8d60',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM10_STD()']]], + ['geteventpm25_5fstd',['getEventPM25_STD',['../class_wipper_snapper___i2_c___driver.html#ad2bad6c048564c3472427f1a661873fb',1,'WipperSnapper_I2C_Driver::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___p_m25.html#adbe144cd72ecd1d9ef0cab6ac157b7b1',1,'WipperSnapper_I2C_Driver_PM25::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a8c0bc026367aba1a63fa389a20305c1c',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM25_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a9521500d720664e7bde4a01c4ce83a62',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM25_STD()']]], + ['geteventpm40_5fstd',['getEventPM40_STD',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a4a25a13645b2d8cbf6dc3157b1f96232',1,'WipperSnapper_I2C_Driver_SEN5X::getEventPM40_STD()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a76f040ef62489c503e978e7305a7b7da',1,'WipperSnapper_I2C_Driver_SEN6X::getEventPM40_STD()']]], ['geteventpressure',['getEventPressure',['../class_wipper_snapper___i2_c___driver.html#a7a2da3fae0d97872416c24066720276d',1,'WipperSnapper_I2C_Driver::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#a58e26c19effac4be6d41c199f154b0b8',1,'WipperSnapper_I2C_Driver_BME280::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#a3873bb989e53c57a5b354b0d30402793',1,'WipperSnapper_I2C_Driver_BME680::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_p280.html#a03a626388a9f6f98a671bb55b259a758',1,'WipperSnapper_I2C_Driver_BMP280::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___b_m_p3_x_x.html#a77ce4d038c17debc63569d0ea143bc3e',1,'WipperSnapper_I2C_Driver_BMP3XX::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___d_p_s310.html#ae289e008f8c00825470d8612923e382f',1,'WipperSnapper_I2C_Driver_DPS310::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a085af6656ab51694dd3901eb5457d8e8',1,'WipperSnapper_I2C_Driver_LPS22HB::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a4946bebb8da0ce832f307ddfa47d2ab5',1,'WipperSnapper_I2C_Driver_LPS25HB::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___l_p_s3_x_h_w.html#a11725eb31309bc542753310f5de135e8',1,'WipperSnapper_I2C_Driver_LPS3XHW::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#acd19f50e18038b53ea8450b1a34a10cf',1,'WipperSnapper_I2C_Driver_MPL115A2::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#ab0037bcf69b527203445be8938705690',1,'WipperSnapper_I2C_Driver_MPRLS::getEventPressure()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad3792eb918e3cbfc3e1d760e216bdb9e',1,'WipperSnapper_I2C_Driver_MS8607::getEventPressure()']]], - ['geteventproximity',['getEventProximity',['../class_wipper_snapper___i2_c___driver.html#a7d9543490469c686a840c98dae35d79f',1,'WipperSnapper_I2C_Driver::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#ad513c054e926a08d4c475dd3081c7412',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2a78442326ef7f1eaa3f7cd84bc05bf9',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#aac68ee5e75ac9cded200f85942583957',1,'WipperSnapper_I2C_Driver_VL53L0X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#aeb6e89f863f10a0a1523ca2b5f42be1a',1,'WipperSnapper_I2C_Driver_VL53L1X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a7bc926f9b54b1624077b8d4dcadeab9e',1,'WipperSnapper_I2C_Driver_VL53L4CD::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a3b651566d61dc4b7a02af5bfee9ae4d7',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a55fa805c11f434f0838840f3154a108b',1,'WipperSnapper_I2C_Driver_VL6180X::getEventProximity()']]], + ['geteventproximity',['getEventProximity',['../class_wipper_snapper___i2_c___driver.html#a7d9543490469c686a840c98dae35d79f',1,'WipperSnapper_I2C_Driver::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#ad513c054e926a08d4c475dd3081c7412',1,'WipperSnapper_I2C_Driver_VCNL4020::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#a2a78442326ef7f1eaa3f7cd84bc05bf9',1,'WipperSnapper_I2C_Driver_VCNL4040::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a17331fc166fd01bc44a0534c8612a598',1,'WipperSnapper_I2C_Driver_VCNL4200::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#aac68ee5e75ac9cded200f85942583957',1,'WipperSnapper_I2C_Driver_VL53L0X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#aeb6e89f863f10a0a1523ca2b5f42be1a',1,'WipperSnapper_I2C_Driver_VL53L1X::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_d.html#a7bc926f9b54b1624077b8d4dcadeab9e',1,'WipperSnapper_I2C_Driver_VL53L4CD::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a3b651566d61dc4b7a02af5bfee9ae4d7',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventProximity()'],['../class_wipper_snapper___i2_c___driver___v_l6180_x.html#a55fa805c11f434f0838840f3154a108b',1,'WipperSnapper_I2C_Driver_VL6180X::getEventProximity()']]], ['geteventraw',['getEventRaw',['../class_wipper_snapper___i2_c___driver.html#a82b80136f66f6f45b6d590bb694d670a',1,'WipperSnapper_I2C_Driver::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#ad76418f2a2680ae3691e292646fcd47a',1,'WipperSnapper_I2C_Driver_ENS160::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___l_t_r329___l_t_r303.html#a7fca25ea7312dd13ab433e2d53eb4214',1,'WipperSnapper_I2C_Driver_LTR329_LTR303::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___l_t_r390.html#a332c17b172ccaca4047c12604c7c01ea',1,'WipperSnapper_I2C_Driver_LTR390::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___m_c_p3421.html#a395cee03ac616bab232b1bfca1de860e',1,'WipperSnapper_I2C_Driver_MCP3421::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___n_a_u7802.html#a528b16bfc54ad27d4f2eed915e5f39bc',1,'WipperSnapper_I2C_Driver_NAU7802::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a0c4d07b6f93ba859c79bdf18c55f81a9',1,'WipperSnapper_I2C_Driver_SGP40::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#af671c08963756f710ccecca6c82520d4',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor::getEventRaw()'],['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a945f8c9276b5dc6dedca6c71a1f5abd9',1,'WipperSnapper_I2C_Driver_VL53L4CX::getEventRaw()']]], - ['geteventrelativehumidity',['getEventRelativeHumidity',['../class_wipper_snapper___i2_c___driver.html#a64254b7895801dc14e8d792e7d997f0f',1,'WipperSnapper_I2C_Driver::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#a829041ed0eaaac49819872de32640f66',1,'WipperSnapper_I2C_Driver_AHTX0::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#ae865c5c2bc7aaa759ceacb56f93c6997',1,'WipperSnapper_I2C_Driver_BME280::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acfda397c53ccc1e21123f6d41c1b859d',1,'WipperSnapper_I2C_Driver_BME680::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aaa8e692371176c22572fcbd95081d937',1,'WipperSnapper_I2C_Driver_HDC302X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#ab96618bd164218991a1b80e9bf9fbb8d',1,'WipperSnapper_I2C_Driver_HTS221::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a44d4e7365069bad3a046bb7e757c7a36',1,'WipperSnapper_I2C_Driver_HTU21D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#acb2fe3f0ebd8dd24a2e39c56db82618e',1,'WipperSnapper_I2C_Driver_HTU31D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad97c0a522f75b201b1ff45adc3d03b18',1,'WipperSnapper_I2C_Driver_MS8607::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad591fdc0ecfa2697177a0a86db68884f',1,'WipperSnapper_I2C_Driver_SCD30::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4f8f51b9ba4fc6dd763cc07d6d4024fa',1,'WipperSnapper_I2C_Driver_SCD4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a585d0f06fd9f353c075d0ebd9572c952',1,'WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#aa7124e2bf4e83b6b24a9df60966d8d98',1,'WipperSnapper_I2C_Driver_SHT3X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#afc01d4300e4226a06b8a3a3f5f34e10c',1,'WipperSnapper_I2C_Driver_SHT4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a8863db8c2476797c5b648f8fc65b86bc',1,'WipperSnapper_I2C_Driver_SHTC3::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#aafa45f134fe4de304bcab741c3ab765b',1,'WipperSnapper_I2C_Driver_SI7021::getEventRelativeHumidity()']]], + ['geteventrelativehumidity',['getEventRelativeHumidity',['../class_wipper_snapper___i2_c___driver.html#a64254b7895801dc14e8d792e7d997f0f',1,'WipperSnapper_I2C_Driver::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___a_h_t_x0.html#a829041ed0eaaac49819872de32640f66',1,'WipperSnapper_I2C_Driver_AHTX0::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e280.html#ae865c5c2bc7aaa759ceacb56f93c6997',1,'WipperSnapper_I2C_Driver_BME280::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___b_m_e680.html#acfda397c53ccc1e21123f6d41c1b859d',1,'WipperSnapper_I2C_Driver_BME680::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#aaa8e692371176c22572fcbd95081d937',1,'WipperSnapper_I2C_Driver_HDC302X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_s221.html#ab96618bd164218991a1b80e9bf9fbb8d',1,'WipperSnapper_I2C_Driver_HTS221::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u21_d.html#a44d4e7365069bad3a046bb7e757c7a36',1,'WipperSnapper_I2C_Driver_HTU21D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___h_t_u31_d.html#acb2fe3f0ebd8dd24a2e39c56db82618e',1,'WipperSnapper_I2C_Driver_HTU31D::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___m_s8607.html#ad97c0a522f75b201b1ff45adc3d03b18',1,'WipperSnapper_I2C_Driver_MS8607::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d30.html#ad591fdc0ecfa2697177a0a86db68884f',1,'WipperSnapper_I2C_Driver_SCD30::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a4f8f51b9ba4fc6dd763cc07d6d4024fa',1,'WipperSnapper_I2C_Driver_SCD4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a585d0f06fd9f353c075d0ebd9572c952',1,'WipperSnapper_I2C_Driver_SEN5X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a344ad167dffe959697b3c4db4ea4a07e',1,'WipperSnapper_I2C_Driver_SEN6X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t3_x.html#aa7124e2bf4e83b6b24a9df60966d8d98',1,'WipperSnapper_I2C_Driver_SHT3X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#afc01d4300e4226a06b8a3a3f5f34e10c',1,'WipperSnapper_I2C_Driver_SHT4X::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#a8863db8c2476797c5b648f8fc65b86bc',1,'WipperSnapper_I2C_Driver_SHTC3::getEventRelativeHumidity()'],['../class_wipper_snapper___i2_c___driver___s_i7021.html#aafa45f134fe4de304bcab741c3ab765b',1,'WipperSnapper_I2C_Driver_SI7021::getEventRelativeHumidity()']]], ['geteventtvoc',['getEventTVOC',['../class_wipper_snapper___i2_c___driver.html#a22a56a7ce38b3a84116dc96524f66cd6',1,'WipperSnapper_I2C_Driver::getEventTVOC()'],['../class_wipper_snapper___i2_c___driver___e_n_s160.html#ac33016fa8bac05e7784a2644c35bdc47',1,'WipperSnapper_I2C_Driver_ENS160::getEventTVOC()'],['../class_wipper_snapper___i2_c___driver___s_g_p30.html#add2d23e549c6b6f2b0a00fb7bcd79486',1,'WipperSnapper_I2C_Driver_SGP30::getEventTVOC()']]], ['geteventunitlesspercent',['getEventUnitlessPercent',['../class_wipper_snapper___i2_c___driver.html#ae50567a51f9a6602261aeec7670998a2',1,'WipperSnapper_I2C_Driver::getEventUnitlessPercent()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a7a5933073e01626be9ff7403025c4d61',1,'WipperSnapper_I2C_Driver_LC709203F::getEventUnitlessPercent()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#a9e7956e6af41e41eefe4d1908ca86010',1,'WipperSnapper_I2C_Driver_MAX17048::getEventUnitlessPercent()']]], - ['geteventvocindex',['getEventVOCIndex',['../class_wipper_snapper___i2_c___driver.html#a782655a0ff3100814b6ca523bd38eb43',1,'WipperSnapper_I2C_Driver::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a5faaf81d2470592827b665e67b08d867',1,'WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a6b086be397885bd6d6d6faeecfa88d67',1,'WipperSnapper_I2C_Driver_SGP40::getEventVOCIndex()']]], + ['geteventvocindex',['getEventVOCIndex',['../class_wipper_snapper___i2_c___driver.html#a782655a0ff3100814b6ca523bd38eb43',1,'WipperSnapper_I2C_Driver::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#a5faaf81d2470592827b665e67b08d867',1,'WipperSnapper_I2C_Driver_SEN5X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#aa20985c869910356e356cc14fabdd968',1,'WipperSnapper_I2C_Driver_SEN6X::getEventVOCIndex()'],['../class_wipper_snapper___i2_c___driver___s_g_p40.html#a6b086be397885bd6d6d6faeecfa88d67',1,'WipperSnapper_I2C_Driver_SGP40::getEventVOCIndex()']]], ['geteventvoltage',['getEventVoltage',['../class_wipper_snapper___i2_c___driver.html#aa8eb929642f1f8506909311d07fd8674',1,'WipperSnapper_I2C_Driver::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___i_n_a219.html#a6d3bfb0523bbb623ad16196882770cce',1,'WipperSnapper_I2C_Driver_INA219::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a24c5897fc9eaeb2940a3d21efd421b69',1,'WipperSnapper_I2C_Driver_LC709203F::getEventVoltage()'],['../class_wipper_snapper___i2_c___driver___m_a_x17048.html#af0a6530168a29b47931d42447b589074',1,'WipperSnapper_I2C_Driver_MAX17048::getEventVoltage()']]], ['getgammacorrectedcolor',['getGammaCorrectedColor',['../classws__pixels.html#aafb5c100fbaaafdfd0d312968fac1a95',1,'ws_pixels']]], ['geti2caddress',['getI2CAddress',['../class_wipper_snapper___i2_c___driver.html#aef9934f4bbcf8faee9a9ce4371ae5988',1,'WipperSnapper_I2C_Driver']]], ['getloadingstate',['getLoadingState',['../classws__display__ui__helper.html#aebb5690c8b1c6a0e120bf8962e469d68',1,'ws_display_ui_helper']]], - ['getmacaddr',['getMacAddr',['../class_wippersnapper___a_i_r_l_i_f_t.html#ab8967a619a24f16975b98069a052317e',1,'Wippersnapper_AIRLIFT::getMacAddr()'],['../class_wippersnapper___e_s_p32.html#ab57f54dbcff0e24dbf9263100b887070',1,'Wippersnapper_ESP32::getMacAddr()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a2d4be62781db359524c53d3d696695f2',1,'Wippersnapper_WIFININA::getMacAddr()'],['../class_wippersnapper.html#a1034172df196bc9db1f5e390c785c0f8',1,'Wippersnapper::getMacAddr()']]], + ['getmacaddr',['getMacAddr',['../class_wippersnapper___a_i_r_l_i_f_t.html#ab8967a619a24f16975b98069a052317e',1,'Wippersnapper_AIRLIFT::getMacAddr()'],['../class_wippersnapper___e_s_p32.html#ab57f54dbcff0e24dbf9263100b887070',1,'Wippersnapper_ESP32::getMacAddr()'],['../class_wippersnapper.html#a1034172df196bc9db1f5e390c785c0f8',1,'Wippersnapper::getMacAddr()']]], ['getnativeresolution',['getNativeResolution',['../class_wippersnapper___analog_i_o.html#a79251a27be95ce1ba49fa8421f5c14cf',1,'Wippersnapper_AnalogIO']]], ['getneopixelstrandorder',['getNeoPixelStrandOrder',['../classws__pixels.html#afdadef5a9176a7bbfc826c4882665205',1,'ws_pixels']]], ['getpinvalue',['getPinValue',['../class_wippersnapper___analog_i_o.html#ab915060e10cc7808d27e3a983d62b027',1,'Wippersnapper_AnalogIO']]], ['getpinvaluevolts',['getPinValueVolts',['../class_wippersnapper___analog_i_o.html#a06a1f019ab0b2dac68e46c6a5901abb0',1,'Wippersnapper_AnalogIO']]], ['getproximity',['getProximity',['../class_wipper_snapper___i2_c___driver___v_l53_l4_c_x.html#a8371d695526d04e136fe617d1ec4da49',1,'WipperSnapper_I2C_Driver_VL53L4CX']]], - ['getrssi',['getRSSI',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5a8ac4e59e125a2c3d13d8bed12efa9f',1,'Wippersnapper_AIRLIFT::getRSSI()'],['../class_wippersnapper___e_s_p32.html#ae2c425e0feaf49bf794eac887f95a4cb',1,'Wippersnapper_ESP32::getRSSI()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ae09df9ca5a275779929b76bc8d286de7',1,'Wippersnapper_WIFININA::getRSSI()'],['../class_wippersnapper.html#a260a0747d76d6cdcf6be849805c27a17',1,'Wippersnapper::getRSSI()']]], + ['getrssi',['getRSSI',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5a8ac4e59e125a2c3d13d8bed12efa9f',1,'Wippersnapper_AIRLIFT::getRSSI()'],['../class_wippersnapper___e_s_p32.html#ae2c425e0feaf49bf794eac887f95a4cb',1,'Wippersnapper_ESP32::getRSSI()'],['../class_wippersnapper.html#a260a0747d76d6cdcf6be849805c27a17',1,'Wippersnapper::getRSSI()']]], ['getsensoraltitudeperiod',['getSensorAltitudePeriod',['../class_wipper_snapper___i2_c___driver.html#a455cfe493e63106ae2e7d663c4c74dee',1,'WipperSnapper_I2C_Driver']]], ['getsensoraltitudeperiodprv',['getSensorAltitudePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a46fb934d4cf578a4743a7cee2060fddb',1,'WipperSnapper_I2C_Driver']]], ['getsensorambienttempfperiod',['getSensorAmbientTempFPeriod',['../class_wipper_snapper___i2_c___driver.html#ac8e7cf9347d0acb91bf79e28c33f03d0',1,'WipperSnapper_I2C_Driver']]], diff --git a/html/search/functions_8.js b/html/search/functions_8.js index 765232b98..57ba8e72c 100644 --- a/html/search/functions_8.js +++ b/html/search/functions_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['halterror',['haltError',['../class_wippersnapper.html#ad1ea32dd9cbe0b9e0c05ad1ad1dc4835',1,'Wippersnapper']]] + ['halterror',['haltError',['../class_wippersnapper.html#aa46f91b35371db5169facea47456854d',1,'Wippersnapper']]] ]; diff --git a/html/search/functions_b.js b/html/search/functions_b.js index 69cff3e88..6715869c9 100644 --- a/html/search/functions_b.js +++ b/html/search/functions_b.js @@ -1,5 +1,5 @@ var searchData= [ - ['networkstatus',['networkStatus',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac238fc561ddcd654a47b474f74ec37fb',1,'Wippersnapper_AIRLIFT::networkStatus()'],['../class_wippersnapper___e_s_p32.html#aa8d043c0f7516489964bd4eeb465bb6d',1,'Wippersnapper_ESP32::networkStatus()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aa33a4dfb0f3d2857deafdd4847baa07c',1,'Wippersnapper_WIFININA::networkStatus()'],['../class_wippersnapper.html#acc057cbc63fec2d0da8ac529aa202e4c',1,'Wippersnapper::networkStatus()']]], + ['networkstatus',['networkStatus',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac238fc561ddcd654a47b474f74ec37fb',1,'Wippersnapper_AIRLIFT::networkStatus()'],['../class_wippersnapper___e_s_p32.html#aa8d043c0f7516489964bd4eeb465bb6d',1,'Wippersnapper_ESP32::networkStatus()'],['../class_wippersnapper.html#acc057cbc63fec2d0da8ac529aa202e4c',1,'Wippersnapper::networkStatus()']]], ['notone',['noTone',['../classws__pwm.html#a41810aaf962463a9b2301f252cc45d01',1,'ws_pwm']]] ]; diff --git a/html/search/functions_e.js b/html/search/functions_e.js index 8d7d22524..d9faecc74 100644 --- a/html/search/functions_e.js +++ b/html/search/functions_e.js @@ -14,9 +14,9 @@ var searchData= ['set_5flabel_5fstatus',['set_label_status',['../classws__display__ui__helper.html#af65c0213180b7371ab4c1022b46e08f4',1,'ws_display_ui_helper']]], ['set_5fload_5fbar_5ficon_5fcomplete',['set_load_bar_icon_complete',['../classws__display__ui__helper.html#aa37063cd4c304113e7f128daa5adbc51',1,'ws_display_ui_helper']]], ['set_5fmqtt_5fclient',['set_mqtt_client',['../classws__uart__drv.html#af6b65c78ca79a65654612ab6320fcdfa',1,'ws_uart_drv']]], - ['set_5fssid_5fpass',['set_ssid_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5d98c8d0158c551f78c242ed57e42165',1,'Wippersnapper_AIRLIFT::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___a_i_r_l_i_f_t.html#a9e842381c45f33016ab030a875b25a76',1,'Wippersnapper_AIRLIFT::set_ssid_pass()'],['../class_wippersnapper___e_s_p32.html#a6e93f243e49a45ad4a41a1e1f48a9bcf',1,'Wippersnapper_ESP32::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___e_s_p32.html#a5f079d18dd8e8bfbc452c6574f38df23',1,'Wippersnapper_ESP32::set_ssid_pass()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a12f2c625c55546f1cc318ed352db7be4',1,'Wippersnapper_WIFININA::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a58891176b851ade0d5c563c609cbee59',1,'Wippersnapper_WIFININA::set_ssid_pass()'],['../class_wippersnapper.html#a50aca7f9bc2ced0a2928c1f85624c9b8',1,'Wippersnapper::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper.html#aed020a82571d3b7fc1ee9038b857f9fa',1,'Wippersnapper::set_ssid_pass()']]], - ['set_5fuser_5fkey',['set_user_key',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a0861f453a20f78a3c6b8e6667c468cbe',1,'Wippersnapper_WIFININA::set_user_key()'],['../class_wippersnapper.html#ae17c82aa45ff311c9cc8a23b98acca92',1,'Wippersnapper::set_user_key()']]], - ['set_5fwifi',['set_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#aab1d7de6deaed143f3cbdaf85ec46294',1,'Wippersnapper_AIRLIFT::set_wifi()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#aeb13046386ec0dd146153fec95845eea',1,'Wippersnapper_WIFININA::set_wifi()']]], + ['set_5fssid_5fpass',['set_ssid_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a5d98c8d0158c551f78c242ed57e42165',1,'Wippersnapper_AIRLIFT::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___a_i_r_l_i_f_t.html#a9e842381c45f33016ab030a875b25a76',1,'Wippersnapper_AIRLIFT::set_ssid_pass()'],['../class_wippersnapper___e_s_p32.html#a6e93f243e49a45ad4a41a1e1f48a9bcf',1,'Wippersnapper_ESP32::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper___e_s_p32.html#a5f079d18dd8e8bfbc452c6574f38df23',1,'Wippersnapper_ESP32::set_ssid_pass()'],['../class_wippersnapper.html#a50aca7f9bc2ced0a2928c1f85624c9b8',1,'Wippersnapper::set_ssid_pass(const char *ssid, const char *ssidPassword)'],['../class_wippersnapper.html#aed020a82571d3b7fc1ee9038b857f9fa',1,'Wippersnapper::set_ssid_pass()']]], + ['set_5fuser_5fkey',['set_user_key',['../class_wippersnapper.html#ae17c82aa45ff311c9cc8a23b98acca92',1,'Wippersnapper']]], + ['set_5fwifi',['set_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#aab1d7de6deaed143f3cbdaf85ec46294',1,'Wippersnapper_AIRLIFT']]], ['setadcresolution',['setADCResolution',['../class_wippersnapper___analog_i_o.html#a883d16afad81abb3b8fe6398427580cb',1,'Wippersnapper_AnalogIO']]], ['setaref',['setAref',['../class_wippersnapper___analog_i_o.html#ae715f810b324c90bca4d4bc2dbccb408',1,'Wippersnapper_AnalogIO']]], ['setdriverid',['setDriverID',['../classws__uart__drv.html#a91fab7684041e996ef713362740c7af4',1,'ws_uart_drv']]], @@ -51,7 +51,7 @@ var searchData= ['setsensorvoltageperiodprv',['setSensorVoltagePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#abc393b0d4db17e527ea70599d2a9df05',1,'WipperSnapper_I2C_Driver']]], ['setstatusledbrightness',['setStatusLEDBrightness',['../_wippersnapper___status_l_e_d_8cpp.html#af728f778c367e553747cd874c97ebdda',1,'setStatusLEDBrightness(float brightness): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#af728f778c367e553747cd874c97ebdda',1,'setStatusLEDBrightness(float brightness): Wippersnapper_StatusLED.cpp']]], ['setstatusledcolor',['setStatusLEDColor',['../_wippersnapper___status_l_e_d_8cpp.html#ad184a104afaf5e287efca9792e8d57c1',1,'setStatusLEDColor(uint32_t color): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#a8da24cc4b6b91b784e7a35a6f4058e75',1,'setStatusLEDColor(uint32_t color, int brightness): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#ad184a104afaf5e287efca9792e8d57c1',1,'setStatusLEDColor(uint32_t color): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#a8da24cc4b6b91b784e7a35a6f4058e75',1,'setStatusLEDColor(uint32_t color, int brightness): Wippersnapper_StatusLED.cpp']]], - ['setupmqttclient',['setupMQTTClient',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac05433b076a739d94e07222d926a0045',1,'Wippersnapper_AIRLIFT::setupMQTTClient()'],['../class_wippersnapper___e_s_p32.html#a7b0795b00c8de7f3f3523a6ef567700b',1,'Wippersnapper_ESP32::setupMQTTClient()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#af93ea859ff730b169c2ff1bfec455e11',1,'Wippersnapper_WIFININA::setupMQTTClient()'],['../class_wippersnapper.html#a95627d13a469876e0aefb8a120a18732',1,'Wippersnapper::setupMQTTClient()']]], + ['setupmqttclient',['setupMQTTClient',['../class_wippersnapper___a_i_r_l_i_f_t.html#ac05433b076a739d94e07222d926a0045',1,'Wippersnapper_AIRLIFT::setupMQTTClient()'],['../class_wippersnapper___e_s_p32.html#a7b0795b00c8de7f3f3523a6ef567700b',1,'Wippersnapper_ESP32::setupMQTTClient()'],['../class_wippersnapper.html#a95627d13a469876e0aefb8a120a18732',1,'Wippersnapper::setupMQTTClient()']]], ['show_5fscr_5ferror',['show_scr_error',['../classws__display__ui__helper.html#a09e1f336b5185629240e096065352d75',1,'ws_display_ui_helper']]], ['show_5fscr_5fload',['show_scr_load',['../classws__display__ui__helper.html#a971a267aba0d230d7c9a609bd559ed13',1,'ws_display_ui_helper']]], ['statusledblink',['statusLEDBlink',['../_wippersnapper___status_l_e_d_8cpp.html#a70a14dcc6e5d76435e685c672d4280ce',1,'statusLEDBlink(ws_led_status_t statusState): Wippersnapper_StatusLED.cpp'],['../_wippersnapper___status_l_e_d_8h.html#a3953970f6d73a9d9b0e5c708e1211a8e',1,'statusLEDBlink(ws_led_status_t statusState=WS_LED_STATUS_ERROR_RUNTIME): Wippersnapper_StatusLED.cpp']]], diff --git a/html/search/functions_f.js b/html/search/functions_f.js index b703ddaed..256d0acae 100644 --- a/html/search/functions_f.js +++ b/html/search/functions_f.js @@ -1,5 +1,5 @@ var searchData= [ - ['timerexpired',['timerExpired',['../class_wippersnapper___analog_i_o.html#a7b9a2a52d3d0ffac5c8a21ef8b74e43b',1,'Wippersnapper_AnalogIO']]], + ['timerexpired',['timerExpired',['../class_wippersnapper___analog_i_o.html#aa59bc605a9a601452b708d716f43923a',1,'Wippersnapper_AnalogIO']]], ['tone',['tone',['../classws__ledc.html#ae30ec473c16e0c787f519dc0fdc81b90',1,'ws_ledc']]] ]; diff --git a/html/search/variables_0.js b/html/search/variables_0.js index 8cde2c198..60cfb3a59 100644 --- a/html/search/variables_0.js +++ b/html/search/variables_0.js @@ -74,7 +74,6 @@ var searchData= ['_5fisi2cport0init',['_isI2CPort0Init',['../class_wippersnapper.html#a6386fe27a2b8f17d6dadcd5e18ebe4f7',1,'Wippersnapper']]], ['_5fisi2cport1init',['_isI2CPort1Init',['../class_wippersnapper.html#a486962cdb0c74670b8888497695b3987',1,'Wippersnapper']]], ['_5fiswifimulti',['_isWiFiMulti',['../class_wippersnapper.html#aaae962d10a8621ea632bee4045194734',1,'Wippersnapper']]], - ['_5fkey',['_key',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#ace1daabe52f7a5f3b706fe74193d0b84',1,'Wippersnapper_WIFININA']]], ['_5flast_5fmqtt_5fconnect',['_last_mqtt_connect',['../class_wippersnapper.html#ad91ea7ed5595bd655f0a8719a7216a45',1,'Wippersnapper']]], ['_5flastread',['_lastRead',['../class_wipper_snapper___i2_c___driver___s_c_d30.html#abb830197d2c8b5be45f2bd2fc36c365b',1,'WipperSnapper_I2C_Driver_SCD30']]], ['_5flc',['_lc',['../class_wipper_snapper___i2_c___driver___l_c709203_f.html#a2f963f4bd08c6ab7132242eb239a12e1',1,'WipperSnapper_I2C_Driver_LC709203F']]], @@ -94,7 +93,7 @@ var searchData= ['_5fmpl115a2',['_mpl115a2',['../class_wipper_snapper___i2_c___driver___m_p_l115_a2.html#af6d6a1b39f29b21286f0a19d1cedeb18',1,'WipperSnapper_I2C_Driver_MPL115A2']]], ['_5fmprls',['_mprls',['../class_wipper_snapper___i2_c___driver___m_p_r_l_s.html#a122da94ed5f65ec0b0344e580e282cfb',1,'WipperSnapper_I2C_Driver_MPRLS']]], ['_5fmqtt',['_mqtt',['../class_wippersnapper.html#a4aae92d295fa7740aef1bd6e45a13349',1,'Wippersnapper']]], - ['_5fmqtt_5fclient',['_mqtt_client',['../class_wippersnapper___a_i_r_l_i_f_t.html#af56696c5a407755fb5a998747250f116',1,'Wippersnapper_AIRLIFT::_mqtt_client()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#af1e950739e88ebe968346be3a6d54c57',1,'Wippersnapper_WIFININA::_mqtt_client()']]], + ['_5fmqtt_5fclient',['_mqtt_client',['../class_wippersnapper___a_i_r_l_i_f_t.html#af56696c5a407755fb5a998747250f116',1,'Wippersnapper_AIRLIFT']]], ['_5fmqtt_5fclient_5finsecure',['_mqtt_client_insecure',['../class_wippersnapper___e_s_p32.html#aeb38f3f6b82a53c00e21851170c407b1',1,'Wippersnapper_ESP32']]], ['_5fmqtt_5fclient_5fsecure',['_mqtt_client_secure',['../class_wippersnapper___e_s_p32.html#a0c459cc04c4535a74651c4b2e8b02613',1,'Wippersnapper_ESP32']]], ['_5fms8607',['_ms8607',['../class_wipper_snapper___i2_c___driver___m_s8607.html#a55897c4491bcdebb148655e6bd492e0b',1,'WipperSnapper_I2C_Driver_MS8607']]], @@ -110,7 +109,7 @@ var searchData= ['_5fobjecttempsensorperiod',['_objectTempSensorPeriod',['../class_wipper_snapper___i2_c___driver.html#a8d7e58b7a4a7ff699704a32129f7a9c3',1,'WipperSnapper_I2C_Driver']]], ['_5fobjecttempsensorperiodprv',['_objectTempSensorPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a738f4988bef3af61be5d6c07076a8ea4',1,'WipperSnapper_I2C_Driver']]], ['_5foutgoingsignalmsg',['_outgoingSignalMsg',['../class_wippersnapper.html#a3c5eb7a0b81de9ca7472e4a37b3d27fe',1,'Wippersnapper']]], - ['_5fpass',['_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a60b11a804f697efcb2958126eb280b53',1,'Wippersnapper_AIRLIFT::_pass()'],['../class_wippersnapper___e_s_p32.html#a55257dfc5d30811ed8c9c95ae09e797f',1,'Wippersnapper_ESP32::_pass()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#addedfe0336fb0c28f0d9a781ceb51e90',1,'Wippersnapper_WIFININA::_pass()']]], + ['_5fpass',['_pass',['../class_wippersnapper___a_i_r_l_i_f_t.html#a60b11a804f697efcb2958126eb280b53',1,'Wippersnapper_AIRLIFT::_pass()'],['../class_wippersnapper___e_s_p32.html#a55257dfc5d30811ed8c9c95ae09e797f',1,'Wippersnapper_ESP32::_pass()']]], ['_5fpct2075',['_pct2075',['../class_wipper_snapper___i2_c___driver___p_c_t2075.html#a6a17137d1bbd9e9cf77b161a47e38f4e',1,'WipperSnapper_I2C_Driver_PCT2075']]], ['_5fpm100sensorperiod',['_PM100SensorPeriod',['../class_wipper_snapper___i2_c___driver.html#a6cc8417bd7488f67b40ab0cb7fa4ae2b',1,'WipperSnapper_I2C_Driver']]], ['_5fpm100sensorperiodprv',['_PM100SensorPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a24acc438f04269354675149cd192c107',1,'WipperSnapper_I2C_Driver']]], @@ -133,7 +132,7 @@ var searchData= ['_5frstpin',['_rstPin',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6c28583752d13621a35bedc67e4e4913',1,'Wippersnapper_AIRLIFT']]], ['_5fscd',['_scd',['../class_wipper_snapper___i2_c___driver___s_c_d30.html#adcefb7aac525eb79073e50392ea7fe16',1,'WipperSnapper_I2C_Driver_SCD30::_scd()'],['../class_wipper_snapper___i2_c___driver___s_c_d4_x.html#a8e49ec7f6bdf9920d1c0c04026c8639a',1,'WipperSnapper_I2C_Driver_SCD4X::_scd()']]], ['_5fseesaw',['_seesaw',['../class_wipper_snapper___i2_c___driver___s_t_e_m_m_a___soil___sensor.html#a9c970df33787ee1ecf2b54a3214d72d2',1,'WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor']]], - ['_5fsen',['_sen',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ae20509ae9eb3779f58cb848a5dc0487f',1,'WipperSnapper_I2C_Driver_SEN5X']]], + ['_5fsen',['_sen',['../class_wipper_snapper___i2_c___driver___s_e_n5_x.html#ae20509ae9eb3779f58cb848a5dc0487f',1,'WipperSnapper_I2C_Driver_SEN5X::_sen()'],['../class_wipper_snapper___i2_c___driver___s_e_n6_x.html#a4fff95dbd373356a0b0d846ddfa5e9d6',1,'WipperSnapper_I2C_Driver_SEN6X::_sen()']]], ['_5fsensoraddress',['_sensorAddress',['../class_wipper_snapper___i2_c___driver.html#a504fa3d1869f741dbb46a8e5f5f5e281',1,'WipperSnapper_I2C_Driver']]], ['_5fservocomponent',['_servoComponent',['../class_wippersnapper.html#acb20c02d9bbe7ed659a0d75de7fba140',1,'Wippersnapper']]], ['_5fsgp30',['_sgp30',['../class_wipper_snapper___i2_c___driver___s_g_p30.html#a6d59a65978abd3e6984dd25a82913740',1,'WipperSnapper_I2C_Driver_SGP30']]], @@ -142,7 +141,7 @@ var searchData= ['_5fsht4x',['_sht4x',['../class_wipper_snapper___i2_c___driver___s_h_t4_x.html#af96c1dc36d17a65fc2bc55c980afb85f',1,'WipperSnapper_I2C_Driver_SHT4X']]], ['_5fshtc3',['_shtc3',['../class_wipper_snapper___i2_c___driver___s_h_t_c3.html#aa4e217af3d48bcc008c50e51ee004c9c',1,'WipperSnapper_I2C_Driver_SHTC3']]], ['_5fsi7021',['_si7021',['../class_wipper_snapper___i2_c___driver___s_i7021.html#acd884eab3fd217ec4172e68ba53cebd4',1,'WipperSnapper_I2C_Driver_SI7021']]], - ['_5fssid',['_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6ec6435a676ba335c86f47bc373ac2e6',1,'Wippersnapper_AIRLIFT::_ssid()'],['../class_wippersnapper___e_s_p32.html#a2ada973343e53f2496910ab4069e0dba',1,'Wippersnapper_ESP32::_ssid()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a7b2129e4a4691c6b57a2a78719929cd9',1,'Wippersnapper_WIFININA::_ssid()']]], + ['_5fssid',['_ssid',['../class_wippersnapper___a_i_r_l_i_f_t.html#a6ec6435a676ba335c86f47bc373ac2e6',1,'Wippersnapper_AIRLIFT::_ssid()'],['../class_wippersnapper___e_s_p32.html#a2ada973343e53f2496910ab4069e0dba',1,'Wippersnapper_ESP32::_ssid()']]], ['_5fsspin',['_ssPin',['../class_wippersnapper___a_i_r_l_i_f_t.html#ae0fb6f803b4a9f81d9a4b15ffa46a9ee',1,'Wippersnapper_AIRLIFT']]], ['_5fstatus',['_status',['../class_wippersnapper.html#a9a1b5d8342f11f48567092a643d9cd94',1,'Wippersnapper']]], ['_5ftemp',['_temp',['../class_wipper_snapper___i2_c___driver___h_d_c302_x.html#a6f889cd621eae8dec94be48137f79611',1,'WipperSnapper_I2C_Driver_HDC302X::_temp()'],['../class_wipper_snapper___i2_c___driver___l_p_s22_h_b.html#a61ced59bf908a05b59277459589154e4',1,'WipperSnapper_I2C_Driver_LPS22HB::_temp()'],['../class_wipper_snapper___i2_c___driver___l_p_s25_h_b.html#a3850f4282d6ea200b18a92120ae102d4',1,'WipperSnapper_I2C_Driver_LPS25HB::_temp()']]], @@ -186,9 +185,9 @@ var searchData= ['_5fui_5fhelper',['_ui_helper',['../class_wippersnapper.html#ac82ed8f8ce5f18a34f696cfc385038de',1,'Wippersnapper']]], ['_5funitlesspercentperiod',['_unitlessPercentPeriod',['../class_wipper_snapper___i2_c___driver.html#ae62156acc732bcebe5652dadd87ee459',1,'WipperSnapper_I2C_Driver']]], ['_5funitlesspercentperiodprv',['_unitlessPercentPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#aba6581748d333e113d208a467edaee03',1,'WipperSnapper_I2C_Driver']]], - ['_5fusername',['_username',['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a22ef7feaaecda8b135f3cccdae583218',1,'Wippersnapper_WIFININA']]], ['_5fvcnl4020',['_vcnl4020',['../class_wipper_snapper___i2_c___driver___v_c_n_l4020.html#a6ded33fbd8b2db1a1805d878b8cceeb1',1,'WipperSnapper_I2C_Driver_VCNL4020']]], ['_5fvcnl4040',['_vcnl4040',['../class_wipper_snapper___i2_c___driver___v_c_n_l4040.html#ab0d70da76123cc6eb97d6a26fcde4724',1,'WipperSnapper_I2C_Driver_VCNL4040']]], + ['_5fvcnl4200',['_vcnl4200',['../class_wipper_snapper___i2_c___driver___v_c_n_l4200.html#a0066360d4651e405d0501f3ee5ac884a',1,'WipperSnapper_I2C_Driver_VCNL4200']]], ['_5fveml',['_veml',['../class_wipper_snapper___i2_c___driver___v_e_m_l7700.html#a9b1e691b1b4ed22c7439ae577858a93c',1,'WipperSnapper_I2C_Driver_VEML7700']]], ['_5fvl53l0x',['_vl53l0x',['../class_wipper_snapper___i2_c___driver___v_l53_l0_x.html#ad3c6acc57106862138f4974b9ad76b31',1,'WipperSnapper_I2C_Driver_VL53L0X']]], ['_5fvl53l1x',['_VL53L1X',['../class_wipper_snapper___i2_c___driver___v_l53_l1_x.html#a3dfd5af1e3e99b6bff347eeda39a0185',1,'WipperSnapper_I2C_Driver_VL53L1X']]], @@ -199,7 +198,7 @@ var searchData= ['_5fvocindexperiodprv',['_VOCIndexPeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a4cee6abb91a33770472b4db891f39b06',1,'WipperSnapper_I2C_Driver']]], ['_5fvoltageperiod',['_voltagePeriod',['../class_wipper_snapper___i2_c___driver.html#a3c0b67eb3397dd2e439cdcffc3c8db74',1,'WipperSnapper_I2C_Driver']]], ['_5fvoltageperiodprv',['_voltagePeriodPrv',['../class_wipper_snapper___i2_c___driver.html#a2b3343936adcbad3ac36827b8d6e71ab',1,'WipperSnapper_I2C_Driver']]], - ['_5fwifi',['_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#a583121d8e9177c59463b815ceac98ea6',1,'Wippersnapper_AIRLIFT::_wifi()'],['../class_wippersnapper___w_i_f_i_n_i_n_a.html#a0543a08ce2fdf662678eb69a9f6145ee',1,'Wippersnapper_WIFININA::_wifi()']]], + ['_5fwifi',['_wifi',['../class_wippersnapper___a_i_r_l_i_f_t.html#a583121d8e9177c59463b815ceac98ea6',1,'Wippersnapper_AIRLIFT']]], ['_5fwifimulti',['_wifiMulti',['../class_wippersnapper___e_s_p32.html#a3bb14b42e597e2ac2a78df5fd32ea6c4',1,'Wippersnapper_ESP32']]], ['_5fws_5fpixelscomponent',['_ws_pixelsComponent',['../class_wippersnapper.html#acba8bb65ab39d1adc9c40890dddad99f',1,'Wippersnapper']]] ]; diff --git a/html/search/variables_9.js b/html/search/variables_9.js index 957141acf..bdd4e0b19 100644 --- a/html/search/variables_9.js +++ b/html/search/variables_9.js @@ -1,7 +1,7 @@ var searchData= [ ['period',['period',['../structanalog_input_pin.html#a9c802b98c645728111732287daedea2b',1,'analogInputPin::period()'],['../structdigital_input_pin.html#a5c96669839f0ee5be8579726497240f8',1,'digitalInputPin::period()']]], - ['pin',['Pin',['../structservo__t.html#a04bcc6cf13ea5cd2c4dabdc977e054cb',1,'servo_t::Pin()'],['../structservo_component.html#a10177caa27f60f6bff9dbdad120afbc6',1,'servoComponent::pin()']]], + ['pin',['pin',['../structservo_component.html#a10177caa27f60f6bff9dbdad120afbc6',1,'servoComponent::pin()'],['../structservo__t.html#a04bcc6cf13ea5cd2c4dabdc977e054cb',1,'servo_t::Pin()']]], ['pincfgcompleted',['pinCfgCompleted',['../class_wippersnapper.html#ae625ae372c5aa19eb0a8713f25b1fca9',1,'Wippersnapper']]], ['pindotstarclock',['pinDotStarClock',['../structstrand__s.html#ad7c7f86db3afb63cbb8261179cc4d7be',1,'strand_s']]], ['pindotstardata',['pinDotStarData',['../structstrand__s.html#a0c314d917738e634288685b4c3ebad55',1,'strand_s']]], diff --git a/html/search/variables_e.js b/html/search/variables_e.js index e5b1ed456..97ee0806b 100644 --- a/html/search/variables_e.js +++ b/html/search/variables_e.js @@ -1,4 +1,4 @@ var searchData= [ - ['ws',['WS',['../_wippersnapper___analog_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___digital_g_p_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ds18x20_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wipper_snapper___i2_c_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ledc_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__pixels_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___register_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__servo_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__display__driver_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___a_i_r_l_i_f_t_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___e_s_p32_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___w_i_f_i_n_i_n_a_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp']]] + ['ws',['WS',['../_wippersnapper___analog_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___digital_g_p_i_o_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ds18x20_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wipper_snapper___i2_c_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__ledc_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__pixels_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___register_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__servo_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___status_l_e_d_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../ws__display__driver_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___a_i_r_l_i_f_t_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper___e_s_p32_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8cpp.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp'],['../_wippersnapper_8h.html#ae26e6d0526376ae51cce14cce3148855',1,'WS(): Wippersnapper.cpp']]] ]; diff --git a/html/ws__display__driver_8h_source.html b/html/ws__display__driver_8h_source.html index adc96ec1b..8e87a4f03 100644 --- a/html/ws__display__driver_8h_source.html +++ b/html/ws__display__driver_8h_source.html @@ -68,7 +68,7 @@
                                                                                                                                                Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                15 #ifndef WIPPERSNAPPER_DISPLAY_H
                                                                                                                                                16 #define WIPPERSNAPPER_DISPLAY_H
                                                                                                                                                17 
                                                                                                                                                18 #include "Wippersnapper.h"
                                                                                                                                                19 #include "provisioning/Config.h"
                                                                                                                                                20 #include <Adafruit_LvGL_Glue.h> // Always include this BEFORE lvgl.h!
                                                                                                                                                21 #include <Adafruit_ST7789.h>
                                                                                                                                                22 #include <lvgl.h>
                                                                                                                                                23 
                                                                                                                                                24 LV_FONT_DECLARE(errorTriangle);
                                                                                                                                                25 
                                                                                                                                                26 class Wippersnapper; // fwd decl
                                                                                                                                                27 
                                                                                                                                                28 /***************************************************************************/
                                                                                                                                                32 /***************************************************************************/
                                                                                                                                                33 class ws_display_driver {
                                                                                                                                                34 public:
                                                                                                                                                35  ws_display_driver(){};
                                                                                                                                                36  ws_display_driver(displayConfig config);
                                                                                                                                                37  ~ws_display_driver();
                                                                                                                                                38 
                                                                                                                                                39  bool begin();
                                                                                                                                                40  void setResolution(uint16_t displayWidth, uint16_t displayHeight);
                                                                                                                                                41  void setRotation(uint8_t rotationMode);
                                                                                                                                                42  void enableLogging();
                                                                                                                                                43  Adafruit_LvGL_Glue *_glue;
                                                                                                                                                44  void esp32_lvgl_acquire();
                                                                                                                                                45  void esp32_lvgl_release();
                                                                                                                                                46 
                                                                                                                                                47 private:
                                                                                                                                                48  Adafruit_ST7789 *_tft_st7789 = nullptr;
                                                                                                                                                49  uint16_t _displayWidth;
                                                                                                                                                50  uint16_t _displayHeight;
                                                                                                                                                51  uint8_t
                                                                                                                                                52  _displayRotationMode;
                                                                                                                                                53 };
                                                                                                                                                54 extern Wippersnapper WS;
                                                                                                                                                55 
                                                                                                                                                56 #endif // WIPPERSNAPPER_DISPLAY_H
                                                                                                                                                ws_display_driver::esp32_lvgl_acquire
                                                                                                                                                void esp32_lvgl_acquire()
                                                                                                                                                Acquires the LVGL_Glue lock.
                                                                                                                                                Definition: ws_display_driver.cpp:134
                                                                                                                                                ws_display_driver::begin
                                                                                                                                                bool begin()
                                                                                                                                                Initializes the display and the lvgl_glue driver.
                                                                                                                                                Definition: ws_display_driver.cpp:94
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                Wippersnapper.h
                                                                                                                                                ws_display_driver
                                                                                                                                                Display driver for LVGL and LVGL_Glue in WipperSnapper.
                                                                                                                                                Definition: ws_display_driver.h:33
                                                                                                                                                ws_display_driver::_glue
                                                                                                                                                Adafruit_LvGL_Glue * _glue
                                                                                                                                                LVGL glue object.
                                                                                                                                                Definition: ws_display_driver.h:43
                                                                                                                                                diff --git a/html/ws__ds18x20_8h_source.html b/html/ws__ds18x20_8h_source.html index 10af9450e..b240c474a 100644 --- a/html/ws__ds18x20_8h_source.html +++ b/html/ws__ds18x20_8h_source.html @@ -68,7 +68,7 @@
                                                                                                                                                Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                16 #ifndef WIPPERSNAPPER_DS18X20_H
                                                                                                                                                17 #define WIPPERSNAPPER_DS18X20_H
                                                                                                                                                18 
                                                                                                                                                19 #include "Wippersnapper.h"
                                                                                                                                                20 
                                                                                                                                                21 #include <Adafruit_Sensor.h>
                                                                                                                                                22 #include <DallasTemperature.h>
                                                                                                                                                23 
                                                                                                                                                25 struct ds18x20Obj {
                                                                                                                                                26  OneWire *
                                                                                                                                                27  oneWire;
                                                                                                                                                28  char onewire_pin[5];
                                                                                                                                                29  DallasTemperature
                                                                                                                                                30  *dallasTempObj;
                                                                                                                                                31  DeviceAddress dallasTempAddr;
                                                                                                                                                32  int sensorPropertiesCount;
                                                                                                                                                33  wippersnapper_i2c_v1_I2CDeviceSensorProperties sensorProperties[2] =
                                                                                                                                                34  wippersnapper_i2c_v1_I2CDeviceSensorProperties_init_zero;
                                                                                                                                                35  long sensorPeriodPrv;
                                                                                                                                                37 };
                                                                                                                                                38 
                                                                                                                                                39 // forward decl.
                                                                                                                                                40 class Wippersnapper;
                                                                                                                                                41 
                                                                                                                                                42 /**************************************************************************/
                                                                                                                                                47 /**************************************************************************/
                                                                                                                                                48 class ws_ds18x20 {
                                                                                                                                                49 public:
                                                                                                                                                50  ws_ds18x20();
                                                                                                                                                51  ~ws_ds18x20();
                                                                                                                                                52 
                                                                                                                                                53  bool
                                                                                                                                                54  addDS18x20(wippersnapper_ds18x20_v1_Ds18x20InitRequest *msgDs18x20InitReq);
                                                                                                                                                55  void deleteDS18x20(
                                                                                                                                                56  wippersnapper_ds18x20_v1_Ds18x20DeInitRequest *msgDS18x20DeinitReq);
                                                                                                                                                57  void update();
                                                                                                                                                58 
                                                                                                                                                59 private:
                                                                                                                                                60  std::vector<ds18x20Obj *>
                                                                                                                                                61  _ds18xDrivers;
                                                                                                                                                62 };
                                                                                                                                                63 extern Wippersnapper WS;
                                                                                                                                                64 
                                                                                                                                                65 #endif // WIPPERSNAPPER_DS18X20_H
                                                                                                                                                ds18x20Obj::sensorPropertiesCount
                                                                                                                                                int sensorPropertiesCount
                                                                                                                                                Tracks # of sensorProperties.
                                                                                                                                                Definition: ws_ds18x20.h:32
                                                                                                                                                ds18x20Obj::sensorPeriodPrv
                                                                                                                                                long sensorPeriodPrv
                                                                                                                                                Last time the sensor was polled, in millis.
                                                                                                                                                Definition: ws_ds18x20.h:36
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                Wippersnapper.h
                                                                                                                                                ds18x20Obj::dallasTempObj
                                                                                                                                                DallasTemperature * dallasTempObj
                                                                                                                                                Pointer to a DallasTemperature sensor object.
                                                                                                                                                Definition: ws_ds18x20.h:30
                                                                                                                                                ws_ds18x20
                                                                                                                                                Class that provides an interface with DS18X20-compatible sensors.
                                                                                                                                                Definition: ws_ds18x20.h:48
                                                                                                                                                diff --git a/html/ws__ledc_8h_source.html b/html/ws__ledc_8h_source.html index 4aa838065..5695938d0 100644 --- a/html/ws__ledc_8h_source.html +++ b/html/ws__ledc_8h_source.html @@ -70,7 +70,7 @@
                                                                                                                                                ws_ledc::~ws_ledc
                                                                                                                                                ~ws_ledc()
                                                                                                                                                Dtor.
                                                                                                                                                Definition: ws_ledc.h:50
                                                                                                                                                ws_ledc::analogWrite
                                                                                                                                                bool analogWrite(uint8_t pin, int value)
                                                                                                                                                Arduino AnalogWrite function, but for ESP32&#39;s LEDC.
                                                                                                                                                Definition: ws_ledc.cpp:51
                                                                                                                                                ws_ledc::setDuty
                                                                                                                                                bool setDuty(uint8_t pin, uint32_t duty)
                                                                                                                                                Sets the duty cycle of a LEDC pin.
                                                                                                                                                Definition: ws_ledc.cpp:71
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                ws_ledc::detachPin
                                                                                                                                                bool detachPin(uint8_t pin)
                                                                                                                                                Detaches a pin from LEDC.
                                                                                                                                                Definition: ws_ledc.cpp:41
                                                                                                                                                Wippersnapper.h
                                                                                                                                                ws_ledc::ws_ledc
                                                                                                                                                ws_ledc()
                                                                                                                                                Ctor.
                                                                                                                                                Definition: ws_ledc.h:44
                                                                                                                                                diff --git a/html/ws__networking__pico_8h_source.html b/html/ws__networking__pico_8h_source.html index 8738f2a51..5526764ff 100644 --- a/html/ws__networking__pico_8h_source.html +++ b/html/ws__networking__pico_8h_source.html @@ -66,25 +66,27 @@
                                                                                                                                                ws_networking_pico.h
                                                                                                                                                -Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                17 #ifndef WS_NETWORKING_PICO_H
                                                                                                                                                18 #define WS_NETWORKING_PICO_H
                                                                                                                                                19 
                                                                                                                                                20 #ifdef ARDUINO_ARCH_RP2040
                                                                                                                                                21 
                                                                                                                                                22 #define PICO_CONNECT_TIMEOUT_MS 20000
                                                                                                                                                23 #define PICO_CONNECT_RETRY_DELAY_MS 200
                                                                                                                                                25 #include "Wippersnapper.h"
                                                                                                                                                26 
                                                                                                                                                27 #include "Adafruit_MQTT.h"
                                                                                                                                                28 #include "Adafruit_MQTT_Client.h"
                                                                                                                                                29 #include "Arduino.h"
                                                                                                                                                30 #include <WiFiClient.h>
                                                                                                                                                31 #include <WiFiClientSecure.h>
                                                                                                                                                32 extern Wippersnapper WS;
                                                                                                                                                33 
                                                                                                                                                34 /****************************************************************************/
                                                                                                                                                38 /****************************************************************************/
                                                                                                                                                39 class ws_networking_pico : public Wippersnapper {
                                                                                                                                                40 
                                                                                                                                                41 public:
                                                                                                                                                42  /**************************************************************************/
                                                                                                                                                46  /**************************************************************************/
                                                                                                                                                47  ws_networking_pico() : Wippersnapper() {
                                                                                                                                                48  _ssid = 0;
                                                                                                                                                49  _pass = 0;
                                                                                                                                                50  }
                                                                                                                                                51 
                                                                                                                                                52  /**************************************************************************/
                                                                                                                                                56  /**************************************************************************/
                                                                                                                                                57  ~ws_networking_pico() {
                                                                                                                                                58  if (_mqtt_client_secure)
                                                                                                                                                59  delete _mqtt_client_secure;
                                                                                                                                                60  if (_mqtt_client_secure)
                                                                                                                                                61  delete _mqtt_client_secure;
                                                                                                                                                62  }
                                                                                                                                                63 
                                                                                                                                                64  /********************************************************/
                                                                                                                                                72  /********************************************************/
                                                                                                                                                73  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
                                                                                                                                                74  _ssid = ssid;
                                                                                                                                                75 
                                                                                                                                                76  // set the AP password
                                                                                                                                                77  // check if ssidPassword was "" in secrets.json
                                                                                                                                                78  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
                                                                                                                                                79  _pass = NULL; // Set as NULL for open networks
                                                                                                                                                80  } else {
                                                                                                                                                81  _pass = ssidPassword;
                                                                                                                                                82  }
                                                                                                                                                83  }
                                                                                                                                                84 
                                                                                                                                                85  /**********************************************************/
                                                                                                                                                89  /**********************************************************/
                                                                                                                                                90  void set_ssid_pass() {
                                                                                                                                                91  _ssid = WS._config.network.ssid;
                                                                                                                                                92  _pass = WS._config.network.pass;
                                                                                                                                                93  }
                                                                                                                                                94 
                                                                                                                                                95  /***********************************************************/
                                                                                                                                                100  /***********************************************************/
                                                                                                                                                101  bool check_valid_ssid() {
                                                                                                                                                102  // Set WiFi to station mode and disconnect from an AP if it was previously
                                                                                                                                                103  // connected
                                                                                                                                                104  WiFi.mode(WIFI_STA);
                                                                                                                                                105  WiFi.disconnect();
                                                                                                                                                106  delay(100);
                                                                                                                                                107 
                                                                                                                                                108  // Perform a network scan
                                                                                                                                                109  int n = WiFi.scanNetworks();
                                                                                                                                                110  if (n == 0) {
                                                                                                                                                111  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
                                                                                                                                                112  return false;
                                                                                                                                                113  }
                                                                                                                                                114 
                                                                                                                                                115  // Was the network within secrets.json found?
                                                                                                                                                116  for (int i = 0; i < n; ++i) {
                                                                                                                                                117  if (strcmp(_ssid, WiFi.SSID(i)) == 0) {
                                                                                                                                                118  WS_DEBUG_PRINT("SSID (");
                                                                                                                                                119  WS_DEBUG_PRINT(_ssid);
                                                                                                                                                120  WS_DEBUG_PRINT(") found! RSSI: ");
                                                                                                                                                121  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
                                                                                                                                                122  return true;
                                                                                                                                                123  }
                                                                                                                                                124  if (WS._isWiFiMulti) {
                                                                                                                                                125  // multi network mode
                                                                                                                                                126  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
                                                                                                                                                127  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i)) == 0) {
                                                                                                                                                128  WS_DEBUG_PRINT("SSID (");
                                                                                                                                                129  WS_DEBUG_PRINT(WS._multiNetworks[j].ssid);
                                                                                                                                                130  WS_DEBUG_PRINT(") found! RSSI: ");
                                                                                                                                                131  WS_DEBUG_PRINTLN(WiFi.RSSI(i));
                                                                                                                                                132  return true;
                                                                                                                                                133  }
                                                                                                                                                134  }
                                                                                                                                                135  }
                                                                                                                                                136  }
                                                                                                                                                137 
                                                                                                                                                138  // User-set network not found, print scan results to serial console
                                                                                                                                                139  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
                                                                                                                                                140  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks: ");
                                                                                                                                                141  for (int i = 0; i < n; ++i) {
                                                                                                                                                142  WS_DEBUG_PRINT(WiFi.SSID(i));
                                                                                                                                                143  WS_DEBUG_PRINT(" ");
                                                                                                                                                144  WS_DEBUG_PRINT(WiFi.RSSI(i));
                                                                                                                                                145  WS_DEBUG_PRINTLN("dB");
                                                                                                                                                146  }
                                                                                                                                                147 
                                                                                                                                                148  return false;
                                                                                                                                                149  }
                                                                                                                                                150 
                                                                                                                                                151  /********************************************************/
                                                                                                                                                156  /********************************************************/
                                                                                                                                                157  void getMacAddr() {
                                                                                                                                                158  uint8_t mac[6] = {0};
                                                                                                                                                159  WiFi.macAddress(mac);
                                                                                                                                                160  memcpy(WS._macAddr, mac, sizeof(mac));
                                                                                                                                                161  }
                                                                                                                                                162 
                                                                                                                                                163  /********************************************************/
                                                                                                                                                168  /********************************************************/
                                                                                                                                                169  int32_t getRSSI() { return WiFi.RSSI(); }
                                                                                                                                                170 
                                                                                                                                                171  /********************************************************/
                                                                                                                                                177  /********************************************************/
                                                                                                                                                178  void setupMQTTClient(const char *clientID) {
                                                                                                                                                179  if (strcmp(WS._config.aio_url, "io.adafruit.com") == 0 ||
                                                                                                                                                180  strcmp(WS._config.aio_url, "io.adafruit.us") == 0) {
                                                                                                                                                181  _mqtt_client_secure = new WiFiClientSecure();
                                                                                                                                                182  _mqtt_client_secure->setCACert(
                                                                                                                                                183  strcmp(WS._config.aio_url, "io.adafruit.com") == 0
                                                                                                                                                184  ? _aio_root_ca_prod
                                                                                                                                                185  : _aio_root_ca_staging);
                                                                                                                                                186  WS._mqtt = new Adafruit_MQTT_Client(
                                                                                                                                                187  _mqtt_client_secure, WS._config.aio_url, WS._config.io_port, clientID,
                                                                                                                                                188  WS._config.aio_user, WS._config.aio_key);
                                                                                                                                                189  } else {
                                                                                                                                                190  _mqtt_client_insecure = new WiFiClient();
                                                                                                                                                191  WS._mqtt = new Adafruit_MQTT_Client(
                                                                                                                                                192  _mqtt_client_insecure, WS._config.aio_url, WS._config.io_port,
                                                                                                                                                193  clientID, WS._config.aio_user, WS._config.aio_key);
                                                                                                                                                194  }
                                                                                                                                                195  }
                                                                                                                                                196 
                                                                                                                                                197  /********************************************************/
                                                                                                                                                202  /********************************************************/
                                                                                                                                                203  ws_status_t networkStatus() {
                                                                                                                                                204  switch (WiFi.status()) {
                                                                                                                                                205  case WL_CONNECTED:
                                                                                                                                                206  return WS_NET_CONNECTED;
                                                                                                                                                207  case WL_CONNECT_FAILED:
                                                                                                                                                208  return WS_NET_CONNECT_FAILED;
                                                                                                                                                209  case WL_IDLE_STATUS:
                                                                                                                                                210  return WS_IDLE;
                                                                                                                                                211  default:
                                                                                                                                                212  return WS_NET_DISCONNECTED;
                                                                                                                                                213  }
                                                                                                                                                214  }
                                                                                                                                                215 
                                                                                                                                                216  /*******************************************************************/
                                                                                                                                                221  /*******************************************************************/
                                                                                                                                                222  const char *connectionType() { return "Pico"; }
                                                                                                                                                223 
                                                                                                                                                224 protected:
                                                                                                                                                225  const char *_ssid;
                                                                                                                                                226  const char *_pass;
                                                                                                                                                227  WiFiClient
                                                                                                                                                228  *_mqtt_client_insecure;
                                                                                                                                                229  WiFiClientSecure
                                                                                                                                                230  *_mqtt_client_secure;
                                                                                                                                                231  WiFiMulti _wifiMulti;
                                                                                                                                                232 
                                                                                                                                                233  const char *_aio_root_ca_staging =
                                                                                                                                                234  "-----BEGIN CERTIFICATE-----\n"
                                                                                                                                                235  "MIIEVzCCAj+gAwIBAgIRAIOPbGPOsTmMYgZigxXJ/d4wDQYJKoZIhvcNAQELBQAw\n"
                                                                                                                                                236  "TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
                                                                                                                                                237  "cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMjQwMzEzMDAwMDAw\n"
                                                                                                                                                238  "WhcNMjcwMzEyMjM1OTU5WjAyMQswCQYDVQQGEwJVUzEWMBQGA1UEChMNTGV0J3Mg\n"
                                                                                                                                                239  "RW5jcnlwdDELMAkGA1UEAxMCRTUwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQNCzqK\n"
                                                                                                                                                240  "a2GOtu/cX1jnxkJFVKtj9mZhSAouWXW0gQI3ULc/FnncmOyhKJdyIBwsz9V8UiBO\n"
                                                                                                                                                241  "VHhbhBRrwJCuhezAUUE8Wod/Bk3U/mDR+mwt4X2VEIiiCFQPmRpM5uoKrNijgfgw\n"
                                                                                                                                                242  "gfUwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggrBgEFBQcD\n"
                                                                                                                                                243  "ATASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBSfK1/PPCFPnQS37SssxMZw\n"
                                                                                                                                                244  "i9LXDTAfBgNVHSMEGDAWgBR5tFnme7bl5AFzgAiIyBpY9umbbjAyBggrBgEFBQcB\n"
                                                                                                                                                245  "AQQmMCQwIgYIKwYBBQUHMAKGFmh0dHA6Ly94MS5pLmxlbmNyLm9yZy8wEwYDVR0g\n"
                                                                                                                                                246  "BAwwCjAIBgZngQwBAgEwJwYDVR0fBCAwHjAcoBqgGIYWaHR0cDovL3gxLmMubGVu\n"
                                                                                                                                                247  "Y3Iub3JnLzANBgkqhkiG9w0BAQsFAAOCAgEAH3KdNEVCQdqk0LKyuNImTKdRJY1C\n"
                                                                                                                                                248  "2uw2SJajuhqkyGPY8C+zzsufZ+mgnhnq1A2KVQOSykOEnUbx1cy637rBAihx97r+\n"
                                                                                                                                                249  "bcwbZM6sTDIaEriR/PLk6LKs9Be0uoVxgOKDcpG9svD33J+G9Lcfv1K9luDmSTgG\n"
                                                                                                                                                250  "6XNFIN5vfI5gs/lMPyojEMdIzK9blcl2/1vKxO8WGCcjvsQ1nJ/Pwt8LQZBfOFyV\n"
                                                                                                                                                251  "XP8ubAp/au3dc4EKWG9MO5zcx1qT9+NXRGdVWxGvmBFRAajciMfXME1ZuGmk3/GO\n"
                                                                                                                                                252  "koAM7ZkjZmleyokP1LGzmfJcUd9s7eeu1/9/eg5XlXd/55GtYjAM+C4DG5i7eaNq\n"
                                                                                                                                                253  "cm2F+yxYIPt6cbbtYVNJCGfHWqHEQ4FYStUyFnv8sjyqU8ypgZaNJ9aVcWSICLOI\n"
                                                                                                                                                254  "E1/Qv/7oKsnZCWJ926wU6RqG1OYPGOi1zuABhLw61cuPVDT28nQS/e6z95cJXq0e\n"
                                                                                                                                                255  "K1BcaJ6fJZsmbjRgD5p3mvEf5vdQM7MCEvU0tHbsx2I5mHHJoABHb8KVBgWp/lcX\n"
                                                                                                                                                256  "GWiWaeOyB7RP+OfDtvi2OsapxXiV7vNVs7fMlrRjY1joKaqmmycnBvAq14AEbtyL\n"
                                                                                                                                                257  "sVfOS66B8apkeFX2NY4XPEYV4ZSCe8VHPrdrERk2wILG3T/EGmSIkCYVUMSnjmJd\n"
                                                                                                                                                258  "VQD9F6Na/+zmXCc=\n"
                                                                                                                                                259  "-----END CERTIFICATE-----\n";
                                                                                                                                                260 
                                                                                                                                                261  const char *_aio_root_ca_prod =
                                                                                                                                                262  "-----BEGIN CERTIFICATE-----\n"
                                                                                                                                                263  "MIIEjTCCA3WgAwIBAgIQDQd4KhM/xvmlcpbhMf/ReTANBgkqhkiG9w0BAQsFADBh\n"
                                                                                                                                                264  "MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n"
                                                                                                                                                265  "d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH\n"
                                                                                                                                                266  "MjAeFw0xNzExMDIxMjIzMzdaFw0yNzExMDIxMjIzMzdaMGAxCzAJBgNVBAYTAlVT\n"
                                                                                                                                                267  "MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n"
                                                                                                                                                268  "b20xHzAdBgNVBAMTFkdlb1RydXN0IFRMUyBSU0EgQ0EgRzEwggEiMA0GCSqGSIb3\n"
                                                                                                                                                269  "DQEBAQUAA4IBDwAwggEKAoIBAQC+F+jsvikKy/65LWEx/TMkCDIuWegh1Ngwvm4Q\n"
                                                                                                                                                270  "yISgP7oU5d79eoySG3vOhC3w/3jEMuipoH1fBtp7m0tTpsYbAhch4XA7rfuD6whU\n"
                                                                                                                                                271  "gajeErLVxoiWMPkC/DnUvbgi74BJmdBiuGHQSd7LwsuXpTEGG9fYXcbTVN5SATYq\n"
                                                                                                                                                272  "DfbexbYxTMwVJWoVb6lrBEgM3gBBqiiAiy800xu1Nq07JdCIQkBsNpFtZbIZhsDS\n"
                                                                                                                                                273  "fzlGWP4wEmBQ3O67c+ZXkFr2DcrXBEtHam80Gp2SNhou2U5U7UesDL/xgLK6/0d7\n"
                                                                                                                                                274  "6TnEVMSUVJkZ8VeZr+IUIlvoLrtjLbqugb0T3OYXW+CQU0kBAgMBAAGjggFAMIIB\n"
                                                                                                                                                275  "PDAdBgNVHQ4EFgQUlE/UXYvkpOKmgP792PkA76O+AlcwHwYDVR0jBBgwFoAUTiJU\n"
                                                                                                                                                276  "IBiV5uNu5g/6+rkS7QYXjzkwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsG\n"
                                                                                                                                                277  "AQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMDQGCCsGAQUFBwEB\n"
                                                                                                                                                278  "BCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tMEIGA1Ud\n"
                                                                                                                                                279  "HwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEds\n"
                                                                                                                                                280  "b2JhbFJvb3RHMi5jcmwwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUHAgEW\n"
                                                                                                                                                281  "HGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwDQYJKoZIhvcNAQELBQADggEB\n"
                                                                                                                                                282  "AIIcBDqC6cWpyGUSXAjjAcYwsK4iiGF7KweG97i1RJz1kwZhRoo6orU1JtBYnjzB\n"
                                                                                                                                                283  "c4+/sXmnHJk3mlPyL1xuIAt9sMeC7+vreRIF5wFBC0MCN5sbHwhNN1JzKbifNeP5\n"
                                                                                                                                                284  "ozpZdQFmkCo+neBiKR6HqIA+LMTMCMMuv2khGGuPHmtDze4GmEGZtYLyF8EQpa5Y\n"
                                                                                                                                                285  "jPuV6k2Cr/N3XxFpT3hRpt/3usU/Zb9wfKPtWpoznZ4/44c1p9rzFcZYrWkj3A+7\n"
                                                                                                                                                286  "TNBJE0GmP2fhXhP1D/XVfIW/h0yCJGEiV9Glm/uGOa3DXHlmbAcxSyCRraG+ZBkA\n"
                                                                                                                                                287  "7h4SeM6Y8l/7MBRpPCz6l8Y=\n"
                                                                                                                                                288  "-----END CERTIFICATE-----\n";
                                                                                                                                                289 
                                                                                                                                                290  /**************************************************************************/
                                                                                                                                                294  /**************************************************************************/
                                                                                                                                                295  void _connect() {
                                                                                                                                                296 
                                                                                                                                                297  if (WiFi.status() == WL_CONNECTED)
                                                                                                                                                298  return;
                                                                                                                                                299 
                                                                                                                                                300  WiFi.mode(WIFI_STA);
                                                                                                                                                301  WS.feedWDT();
                                                                                                                                                302  WiFi.setTimeout(20000);
                                                                                                                                                303  WS.feedWDT();
                                                                                                                                                304 
                                                                                                                                                305  if (strlen(_ssid) == 0) {
                                                                                                                                                306  _status = WS_SSID_INVALID;
                                                                                                                                                307  } else {
                                                                                                                                                308  _disconnect();
                                                                                                                                                309  delay(5000);
                                                                                                                                                310  WS.feedWDT();
                                                                                                                                                311  if (WS._isWiFiMulti) {
                                                                                                                                                312  // multi network mode
                                                                                                                                                313  _wifiMulti.clearAPList();
                                                                                                                                                314  // add default network
                                                                                                                                                315  _wifiMulti.addAP(_ssid, _pass);
                                                                                                                                                316  // add array of alternative networks
                                                                                                                                                317  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
                                                                                                                                                318  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
                                                                                                                                                319  WS._multiNetworks[i].pass);
                                                                                                                                                320  }
                                                                                                                                                321  WS.feedWDT();
                                                                                                                                                322  if (_wifiMulti.run(10000) == WL_CONNECTED) {
                                                                                                                                                323  WS.feedWDT();
                                                                                                                                                324  _status = WS_NET_CONNECTED;
                                                                                                                                                325  return;
                                                                                                                                                326  }
                                                                                                                                                327  WS.feedWDT();
                                                                                                                                                328  } else {
                                                                                                                                                329  WiFi.begin(_ssid, _pass);
                                                                                                                                                330 
                                                                                                                                                331  // Use the macro to retry the status check until connected / timed out
                                                                                                                                                332  int lastResult;
                                                                                                                                                333  RETRY_FUNCTION_UNTIL_TIMEOUT(
                                                                                                                                                334  []() -> int { return WiFi.status(); }, // Function call each cycle
                                                                                                                                                335  int, // return type
                                                                                                                                                336  lastResult, // return variable (unused here)
                                                                                                                                                337  [](int status) { return status == WL_CONNECTED; }, // check
                                                                                                                                                338  PICO_CONNECT_TIMEOUT_MS, // timeout interval (ms)
                                                                                                                                                339  PICO_CONNECT_RETRY_DELAY_MS); // interval between retries
                                                                                                                                                340 
                                                                                                                                                341  if (lastResult == WL_CONNECTED) {
                                                                                                                                                342  _status = WS_NET_CONNECTED;
                                                                                                                                                343  // wait 2seconds for connection to stabilize
                                                                                                                                                344  WS_DELAY_WITH_WDT(2000);
                                                                                                                                                345  return;
                                                                                                                                                346  }
                                                                                                                                                347  }
                                                                                                                                                348  _status = WS_NET_DISCONNECTED;
                                                                                                                                                349  }
                                                                                                                                                350  }
                                                                                                                                                351 
                                                                                                                                                352  /**************************************************************************/
                                                                                                                                                356  /**************************************************************************/
                                                                                                                                                357  void _disconnect() {
                                                                                                                                                358  WS.feedWDT();
                                                                                                                                                359  WiFi.disconnect();
                                                                                                                                                360  delay(5000);
                                                                                                                                                361  WS.feedWDT();
                                                                                                                                                362  }
                                                                                                                                                363 };
                                                                                                                                                364 
                                                                                                                                                365 #endif // ARDUINO_ARCH_RP2040
                                                                                                                                                366 #endif // WS_NETWORKING_PICO_H
                                                                                                                                                Wippersnapper::setupMQTTClient
                                                                                                                                                virtual void setupMQTTClient(const char *clientID)
                                                                                                                                                Sets up the MQTT client session.
                                                                                                                                                Definition: Wippersnapper.cpp:203
                                                                                                                                                +Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                17 #ifndef WS_NETWORKING_PICO_H
                                                                                                                                                18 #define WS_NETWORKING_PICO_H
                                                                                                                                                19 
                                                                                                                                                20 #ifdef ARDUINO_ARCH_RP2040
                                                                                                                                                21 
                                                                                                                                                22 #define PICO_CONNECT_TIMEOUT_MS 20000
                                                                                                                                                23 #define PICO_CONNECT_RETRY_DELAY_MS 200
                                                                                                                                                25 #include "Wippersnapper.h"
                                                                                                                                                26 
                                                                                                                                                27 #include "Adafruit_MQTT.h"
                                                                                                                                                28 #include "Adafruit_MQTT_Client.h"
                                                                                                                                                29 #include "Arduino.h"
                                                                                                                                                30 #include <WiFiClient.h>
                                                                                                                                                31 #include <WiFiClientSecure.h>
                                                                                                                                                32 extern Wippersnapper WS;
                                                                                                                                                33 
                                                                                                                                                34 /****************************************************************************/
                                                                                                                                                38 /****************************************************************************/
                                                                                                                                                39 class ws_networking_pico : public Wippersnapper {
                                                                                                                                                40 
                                                                                                                                                41 public:
                                                                                                                                                42  /**************************************************************************/
                                                                                                                                                46  /**************************************************************************/
                                                                                                                                                47  ws_networking_pico() : Wippersnapper() {
                                                                                                                                                48  _ssid = 0;
                                                                                                                                                49  _pass = 0;
                                                                                                                                                50  }
                                                                                                                                                51 
                                                                                                                                                52  /**************************************************************************/
                                                                                                                                                56  /**************************************************************************/
                                                                                                                                                57  ~ws_networking_pico() {
                                                                                                                                                58  if (_mqtt_client_secure)
                                                                                                                                                59  delete _mqtt_client_secure;
                                                                                                                                                60  if (_mqtt_client_secure)
                                                                                                                                                61  delete _mqtt_client_secure;
                                                                                                                                                62  }
                                                                                                                                                63 
                                                                                                                                                64  /********************************************************/
                                                                                                                                                72  /********************************************************/
                                                                                                                                                73  void set_ssid_pass(const char *ssid, const char *ssidPassword) {
                                                                                                                                                74  _ssid = ssid;
                                                                                                                                                75 
                                                                                                                                                76  // set the AP password
                                                                                                                                                77  // check if ssidPassword was "" in secrets.json
                                                                                                                                                78  if ((ssidPassword != NULL) && (strlen(ssidPassword) == 0)) {
                                                                                                                                                79  _pass = NULL; // Set as NULL for open networks
                                                                                                                                                80  } else {
                                                                                                                                                81  _pass = ssidPassword;
                                                                                                                                                82  }
                                                                                                                                                83  }
                                                                                                                                                84 
                                                                                                                                                85  /**********************************************************/
                                                                                                                                                89  /**********************************************************/
                                                                                                                                                90  void set_ssid_pass() {
                                                                                                                                                91  _ssid = WS._config.network.ssid;
                                                                                                                                                92  _pass = WS._config.network.pass;
                                                                                                                                                93  }
                                                                                                                                                94 
                                                                                                                                                95  /***********************************************************/
                                                                                                                                                100  /***********************************************************/
                                                                                                                                                101  bool check_valid_ssid() {
                                                                                                                                                102  // Set WiFi to station mode and disconnect from an AP if it was previously
                                                                                                                                                103  // connected
                                                                                                                                                104  WiFi.mode(WIFI_STA);
                                                                                                                                                105  WiFi.disconnect();
                                                                                                                                                106  delay(100);
                                                                                                                                                107 
                                                                                                                                                108  // Perform a network scan
                                                                                                                                                109  int n = WiFi.scanNetworks();
                                                                                                                                                110  if (n == 0) {
                                                                                                                                                111  WS_DEBUG_PRINTLN("ERROR: No WiFi networks found!");
                                                                                                                                                112  return false;
                                                                                                                                                113  }
                                                                                                                                                114 
                                                                                                                                                115  bool foundNetwork = false;
                                                                                                                                                116 
                                                                                                                                                117  WS_DEBUG_PRINTLN("WipperSnapper found these WiFi networks:");
                                                                                                                                                118  for (uint8_t i = 0; i < n; i++) {
                                                                                                                                                119  if (!foundNetwork && strcmp(WiFi.SSID(i), _ssid) == 0) {
                                                                                                                                                120  foundNetwork = true;
                                                                                                                                                121  } else if (!foundNetwork && WS._isWiFiMulti) {
                                                                                                                                                122  // multi network mode
                                                                                                                                                123  for (int j = 0; j < WS_MAX_ALT_WIFI_NETWORKS; j++) {
                                                                                                                                                124  if (strcmp(WS._multiNetworks[j].ssid, WiFi.SSID(i)) == 0) {
                                                                                                                                                125  foundNetwork = true;
                                                                                                                                                126  }
                                                                                                                                                127  }
                                                                                                                                                128  }
                                                                                                                                                129  WS_DEBUG_PRINT(WiFi.SSID(i));
                                                                                                                                                130  WS_DEBUG_PRINT(" (");
                                                                                                                                                131  uint8_t BSSID[WL_MAC_ADDR_LENGTH];
                                                                                                                                                132  WiFi.BSSID(i, BSSID);
                                                                                                                                                133  for (int m = 0; m < WL_MAC_ADDR_LENGTH; m++) {
                                                                                                                                                134  if (m != 0)
                                                                                                                                                135  WS_DEBUG_PRINT(":");
                                                                                                                                                136  WS_DEBUG_PRINTHEX(BSSID[m]);
                                                                                                                                                137  }
                                                                                                                                                138  WS_DEBUG_PRINT(") ");
                                                                                                                                                139  WS_DEBUG_PRINT(WiFi.RSSI(i));
                                                                                                                                                140  WS_DEBUG_PRINT("dB (ch");
                                                                                                                                                141  WS_DEBUG_PRINT(WiFi.channel(i))
                                                                                                                                                142  WS_DEBUG_PRINTLN(")");
                                                                                                                                                143  }
                                                                                                                                                144 
                                                                                                                                                145  if (!foundNetwork) {
                                                                                                                                                146  WS_DEBUG_PRINTLN("ERROR: Your requested WiFi network was not found!");
                                                                                                                                                147  }
                                                                                                                                                148  return foundNetwork;
                                                                                                                                                149  }
                                                                                                                                                150 
                                                                                                                                                151  /********************************************************/
                                                                                                                                                156  /********************************************************/
                                                                                                                                                157  void getMacAddr() {
                                                                                                                                                158  uint8_t mac[6] = {0};
                                                                                                                                                159  WiFi.macAddress(mac);
                                                                                                                                                160  memcpy(WS._macAddr, mac, sizeof(mac));
                                                                                                                                                161  }
                                                                                                                                                162 
                                                                                                                                                163  /********************************************************/
                                                                                                                                                168  /********************************************************/
                                                                                                                                                169  int32_t getRSSI() { return WiFi.RSSI(); }
                                                                                                                                                170 
                                                                                                                                                171  /********************************************************/
                                                                                                                                                177  /********************************************************/
                                                                                                                                                178  void setupMQTTClient(const char *clientID) {
                                                                                                                                                179  if (strcmp(WS._config.aio_url, "io.adafruit.com") == 0 ||
                                                                                                                                                180  strcmp(WS._config.aio_url, "io.adafruit.us") == 0) {
                                                                                                                                                181  _mqtt_client_secure = new WiFiClientSecure();
                                                                                                                                                182  _mqtt_client_secure->setCACert(
                                                                                                                                                183  strcmp(WS._config.aio_url, "io.adafruit.com") == 0
                                                                                                                                                184  ? _aio_root_ca_prod
                                                                                                                                                185  : _aio_root_ca_staging);
                                                                                                                                                186  WS._mqtt = new Adafruit_MQTT_Client(
                                                                                                                                                187  _mqtt_client_secure, WS._config.aio_url, WS._config.io_port, clientID,
                                                                                                                                                188  WS._config.aio_user, WS._config.aio_key);
                                                                                                                                                189  } else {
                                                                                                                                                190  _mqtt_client_insecure = new WiFiClient();
                                                                                                                                                191  WS._mqtt = new Adafruit_MQTT_Client(
                                                                                                                                                192  _mqtt_client_insecure, WS._config.aio_url, WS._config.io_port,
                                                                                                                                                193  clientID, WS._config.aio_user, WS._config.aio_key);
                                                                                                                                                194  }
                                                                                                                                                195  }
                                                                                                                                                196 
                                                                                                                                                197  /********************************************************/
                                                                                                                                                202  /********************************************************/
                                                                                                                                                203  ws_status_t networkStatus() {
                                                                                                                                                204  switch (WiFi.status()) {
                                                                                                                                                205  case WL_CONNECTED:
                                                                                                                                                206  return WS_NET_CONNECTED;
                                                                                                                                                207  case WL_CONNECT_FAILED:
                                                                                                                                                208  return WS_NET_CONNECT_FAILED;
                                                                                                                                                209  case WL_IDLE_STATUS:
                                                                                                                                                210  return WS_IDLE;
                                                                                                                                                211  default:
                                                                                                                                                212  return WS_NET_DISCONNECTED;
                                                                                                                                                213  }
                                                                                                                                                214  }
                                                                                                                                                215 
                                                                                                                                                216  /*******************************************************************/
                                                                                                                                                221  /*******************************************************************/
                                                                                                                                                222  const char *connectionType() { return "Pico"; }
                                                                                                                                                223 
                                                                                                                                                224 protected:
                                                                                                                                                225  const char *_ssid;
                                                                                                                                                226  const char *_pass;
                                                                                                                                                227  WiFiClient
                                                                                                                                                228  *_mqtt_client_insecure;
                                                                                                                                                229  WiFiClientSecure
                                                                                                                                                230  *_mqtt_client_secure;
                                                                                                                                                231  WiFiMulti _wifiMulti;
                                                                                                                                                232 
                                                                                                                                                233  const char *_aio_root_ca_staging =
                                                                                                                                                234  "-----BEGIN CERTIFICATE-----\n"
                                                                                                                                                235  "MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw\n"
                                                                                                                                                236  "TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh\n"
                                                                                                                                                237  "cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4\n"
                                                                                                                                                238  "WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu\n"
                                                                                                                                                239  "ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY\n"
                                                                                                                                                240  "MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc\n"
                                                                                                                                                241  "h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+\n"
                                                                                                                                                242  "0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U\n"
                                                                                                                                                243  "A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW\n"
                                                                                                                                                244  "T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH\n"
                                                                                                                                                245  "B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC\n"
                                                                                                                                                246  "B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv\n"
                                                                                                                                                247  "KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn\n"
                                                                                                                                                248  "OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn\n"
                                                                                                                                                249  "jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw\n"
                                                                                                                                                250  "qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI\n"
                                                                                                                                                251  "rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV\n"
                                                                                                                                                252  "HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq\n"
                                                                                                                                                253  "hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL\n"
                                                                                                                                                254  "ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ\n"
                                                                                                                                                255  "3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK\n"
                                                                                                                                                256  "NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5\n"
                                                                                                                                                257  "ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur\n"
                                                                                                                                                258  "TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC\n"
                                                                                                                                                259  "jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc\n"
                                                                                                                                                260  "oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq\n"
                                                                                                                                                261  "4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA\n"
                                                                                                                                                262  "mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d\n"
                                                                                                                                                263  "emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=\n"
                                                                                                                                                264  "-----END CERTIFICATE-----\n";
                                                                                                                                                265 
                                                                                                                                                266  const char *_aio_root_ca_prod =
                                                                                                                                                267  "-----BEGIN CERTIFICATE-----\n"
                                                                                                                                                268  "MIIEjTCCA3WgAwIBAgIQDQd4KhM/xvmlcpbhMf/ReTANBgkqhkiG9w0BAQsFADBh\n"
                                                                                                                                                269  "MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n"
                                                                                                                                                270  "d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH\n"
                                                                                                                                                271  "MjAeFw0xNzExMDIxMjIzMzdaFw0yNzExMDIxMjIzMzdaMGAxCzAJBgNVBAYTAlVT\n"
                                                                                                                                                272  "MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n"
                                                                                                                                                273  "b20xHzAdBgNVBAMTFkdlb1RydXN0IFRMUyBSU0EgQ0EgRzEwggEiMA0GCSqGSIb3\n"
                                                                                                                                                274  "DQEBAQUAA4IBDwAwggEKAoIBAQC+F+jsvikKy/65LWEx/TMkCDIuWegh1Ngwvm4Q\n"
                                                                                                                                                275  "yISgP7oU5d79eoySG3vOhC3w/3jEMuipoH1fBtp7m0tTpsYbAhch4XA7rfuD6whU\n"
                                                                                                                                                276  "gajeErLVxoiWMPkC/DnUvbgi74BJmdBiuGHQSd7LwsuXpTEGG9fYXcbTVN5SATYq\n"
                                                                                                                                                277  "DfbexbYxTMwVJWoVb6lrBEgM3gBBqiiAiy800xu1Nq07JdCIQkBsNpFtZbIZhsDS\n"
                                                                                                                                                278  "fzlGWP4wEmBQ3O67c+ZXkFr2DcrXBEtHam80Gp2SNhou2U5U7UesDL/xgLK6/0d7\n"
                                                                                                                                                279  "6TnEVMSUVJkZ8VeZr+IUIlvoLrtjLbqugb0T3OYXW+CQU0kBAgMBAAGjggFAMIIB\n"
                                                                                                                                                280  "PDAdBgNVHQ4EFgQUlE/UXYvkpOKmgP792PkA76O+AlcwHwYDVR0jBBgwFoAUTiJU\n"
                                                                                                                                                281  "IBiV5uNu5g/6+rkS7QYXjzkwDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsG\n"
                                                                                                                                                282  "AQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMDQGCCsGAQUFBwEB\n"
                                                                                                                                                283  "BCgwJjAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tMEIGA1Ud\n"
                                                                                                                                                284  "HwQ7MDkwN6A1oDOGMWh0dHA6Ly9jcmwzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEds\n"
                                                                                                                                                285  "b2JhbFJvb3RHMi5jcmwwPQYDVR0gBDYwNDAyBgRVHSAAMCowKAYIKwYBBQUHAgEW\n"
                                                                                                                                                286  "HGh0dHBzOi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwDQYJKoZIhvcNAQELBQADggEB\n"
                                                                                                                                                287  "AIIcBDqC6cWpyGUSXAjjAcYwsK4iiGF7KweG97i1RJz1kwZhRoo6orU1JtBYnjzB\n"
                                                                                                                                                288  "c4+/sXmnHJk3mlPyL1xuIAt9sMeC7+vreRIF5wFBC0MCN5sbHwhNN1JzKbifNeP5\n"
                                                                                                                                                289  "ozpZdQFmkCo+neBiKR6HqIA+LMTMCMMuv2khGGuPHmtDze4GmEGZtYLyF8EQpa5Y\n"
                                                                                                                                                290  "jPuV6k2Cr/N3XxFpT3hRpt/3usU/Zb9wfKPtWpoznZ4/44c1p9rzFcZYrWkj3A+7\n"
                                                                                                                                                291  "TNBJE0GmP2fhXhP1D/XVfIW/h0yCJGEiV9Glm/uGOa3DXHlmbAcxSyCRraG+ZBkA\n"
                                                                                                                                                292  "7h4SeM6Y8l/7MBRpPCz6l8Y=\n"
                                                                                                                                                293  "-----END CERTIFICATE-----\n";
                                                                                                                                                294 
                                                                                                                                                295  /**************************************************************************/
                                                                                                                                                299  /**************************************************************************/
                                                                                                                                                300  void _connect() {
                                                                                                                                                301 
                                                                                                                                                302  if (WiFi.status() == WL_CONNECTED)
                                                                                                                                                303  return;
                                                                                                                                                304 
                                                                                                                                                305  WiFi.mode(WIFI_STA);
                                                                                                                                                306  WS.feedWDT();
                                                                                                                                                307  WiFi.setTimeout(20000);
                                                                                                                                                308  WS.feedWDT();
                                                                                                                                                309 
                                                                                                                                                310  if (strlen(_ssid) == 0) {
                                                                                                                                                311  _status = WS_SSID_INVALID;
                                                                                                                                                312  } else {
                                                                                                                                                313  _disconnect();
                                                                                                                                                314  delay(5000);
                                                                                                                                                315  WS.feedWDT();
                                                                                                                                                316  if (WS._isWiFiMulti) {
                                                                                                                                                317  // multi network mode
                                                                                                                                                318  _wifiMulti.clearAPList();
                                                                                                                                                319  // add default network
                                                                                                                                                320  _wifiMulti.addAP(_ssid, _pass);
                                                                                                                                                321  // add array of alternative networks
                                                                                                                                                322  for (int i = 0; i < WS_MAX_ALT_WIFI_NETWORKS; i++) {
                                                                                                                                                323  _wifiMulti.addAP(WS._multiNetworks[i].ssid,
                                                                                                                                                324  WS._multiNetworks[i].pass);
                                                                                                                                                325  }
                                                                                                                                                326  WS.feedWDT();
                                                                                                                                                327  if (_wifiMulti.run(20000) == WL_CONNECTED) {
                                                                                                                                                328  WS.feedWDT();
                                                                                                                                                329  _status = WS_NET_CONNECTED;
                                                                                                                                                330  return;
                                                                                                                                                331  }
                                                                                                                                                332  WS.feedWDT();
                                                                                                                                                333  } else {
                                                                                                                                                334  WiFi.begin(_ssid, _pass);
                                                                                                                                                335 
                                                                                                                                                336  // Use the macro to retry the status check until connected / timed out
                                                                                                                                                337  int lastResult;
                                                                                                                                                338  RETRY_FUNCTION_UNTIL_TIMEOUT(
                                                                                                                                                339  []() -> int { return WiFi.status(); }, // Function call each cycle
                                                                                                                                                340  int, // return type
                                                                                                                                                341  lastResult, // return variable (unused here)
                                                                                                                                                342  [](int status) { return status == WL_CONNECTED; }, // check
                                                                                                                                                343  PICO_CONNECT_TIMEOUT_MS, // timeout interval (ms)
                                                                                                                                                344  PICO_CONNECT_RETRY_DELAY_MS); // interval between retries
                                                                                                                                                345 
                                                                                                                                                346  if (lastResult == WL_CONNECTED) {
                                                                                                                                                347  _status = WS_NET_CONNECTED;
                                                                                                                                                348  // wait 2seconds for connection to stabilize
                                                                                                                                                349  WS_DELAY_WITH_WDT(2000);
                                                                                                                                                350  return;
                                                                                                                                                351  }
                                                                                                                                                352  }
                                                                                                                                                353  _status = WS_NET_DISCONNECTED;
                                                                                                                                                354  }
                                                                                                                                                355  }
                                                                                                                                                356 
                                                                                                                                                357  /**************************************************************************/
                                                                                                                                                361  /**************************************************************************/
                                                                                                                                                362  void _disconnect() {
                                                                                                                                                363  WS.feedWDT();
                                                                                                                                                364  WiFi.disconnect();
                                                                                                                                                365  delay(5000);
                                                                                                                                                366  WS.feedWDT();
                                                                                                                                                367  }
                                                                                                                                                368 };
                                                                                                                                                369 
                                                                                                                                                370 #endif // ARDUINO_ARCH_RP2040
                                                                                                                                                371 #endif // WS_NETWORKING_PICO_H
                                                                                                                                                Wippersnapper::setupMQTTClient
                                                                                                                                                virtual void setupMQTTClient(const char *clientID)
                                                                                                                                                Sets up the MQTT client session.
                                                                                                                                                Definition: Wippersnapper.cpp:203
                                                                                                                                                RETRY_FUNCTION_UNTIL_TIMEOUT
                                                                                                                                                #define RETRY_FUNCTION_UNTIL_TIMEOUT(func, result_type, result_var, condition, timeout, interval,...)
                                                                                                                                                Retry a function until a condition is met or a timeout is reached.
                                                                                                                                                Definition: Wippersnapper.h:108
                                                                                                                                                WS_DEBUG_PRINT
                                                                                                                                                #define WS_DEBUG_PRINT(...)
                                                                                                                                                Prints debug output.
                                                                                                                                                Definition: Wippersnapper.h:49
                                                                                                                                                -
                                                                                                                                                Wippersnapper::_config
                                                                                                                                                secretsConfig _config
                                                                                                                                                Definition: Wippersnapper.h:400
                                                                                                                                                +
                                                                                                                                                WS_DEBUG_PRINTHEX
                                                                                                                                                #define WS_DEBUG_PRINTHEX(...)
                                                                                                                                                Prints debug output.
                                                                                                                                                Definition: Wippersnapper.h:55
                                                                                                                                                +
                                                                                                                                                Wippersnapper::_config
                                                                                                                                                secretsConfig _config
                                                                                                                                                Definition: Wippersnapper.h:406
                                                                                                                                                +
                                                                                                                                                WL_MAC_ADDR_LENGTH
                                                                                                                                                #define WL_MAC_ADDR_LENGTH
                                                                                                                                                MAC address length - from RP2040 BSP.
                                                                                                                                                Definition: Wippersnapper_Networking.h:20
                                                                                                                                                ws_status_t
                                                                                                                                                ws_status_t
                                                                                                                                                Definition: Wippersnapper.h:190
                                                                                                                                                Wippersnapper::check_valid_ssid
                                                                                                                                                virtual bool check_valid_ssid()
                                                                                                                                                Performs a scan of local WiFi networks.
                                                                                                                                                Definition: Wippersnapper.cpp:248
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                Wippersnapper::_connect
                                                                                                                                                virtual void _connect()
                                                                                                                                                Connects to wireless network.
                                                                                                                                                Definition: Wippersnapper.cpp:162
                                                                                                                                                -
                                                                                                                                                WS_MAX_ALT_WIFI_NETWORKS
                                                                                                                                                #define WS_MAX_ALT_WIFI_NETWORKS
                                                                                                                                                Maximum number of alternative networks.
                                                                                                                                                Definition: Wippersnapper.h:246
                                                                                                                                                +
                                                                                                                                                WS_MAX_ALT_WIFI_NETWORKS
                                                                                                                                                #define WS_MAX_ALT_WIFI_NETWORKS
                                                                                                                                                Maximum number of alternative networks.
                                                                                                                                                Definition: Wippersnapper.h:251
                                                                                                                                                Wippersnapper::getMacAddr
                                                                                                                                                virtual void getMacAddr()
                                                                                                                                                Sets the network interface&#39;s unique identifer, typically the MAC address.
                                                                                                                                                Definition: Wippersnapper.cpp:181
                                                                                                                                                Wippersnapper::set_ssid_pass
                                                                                                                                                virtual void set_ssid_pass()
                                                                                                                                                Sets the device&#39;s wireless network credentials from the secrets.json configuration file...
                                                                                                                                                Definition: Wippersnapper.cpp:238
                                                                                                                                                -
                                                                                                                                                Wippersnapper::feedWDT
                                                                                                                                                void feedWDT()
                                                                                                                                                Feeds the WDT to prevent hardware reset.
                                                                                                                                                Definition: Wippersnapper.cpp:2589
                                                                                                                                                -
                                                                                                                                                Wippersnapper::_isWiFiMulti
                                                                                                                                                bool _isWiFiMulti
                                                                                                                                                Definition: Wippersnapper.h:402
                                                                                                                                                -
                                                                                                                                                Wippersnapper::_multiNetworks
                                                                                                                                                networkConfig _multiNetworks[3]
                                                                                                                                                Definition: Wippersnapper.h:401
                                                                                                                                                +
                                                                                                                                                Wippersnapper::feedWDT
                                                                                                                                                void feedWDT()
                                                                                                                                                Feeds the WDT to prevent hardware reset.
                                                                                                                                                Definition: Wippersnapper.cpp:2608
                                                                                                                                                +
                                                                                                                                                Wippersnapper::_isWiFiMulti
                                                                                                                                                bool _isWiFiMulti
                                                                                                                                                Definition: Wippersnapper.h:408
                                                                                                                                                +
                                                                                                                                                Wippersnapper::_multiNetworks
                                                                                                                                                networkConfig _multiNetworks[3]
                                                                                                                                                Definition: Wippersnapper.h:407
                                                                                                                                                WS_DEBUG_PRINTLN
                                                                                                                                                #define WS_DEBUG_PRINTLN(...)
                                                                                                                                                Prints line from debug output.
                                                                                                                                                Definition: Wippersnapper.h:52
                                                                                                                                                WS_DELAY_WITH_WDT
                                                                                                                                                #define WS_DELAY_WITH_WDT(timeout)
                                                                                                                                                Delay function.
                                                                                                                                                Definition: Wippersnapper.h:65
                                                                                                                                                WS
                                                                                                                                                Wippersnapper WS
                                                                                                                                                Definition: Wippersnapper.cpp:36
                                                                                                                                                -
                                                                                                                                                Wippersnapper::_macAddr
                                                                                                                                                uint8_t _macAddr[6]
                                                                                                                                                Definition: Wippersnapper.h:395
                                                                                                                                                -
                                                                                                                                                Wippersnapper::_mqtt
                                                                                                                                                Adafruit_MQTT * _mqtt
                                                                                                                                                Definition: Wippersnapper.h:398
                                                                                                                                                +
                                                                                                                                                Wippersnapper::_macAddr
                                                                                                                                                uint8_t _macAddr[6]
                                                                                                                                                Definition: Wippersnapper.h:401
                                                                                                                                                +
                                                                                                                                                Wippersnapper::_mqtt
                                                                                                                                                Adafruit_MQTT * _mqtt
                                                                                                                                                Definition: Wippersnapper.h:404
                                                                                                                                                Wippersnapper::networkStatus
                                                                                                                                                virtual ws_status_t networkStatus()
                                                                                                                                                Returns the network&#39;s connection status.
                                                                                                                                                Definition: Wippersnapper.cpp:213
                                                                                                                                                Wippersnapper::getRSSI
                                                                                                                                                virtual int32_t getRSSI()
                                                                                                                                                Gets the network&#39;s RSSI.
                                                                                                                                                Definition: Wippersnapper.cpp:191
                                                                                                                                                Wippersnapper::_disconnect
                                                                                                                                                virtual void _disconnect()
                                                                                                                                                Disconnect Wippersnapper MQTT session and network.
                                                                                                                                                Definition: Wippersnapper.cpp:171
                                                                                                                                                diff --git a/html/ws__pixels_8h_source.html b/html/ws__pixels_8h_source.html index 3ecb4a28f..4673116d0 100644 --- a/html/ws__pixels_8h_source.html +++ b/html/ws__pixels_8h_source.html @@ -72,7 +72,7 @@
                                                                                                                                                strand_s
                                                                                                                                                Definition: ws_pixels.h:29
                                                                                                                                                strand_s::pinDotStarData
                                                                                                                                                int16_t pinDotStarData
                                                                                                                                                DotStar strand data pin.
                                                                                                                                                Definition: ws_pixels.h:38
                                                                                                                                                strand_s::pinNeoPixel
                                                                                                                                                int16_t pinNeoPixel
                                                                                                                                                NeoPixel strand data pin.
                                                                                                                                                Definition: ws_pixels.h:37
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                ws_pixels
                                                                                                                                                friend class
                                                                                                                                                Definition: ws_pixels.h:49
                                                                                                                                                Wippersnapper.h
                                                                                                                                                strand_s::type
                                                                                                                                                wippersnapper_pixels_v1_PixelsType type
                                                                                                                                                Type of strand (DotStar, NeoPixel)
                                                                                                                                                Definition: ws_pixels.h:33
                                                                                                                                                diff --git a/html/ws__pwm_8h_source.html b/html/ws__pwm_8h_source.html index afde5e19f..090956658 100644 --- a/html/ws__pwm_8h_source.html +++ b/html/ws__pwm_8h_source.html @@ -71,7 +71,7 @@
                                                                                                                                                ws_pwm::noTone
                                                                                                                                                void noTone(uint8_t pin)
                                                                                                                                                Stops a square wave generated by writeTone().
                                                                                                                                                Definition: ws_pwm.cpp:121
                                                                                                                                                ws_pwm::~ws_pwm
                                                                                                                                                ~ws_pwm()
                                                                                                                                                Destructor.
                                                                                                                                                Definition: ws_pwm.cpp:38
                                                                                                                                                ws_pwm::writeTone
                                                                                                                                                void writeTone(uint8_t pin, uint32_t freq)
                                                                                                                                                Writes a frequency to a pin with a fixed duty cycle.
                                                                                                                                                Definition: ws_pwm.cpp:107
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                Wippersnapper.h
                                                                                                                                                ws_ledc.h
                                                                                                                                                ws_pwm::attach
                                                                                                                                                bool attach(uint8_t pin, double freq, uint8_t resolution)
                                                                                                                                                Attaches a PWM pin.
                                                                                                                                                Definition: ws_pwm.cpp:50
                                                                                                                                                diff --git a/html/ws__servo_8h_source.html b/html/ws__servo_8h_source.html index d66d1c372..a98a7a421 100644 --- a/html/ws__servo_8h_source.html +++ b/html/ws__servo_8h_source.html @@ -68,7 +68,7 @@
                                                                                                                                                Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                17 #ifndef WS_SERVO
                                                                                                                                                18 #define WS_SERVO
                                                                                                                                                19 
                                                                                                                                                20 #include "Wippersnapper.h"
                                                                                                                                                21 
                                                                                                                                                22 #if defined(ARDUINO_ARCH_ESP32)
                                                                                                                                                23 #include "components/ledc/drivers/servo/ws_ledc_servo.h"
                                                                                                                                                24 #else
                                                                                                                                                25 #include <Servo.h>
                                                                                                                                                26 #endif
                                                                                                                                                27 
                                                                                                                                                28 #ifdef ARDUINO_ARCH_RP2040
                                                                                                                                                29 #define MAX_SERVO_NUM \
                                                                                                                                                30  8
                                                                                                                                                31 #else
                                                                                                                                                33 #define MAX_SERVO_NUM 16
                                                                                                                                                34 #endif
                                                                                                                                                35 
                                                                                                                                                36 #define MIN_SERVO_PULSE_WIDTH 500
                                                                                                                                                37 #define ERR_SERVO_ATTACH 255
                                                                                                                                                38 
                                                                                                                                                39 #if defined(ARDUINO_ARCH_ESP32)
                                                                                                                                                40 class ws_ledc_servo;
                                                                                                                                                42 struct servoComponent {
                                                                                                                                                43  ws_ledc_servo *servoObj = nullptr;
                                                                                                                                                44  uint8_t pin = 0;
                                                                                                                                                45 };
                                                                                                                                                46 #else
                                                                                                                                                47 
                                                                                                                                                48 struct servoComponent {
                                                                                                                                                49  Servo *servoObj = nullptr;
                                                                                                                                                50  uint8_t pin = 0;
                                                                                                                                                51 };
                                                                                                                                                52 #endif
                                                                                                                                                53 
                                                                                                                                                54 class Wippersnapper;
                                                                                                                                                55 
                                                                                                                                                56 /**************************************************************************/
                                                                                                                                                60 /**************************************************************************/
                                                                                                                                                61 class ws_servo {
                                                                                                                                                62 public:
                                                                                                                                                63  ws_servo(){};
                                                                                                                                                64  ~ws_servo();
                                                                                                                                                65  bool servo_attach(int pin, int minPulseWidth, int maxPulseWidth, int freq);
                                                                                                                                                66  void servo_detach(int pin);
                                                                                                                                                67  void servo_write(int pin, int value);
                                                                                                                                                68  servoComponent *getServoComponent(uint8_t pin);
                                                                                                                                                69 
                                                                                                                                                70 private:
                                                                                                                                                71  servoComponent _servos[MAX_SERVO_NUM];
                                                                                                                                                72 };
                                                                                                                                                74 extern Wippersnapper WS;
                                                                                                                                                75 
                                                                                                                                                76 #endif // WS_SERVO
                                                                                                                                                WS
                                                                                                                                                Wippersnapper WS
                                                                                                                                                Definition: Wippersnapper.cpp:36
                                                                                                                                                ws_ledc_servo
                                                                                                                                                High-level driver for servos for ESP32/ESP32-Sx/ESP32-Cx. This driver implements a subset of the func...
                                                                                                                                                Definition: ws_ledc_servo.h:57
                                                                                                                                                -
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:278
                                                                                                                                                +
                                                                                                                                                Wippersnapper
                                                                                                                                                Class that provides storage and functions for the Adafruit IO Wippersnapper interface.
                                                                                                                                                Definition: Wippersnapper.h:283
                                                                                                                                                ws_servo
                                                                                                                                                Interface for WipperSnapper servo control.
                                                                                                                                                Definition: ws_servo.h:61
                                                                                                                                                ws_ledc_servo.h
                                                                                                                                                Wippersnapper.h
                                                                                                                                                diff --git a/html/ws__uart__drv_8h_source.html b/html/ws__uart__drv_8h_source.html index fa726755b..56c2f3291 100644 --- a/html/ws__uart__drv_8h_source.html +++ b/html/ws__uart__drv_8h_source.html @@ -66,7 +66,7 @@
                                                                                                                                                ws_uart_drv.h
                                                                                                                                                -Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                16 #ifndef WS_UART_DRV_H
                                                                                                                                                17 #define WS_UART_DRV_H
                                                                                                                                                18 #include "Wippersnapper.h"
                                                                                                                                                19 #include <Adafruit_Sensor.h>
                                                                                                                                                20 
                                                                                                                                                21 // ESP8266 platform uses SoftwareSerial
                                                                                                                                                22 // so does RP2040 (note that this has differences from the pure softwareserial
                                                                                                                                                23 // library, see: https://arduino-pico.readthedocs.io/en/latest/piouart.html)
                                                                                                                                                24 #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_RP2040)
                                                                                                                                                25 #define USE_SW_UART
                                                                                                                                                26 #include <SoftwareSerial.h>
                                                                                                                                                27 #else
                                                                                                                                                28 #include <HardwareSerial.h>
                                                                                                                                                29 #endif
                                                                                                                                                30 
                                                                                                                                                31 /**************************************************************************/
                                                                                                                                                35 /**************************************************************************/
                                                                                                                                                36 class ws_uart_drv {
                                                                                                                                                37 public:
                                                                                                                                                38 #ifdef USE_SW_UART
                                                                                                                                                39  /*******************************************************************************/
                                                                                                                                                47  /*******************************************************************************/
                                                                                                                                                48  ws_uart_drv(SoftwareSerial *swSerial, int32_t interval){};
                                                                                                                                                49 #else
                                                                                                                                                50  /*******************************************************************************/
                                                                                                                                                58  /*******************************************************************************/
                                                                                                                                                59  ws_uart_drv(HardwareSerial *hwSerial, int32_t interval){};
                                                                                                                                                60 #endif
                                                                                                                                                61  ~ws_uart_drv(void) {}
                                                                                                                                                62 
                                                                                                                                                63  /*******************************************************************************/
                                                                                                                                                69  /*******************************************************************************/
                                                                                                                                                70  bool isReady() {
                                                                                                                                                71  if (millis() - _prvPoll > pollingInterval) {
                                                                                                                                                72  return true;
                                                                                                                                                73  }
                                                                                                                                                74  return false;
                                                                                                                                                75  }
                                                                                                                                                76 
                                                                                                                                                77  /*******************************************************************************/
                                                                                                                                                83  /*******************************************************************************/
                                                                                                                                                84  void setPrvPollTime(unsigned long curTime) { _prvPoll = curTime; }
                                                                                                                                                85 
                                                                                                                                                86  /*******************************************************************************/
                                                                                                                                                91  /*******************************************************************************/
                                                                                                                                                92  const char *getDriverID() { return _driverID; }
                                                                                                                                                93 
                                                                                                                                                94  /*******************************************************************************/
                                                                                                                                                100  /*******************************************************************************/
                                                                                                                                                101  void setDriverID(const char *id) { _driverID = strdup(id); }
                                                                                                                                                102 
                                                                                                                                                103  /*******************************************************************************/
                                                                                                                                                112  /*******************************************************************************/
                                                                                                                                                113  virtual void set_mqtt_client(Adafruit_MQTT *AMQTT, const char *mqtt_topic) {
                                                                                                                                                114  mqttClient = AMQTT;
                                                                                                                                                115  uartTopic = mqtt_topic;
                                                                                                                                                116  }
                                                                                                                                                117 
                                                                                                                                                118  /*******************************************************************************/
                                                                                                                                                124  /*******************************************************************************/
                                                                                                                                                125  virtual bool begin() { return false; }
                                                                                                                                                126 
                                                                                                                                                127  /*******************************************************************************/
                                                                                                                                                132  /*******************************************************************************/
                                                                                                                                                133  virtual bool read_data() { return false; }
                                                                                                                                                134 
                                                                                                                                                135  /*******************************************************************************/
                                                                                                                                                147  /*******************************************************************************/
                                                                                                                                                148  void packUARTResponse(wippersnapper_signal_v1_UARTResponse *msgUARTResponse,
                                                                                                                                                149  int event_index,
                                                                                                                                                150  wippersnapper_i2c_v1_SensorType sensor_type,
                                                                                                                                                151  float sensor_value) {
                                                                                                                                                152  msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
                                                                                                                                                153  .type = sensor_type;
                                                                                                                                                154  msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
                                                                                                                                                155  .value = sensor_value;
                                                                                                                                                156  }
                                                                                                                                                157 
                                                                                                                                                158  /*******************************************************************************/
                                                                                                                                                162  /*******************************************************************************/
                                                                                                                                                163  virtual void send_data(){};
                                                                                                                                                164 
                                                                                                                                                165  const char *uartTopic = nullptr;
                                                                                                                                                166  Adafruit_MQTT *mqttClient = nullptr;
                                                                                                                                                167  unsigned long
                                                                                                                                                168  pollingInterval;
                                                                                                                                                169 private:
                                                                                                                                                170  long _prvPoll = millis() - (24 * 60 * 60 * 1000);
                                                                                                                                                172  const char *_driverID = nullptr;
                                                                                                                                                173 };
                                                                                                                                                174 
                                                                                                                                                175 #endif // WS_UART_DRV_H
                                                                                                                                                ws_uart_drv::getDriverID
                                                                                                                                                const char * getDriverID()
                                                                                                                                                Gets the UART device&#39;s unique identifier.
                                                                                                                                                Definition: ws_uart_drv.h:92
                                                                                                                                                +Go to the documentation of this file.
                                                                                                                                                1 
                                                                                                                                                16 #ifndef WS_UART_DRV_H
                                                                                                                                                17 #define WS_UART_DRV_H
                                                                                                                                                18 #include "Wippersnapper.h"
                                                                                                                                                19 #include <Adafruit_Sensor.h>
                                                                                                                                                20 
                                                                                                                                                21 // ESP8266 platform uses SoftwareSerial
                                                                                                                                                22 // so does RP2040 (note that this has differences from the pure softwareserial
                                                                                                                                                23 // library, see: https://arduino-pico.readthedocs.io/en/latest/piouart.html)
                                                                                                                                                24 #if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_RP2040)
                                                                                                                                                25 #define USE_SW_UART
                                                                                                                                                26 #include <SoftwareSerial.h>
                                                                                                                                                27 #else
                                                                                                                                                28 #include <HardwareSerial.h>
                                                                                                                                                29 #endif
                                                                                                                                                30 
                                                                                                                                                31 /**************************************************************************/
                                                                                                                                                35 /**************************************************************************/
                                                                                                                                                36 class ws_uart_drv {
                                                                                                                                                37 public:
                                                                                                                                                38 #ifdef USE_SW_UART
                                                                                                                                                39  /*******************************************************************************/
                                                                                                                                                47  /*******************************************************************************/
                                                                                                                                                48  ws_uart_drv(SoftwareSerial *swSerial, int32_t interval){};
                                                                                                                                                49 #else
                                                                                                                                                50  /*******************************************************************************/
                                                                                                                                                58  /*******************************************************************************/
                                                                                                                                                59  ws_uart_drv(HardwareSerial *hwSerial, int32_t interval){};
                                                                                                                                                60 #endif
                                                                                                                                                61  ~ws_uart_drv(void) {}
                                                                                                                                                62 
                                                                                                                                                63  /*******************************************************************************/
                                                                                                                                                69  /*******************************************************************************/
                                                                                                                                                70  bool isReady() {
                                                                                                                                                71  if (millis() - _prvPoll > pollingInterval) {
                                                                                                                                                72  return true;
                                                                                                                                                73  }
                                                                                                                                                74  return false;
                                                                                                                                                75  }
                                                                                                                                                76 
                                                                                                                                                77  /*******************************************************************************/
                                                                                                                                                83  /*******************************************************************************/
                                                                                                                                                84  void setPrvPollTime(unsigned long curTime) { _prvPoll = curTime; }
                                                                                                                                                85 
                                                                                                                                                86  /*******************************************************************************/
                                                                                                                                                91  /*******************************************************************************/
                                                                                                                                                92  const char *getDriverID() { return _driverID; }
                                                                                                                                                93 
                                                                                                                                                94  /*******************************************************************************/
                                                                                                                                                100  /*******************************************************************************/
                                                                                                                                                101  void setDriverID(const char *id) { _driverID = strdup(id); }
                                                                                                                                                102 
                                                                                                                                                103  /*******************************************************************************/
                                                                                                                                                112  /*******************************************************************************/
                                                                                                                                                113  virtual void set_mqtt_client(Adafruit_MQTT *AMQTT, const char *mqtt_topic) {
                                                                                                                                                114  mqttClient = AMQTT;
                                                                                                                                                115  uartTopic = mqtt_topic;
                                                                                                                                                116  }
                                                                                                                                                117 
                                                                                                                                                118  /*******************************************************************************/
                                                                                                                                                124  /*******************************************************************************/
                                                                                                                                                125  virtual bool begin() { return false; }
                                                                                                                                                126 
                                                                                                                                                127  /*******************************************************************************/
                                                                                                                                                132  /*******************************************************************************/
                                                                                                                                                133  virtual bool read_data() { return false; }
                                                                                                                                                134 
                                                                                                                                                135  /*******************************************************************************/
                                                                                                                                                147  /*******************************************************************************/
                                                                                                                                                148  void packUARTResponse(wippersnapper_signal_v1_UARTResponse *msgUARTResponse,
                                                                                                                                                149  int event_index,
                                                                                                                                                150  wippersnapper_i2c_v1_SensorType sensor_type,
                                                                                                                                                151  float sensor_value) {
                                                                                                                                                152  msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
                                                                                                                                                153  .type = sensor_type;
                                                                                                                                                154  msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
                                                                                                                                                155  .value = sensor_value;
                                                                                                                                                156  }
                                                                                                                                                157 
                                                                                                                                                158  /*******************************************************************************/
                                                                                                                                                162  /*******************************************************************************/
                                                                                                                                                163  virtual void send_data() {};
                                                                                                                                                164 
                                                                                                                                                165  const char *uartTopic = nullptr;
                                                                                                                                                166  Adafruit_MQTT *mqttClient = nullptr;
                                                                                                                                                167  unsigned long
                                                                                                                                                168  pollingInterval;
                                                                                                                                                169 private:
                                                                                                                                                170  long _prvPoll = millis() - (24 * 60 * 60 * 1000);
                                                                                                                                                172  const char *_driverID = nullptr;
                                                                                                                                                173 };
                                                                                                                                                174 
                                                                                                                                                175 #endif // WS_UART_DRV_H
                                                                                                                                                ws_uart_drv::getDriverID
                                                                                                                                                const char * getDriverID()
                                                                                                                                                Gets the UART device&#39;s unique identifier.
                                                                                                                                                Definition: ws_uart_drv.h:92
                                                                                                                                                ws_uart_drv::read_data
                                                                                                                                                virtual bool read_data()
                                                                                                                                                Checks if the UART device&#39;s data is ready.
                                                                                                                                                Definition: ws_uart_drv.h:133
                                                                                                                                                ws_uart_drv::send_data
                                                                                                                                                virtual void send_data()
                                                                                                                                                Reads the UART device&#39;s data then packs and sends it to IO.
                                                                                                                                                Definition: ws_uart_drv.h:163
                                                                                                                                                ws_uart_drv::set_mqtt_client
                                                                                                                                                virtual void set_mqtt_client(Adafruit_MQTT *AMQTT, const char *mqtt_topic)
                                                                                                                                                Provides the UART device driver with an instance of the application&#39;s MQTT configuration.
                                                                                                                                                Definition: ws_uart_drv.h:113