Repository per progetto IoT
Le componenti elettroniche utilizzate per la realizzazione del progetto assegnatoci sono:
- Raspberry Pi 3A+, un device non-constrained che funge da LWM2M Server
- ESP-32-WROOM-32, un device constrained che rappresenta il LWM2M Client
Questi sono i prerequisiti necessari per il corretto funzionamento della tesina
Per poter utilizzare correttamente il Raspberry Pi 3A+, è necessario installare il sistema operativo Raspberry Pi OS. Per fare ciò, scaricare l'ultima release dal sito ufficiale al seguente link:
https://www.raspberrypi.com/software/
Scaricare il file compatibile con il sistema operativo del computer attualmente in uso e seguire le istruzioni del sito di Raspberry per installare l'immagine su una Micro SD (in quanto questo modello prevede solo uno slot per l'OS del Raspberry).
In caso non dovessero essere presenti, è necessario scaricare i driver per utilizzare le porte COM dal seriale USB.
Il driver viene incluso nella repository corrente (al folder CP210x_Universal_Windows_Driver valido per Windows) o comunque scaricabile dal sito ufficiale al seguente link:
https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads
Per effettuare le comunicazioni client-server, è necessario usufruire di una rete Wi-Fi a 2.4GHz di cui si conoscono SSID e password: la frequenza prima indicata è dovuta al fatto che l'ESP-32 sopra descritto non riesca ad associarsi ad una rete Wi-Fi con frequenza di 5GHz.
Potrebbe essere, inoltre, necessario poter aprire le port 5683 e 56830 del router: queste ultime serviranno per far comunicare client e server utilizzando il protocollo CoAP (anche se in tutti i codici che vedremo successivamente è possibile definire le port di comunicazione in maniera dinamica).
Per facilitare la scrittura del codice usato nei passi successivi, si consiglia di scaricare:
- Arduino IDE (versione 2.2.1 o successive)
- Visual Studio Code (con successiva installazione del plugin PlatformIO per caricare il codice eseguibile su ESP-32)
Per l'utilizzo di alcune delle librerie sotto citate, è necessario scaricare CMake sul Raspberry Pi e sul computer che si sta utilizzando, al fine di poter effettuare le compilazioni del codice C in maniera cross-platform.
Le librerie qui elencate sono state scelte dopo una serie di confronti e risultate essere più consone all'obiettivo finale.
La libreria può essere scaricata qui di seguito o alla seguente repository GitHub:
https://github.com/Alv3s/Thing.CoAP
Questa libreria permetterà di programmare un CoAP client sull'ESP-32. Seguire i seguenti passi per importare la libreria su Arduino:
- Aprire Arduino IDE
- Andare su
Sketch -> Include Library -> Add Zip Library - Cercare il percorso in cui si è scaricata la libreria e cliccare apri
- Riavviare Arduino IDE
- Verificare che la libreria sia presente andando su
File -> Examples: qui sarà presente Thing.CoAP tra gli Examples of Custom Libraries
Così facendo, sarà possibile utilizzare gli examples della libreria direttamente da Arduino IDE.
Prerequisito unico per poter utilizzare questa libreria sul server (Raspberry Pi) è installare NodeJS. Per farlo, aprire una shell e digitare
sudo apt install nodejs
Una volta fatto ciò, verificare che l'installazione sia andata a buon fine digitando
nodejs --version
npm --version
Se per entrambi i comandi è possibile verificare la versione, scaricare la libreria node-coap utilizzando il seguente comando
npm install coap
Per svolgere il test sulle librerie scelte, andare ad utilizzare i codici così come segue.
Aprire Arduino IDE ed andare su File -> Examples -> Thing.CoAP -> ESP-32 -> Server-InlineEndpoints
Verrà caricato il codice di esempio della libreria sulla finestra dell'IDE: questo inizializzerà un server CoAP con le risorse /Button (accessibile via richiesta GET) e /LED (accessibile via richieste GET o POST).
Andare quindi a modificare l'SSID e la password della rete Wi-Fi precedentemente predisposta.
Caricato il codice ed effettuate le seguenti modifiche, collegare l'ESP-32 al computer tramite la porta COM designata e selezionare il modulo ESP-32-WROOM-DA Module, dopodiché andare ad effettuare l'upload del codice sul device constrained.
Terminato l'upload con successo, aprire il Serial Monitor dall'IDE, selezionare il baud rate a 115200 e verificare se si connette alla rete: in caso di esito positivo, verrà mostrato l'indirizzo IP nel Serial Monitor.
Sul Raspberry Pi, andare a copiare il codice JavaScript presente al percorso Librerie CoAP/client.js della repository
Successivamente, andare ad eseguire nello stesso percorso in cui è stato copiato il file client.js il seguente comando:
node client.js
Sostituire <<your_ip>> con l'indirizzo IP ottenuto in precedenza nel Serial Monitor di Arduino.
Così facendo, verrà inizializzato un client CoAP sulla porta 5683 che andrà ad effettuare una richiesta GET alla risorsa /Button: verrà quindi stampata la risposta sulla shell.
Dopo aver testato le librerie CoAP, si può andare ad effettuare il testing client-server utilizzando la libreria Wakaama.
Questa libreria è stata scelta in quanto permette di effettuare comunicazioni client-server usando il formato JSON di OMA-LWM2M.
I seguenti passi servono per la creazione del server Wakaama sul Raspberry Pi.
Per installare la libreria dalla repository GitHub, scrivere il seguente codice sul Raspberry Pi
git clone --recurse-submodules https://github.com/eclipse/wakaama.git
Una volta installata, andare nella cartella della repository e creare una cartella build, nella quale andranno gli eseguibili compilati con CMake.
Successivamente, andare nella cartella appena creata ed eseguire i seguenti comandi
cmake [wakaama directory]/examples/servermake
Inserire il percorso in cui è stata installata la repository al posto di [wakaama directory].
Verranno creati i file del CMakeList e l'eseguibile lwm2mserver.
I seguenti passi servono per la creazione del client Wakaama sull'ESP-32.
Scaricare sul desktop a cui è collegato l'ESP-32 la libreria di Wakaama modificata per l'ESP-32.
Per farlo, aprire un terminale e digitare il seguente comando
https://github.com/antonzk/lwm2m-esp.git
Aprire la repository appena scaricata con Visual Studio Code (in cui era stato precedentemente scaricato PlatformIO).
Successivamente, andare nel file platformio.ini e inserire SSID e password del Wi-Fi in uso (rispettivamente nelle keys DWIFI_SSID e DWIFI_PASSWORD).
Fatto ciò, andare a modificare il file LwM2mManager.h inserendo l'IP del Server alla variabile *server (l'IP del server sarà ottenibile una volta lanciato l'eseguibile sul Raspberry Pi).
Sul Raspberry Pi, andare alla cartella build precedentemente creata ed eseguire il seguente comando
./lwm2mserver -h
Qualora tutto funzionasse correttamente, verrà aperta una shell del server in cui sarà possibile lanciare dei comandi.
Effettuare, dunque, i seguenti passi:
- Andare su Visual Studio Code
- Connettere l'ESP-32 al computer
- Selezionare nell'IDE la porta COM da utilizzare
- Effettuare la build della libreria scaricata
- Eseguire l'upload
A questo punto, il client sull'ESP-32 si connetterà alla rete internet e andrà ad effettuare una richiesta di registrazione al server.
Di contro, nel server sarà possibile verificare la connessione client-server nella shell.
Inoltre, sarà possibile utilizzare una serie di comandi della shell del server digitando il comando help.
Per effettuare lo sniffing nella comunicazione client-server, bisogna eseguire i seguenti passi:
- Dopo l'avvio di client e server Wakaama, è stato lanciato il seguente comando per sniffare il traffico
Sostituire
sudo tcpdump -i any -n 'udp port 5683 and host <<your_ip>>' -s 0 -w sniffing.pcap<<your_ip>>con l'indirizzo IP dell'ESP-32 ottenibile dal Serial Monitor di Visual Studio Code - Catturati i pacchetti, questi saranno esportati nel file
sniffing.pcap - Avviare Wireshark e andare su
File -> Apri - Si aprirà una finestra di dialogo per importare il file .pcap prima ottenuto
- Una volta importato, sarà possibile vedere il traffico client-server scambiato sulla GUI