electron-rare/ArduinoProps
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modifiy compatible hardware in docu

Browse Source
This commit is contained in:
fauresystems
2019-11-08 07:01:07 +01:00
parent 2ef644fcd4
commit 67418d7bef
3 changed files with 37 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Arduino_Props.md
+17 -19
View File
@@ -69,26 +69,24 @@ Arduino with Ethernet or Wifi shield is suitable to build an Escape Room Props,
# Compatible hardware
The library is compatible with any Arduino board with Ethernet or Wifi capability.
*ArduinoProps library* supported harware:
- Arduino Yún and 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
- Arduino Ethernet
- Arduino Ethernet Shield
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 <WiFiNINA.h>` statement with appropriate one (`#include <ESP8266WiFi.h>` for ESP8266) in `WifiProps.h`:
* Sparkfun WiFly Shield – <a href="https://github.com/dpslwk/WiFly" target="_blank">library</a>
* TI CC3000 WiFi - <a href="https://github.com/sparkfun/SFE_CC3000_Library" target="_blank">library</a>
* 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
To use other WiFi hardware compatible with any *<a href="https://github.com/knolleary/pubsubclient" target="_blank">Nick O'Leary PubSubClient</a>* library you have to fork `WifiProps.h` and `WifiProps.cpp` and to replace `WiFiNINA.h` whih appropriate WiFi library (`ESP8266WiFi.h` for example):
- Arduino WiFi Shield
- Sparkfun WiFly Shield – [library](https://github.com/dpslwk/WiFly)
- TI CC3000 WiFi - [library](https://github.com/sparkfun/SFE_CC3000_Library)
- Intel Galileo/Edison
- ESP8266
- ESP32
## Author
Props.md
+17 -17
View File
@@ -319,24 +319,24 @@ See [EXAMPLES.md](EXAMPLES.md) for an adaptation of the Blink example (https://w
## 7. Compatible hardware
*Props* library is compatible with any Arduino board with Ethernet or Wifi capability.
*Props library* supported harware:
- Arduino Yún and 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
- Arduino Ethernet
- Arduino Ethernet Shield
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 <WiFiNINA.h>` statement with appropriate one (`#include <ESP8266WiFi.h>` for ESP8266) in `WifiProps.h`:
* Sparkfun WiFly Shield – <a href="https://github.com/dpslwk/WiFly" target="_blank">library</a>
* TI CC3000 WiFi - <a href="https://github.com/sparkfun/SFE_CC3000_Library" target="_blank">library</a>
* Intel Galileo/Edison
* ESP8266
* ESP32
To use other WiFi hardware compatible with any *<a href="https://github.com/knolleary/pubsubclient" target="_blank">Nick O'Leary PubSubClient</a>* library you have to fork `WifiProps.h` and `WifiProps.cpp` and to replace `WiFiNINA.h` whih appropriate WiFi library (`ESP8266WiFi.h` for example):
- Arduino WiFi Shield
- Sparkfun WiFly Shield – [library](https://github.com/dpslwk/WiFly)
- TI CC3000 WiFi - [library](https://github.com/sparkfun/SFE_CC3000_Library)
- Intel Galileo/Edison
- ESP8266
- ESP32
## Author
README.md
+3 -2
View File
@@ -157,8 +157,7 @@ More MQTT topics can be use for anything (room scenario, etc.).
## 5. Compatible hardware
You can use the *ArduinoProps library* with any *Nick O'Leary PubSubClient* supported hardware. It uses the Arduino Ethernet Client api for interacting with the underlying network hardware. This means it Just Works with a growing number of boards and shields, including:
*ArduinoProps library* supported harware:
- Arduino Yún and Arduino Yún Rev 2
- Arduino Mega 2560 Rev3 + Dragino Yún Shield
- Elegoo Mega 2560 R3 + Dragino Yún Shield
@@ -168,6 +167,8 @@ You can use the *ArduinoProps library* with any *Nick O'Leary PubSubClient* supp
- Arduino MKR VIDOR 4000
- Arduino Ethernet
- Arduino Ethernet Shield
To use other WiFi hardware compatible with any *<a href="https://github.com/knolleary/pubsubclient" target="_blank">Nick O'Leary PubSubClient</a>* library you have to fork `WifiProps.h` and `WifiProps.cpp` and to replace `WiFiNINA.h` whih appropriate WiFi library (`ESP8266WiFi.h` for example):
- Arduino WiFi Shield
- Sparkfun WiFly Shield – [library](https://github.com/dpslwk/WiFly)
- TI CC3000 WiFi - [library](https://github.com/sparkfun/SFE_CC3000_Library)