compatible with Arduino IDE 2.0

+ Auto install dependencies
+ update MQTT example

Author: RoanBrand

README.md

@@ -5,19 +5,20 @@ Open a TCP connection to a server from the Arduino using just serial. No Etherne
 Quickly communicate with other servers and make network apps using minimal hardware.  
 See [this](https://github.com/RoanBrand/SerialToTCPBridgeProtocol) for more information on the protocol and for the **Protocol Gateway** you will need to run on the host PC the Arduino is connected to serially.  
 
-## Requires:
+## Hardware Requirements:
 - Serial 0 (Main serial through USB)
 - Timer 1
 
 ## Dependencies
-- [NeoHWSerial](https://github.com/SlashDevin/NeoHWSerial) - Install manually
-- [CRC32](https://github.com/bakercp/CRC32) v2.0.0 - Can be installed from the Arduino *Library Manager*
+- [NeoHWSerial](https://github.com/gicking/NeoHWSerial) v1.6.6
+- [CRC32](https://github.com/bakercp/CRC32) v2.0.0
+- [PubSubClient](https://github.com/knolleary/pubsubclient) v2.8.0 - Needed for the included **MQTT Client Example**
 
-After installing the dependencies and this library, make sure you have all 3 present inside your **libraries** sub-directory of your sketchbook directory.  
+These should install automatically when installing this library through the Arduino *Library Manager*.
 
 ## How to
 - Get the [Protocol Gateway](https://github.com/RoanBrand/SerialToTCPBridgeProtocol) and build it.
-- Change the gateway's config to listen on the COM port connected to your Arduino and start it.
+- Change the gateway's config to listen on the Serial port connected to your Arduino and start it.
 - Your Arduino app can then use the `ArduinoSerialToTCPBridgeClient` API which is similar to the `EthernetClient` API to make tcp connections to servers as long as they are reachable from the host PC and the gateway service is running.
 
 ## Web Client Example
@@ -28,12 +29,12 @@ After installing the dependencies and this library, make sure you have all 3 pre
 - On other boards with more hardware serial ports than the Uno the example can be modified to use those instead (Serial1,2,etc.) and remove the software serial lib.
 
 ## MQTT Client Example
-1. Install [PubSubClient](https://github.com/knolleary/pubsubclient) - Manually, or from the Arduino *Library Manager*.
-2. Get a MQTT Broker running on your host PC, listening on `localhost`. I used [HiveMQ](www.hivemq.com).
-3. Open and upload the example from the Arduino *Examples menu*.
-4. Run the **Protocol Gateway** on the same PC, with the right COM port configuration.
-5. When the Arduino is connected to the MQTT broker, it will publish a message and subscribe to the `led` topic.
-6. You can use another MQTT client like [MQTT.fx](http://mqttfx.jfx4ee.org) to publish characters `0` and `1` to the topic `led` to toggle the led on and off on the Arduino board.
+1. Open and upload the example from the Arduino *Examples menu*.
+2. Run the **Protocol Gateway** on the same PC, with the correct Serial port configuration.
+3. After a short time, the Arduino should connect to the MQTT broker `mqtt.eclipseprojects.io`.
+4. Using a MQTT client, like [MQTTX](https://mqttx.app/), connect to the same broker and subscribe to the `ArduinoOut` topic.
+5. While the Arduino is connected to the MQTT broker, it will publish a message to the `ArduinoOut` topic every 5s.
+6. Using the client, publish characters `1` and `2` to topic `LedIn` to toggle the led on and off on the Arduino board.
 
 ### Details
 - Tested only on Arduino Uno. It would probably not work for the Arduino Due.

examples/MQTTClient/MQTTClient.ino

@@ -1,11 +1,14 @@
 /*
  * Basic example of MQTT Client running over the Serial To TCP Bridge Client.
  *
- * The example connects to a Broker serving on "localhost" on the host PC.
- * It will publish millis() as a message every 5s, while connected.
+ * It uses the MQTT client package PubSubClient from Nick O’Leary.
+ * Install it from the Library Manager, if not already automatically installed.
  *
- * Using another MQTT client:
- * Publish char '1' to topic "led" to turn on Led on Arduino Uno and '2' to turn off.
+ * The example connects to the public Broker at "mqtt.eclipseprojects.io".
+ * It will publish millis() as a message every 5s to topic "ArduinoOut", while connected.
+ *
+ * Using a MQTT client (e.g. https://mqttx.app):
+ * Publish character '1' to topic "LedIn" to turn on the Led on the Arduino Uno and '2' to turn it off.
  */
 
 #include <ArduinoSerialToTCPBridgeClient.h>
@@ -14,8 +17,8 @@
 ArduinoSerialToTCPBridgeClient*      s;  // Protocol Client running over USB Serial
 PubSubClient                    client;  // MQTT Client
 
-const char* broker   = "localhost";
-const char* ledTopic = "led";
+const char* broker   = "mqtt.eclipseprojects.io";
+const char* ledTopic = "LedIn";
 const char* outTopic = "ArduinoOut";
 
 uint32_t lastPub = 0;
@@ -68,7 +71,7 @@ void callback(char* topic, byte* payload, unsigned int length) {
 boolean connectToBroker() {
   if (client.connect("arduinoClient")) {
     // Publish first message on connect and subscribe to Led controller.
-    client.publish(outTopic, "Hello world!");
+    client.publish(outTopic, "Arduino connected!");
     client.subscribe(ledTopic);
     return true;
   } else {

library.properties

@@ -1,11 +1,11 @@
 name=ArduinoSerialToTCPBridgeClient
-version=1.1.0
+version=1.1.1
 author=Roan Brand <brandroan@gmail.com>
 maintainer=Roan Brand <brandroan@gmail.com>
-sentence=Open a TCP connection to a server from the Arduino using just serial. (No Ethernet/WiFi shields necessary)
-paragraph=Quickly communicate with other servers and make network apps using minimal hardware. INSTALL DEPENDENCIES! The Protocol Gateway service runs on the host, listens on a COM port connected to the Arduino, and opens TCP connections on behalf of the Protocol Client runnning on the Arduino, forwarding traffic bi-directionally. The protocol provides the app an in order, duplicates free and error checked byte stream by adding a CRC32 and simple retry mechanism.
+sentence=Open a TCP connection to a server from the Arduino using just Serial. (No Ethernet/WiFi shields necessary)
+paragraph=Quickly communicate with other servers and make network apps using minimal hardware. The Protocol Gateway service runs on the host, listens on a Serial port connected to the Arduino, and opens TCP connections on behalf of the Protocol Client runnning on the Arduino, forwarding traffic bi-directionally. The protocol provides the app an in order, duplicates free and error checked byte stream by adding a CRC32 and simple retry mechanism.
 category=Communication
 url=https://github.com/RoanBrand/ArduinoSerialToTCPBridgeClient
 architectures=*
 includes=ArduinoSerialToTCPBridgeClient.h
-depends=CRC32
+depends=CRC32 (=2.0.0), NeoHWSerial (=1.6.6), PubSubClient (>=2.8.0)