From 23a4770fcb2d2a6e8acde2b38fd5bd31077660ab Mon Sep 17 00:00:00 2001 From: Doxygen CI Date: Wed, 19 Jul 2023 16:23:15 +0000 Subject: [PATCH] Deploy docs to GitHub Pages from commit e341e1d5a7 Commit: e341e1d5a71983909aca3a4a460668e10b73b6ce GitHub Actions run: 5601592702 --- html/_adafruit___sensor_8h_source.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/html/_adafruit___sensor_8h_source.html b/html/_adafruit___sensor_8h_source.html index a9aa9b9..f2475c2 100644 --- a/html/_adafruit___sensor_8h_source.html +++ b/html/_adafruit___sensor_8h_source.html @@ -62,7 +62,7 @@ $(function() {
Adafruit_Sensor.h
-
1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software< /span>
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and
18  * extended sensor support to include color, voltage and current */
19 
20 #ifndef _ADAFRUIT_SENSOR_H
21 #define _ADAFRUIT_SENSOR_H
22 
23 #ifndef ARDUINO
24 #include <stdint.h>
25 #elif ARDUINO >= 100
26 #include "Arduino.h"
27 #include "Print.h"
28 #else
29 #include "WProgram.h"
30 #endif
31 
32 /* Constants */
33 #define SENSORS_GRAVITY_EARTH (9.80665F)
34 #define SENSORS_GRAVITY_MOON (1.6F)
35 #define SENSORS_GRAVITY_SUN (275.0F)
36 #define SENSORS_GRAVITY_STANDARD (SENSORS_GRAVITY_EARTH)
37 #define SENSORS_MAGFIELD_EARTH_MAX \
38  (60.0F)
39 #define SENSORS_MAGFIELD_EARTH_MIN \
40  (30.0F)
41 #define SENSORS_PRESSURE_SEALEVELHPA \
42  (1013.25F)
43 #define SENSORS_DPS_TO_RADS \
44  (0.017453293F)
46 #define SENSORS_RADS_TO_DPS \
47  (57.29577793F)
48 #define SENSORS_GAUSS_TO_MICROTESLA \
49  (100)
52 typedef enum {
53  SENSOR_TYPE_ACCELEROMETER = (1),
54  SENSOR_TYPE_MAGNETIC_FIELD = (2),
55  SENSOR_TYPE_ORIENTATION = (3),
56  SENSOR_TYPE_GYROSCOPE = (4),
57  SENSOR_TYPE_LIGHT = (5),
58  SENSOR_TYPE_PRESSURE = (6),
59  SENSOR_TYPE_PROXIMITY = (8),
60  SENSOR_TYPE_GRAVITY = (9),
61  SENSOR_TYPE_LINEAR_ACCELERATION =
62  (10),
63  SENSOR_TYPE_ROTATION_VECTOR = (11),
64  SENSOR_TYPE_RELATIVE_HUMIDITY = (12),
65  SENSOR_TYPE_AMBIENT_TEMPERATURE = (13),
66  SENSOR_TYPE_OBJECT_TEMPERATURE = (14),
67  SENSOR_TYPE_VOLTAGE = (15),
68  SENSOR_TYPE_CURRENT = (16),
69  SENSOR_TYPE_COLOR = (17),
70  SENSOR_TYPE_TVOC = (18),
71  SENSOR_TYPE_VOC_INDEX = (19),
72  SENSOR_TYPE_NOX_INDEX = (20),
73  SENSOR_TYPE_CO2 = (21),
74  SENSOR_TYPE_ECO2 = (22),
75  SENSOR_TYPE_PM10_STD = (23),
76  SENSOR_TYPE_PM25_STD = (24),
77  SENSOR_TYPE_PM100_STD = (25),
78  SENSOR_TYPE_PM10_ENV = (26),
79  SENSOR_TYPE_PM25_ENV = (27),
80  SENSOR_TYPE_PM100_ENV = (28),
81  SENSOR_TYPE_GAS_RESISTANCE = (29),
82  SENSOR_TYPE_UNITLESS_PERCENT = (30)
83 } sensors_type_t;
84 
86 typedef struct {
87  union {
88  float v[3];
89  struct {
90  float x;
91  float y;
92  float z;
93  };
94  /* Orientation sensors */
95  struct {
96  float roll;
99  float pitch;
102  float heading;
105  };
106  };
107  int8_t status;
109  uint8_t reserved[3];
110 } sensors_vec_t;
111 
113 typedef struct {
114  union {
115  float c[3];
116  /* RGB color space */
117  struct {
118  float r;
119  float g;
120  float b;
121  };
122  };
123  uint32_t rgba;
124 } sensors_color_t;
125 
126 /* Sensor event (36 bytes) */
129 typedef struct {
130  int32_t version;
131  int32_t sensor_id;
132  int32_t type;
133  int32_t reserved0;
134  int32_t timestamp;
135  union {
136  float data[4];
137  sensors_vec_t acceleration;
139  sensors_vec_t
140  magnetic;
141  sensors_vec_t orientation;
142  sensors_vec_t gyro;
143  float temperature;
144  float distance;
145  float light;
146  float pressure;
147  float relative_humidity;
148  float current;
149  float voltage;
150  float tvoc;
151  float voc_index;
153  float nox_index;
155  float CO2;
156  float eCO2;
158  float pm10_std;
160  float pm25_std;
162  float pm100_std;
164  float pm10_env;
166  float pm25_env;
168  float pm100_env;
170  float gas_resistance;
172  float unitless_percent;
173  sensors_color_t color;
174  };
175 } sensors_event_t;
176 
177 /* Sensor details (40 bytes) */
180 typedef struct {
181  char name[12];
182  int32_t version;
183  int32_t sensor_id;
184  int32_t type;
185  float max_value;
186  float min_value;
187  float resolution;
189  int32_t min_delay;
191 } sensor_t;
192 
197 class Adafruit_Sensor {
198 public:
199  // Constructor(s)
200  Adafruit_Sensor() {}
201  virtual ~Adafruit_Sensor() {}
202 
203  // These must be defined by the subclass
204 
208  virtual void enableAutoRange(bool enabled) {
209  (void)enabled; /* suppress unused warning */
210  };
211 
214  virtual bool getEvent(sensors_event_t *) = 0;
216  virtual void getSensor(sensor_t *) = 0;
217 
218  void printSensorDetails(void);
219 
220 private:
221  bool _autoRange;
222 };
223 
224 #endif
sensors_vec_t
Definition: Adafruit_Sensor.h:87
+
1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software< /span>
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and
18  * extended sensor support to include color, voltage and current */
19 
20 #ifndef _ADAFRUIT_SENSOR_H
21 #define _ADAFRUIT_SENSOR_H
22 
23 #ifndef ARDUINO
24 #include <stdint.h>
25 #elif ARDUINO >= 100
26 #include "Arduino.h"
27 #include "Print.h"
28 #else
29 #include "WProgram.h"
30 #endif
31 
32 /* Constants */
33 #define SENSORS_GRAVITY_EARTH (9.80665F)
34 #define SENSORS_GRAVITY_MOON (1.6F)
35 #define SENSORS_GRAVITY_SUN (275.0F)
36 #define SENSORS_GRAVITY_STANDARD (SENSORS_GRAVITY_EARTH)
37 #define SENSORS_MAGFIELD_EARTH_MAX \
38  (60.0F)
39 #define SENSORS_MAGFIELD_EARTH_MIN \
40  (30.0F)
41 #define SENSORS_PRESSURE_SEALEVELHPA \
42  (1013.25F)
43 #define SENSORS_DPS_TO_RADS \
44  (0.017453293F)
46 #define SENSORS_RADS_TO_DPS \
47  (57.29577793F)
48 #define SENSORS_GAUSS_TO_MICROTESLA \
49  (100)
52 typedef enum {
53  SENSOR_TYPE_ACCELEROMETER = (1),
54  SENSOR_TYPE_MAGNETIC_FIELD = (2),
55  SENSOR_TYPE_ORIENTATION = (3),
56  SENSOR_TYPE_GYROSCOPE = (4),
57  SENSOR_TYPE_LIGHT = (5),
58  SENSOR_TYPE_PRESSURE = (6),
59  SENSOR_TYPE_PROXIMITY = (8),
60  SENSOR_TYPE_GRAVITY = (9),
61  SENSOR_TYPE_LINEAR_ACCELERATION =
62  (10),
63  SENSOR_TYPE_ROTATION_VECTOR = (11),
64  SENSOR_TYPE_RELATIVE_HUMIDITY = (12),
65  SENSOR_TYPE_AMBIENT_TEMPERATURE = (13),
66  SENSOR_TYPE_OBJECT_TEMPERATURE = (14),
67  SENSOR_TYPE_VOLTAGE = (15),
68  SENSOR_TYPE_CURRENT = (16),
69  SENSOR_TYPE_COLOR = (17),
70  SENSOR_TYPE_TVOC = (18),
71  SENSOR_TYPE_VOC_INDEX = (19),
72  SENSOR_TYPE_NOX_INDEX = (20),
73  SENSOR_TYPE_CO2 = (21),
74  SENSOR_TYPE_ECO2 = (22),
75  SENSOR_TYPE_PM10_STD = (23),
76  SENSOR_TYPE_PM25_STD = (24),
77  SENSOR_TYPE_PM100_STD = (25),
78  SENSOR_TYPE_PM10_ENV = (26),
79  SENSOR_TYPE_PM25_ENV = (27),
80  SENSOR_TYPE_PM100_ENV = (28),
81  SENSOR_TYPE_GAS_RESISTANCE = (29),
82  SENSOR_TYPE_UNITLESS_PERCENT = (30)
83 } sensors_type_t;
84 
86 typedef struct {
87  union {
88  float v[3];
89  struct {
90  float x;
91  float y;
92  float z;
93  };
94  /* Orientation sensors */
95  struct {
96  float roll;
99  float pitch;
102  float heading;
105  };
106  };
107  int8_t status;
109  uint8_t reserved[3];
110 } sensors_vec_t;
111 
113 typedef struct {
114  union {
115  float c[3];
116  /* RGB color space */
117  struct {
118  float r;
119  float g;
120  float b;
121  };
122  };
123  uint32_t rgba;
124 } sensors_color_t;
125 
126 /* Sensor event (36 bytes) */
129 typedef struct {
130  int32_t version;
131  int32_t sensor_id;
132  int32_t type;
133  int32_t reserved0;
134  int32_t timestamp;
135  union {
136  float data[4];
137  sensors_vec_t acceleration;
139  sensors_vec_t
140  magnetic;
141  sensors_vec_t orientation;
142  sensors_vec_t gyro;
143  float temperature;
144  float distance;
145  float light;
146  float pressure;
147  float relative_humidity;
148  float current;
149  float voltage;
150  float tvoc;
151  float voc_index;
153  float nox_index;
155  float CO2;
156  float eCO2;
158  float pm10_std;
160  float pm25_std;
162  float pm100_std;
164  float pm10_env;
166  float pm25_env;
168  float pm100_env;
170  float gas_resistance;
172  float unitless_percent;
173  sensors_color_t color;
174  };
175 } sensors_event_t;
176 
177 /* Sensor details (40 bytes) */
180 typedef struct {
181  char name[12];
182  int32_t version;
183  int32_t sensor_id;
184  int32_t type;
185  float max_value;
186  float min_value;
187  float resolution;
189  int32_t min_delay;
191 } sensor_t;
192 
197 class Adafruit_Sensor {
198 public:
199  // Constructor(s)
200  Adafruit_Sensor() {}
201  virtual ~Adafruit_Sensor() {}
202 
203  // These must be defined by the subclass
204 
208  virtual void enableAutoRange(bool enabled) {
209  (void)enabled; /* suppress unused warning */
210  };
211 
214  virtual bool getEvent(sensors_event_t *) = 0;
216  virtual void getSensor(sensor_t *) = 0;
217 
218  void printSensorDetails(void);
219 };
220 
221 #endif
sensors_vec_t
Definition: Adafruit_Sensor.h:87
Adafruit_Sensor
Common sensor interface to unify various sensors. Intentionally modeled after sensors.h in the Android API: https://github.com/android/platform_hardware_libhardware/blob/master/include/hardware/sensors.h.
Definition: Adafruit_Sensor.h:198
Adafruit_Sensor::getEvent
virtual bool getEvent(sensors_event_t *)=0
Get the latest sensor event.
Adafruit_Sensor::printSensorDetails
void printSensorDetails(void)
Prints sensor information to serial console.
Definition: Adafruit_Sensor.cpp:8