Merge branch 'master' of https://github.com/arduino/ArduinoCore-API

Author: earlephilhower

.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 = hel
+check-filenames =
+check-hidden =
+skip = ./.git,./test/external

.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

.github/workflows/unit-tests.yml

@@ -2,7 +2,7 @@ name: Unit Tests
 
 on:
   pull_request:
-    # Only run workflow if a file in these paths are modified
+    # Only run workflow if a file in these paths is modified
     paths:
       - ".github/workflows/unit-tests.yml"
       - "test/**"

README.md

@@ -2,13 +2,14 @@
 
 [![Unit Tests](https://github.com/arduino/ArduinoCore-API/workflows/Unit%20Tests/badge.svg)](https://github.com/arduino/ArduinoCore-API/actions?workflow=Unit+Tests)
 [![codecov](https://codecov.io/gh/arduino/ArduinoCore-API/branch/master/graph/badge.svg)](https://codecov.io/gh/arduino/ArduinoCore-API)
+[![Spell Check status](https://github.com/arduino/ArduinoCore-API/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino/ArduinoCore-API/actions/workflows/spell-check.yml)
 
 This repository hosts the hardware independent layer of Arduino core.
 
 All Arduino official cores are being ported to the new structure so they take advantage of this single repo.
 
 Including this repo in your existing Arduino core will allow the language to grow and include new features.
-For backwards compatibility, every revision of this repo will increase `ARDUINO_API_VERSION` define.
+For backwards compatibility, every revision of this repo will increase the `ARDUINO_API_VERSION` define.
 
 Some cores have been ported to the new structure, for example:
 * megaAVR (https://github.com/arduino/ArduinoCore-megaAVR) 
@@ -20,7 +21,7 @@ These repositories **don't** contain the needed `api` subfolder; to "complete" t
 
 ### Porting tips
 
-In the future, core apis will be updated independently from the core, so all the compatible cores will seamlessly adopt new features.
+In the future, core APIs will be updated independently from the core, so all the compatible cores will seamlessly adopt new features.
 This requires support from all the IDEs, so in the meantime we suggest to release the core by copying a snapshot of this `api` folder.
 
 The most elegant and effective solution is to develop the core with `api` symlinked and produce the distributable archive by telling `tar` to follow symlinks. 

api/ArduinoAPI.h

@@ -20,8 +20,8 @@
 #ifndef ARDUINO_API_H
 #define ARDUINO_API_H
 
-// version 1.2.0
-#define ARDUINO_API_VERSION 10200
+// version 1.3.0
+#define ARDUINO_API_VERSION 10300
 
 #include "Binary.h"
 

api/Common.h

@@ -85,7 +85,7 @@ int atexit(void (*func)()) __attribute__((weak));
 int main() __attribute__((weak));
 
 #ifdef EXTENDED_PIN_MODE
-// Platforms who wnat to declare more than 256 pins need to define EXTENDED_PIN_MODE globally
+// Platforms who want to declare more than 256 pins need to define EXTENDED_PIN_MODE globally
 typedef uint32_t pin_size_t;
 #else
 typedef uint8_t pin_size_t;

api/HardwareSPI.h

@@ -124,7 +124,7 @@ class HardwareSPI
     virtual void end() = 0;
 };
 
-// Alias SPIClass to HardwareSPI since it's already the defacto standard for SPI classe name
+// Alias SPIClass to HardwareSPI since it's already the defacto standard for SPI class name
 typedef HardwareSPI SPIClass;
 
 }

api/IPAddress.cpp

@@ -66,7 +66,7 @@ bool IPAddress::fromString(const char *address)
         else if (c == '.')
         {
             if (dots == 3) {
-                // Too much dots (there must be 3 dots)
+                // Too many dots (there must be 3 dots)
                 return false;
             }
             if (acc < 0) {

api/IPAddress.h

@@ -23,7 +23,7 @@
 #include "Printable.h"
 #include "String.h"
 
-// forward declartions of global name space friend classes
+// forward declarations of global name space friend classes
 class EthernetClass;
 class DhcpClass;
 class DNSClient;
@@ -83,3 +83,5 @@ class IPAddress : public Printable {
 
 extern const IPAddress INADDR_NONE;
 }
+
+using arduino::IPAddress;

api/Print.h

@@ -57,7 +57,7 @@ class Print
     }
 
     // default to zero, meaning "a single write may block"
-    // should be overriden by subclasses with buffering
+    // should be overridden by subclasses with buffering
     virtual int availableForWrite() { return 0; }
 
     size_t print(const __FlashStringHelper *);
@@ -97,4 +97,4 @@ class Print
 };
 
 }
-using namespace arduino;
+using arduino::Print;