Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit cf33b60

Browse files
authored
v1.0.0
### Releases v1.0.0 1. Add support to ***nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B30_ublox, NINA_B112_ublox, etc.)***. 2. Add support to ***Adafruit SAMD21/SAM51 (Itsy-Bitsy M0/M4, Metro M0/M4, Grand Central M4, Feather M0/M4 Express, etc.)***. 3. Add support to ***STM32F, Teensy, SAM DUE***. 4. Add support to ESP32-AT shields. 5. Add debug AT command output
1 parent e47592d commit cf33b60

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

README.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
An ESP8266/ESP32 wrapper library for Arduino providing an easy-to-use way to manipulate ESP8266/ESP32-AT shields.
1010

11-
This library is based on, modified and improved from [TEADLIB_Arduino_WeeESP8266](https://github.com/itead/ITEADLIB_Arduino_WeeESP8266)
11+
This library is based on, modified and improved from [ITEADLIB_Arduino_WeeESP8266](https://github.com/itead/ITEADLIB_Arduino_WeeESP8266)
1212

1313
---
1414

@@ -22,7 +22,7 @@ This library is based on, modified and improved from [TEADLIB_Arduino_WeeESP8266
2222

2323
---
2424

25-
## Prerequisite
25+
### Prerequisite
2626
1. [`Arduino IDE 1.8.12 or later` for Arduino](https://www.arduino.cc/en/Main/Software)
2727
2. [`Adafruit nRF52 v0.20.1 or later`](www.adafruit.com) for nRF52 boards such as Adafruit NRF52840_FEATHER, NRF52832_FEATHER, NRF52840_FEATHER_SENSE, NRF52840_ITSYBITSY, NRF52840_CIRCUITPLAY, NRF52840_CLUE, NRF52840_METRO, NRF52840_PCA10056, PARTICLE_XENON, ***NINA_B302_ublox, NINA_B112_ublox***, etc.
2828
3. [`Arduino Core for STM32 v1.8.0 or later`](https://github.com/khoih-prog/Arduino_Core_STM32) for STM32 boards
@@ -93,13 +93,6 @@ Another way to install is to:
9393
9494
---
9595
96-
### Documentation
97-
98-
Online API documentation can be reached at <http://docs.iteadstudio.com/ITEADLIB_Arduino_WeeESP8266/index.html>.
99-
100-
Offline API documentation can be found under directory
101-
[doc](https://github.com/itead/ITEADLIB_Arduino_WeeESP8266/tree/master/doc).
102-
10396
### How to get started
10497
10598
On the home page of API documentation, the tabs of Examples, Classes and Modules
@@ -182,27 +175,22 @@ will be useful for Arduino lovers.
182175
uint32_t recv (uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from all of TCP or UDP builded already in multiple mode.
183176
```
184177

185-
### Mainboard Requires
186-
187-
- RAM: not less than 2KBytes
188-
- Serial: one serial (HardwareSerial or SoftwareSerial) at least
189-
190178
### Suppported Mainboards
191179

192-
- Arduino MEGA and its derivatives
180+
- Arduino MEGA
193181
- SAM DUE
194-
- Arduino SAMD21
195-
- Adafruit SAMD21 and SAMD51
182+
- ***Arduino SAMD21 (ZERO, MKR, NANO_33_IOT, M0, M0 Pro, AdaFruit CIRCUITPLAYGROUND_EXPRESS, etc.)***
183+
- ***Adafruit SAMD21/SAM51 (Itsy-Bitsy M0/M4, Metro M0/M4, Grand Central M4, Feather M0/M4 Express, etc.)***
196184
- Teensy
197-
- nRF52
198-
- STM32F
185+
- ***nRF52 (AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B30_ublox, NINA_B112_ublox, etc.)***
186+
- ***STM32F (STM32F1, F2, F3, F4, F7, etc.)***
199187

200188

201189
### Hardware Connection
202190

203191
ESP_AT_Lib library only needs an UART for hardware connection. All communications are done via UART. In each example, you must specify the UART used by mainboard to communicate with ESP8266/ESP32-AT firmware.
204192

205-
### MEGA, SAM DUE
193+
#### MEGA, SAM DUE
206194

207195
For MEGA and SAM DUE, `Serial1` or `Serial3` will be used if you create an object (named wifi) of class ESP8266 in your code like this:
208196

@@ -219,9 +207,9 @@ The connection should be like these:
219207

220208
### Attention
221209

222-
The size of data from ESP8266/ESP32-AT is too big for arduino sometimes, so the library can't receive the whole buffer because the size of the hardware serial buffer which is defined in HardwareSerial.h is too small.
210+
The size of data from ESP8266/ESP32-AT is sometimes too big for Arduino boards, so the library can't receive the whole buffer because the size of the hardware serial buffer, defined in HardwareSerial.h, is too small.
223211

224-
The `SERIAL_TX_BUFFER_SIZE` and `SERIAL_RX_BUFFER_SIZE` are already redefined to 256 for Mega, and 2-48 for other boards
212+
The `SERIAL_TX_BUFFER_SIZE` and `SERIAL_RX_BUFFER_SIZE` are already redefined to 256 for Mega, and 2048 for other boards
225213

226214
```cpp
227215
#if ( defined(ARDUINO_AVR_ADK) || defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560) )
@@ -599,11 +587,11 @@ void loop(void)
599587
600588
---
601589
602-
## TO DO
590+
### TO DO
603591
604592
1. Fix bugs
605593
606-
## DONE
594+
### DONE
607595
608596
1. Add ESP32-AT support
609597
2. Replace deprecated AT commands

0 commit comments

Comments
 (0)