Skip to content

Commit af0cef4

Browse files
authored
Update README.md
1 parent ac19ecf commit af0cef4

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
Arduino core for ESP32 WiFi chip
22
===========================================
33

4+
### Development Status
5+
Not everything is working yet, you can not get it through package manager, but you can give it a go and help us find bugs in the things that are implemented :)
6+
7+
The framework can also be downloaded as component in an IDF project and be used like that.
8+
9+
Things that "should" work:
10+
- pinMode
11+
- digitalRead/digitalWrite
12+
- attachInterrupt/detachInterrupt
13+
- Serial (global Serial is attached to pins 1 and 3 by default, there are another 2 serials that you can attach to any pin)
14+
- SPI (global SPI is attached to VSPI pins by default and HSPI can be attached to any pins)
15+
- Wire (global Wire is attached to pins 21 and 22 by default and there is another I2C bus that you can attach to any pins)
16+
- WiFi (about 99% the same as ESP8266)
17+
18+
WiFiClient, WiFiServer and WiFiUdp are not quite ready yet because there are still some small hiccups in LwIP to be overcome.
19+
You can try WiFiClient but you need to disconnect the client yourself to be sure that connection is closed.
20+
421
### Installation
5-
- Install Arduino 1.6.9
6-
- Go to Arduino directory
22+
- Install Arduino IDE
23+
- Go to Arduino IDE installation directory
724
- Clone this repository into hardware/espressif/esp32 directory (or clone it elsewhere and create a symlink)
825
```bash
926
cd hardware

0 commit comments

Comments
 (0)