Add documentation to examples

Author: manchoz

Diff for: examples/RS485_fullduplex/RS485_fullduplex.ino

@@ -33,12 +33,26 @@ void setup()
     delay(1000);
     Serial.println("Start RS485 initialization");
 
+    // Set the PMC Communication Protocols to default config
     comm_protocols.init();
+    // RS485/RS232 default config is:
+    // - RS485 mode
+    // - Half Duplex
+    // - No A/B and Y/Z 120 Ohm termination enabled
+
+    // Enable the RS485/RS232 system
     comm_protocols.rs485Enable(true);
+
+    // Enable Full Duplex mode
+    // This will also enable A/B and Y/Z 120 Ohm termination resistors
     comm_protocols.rs485FullDuplex(true);
 
-    comm_protocols.rs485.receive();
+    // Specify baudrate, and preamble and postamble times for RS485 communication
     comm_protocols.rs485.begin(115200, 0, 500);
+    
+    // Start in receive mode
+    comm_protocols.rs485.receive();
+    
 
     Serial.println("Initialization done!");
 }
@@ -49,13 +63,17 @@ void loop()
         Serial.write(comm_protocols.rs485.read());
 
     if (millis() > sendNow) {
+        // Disable receive mode before transmission
         comm_protocols.rs485.noReceive();
+
         comm_protocols.rs485.beginTransmission();
 
         comm_protocols.rs485.print("hello ");
         comm_protocols.rs485.println(counter++);
 
         comm_protocols.rs485.endTransmission();
+        
+        // Re-enable receive mode after transmission
         comm_protocols.rs485.receive();
 
         sendNow = millis() + sendInterval;

Diff for: examples/RS485_halfduplex/RS485_halfduplex.ino

@@ -21,22 +21,33 @@ using namespace machinecontrol;
 constexpr unsigned long sendInterval { 1000 };
 unsigned long sendNow { 0 };
 
-unsigned long counter = 0;
+unsigned long counter { 0 };
 
 void setup()
 {
 
     Serial.begin(115200);
+    // Wait for Serial or start after 2.5s
     for (auto const timeout = millis() + 2500; !Serial && timeout < millis(); delay(500))
         ;
 
     delay(2500);
     Serial.println("Start RS485 initialization");
 
+    // Set the PMC Communication Protocols to default config
     comm_protocols.init();
+
+    // RS485/RS232 default config is:
+    // - RS485 mode
+    // - Half Duplex
+    // - No A/B and Y/Z 120 Ohm termination enabled
+
+    // Enable the RS485/RS232 system
     comm_protocols.rs485Enable(true);
 
+    // Specify baudrate, and preamble and postamble times for RS485 communication
     comm_protocols.rs485.begin(115200, 0, 500);
+    // Start in receive mode
     comm_protocols.rs485.receive();
 
     Serial.println("Initialization done!");
@@ -46,17 +57,21 @@ void loop()
 {
     if (comm_protocols.rs485.available())
         Serial.write(comm_protocols.rs485.read());
-    
+
     if (millis() > sendNow) {
+        // Disable receive mode before transmission
         comm_protocols.rs485.noReceive();
+
         comm_protocols.rs485.beginTransmission();
 
         comm_protocols.rs485.print("hello ");
         comm_protocols.rs485.println(counter++);
 
         comm_protocols.rs485.endTransmission();
 
-        sendNow = millis() + sendInterval;
+        // Re-enable receive mode after transmission
         comm_protocols.rs485.receive();
+
+        sendNow = millis() + sendInterval;
     }
 }