Documentation

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -33,15 +33,15 @@ jobs:
           - ATTinyCore:avr:attinyx5:chip=85,clock=1internal
 
         # Specify parameters for each board.
-        # Parameters can be: examples-exclude and examples-build-properties
+        # With examples-exclude you may exclude specific examples for a board. Use a comma separated list.
         #############################################################################################################
         include:
           - arduino-boards-fqbn: arduino:avr:uno
-            examples-exclude: 50Hz # Space separated list of (unique substrings of) example names to exclude in build
+            examples-exclude: 50Hz # Comma separated list of (unique substrings of) example names to exclude in build
 
           - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal
             platform-url: http://drazzy.com/package_drazzy.com_index.json
-            examples-exclude: TraceTest # Space separated list of (unique substrings of) example names to exclude in build
+            examples-exclude: TraceTest # Comma separated list of (unique substrings of) example names to exclude in build
 
       # Do not cancel all jobs / architectures if one job fails
       fail-fast: false

README.md

@@ -7,9 +7,11 @@
 
 ### ADCUtils.cpp
 - Fast and flexible ADC conversions.
+
 ### HCSR04
 - Blocking and **non-blocking** reading of HCSR04 US Sensors with timeouts and exact conversions.
-- Supports also **1 Pin mode** available with the HY-SRF05 or Parallax PING modules. 
+- Supports also **1 Pin mode** available with the HY-SRF05 or Parallax PING modules.
+
 #### You can modify the HCSR04 modules to 1 Pin mode by:
 1 Old module with 3 16 pin chips: Connect Trigger and Echo direct or use a resistor < 4.7 kOhm. 
 If you remove both 10 kOhm pullup resistor you can use a connecting resistor < 47 kOhm, but I suggest to use 10 kOhm which is more reliable.
@@ -19,15 +21,20 @@ If you remove both 10 kOhm pullup resistor you can use a connecting resistor < 4
 
 ### BlinkLed.cpp
 - Class for blinking one ore more LED's in different fashions.
+
 ### ShowInfo
 - Serial.print display of timer and other peripheral and system registers (to be extended :-)).
+
 ### AVRUtils.cpp
 - Sleep and sleep with watchdog functions.
 - Available Ram, Heap / Stack memory display.
+
 ### MillisUtils.cpp
 - Tweaking `millis()` after long running tasks in `noIterrupt()` context like NeoPixel output, ADC buffer reading etc.
+
 ### DebugLevel.h
 - Propagating debug levels for development. Supports level `TRACE, DEBUG, INFO, WARN and ERROR`. **Explains semantics of these levels**.
+
 ### ATtinyUtils.cpp
 - `changeDigisparkClock()` to use Digispark boards with standard ATtiny code like ATTinyCore by [Spence Konde](https://github.com/SpenceKonde/ATTinyCore). 
 It changes Digispark Bootloader clock settings to get the right CPU frequency and resets Digispark OCCAL tweak.
@@ -57,6 +64,7 @@ To access the Arduino library files from a sketch, you have to first use *Sketch
 Then navigate to the parallel `libraries` folder and select the library you want to access.<br/>
 The library files itself are located in the `src` sub-directory.<br/>
 If you did not yet store the example as your own sketch, then with *Ctrl+K* you are instantly in the right library folder.
+
 ## Consider to use [Sloeber](http://eclipse.baeyens.it/stable.php?OS=Windows) as IDE
 If you are using Sloeber as your IDE, you can easily define global symbols at *Properties/Arduino/CompileOptions*.<br/>
 ![Sloeber settings](https://github.com/ArminJo/ServoEasing/blob/master/pictures/SloeberDefineSymbols.png)

examples/50Hz/ATtinySerialOut.cpp

@@ -12,7 +12,7 @@
  * Using the Serial.print commands needs 4 bytes extra for each call.
  *
  *
- *  Copyright (C) 2015-2019  Armin Joachimsmeyer
+ *  Copyright (C) 2015-2020  Armin Joachimsmeyer
  *  Email: [email protected]
  *
  *  This file is part of TinySerialOut https://github.com/ArminJo/ATtinySerialOut.

examples/50Hz/ATtinySerialOut.h

@@ -1,7 +1,7 @@
 /*
  * ATtinySerialOut.h
  *
- *  Copyright (C) 2015-2019  Armin Joachimsmeyer
+ *  Copyright (C) 2015-2020  Armin Joachimsmeyer
  *  Email: [email protected]
  *
  *  This file is part of TinySerialOut https://github.com/ArminJo/ATtinySerialOut.

src/ATtinyUtils.h

@@ -24,12 +24,12 @@
 //
 // ATMEL ATTINY85
 //
-//                                        +-\/-+
-//        PCINT5/!RESET/ADC0/dW (5) PB5  1|    |8  Vcc
-// PCINT3/XTAL1/CLKI/!OC1B/ADC3 (3) PB3  2|    |7  PB2 (2) SCK/USCK/SCL/ADC1/T0/INT0/PCINT2
-//  PCINT4/XTAL2/CLKO/OC1B/ADC2 (4) PB4  3|    |6  PB1 (1) MISO/DO/AIN1/OC0B/OC1A/PCINT1 / TX Debug output
-//                                  GND  4|    |5  PB0 (0) MOSI/DI/SDA/AIN0/OC0A/!OC1A/AREF/PCINT0
-//                                        +----+
+//                                               +-\/-+
+//               PCINT5/!RESET/ADC0/dW (5) PB5  1|    |8  VCC
+// USB+   PCINT3/XTAL1/CLKI/!OC1B/ADC3 (3) PB3  2|    |7  PB2 (2) SCK/USCK/SCL/ADC1/T0/INT0/PCINT2 / TX Debug output
+// USB-   PCINT4/XTAL2/CLKO/ OC1B/ADC2 (4) PB4  3|    |6  PB1 (1) MISO/DO/AIN1/OC0B/ OC1A/PCINT1 - (Digispark) LED
+//                                         GND  4|    |5  PB0 (0) MOSI/DI/AIN0/OC0A/!OC1A/SDA/AREF/PCINT0
+//                                               +----+
 
 // ATMEL ATTINY167
 // Pin numbers are for Digispark core