Skip to content

Commit f4c23c0

Browse files
PaulZCPaulZC
committed
Added SENSOR_UNITS.md
1 parent ebd6415 commit f4c23c0

File tree

2 files changed

+297
-1
lines changed

2 files changed

+297
-1
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ Documentation
7171
* **[UPGRADE.md](./UPGRADE.md)** - contains full instructions on how to upgrade the firmware on the OLA using the [Artemis Firmware Upload GUI](https://github.com/sparkfun/Artemis-Firmware-Upload-GUI).
7272
* **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library.
7373
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - OLA includes a large number of libraries that will need to be installed before compiling will work.
74-
* **[ADDING_SENSORS.md](./ADDING_SENSORS.md)** - contains _abbreviated_ instructions on how to add a new sensor to the OLA firmware. It's more of an aide-memoire really...
74+
* **[ADDING_SENSORS.md](./ADDING_SENSORS.md)** - contains _abbreviated_ instructions on how to add a new sensor to the OLA firmware. It's more of an aide-memoire really... Sorry about that.
75+
* **[SENSOR_UNITS.md](./SENSOR_UNITS.md)** - contains a summary of the units used by each sensor reading.
7576

7677
License Information
7778
-------------------

‎SENSOR_UNITS.md‎

Lines changed: 295 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,295 @@
1+
# OpenLog Artemis : Sensor Units
2+
3+
This document summarizes the units used for each sensor measurement.
4+
5+
---
6+
## Index
7+
8+
### Built-in Inertial Measurement Unit:
9+
10+
- [ICM-20948 IMU](ICM-20948-IMU)
11+
12+
### Global Navigation Satellite System (GNSS) navigation data:
13+
14+
- [u-blox GNSS boards](u-blox-GNSS-boards)
15+
16+
### Pressure, Altitude, Humidity and Temperature Data:
17+
18+
- [BME280 atmospheric sensor](BME280-atmospheric-sensor)
19+
- [LPS25HB absolute pressure sensor](LPS25HB-absolute-pressure-sensor)
20+
- [MS8607 PHT sensor](MS8607-PHT-sensor)
21+
- [MPR0025PA MicroPressure sensor](MPR0025PA-MicroPressure-sensor)
22+
- [MS5637 barometric pressure sensor](MS5637-barometric-pressure-sensor)
23+
- [AHT20 humidity and temperature sensor](AHT20-humidity-and-temperature-sensor)
24+
- [SHTC3 humidity and temperature sensor](SHTC3-humidity-and-temperature-sensor)
25+
26+
### Air Quality and Environmental Sensors:
27+
28+
- [CCS811 air quality sensor](CCS811-air-quality-sensor)
29+
- [VEML6075 UV light sensor](VEML6075-UV-light-sensor)
30+
- [SGP30 air quality and Volatile Organic Compound (VOC) sensor](SGP30-air-quality-and-VOC-sensor)
31+
- [SCD30 CO2 humidity and temperature sensor](SCD30-CO2-humidity-and-temperature-sensor)
32+
- [SN-GCJA5 Particle Sensor](SN-GCJA5-Particle-Sensor)
33+
34+
### Distance:
35+
36+
- [VL53L1X laser Time of Flight (ToF) sensor](VL53L1X-laser-ToF-sensor)
37+
- [VCNL4040 proximity sensor](VCNL4040-proximity-sensor)
38+
39+
### Precision Temperature Sensors:
40+
41+
- [MCP9600 thermocouple amplifier](MCP9600-thermocouple-amplifier)
42+
- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor)
43+
- [TMP117 precision temperature sensor](TMP117-precision-temperature-sensor)
44+
45+
### Weight:
46+
47+
- [NAU7802 load cell sensor](NAU7802-load-cell-sensor)
48+
49+
### ADC:
50+
51+
- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor)
52+
53+
---
54+
## Sensor Units
55+
56+
---
57+
## ICM-20948 IMU
58+
59+
| []() | | |
60+
|---|---|---|
61+
| Accelerometer | aX,aY,aZ | milli g |
62+
| Gyro | gX,gY,gZ | Degrees per Second |
63+
| Magnetometer | mX,mY,mZ | micro Tesla |
64+
| Temperature | imu_degC | Degrees Centigrade |
65+
66+
---
67+
## u-blox GNSS boards
68+
69+
| []() | | |
70+
|---|---|---|
71+
| Date | gps_Date | MM/DD/YYYY or DD/MM/YYYY |
72+
| Time | gps_Time | HH:MM:SS.SSS |
73+
| Lat & Lon | gps_Lat,gps_Long | Degrees<sup>-7</sup> |
74+
| Altitude | gps_Alt | mm |
75+
| Altitude MSL | gps_AltMSL | mm |
76+
| SIV | gps_SIV | Count |
77+
| Fix Type | gps_FixType | 0-4 |
78+
| Carrier Soln. | gps_CarrierSolution | 0-2 |
79+
| Ground Speed | gps_GroundSpeed | mm/s |
80+
| Heading | gps_Heading | Degrees<sup>-7</sup> |
81+
| PDOP | gps_pDOP | m<sup>-2</sup> |
82+
| Time Of Week | gps_iTOW | Seconds |
83+
84+
Lat = Latitude
85+
Lon = Longitude
86+
MSL = Metres above Sea Level
87+
SIV = Satellites In View
88+
PDOP = Positional Dilution Of Precision
89+
90+
Fix Type:
91+
0: No
92+
3: 3D
93+
4: GNSS + Dead Reckoning
94+
95+
Carrier Solution:
96+
0: No
97+
1: Float Solution
98+
2: Fixed Solution
99+
100+
---
101+
## BME280 atmospheric sensor
102+
103+
| []() | | |
104+
|---|---|---|
105+
| Pressure | pressure_Pa | Pascals |
106+
| Humidity | humidity_% | Percent |
107+
| Altitude | altitude_m | m |
108+
| Temperature | temp_degC | Degrees Centigrade |
109+
110+
---
111+
## LPS25HB absolute pressure sensor
112+
113+
| []() | | |
114+
|---|---|---|
115+
| Pressure | pressure_hPa | hectoPascals |
116+
| Temperature | pressure_degC | Degrees Centigrade |
117+
118+
---
119+
## MS8607 PHT sensor
120+
121+
| []() | | |
122+
|---|---|---|
123+
| Humidity | humidity_% | Percent |
124+
| Pressure | hPa | hectoPascals |
125+
| Temperature | degC | Degrees Centigrade |
126+
127+
---
128+
## MPR0025PA MicroPressure sensor
129+
130+
| []() | | |
131+
|---|---|---|
132+
| Pressure (PSI) | PSI | Pounds per Square Inch |
133+
| Pressure (Pa) | Pa | Pascals |
134+
| Pressure (kPa) | kPa | kiloPascals |
135+
| Pressure (torr) | torr | torr |
136+
| Pressure (inHg) | inHg | inches of Mercury |
137+
| Pressure (atm) | atm | atmospheres |
138+
| Pressure (bar) | bar | barometric pressure |
139+
140+
---
141+
## MS5637 barometric pressure sensor
142+
143+
| []() | | |
144+
|---|---|---|
145+
| Pressure | pressure_hPa | hectoPascals |
146+
| Temperature | pressure_degC | Degrees Centigrade |
147+
148+
---
149+
## AHT20 humidity and temperature sensor
150+
151+
| []() | | |
152+
|---|---|---|
153+
| Humidity | humidity_% | Percent |
154+
| Temperature | degC | Degrees Centigrade |
155+
156+
---
157+
## SHTC3 humidity and temperature sensor
158+
159+
| []() | | |
160+
|---|---|---|
161+
| Humidity | humidity_% | Percent |
162+
| Temperature | degC | Degrees Centigrade |
163+
164+
---
165+
## CCS811 air quality sensor
166+
167+
| []() | | |
168+
|---|---|---|
169+
| VOC | tvoc_ppb | Parts Per Billion |
170+
| CO<sub>2</sub> | co2_ppm | Parts Per Million |
171+
172+
VOC = Volatile Organic Compounds
173+
174+
---
175+
## VEML6075 UV light sensor
176+
177+
| []() | | |
178+
|---|---|---|
179+
| UVA | uva | |
180+
| UVB | uvb | |
181+
| UV Index | uvIndex | |
182+
183+
---
184+
## SGP30 air quality and VOC sensor
185+
186+
| []() | | |
187+
|---|---|---|
188+
| Total VOC | tvoc_ppb | Parts Per Billion |
189+
| CO<sub>2</sub> | co2_ppm | Parts Per Million |
190+
| H<sub>2</sub> | H2 | none |
191+
| Ethanol | ethanol | none |
192+
193+
---
194+
## SCD30 CO2 humidity and temperature sensor
195+
196+
| []() | | |
197+
|---|---|---|
198+
| CO<sub>2</sub> | co2_ppm | Parts Per Million |
199+
| Humidity | humidity_% | Percent |
200+
| Temperature | degC | Degrees Centigrade |
201+
202+
---
203+
## SN-GCJA5 Particle Sensor
204+
205+
| []() | | |
206+
|---|---|---|
207+
| Particle Density (1.0µm) | PM1_0 | µg/m<sup>3</sup> |
208+
| Particle Density (2.5µm) | PM2_5 | µg/m<sup>3</sup> |
209+
| Particle Density (10µm) | PM10 | µg/m<sup>3</sup> |
210+
| Particle Count (0.5µm) | PC0_5 | Count |
211+
| Particle Count (1.0µm) | PC1_0 | Count |
212+
| Particle Count (2.5µm) | PC2_5 | Count |
213+
| Particle Count (5.0µm) | PC5_0 | Count |
214+
| Particle Count (7.5µm) | PC7_5 | Count |
215+
| Particle Count (10µm) | PC10 | Count |
216+
| Sensor Status | Sensors | |
217+
| Photodiode Status | PD | 0-3 |
218+
| Laser Diode Status | LD | 0-3 |
219+
| Fan Status | Fan | 0-3 |
220+
221+
Sensor status:
222+
| []() | |
223+
|---|---|
224+
| | PD LD Fan |
225+
| 0 | 0 0 0 |
226+
| 1 | Any 1, nor 2 & 3 |
227+
| 2 | Any 2 |
228+
| 3 | Any 3 nor 2 |
229+
230+
PD status:
231+
0: Normal status
232+
1: Normal status (within -80% against initial value), with S/W correction
233+
2: Abnormal (below -90% against initial value), loss of function
234+
3: Abnormal (below -80% against initial value), with S/W correction
235+
236+
LD operational status:
237+
0: Normal status
238+
1: Normal status (within -70% against initial LOP), with S/W correction
239+
2: Abnormal (below -90% against initial LOP) or no LOP, loss of function
240+
3: Abnormal (below -70% against initial LOP), with S/W correction
241+
242+
Fan operational status:
243+
0: Normal status
244+
1: Normal status (1,000rpm or more), with S/W correction
245+
2: In initial calibration
246+
3: Abnormal (below 1,000rpm), out of control
247+
248+
---
249+
## VL53L1X laser ToF sensor
250+
251+
| []() | | |
252+
|---|---|---|
253+
| Distance | distance_mm | mm |
254+
| Range Status | distance_rangeStatus(0=good) | |
255+
| Signal Rate | distance_signalRate | |
256+
257+
---
258+
## VCNL4040 proximity sensor
259+
260+
| []() | | |
261+
|---|---|---|
262+
| Proximity | prox(no unit) | none |
263+
| Ambient Light | ambient_lux | |
264+
265+
---
266+
## MCP9600 thermocouple amplifier
267+
268+
| []() | | |
269+
|---|---|---|
270+
| Temperature | thermo_degC | Degrees Centigrade |
271+
| Ambient Temperature | thermo_ambientDegC | Degrees Centigrade |
272+
273+
---
274+
## Qwiic PT100 ADS122C04 platinum resistance sensor
275+
276+
| []() | | |
277+
|---|---|---|
278+
| Temperature (C) | degC | Degrees Centigrade |
279+
| Temperature (F) | degF | Degrees Fahrenheit |
280+
| Temperature Internal | degC | Degrees Centigrade |
281+
| Raw Voltage | V*2.048/2^23 | Volts * 2.048 / 2<sup>23</sup> |
282+
283+
---
284+
## TMP117 precision temperature sensor
285+
286+
| []() | | |
287+
|---|---|---|
288+
| Temperature | degC | Degrees Centigrade |
289+
290+
---
291+
## NAU7802 load cell sensor
292+
293+
| []() | | |
294+
|---|---|---|
295+
| Weight | weight(no unit) | none |

0 commit comments

Comments
 (0)