Arduino ci (#1)

* initial arduino-ci ==> **no** unit test as lib is too HW specific

Author: RobTillaart

.arduino-ci.yml

@@ -0,0 +1,6 @@
+compile:
+  # Choosing to run compilation tests on 2 different Arduino platforms
+  platforms:
+    - uno
+    - leonardo
+  

.github/workflows/arduino_test_runner.yml

@@ -0,0 +1,13 @@
+---
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  arduino_ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: Arduino-CI/action@master
+          #   Arduino-CI/action@v0.1.1

AsyncAnalog.cpp

@@ -1,27 +1,27 @@
 //
 //    FILE: AsyncAnalog.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 //    DATE: 2018-09-05
 // PURPOSE: async version of analogRead, prevent blocking wait
 //
 // backgrounder
 // https://www.avrfreaks.net/forum/tut-c-newbies-guide-avr-adc?name=PNphpBB2&file=viewtopic&t=56429
 //
 // HISTORY:
-// 0.1.0   2018-09-05 initial version, based upon analogRead()
-// 0.1.1   2020-03-26 minor refactor
-// 0.1.2   2020-05-27 update library.json
-//
+// 0.1.0   2018-09-05  initial version, based upon analogRead()
+// 0.1.1   2020-03-26  minor refactor
+// 0.1.2   2020-05-27  update library.json
+// 0.1.3   2020-12-12  added Arduino CI, minor fixes
 
-#include "AsyncAnalog.h"
 
+#include "AsyncAnalog.h"
 
 #if defined(ARDUINO_ARCH_AVR)
 
 AsyncAnalog::AsyncAnalog(const uint8_t pin)
 {
-    _pin = pin;
+  _pin = pin;
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   if (_pin >= 54) _pin -= 54;
 #else
@@ -67,6 +67,6 @@ int AsyncAnalog::value()
   return (high << 8) | low;
 }
 
-#endif		// ARDUINO_ARCH_AVR
+#endif        // ARDUINO_ARCH_AVR
 
 // -- END OF FILE --

AsyncAnalog.h

@@ -2,35 +2,40 @@
 //
 //    FILE: AsyncAnalog.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 //    DATE: 2018-09-05
 // PURPOSE: async version of analogRead
 //     URL: https://github.com/RobTillaart/AsyncAnalog
 //
 
 #if !defined(ARDUINO_ARCH_AVR)
-  #error “AsyncAnalog library 0.1.2 only supports boards with an AVR processor .”
-#endif
+
+  #error “AsyncAnalog library 0.1.3 only supports boards with an AVR processor .”
+  
+#else
+
 // (ARDUINO_ARCH_SAM) future
 
 
 #include "Arduino.h"
 #include "wiring_private.h"
 #include "pins_arduino.h"
 
-#define ASYNCANALOG_LIB_VERSION "0.1.2"
+#define ASYNCANALOG_LIB_VERSION "0.1.3"
 
 class AsyncAnalog
 {
 public:
-    AsyncAnalog(uint8_t pin);
+  AsyncAnalog(uint8_t pin);
 
-    void start();
-    bool ready();
-    int  value();
+  void start();
+  bool ready();
+  int  value();
 
 private:
-    uint8_t _pin;
+  uint8_t _pin;
 };
 
+#endif
+
 // -- END OF FILE --

README.md

@@ -1,3 +1,8 @@
+
+[![Arduino CI](https://github.com/RobTillaart/AsyncAnalog/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/AsyncAnalog/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/RobTillaart/AsyncAnalog.svg?maxAge=3600)](https://github.com/RobTillaart/AsyncAnalog/releases)
+
 # AsyncAnalog
 
 Arduino Library for async reading of an analog pin. **\[AVR ONLY\]**
@@ -8,23 +13,30 @@ AsyncAnalog is a library to read the analog port in an asynchronous way.
 This means that the user must explicitly **start** the ADC, check if it is **ready**
 and read out its **value**.
 
-By using this class, the user prevents the (112 uSec) blocking of the 
+By using this class, the user prevents the (~112 uSec) blocking of the 
 **analogRead()** call, and gives the user the ability to do some processing.
 
 The library works only for AVR boards now, other platforms might be supported in the future.
 
 As the UNO has only one ADC that is multiplexed, one can only read one analog pin
 in async way simultaneously.
 
-## Operation
+## Interface 
+
+- **AsyncAnalog(uint8_t pin)** constructor, defines the analog pin to use.
+    
 The library consists of three main function:
 
-* **void start()**
-* **bool ready()**
-* **int value()**
+- **void start()** triggers a new ADC reading.
+- **bool ready()** returns true if sample is complete
+- **int value()** returns the value 
+
+## Operation
 
 The example **asyncAnalogTest2.ino** shows a loop of 1000 analogReads and prints 
 over Serial at 115200 baud. The async test does this in less time. Note that faster
-baudrates shows an even bigger difference. 
+baudrates shows an even bigger difference.
+
+During the printing, the sampling continues.
 
 

keywords.txt

@@ -0,0 +1,15 @@
+# Syntax Coloring Map For AsyncAnalog
+
+# Datatypes (KEYWORD1)
+AsyncAnalog	KEYWORD1
+
+
+# Methods and Functions (KEYWORD2)
+start	KEYWORD2
+ready	KEYWORD2
+value	KEYWORD2
+
+
+# Constants (LITERAL1)
+ASYNCANALOG_LIB_VERSION	LITERAL1
+

library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/AsyncAnalog.git"
   },
-  "version":"0.1.2",
+  "version":"0.1.3",
   "frameworks": "arduino",
   "platforms": "*"
 }

library.properties

@@ -1,5 +1,5 @@
 name=AsyncAnalog
-version=0.1.2
+version=0.1.3
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino Library for async reading of an analog pin

test/unit_test_001.cpp_no_valid_test

@@ -0,0 +1,42 @@
+//
+//    FILE: unit_test_001.cpp
+//  AUTHOR: Rob Tillaart
+//    DATE: 2020-12-12
+// PURPOSE: unit tests for the AsyncAnalog
+//          https://github.com/RobTillaart/AsyncAnalog
+//          https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md
+//
+
+// supported assertions
+// ----------------------------
+// assertEqual(expected, actual)
+// assertNotEqual(expected, actual)
+// assertLess(expected, actual)
+// assertMore(expected, actual)
+// assertLessOrEqual(expected, actual)
+// assertMoreOrEqual(expected, actual)
+// assertTrue(actual)
+// assertFalse(actual)
+// assertNull(actual)
+
+#include <ArduinoUnitTests.h>
+
+#include "Arduino.h"
+#include "AsyncAnalog.h"
+
+unittest_setup()
+{
+}
+
+unittest_teardown()
+{
+}
+
+unittest(test_none)
+{
+  fprintf(stderr, "no unit test defined as library is HW specific");
+}
+
+unittest_main()
+
+// --------