Skip to content

Commit 058d4e6

Browse files
authored
Merge pull request #31 from arduino-libraries/marqdevx/CI
* Added full CI actions * Fixed spell check * added LICENSE file * Fixed Library.properties
2 parents b18048e + 98eb1c7 commit 058d4e6

File tree

11 files changed

+597
-9
lines changed

11 files changed

+597
-9
lines changed

.github/dependabot.yml

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

.github/workflows/check-arduino.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Check Arduino
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v2
20+
21+
- name: Arduino Lint
22+
uses: arduino/arduino-lint-action@v1
23+
with:
24+
compliance: specification
25+
library-manager: update
26+
# Always use this setting for official repositories. Remove for 3rd party projects.
27+
official: true
28+
project-type: library
+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Report Size Deltas
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
paths:
7+
- ".github/workflows/report-size-deltas.yml"
8+
schedule:
9+
# Run at the minimum interval allowed by GitHub Actions.
10+
# Note: GitHub Actions periodically has outages which result in workflow failures.
11+
# In this event, the workflows will start passing again once the service recovers.
12+
- cron: "*/5 * * * *"
13+
workflow_dispatch:
14+
repository_dispatch:
15+
16+
jobs:
17+
report:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Comment size deltas reports to PRs
21+
uses: arduino/report-size-deltas@v1
22+
with:
23+
# The name of the workflow artifact created by the sketch compilation workflow
24+
sketches-reports-source: sketches-reports

.github/workflows/spell-check.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spell Check
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
pull_request:
7+
schedule:
8+
# Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
9+
- cron: "0 8 * * TUE"
10+
workflow_dispatch:
11+
repository_dispatch:
12+
13+
jobs:
14+
spellcheck:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v2
20+
21+
- name: Spell check
22+
uses: codespell-project/actions-codespell@master

LICENSE

+504
Large diffs are not rendered by default.

docs/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Constructor of the object
5050
MKRIoTCarrier yourName; //In the examples we name it as *carrier*
5151
```
5252

53-
Intialization example sketch
53+
Initialization example sketch
5454

5555
```cpp
5656
#include <Arduino_MKRIoTCarrier.h>
@@ -97,7 +97,7 @@ Init the calaibration and the set up for the touchable pads (Already done in the
9797
```cpp
9898
Buttons.begin()
9999
```
100-
Read the state of the pads and save them to be analize in the diferent type of touch events
100+
Read the state of the pads and save them to be analyze in the different type of touch events
101101
```cpp
102102
Buttons.update()
103103
```
@@ -126,7 +126,7 @@ Get both, touched and released
126126
ButtonX.onTouchChange()
127127
```
128128

129-
In case you have another enclosure you can change the sensivity of the pads, 3-100
129+
In case you have another enclosure you can change the sensitivity of the pads, 3-100
130130
Automatically configured when you set the `CARRIER_CASE` boolean, by default is false (sensitivity threshold 4)
131131

132132
```cpp

examples/All_Features/All_Features.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ void loop() {
5353
//Simple relay open and close loop
5454
/* Relay function
5555
open() - goes to Normally Open (NO) circuit, status LED will be ON
56-
close() - goes to Normally Close (NC) cirucit, status LED will be OFF
56+
close() - goes to Normally Close (NC) circuit, status LED will be OFF
5757
*/
5858
carrier.Relay1.close();
5959
delay(1000);

examples/TouchPads/TouchTypes/TouchTypes.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Arduino_Qtouch - Sensor data read Example
33
This example shows how to configure and read data
4-
from touch sensors bottons on MKR IoT Carrier and
4+
from touch sensors buttons on MKR IoT Carrier and
55
prints updates to the Serial Monitor.
66
77
The circuit:

examples/TouchPads/getTouch/getTouch.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Arduino_Qtouch - Sensor data read Example
33
This example shows how to configure and read data
4-
from touch sensors bottons on MKR IoT Carrier and
4+
from touch sensors buttons on MKR IoT Carrier and
55
prints updates to the Serial Monitor.
66
77
The circuit:

library.properties

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ version=1.0.0
33
author=Riccardo Rizzo, Jose García, Pablo Marquínez
44
maintainer=Arduino <[email protected]>
55
sentence=Controlling the IoT MKR Carrier
6-
paragraph=Allows you to controll all the components included in the Explore IoT Kit
7-
category=Sensors + Relays
6+
paragraph=Allows you to control all the components included in the Explore IoT Kit
7+
category=
88
url=https://github.com/arduino-libraries/Arduino_MKRIoTCarrier
99
architectures=samd
1010
precompiled=false

src/Arduino_MKRIoTCarrier_Qtouch.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class MKRIoTCarrierQtouch{
6464

6565
//Config
6666
bool setOnChange = false; //Touch on change
67-
bool setOnNormal = false; //Allways read
67+
bool setOnNormal = false; //Always read
6868
bool setOnUp = false; //When the pad is not being touched
6969
bool setOnDown = false; //When is pressed, to make 2 Downs you need to touch it, release it and touch it again
7070
};

0 commit comments

Comments
 (0)