GY-63_MS5611/libraries/Temperature/readme.md

87 lines
3.1 KiB
Markdown
Raw Normal View History

2021-01-29 06:31:58 -05:00
[![Arduino CI](https://github.com/RobTillaart/Temperature/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
2021-12-28 13:11:26 -05:00
[![Arduino-lint](https://github.com/RobTillaart/Temperature/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Temperature/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/Temperature/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/Temperature/actions/workflows/jsoncheck.yml)
2021-01-29 06:31:58 -05:00
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/Temperature/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/Temperature.svg?maxAge=3600)](https://github.com/RobTillaart/Temperature/releases)
2020-11-27 05:33:55 -05:00
# Temperature
2015-03-07 16:44:21 -05:00
2021-12-28 13:11:26 -05:00
Arduino library with dewPoint, humidex, heatIndex and wind-chill functions.
2015-03-07 16:44:21 -05:00
2021-01-29 06:31:58 -05:00
2020-11-27 05:33:55 -05:00
## Description
2015-03-07 16:44:21 -05:00
2021-01-29 06:31:58 -05:00
This library contains weather related functions.
These functions are approximations based on work of NOAA a.o.
2020-11-27 05:33:55 -05:00
These functions can be used with temperature and humidity sensors e.g.
2021-01-29 06:31:58 -05:00
DHT22 or Sensirion, to make a weather station application.
## Interface
### Conversion
2021-12-28 13:11:26 -05:00
- **float Fahrenheit(float Celsius)** idem.
- **float Celsius(float Fahrenheit)** idem.
- **float Kelvin(float Celsius)** idem.
2021-01-29 06:31:58 -05:00
### DewPoint, humidex
2021-12-28 13:11:26 -05:00
- **float dewPoint(float Celsius, float humidity)** idem.
- **float dewPointFast(float Celsius, float humidity)** idem.
- **float humidex(float Celsius, float dewPoint)** idem.
2021-01-29 06:31:58 -05:00
### heatIndex
2021-12-28 13:11:26 -05:00
- **float heatIndex(float Fahrenheit, float humidity)** idem.
- **float heatIndexC(float Celsius, float humidity)** idem.
2021-01-29 06:31:58 -05:00
2022-01-06 09:32:26 -05:00
**0.3.0**
The formula for the **heatIndex()** was taken from https://en.wikipedia.org/wiki/Heat_index.
Since version 0.3.0 the more elaborated version of https://www.wpc.ncep.noaa.gov/html/heatindex_equation.shtml
will be used. Note: there will be performance differences.
Indicative table
| Fahrenheit | Celsius | description | colour code |
|:----------:|:-------:|:------------|------------:|
| 70-79 | 21-26 | warm | green |
| 80-89 | 26-32 | very warm | yellow |
| 90-104 | 32-40 | hot | orange |
| 105-129 | 40-54 | very hot | red |
| > 130 | > 54 | extreme hot | purple |
2021-01-29 06:31:58 -05:00
### WindChill
2021-12-28 13:11:26 -05:00
Wind speed @ 10 meter, if **convert** is true => wind speed will be converted to 1.5 meter
else ==> formula assumes wind speed @ 1.5 meter
2021-01-29 06:31:58 -05:00
2021-12-28 13:11:26 -05:00
- **float WindChill_F_mph(float Fahrenheit, float milesPerHour, bool convert = true)**
- **float WindChill_C_kmph(float Celsius, float kilometerPerHour, bool convert = true)**
- **float WindChill_C_mps(float Celsius, float meterPerSecond, bool convert = true)**
2020-11-27 05:33:55 -05:00
## Operations
The functions have a limited scope so one cannot use it for all input values possible.
The user should be aware of that. Check the references mentioned in the code and or
2021-12-28 13:11:26 -05:00
Wikipedia to confirm the applicability of the values generated.
2020-11-27 05:33:55 -05:00
The functions do not check the inputs.
See examples for typical usage.
2021-12-28 13:11:26 -05:00
# Future
- improve documentation
- expand number of formulas
-