Skip to content

Commit 26ec2bb

Browse files
authored
Update README.md
1 parent ba48b70 commit 26ec2bb

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
11
# Motion classification application on an Arduino board supporting multiple IoT protocols
22

3-
Final project of the Summer School on Enabling Technologies for IIoT by University of Pisa, 2022.
4-
5-
The objective is to develop a motion classification application on an arduino board (using embedded ML capabilities of the hardware) and connect it to the external world either:
3+
This is a motion classification application for an arduino board (using embedded ML capabilities of the hardware) that sends events to the external world either:
64

75
- by sending the events [through MQTT](./mqtt_version)
86
- by sending events with the [CoAP protocol](./coap_version/)
9-
- by wrapping it as a ["Web Thing"](./webthings_version/), and monitoring it via a WebThings Gateway running on a Raspberry Pi
7+
- by declaring a ["Web Thing"](./webthings_version/) interface, allowing to monitor it via a WebThings Gateway running on a Raspberry Pi
108

9+
It was my final project at the Summer School on Enabling Technologies for IIoT by University of Pisa, 2022.
1110

12-
### Required Hardware:
11+
## Requirements
12+
### Hardware:
1313
- [Arduino Nano RP2040 connect](https://docs.arduino.cc/hardware/nano-rp2040-connect)
1414
- [Raspberry Pi for running the WebThings Gateway software](https://webthings.io/docs/gateway-getting-started-guide.html) (Optional)
1515

16-
### Required Libraries:
16+
### Libraries:
1717
- [WiFiNINA](https://www.arduino.cc/reference/en/libraries/wifinina/)
1818
- [STM32duino X-NUCLEO-IKS01A3](https://www.arduino.cc/reference/en/libraries/stm32duino-x-nucleo-iks01a3/3)
1919
- [ArduinoMqttClient](https://www.arduino.cc/reference/en/libraries/arduinomqttclient/)
2020
- [CoAP-simple-library](https://www.arduino.cc/reference/en/libraries/coap-simple-library/)
2121
- [webthing](https://webthings.io/framework/)
2222
- [ArduinoMDNS](https://github.com/arduino-libraries/ArduinoMDNS)
2323

24-
### Setup:
24+
### Example setup:
2525

26-
![](./img/setup.jpg)
26+
<img src="./img/setup.jpg" width="50%">
2727

28-
### Milestones:
28+
## Features:
2929

30-
- [X] Sending the current motion status through an MQTT topic to a broker running on my personal DigitalOcean cloud server
30+
- Send the current motion status through an MQTT topic to a broker running on a cloud server. [(See source code)](https://github.com/linomp/rp2040-webthing/blob/main/mqtt_version/mqtt_version.ino)
3131

32-
![](./img/demoMqtt.PNG)
32+
![](./img/demoMqtt.PNG)
3333

34-
- [X] Sending the current motion status as a CoAP PUT request to a CoAP test server running on my personal DigitalOcean cloud server
34+
- Send the current motion status as a CoAP PUT request to a CoAP test server running on a cloud server. [(See source code)](https://github.com/linomp/rp2040-webthing/blob/main/coap_version/coap_version.ino)
3535

36-
![](./img/demoCoap.PNG)
36+
![](./img/demoCoap.PNG)
3737

38-
- [X] Sending the current motion status to a WebThings gateway running on a Raspberry Pi on the local network
38+
- Send the current motion status to a WebThings gateway running on a Raspberry Pi on the local network. [(See source code)](https://github.com/linomp/rp2040-webthing/blob/main/webthings_version/webthings_version.ino)
3939

4040
![](./img/dashboard.PNG)
4141
![](./img/logs.PNG)
4242

4343

44-
### References:
44+
## References:
4545

4646
- [Using the IMU Machine Learning Core Features of the Nano RP2040 Connect](https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-imu-advanced)
4747
- [Article about Coap by Adafruit](https://learn.adafruit.com/alltheiot-protocols/coap)

0 commit comments

Comments
 (0)