Skip to content

Commit 72c395b

Browse files
authored
Merge pull request #85 from pennam/readme-fix
Update readme with last changes
2 parents 04af28b + d39737e commit 72c395b

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,20 @@ Arduino Library for network connections management
66
[![Spell Check status](https://github.com/arduino-libraries/Arduino_ConnectionHandler/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_ConnectionHandler/actions/workflows/spell-check.yml)
77

88
Library for handling and managing network connections by providing keep-alive functionality and automatic reconnection in case of connection-loss. It supports the following boards:
9-
* **WiFi**: [`MKR 1000`](https://store.arduino.cc/arduino-mkr1000-wifi), [`MKR WiFi 1010`](https://store.arduino.cc/arduino-mkr-wifi-1010), [`Nano 33 IoT`](https://store.arduino.cc/arduino-nano-33-iot), [`Portenta H7`](https://store.arduino.cc/products/portenta-h7), [`Nano RP2040 Connect`](https://store.arduino.cc/products/arduino-nano-rp2040-connect), [`Nicla Vision`](https://store.arduino.cc/products/nicla-vision), `ESP8266`
9+
* **WiFi**: [`MKR 1000`](https://store.arduino.cc/arduino-mkr1000-wifi), [`MKR WiFi 1010`](https://store.arduino.cc/arduino-mkr-wifi-1010), [`Nano 33 IoT`](https://store.arduino.cc/arduino-nano-33-iot), [`Portenta H7`](https://store.arduino.cc/products/portenta-h7), [`Nano RP2040 Connect`](https://store.arduino.cc/products/arduino-nano-rp2040-connect), [`Nicla Vision`](https://store.arduino.cc/products/nicla-vision), [`ESP8266`](https://github.com/esp8266/Arduino/releases/tag/2.5.0), [`ESP32`](https://github.com/espressif/arduino-esp32)
1010
* **GSM**: [`MKR GSM 1400`](https://store.arduino.cc/arduino-mkr-gsm-1400-1415)
1111
* **5G**: [`MKR NB 1500`](https://store.arduino.cc/arduino-mkr-nb-1500-1413)
1212
* **LoRa**: [`MKR WAN 1300/1310`](https://store.arduino.cc/mkr-wan-1310)
13+
* **Ethernet**: [`Portenta H7`](https://store.arduino.cc/products/portenta-h7) + [`Vision Shield Ethernet`](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet), [`Max Carrier`](https://store.arduino.cc/products/portenta-max-carrier), [`Breakout`](https://store.arduino.cc/products/arduino-portenta-breakout), [`Portenta Machine Control`](https://store.arduino.cc/products/arduino-portenta-machine-control)
1314

1415
### How-to-use
1516

1617
```C++
1718
#include <Arduino_ConnectionHandler.h>
1819
/* ... */
19-
#if defined(BOARD_HAS_WIFI)
20+
#if defined(BOARD_HAS_ETHERNET)
21+
EthernetConnectionHandler conMan;
22+
#elif defined(BOARD_HAS_WIFI)
2023
WiFiConnectionHandler conMan("SECRET_SSID", "SECRET_PASS");
2124
#elif defined(BOARD_HAS_GSM)
2225
GSMConnectionHandler conMan("SECRET_PIN", "SECRET_APN", "SECRET_GSM_LOGIN", "SECRET_GSM_PASS");

examples/ConnectionHandlerDemo/ConnectionHandlerDemo.ino

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* If using a Portenta + Ethernet shield you'll need a EthernetConnectionHandler object as follows:
1919
*
2020
* DHCP mode
21-
* EthernetConnectionHandler conMan();
21+
* EthernetConnectionHandler conMan;
2222
*
2323
* Manual configuration
2424
* EthernetConnectionHandler conMan(SECRET_IP, SECRET_DNS, SECRET_GATEWAY, SECRET_NETMASK);

0 commit comments

Comments
 (0)