Update doc

Author: bibi21000

README.md

@@ -83,6 +83,7 @@ In your sketch :
 
 That's all !!!
 
-Look at doc (http://bibi21000.gallet.info/index.php/fr/component/sphin
-xdoc/documentation/8-fullip-for-arduino/readme.html) and examples to
-get more informations.
+Look at documentation in the doc directory and examples to get more
+informations. You can also browse the documentation online here : http
+://bibi21000.gallet.info/index.php/fr/component/sphinxdoc/documentatio
+n/8-fullip-for-arduino/readme.html

doc/ftpclient.txt

@@ -6,41 +6,41 @@ FullIP FTP Client
 Installation
 ============
 
-Download and install FullIP (Look at *Installation*).
+Download and install FullIP (Look at "Installation instructions").
 
 Uncomment #define FULLIP_SD to enable SD in FullIP.h.
 
 
 Usage
 =====
 
-Define a variable dor the FTP client
+Define a variable for the FTP client :
 
    FtpClient ftpclient;
 
-Start the FTP client
+Initialize the SD and start the FTP client :
 
+   pinMode(PIN_SD_CS, OUTPUT);
+   if (!SD.begin(PIN_SD_CS)) {
+       Serial.println("SD failed :");
+   } else {
+       Serial.println("SD configured :)");
+   }
    ftpclient.begin(server_name,user_name,password);
 
-Send a file
+Send a file  :
 
    ftpclient.sendFile(filename2,local_dir,remote_dir)
 
-Or retrieve one
+Or retrieve one :
 
    ftpclient.getFile(filename2,local_dir,remote_dir)
 
-And process it in your loop
+And process it in your loop :
 
    ftpclient.maintain();
 
 
-Full example
-============
-
-Get the full "example".
-
-
 Class definition
 ================
 

doc/httpserver.txt

@@ -2,23 +2,108 @@
 FullIP HTTP Server
 ******************
 
+(Work in progress ...)
+
 
 Installation
 ============
 
-Download and install FullIP (Look at *Installation*).
+Download and install FullIP (Look at "Installation instructions").
 
 Uncomment #define FULLIP_SD to enable SD in FullIP.h.
 
 
 Usage
 =====
 
-
-Full example
-============
-
-Get the full "example".
+Create a rootdir directory on your SD and copy the html files in it
+
+Define a variable for the HTTP server :
+
+   HttpServer http;
+
+Initialize the SD ans start the HTTP server :
+
+   pinMode(PIN_SD_CS, OUTPUT);
+   if (!SD.begin(PIN_SD_CS)) {
+       Serial.println("SD failed :");
+   } else {
+       Serial.println("SD configured :)");
+   }
+   http.begin(rootdir, parseUrl, parsePage);
+
+And process client connections in your loop :
+
+   http.maintain();
+
+Define a callback function to parse the requested URL :
+
+   byte parseUrl(EthernetClient client, char mode[], char url[], byte state) {
+     //Serial.print("freeMemory()=");
+     //Serial.println(freeMemory());
+     byte ret=0;
+     char buffer[80];
+     if (state==0) {
+         urlStateMachine=0;
+         if (strcmp_P(url,PSTR("/state"))==0) {
+             http.printJsonHeader(200,0);
+             strcpy_P(buffer,PSTR("{"));
+             client.println(buffer);
+             strcpy_P(buffer,PSTR("  rooms: ["));
+             client.println(buffer);
+             urlStateMachine++;
+             ret=1;
+           }
+     } else if (state==1)
+         if (strcmp_P(url,PSTR("/state"))==0) {
+             if (urlStateMachine==1) {
+               strcpy_P(buffer,PSTR("      {key: \"kitchen\", name: \"Cuisine\", devices: ["));
+               client.println(buffer);
+               sprintf_P(buffer,PSTR("        {key: \"Lampe1\", name: \"plafonnier\", state: %i},"),digitalRead(1));
+               client.println(buffer);
+               sprintf_P(buffer,PSTR("        {key: \"Lampe2\", name: \"applique\", state: %i}"),digitalRead(2));
+               client.println(buffer);
+               strcpy_P(buffer,PSTR("      ]},"));
+               client.println(buffer);
+               urlStateMachine++;
+               ret=1;
+             } else if (urlStateMachine==2) {
+               strcpy_P(buffer,PSTR("      {key: \"bedroom\", name: \"Chambre a coucher\", devices: ["));
+               client.println(buffer);
+               sprintf_P(buffer,PSTR("        {key: \"Lampe1\", name: \"plafonnier\", state: %i},"),digitalRead(3));
+               client.println(buffer);
+               sprintf_P(buffer,PSTR("        {key: \"Lampe2\", name: \"applique\", state: %i}"),digitalRead(4));
+               client.println(buffer);
+               strcpy_P(buffer,PSTR("      ]},"));
+               client.println(buffer);
+               urlStateMachine++;
+               ret=1;
+             } else if (urlStateMachine==3) {
+               strcpy_P(buffer,PSTR("      {key: \"outdoor\", name: \"Exterieur\", devices: ["));
+               client.println(buffer);
+               sprintf_P(buffer,PSTR("        {key: \"Lampe\", name: \"appliques\", state: %i}"),digitalRead(5));
+               client.println(buffer);
+               strcpy_P(buffer,PSTR("      ]}"));
+               client.println(buffer);
+               strcpy_P(buffer,PSTR("   ]"));
+               client.println(buffer);
+               strcpy_P(buffer,PSTR("}"));
+               client.println(buffer);
+               urlStateMachine++;
+               ret=0;
+             }
+         }
+     return ret;
+   }
+
+Define a callback function to parse the page content :
+
+   byte parsePage(EthernetClient client, char buffer[], int bsize)
+   {
+     if (strcmp_P(buffer,"/state")==0) {
+     }
+     return 0;
+   }
 
 
 Class definition

doc/installation.txt

@@ -6,15 +6,20 @@ FullIP for Arduino
 
 FullIP is a suite of ip protocols implementation for Arduino.
 
-* Download the library from github (https://github.com/bibi21000
-  /arduino-fullip).
+* Download the library from github : https://github.com/bibi21000
+  /arduino-fullip.
 
-* Install it in your libraries in a directory called FullIP.
+* Install it in your libraries. Rename the directory to FullIP.
+
+* If you want to use FullIP with enc28j60, install the UIPEthernet
+  library : https://github.com/ntruchsess/arduino_uip.
+
+* Restart Arduino IDE.
 
 * Update FullIP.h according to your hardware :
 
   * comment #define FULLIP_UIP to build with official shield (w5100)
-    or uncomment it to build with enc28j60 and UIPEthernet
+    or uncomment it to build with enc28j60 and UIPEthernet.
 
   * comment #define FULLIP_SD to disable SD or uncomment it to build
     ftpclient, httpserver, ...

doc/smtpclient.txt

@@ -6,19 +6,19 @@ FullIP SMTP Client
 Installation
 ============
 
-Download and install FullIP (Look at *Installation*).
+Download and install FullIP (Look at "Installation instructions").
 
 Comment #define FULLIP_SD to disable SD in FullIP.h.
 
 
 Usage
 =====
 
-Define a variable dor the SMTP client
+Define a variable for the SMTP client :
 
    SmtpClient smtpclient;
 
-Start the SMTP client
+Start the SMTP client :
 
    smtpclient.begin(server_name,domain_name);
 
@@ -32,21 +32,15 @@ using the following command in a terminal :
    $ perl -MMIME::Base64 -e 'print encode_base64("\000myuser\@yourisp.com\000password")'
    $ AG15dXNlckB5b3VyaXNwLmNvbQBwYXNzd29yZA==
 
-Put a mail in the queue
+Put a mail in the queue :
 
    smtpclient.sendMail(from,to,subject,body)
 
-And send it in your loop
+And send it in your loop :
 
    smtpclient.maintain();
 
 
-Full example
-============
-
-Get the full "example".
-
-
 Class definition
 ================
 

doc/telnetserver.txt

@@ -6,19 +6,76 @@ FullIP Telnet Server
 Installation
 ============
 
-Download and install FullIP (Look at *Installation*).
+Download and install FullIP (Look at "Installation instructions").
 
 Comment #define FULLIP_SD to disable SD in FullIP.h.
 
 
 Usage
 =====
 
-
-Full example
-============
-
-Get the full "example".
+Define a variable for the Telnet server :
+
+   TelnetServer telnet;
+
+Start the Telnet server :
+
+   telnet.begin(parse);
+
+And process client connections in your loop :
+
+   telnet.maintain();
+
+Define a callback function to parse the client commands and send
+result to it :
+
+   byte parse(char buffer[]) {
+     char buff2[4];
+     int pin;
+     if (strcmp_P(buffer,PSTR(""))==0) {
+             telnet.client.println("Here is my telnet");
+             return 1;
+     } else if (strcmp_P(buffer,PSTR("?"))==0) {
+             telnet.client.println("get pin XX : show the state of the pin XX");
+             telnet.client.println("set pin XX : change the state of the pin XX");
+             return 1;
+     } else if (strncmp_P(buffer,PSTR("get pin "),8)==0) {
+             buff2[0]=buffer[8];
+             buff2[1]=buffer[9];
+             buff2[2]='\0';
+             pin=atoi(buff2);
+             int val=digitalRead(pin);
+             telnet.client.print("pin ");
+             telnet.client.print(buff2);
+             telnet.client.print(" : ");
+             if (digitalRead(pin)==HIGH) {
+                   telnet.client.println("HIGH");
+             } else {
+                   telnet.client.println("LOW");
+             }
+             return 1;
+     } else if (strncmp_P(buffer,PSTR("set pin "),8)==0) {
+             buff2[0]=buffer[8];
+             buff2[1]=buffer[9];
+             buff2[2]='\0';
+             pin=atoi(buff2);
+             int val=digitalRead(pin);
+             telnet.client.print("pin ");
+             telnet.client.print(buff2);
+             telnet.client.print(" : ");
+             if (digitalRead(pin)==HIGH) {
+                   digitalWrite(pin,LOW);
+                   telnet.client.println("LOW");
+             } else {
+                   digitalWrite(pin,HIGH);
+                   telnet.client.println("HIGH");
+             }
+             return 1;
+     }
+     return 0;
+   }
+
+This function must return 1 if the command is recognized and 0 if not.
 
 
 Class definition
@@ -28,6 +85,10 @@ typedef uint8_t(* **telnetParseCommand**)(char[])
 
    The user defined callback for parsing commands.
 
+   **Parameters**
+      * "char" -
+        : the command sent by the client
+
 *class* **TelnetServer**
 
    The Telnet Server.

sphinx/ftpclient.rst

@@ -6,39 +6,45 @@ FullIP FTP Client
 Installation
 ============
 
-Download and install FullIP (Look at :doc:`installation`).
+Download and install FullIP (Look at "Installation instructions").
 
 Uncomment #define FULLIP_SD to enable SD in FullIP.h.
 
 
 Usage
 =====
 
-Define a variable for the FTP client
+Define a variable for the FTP client :
 
 .. code-block:: c
 
  FtpClient ftpclient;
 
-Start the FTP client
+Initialize the SD and start the FTP client :
 
 .. code-block:: c
 
- ftpclient.begin(server_name,user_name,password);
+  pinMode(PIN_SD_CS, OUTPUT);
+  if (!SD.begin(PIN_SD_CS)) {
+      Serial.println("SD failed :");
+  } else {
+      Serial.println("SD configured :)");
+  }
+  ftpclient.begin(server_name,user_name,password);
 
-Send a file 
+Send a file  :
 
 .. code-block:: c
 
  ftpclient.sendFile(filename2,local_dir,remote_dir)
 
-Or retrieve one 
+Or retrieve one :
 
 .. code-block:: c
 
  ftpclient.getFile(filename2,local_dir,remote_dir)
 
-And process it in your loop
+And process it in your loop :
 
 .. code-block:: c