From e8baea6f4b7004bcf327522ab58778cb5872ee07 Mon Sep 17 00:00:00 2001 From: flavienhaas Date: Fri, 20 Apr 2018 18:37:05 +0200 Subject: [PATCH] add comments --- LoRaEthernet/LoRaEthernet.ino | 96 ++++++++++++++++------------------- LoRaEthernet/task.h | 56 -------------------- LoRaEthernet/util.h | 40 --------------- 3 files changed, 45 insertions(+), 147 deletions(-) delete mode 100644 LoRaEthernet/task.h delete mode 100644 LoRaEthernet/util.h diff --git a/LoRaEthernet/LoRaEthernet.ino b/LoRaEthernet/LoRaEthernet.ino index fafd51b..367ab38 100644 --- a/LoRaEthernet/LoRaEthernet.ino +++ b/LoRaEthernet/LoRaEthernet.ino @@ -1,92 +1,91 @@ // Flavien HAAS, 2018 -// to compile as on the diagrams, check that you have changed the SS port as indicated on the README +// before transfert, check that you have changed the SS port as indicated on the README or you will not be able to use the LoRa shield as the same time as the Ethernet shield -#include // to communicate using spi (required for our shields) -#include // to use the LoRa shield -#include "Ethernet.h" // to use the ethernet shield -#include "util.h" // to have the display of the elapsed time +#include // to communicate using spi (required for our shields) +#include // to use the LoRa shield +#include "Ethernet.h" // to use the ethernet shield -#define LENMAX 80 // maximum size for the LoRa frame -#define Serial SerialUSB // serial out on the M0 use a different function +#define LENMAX 80 // maximum size for the LoRa frame +#define Serial SerialUSB // serial out on the M0 use a different function -// void setSPIFrequency(uint32_t frequency); // set the SPI at 8MHz to use logic analyser +// void setSPIFrequency(uint32_t frequency); // set the SPI at 8MHz to use logic analyser -byte mac[] = {0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED}; // set the mac address +byte mac[] = {0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED}; // set the mac address -//IPAddress ip(10, 0, 0, 49); //set the IP address for the ethernet shield, overwise the librairy use DHCP +//IPAddress ip(10, 0, 0, 49); // set the IP address for the ethernet shield, overwise the librairy use DHCP -EthernetServer server(80); // initialize the EthernetServer library, using port 80 (default fot HTTP) +EthernetServer server(80); // initialize the EthernetServer library, using port 80 (default fot HTTP) void setup(){ Serial.begin(9600); - while (!Serial); // wait for serial to initialize - Serial.print("Passerelle LoRa\n"); // display on serial the name of the device + while (!Serial); // wait for serial to initialize + Serial.print("Passerelle LoRa\n"); // display on serial the name of the device if( !LoRa.begin(868E6) ){ Serial.print("Echec de l'initialisation LoRa !\n"); - while(true);} // initialize LoRa shield LoRa at 868 MHz + while(true);} // initialize LoRa shield LoRa at 868 MHz - //Ethernet.begin(mac, ip); // initialize Ethernet shield using the set mac adress and set IP - Ethernet.begin(mac); // initialize Ethernet shield uding the set mac and DHCP for the IP - server.begin(); - Serial.print("server is at "); + //Ethernet.begin(mac, ip); // initialize Ethernet shield using the set mac adress and set IP + Ethernet.begin(mac); // initialize Ethernet shield uding the set mac and DHCP for the IP + server.begin(); // initialize WebServer part of the librairy + Serial.print("server is at "); // display on serial the IP you can find the webpage Serial.println(Ethernet.localIP()); } +void SerialPrintElapsedTime( boolean espaceFinal=true ){ // to display the elapsed time + unsigned long h,m,s = millis()/1000; + m=s/60; + h=m/60; + s=s-(m*60); + m=m-(h*60); + Serial << ((h<10)?"0":"") << h << ":" << ((m<10)?"0":"") << m << ":" << ((s<10)?"0":"") << s << (espaceFinal?" ":""); +} + void loop() { - static byte tampon[LENMAX]={0}; +// LoRa receiver + static byte tampon[LENMAX]={0}; // if the module receive a frame, it willnot be null int longueurTrame; - // si le module a reçu une trame alors sa longueur sera non nulle longueurTrame=LoRa.parsePacket(); if( longueurTrame > 0 ){ - //---- copie de la trame depuis le modem vers le tampon ---- - if( longueurTrame>LENMAX ){ - Serial.print("Trame reçue est trop grande pour le tampon : "); + if( longueurTrame>LENMAX ){ // copy of the frame to cache (LENMAX) and verify if the frame is to big + Serial.print("Trame reçue trop grande : "); Serial.println(longueurTrame); - longueurTrame=LENMAX; // troncature + longueurTrame=LENMAX; // troncature } for( int i=0; i 0x7E) ){ - Serial.print( "."); // ce caractère est non imprimable + Serial.print( "."); // this character isn't printable (displayable) }else{ - Serial.print( (char)tampon[i] ); + Serial.print( (char)tampon[i] ); // display the frame in ASCII } } Serial.print( "\n" ); - }//if LoRa.parsePacket + } // end of if LoRa.parsePacket delay(10); - // listen for incoming clients - EthernetClient client = server.available(); +// WebServer + EthernetClient client = server.available(); // WebServer :listen for incoming clients if (client) { Serial.println("new client"); - // an http request ends with a blank line - boolean currentLineIsBlank = true; + boolean currentLineIsBlank = true; // an http request ends with a blank line while (client.connected()) { if (client.available()) { char c = client.read(); Serial.write(c); - // if you've gotten to the end of the line (received a newline - // character) and the line is blank, the http request has ended, - // so you can send a reply - if (c == '\n' && currentLineIsBlank) { - // send a standard http response header + if (c == '\n' && currentLineIsBlank) { // send the beginning of a standard http response header client.println("HTTP/1.1 200 OK"); client.println("Content-Type: text/html"); - client.println("Connection: close"); // the connection will be closed after completion of the response - client.println("Refresh: 5"); // refresh the page automatically every 5 sec + client.println("Connection: close"); // the connection will be closed after completion of the response + client.println("Refresh: 5"); // refresh the page automatically every 5 sec client.println(); client.println(""); client.println(""); @@ -102,19 +101,14 @@ void loop() { client.println(""); break; } - if (c == '\n') { - // you're starting a new line + if (c == '\n') { // send a new blank line to indicate the end of the connection currentLineIsBlank = true; } else if (c != '\r') { - // you've gotten a character on the current line currentLineIsBlank = false; } } } - // give the web browser time to receive the data - delay(1); - // close the connection: - client.stop(); - Serial.println("client disconnected"); + delay(1); // give the web browser time to receive the data + client.stop(); // close the connection of the webserver } } diff --git a/LoRaEthernet/task.h b/LoRaEthernet/task.h deleted file mode 100644 index c4ad4c8..0000000 --- a/LoRaEthernet/task.h +++ /dev/null @@ -1,56 +0,0 @@ - -#ifndef DaKTASK -#define DaKTASK - -// la tàche est effectuee avec un delai de PeriodeMilliSecondes entre deux executions. -// consomme 4 octets de RAM -// exemple : cron(1000){ // code � r�p�ter toutes les secondes } -#define cron(PeriodeMilliSecondes) for( \ - static unsigned long __nextmillis = 0; \ - millis() - __nextmillis >= (unsigned long)(PeriodeMilliSecondes); \ - __nextmillis = millis() \ - ) - - // la tàche est effectuee avec un delai de PeriodeMilliSecondes entre deux executions. -// consomme 4 octets de RAM -#define task(NomTache,PeriodeMilliSecondes) for( \ - static unsigned long DaKTASK_ ## NomTache = 0; \ - millis() - DaKTASK_ ## NomTache >= (unsigned long)(PeriodeMilliSecondes); \ - DaKTASK_ ## NomTache = millis() \ - ) - -// la tàche est effectuee pr�cis�ment toutes les PeriodeMilliSecondes. -// consomme 8 octets de RAM -#define ftask(NomTache,PeriodeMilliSecondes) for( \ - static unsigned long DaKTASK_ ## NomTache = 0, millis_ ## NomTache = 0; \ - (millis_ ## NomTache = millis()) - DaKTASK_ ## NomTache >= (unsigned long)(PeriodeMilliSecondes); \ - DaKTASK_ ## NomTache = millis_ ## NomTache \ - ) - - -#endif - - - -/* - -void setup() { - Serial.begin(9600); - pinMode(13, OUTPUT); -} - -void loop() { - Task( Toto, 1500 ){ - Serial.print("Toto="); - Serial.println( millis() ); - } - - Task( line, 3000) Serial.println(F("-----------------")); - - FTask( LED, 100 ){ PORTB ^= 0x20; } // clignoter la LED - - cron(500){ PORTB ^= 0x20; } // clignoter la LED toutes les secondes - - delay(11); -} -*/ diff --git a/LoRaEthernet/util.h b/LoRaEthernet/util.h deleted file mode 100644 index 8ac179d..0000000 --- a/LoRaEthernet/util.h +++ /dev/null @@ -1,40 +0,0 @@ -/*----------------------------------- - Petite collection deviendra grande - - Astuces glanées ça et là - ------------------------------------*/ - - -/* Permet de compacter des suites de Serial.Print - Exemple : - Serial.print("J'ai "); - Serial.print(i); - Serial.print(" bronzes de "); - Serial.print(j); - Serial.println(" kilo chacun."); - par - Serial << "J'ai" << i << " bronzes de " << j << " kilo chacun.\n" - Source : https://playground.arduino.cc/Main/StreamingOutput - - Fonctionne avec toutes les librairies d�riv�es comme LCD, SerialUSB, ..." -*/ -template inline Print &operator <<(Print &obj, T arg) { obj.print(arg); return obj; } - - -/*----------------------------------------- - * Affichage du temps écoulé depuis le lancement - * du programme, - * sous le forme hh:mm:ss - * le paramètre optionnel place un espace à la fin - */ -void SerialPrintElapsedTime( boolean espaceFinal=true ){ - unsigned long h,m,s = millis()/1000; - m=s/60; - h=m/60; - s=s-(m*60); - m=m-(h*60); - Serial << ((h<10)?"0":"") << h << ":" << ((m<10)?"0":"") << m << ":" << ((s<10)?"0":"") << s << (espaceFinal?" ":""); -} - -