Skip to content

Commit 481e54f

Browse files
facchinmaentinger
facchinm
authored and
aentinger
committed
Add SNU (for OTA backed by NINA storage)
1 parent 6e049f7 commit 481e54f

File tree

17 files changed

+1255
-0
lines changed

17 files changed

+1255
-0
lines changed

‎libraries/SNU/examples/Usage/Usage.ino‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
/*
2+
Usage
3+
This example demonstrates how to use the SAMD SNU library to update a
4+
sketch on an Arduino MKRWiFi1010 board using the board and nothing else.
5+
It prints out the date and time the sketch was compiled at
6+
to both Serial and Serial1.
7+
8+
Arduino MKRWiFi1010 board
9+
10+
Steps to update sketch via NINA WiFi/BT module:
11+
12+
1) Upload this sketch or another sketch that includes the SNU library
13+
via #include <SNU.h>
14+
15+
2) Update the sketch as desired. For this example the sketch prints out
16+
the compiled date and time so no updates are needed.
17+
18+
3) In the IDE select: Sketch -> Export compiled Binary
19+
20+
4) Use WiFiStorage.download(url, "UPDATE.BIN") function to download the
21+
new binary from a remote webserver.
22+
23+
5) Reboot the board; the update will be applied seamlessly
24+
25+
created 14 December 2018
26+
by Martino Facchin
27+
*/
28+
29+
/*
30+
Include the SNU library
31+
32+
This will add some code to the sketch before setup() is called
33+
to check if the WiFi module is present and UPDATE.bin exists.
34+
35+
If UPDATE.bin is present, the file is used to update the sketch
36+
running on the board. After this UPDATE.bin is deleted from NINA memory.
37+
*/
38+
#include <SNU.h>
39+
#include <WiFiNINA.h>
40+
41+
#include "arduino_secrets.h"
42+
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
43+
/////// Wifi Settings ///////
44+
char ssid[] = SECRET_SSID; // your network SSID (name)
45+
char pass[] = SECRET_PASS; // your network password
46+
char url[] = SECRET_OTA_URL;
47+
48+
int status = WL_IDLE_STATUS;
49+
50+
String message;
51+
52+
void setup() {
53+
Serial.begin(9600);
54+
Serial1.begin(9600);
55+
56+
// check for the presence of the shield:
57+
if (WiFi.status() == WL_NO_SHIELD) {
58+
Serial.println("WiFi shield not present");
59+
// don't continue:
60+
while (true);
61+
}
62+
63+
// attempt to connect to Wifi network:
64+
while ( status != WL_CONNECTED) {
65+
Serial.print("Attempting to connect to SSID: ");
66+
Serial.println(ssid);
67+
// Connect to WPA/WPA2 network. Change this line if using open or WEP network:
68+
status = WiFi.begin(ssid, pass);
69+
}
70+
71+
// wait a bit
72+
delay(1000);
73+
74+
message += "Sketch compile date and time: ";
75+
message += __DATE__;
76+
message += " ";
77+
message += __TIME__;
78+
79+
// print out the sketch compile date and time on the serial port
80+
Serial.println(message);
81+
Serial1.println(message);
82+
83+
Serial.println("Type \"download\" in the Serial Monitor to start downloading the update");
84+
}
85+
86+
void loop() {
87+
String command = Serial.readStringUntil('\n');
88+
89+
if (command.indexOf("download") >= 0) {
90+
91+
Serial.println("Downloading update file");
92+
WiFiStorage.download(url, "UPDATE.BIN");
93+
94+
WiFiStorageFile update = WiFiStorage.open("/fs/UPDATE.BIN");
95+
if (update.available()) {
96+
Serial.println("Download complete, please restart or type \"restart\" to apply the update");
97+
Serial.println("Filesize: " + String(update.available()));
98+
} else {
99+
Serial.println("Download failed, please retry :(");
100+
}
101+
}
102+
103+
if (command.indexOf("restart") >= 0) {
104+
NVIC_SystemReset();
105+
}
106+
}

‎libraries/SNU/examples/Usage/arduino_secrets.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#define SECRET_SSID ""
2+
#define SECRET_PASS ""
3+
#define SECRET_OTA_URL "http://downloads.arduino.cc/misc/WiFi1010_blinkRBG.bin"

‎libraries/SNU/extras/NiNaBoot/NiNaBoot.ino‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
Copyright (c) 2017 Arduino LLC. All right reserved.
3+
4+
This library is free software; you can redistribute it and/or
5+
modify it under the terms of the GNU Lesser General Public
6+
License as published by the Free Software Foundation; either
7+
version 2.1 of the License, or (at your option) any later version.
8+
9+
This library is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12+
See the GNU Lesser General Public License for more details.
13+
14+
You should have received a copy of the GNU Lesser General Public
15+
License along with this library; if not, write to the Free Software
16+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17+
*/
18+
19+
#include <WiFiNINA.h>
20+
#include <FlashStorage.h>
21+
22+
#define SDU_START 0x2000
23+
#define SDU_SIZE 0x4000
24+
25+
#define SKETCH_START (uint32_t*)(SDU_START + SDU_SIZE)
26+
27+
#define UPDATE_FILE "/fs/UPDATE.BIN"
28+
29+
FlashClass flash;
30+
31+
// Initialize C library
32+
extern "C" void __libc_init_array(void);
33+
34+
int main() {
35+
init();
36+
37+
__libc_init_array();
38+
39+
delay(1);
40+
41+
// NINA - SPI boot
42+
pinMode(NINA_GPIO0, OUTPUT);
43+
digitalWrite(NINA_GPIO0, HIGH);
44+
45+
// disable NINA
46+
pinMode(NINA_RESETN, OUTPUT);
47+
digitalWrite(NINA_RESETN, HIGH);
48+
49+
if (WiFi.status() == WL_NO_SHIELD) {
50+
goto boot;
51+
}
52+
53+
if (WiFiStorage.exists(UPDATE_FILE)) {
54+
55+
WiFiStorageFile updateFile = WiFiStorage.open(UPDATE_FILE);
56+
uint32_t updateSize = updateFile.size();
57+
bool updateFlashed = false;
58+
59+
if (updateSize > SDU_SIZE) {
60+
// skip the SDU section
61+
updateFile.seek(SDU_SIZE);
62+
updateSize -= SDU_SIZE;
63+
64+
uint32_t flashAddress = (uint32_t)SKETCH_START;
65+
66+
// erase the pages
67+
flash.erase((void*)flashAddress, updateSize);
68+
69+
uint8_t buffer[128];
70+
71+
// write the pages
72+
for (uint32_t i = 0; i < updateSize; i += sizeof(buffer)) {
73+
updateFile.read(buffer, sizeof(buffer));
74+
75+
flash.write((void*)flashAddress, buffer, sizeof(buffer));
76+
77+
flashAddress += sizeof(buffer);
78+
}
79+
80+
updateFlashed = true;
81+
}
82+
83+
updateFile.close();
84+
85+
if (updateFlashed) {
86+
updateFile.erase();
87+
}
88+
}
89+
90+
boot:
91+
// jump to the sketch
92+
__set_MSP(*SKETCH_START);
93+
94+
//Reset vector table address
95+
SCB->VTOR = ((uint32_t)(SKETCH_START) & SCB_VTOR_TBLOFF_Msk);
96+
97+
// address of Reset_Handler is written by the linker at the beginning of the .text section (see linker script)
98+
uint32_t resetHandlerAddress = (uint32_t) * (SKETCH_START + 1);
99+
// jump to reset handler
100+
asm("bx %0"::"r"(resetHandlerAddress));
101+
}

‎libraries/SNU/extras/NiNaBoot/build.sh‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/bin/sh -x
2+
3+
ARDUINO=arduino
4+
SKETCH_NAME="NiNaBoot.ino"
5+
SKETCH="$PWD/$SKETCH_NAME"
6+
BUILD_PATH="$PWD/build"
7+
OUTPUT_PATH="../../src/boot"
8+
9+
if [[ "$OSTYPE" == "darwin"* ]]; then
10+
ARDUINO="/Applications/Arduino.app/Contents/MacOS/Arduino"
11+
fi
12+
13+
buildSDUBootSketch() {
14+
BOARD=$1
15+
DESTINATION=$2
16+
17+
$ARDUINO --verify --board $BOARD --preserve-temp-files --pref build.path="$BUILD_PATH" $SKETCH
18+
cat "$BUILD_PATH/$SKETCH_NAME.bin" | xxd -i > $DESTINATION
19+
rm -rf "$BUILD_PATH"
20+
}
21+
22+
mkdir -p "$OUTPUT_PATH"
23+
24+
buildSDUBootSketch "arduino:samd:arduino_zero_edbg" "$OUTPUT_PATH/zero.h"
25+
buildSDUBootSketch "arduino:samd:mkr1000" "$OUTPUT_PATH/mkr1000.h"
26+
buildSDUBootSketch "arduino:samd:mkrzero" "$OUTPUT_PATH/mkrzero.h"
27+
buildSDUBootSketch "arduino:samd:mkrfox1200" "$OUTPUT_PATH/mkrfox1200.h"
28+
buildSDUBootSketch "arduino:samd:mkrgsm1400" "$OUTPUT_PATH/mkrgsm1400.h"
29+
buildSDUBootSketch "arduino:samd:mkrwan1300" "$OUTPUT_PATH/mkrwan1300.h"
30+
buildSDUBootSketch "arduino:samd:mkrnb1500" "$OUTPUT_PATH/mkrnb1500.h"
31+
buildSDUBootSketch "arduino:samd:mkrwifi1010" "$OUTPUT_PATH/mkrwifi1010.h"
32+
buildSDUBootSketch "arduino:samd:mkrvidor" "$OUTPUT_PATH/mkrvidor4000.h"

‎libraries/SNU/keywords.txt‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#######################################
2+
# Syntax Coloring Map For SDU
3+
#######################################
4+
5+
#######################################
6+
# Datatypes (KEYWORD1)
7+
#######################################
8+
9+
SDU KEYWORD1
10+
11+
#######################################
12+
# Methods and Functions (KEYWORD2)
13+
#######################################
14+
15+
#######################################
16+
# Constants (LITERAL1)
17+
#######################################

‎libraries/SNU/library.properties‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=SNU
2+
version=1.0.0
3+
author=Arduino
4+
maintainer=Arduino <info@arduino.cc>
5+
sentence=Update the sketch on your board with NiNa W10 wifi module
6+
paragraph=Requires a board with NiNa W10 module onboard
7+
category=Other
8+
url=http://www.arduino.cc/en/Reference/SNU
9+
architectures=megaAVR, samd

‎libraries/SNU/src/SNU.cpp‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/*
2+
Copyright (c) 2017 Arduino LLC. All right reserved.
3+
4+
This library is free software; you can redistribute it and/or
5+
modify it under the terms of the GNU Lesser General Public
6+
License as published by the Free Software Foundation; either
7+
version 2.1 of the License, or (at your option) any later version.
8+
9+
This library is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12+
See the GNU Lesser General Public License for more details.
13+
14+
You should have received a copy of the GNU Lesser General Public
15+
License along with this library; if not, write to the Free Software
16+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17+
*/
18+
19+
#include <Arduino.h>
20+
21+
#include "SNU.h"
22+
23+
__attribute__ ((section(".sketch_boot")))
24+
unsigned char sduBoot[0x4000] = {
25+
#if defined(ARDUINO_SAMD_ZERO)
26+
#include "boot/zero.h"
27+
#elif defined(ARDUINO_SAMD_MKR1000)
28+
#include "boot/mkr1000.h"
29+
#elif defined(ARDUINO_SAMD_MKRZERO)
30+
#include "boot/mkrzero.h"
31+
#elif defined(ARDUINO_SAMD_MKRFox1200)
32+
#include "boot/mkrfox1200.h"
33+
#elif defined(ARDUINO_SAMD_MKRGSM1400)
34+
#include "boot/mkrgsm1400.h"
35+
#elif defined(ARDUINO_SAMD_MKRWAN1300)
36+
#include "boot/mkrwan1300.h"
37+
#elif defined(ARDUINO_SAMD_MKRWIFI1010)
38+
#include "boot/mkrwifi1010.h"
39+
#else
40+
#error "Unsupported board!"
41+
#endif
42+
};

‎libraries/SNU/src/SNU.h‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright (c) 2017 Arduino LLC. All right reserved.
3+
4+
This library is free software; you can redistribute it and/or
5+
modify it under the terms of the GNU Lesser General Public
6+
License as published by the Free Software Foundation; either
7+
version 2.1 of the License, or (at your option) any later version.
8+
9+
This library is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12+
See the GNU Lesser General Public License for more details.
13+
14+
You should have received a copy of the GNU Lesser General Public
15+
License along with this library; if not, write to the Free Software
16+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17+
*/
18+
19+
#ifndef _SFU_H_INCLUDED
20+
#define _SFU_H_INCLUDED
21+
22+
// nothing for now
23+
24+
#endif

‎libraries/SNU/src/boot/mkr1000.h‎

Whitespace-only changes.

‎libraries/SNU/src/boot/mkrfox1200.h‎

Whitespace-only changes.

0 commit comments

Comments
 (0)