Skip to content

Commit fbd1df9

Browse files
committed
2 parents e14fe21 + 1eda5c7 commit fbd1df9

19 files changed

+158
-13
lines changed

.codespellrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[codespell]
2+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
3+
ignore-words-list = ,
4+
check-filenames =
5+
check-hidden =
6+
skip = ./.git

.github/workflows/arduino-lint.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Arduino Lint
2+
on:
3+
push:
4+
pull_request:
5+
# Scheduled trigger checks for breakage caused by new rules added to Arduino Lint
6+
schedule:
7+
# run every Saturday at 3 AM UTC
8+
- cron: "0 3 * * 6"
9+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
10+
workflow_dispatch:
11+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
12+
repository_dispatch:
13+
14+
jobs:
15+
lint:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v2
21+
22+
- name: Arduino Lint
23+
uses: arduino/arduino-lint-action@v1
24+
with:
25+
official: true
26+
library-manager: submit # Change this to "update" once the library has been added to the Library Manager index.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Compile Examples
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- ".github/workflows/compile-examples.yml"
7+
- "examples/**"
8+
- "src/**"
9+
push:
10+
paths:
11+
- ".github/workflows/compile-examples.yml"
12+
- "examples/**"
13+
- "src/**"
14+
# Scheduled trigger checks for breakage caused by changes to external resources (libraries, platforms)
15+
schedule:
16+
# run every Saturday at 3 AM UTC
17+
- cron: "0 3 * * 6"
18+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
19+
workflow_dispatch:
20+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
21+
repository_dispatch:
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
27+
env:
28+
SKETCHES_REPORTS_PATH: sketches-reports
29+
30+
strategy:
31+
fail-fast: false
32+
33+
matrix:
34+
board:
35+
- fqbn: arduino:mbed:envie_m7
36+
platforms: |
37+
- name: arduino:mbed
38+
39+
steps:
40+
- name: Checkout
41+
uses: actions/checkout@v2
42+
43+
- name: Compile examples
44+
uses: arduino/compile-sketches@main
45+
with:
46+
github-token: ${{ secrets.GITHUB_TOKEN }}
47+
fqbn: ${{ matrix.board.fqbn }}
48+
platforms: ${{ matrix.board.platforms }}
49+
libraries: |
50+
# Install the library from the local path.
51+
- source-path: ./
52+
# Additional library dependencies can be listed here.
53+
# See: https://github.com/arduino/compile-sketches#libraries
54+
sketch-paths: |
55+
- ./examples/
56+
enable-deltas-report: true
57+
sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
58+
59+
- name: Save memory usage change report as artifact
60+
uses: actions/upload-artifact@v2
61+
with:
62+
name: ${{ env.SKETCHES_REPORTS_PATH }}
63+
path: ${{ env.SKETCHES_REPORTS_PATH }}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Report Size Deltas
2+
3+
on:
4+
schedule:
5+
- cron: '*/5 * * * *'
6+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
7+
workflow_dispatch:
8+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
9+
repository_dispatch:
10+
11+
jobs:
12+
report:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# See: https://github.com/arduino/actions/blob/master/libraries/report-size-deltas/README.md
17+
- name: Comment size deltas reports to PRs
18+
uses: arduino/report-size-deltas@main
19+
with:
20+
# The name of the workflow artifact created by the "Compile Examples" workflow
21+
sketches-reports-source: sketches-reports

.github/workflows/spell-check.yml

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

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
# Arduino_Portenta_OTA
2+
3+
[![Compile Examples](https://github.com/arduino-libraries/Arduino_Portenta_OTA/workflows/Compile%20Examples/badge.svg)](https://github.com/arduino-libraries/Arduino_Portenta_OTA/actions?workflow=Compile+Examples)
4+
[![Arduino Lint](https://github.com/arduino-libraries/Arduino_Portenta_OTA/workflows/Arduino%20Lint/badge.svg)](https://github.com/arduino-libraries/Arduino_Portenta_OTA/actions?workflow=Arduino+Lint)
5+
[![Spell Check](https://github.com/arduino-libraries/Arduino_Portenta_OTA/workflows/Spell%20Check/badge.svg)](https://github.com/arduino-libraries/Arduino_Portenta_OTA/actions?workflow=Spell+Check)
6+
27
OTA on the Arduino Portenta.

examples/OTA_Internal_Flash/OTA_Internal_Flash.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ void setup()
2828
return;
2929
}
3030

31-
/* This functions set's the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
31+
/* This function sets the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
3232
ota.setUpdateLen(131728);
3333

3434
Serial.println("Storing parameters for firmware update in bootloader accessible non-volatile memory");

examples/OTA_Qspi_Flash/OTA_Qspi_Flash.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ void setup()
2323
return;
2424
}
2525

26-
/* This functions set's the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
26+
/* This function sets the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
2727
ota.setUpdateLen(131728);
2828

2929
Serial.println("Storing parameters for firmware update in bootloader accessible non-volatile memory");

examples/OTA_SD_Portenta/OTA_SD_Portenta.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ void setup()
2323
return;
2424
}
2525

26-
/* This functions set's the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
26+
/* This function sets the precise length of update binary, in this case of OTA_Usage_Portenta.ino.PORTENTA_H7_M7.bin */
2727
ota.setUpdateLen(131728);
2828

2929
Serial.println("Storing parameters for firmware update in bootloader accessible non-volatile memory");

examples/OTA_Usage_Portenta/OTA_Usage_Portenta.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Steps to update sketch:
66
1) Upload this sketch or any other sketch (this one lights the LED up with different colours).
77
2) In the IDE select: Sketch -> Export compiled Binary
8-
3) Open the location of the sketch and to choose the next step according to the desired storage type:
8+
3) Open the location of the sketch and choose the next step according to the desired storage type:
99
- SD: copy the binary to the SD with the name "UPDATE.BIN"
1010
- INTERNAL FLASH:
1111
- QSPI Flash:

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version=0.1.0
33
author=Arduino
44
maintainer=Arduino <[email protected]>
55
sentence=Firmware update for the Portenta H7.
6-
paragraph=This library allows to perform a firmware update on the Arduino Portenta H7. The firmware can be stored in various different locations such as within the microcontrolllers flash, on an external SD card or on the QSPI flash chip.
6+
paragraph=This library allows performing a firmware update on the Arduino Portenta H7. The firmware can be stored in various different locations such as within the microcontroller's flash, on an external SD card or on the QSPI flash chip.
77
category=Communication
88
url=https://github.com/arduino-libraries/Arduino_Portenta_OTA
99
architectures=mbed

src/Arduino_Portenta_OTA.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_InternalFlash.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_InternalFlash.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_QSPI.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_QSPI.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_SD.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

src/Arduino_Portenta_OTA_SD.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This file is part of ArduinoIoTCloud.
2+
This file is part of Arduino_Portenta_OTA.
33
44
Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
55

0 commit comments

Comments
 (0)