arduino-esp32/libraries/README.md

# ESP32 Libraries

arduino-esp32 includes libraries for Arduino compatibility along with some object wrappers around hardware specific devices.  Examples are included in the examples folder under each library folder.  The ESP32 includes additional examples which need no special drivers.

### ArduinoOTA
  Over The Air firmware update daemon.  Use espota.py to upload to the device.

### AsyncUDP
  Asynchronous task driven UDP datagram client/server

### AzureIoT
  Library to interact with Microsoft Azure IoT services

### BLE
  Bluetooth Low Energy v4.2 client/server framework

### BluetoothSerial
  Serial to Bluetooth redirection server

### DNSServer
  A basic UDP DNS daemon (includes captive portal demo)

### EEPROM
  Arduino compatibility for EEPROM (using flash)

### ESP32
  Additional examples
  * AnalogOut
  * Camera
  * ChipID
  * DeepSleep
  * ESPNow
  * FreeRTOS
  * GPIO
  * HallSensor
  * I2S
  * ResetReason
  * RMT
  * Time
  * Timer
  * Touch

### ESPmDNS
  mDNS service advertising

### FFat
  FAT indexed filesystem on SPI flash

### FS
  Filesystem virtualization framework

### HTTPClient
  A simple HTTP client, compatible with WiFiClientSecure

### HTTPUpdate
  Download a firmware update from HTTPd and apply it using Update

### NetBIOS
  NetBIOS name advertiser

### Preferences
  Flash keystore using ESP32 NVS

### ESP RainMaker
  End-to-end platform by Espressif that enables Makers to realize their IoT ideas faster

### SD
  Secure Digital card filesystem using SPI access

### SD_MMC
  Secure Digital card filesystem using 4-lane access

### SimpleBLE
  Minimal BLE advertiser

### SPI
  Arduino compatible Serial Peripheral Interface driver (master only)

### SPIFFS
  SPI Flash Filesystem (see [spiffs-plugin](https://github.com/me-no-dev/arduino-esp32fs-plugin) to upload to device)

### Ticker
  A timer to call functions on an interval

### Update
  Sketch Update using ESP32 OTA functionality

### WebServer
  A simple HTTP daemon

### WiFi
  Arduino compatible WiFi driver (includes Ethernet driver)

### WiFiClientSecure
  Arduino compatible WiFi client object using embedded encryption

### Wire
  Arduino compatible I2C driver (master only)
Added a description README.md for libraries (#3349) 2019-10-14 11:37:09 -06:00			`# ESP32 Libraries`

			`arduino-esp32 includes libraries for Arduino compatibility along with some object wrappers around hardware specific devices. Examples are included in the examples folder under each library folder. The ESP32 includes additional examples which need no special drivers.`

			`### ArduinoOTA`
			`Over The Air firmware update daemon. Use espota.py to upload to the device.`

			`### AsyncUDP`
			`Asynchronous task driven UDP datagram client/server`

			`### AzureIoT`
			`Library to interact with Microsoft Azure IoT services`

			`### BLE`
			`Bluetooth Low Energy v4.2 client/server framework`

			`### BluetoothSerial`
			`Serial to Bluetooth redirection server`

			`### DNSServer`
			`A basic UDP DNS daemon (includes captive portal demo)`

			`### EEPROM`
			`Arduino compatibility for EEPROM (using flash)`

			`### ESP32`
			`Additional examples`
			`* AnalogOut`
			`* Camera`
			`* ChipID`
			`* DeepSleep`
			`* ESPNow`
			`* FreeRTOS`
			`* GPIO`
			`* HallSensor`
			`* I2S`
			`* ResetReason`
			`* RMT`
			`* Time`
			`* Timer`
			`* Touch`

			`### ESPmDNS`
			`mDNS service advertising`

			`### FFat`
			`FAT indexed filesystem on SPI flash`

			`### FS`
			`Filesystem virtualization framework`

			`### HTTPClient`
			`A simple HTTP client, compatible with WiFiClientSecure`

			`### HTTPUpdate`
			`Download a firmware update from HTTPd and apply it using Update`

			`### NetBIOS`
			`NetBIOS name advertiser`

			`### Preferences`
			`Flash keystore using ESP32 NVS`

v2.0.0 Add support for ESP32S2 and update ESP-IDF to 4.4 (#4996) This is very much still work in progress and much more will change before the final 2.0.0 Some APIs have changed. New libraries have been added. LittleFS included. Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Mike Dunston <m_dunston@comcast.net> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: microDev <70126934+microDev1@users.noreply.github.com> Co-authored-by: tobozo <tobozo@users.noreply.github.com> Co-authored-by: bobobo1618 <bobobo1618@users.noreply.github.com> Co-authored-by: lorol <lorolouis@gmail.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net> Co-authored-by: Sweety <switi.mhaiske@espressif.com> Co-authored-by: Loick MAHIEUX <loick111@gmail.com> Co-authored-by: Larry Bernstone <lbernstone@gmail.com> Co-authored-by: Valerii Koval <valeros@users.noreply.github.com> Co-authored-by: 快乐的我531 <2302004040@qq.com> Co-authored-by: chegewara <imperiaonline4@gmail.com> Co-authored-by: Clemens Kirchgatterer <clemens@1541.org> Co-authored-by: Aron Rubin <aronrubin@gmail.com> Co-authored-by: Pete Lewis <601236+lewispg228@users.noreply.github.com> 2021-04-05 14:23:58 +03:00			`### ESP RainMaker`
			`End-to-end platform by Espressif that enables Makers to realize their IoT ideas faster`

Added a description README.md for libraries (#3349) 2019-10-14 11:37:09 -06:00			`### SD`
			`Secure Digital card filesystem using SPI access`

			`### SD_MMC`
			`Secure Digital card filesystem using 4-lane access`

			`### SimpleBLE`
			`Minimal BLE advertiser`

			`### SPI`
			`Arduino compatible Serial Peripheral Interface driver (master only)`

			`### SPIFFS`
			`SPI Flash Filesystem (see [spiffs-plugin](https://github.com/me-no-dev/arduino-esp32fs-plugin) to upload to device)`

			`### Ticker`
			`A timer to call functions on an interval`

			`### Update`
			`Sketch Update using ESP32 OTA functionality`

			`### WebServer`
			`A simple HTTP daemon`

			`### WiFi`
			`Arduino compatible WiFi driver (includes Ethernet driver)`

			`### WiFiClientSecure`
			`Arduino compatible WiFi client object using embedded encryption`

			`### Wire`
			`Arduino compatible I2C driver (master only)`