add RP2040 to build-CI (#18)

RobTillaart · Nov 26, 2022 · 1c486ef · 1c486ef
1 parent b5ec971
commit 1c486ef
Show file tree

Hide file tree

Showing 7 changed files with 153 additions and 141 deletions.
diff --git a/.arduino-ci.yml b/.arduino-ci.yml
@@ -1,3 +1,18 @@
+platforms:
+  rpipico:
+    board: rp2040:rp2040:rpipico
+    package: rp2040:rp2040
+    gcc:
+      features:
+      defines:
+        - ARDUINO_ARCH_RP2040
+      warnings:
+      flags:
+
+packages:
+  rp2040:rp2040:
+    url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+
 compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
@@ -7,5 +22,6 @@ compile:
     # - leonardo
     - m4
     - esp32
-    # - esp8266
+    - esp8266
     # - mega2560
+    - rpipico
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,44 +6,32 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.3.4] - 2022-04-15
-
-### Added
+## [0.3.5] - 2022-11-26
+- added RP2040 to build-CI
+- simplified changelog
+- optimized Steadman's formula (HeatIndex).
+- update readme.md
 
-### Changed
 
-### Fixed
+## [0.3.4] - 2022-04-15
 - fix #16 Split .h in .h and .cpp 
 
-
 ## [0.3.3] - 2022-01-09
-
-### Added
-- added working limits to windchill() and heatIndex()
-
+- added working limits to windChill() and heatIndex()
 
 ## [0.3.2] - 2022-01-08
-
-### Added
 - added a TempConvertor class for more exotic scales.
 - added baroToSeaLevel() - kudos to RobertDB59
-
-### Fixed
--  Renamed Celcius to Celsius.
-
+- Renamed Celcius to Celsius.
 
 ## [0.3.1] - 2022-01-07
-
-### Fixed
-- fix adjustments
+- fix adjustments which were incorrectly added.
 
 ## [0.3.0] - 2022-01-05
-
-### Fixed
 - fix #10 update HeatIndex function
  compared with https://www.calculator.net/heat-index-calculator.html
 
-
+----
 
 ## [0.2.5] - 2021-12-28
 - Arduino-CI, library.json, readme.md, license, minor edits

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 # Temperature
 
-Arduino library with dewPoint, humidex, heatIndex and wind-chill functions.
+Arduino library with temperature conversion and weather functions including dewPoint, humidex, heatIndex and wind-chill.
 
 
 ## Description
@@ -31,7 +31,7 @@ Note: pre-0.3.1 versions have incorrect heat-index.
 - **float Celsius(float Fahrenheit)** idem.
 - **float Kelvin(float Celsius)** idem.
 
-More converters are implemented in tne **temperatureConverter()** below.
+More converters are implemented in the **temperatureConverter** class below.
 
 
 ### DewPoint, humidex
@@ -51,22 +51,18 @@ More converters are implemented in tne **temperatureConverter()** below.
 
 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.
+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   |
-
-
-#### 0.3.1
-
-Fixed the adjustment which was incorrectly added.
+|  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     |
 
 
 ### WindChill
@@ -81,15 +77,17 @@ else ==> formula assumes wind speed @ 1.5 meter
 
 Indicative table (subjective).
 
-| wind chill °C | description          |
-|:-------------:|:---------------------|
-|  > -10        |  cold                |
-|  -10 .. -25   |  very cold !         |
-|  -25 .. -35   |  very very cold !    |
-|  -35 .. -55   |  chance of frostbite |
-|  < -55        |  serious dangerous   |
+|  wind chill °C  |  description           |
+|:---------------:|:-----------------------|
+|    > -10        |  cold                  |
+|    -10 .. -25   |  very cold !           |
+|    -25 .. -35   |  very very cold !      |
+|    -35 .. -55   |  chance of frostbite   |
+|    < -55        |  serious dangerous     |
 
 
+----
+
 # temperatureConverter class
 
 Since version 0.3.2 a temperature convertor class is added to convert to and from 
@@ -101,23 +99,25 @@ See example.
 The scales are typically named after their inventor. 
 Check Wikipedia for details about the scales.
 
-| Name        | units | 1° in °K |    0°C  |   100°C | notes |
-|:------------|:-----:|:--------:|--------:|--------:|:------|
-| Celsius     |  °C   | 1.000000 |    0.00 |  100.00 |
-| Delisle     |  °De  | 0.666666 | -100.00 |   50.00 |
-| Fahrenheit  |  °F   | 0.555556 |   32.00 |  212.00 |
-| Kelvin      |  °K   | 1.000000 |  273.15 |  373.15 |
-| Newton      |  --   | 3.030303 |    0.00 |   33.00 | not the force.
-| Rankine     |  °Ra  | 0.555556 |  491.76 |  671.67 | 0°Ra == 0°K, steps == Fahrenheit.
-| Reamur      |  °Re  | 1.250000 |    0.00 |   80.00 |
-| Romer       |  °Ro  | 1.904762 |    7.50 |   60.00 |
+|  Name         |  units  |  1° in °K  |     0°C   |    100°C  |  notes  |
+|:--------------|:-------:|:----------:|----------:|----------:|:--------|
+|  Celsius      |   °C    |  1.000000  |     0.00  |   100.00  |
+|  Delisle      |   °De   |  0.666666  |  -100.00  |    50.00  |
+|  Fahrenheit   |   °F    |  0.555556  |    32.00  |   212.00  |
+|  Kelvin       |   °K    |  1.000000  |   273.15  |   373.15  |
+|  Newton       |   --    |  3.030303  |     0.00  |    33.00  |  not the force.
+|  Rankine      |   °Ra   |  0.555556  |   491.76  |   671.67  |  0°Ra == 0°K, steps == Fahrenheit.
+|  Reamur       |   °Re   |  1.250000  |     0.00  |    80.00  |
+|  Romer        |   °Ro   |  1.904762  |     7.50  |    60.00  |
 
 Note: units to be verified.
 
 Note: this class is slightly slower than direct conversion, but it 
 prevents to have 8 x 7 optimized functions.
 
 
+## Interface
+
 #### Constructor
 
 - **temperatureConverter()** Constructor sets the default to zero degrees C.
@@ -158,6 +158,14 @@ See examples for typical usage.
 
 # Future
 
+#### must
+
+#### should
 - improve documentation
   - add short explanation?
-- 
+- add formula for water boiling height 
+  - https://en.wikipedia.org/wiki/High-altitude_cooking
+  - multiMap needed?
+
+#### could
+
diff --git a/library.json b/library.json
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/Temperature"
   },
-  "version": "0.3.4",
+  "version": "0.3.5",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",

diff --git a/library.properties b/library.properties
@@ -1,8 +1,8 @@
 name=Temperature
-version=0.3.4
+version=0.3.5
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
-sentence=Library with weather related functions. 
+sentence=Library with weather and temperature conversion functions.
 paragraph=Kelvin Celsius Fahrenheit dewPoint humidex heatIndex windChill
 category=Data Processing
 url=https://github.com/RobTillaart/Temperature