diff --git a/README.md b/README.md index c12ecbb3..e7523f41 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ Arduino core for ESP32 WiFi chip =========================================== +### Development Status +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 :) + +The framework can also be downloaded as component in an IDF project and be used like that. + +Things that "should" work: +- pinMode +- digitalRead/digitalWrite +- attachInterrupt/detachInterrupt +- Serial (global Serial is attached to pins 1 and 3 by default, there are another 2 serials that you can attach to any pin) +- SPI (global SPI is attached to VSPI pins by default and HSPI can be attached to any pins) +- 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) +- WiFi (about 99% the same as ESP8266) + +WiFiClient, WiFiServer and WiFiUdp are not quite ready yet because there are still some small hiccups in LwIP to be overcome. +You can try WiFiClient but you need to disconnect the client yourself to be sure that connection is closed. + ### Installation -- Install Arduino 1.6.9 -- Go to Arduino directory +- Install Arduino IDE +- Go to Arduino IDE installation directory - Clone this repository into hardware/espressif/esp32 directory (or clone it elsewhere and create a symlink) ```bash cd hardware