From f4c23c095afcefb5c4c90811ac97f8b86e3d036e Mon Sep 17 00:00:00 2001 From: PaulZC Date: Wed, 14 Oct 2020 08:25:24 +0100 Subject: [PATCH 1/4] Added SENSOR_UNITS.md --- README.md | 3 +- SENSOR_UNITS.md | 295 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 297 insertions(+), 1 deletion(-) create mode 100644 SENSOR_UNITS.md diff --git a/README.md b/README.md index 95e94d6..7adc953 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,8 @@ Documentation * **[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). * **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library. * **[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. -* **[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... +* **[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. +* **[SENSOR_UNITS.md](./SENSOR_UNITS.md)** - contains a summary of the units used by each sensor reading. License Information ------------------- diff --git a/SENSOR_UNITS.md b/SENSOR_UNITS.md new file mode 100644 index 0000000..d207087 --- /dev/null +++ b/SENSOR_UNITS.md @@ -0,0 +1,295 @@ +# OpenLog Artemis : Sensor Units + +This document summarizes the units used for each sensor measurement. + +--- +## Index + +### Built-in Inertial Measurement Unit: + +- [ICM-20948 IMU](ICM-20948-IMU) + +### Global Navigation Satellite System (GNSS) navigation data: + +- [u-blox GNSS boards](u-blox-GNSS-boards) + +### Pressure, Altitude, Humidity and Temperature Data: + +- [BME280 atmospheric sensor](BME280-atmospheric-sensor) +- [LPS25HB absolute pressure sensor](LPS25HB-absolute-pressure-sensor) +- [MS8607 PHT sensor](MS8607-PHT-sensor) +- [MPR0025PA MicroPressure sensor](MPR0025PA-MicroPressure-sensor) +- [MS5637 barometric pressure sensor](MS5637-barometric-pressure-sensor) +- [AHT20 humidity and temperature sensor](AHT20-humidity-and-temperature-sensor) +- [SHTC3 humidity and temperature sensor](SHTC3-humidity-and-temperature-sensor) + +### Air Quality and Environmental Sensors: + +- [CCS811 air quality sensor](CCS811-air-quality-sensor) +- [VEML6075 UV light sensor](VEML6075-UV-light-sensor) +- [SGP30 air quality and Volatile Organic Compound (VOC) sensor](SGP30-air-quality-and-VOC-sensor) +- [SCD30 CO2 humidity and temperature sensor](SCD30-CO2-humidity-and-temperature-sensor) +- [SN-GCJA5 Particle Sensor](SN-GCJA5-Particle-Sensor) + +### Distance: + +- [VL53L1X laser Time of Flight (ToF) sensor](VL53L1X-laser-ToF-sensor) +- [VCNL4040 proximity sensor](VCNL4040-proximity-sensor) + +### Precision Temperature Sensors: + +- [MCP9600 thermocouple amplifier](MCP9600-thermocouple-amplifier) +- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor) +- [TMP117 precision temperature sensor](TMP117-precision-temperature-sensor) + +### Weight: + +- [NAU7802 load cell sensor](NAU7802-load-cell-sensor) + +### ADC: + +- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor) + +--- +## Sensor Units + +--- +## ICM-20948 IMU + +| []() | | | +|---|---|---| +| Accelerometer | aX,aY,aZ | milli g | +| Gyro | gX,gY,gZ | Degrees per Second | +| Magnetometer | mX,mY,mZ | micro Tesla | +| Temperature | imu_degC | Degrees Centigrade | + +--- +## u-blox GNSS boards + +| []() | | | +|---|---|---| +| Date | gps_Date | MM/DD/YYYY or DD/MM/YYYY | +| Time | gps_Time | HH:MM:SS.SSS | +| Lat & Lon | gps_Lat,gps_Long | Degrees-7 | +| Altitude | gps_Alt | mm | +| Altitude MSL | gps_AltMSL | mm | +| SIV | gps_SIV | Count | +| Fix Type | gps_FixType | 0-4 | +| Carrier Soln. | gps_CarrierSolution | 0-2 | +| Ground Speed | gps_GroundSpeed | mm/s | +| Heading | gps_Heading | Degrees-7 | +| PDOP | gps_pDOP | m-2 | +| Time Of Week | gps_iTOW | Seconds | + +Lat = Latitude +Lon = Longitude +MSL = Metres above Sea Level +SIV = Satellites In View +PDOP = Positional Dilution Of Precision + +Fix Type: +0: No +3: 3D +4: GNSS + Dead Reckoning + +Carrier Solution: +0: No +1: Float Solution +2: Fixed Solution + +--- +## BME280 atmospheric sensor + +| []() | | | +|---|---|---| +| Pressure | pressure_Pa | Pascals | +| Humidity | humidity_% | Percent | +| Altitude | altitude_m | m | +| Temperature | temp_degC | Degrees Centigrade | + +--- +## LPS25HB absolute pressure sensor + +| []() | | | +|---|---|---| +| Pressure | pressure_hPa | hectoPascals | +| Temperature | pressure_degC | Degrees Centigrade | + +--- +## MS8607 PHT sensor + +| []() | | | +|---|---|---| +| Humidity | humidity_% | Percent | +| Pressure | hPa | hectoPascals | +| Temperature | degC | Degrees Centigrade | + +--- +## MPR0025PA MicroPressure sensor + +| []() | | | +|---|---|---| +| Pressure (PSI) | PSI | Pounds per Square Inch | +| Pressure (Pa) | Pa | Pascals | +| Pressure (kPa) | kPa | kiloPascals | +| Pressure (torr) | torr | torr | +| Pressure (inHg) | inHg | inches of Mercury | +| Pressure (atm) | atm | atmospheres | +| Pressure (bar) | bar | barometric pressure | + +--- +## MS5637 barometric pressure sensor + +| []() | | | +|---|---|---| +| Pressure | pressure_hPa | hectoPascals | +| Temperature | pressure_degC | Degrees Centigrade | + +--- +## AHT20 humidity and temperature sensor + +| []() | | | +|---|---|---| +| Humidity | humidity_% | Percent | +| Temperature | degC | Degrees Centigrade | + +--- +## SHTC3 humidity and temperature sensor + +| []() | | | +|---|---|---| +| Humidity | humidity_% | Percent | +| Temperature | degC | Degrees Centigrade | + +--- +## CCS811 air quality sensor + +| []() | | | +|---|---|---| +| VOC | tvoc_ppb | Parts Per Billion | +| CO2 | co2_ppm | Parts Per Million | + +VOC = Volatile Organic Compounds + +--- +## VEML6075 UV light sensor + +| []() | | | +|---|---|---| +| UVA | uva | | +| UVB | uvb | | +| UV Index | uvIndex | | + +--- +## SGP30 air quality and VOC sensor + +| []() | | | +|---|---|---| +| Total VOC | tvoc_ppb | Parts Per Billion | +| CO2 | co2_ppm | Parts Per Million | +| H2 | H2 | none | +| Ethanol | ethanol | none | + +--- +## SCD30 CO2 humidity and temperature sensor + +| []() | | | +|---|---|---| +| CO2 | co2_ppm | Parts Per Million | +| Humidity | humidity_% | Percent | +| Temperature | degC | Degrees Centigrade | + +--- +## SN-GCJA5 Particle Sensor + +| []() | | | +|---|---|---| +| Particle Density (1.0µm) | PM1_0 | µg/m3 | +| Particle Density (2.5µm) | PM2_5 | µg/m3 | +| Particle Density (10µm) | PM10 | µg/m3 | +| Particle Count (0.5µm) | PC0_5 | Count | +| Particle Count (1.0µm) | PC1_0 | Count | +| Particle Count (2.5µm) | PC2_5 | Count | +| Particle Count (5.0µm) | PC5_0 | Count | +| Particle Count (7.5µm) | PC7_5 | Count | +| Particle Count (10µm) | PC10 | Count | +| Sensor Status | Sensors | | +| Photodiode Status | PD | 0-3 | +| Laser Diode Status | LD | 0-3 | +| Fan Status | Fan | 0-3 | + +Sensor status: +| []() | | +|---|---| +| | PD LD Fan | +| 0 | 0 0 0 | +| 1 | Any 1, nor 2 & 3 | +| 2 | Any 2 | +| 3 | Any 3 nor 2 | + +PD status: +0: Normal status +1: Normal status (within -80% against initial value), with S/W correction +2: Abnormal (below -90% against initial value), loss of function +3: Abnormal (below -80% against initial value), with S/W correction + +LD operational status: +0: Normal status +1: Normal status (within -70% against initial LOP), with S/W correction +2: Abnormal (below -90% against initial LOP) or no LOP, loss of function +3: Abnormal (below -70% against initial LOP), with S/W correction + +Fan operational status: +0: Normal status +1: Normal status (1,000rpm or more), with S/W correction +2: In initial calibration +3: Abnormal (below 1,000rpm), out of control + +--- +## VL53L1X laser ToF sensor + +| []() | | | +|---|---|---| +| Distance | distance_mm | mm | +| Range Status | distance_rangeStatus(0=good) | | +| Signal Rate | distance_signalRate | | + +--- +## VCNL4040 proximity sensor + +| []() | | | +|---|---|---| +| Proximity | prox(no unit) | none | +| Ambient Light | ambient_lux | | + +--- +## MCP9600 thermocouple amplifier + +| []() | | | +|---|---|---| +| Temperature | thermo_degC | Degrees Centigrade | +| Ambient Temperature | thermo_ambientDegC | Degrees Centigrade | + +--- +## Qwiic PT100 ADS122C04 platinum resistance sensor + +| []() | | | +|---|---|---| +| Temperature (C) | degC | Degrees Centigrade | +| Temperature (F) | degF | Degrees Fahrenheit | +| Temperature Internal | degC | Degrees Centigrade | +| Raw Voltage | V*2.048/2^23 | Volts * 2.048 / 223 | + +--- +## TMP117 precision temperature sensor + +| []() | | | +|---|---|---| +| Temperature | degC | Degrees Centigrade | + +--- +## NAU7802 load cell sensor + +| []() | | | +|---|---|---| +| Weight | weight(no unit) | none | From 8f5960674e0ec3ab1b0e012cdabc0afd424705cb Mon Sep 17 00:00:00 2001 From: PaulZC Date: Wed, 14 Oct 2020 08:28:29 +0100 Subject: [PATCH 2/4] Updated SENSOR_UNITS.md --- README.md | 2 +- SENSOR_UNITS.md | 42 +++++++++++++++++++++--------------------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7adc953..3e59633 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Documentation * **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library. * **[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. * **[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. -* **[SENSOR_UNITS.md](./SENSOR_UNITS.md)** - contains a summary of the units used by each sensor reading. +* **[SENSOR_UNITS.md](./SENSOR_UNITS.md)** - contains a summary of the units used for each sensor measurement. License Information ------------------- diff --git a/SENSOR_UNITS.md b/SENSOR_UNITS.md index d207087..113d58f 100644 --- a/SENSOR_UNITS.md +++ b/SENSOR_UNITS.md @@ -7,48 +7,48 @@ This document summarizes the units used for each sensor measurement. ### Built-in Inertial Measurement Unit: -- [ICM-20948 IMU](ICM-20948-IMU) +- [ICM-20948 IMU](#ICM-20948-IMU) ### Global Navigation Satellite System (GNSS) navigation data: -- [u-blox GNSS boards](u-blox-GNSS-boards) +- [u-blox GNSS boards](#u-blox-GNSS-boards) ### Pressure, Altitude, Humidity and Temperature Data: -- [BME280 atmospheric sensor](BME280-atmospheric-sensor) -- [LPS25HB absolute pressure sensor](LPS25HB-absolute-pressure-sensor) -- [MS8607 PHT sensor](MS8607-PHT-sensor) -- [MPR0025PA MicroPressure sensor](MPR0025PA-MicroPressure-sensor) -- [MS5637 barometric pressure sensor](MS5637-barometric-pressure-sensor) -- [AHT20 humidity and temperature sensor](AHT20-humidity-and-temperature-sensor) -- [SHTC3 humidity and temperature sensor](SHTC3-humidity-and-temperature-sensor) +- [BME280 atmospheric sensor](#BME280-atmospheric-sensor) +- [LPS25HB absolute pressure sensor](#LPS25HB-absolute-pressure-sensor) +- [MS8607 PHT sensor](#MS8607-PHT-sensor) +- [MPR0025PA MicroPressure sensor](#MPR0025PA-MicroPressure-sensor) +- [MS5637 barometric pressure sensor](#MS5637-barometric-pressure-sensor) +- [AHT20 humidity and temperature sensor](#AHT20-humidity-and-temperature-sensor) +- [SHTC3 humidity and temperature sensor](#SHTC3-humidity-and-temperature-sensor) ### Air Quality and Environmental Sensors: -- [CCS811 air quality sensor](CCS811-air-quality-sensor) -- [VEML6075 UV light sensor](VEML6075-UV-light-sensor) -- [SGP30 air quality and Volatile Organic Compound (VOC) sensor](SGP30-air-quality-and-VOC-sensor) -- [SCD30 CO2 humidity and temperature sensor](SCD30-CO2-humidity-and-temperature-sensor) -- [SN-GCJA5 Particle Sensor](SN-GCJA5-Particle-Sensor) +- [CCS811 air quality sensor](#CCS811-air-quality-sensor) +- [VEML6075 UV light sensor](#VEML6075-UV-light-sensor) +- [SGP30 air quality and Volatile Organic Compound (VOC) sensor](#SGP30-air-quality-and-VOC-sensor) +- [SCD30 CO2 humidity and temperature sensor](#SCD30-CO2-humidity-and-temperature-sensor) +- [SN-GCJA5 Particle Sensor](#SN-GCJA5-Particle-Sensor) ### Distance: -- [VL53L1X laser Time of Flight (ToF) sensor](VL53L1X-laser-ToF-sensor) -- [VCNL4040 proximity sensor](VCNL4040-proximity-sensor) +- [VL53L1X laser Time of Flight (ToF) sensor](#VL53L1X-laser-ToF-sensor) +- [VCNL4040 proximity sensor](#VCNL4040-proximity-sensor) ### Precision Temperature Sensors: -- [MCP9600 thermocouple amplifier](MCP9600-thermocouple-amplifier) -- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor) -- [TMP117 precision temperature sensor](TMP117-precision-temperature-sensor) +- [MCP9600 thermocouple amplifier](#MCP9600-thermocouple-amplifier) +- [Qwiic PT100 ADS122C04 platinum resistance sensor](#Qwiic-PT100-ADS122C04-platinum-resistance-sensor) +- [TMP117 precision temperature sensor](#TMP117-precision-temperature-sensor) ### Weight: -- [NAU7802 load cell sensor](NAU7802-load-cell-sensor) +- [NAU7802 load cell sensor](#NAU7802-load-cell-sensor) ### ADC: -- [Qwiic PT100 ADS122C04 platinum resistance sensor](Qwiic-PT100-ADS122C04-platinum-resistance-sensor) +- [Qwiic PT100 ADS122C04 platinum resistance sensor](#Qwiic-PT100-ADS122C04-platinum-resistance-sensor) --- ## Sensor Units From 2a99ba6860823370e81fb1fc8726a24b8127fd74 Mon Sep 17 00:00:00 2001 From: PaulZC Date: Wed, 14 Oct 2020 09:47:22 +0100 Subject: [PATCH 3/4] Update SENSOR_UNITS.md --- SENSOR_UNITS.md | 64 ++++++++++++++++++++++++------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/SENSOR_UNITS.md b/SENSOR_UNITS.md index 113d58f..8e3016a 100644 --- a/SENSOR_UNITS.md +++ b/SENSOR_UNITS.md @@ -81,21 +81,21 @@ This document summarizes the units used for each sensor measurement. | PDOP | gps_pDOP | m-2 | | Time Of Week | gps_iTOW | Seconds | -Lat = Latitude -Lon = Longitude -MSL = Metres above Sea Level -SIV = Satellites In View -PDOP = Positional Dilution Of Precision - -Fix Type: -0: No -3: 3D -4: GNSS + Dead Reckoning - -Carrier Solution: -0: No -1: Float Solution -2: Fixed Solution +Lat = Latitude +Lon = Longitude +MSL = Metres above Sea Level +SIV = Satellites In View +PDOP = Positional Dilution Of Precision + +Fix Type: +0: No +3: 3D +4: GNSS + Dead Reckoning + +Carrier Solution: +0: No +1: Float Solution +2: Fixed Solution --- ## BME280 atmospheric sensor @@ -227,23 +227,23 @@ Sensor status: | 2 | Any 2 | | 3 | Any 3 nor 2 | -PD status: -0: Normal status -1: Normal status (within -80% against initial value), with S/W correction -2: Abnormal (below -90% against initial value), loss of function -3: Abnormal (below -80% against initial value), with S/W correction - -LD operational status: -0: Normal status -1: Normal status (within -70% against initial LOP), with S/W correction -2: Abnormal (below -90% against initial LOP) or no LOP, loss of function -3: Abnormal (below -70% against initial LOP), with S/W correction - -Fan operational status: -0: Normal status -1: Normal status (1,000rpm or more), with S/W correction -2: In initial calibration -3: Abnormal (below 1,000rpm), out of control +PD status: +0: Normal status +1: Normal status (within -80% against initial value), with S/W correction +2: Abnormal (below -90% against initial value), loss of function +3: Abnormal (below -80% against initial value), with S/W correction + +LD operational status: +0: Normal status +1: Normal status (within -70% against initial LOP), with S/W correction +2: Abnormal (below -90% against initial LOP) or no LOP, loss of function +3: Abnormal (below -70% against initial LOP), with S/W correction + +Fan operational status: +0: Normal status +1: Normal status (1,000rpm or more), with S/W correction +2: In initial calibration +3: Abnormal (below 1,000rpm), out of control --- ## VL53L1X laser ToF sensor From 0b2feb1646bc1ffbb410b0f5959fee4271a5d111 Mon Sep 17 00:00:00 2001 From: PaulZC Date: Wed, 14 Oct 2020 10:02:04 +0100 Subject: [PATCH 4/4] Update SENSOR_UNITS.md --- SENSOR_UNITS.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/SENSOR_UNITS.md b/SENSOR_UNITS.md index 8e3016a..7b756a9 100644 --- a/SENSOR_UNITS.md +++ b/SENSOR_UNITS.md @@ -74,12 +74,12 @@ This document summarizes the units used for each sensor measurement. | Altitude | gps_Alt | mm | | Altitude MSL | gps_AltMSL | mm | | SIV | gps_SIV | Count | -| Fix Type | gps_FixType | 0-4 | +| Fix Type | gps_FixType | 0-5 | | Carrier Soln. | gps_CarrierSolution | 0-2 | | Ground Speed | gps_GroundSpeed | mm/s | -| Heading | gps_Heading | Degrees-7 | +| Heading | gps_Heading | Degrees-5 | | PDOP | gps_pDOP | m-2 | -| Time Of Week | gps_iTOW | Seconds | +| Time Of Week | gps_iTOW | ms | Lat = Latitude Lon = Longitude @@ -89,8 +89,11 @@ PDOP = Positional Dilution Of Precision Fix Type: 0: No +1: Dead Reckoning Only +2: 2D 3: 3D 4: GNSS + Dead Reckoning +5: Time Only Carrier Solution: 0: No