/
UtilsSDEthernet.cpp
366 lines (242 loc) · 15 KB
/
UtilsSDEthernet.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/*
* Copyright (c) 2013 by Xavier HINAULT - support@mon-club-elec.fr
*
* This file is free software; you can redistribute it and/or modify
* it under the terms of either the GNU General Public License version 3
* or the GNU Lesser General Public License version 3, both as
* published by the Free Software Foundation.
*/
/* Cette librairie contient plusieurs fonctions générales utiles
notamment pour assurer la gestion de la carte SD à distance par le réseau ethernet
*/
#include "Arduino.h"
#include "SPI.h" // fichier libairie pour communication SPI utilisée par carte SD
#include "SD.h" // fichier librairie pour gestion de la carte SD
#include "Ethernet.h" // fichier librairie Ethernet
#include "Utils.h"
#include "UtilsSDEthernet.h"
UtilsSDEthernet::UtilsSDEthernet(){
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction affichant le contenu d'un répertoire de la carte mémoire SD sur le port série
// modifié par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013 – supporte appels itératifs de la fonction
// d'après exemple listFiles de la librairie SD | created Nov 2010 by David A. Mellis | modified 9 Apr 2012 by Tom Igoe
void UtilsSDEthernet::getContentDir(EthernetClient clientIn, char* dirIn, int numTabsIn) { // la fonction reçoit le nom du répertoire, le décalage tab et le drapeau de debug
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du répertoire
// > le nombre de tab de début - obligatoire car reçu en paramètre ré-entrant...
// la fonction ne renvoie rien
File openDir=SD.open(dirIn); // ouvre la SD Card à l'emplacement indiqué et renvoie l'objet File correspondant
openDir.rewindDirectory(); // RAZ la position dans le rép
boolean firstPassWhile=false; // drapeau 1er passage while
boolean debug=true;
while(true) { // tant que vrai = crée une "loop" qui s'exécute tant que contenu
// la sortie se fait par break;
File contenu = openDir.openNextFile(); // ouvre le fichier ou repertoire suivant - NB : un répertoire est aussi un objet File
if (! contenu) { // si aucun nouveau fichier /repertoire
//if (debug) Serial.println("** vide**");
contenu.close(); // ferme fichier avant sortie while
break; // sort de la fonction
} // fin si aucun nouveau fichier / répertoire
if (firstPassWhile==false) { // si premier passage while = on remonte pour etre sur d'etre au debut du rep
contenu.rewindDirectory();
firstPassWhile==true; // est déjà passé 1 fois
} // fin if first pass
// affiche le nombre de tab voulu - 0 si racine, 1 si sous Rép, 2 si sous-sous rép, etc..
for (int i=0; i<numTabsIn; i++) {if (debug) Serial.print('\t');}
if (debug) clientIn.print(contenu.name()); // affiche le nom du fichier/repertoire courant
if (contenu.isDirectory()) { // si le fichier est un répertoire
if (debug) clientIn.println("/"); // affiche un slash
contenu.close(); // ferme fichier avant sortie while
getContentDir(clientIn, contenu.name(), numTabsIn+1); // affiche le contenu en décalant d'un tab - Fonction ré-entrante qui s'appelle elle-meme!!
} // fin si le fichier est un répertoire
else { // sinon affiche la taille - les fichiers ont une taille, pas les répertoires
if (debug)clientIn.print("\t\t"); // affiche de Tab de décalage
if (debug)clientIn.print(contenu.size(), DEC); // affiche la taille
if (debug)clientIn.println(" octets"); // affiche la taille
contenu.close(); // ferme fichier avant sortie while
} // fin sinon = si pas un rép
} // fin while(true)
openDir.close(); // ferme fichier avant sortie fonction
//delay(10); // pause
} // fin fonction getContentDir
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction renvoyant le nombre de lignes d'un fichier sur carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013
int UtilsSDEthernet::getNumberOfLines(EthernetClient clientIn, char* nomFichierIn, boolean debug) {
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier au format 8.3
// > un drapeau d'affichage de messages de debug
// la fonction renvoie le nombre de ligne
File dataFileIn=SD.open(nomFichierIn, FILE_READ); // ouvre le fichier en lecture - NOM FICHIER en 8.3 ++++
if (debug) clientIn.println(F("------"));
int comptLine=0; // variable de comptage des lignes
if (dataFileIn){ // le fichier est True si créé
if (debug)clientIn.println(F("Ouverture fichier OK"));
while (dataFileIn.available()) { // tant que des données sont disposnibles dans le fichier
// le fichier peut etre considéré comme un "buffer" de données comme le buffer du port série
char c = dataFileIn.read(); // lit le caractère suivant
if (debug)clientIn.print(c); // affiche le caractère courant
if (c==10) { // si le caractère est \n : c'est une fin de ligne
comptLine=comptLine+1;
} // fin if saut de ligne
} // fin while available
if (debug) clientIn.println("------");
dataFileIn.close(); // fermeture du fichier obligatoire après accès
} // si fichier existe
else { // sinon = si probleme creation
clientIn.println(F("Probleme ouverture fichier"));
} // fin else
return(comptLine); // renvoie le nombre de ligne
} // fin fonction getNumberOfLines
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// fonction lecture de ligne dans un fichier de carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr -GPL v3 - 03/2013
String UtilsSDEthernet::getLine(EthernetClient clientIn, char* nomFichierIn, int lineNumberIn, boolean debug) {
// la fonctin reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier
// > le numéro de la ligne
// > un drapeau pour messages debug
// la fonction renvoie le String correspondant à la ligne
File dataFileIn=SD.open(nomFichierIn, FILE_READ); // ouvre le fichier en lecture - NOM FICHIER en 8.3 ++++
if (debug) clientIn.println("------");
//int line=1499; // numero de la ligne voulue - 1ère ligne = ligne 1
String strLine="";
int comptLine=0;
int lastPosition=0; // dernière position
int currentPosition=0; // dernière position
if (dataFileIn){ // le fichier est True si créé
if (debug)clientIn.println(F("Ouverture fichier OK"));
while (dataFileIn.available()) { // tant que des données sont disposnibles dans le fichier
// le fichier peut etre considéré comme un "buffer" de données comme le buffer du port série
char c = dataFileIn.read(); // lit le caractère suivant
//Serial.print(c); // affiche le caractère courant
if (c==10) { // si le caractère est \n : c'est une fin de ligne
comptLine=comptLine+1;
if (comptLine==lineNumberIn) { // si on a atteint la ligne voulue
currentPosition=dataFileIn.position(); // mémorise la position actuelle
for (int i=lastPosition; i<currentPosition; i++) { // on défile de la dernière position retenue à la position courante
dataFileIn.seek(i); // se position en i
strLine=strLine+char(dataFileIn.read()); // ajoute le caractère au strLine
} // fin for
break; // sort du while
}// fin if arrivé à la ligne voulue
lastPosition=dataFileIn.position();
//Serial.print ("lastPosition : ");
//Serial.println (lastPosition);
} // fin if saut de ligne
//contenuFichier=contenuFichier+c; // ajoute le char au String
} // fin while available
dataFileIn.close(); // fermeture du fichier obligatoire après accès
if (debug) clientIn.println(F("ligne voulue : "));
if (debug) clientIn.println(strLine);
if (debug) clientIn.println(F("------"));
//Serial.println("Contenu du fichier : ");
//Serial.println(contenuFichier); // affiche le contenu du fichier
} // si fichier existe
else { // sinon = si probleme creation
clientIn.println(F("Probleme creation fichier"));
} // fin else
return(strLine);
} // fin fonction getLine
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction renvoyant la taille en octet d'un fichier sur carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013
int UtilsSDEthernet::getFileSize(EthernetClient clientIn, char* nomFichierIn, boolean debug) {
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier au format 8.3
// > un drapeau d'affichage de messages de debug
// la fonction renvoie le nombre d'octet du fichier
File dataFileIn=SD.open(nomFichierIn, FILE_READ); // ouvre le fichier en lecture - NOM FICHIER en 8.3 ++++
if (debug) clientIn.println("------");
clientIn.println("------");
if (dataFileIn){ // le fichier est True si créé
if (debug)clientIn.println(F("Ouverture fichier OK"));
if (debug) clientIn.print(F("Taille du fichier : "));
if (debug) clientIn.print(dataFileIn.size());
if (debug) clientIn.println(F(" octets."));
return(dataFileIn.size()); // renvoie la taille du fichier
if (debug) clientIn.println(F("------"));
dataFileIn.close(); // fermeture du fichier obligatoire après accès
} // si fichier existe
else { // sinon = si probleme creation
clientIn.println(F("Probleme ouverture fichier"));
return(0);
} // fin else
} // fin fonction getFileSize
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction affichant sur le port série le contenu d'un fichier sur carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013
void UtilsSDEthernet::read(EthernetClient clientIn, char* nomFichierIn, boolean debug) {
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier au format 8.3
// > un drapeau d'affichage de messages de debug
// la fonction ne renvoie rien
// lecture du contenu du fichier
File dataFile=SD.open(nomFichierIn, FILE_READ); // ouvre le fichier en lecture - NOM FICHIER en 8.3 ++++
// un seul fichier ne peut etre ouvert à la fois - fermer au préalable tout fichier déjà ouvert
clientIn.println(F("------"));
if (dataFile){ // le fichier est True si créé
if (debug) clientIn.println(F("Ouverture fichier OK"));
while (dataFile.available()) { // tant que des données sont disposnibles dans le fichier
// le fichier peut etre considéré comme un "buffer" de données comme le buffer du port série
char c = dataFile.read(); // lit le caractère suivant
clientIn.print(c); // affiche le caractère courant
//if (c==10) delay(10); // pause enttre 2 lignes
} // fin while available
dataFile.close(); // fermeture du fichier obligatoire après accès
} // si fichier True
else { // sinon = si probleme creation
clientIn.println(F("Probleme lecture fichier"));
} // fin else
} // fin fonction readSerial
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction ajoutant une chaine dans un fichier sur carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013
void UtilsSDEthernet::writeFile(EthernetClient clientIn, char* nomFichierIn, String toWriteIn, boolean debug) {
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier au format 8.3
// > la chaine à écrire dans le fichier
// > un drapeau d'affichage de messages de debug
// la fonction ne renvoie rien
File dataFile=SD.open(nomFichierIn, FILE_WRITE); // crée / ouvre un objet fichier et l'ouvre en mode écriture - NOM FICHIER en 8.3 ++++
if (dataFile){ // le fichier est True si créé
if(debug)clientIn.println(F("Ouverture fichier OK"));
dataFile.println(toWriteIn); // chaine à écrire
dataFile.close(); // fermeture du fichier obligatoire après accès
if(debug)clientIn.println(F("Ecriture fichier OK"));
} // si fichier ==True
else { // sinon = si probleme creation
clientIn.println(F("Probleme ouverture fichier"));
} // fin else datafile
} // fin fonction writeFile
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fonction créant un fichier sur carte mémoire SD
// par X. HINAULT - www.mon-club-elec.fr - GPLv3 - 03/2013
void UtilsSDEthernet::createFile(EthernetClient clientIn, char* nomFichierIn, boolean debug) {
// La fonction reçoit :
// > le client Ethernet à utiliser
// > le nom du fichier au format 8.3
// > un drapeau d'affichage de messages de debug
// la fonction ne renvoie rien
// création nouveau fichier
File dataFile=SD.open(nomFichierIn, FILE_WRITE); // crée / ouvre un objet fichier et l'ouvre en mode écriture - NOM FICHIER en 8.3 ++++
// > soit en mode : FILE_WRITE: ouvre le fichier pour lecture et écriture, en démarrant au début du fichier.
// Important : Si le fichier est ouvert pour écriture, il sera créé si il n'existe pas déjà (cependant le chemin le contenant doit déjà exister)
clientIn.println("------");
if (dataFile){ // le fichier est True si créé
clientIn.println(F("Creation nouveau fichier OK"));
dataFile.print(""); // chaine vide
dataFile.close(); // fermeture du fichier obligatoire après accès
} // si fichier existe
else { // sinon = si probleme creation
clientIn.println(F("Probleme creation fichier"));
} // fin else datafile
} // fin fonction createFile
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////