From 61fe4941a61307c5862241b4e458ceb90c187dde Mon Sep 17 00:00:00 2001 From: fauresystems <34378695+fauresystems@users.noreply.github.com> Date: Thu, 7 Nov 2019 19:06:58 +0100 Subject: [PATCH] Add compatible hardware in docu --- Arduino_Props.md | 32 +++++++++++++++++++++++++++++--- Props.md | 22 ++++++++++++++++++++++ README.md | 5 ++++- 3 files changed, 55 insertions(+), 4 deletions(-) diff --git a/Arduino_Props.md b/Arduino_Props.md index 84d4bc5..46c7c05 100644 --- a/Arduino_Props.md +++ b/Arduino_Props.md @@ -38,7 +38,7 @@ How does *ArduinoProps library* use MQTT efficiently in escape rooms: - Every props has two MQTT topics assigned as inbox and outbox. - More MQTT topics can be used to share game countdown, scenario or any common useful dynamic data for the escape game. - Notifying the props is done by publishing a message on its inbox topic. -- Other props of software monitor can subscribe to the props outbox topic to receive all its notifications. +- Other props or software controllers can subscribe to the props outbox topic to receive all its notifications. - *ArduinoProps library* includes a ping process at application level, in LAN network the round-trip-delay is around 50 milliseconds. - *ArduinoProps library* is defaulted to publish QoS 0 messages and to subscribe at QoS 1. @@ -57,12 +57,38 @@ Arduino YUN can be rebooted or its MCU resetted remotely with simple SSH command Moreover, SSH command can be used to remotely change the MQTT server IP address, *ArduinoProps library* read this address at sketch start. -Therefore, Arduino YUN or YUN shield is the preferred solution for props with Arduino boards because it will be very easy to sustain over time and greatly facilitates fallback plans to ensure maximum uptime. +Therefore, **Arduino YUN or YUN shield is the preferred solution for props with Arduino boards** because it will be very easy to sustain over time and greatly facilitates fallback plans to ensure maximum uptime: +- **Arduino Yún** +- **Arduino Yún Rev 2** +- **Arduino Mega 2560 Rev3 + Dragino Yún Shield** +- **Elegoo Mega 2560 R3 + Dragino Yún Shield** + # Arduino Ethernet and Wifi Arduino with Ethernet or Wifi shield is suitable to build an Escape Room Props, however the sketch must be uploaded with an USB cable, so it is not convenient for props design and worse for props in production. -Therefore I strongly advise Arduino YUN or YUN shield for Escape Room props. + +# Compatible hardware +The library is compatible with any Arduino board with Ethernet or Wifi capability. + +For Wifi hardware, only **WiFiNINA** boards will compile "as is" (Arduino Uno WiFi Rev 2, Arduino NANO 33 IoT, Arduino MKR 1010 and Arduino MKR VIDOR 4000). + +For others Wifi hardware, replace the `#include ` statement with appropriate one (`#include ` for ESP8266) in `WifiProps.h`: +* Sparkfun WiFly Shield – library +* TI CC3000 WiFi - library +* Intel Galileo/Edison +* ESP8266 +* ESP32 + +The *AduinoProps* library has been tested with: +- Arduino Yún +- Arduino Yún Rev 2 +- Arduino Mega 2560 Rev3 + Dragino Yún Shield +- Elegoo Mega 2560 R3 + Dragino Yún Shield +- Arduino Uno WiFi Rev 2 +- Arduino NANO 33 IoT +- Arduino MKR 1010 +- Arduino MKR VIDOR 4000 ## Author diff --git a/Props.md b/Props.md index 57e8fc0..1266541 100644 --- a/Props.md +++ b/Props.md @@ -16,6 +16,7 @@ 4. Implement `InboxMessage::run()` callback 5. Update broker address from SSH (*BridgeProps*) 6. Examples +7. Compatible hardware ## 1. Defines the *Props* @@ -317,6 +318,27 @@ See [EXAMPLES.md](EXAMPLES.md) for an adaptation of the Blink example (https://w 4. **BlinkOnBridgePubSub**: the Blink example on props using *PubSubClient* directly +## 7. Compatible hardware +*Props* library is compatible with any Arduino board with Ethernet or Wifi capability. + +The library has been tested with: +- **Arduino Yún** +- **Arduino Yún Rev 2** +- **Arduino Mega 2560 Rev3 + Dragino Yún Shield** +- **Elegoo Mega 2560 R3 + Dragino Yún Shield** +- **Arduino Uno WiFi Rev 2** +- **Arduino NANO 33 IoT** +- **Arduino MKR 1010** +- **Arduino MKR VIDOR 4000** + +It will works with other Wifi capable hardware compatible with *[Nick O'Leary PubSubClient](https://github.com/knolleary/pubsubclient)* by replacing the `#include ` statement with appropriate one (`#include ` for ESP8266) in `WifiProps.h`: +* Sparkfun WiFly Shield – library +* TI CC3000 WiFi - library +* Intel Galileo/Edison +* ESP8266 +* ESP32 + + ## Author **Marie FAURE** (Oct 18th, 2019) diff --git a/README.md b/README.md index 663e9a7..9fc6423 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,10 @@ The *ArduinoProps library* allows to build *escape room 2.0 props* easily with A The *ArduinoProps library* relies on *Nick O'Leary PubSubClient* library for MQTT. MQTT is a lightweight publish/subscribe messaging protocol designed for M2M (machine to machine) telemetry in low bandwidth environments. -You will find Raspberry Pi libraries for escape room 2.0 props at https://github.com/fauresystems +### Props with *Raspberry* +Escape room 2.0 props can be powered with Raspberry Pi or any Pythonic nanocomputer using *MqttApp*, our pure Python 3 class based on Eclipse Paho™ MQTT Python Client. + +You will find Raspberry Pi libraries for escape room 2.0 props at [https://github.com/fauresystems](https://github.com/fauresystems), to build props with RPi.GPIO, Pi Hats, Guizero, Pygames, PyQt5 or Kivi. ## 3. *ArduinoProps library* value for escape room 2.0