2018.11.09. / official release

- SPPC(Serial Phpoc Procedure Call) support
- spi protocol v2 support
- new class : Sppc
- new member functions
  . PhpocClient : command, avaiableForWrite
  . PhpocServer : beginWebSocketText, beginWebSocketBinary
- Phpoc
  . begin boot wait support (500ms)
  . clear smtp MSA in begin()
  . cache v2 support : NetCache
- PhpocServer
  . WebSocket path table support
  . beginWebSocket : remove path argument default value (NULL)
  . new beginWebSocket argument : proto
  . proto setup bug fix
  . add 'connected' log message
- PhpocClient
  . SSL "method client" support
  . new static/public flags : client.conn_flags, client.init_flags
- PhpocEmail : tcp0 busy bug fix ("tcp0 ioctl close" => "tcp0 close")
- remove SSL/SSH server
- new library metadata : includes=Phpoc.h
- new boot log : product name, firmware/package version
- examples
  . add new comments & tutorial URL
  . new example URL : example.phpoc.com/asciilogo.txt
  . new example URL : example.phpoc.com/remote_add
  . new examples : WebSerialPlotter, WebRemotePad

Author: phpoc

README.md

@@ -8,13 +8,13 @@ Available Examples
 * DateTime
 * EmailClient
 * GmailClient
-* SSHServer
-* SSLServer
 * TelnetServer
 * WebClient
 * WebClientIPv6
+* WebRemotePad
 * WebRemotePush
 * WebRemoteSlide
+* WebSerialPlotter
 * WebSSLClient
 * WebSSLClientIPv6
 

examples/ChatServer/ChatServer.ino

@@ -1,6 +1,23 @@
-/* arduino chat server - 4 listening sessions */
+// Arduino Chat Server - 4 Listening Sessions
+//
+// PHPoC Shield and PHPoC WiFi Shield are Internet Shields for Arduino Uno and
+// Mega.
+//
+// This is an example of using Arduino Uno/Mega and PHPoC [WiFi] Shield to
+// create a TCP server that can connect up to 4 TCP clients simultaneously. It
+// distributes any incoming messages to all connected clients. The incoming
+// messages are also printed to the serial monitor.
+//
+// Arduino communicates with PHPoC [WiFi] Shield via pins 10, 11, 12 and 13 on
+// the Uno, and pins 10, 50, 51 and 52 on the Mega. Therefore, these pins CANNOT
+// be used for general I/O.
+//
+// This example code was written by Sollae Systems. It is released into the
+// public domain.
+//
+// Tutorial for the example is available here:
+// https://forum.phpoc.com/articles/tutorials/1232-arduino-tcp-chat-server
 
-#include <SPI.h>
 #include <Phpoc.h>
 
 PhpocServer server(23);
@@ -11,13 +28,16 @@ void setup() {
   while(!Serial)
     ;
 
+  // initialize PHPoC [WiFi] Shield:
   Phpoc.begin(PF_LOG_SPI | PF_LOG_NET);
   //Phpoc.begin();
 
+  // start listening for TCP clients:
   server.begin();
 
+  // print IP address of PHPoC [WiFi] Shield to serial monitor:
   Serial.print("Chat server address : ");
-  Serial.println(Phpoc.localIP());  
+  Serial.println(Phpoc.localIP());
 }
 
 void loop() {
@@ -37,10 +57,10 @@ void loop() {
     if (client.available() > 0) {
       // read the bytes incoming from the client:
       char thisChar = client.read();
-      // echo the bytes back to the client:
+      // echo the bytes back to all connected clients:
       server.write(thisChar);
       // echo the bytes to the server as well:
       Serial.write(thisChar);
     }
   }
-}
+}

examples/ChatServerIPv6/ChatServerIPv6.ino

@@ -1,6 +1,23 @@
-/* arduino IPv4 & IPv6 dual stack chat server - 4 listening sessions */
+// Arduino IPv4 & IPv6 Dual Stack Chat Server - 4 Listening Sessions
+//
+// PHPoC Shield and PHPoC WiFi Shield are Internet Shields for Arduino Uno and
+// Mega.
+//
+// This is an example of using Arduino Uno/Mega and PHPoC [WiFi] Shield to
+// create a TCP server that can connect up to 4 TCP clients simultaneously using
+// IPv6. It distributes any incoming messages to all connected clients. The
+// incoming messages are also printed to the serial monitor.
+//
+// Arduino communicates with PHPoC [WiFi] Shield via pins 10, 11, 12 and 13 on
+// the Uno, and pins 10, 50, 51 and 52 on the Mega. Therefore, these pins CANNOT
+// be used for general I/O.
+//
+// This example code was written by Sollae Systems. It is released into the
+// public domain.
+//
+// Tutorial for the example is available here:
+// https://forum.phpoc.com/articles/tutorials/1233-arduino-tcp-ipv6-chat-server
 
-#include <SPI.h>
 #include <Phpoc.h>
 
 PhpocServer server(23);
@@ -11,19 +28,23 @@ void setup() {
   while(!Serial)
     ;
 
+  // initialize PHPoC [WiFi] Shield:
   Phpoc.begin(PF_LOG_SPI | PF_LOG_NET);
   //Phpoc.begin();
 
+  // initialize IPv6:
   Phpoc.beginIP6();
 
+  // start listening for TCP clients:
   server.begin();
 
+  // print IP address of PHPoC [WiFi] Shield to serial monitor:
   Serial.print("Chat server address : ");
-  Serial.print(Phpoc.localIP());  
+  Serial.print(Phpoc.localIP());
   Serial.print(' ');
-  Serial.print(Phpoc.localIP6());  
+  Serial.print(Phpoc.localIP6());
   Serial.print(' ');
-  Serial.print(Phpoc.globalIP6());  
+  Serial.print(Phpoc.globalIP6());
   Serial.println();
 }
 
@@ -44,10 +65,10 @@ void loop() {
     if (client.available() > 0) {
       // read the bytes incoming from the client:
       char thisChar = client.read();
-      // echo the bytes back to the client:
+      // echo the bytes back to all connected clients:
       server.write(thisChar);
       // echo the bytes to the server as well:
       Serial.write(thisChar);
     }
   }
-}
+}

examples/DateTime/DateTime.ino

@@ -1,6 +1,24 @@
-/* arduino RTC date & time test */
+// Arduino RTC Date & Time Test
+//
+// PHPoC Shield and PHPoC WiFi Shield are Internet Shields for Arduino Uno and
+// Mega.
+//
+// PHPoC [WiFi] Shield has a built-in rechargeable battery and RTC that allow to
+// keep date and time information even when power is down.
+//
+// This is an example of using Arduino Uno/Mega to get date and time information
+// from RTC on PHPoC [WiFi] Shield and print it to serial monitor.
+//
+// Arduino communicates with PHPoC [WiFi] Shield via pins 10, 11, 12 and 13 on
+// the Uno, and pins 10, 50, 51 and 52 on the Mega. Therefore, these pins CANNOT
+// be used for general I/O.
+//
+// This example code was written by Sollae Systems. It is released into the
+// public domain.
+//
+// Tutorial for the example is available here:
+// https://forum.phpoc.com/articles/tutorials/1244-arduino-date-and-time
 
-#include <SPI.h>
 #include <Phpoc.h>
 
 PhpocDateTime datetime;
@@ -9,30 +27,32 @@ void setup() {
   Serial.begin(9600);
   while(!Serial)
     ;
-    
-  Phpoc.begin();
-  
+
+  // initialize PHPoC [WiFi] Shield:
+  Phpoc.begin(PF_LOG_SPI | PF_LOG_NET);
+
   Serial.println("Get year/month/day/dayofWeek/hour/minute/second from RTC in PHPoC Shield");
-  
+
   Serial.print(datetime.year());
   Serial.print('-');
   Serial.print(datetime.month());
   Serial.print('-');
   Serial.print(datetime.day());
   Serial.print(' ');
   Serial.print(datetime.dayofWeek());
-  Serial.print(':');
+  Serial.print(' ');
   Serial.print(datetime.hour());
   Serial.print(':');
   Serial.print(datetime.minute());
   Serial.print(':');
   Serial.print(datetime.second());
   Serial.println();
 
-  datetime.date("Y-m-d H:i:s");
+  // set date and time format:
+  datetime.date(F("Y-m-d H:i:s"));
 }
 
 void loop() {
   Serial.println(datetime.date());
-  delay(1000);
-}
+  delay(10);
+}

examples/EmailClient/EmailClient.ino

@@ -1,38 +1,54 @@
-/* arduino email client - send email to server directly */
+// Arduino Email Client - Send Email to Server Directly
+//
+// PHPoC Shield and PHPoC WiFi Shield are Internet Shields for Arduino Uno and
+// Mega.
+//
+// This is an example of using Arduino Uno/Mega and PHPoC [WiFi] Shield to send
+// an email
+//
+// Arduino communicates with PHPoC [WiFi] Shield via pins 10, 11, 12 and 13 on
+// the Uno, and pins 10, 50, 51 and 52 on the Mega. Therefore, these pins CANNOT
+// be used for general I/O.
+//
+// This example code was written by Sollae Systems. It is released into the
+// public domain.
+//
+// Tutorial for the example is available here:
+// https://forum.phpoc.com/articles/tutorials/1252-arduino-email-client
 
-#include "SPI.h"
-#include "Phpoc.h"
+#include <Phpoc.h>
 
 PhpocEmail email;
 
 void setup() {
   Serial.begin(9600);
   while(!Serial)
     ;
-    
+
+  // initialize PHPoC [WiFi] Shield:
   Phpoc.begin(PF_LOG_SPI | PF_LOG_NET | PF_LOG_APP);
   //Phpoc.begin();
-  
+
   Serial.println("Sending email to server directly");
 
-  // setup From/To/Subject
+  // setup From/To/Subject:
   email.setFrom("from_email_address", "from_user_name");
   email.setTo("to_email_address", "to_user_name");
   email.setSubject("Mail from PHPoC Shield for Arduino");
 
-  // write email message
+  // write email message:
   email.beginMessage();
   email.println("Hello, world!");
   email.println("I am PHPoC Shield for Arduino");
   email.println("Good bye");
   email.endMessage();
-  
-  // send email
+
+  // send email:
   if(email.send() > 0)
     Serial.println("Email send ok");
   else
     Serial.println("Email send failed");
 }
 
 void loop() {
-}
+}

examples/GmailClient/GmailClient.ino

@@ -1,52 +1,69 @@
-/* arduino email client - send email via gmail relay server */
+// Arduino Email Client - Send Email via Gmail Relay Server
+//
+// PHPoC Shield and PHPoC WiFi Shield are Internet Shields for Arduino Uno and
+// Mega.
+//
+// This is an example of using Arduino Uno/Mega and PHPoC [WiFi] Shield to send
+// an email via Gmail Relay Server.
+//
+// Arduino communicates with PHPoC [WiFi] Shield via pins 10, 11, 12 and 13 on
+// the Uno, and pins 10, 50, 51 and 52 on the Mega. Therefore, these pins CANNOT
+// be used for general I/O.
+//
+// This example code was written by Sollae Systems. It is released into the
+// public domain.
+//
+// Tutorial for the example is available here:
+// https://forum.phpoc.com/articles/tutorials/1238-arduino-gmail-client
 
-#include "SPI.h"
-#include "Phpoc.h"
+#include <Phpoc.h>
 
 PhpocEmail email;
 
 void setup() {
   Serial.begin(9600);
   while(!Serial)
     ;
-    
+
+  // initialize PHPoC [WiFi] Shield:
   Phpoc.begin(PF_LOG_SPI | PF_LOG_NET | PF_LOG_APP);
   //Phpoc.begin();
-  
+
   Serial.println("Sending email to gmail relay server");
 
   // [login using your private password]
-  // Google may block sign-in attempts from some apps or devices that do not use modern security standards.
+  // Google may block sign-in attempts from some apps or devices that do not use
+  // modern security standards.
   // Change your settings to allow less secure apps to access your account.
   // https://www.google.com/settings/security/lesssecureapps
-  
+
   // [login using app password]
   // 1. turn on 2-step verification
   // 2. create app password
   // 3. apply app password as your login password
 
-  // setup outgoing relay server - gmail.com
+  // setup outgoing relay server - gmail.com:
   email.setOutgoingServer("smtp.gmail.com", 587);
   email.setOutgoingLogin("your_login_id", "your_login_password or app_password");
 
-  // setup From/To/Subject
+  // setup From/To/Subject:
   email.setFrom("from_email_address", "from_user_name");
   email.setTo("to_email_address", "to_user_name");
   email.setSubject("Mail from PHPoC Shield for Arduino");
 
-  // write email message
+  // write email message:
   email.beginMessage();
   email.println("Hello, world!");
   email.println("I am PHPoC Shield for Arduino");
   email.println("Good bye");
   email.endMessage();
 
-  // send email
+  // send email:
   if(email.send() > 0)
     Serial.println("Email send ok");
   else
     Serial.println("Email send failed");
 }
 
 void loop() {
-}
+}