Update continuous integration system (#54)

* Add library.properties to "Compile Examples" workflow path filter

The library.properties metadata file content is a factor in compilation, so the workflow should run on any change to this
file.

* Use major version refs of sketch compilation actions

Previously, due to the lack of a release, the development versions of the sketch compilation actions were used. Using
release versions provides a more stable CI system for the ArduinoCore-mbed project.

Use of the major version ref will cause the workflow to benefit from ongoing development to the actions up until such
time as a new major release of an action is made, at which time we would need to evaluate whether any changes to the
workflow are required by the breaking change that triggered the major release before updating the major ref
(e.g., uses: 	`arduino/compile-sketches@v2`).

* Optimize management of size deltas report when there are errors

There may sometimes be failed compilations that are not related to the current pull request (e.g., breakage caused by an
external change that will be fixed separately). In this case, it is still valuable to publish a size deltas report for
the compilations that passed.

* Configure Dependabot to check for outdated actions used in workflows

Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to
be outdated, it will submit a pull request to update them.
NOTE: Dependabot's PRs will sometimes try to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1`
to `uses: foo/[email protected]`). When the action author has provided a major version ref, use that instead
(e.g., `uses: foo/bar@v2`). Dependabot will automatically close its PR once the workflow has been updated.
More information:
https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot

* Add badge to readme for "Compile Examples" workflow

This will show the current status of the CI workflow at a glance.

* Add CI workflow to check for commonly misspelled words

On every push, pull request, and periodically, use the codespell-project/actions-codespell action to check for commonly
misspelled words.

In the event of a false positive, the problematic word should be added, in all lowercase, to the ignore-words-list field
of ./.codespellrc. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore
list. The ignore list is comma-separated with no spaces.

* Correct typos in comments and documentation

* Add CI workflow to do Arduino project-specific linting

On every push, pull request, and periodically, run Arduino Lint to check for common problems not related to the project
code.

* Add license file

This defines the license in a standardized place, which allows GitHub's automated license detection system to detect the
license type:
https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license

This is the exact license text provided by choosealicense.com
This text should not be modified in any way. Doing so may interfere with GitHub's license detection or even the licence's
function as a legal instrument.

* Use release version of boards platform in "Compile Examples" workflow

Previously, the development version of the boards platform was used to compile the example sketches in the CI workflow.

Author: per1234

.codespellrc

@@ -0,0 +1,7 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ,
+check-filenames =
+check-hidden =
+skip = ./.git,./src/utility/ioexpander/I2Cdev.*,./src/utility/ioexpander/TCA6424A.*,./src/utility/QEI,./src/utility/RS485,

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
+version: 2
+
+updates:
+  # Configure check for outdated GitHub Actions actions in workflows.
+  # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
+  - package-ecosystem: github-actions
+    directory: / # Check the repository's workflows under /.github/workflows/
+    schedule:
+      interval: daily

.github/workflows/check-arduino.yml

@@ -0,0 +1,28 @@
+name: Check Arduino
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Arduino Lint
+        uses: arduino/arduino-lint-action@v1
+        with:
+          compliance: strict
+          library-manager: submit
+          # Always use this setting for official repositories. Remove for 3rd party projects.
+          official: true
+          project-type: library

.github/workflows/compile-examples.yml

@@ -4,11 +4,13 @@ on:
   pull_request:
     paths:
       - ".github/workflows/compile-examples.yml"
+      - "library.properties"
       - "src/**"
       - "examples/**"
   push:
     paths:
       - ".github/workflows/compile-examples.yml"
+      - "library.properties"
       - "src/**"
       - "examples/**"
   # Scheduled trigger checks for breakage caused by changes to external resources (libraries, platforms)
@@ -30,42 +32,16 @@ jobs:
   compile-examples:
     runs-on: ubuntu-latest
 
-    env:
-      ARDUINOCORE_MBED_STAGING_PATH: extras/ArduinoCore-mbed
-      ARDUINOCORE_API_STAGING_PATH: extras/ArduinoCore-API
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
 
-      # It's necessary to checkout the platform before installing it so that the ArduinoCore-API dependency can be added
-      - name: Checkout ArduinoCore-mbed
-        uses: actions/checkout@v2
-        with:
-          repository: arduino/ArduinoCore-mbed
-          # The arduino/actions/libraries/compile-examples action will install the platform from this path
-          path: ${{ env.ARDUINOCORE_MBED_STAGING_PATH }}
-
-      - name: Checkout ArduinoCore-API
-        uses: actions/checkout@v2
-        with:
-          repository: arduino/ArduinoCore-API
-          path: ${{ env.ARDUINOCORE_API_STAGING_PATH }}
-
-      - name: Install ArduinoCore-API
-        run: |
-          mv "${{ env.ARDUINOCORE_API_STAGING_PATH }}/api" "${{ env.ARDUINOCORE_MBED_STAGING_PATH }}/cores/arduino"
-
       - name: Compile example sketches
-        uses: arduino/compile-sketches@main
+        uses: arduino/compile-sketches@v1
         with:
-          fqbn: arduino:mbed:envie_m7
+          fqbn: arduino:mbed_portenta:envie_m7
           platforms: |
-            # Install Arduino mbed-Enabled Boards via Boards Manager for the toolchain
-            - name: arduino:mbed
-            # Overwrite the Arduino mbed-Enabled Boards release version with version from the tip of the master branch (located in local path because of the need to first install ArduinoCore-API)
-            - source-path: extras/ArduinoCore-mbed
-              name: arduino:mbed
+            - name: arduino:mbed_portenta
           enable-deltas-report: true
           enable-warnings-report: true
           sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
@@ -74,21 +50,27 @@ jobs:
       - name: Save memory usage change report as artifact
         uses: actions/upload-artifact@v2
         with:
+          if-no-files-found: error
           path: ${{ env.SKETCHES_REPORTS_PATH }}
           name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }}
 
   report:
     needs: compile-examples
     # Only run the job when the workflow is triggered by a pull request from this repository (because arduino/report-size-deltas requires write permissions)
-    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    if: always() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
     runs-on: ubuntu-latest
     steps:
       - name: Download sketches reports artifact
+        id: download-artifact
+        continue-on-error: true # If compilation failed for all boards then there are no artifacts
         uses: actions/download-artifact@v2
         with:
           name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }}
           path: ${{ env.SKETCHES_REPORTS_PATH }}
 
-      - uses: arduino/report-size-deltas@main
+      - name: Comment size deltas report to PR
+        uses: arduino/report-size-deltas@v1
+        # If actions/download-artifact failed, there are no artifacts to report from.
+        if: steps.download-artifact.outcome == 'success'
         with:
           sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }}

.github/workflows/spell-check.yml

@@ -0,0 +1,22 @@
+name: Spell Check
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master

LICENSE.txt

@@ -1,5 +1,9 @@
 = Machine Control Library for Arduino =
 
+[![Check Arduino status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/check-arduino.yml)
+[![Compile Examples status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/compile-examples.yml)
+[![Spell Check status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/spell-check.yml)
+
 Arduino Library for the Machine Control
 
 For more information about this library please visit us at https://www.arduino.cc/en/Reference/MachineControl

README.md

@@ -45,7 +45,7 @@ void loop() {
   if (counter >= 10.5)
   {
     counter = 0;
-    //Additional 100ms delay introduced to manage 10.5V -> 0V fall time of 150ms
+    //Additional 100 ms delay introduced to manage 10.5V -> 0V fall time of 150 ms
     delay(100);
   }
   delay(100);

examples/Analog_Out/Analog_Out.ino

@@ -3,7 +3,7 @@
 
   This example provides the current value acquired by the
   Machine Control. For each channel of the ANALOG IN
-   connector, there is a 120 ohm resistor to GND. The current
+  connector, there is a 120 ohm resistor to GND. The current
   of the 4-20mA sensor flows through it, generating a voltage
   which is sampled by the Portenta's ADC.
   To use the 4-20mA functionality, a 24V supply on

examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino

@@ -13,11 +13,11 @@
   different behaviors, and it is the same for all channels:
     1) Latch mode: when the over current is detected
        the channel is opened, and will remain opened until
-       it will be toggle via software.
+       it is toggled via software.
     2) Auto retry: when the over current is detected
-       the channel is openend, but after some tents of
+       the channel is opened, but after some tens of
        milliseconds the channel will automatically try
-       to close itself again. In case of a persistant
+       to close itself again. In case of a persistent
        overcurrent the channel will continuously toggle.
   
   The circuit:
@@ -33,7 +33,7 @@ using namespace machinecontrol;
 
 void setup() {
   Serial.begin(9600);
-  // The loop starts only when the serial monitor is opened.
+  // The loop starts only when the Serial Monitor is opened.
   while (!Serial);
 
   //Set over current behavior of all channels to latch mode:
@@ -53,60 +53,60 @@ void loop() {
 
   // Set all channels to CLOSED
   digital_outputs.setAll(255);
-  Serial.print("All channels are CLOSED for 1s...");
+  Serial.print("All channels are CLOSED for 1 s...");
   delay(1000);
 
   // Set all channels to OPEN
   digital_outputs.setAll(0);
   Serial.println("now they are OPEN.");
   delay(1000);
 
-  // Toggle each channel for 1s, one by one
+  // Toggle each channel for 1 s, one by one
 
   digital_outputs.set(0, HIGH);
-  Serial.print("CH0 is CLOSED for 1s...");
+  Serial.print("CH0 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(0, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(1, HIGH);
-  Serial.print("CH1 is CLOSED for 1s...");
+  Serial.print("CH1 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(1, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(2, HIGH);
-  Serial.print("CH2 is CLOSED for 1s...");
+  Serial.print("CH2 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(2, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(3, HIGH);
-  Serial.print("CH3 is CLOSED for 1s...");
+  Serial.print("CH3 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(3, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(4, HIGH);
-  Serial.print("CH4 is CLOSED for 1s...");
+  Serial.print("CH4 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(4, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(5, HIGH);
-  Serial.print("CH5 is CLOSED for 1s...");
+  Serial.print("CH5 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(5, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(6, HIGH);
-  Serial.print("CH6 is CLOSED for 1s...");
+  Serial.print("CH6 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(6, LOW);
   Serial.println("now is OPEN.");
 
   digital_outputs.set(7, HIGH);
-  Serial.print("CH7 is CLOSED for 1s...");
+  Serial.print("CH7 is CLOSED for 1 s...");
   delay(1000);
   digital_outputs.set(7, LOW);
   Serial.println("now is OPEN.");

examples/Digital_output/Digital_output.ino

@@ -18,7 +18,7 @@ using namespace machinecontrol;
 
 void setup() {
   Serial.begin(9600);
-  //The loop starts only when the serial monitor is opened.
+  //The loop starts only when the Serial Monitor is opened.
   while(!Serial);
   Wire.begin();
 

examples/Digital_programmable/Digital_input/Digital_input.ino

@@ -9,7 +9,7 @@
   Circuit:
    - Portenta H7
    - Machine Control
-   - A Slave device with RS485 inteface
+   - A Slave device with RS485 interface
 
 */
 
@@ -34,8 +34,8 @@ void setup()
     comm_protocols.rs485.sel_485 = 1;       // RS485_RS232_N
     comm_protocols.rs485.half_duplex = 0;   // HALF_FULL_N
     comm_protocols.rs485.receive();         // RE_N
-    comm_protocols.rs485.fd_tx_term = 1;    // FD_TX_TERM - 120 Ohm Y-Z termination enabled when both TERM and FD_TX_TERM are high
-    comm_protocols.rs485.term = 1;          // TERM - 120 Ohm A-B termination enabled when high
+    comm_protocols.rs485.fd_tx_term = 1;    // FD_TX_TERM - 120 ohm Y-Z termination enabled when both TERM and FD_TX_TERM are high
+    comm_protocols.rs485.term = 1;          // TERM - 120 ohm A-B termination enabled when high
 
     Serial.println("Initialization done!");
 }

examples/RS485_fullduplex/RS485_fullduplex.ino

@@ -36,7 +36,7 @@ void setup() {
 
   Serial.println("Initialization Done!");
 
-  // APIs to set date's fields:hours, minutes and seconds
+  // APIs to set date's fields: hours, minutes and seconds
   rtc_controller.setHours(hours);
   rtc_controller.setMinutes(minutes);
   rtc_controller.setSeconds(seconds);

examples/RTC_Alarm/RTC_Alarm.ino

@@ -2,10 +2,10 @@
   Machine Control - Temperature probes RTD example
 
   This example provides a way to test the 3-wire RTDs
-  on the Machine control Carrier. It is possibile to
+  on the Machine control Carrier. It is possible to
   acquire 2-wire RTD simply by shorting the RTDx pin
   to the TPx pin. The Machine control carrier has on
-  board a precise 400ohm 0.1% reference resistor which
+  board a precise 400 ohm 0.1% reference resistor which
   is used as a reference by the MAX31865.
 
   The circuit:

examples/Temp_probes_RTD/Temp_probes_RTD.ino

@@ -31,23 +31,23 @@ void setup() {
 }
 
 void loop() {
-  //Set CH0, has internal 150ms delay
+  //Set CH0, has internal 150 ms delay
   temp_probes.selectChannel(0);
   //Take CH0 measurement
   float temp_ch0 = temp_probes.tc.readTemperature();
   Serial.print("Temperature CH0 [°C]: ");
   Serial.print(temp_ch0);
   Serial.println();
 
-  //Set CH1, has internal 150ms delay
+  //Set CH1, has internal 150 ms delay
   temp_probes.selectChannel(1);
   //Take CH1 measurement
   float temp_ch1 = temp_probes.tc.readTemperature();
   Serial.print("Temperature CH1 [°C]: ");
   Serial.print(temp_ch1);
   Serial.println();
 
-  //Set CH2, has internal 150ms delay
+  //Set CH2, has internal 150 ms delay
   temp_probes.selectChannel(2);
   //Take CH2 measurement
   float temp_ch2 = temp_probes.tc.readTemperature();

examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino

@@ -161,4 +161,4 @@ static int process_key(tusbh_ep_info_t* ep, const uint8_t* keys)
     tusbh_set_keyboard_led(ep, key_leds);
   }
   return 0;
-}
+}

examples/USB_host/USB_host.ino

@@ -54,7 +54,7 @@ static 	mbed::CAN   _can(PB_8, PH_13);
 
 class COMMClass {
 public:
-	// to be tested: cjeck if can be made a big pin initialization
+	// to be tested: check if can be made a big pin initialization
 	void init() {
 		//SHUTDOWN OF RS485 LEDS
 		digitalWrite(PA_0, LOW);

src/MachineControl.h

@@ -28,7 +28,7 @@
 #define PCF8563T_MONTHS_REG     0x07
 #define PCF8563T_YEARS_REG      0x08
 
-// allarm managemet
+// allarm management
 #define PCF8563T_MINUTE_ALARM_REG 0x09
 #define PCF8563T_MINUTE_ALARM_AE_M_MASK 0x80
 #define PCF8563T_MINUTE_ALARM_ON 0x7F

src/utility/RTC/PCF8563T.cpp

@@ -84,7 +84,7 @@ float MAX31855Class::readTemperature(int type)
     return NAN; 
   }
   // The temperature is stored in the last 14 word's bits 
-  // sendend by the Thermocouple-to-Digital Converter
+  // sent by the Thermocouple-to-Digital Converter
   if (rawword & 0x80000000) {
     // Negative value, drop the lower 18 bits and explicitly extend sign bits.
     rawword = 0xFFFFC000 | ((rawword >> 18) & 0x00003FFFF);
@@ -113,7 +113,7 @@ float MAX31855Class::readReferenceTemperature(int type)
   rawword >>= 4;
 
   // The cold junction reference temperature is stored in the first 11 word's bits
-  // sendend by the Thermocouple-to-Digital Converter
+  // sent by the Thermocouple-to-Digital Converter
   rawword = rawword & 0x7FF;
   // check sign bit  and convert to negative value.
   if (rawword & 0x800) {