update build-CI, badges, minor edits (#4)

Author: RobTillaart

.arduino-ci.yml

@@ -2,6 +2,10 @@ compile:
  # Choosing to run compilation tests on 2 different Arduino platforms
  platforms:
  - uno
- - leonardo
- - due
- - zero
+ # - due
+ # - zero
+ # - leonardo
+ - m4
+ - esp32
+ # - esp8266
+ # - mega2560

.github/workflows/arduino_test_runner.yml

@@ -4,10 +4,14 @@ name: Arduino CI
 on: [push, pull_request]
 
 jobs:
- arduino_ci:
+ runTest:
  runs-on: ubuntu-latest
 
  steps:
  - uses: actions/checkout@v2
- - uses: Arduino-CI/action@master
- # Arduino-CI/action@v0.1.1
+ - uses: ruby/setup-ruby@v1
+ with:
+ ruby-version: 2.6
+ - run: |
+ gem install arduino_ci
+ arduino_ci.rb

README.md

@@ -1,8 +1,11 @@
 
 [![Arduino CI](https://github.com/RobTillaart/MultiMap/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/MultiMap/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/MultiMap/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/MultiMap/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/MultiMap/actions/workflows/jsoncheck.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/MultiMap/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/MultiMap.svg?maxAge=3600)](https://github.com/RobTillaart/MultiMap/releases)
 
+
 # MultiMap
 
 Arduino library for fast non-linear mapping or interpolation of values
@@ -44,6 +47,12 @@ See examples
 Please note the fail example as this shows that in the intern math overflow can happen.
 
 
-## TODO
+## Future
 
-Investigate class implementation for performance.
+- Investigate class implementation for performance / footprint
+- flag if input value was "IN_MIN" < input < "IN_MAX", 
+ now it is constrained without user being informed.
+- should the lookup tables be merged into one array of pairs?
+ - you cannot reuse e.g. the input array then.
+- 
+- 

examples/multimap_NTC/multimap_NTC.ino

@@ -6,6 +6,7 @@
 // DATE: 2020-04-09
 // (c) : MIT
 //
+// example uses multiMap to calculate the temperature from an 10K NTC.
 
 
 #include "MultiMap.h"
@@ -22,11 +23,13 @@ volatile float x, y, z;
 float in[] = {
  0, 1, 3, 8, 13, 20, 25, 32, 50, 60, 72, 85, 100, 145, 200, 250, 300, 400, 500, 600, 650, 700, 753, 800, 830, 870, 900, 936, 964, 985, 1000, 1017, 1023
 };
+
 float out[] = {
  -273.15, -71.65, -60.69, -49.81, -43.97, -38.50, -35.54, -32.16, -25.72, -22.95, -20.08, -17.37, -14.62, -7.90, -1.43, 3.57,
  8.08, 16.34, 24.30, 32.64, 37.17, 42.13, 48.05, 54.19, 58.75, 66.03, 72.87, 83.85, 96.51, 111.46, 129.49, 182.82, 301.82
 };
 
+
 int sz = 33;
 
 

examples/multimap_NTC_int_FAIL/multimap_NTC_int_FAIL.ino

@@ -27,6 +27,7 @@ volatile float x, y, z;
 int in[] = {
  0, 1, 3, 8, 13, 20, 25, 32, 50, 60, 72, 85, 100, 145, 200, 250, 300, 400, 500, 600, 650, 700, 753, 800, 830, 870, 900, 936, 964, 985, 1000, 1017, 1023
 };
+
 int out[] = {
  -27315, -7165, -6069, -4981, -4397, -3850, -3554, -3216, -2572, -2295, -2008, -1737, -1462, -790, -143, 357, 808, 1634, 2430, 3264, 
  3717, 4213, 4805, 5419, 5875, 6603, 7287, 8385, 9651, 11146, 12949, 18282, 30182

examples/multimap_distance/multimap_distance.ino

@@ -5,6 +5,7 @@
 // PURPOSE: demo
 // DATE: 2020-04-09
 //
+// example simulates the lookup graph of a distance sensor 
 
 
 #include "MultiMap.h"

examples/multimap_functions/multimap_functions.ino

@@ -6,6 +6,8 @@
 // DATE: 2020-04-09
 // (c) : MIT
 //
+// example show use of multiMap to approximate some well known functions.
+
 
 
 #include "MultiMap.h"

examples/multimap_timing/multimap_timing.ino

@@ -6,6 +6,7 @@
 // DATE: 2020-04-09
 // (c) : MIT
 //
+// example measures the performance of multiMap <int> vs <float>
 
 
 #include "MultiMap.h"
@@ -30,15 +31,20 @@ void setup()
  start = micros();
  float x = multiMap<int>(12, in, out, 3);
  stop = micros();
+ Serial.print("time <int>: \t");
  Serial.println(stop - start);
  Serial.println(x, 4);
  delay(10); // make sure print has ended
 
  start = micros();
  float y = multiMap<float>(12, fin, fout, 3);
  stop = micros();
+ Serial.print("time <float>: \t");
  Serial.println(stop - start);
  Serial.println(y, 4);
+ delay(10); // make sure print has ended
+
+ Serial.println("\ndone...");
 }
 
 

keywords.txt

@@ -1,6 +1,6 @@
-# Syntax Coloring Map For multiMap
+# Syntax Colouring Map For multiMap
 
-# Datatypes (KEYWORD1)
+# Data types (KEYWORD1)
 
 
 # Methods and Functions (KEYWORD2)