mirror of
https://github.com/esp8266/Arduino.git
synced 2025-06-06 05:21:22 +03:00
Merge remote-tracking branch 'remotes/esp8266/esp8266' into esp8266
This commit is contained in:
Markus Sattler
commit
c33e2a60db
41
.travis.yml
41
.travis.yml
@ -1,35 +1,38 @@
|
||||
sudo: true
|
||||
sudo: false
|
||||
|
||||
language: java
|
||||
|
||||
os:
|
||||
- linux
|
||||
- osx
|
||||
|
||||
addons:
|
||||
apt:
|
||||
packages:
|
||||
- ant
|
||||
|
||||
jdk:
|
||||
- oraclejdk8
|
||||
|
||||
script:
|
||||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get update -qq; fi
|
||||
- if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get install -qq ant; fi
|
||||
- pushd build
|
||||
- echo "" | ant dist
|
||||
- echo "" | ant build
|
||||
- popd
|
||||
#- bash -x ./generate-appimage
|
||||
|
||||
deploy:
|
||||
provider: releases
|
||||
api_key:
|
||||
secure: eKHcAMuC58JZKRsn1QwbiYE4aL/9dZsybDqqHTo1dUo8x9+3fGed/Dci76ItFFS7SmFfIdl6ej8/Uj0nPK/sIE21blKBe3+L0KAJm0TTq3m0ig1suCmMipCsSW+srWYM0hl58+OKagM4FoHKDjsEnzRDv9Z4xtxyvG+7/XLD1dE=
|
||||
skip_cleanup: true
|
||||
file_glob: true
|
||||
file:
|
||||
- '$TRAVIS_BUILD_DIR/build/linux/arduino-*.tar.xz'
|
||||
# - '$TRAVIS_BUILD_DIR/Arduino.AppImage'
|
||||
on:
|
||||
tags: true
|
||||
all_branches: true
|
||||
- /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16
|
||||
- sleep 3
|
||||
- export DISPLAY=:1.0
|
||||
- export PATH="$PWD/build/linux/work:$PATH"
|
||||
- which arduino
|
||||
- source hardware/esp8266com/esp8266/tests/common.sh
|
||||
- arduino --board esp8266com:esp8266:generic --save-prefs
|
||||
- build_sketches arduino $PWD/hardware/esp8266com/esp8266
|
||||
|
||||
notifications:
|
||||
email:
|
||||
on_success: change
|
||||
on_failure: change
|
||||
webhooks:
|
||||
urls:
|
||||
- secure: "dnSY+KA7NK+KD+Z71copmANDUsyVePrZ0iXvXxmqMEQv+lp3j2Z87G5pHn7j0WNcNZrejJqOdbElJ9Q4QESRaAYxTR7cA6ameJeEKHiFJrQtN/4abvoXb9E1CxpL8aNON/xgnqCk+fycOK3nbWWXlJBodzBm7KN64vrcHO7et+M="
|
||||
on_success: change # options: [always|never|change] default: always
|
||||
on_failure: always # options: [always|never|change] default: always
|
||||
on_start: false # default: false
|
||||
|
||||
325
README.md
325
README.md
@ -1,308 +1,43 @@
|
||||
Arduino-compatible IDE with ESP8266 support
|
||||
===========================================
|
||||
|
||||
[](https://travis-ci.org/igrr/Arduino)
|
||||
[](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66)
|
||||
|
||||
This project brings support for ESP8266 chip to the Arduino environment. ESP8266WiFi library bundled with this project has the same interface as the WiFi Shield library, making it easy to re-use existing code and libraries.
|
||||
|
||||
### Installing with Boards Manager ###
|
||||
|
||||
Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).
|
||||
|
||||
- Install Arduino 1.6.4 from the [Arduino website](http://www.arduino.cc/en/main/software).
|
||||
- Start Arduino and open Perferences window.
|
||||
- Enter ```http://arduino.esp8266.com/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
|
||||
- Install Arduino 1.6.5 from the [Arduino website](http://www.arduino.cc/en/main/software).
|
||||
- Start Arduino and open Preferences window.
|
||||
- Enter ```http://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
|
||||
- Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
|
||||
|
||||
### [Change log](hardware/esp8266com/esp8266/changes.md)
|
||||
#### Available versions
|
||||
|
||||
##### Stable version 
|
||||
Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json`
|
||||
|
||||
Documentation: [Reference](http://arduino.esp8266.com/stable/doc/reference.html)
|
||||
|
||||
##### Staging version 
|
||||
Boards manager link: `http://arduino.esp8266.com/staging/package_esp8266com_index.json`
|
||||
|
||||
Documentation: [Reference](http://arduino.esp8266.com/staging/doc/reference.html)
|
||||
|
||||
|
||||
### Building latest version from source [](https://travis-ci.org/esp8266/Arduino)
|
||||
|
||||
### Building latest version from source ###
|
||||
```
|
||||
$ git clone https://github.com/esp8266/Arduino.git
|
||||
$ cd Arduino/build
|
||||
$ ant dist
|
||||
```
|
||||
|
||||
### Supported boards ###
|
||||
- Generic esp8266 modules (without auto-reset support)
|
||||
- NodeMCU
|
||||
- Olimex MOD-WIFI-ESP8266
|
||||
Documentation for latest development version:
|
||||
|
||||
### Things that work ###
|
||||
|
||||
#### Basic Wiring functions ####
|
||||
|
||||
```pinMode```, ```digitalRead```, ```digitalWrite```, ```analogWrite``` work as usual.
|
||||
|
||||
Pin numbers correspond directly to the esp8266 GPIO pin numbers. To read GPIO2,
|
||||
call ```digitalRead(2);```
|
||||
|
||||
GPIO0-GPIO15 can be ```INPUT```, ```OUTPUT```, ```INPUT_PULLUP```, and ```INPUT_PULLDOWN```.
|
||||
GPIO16 can be ```INPUT```, ```OUTPUT``` or ```INPUT_PULLDOWN```.
|
||||
|
||||
```analogRead(A0)``` reads the value of the ADC channel connected to the TOUT pin.
|
||||
|
||||
```analogWrite(pin, value)``` enables software PWM on the given pin. PWM may be used on pins 0 to 15.
|
||||
Call ```analogWrite(pin, 0)``` to disable PWM on the pin. ```value``` may be in range from 0 to ```PWMRANGE```, which is currently equal to 1023.
|
||||
|
||||
Pin interrupts are supported through ```attachInterrupt```, ```detachInterrupt``` functions.
|
||||
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
|
||||
types are supported: ```CHANGE```, ```RISING```, ```FALLING```.
|
||||
|
||||
#### Pin Functions ####
|
||||
|
||||
|
||||
The most usable pin functions are mapped to the macro ```SPECIAL```, so calling ```pinMode(pin, SPECIAL)```
|
||||
will switch that pin in the most usable FUNCTION_X. Those are UART RX/TX on pins 1 - 3, HSPI for pins 12-15 and CLK functions for pins 0, 4 and 5.
|
||||
|
||||
#### Timing and delays ####
|
||||
```millis``` and ```micros``` return the number of milliseconds and microseconds elapsed after reset, respectively.
|
||||
|
||||
```delay``` pauses the sketch for a given number of milliseconds and allows WiFi and TCP/IP tasks to run.
|
||||
```delayMicroseconds``` pauses for a given number of microseconds.
|
||||
|
||||
Remember that there is a lot of code that needs to run on the chip besides the sketch
|
||||
when WiFi is connected. WiFi and TCP/IP libraries get a chance to handle any pending
|
||||
events each time the ```loop()``` function completes, OR when ```delay(...)``` is called.
|
||||
If you have a loop somewhere in your sketch that takes a lot of time (>50ms) without
|
||||
calling ```delay()```, you might consider adding a call to delay function to keep the WiFi
|
||||
stack running smoothly.
|
||||
|
||||
There is also a ```yield()``` function which is equivalent to ```delay(0)```. The delayMicroseconds
|
||||
function, on the other hand, does not yield to other tasks, so using it for delays
|
||||
more than 20 milliseconds is not recommended.
|
||||
|
||||
#### Serial ####
|
||||
|
||||
```Serial``` object works much the same way as on a regular Arduino. Apart from hardware FIFO (128 bytes for TX and RX) HardwareSerial has additional 256-byte TX and RX buffers. Both transmit and receive is interrupt-driven. Write and read functions only block the sketch execution when the respective FIFO/buffers are full/empty.
|
||||
|
||||
```Serial``` uses UART0, which is mapped to pins GPIO1 (TX) and GPIO3 (RX). Serial may be remapped to GPIO15 (TX) and GPIO13 (RX) by calling ```Serial.swap();``` after ```Serial.begin();```. Calling ```swap``` again maps UART0 back to GPIO1 and GPIO3.
|
||||
|
||||
```Serial1``` uses UART1 which is a transmit-only UART. UART1 TX pin is GPIO2. To use ```Serial1```, call ```Serial1.begin```.
|
||||
|
||||
By default the diagnostic output from WiFi libraries is disabled when you call ```Serial.begin```. To enable debug output again, call ```Serial.setDebugOutput(true);```. To redirect debug output to ```Serial1``` instead, call ```Serial1.setDebugOutput(true);```.
|
||||
|
||||
You also need to use ```Serial.setDebugOutput(true)``` to enable output from the Arduino ```printf()``` function.
|
||||
|
||||
Both ```Serial``` and ```Serial1``` objects support 5, 6, 7, 8 data bits, odd (O), even (E), and no (N) parity, and 1 or 2 stop bits. To set the desired mode, call ```Serial.begin(baudrate, SERIAL_8N1);```, ```Serial.begin(baudrate, SERIAL_6E2);```, etc.
|
||||
|
||||
#### Progmem ####
|
||||
|
||||
The Program memory features work much the same way as on a regular Arduino; placing read only data and strings in read only memory and freeing heap for your application.
|
||||
The important difference is that on the esp8266 the literal strings are not pooled. This means that the same literal string defined inside a ```F("")``` and/or ```PSTR("")``` will take up space for each instance in the code. So you will need to manage the duplicate strings yourself.
|
||||
|
||||
#### WiFi(ESP8266WiFi library) ####
|
||||
|
||||
This is mostly similar to WiFi shield library. Differences include:
|
||||
|
||||
- ```WiFi.mode(m)```: set mode to ```WIFI_AP```, ```WIFI_STA```, or ```WIFI_AP_STA```.
|
||||
- call ```WiFi.softAP(ssid)``` to set up an open network
|
||||
- call ```WiFi.softAP(ssid, password)``` to set up a WPA2-PSK network (password should be at least 8 characters)
|
||||
- ```WiFi.macAddress(mac)``` is for STA, ```WiFi.softAPmacAddress(mac)``` is for AP.
|
||||
- ```WiFi.localIP()``` is for STA, ```WiFi.softAPIP()``` is for AP.
|
||||
- ```WiFi.RSSI()``` doesn't work
|
||||
- ```WiFi.printDiag(Serial);``` will print out some diagnostic info
|
||||
- ```WiFiUDP``` class supports sending and receiving multicast packets on STA interface.
|
||||
When sending a multicast packet, replace ```udp.beginPacket(addr, port)``` with
|
||||
```udp.beginPacketMulticast(addr, port, WiFi.localIP())```.
|
||||
When listening to multicast packets, replace ```udp.begin(port)``` with
|
||||
```udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port)```.
|
||||
You can use ```udp.destinationIP()``` to tell whether the packet received was
|
||||
sent to the multicast or unicast address.
|
||||
Also note that multicast doesn't work on softAP interface.
|
||||
|
||||
WiFiServer, WiFiClient, and WiFiUDP behave mostly the same way as with WiFi shield library.
|
||||
Four samples are provided for this library.
|
||||
You can see more commands here: [http://www.arduino.cc/en/Reference/WiFi](http://www.arduino.cc/en/Reference/WiFi)
|
||||
|
||||
#### Ticker ####
|
||||
|
||||
Library for calling functions repeatedly with a certain period. Two examples included.
|
||||
|
||||
It is currently not recommended to do blocking IO operations (network, serial, file) from Ticker
|
||||
callback functions. Instead, set a flag inside the ticker callback and check for that flag inside the loop function.
|
||||
|
||||
#### EEPROM ####
|
||||
|
||||
This is a bit different from standard EEPROM class. You need to call ```EEPROM.begin(size)```
|
||||
before you start reading or writing, size being the number of bytes you want to use.
|
||||
Size can be anywhere between 4 and 4096 bytes.
|
||||
|
||||
```EEPROM.write``` does not write to flash immediately, instead you must call ```EEPROM.commit()```
|
||||
whenever you wish to save changes to flash. ```EEPROM.end()``` will also commit, and will
|
||||
release the RAM copy of EEPROM contents.
|
||||
|
||||
EEPROM library uses one sector of flash located at 0x7b000 for storage.
|
||||
|
||||
Three examples included.
|
||||
|
||||
#### I2C (Wire library) ####
|
||||
|
||||
Wire library currently supports master mode up to approximately 450KHz.
|
||||
Before using I2C, pins for SDA and SCL need to be set by calling
|
||||
```Wire.begin(int sda, int scl)```, i.e. ```Wire.begin(0, 2);``` on ESP-01,
|
||||
else they default to pins 4(SDA) and 5(SCL).
|
||||
|
||||
#### SPI ####
|
||||
|
||||
SPI library supports the entire Arduino SPI API including transactions, including setting phase (CPHA).
|
||||
Setting the Clock polarity (CPOL) is not supported, yet (SPI_MODE2 and SPI_MODE3 not working).
|
||||
|
||||
#### ESP-specific APIs ####
|
||||
|
||||
APIs related to deep sleep and watchdog timer are available in the ```ESP``` object, only available in Alpha version.
|
||||
|
||||
```ESP.deepSleep(microseconds, mode)``` will put the chip into deep sleep. ```mode``` is one of ```WAKE_RF_DEFAULT```, ```WAKE_RFCAL```, ```WAKE_NO_RFCAL```, ```WAKE_RF_DISABLED```. (GPIO16 needs to be tied to RST to wake from deepSleep.)
|
||||
|
||||
```ESP.restart()``` restarts the CPU.
|
||||
|
||||
```ESP.getFreeHeap()``` returns the free heap size.
|
||||
|
||||
```ESP.getChipId()``` returns the ESP8266 chip ID as a 32-bit integer.
|
||||
|
||||
Several APIs may be used to get flash chip info:
|
||||
|
||||
```ESP.getFlashChipId()``` returns the flash chip ID as a 32-bit integer.
|
||||
|
||||
```ESP.getFlashChipSize()``` returns the flash chip size, in bytes, as seen by the SDK (may be less than actual size).
|
||||
|
||||
```ESP.getFlashChipSpeed(void)``` returns the flash chip frequency, in Hz.
|
||||
|
||||
```ESP.getCycleCount()``` returns the cpu instruction cycle count since start as an unsigned 32-bit. This is useful for accurate timing of very short actions like bit banging.
|
||||
|
||||
```ESP.getVcc()``` may be used to measure supply voltage. ESP needs to reconfigure the ADC
|
||||
at startup in order for this feature to be available. Add the following line to the top
|
||||
of your sketch to use ```getVcc```:
|
||||
```
|
||||
ADC_MODE(ADC_VCC);
|
||||
```
|
||||
TOUT pin has to be disconnected in this mode.
|
||||
|
||||
Note that by default ADC is configured to read from TOUT pin using ```analogRead(A0)```, and
|
||||
```ESP.getVCC()``` is not available.
|
||||
|
||||
#### OneWire (from https://www.pjrc.com/teensy/td_libs_OneWire.html) ####
|
||||
|
||||
Library was adapted to work with ESP8266 by including register definitions into OneWire.h
|
||||
Note that if you already have OneWire library in your Arduino/libraries folder, it will be used
|
||||
instead of the one that comes with this package.
|
||||
|
||||
#### mDNS responder (ESP8266mDNS library) ####
|
||||
|
||||
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local".
|
||||
Currently the library only works on STA interface, AP interface is not supported.
|
||||
See attached example and library README file for details.
|
||||
|
||||
#### DNS server (DNSServer library) ####
|
||||
|
||||
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it clients can open a web server running on ESP8266 using a domain name, not an IP address.
|
||||
See attached example for details.
|
||||
|
||||
#### Servo ####
|
||||
|
||||
This library exposes the ability to control RC (hobby) servo motors. It will support upto 24 servos on any available output pin. By defualt the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be effected.
|
||||
While many RC servo motors will accept the 3.3v IO data pin from a esp8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the esp8266 and the servo motor power supply.
|
||||
|
||||
#### Other libraries (not included with the IDE)
|
||||
|
||||
Libraries that don't rely on low-level access to AVR registers should work well. Here are a few libraries that were verified to work:
|
||||
|
||||
- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets) - WebSocket Server and Client compatible with esp8266 (RFC6455)
|
||||
- [aREST](https://github.com/marcoschwartz/aREST) REST API handler library.
|
||||
- [Blynk](https://github.com/blynkkk/blynk-library) - easy IoT framework for Makers (check out the [Kickstarter page](http://tiny.cc/blynk-kick)).
|
||||
- [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library.git)
|
||||
- [DHT11](https://github.com/adafruit/DHT-sensor-library) - Download latest v1.1.0 library and no changes are necessary. Older versions should initialize DHT as follows: ```DHT dht(DHTPIN, DHTTYPE, 15);```
|
||||
- [NeoPixel](https://github.com/adafruit/Adafruit_NeoPixel) - Adafruit's NeoPixel library, now with support for the ESP8266 (use version 1.0.2 or higher from Arduino's library manager).
|
||||
- [NeoPixelBus](https://github.com/Makuna/NeoPixelBus) - Arduino NeoPixel library compatible with esp8266. Use the "NeoPixelAnimator" branch for esp8266 to get HSL color support and more.
|
||||
- [PubSubClient](https://github.com/Imroy/pubsubclient) MQTT library by @Imroy.
|
||||
- [RTC](https://github.com/Makuna/Rtc) - Arduino Library for Ds1307 & Ds3231 compatible with esp8266.
|
||||
- [Souliss, Smart Home](https://github.com/souliss/souliss) - Framework for Smart Home based on Arduino, Android and openHAB.
|
||||
- [ST7735](https://github.com/nzmichaelh/Adafruit-ST7735-Library) - Adafruit's ST7735 library modified to be compatible with esp8266. Just make sure to modify the pins in the examples as they are still AVR specific.
|
||||
|
||||
#### Upload via serial port ####
|
||||
Pick the correct serial port.
|
||||
You need to put ESP8266 into bootloader mode before uploading code.
|
||||
|
||||
#### Power Supply ####
|
||||
|
||||
For stable use of the ESP8266 a power supply with 3V3 and >= 250mA is required.
|
||||
|
||||
* Note
|
||||
- using Power from USB to Serial is may unstable, they not deliver enough current.
|
||||
|
||||
#### Serial Adapter ####
|
||||
|
||||
There are many different USB to Serial adapters / boards.
|
||||
|
||||
* Note
|
||||
- for full upload management you need RTS and DTR
|
||||
- the chip need to have 3V3 TTL (5V may damage the chip)
|
||||
- not all board have all pins of the ICs as breakout (check before order)
|
||||
- CTS and DSR are not useful for upload (they are Inputs)
|
||||
|
||||
* Working ICs
|
||||
- FT232RL
|
||||
- CP2102
|
||||
- may others (drop a comment)
|
||||
|
||||
#### Minimal hardware Setup for Bootloading and usage ####
|
||||
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Serial Adapter |
|
||||
| ------------- | -------- | -------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| TX or GPIO2* | | RX |
|
||||
| RX | | TX |
|
||||
| GPIO0 | PullUp | DTR |
|
||||
| Reset* | | RTS |
|
||||
| GPIO15* | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
* Note
|
||||
- GPIO15 is also named MTDO
|
||||
- Reset is also named RSBT or REST (adding PullUp improves the stability of the Module)
|
||||
- GPIO2 is alternative TX for the boot loader mode
|
||||
|
||||
###### esp to Serial
|
||||
|
||||
|
||||
#### Minimal hardware Setup for Bootloading only ####
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Serial Adapter |
|
||||
| ------------- | -------- | --------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| TX or GPIO2 | | RX |
|
||||
| RX | | TX |
|
||||
| GPIO0 | | GND |
|
||||
| Reset | | RTS* |
|
||||
| GPIO15 | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
* Note
|
||||
- if no RTS is used a manual power toggle is needed
|
||||
|
||||
#### Minimal hardware Setup for running only ####
|
||||
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Power supply |
|
||||
| ------------- | -------- | --------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| GPIO0 | PullUp | |
|
||||
| GPIO15 | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
###### minimal
|
||||
|
||||
|
||||
###### improved stability
|
||||
|
||||
- [Reference](hardware/esp8266com/esp8266/doc/reference.md)
|
||||
- [Supported boards](hardware/esp8266com/esp8266/doc/boards.md)
|
||||
- [Change log](hardware/esp8266com/esp8266/doc/changes.md)
|
||||
|
||||
### Issues and support ###
|
||||
|
||||
@ -310,16 +45,24 @@ Forum: http://www.esp8266.com/arduino
|
||||
|
||||
Submit issues on Github: https://github.com/esp8266/Arduino/issues
|
||||
|
||||
### Contributing
|
||||
|
||||
For minor fixes of code and documentation, go ahead and submit a pull request.
|
||||
|
||||
Larger changes (rewriting parts of existing code from scratch, adding new functions to the core, adding new libraries) should generally be discussed [in the chat](https://gitter.im/esp8266/Arduino) first.
|
||||
|
||||
Feature branches with lots of small commits (especially titled "oops", "fix typo", "forgot to add file", etc.) should be squashed before opening a pull request. At the same time, please refrain from putting multiple unrelated changes into a single pull request.
|
||||
|
||||
### License and credits ###
|
||||
|
||||
Arduino IDE is based on Wiring and Processing. It is developed and maintained by the Arduino team. The IDE is licensed under GPL, and the core libraries are licensed under LGPL.
|
||||
Arduino IDE is developed and maintained by the Arduino team. The IDE is licensed under GPL.
|
||||
|
||||
This build includes an xtensa gcc toolchain, which is also under GPL.
|
||||
|
||||
Espressif SDK included in this build is under Espressif Public License.
|
||||
ESP8266 core includes an xtensa gcc toolchain, which is also under GPL.
|
||||
|
||||
Esptool written by Christian Klippel is licensed under GPLv2, currently maintained by Ivan Grokhotkov: https://github.com/igrr/esptool-ck.
|
||||
|
||||
ESP8266 core support, ESP8266WiFi, Ticker, ESP8266WebServer libraries were written by Ivan Grokhotkov, ivan@esp8266.com.
|
||||
Espressif SDK included in this build is under Espressif MIT License.
|
||||
|
||||
ESP8266 core files are licensed under LGPL.
|
||||
|
||||
[SPI Flash File System (SPIFFS)](https://github.com/pellepl/spiffs) written by Peter Andersson is used in this project. It is distributed under MIT license.
|
||||
|
||||
215
boards.txt
215
boards.txt
@ -135,56 +135,46 @@ generic.menu.FlashSize.4M.upload.maximum_size=1044464
|
||||
# generic.menu.FlashSize.16M.build.spiffs_blocksize=8192
|
||||
|
||||
##############################################################
|
||||
modwifi.name=Olimex MOD-WIFI-ESP8266(-DEV)
|
||||
huzzah.name=Adafruit HUZZAH ESP8266
|
||||
|
||||
modwifi.upload.tool=esptool
|
||||
modwifi.upload.speed=115200
|
||||
modwifi.upload.resetmethod=ck
|
||||
modwifi.upload.maximum_size=1044464
|
||||
modwifi.upload.maximum_data_size=81920
|
||||
modwifi.upload.wait_for_upload_port=true
|
||||
modwifi.serial.disableDTR=true
|
||||
modwifi.serial.disableRTS=true
|
||||
huzzah.upload.tool=esptool
|
||||
huzzah.upload.speed=115200
|
||||
huzzah.upload.resetmethod=ck
|
||||
huzzah.upload.maximum_size=1044464
|
||||
huzzah.upload.maximum_data_size=81920
|
||||
huzzah.upload.wait_for_upload_port=true
|
||||
huzzah.serial.disableDTR=true
|
||||
huzzah.serial.disableRTS=true
|
||||
|
||||
modwifi.build.mcu=esp8266
|
||||
modwifi.build.f_cpu=80000000L
|
||||
modwifi.build.board=MOD_WIFI_ESP8266
|
||||
modwifi.build.core=esp8266
|
||||
modwifi.build.variant=generic
|
||||
# Winbond W25Q16 flash
|
||||
modwifi.build.flash_mode=qio
|
||||
modwifi.build.flash_size=2M
|
||||
modwifi.build.flash_freq=40
|
||||
modwifi.build.flash_ld=eagle.flash.2m.ld
|
||||
modwifi.build.spiffs_start=0x100000
|
||||
modwifi.build.spiffs_end=0x1FB000
|
||||
modwifi.build.spiffs_pagesize=256
|
||||
modwifi.build.spiffs_blocksize=8192
|
||||
huzzah.build.mcu=esp8266
|
||||
huzzah.build.f_cpu=80000000L
|
||||
huzzah.build.board=ESP8266_ESP12
|
||||
huzzah.build.core=esp8266
|
||||
huzzah.build.variant=adafruit
|
||||
huzzah.build.flash_mode=qio
|
||||
huzzah.build.flash_size=4M
|
||||
huzzah.build.flash_freq=40
|
||||
huzzah.build.flash_ld=eagle.flash.4m.ld
|
||||
huzzah.build.spiffs_start=0x100000
|
||||
huzzah.build.spiffs_end=0x3FB000
|
||||
huzzah.build.spiffs_pagesize=256
|
||||
huzzah.build.spiffs_blocksize=8192
|
||||
|
||||
modwifi.menu.CpuFrequency.80=80 MHz
|
||||
modwifi.menu.CpuFrequency.80.build.f_cpu=80000000L
|
||||
modwifi.menu.CpuFrequency.160=160 MHz
|
||||
modwifi.menu.CpuFrequency.160.build.f_cpu=160000000L
|
||||
huzzah.menu.CpuFrequency.80=80 MHz
|
||||
huzzah.menu.CpuFrequency.80.build.f_cpu=80000000L
|
||||
huzzah.menu.CpuFrequency.160=160 MHz
|
||||
huzzah.menu.CpuFrequency.160.build.f_cpu=160000000L
|
||||
|
||||
modwifi.menu.UploadSpeed.115200=115200
|
||||
modwifi.menu.UploadSpeed.115200.upload.speed=115200
|
||||
modwifi.menu.UploadSpeed.9600=9600
|
||||
modwifi.menu.UploadSpeed.9600.upload.speed=9600
|
||||
modwifi.menu.UploadSpeed.57600=57600
|
||||
modwifi.menu.UploadSpeed.57600.upload.speed=57600
|
||||
modwifi.menu.UploadSpeed.256000.windows=256000
|
||||
modwifi.menu.UploadSpeed.256000.upload.speed=256000
|
||||
modwifi.menu.UploadSpeed.230400.linux=230400
|
||||
modwifi.menu.UploadSpeed.230400.macosx=230400
|
||||
modwifi.menu.UploadSpeed.230400.macosx=230400
|
||||
modwifi.menu.UploadSpeed.230400.upload.speed=230400
|
||||
modwifi.menu.UploadSpeed.460800.linux=460800
|
||||
modwifi.menu.UploadSpeed.460800.macosx=460800
|
||||
modwifi.menu.UploadSpeed.460800.upload.speed=460800
|
||||
modwifi.menu.UploadSpeed.512000.windows=512000
|
||||
modwifi.menu.UploadSpeed.512000.upload.speed=512000
|
||||
modwifi.menu.UploadSpeed.921600=921600
|
||||
modwifi.menu.UploadSpeed.921600.upload.speed=921600
|
||||
huzzah.menu.UploadSpeed.115200=115200
|
||||
huzzah.menu.UploadSpeed.115200.upload.speed=115200
|
||||
huzzah.menu.UploadSpeed.9600=9600
|
||||
huzzah.menu.UploadSpeed.9600.upload.speed=9600
|
||||
huzzah.menu.UploadSpeed.57600=57600
|
||||
huzzah.menu.UploadSpeed.57600.upload.speed=57600
|
||||
huzzah.menu.UploadSpeed.256000=256000
|
||||
huzzah.menu.UploadSpeed.256000.upload.speed=256000
|
||||
huzzah.menu.UploadSpeed.921600=921600
|
||||
huzzah.menu.UploadSpeed.921600.upload.speed=921600
|
||||
|
||||
##############################################################
|
||||
nodemcu.name=NodeMCU 0.9 (ESP-12 Module)
|
||||
@ -289,46 +279,106 @@ nodemcuv2.menu.UploadSpeed.921600=921600
|
||||
nodemcuv2.menu.UploadSpeed.921600.upload.speed=921600
|
||||
|
||||
##############################################################
|
||||
huzzah.name=Adafruit HUZZAH ESP8266
|
||||
modwifi.name=Olimex MOD-WIFI-ESP8266(-DEV)
|
||||
|
||||
huzzah.upload.tool=esptool
|
||||
huzzah.upload.speed=115200
|
||||
huzzah.upload.resetmethod=ck
|
||||
huzzah.upload.maximum_size=1044464
|
||||
huzzah.upload.maximum_data_size=81920
|
||||
huzzah.upload.wait_for_upload_port=true
|
||||
huzzah.serial.disableDTR=true
|
||||
huzzah.serial.disableRTS=true
|
||||
modwifi.upload.tool=esptool
|
||||
modwifi.upload.speed=115200
|
||||
modwifi.upload.resetmethod=ck
|
||||
modwifi.upload.maximum_size=1044464
|
||||
modwifi.upload.maximum_data_size=81920
|
||||
modwifi.upload.wait_for_upload_port=true
|
||||
modwifi.serial.disableDTR=true
|
||||
modwifi.serial.disableRTS=true
|
||||
|
||||
huzzah.build.mcu=esp8266
|
||||
huzzah.build.f_cpu=80000000L
|
||||
huzzah.build.board=ESP8266_ESP12
|
||||
huzzah.build.core=esp8266
|
||||
huzzah.build.variant=adafruit
|
||||
huzzah.build.flash_mode=qio
|
||||
huzzah.build.flash_size=4M
|
||||
huzzah.build.flash_freq=40
|
||||
huzzah.build.flash_ld=eagle.flash.4m.ld
|
||||
huzzah.build.spiffs_start=0x100000
|
||||
huzzah.build.spiffs_end=0x3FB000
|
||||
huzzah.build.spiffs_pagesize=256
|
||||
huzzah.build.spiffs_blocksize=8192
|
||||
modwifi.build.mcu=esp8266
|
||||
modwifi.build.f_cpu=80000000L
|
||||
modwifi.build.board=MOD_WIFI_ESP8266
|
||||
modwifi.build.core=esp8266
|
||||
modwifi.build.variant=generic
|
||||
# Winbond W25Q16 flash
|
||||
modwifi.build.flash_mode=qio
|
||||
modwifi.build.flash_size=2M
|
||||
modwifi.build.flash_freq=40
|
||||
modwifi.build.flash_ld=eagle.flash.2m.ld
|
||||
modwifi.build.spiffs_start=0x100000
|
||||
modwifi.build.spiffs_end=0x1FB000
|
||||
modwifi.build.spiffs_pagesize=256
|
||||
modwifi.build.spiffs_blocksize=8192
|
||||
|
||||
huzzah.menu.CpuFrequency.80=80 MHz
|
||||
huzzah.menu.CpuFrequency.80.build.f_cpu=80000000L
|
||||
huzzah.menu.CpuFrequency.160=160 MHz
|
||||
huzzah.menu.CpuFrequency.160.build.f_cpu=160000000L
|
||||
modwifi.menu.CpuFrequency.80=80 MHz
|
||||
modwifi.menu.CpuFrequency.80.build.f_cpu=80000000L
|
||||
modwifi.menu.CpuFrequency.160=160 MHz
|
||||
modwifi.menu.CpuFrequency.160.build.f_cpu=160000000L
|
||||
|
||||
huzzah.menu.UploadSpeed.115200=115200
|
||||
huzzah.menu.UploadSpeed.115200.upload.speed=115200
|
||||
huzzah.menu.UploadSpeed.9600=9600
|
||||
huzzah.menu.UploadSpeed.9600.upload.speed=9600
|
||||
huzzah.menu.UploadSpeed.57600=57600
|
||||
huzzah.menu.UploadSpeed.57600.upload.speed=57600
|
||||
huzzah.menu.UploadSpeed.256000=256000
|
||||
huzzah.menu.UploadSpeed.256000.upload.speed=256000
|
||||
huzzah.menu.UploadSpeed.921600=921600
|
||||
huzzah.menu.UploadSpeed.921600.upload.speed=921600
|
||||
modwifi.menu.UploadSpeed.115200=115200
|
||||
modwifi.menu.UploadSpeed.115200.upload.speed=115200
|
||||
modwifi.menu.UploadSpeed.9600=9600
|
||||
modwifi.menu.UploadSpeed.9600.upload.speed=9600
|
||||
modwifi.menu.UploadSpeed.57600=57600
|
||||
modwifi.menu.UploadSpeed.57600.upload.speed=57600
|
||||
modwifi.menu.UploadSpeed.256000.windows=256000
|
||||
modwifi.menu.UploadSpeed.256000.upload.speed=256000
|
||||
modwifi.menu.UploadSpeed.230400.linux=230400
|
||||
modwifi.menu.UploadSpeed.230400.macosx=230400
|
||||
modwifi.menu.UploadSpeed.230400.macosx=230400
|
||||
modwifi.menu.UploadSpeed.230400.upload.speed=230400
|
||||
modwifi.menu.UploadSpeed.460800.linux=460800
|
||||
modwifi.menu.UploadSpeed.460800.macosx=460800
|
||||
modwifi.menu.UploadSpeed.460800.upload.speed=460800
|
||||
modwifi.menu.UploadSpeed.512000.windows=512000
|
||||
modwifi.menu.UploadSpeed.512000.upload.speed=512000
|
||||
modwifi.menu.UploadSpeed.921600=921600
|
||||
modwifi.menu.UploadSpeed.921600.upload.speed=921600
|
||||
|
||||
##############################################################
|
||||
thing.name=SparkFun ESP8266 Thing
|
||||
|
||||
thing.upload.tool=esptool
|
||||
thing.upload.speed=921600
|
||||
thing.upload.resetmethod=ck
|
||||
thing.upload.maximum_size=434160
|
||||
thing.upload.maximum_data_size=81920
|
||||
thing.upload.wait_for_upload_port=true
|
||||
thing.serial.disableDTR=true
|
||||
thing.serial.disableRTS=true
|
||||
|
||||
thing.build.mcu=esp8266
|
||||
thing.build.f_cpu=80000000L
|
||||
thing.build.board=ESP8266_THING
|
||||
thing.build.core=esp8266
|
||||
thing.build.variant=thing
|
||||
thing.build.flash_mode=qio
|
||||
# flash chip: AT25SF041 (512 kbyte, 4Mbit)
|
||||
thing.build.flash_size=512K
|
||||
thing.build.flash_ld=eagle.flash.512k.ld
|
||||
thing.build.flash_freq=40
|
||||
thing.build.spiffs_start=0x6B000
|
||||
thing.build.spiffs_end=0x7B000
|
||||
thing.build.spiffs_blocksize=4096
|
||||
|
||||
thing.menu.CpuFrequency.80=80 MHz
|
||||
thing.menu.CpuFrequency.80.build.f_cpu=80000000L
|
||||
thing.menu.CpuFrequency.160=160 MHz
|
||||
thing.menu.CpuFrequency.160.build.f_cpu=160000000L
|
||||
|
||||
thing.menu.UploadSpeed.115200=115200
|
||||
thing.menu.UploadSpeed.115200.upload.speed=115200
|
||||
thing.menu.UploadSpeed.9600=9600
|
||||
thing.menu.UploadSpeed.9600.upload.speed=9600
|
||||
thing.menu.UploadSpeed.57600=57600
|
||||
thing.menu.UploadSpeed.57600.upload.speed=57600
|
||||
thing.menu.UploadSpeed.256000.windows=256000
|
||||
thing.menu.UploadSpeed.256000.upload.speed=256000
|
||||
thing.menu.UploadSpeed.230400.linux=230400
|
||||
thing.menu.UploadSpeed.230400.macosx=230400
|
||||
thing.menu.UploadSpeed.230400.upload.speed=230400
|
||||
thing.menu.UploadSpeed.460800.linux=460800
|
||||
thing.menu.UploadSpeed.460800.macosx=460800
|
||||
thing.menu.UploadSpeed.460800.upload.speed=460800
|
||||
thing.menu.UploadSpeed.512000.windows=512000
|
||||
thing.menu.UploadSpeed.512000.upload.speed=512000
|
||||
thing.menu.UploadSpeed.921600=921600
|
||||
thing.menu.UploadSpeed.921600.upload.speed=921600
|
||||
|
||||
##############################################################
|
||||
esp210.name=SweetPea ESP-210
|
||||
@ -337,6 +387,7 @@ esp210.upload.tool=esptool
|
||||
esp210.upload.speed=115200
|
||||
esp210.upload.resetmethod=ck
|
||||
esp210.upload.maximum_size=1044464
|
||||
esp210.upload.maximum_data_size=81920
|
||||
esp210.upload.wait_for_upload_port=true
|
||||
esp210.serial.disableDTR=true
|
||||
esp210.serial.disableRTS=true
|
||||
|
||||
@ -14,6 +14,8 @@
|
||||
|
||||
#define SWRST do { (*((volatile uint32_t*) 0x60000700)) |= 0x80000000; } while(0);
|
||||
|
||||
extern void ets_wdt_enable(void);
|
||||
extern void ets_wdt_disable(void);
|
||||
|
||||
int load_app_from_flash_raw(const uint32_t flash_addr)
|
||||
{
|
||||
@ -124,7 +126,9 @@ void main()
|
||||
|
||||
if (cmd.action == ACTION_COPY_RAW) {
|
||||
ets_putc('c'); ets_putc('p'); ets_putc(':');
|
||||
ets_wdt_disable();
|
||||
res = copy_raw(cmd.args[0], cmd.args[1], cmd.args[2]);
|
||||
ets_wdt_enable();
|
||||
ets_putc('0'+res); ets_putc('\n');
|
||||
if (res == 0) {
|
||||
cmd.action = ACTION_LOAD_APP;
|
||||
|
||||
Binary file not shown.
@ -38,9 +38,6 @@ extern "C" {
|
||||
#include "esp8266_peri.h"
|
||||
#include "twi.h"
|
||||
|
||||
void yield(void);
|
||||
void optimistic_yield(void);
|
||||
|
||||
#define HIGH 0x1
|
||||
#define LOW 0x0
|
||||
|
||||
@ -207,6 +204,9 @@ void detachInterrupt(uint8_t);
|
||||
void setup(void);
|
||||
void loop(void);
|
||||
|
||||
void yield(void);
|
||||
void optimistic_yield(uint32_t interval_us);
|
||||
|
||||
// Get the bit location within the hardware port of the given virtual pin.
|
||||
// This comes from the pins_*.c file for the active board configuration.
|
||||
#define digitalPinToPort(pin) (0)
|
||||
|
||||
@ -559,7 +559,7 @@ int HardwareSerial::available(void) {
|
||||
}
|
||||
|
||||
if (!result) {
|
||||
optimistic_yield();
|
||||
optimistic_yield(USD(_uart->uart_nr) / 128);
|
||||
}
|
||||
|
||||
return result;
|
||||
|
||||
@ -109,6 +109,9 @@ cont_norm:
|
||||
l32i a2, a1, 4
|
||||
/* sp <- cont_ctx.sp_ret */
|
||||
l32i a1, a2, 4
|
||||
/* 0 -> cont_ctx.pc_ret */
|
||||
movi a4, 0
|
||||
s32i a4, a2, 0
|
||||
|
||||
cont_ret:
|
||||
/* restore registers */
|
||||
|
||||
@ -21,6 +21,8 @@
|
||||
#ifndef CONT_H_
|
||||
#define CONT_H_
|
||||
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifndef CONT_STACKSIZE
|
||||
#define CONT_STACKSIZE 4096
|
||||
#endif
|
||||
@ -58,4 +60,8 @@ void cont_yield(cont_t*);
|
||||
// return 1 if guard bytes were overwritten.
|
||||
int cont_check(cont_t* cont);
|
||||
|
||||
// Check if yield() may be called. Returns true if we are running inside
|
||||
// continuation stack
|
||||
bool cont_can_yield(cont_t* cont);
|
||||
|
||||
#endif /* CONT_H_ */
|
||||
|
||||
@ -19,6 +19,9 @@
|
||||
*/
|
||||
|
||||
#include "cont.h"
|
||||
#include <stddef.h>
|
||||
#include "ets_sys.h"
|
||||
|
||||
|
||||
#define CONT_STACKGUARD 0xfeefeffe
|
||||
|
||||
@ -34,3 +37,8 @@ int cont_check(cont_t* cont) {
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
bool cont_can_yield(cont_t* cont) {
|
||||
return !ETS_INTR_WITHINISR() &&
|
||||
cont->pc_ret != 0 && cont->pc_yield == 0;
|
||||
}
|
||||
|
||||
@ -64,16 +64,16 @@ extern void (*__init_array_end)(void);
|
||||
cont_t g_cont __attribute__ ((aligned (16)));
|
||||
static os_event_t g_loop_queue[LOOP_QUEUE_SIZE];
|
||||
|
||||
static uint32_t g_micros_at_last_task_yield;
|
||||
static uint32_t g_micros_at_task_start;
|
||||
|
||||
|
||||
extern "C" void abort() {
|
||||
while(1) {
|
||||
}
|
||||
do {
|
||||
*((int*)0) = 0;
|
||||
} while(true);
|
||||
}
|
||||
|
||||
extern "C" void esp_yield() {
|
||||
g_micros_at_last_task_yield = system_get_time();
|
||||
cont_yield(&g_cont);
|
||||
}
|
||||
|
||||
@ -82,16 +82,22 @@ extern "C" void esp_schedule() {
|
||||
}
|
||||
|
||||
extern "C" void __yield() {
|
||||
if (cont_can_yield(&g_cont)) {
|
||||
esp_schedule();
|
||||
esp_yield();
|
||||
}
|
||||
else {
|
||||
abort();
|
||||
}
|
||||
}
|
||||
|
||||
extern "C" void yield(void) __attribute__ ((weak, alias("__yield")));
|
||||
|
||||
extern "C" void optimistic_yield(void) {
|
||||
if (!ETS_INTR_WITHINISR() &&
|
||||
(system_get_time() - g_micros_at_last_task_yield) > OPTIMISTIC_YIELD_TIME_US)
|
||||
extern "C" void optimistic_yield(uint32_t interval_us) {
|
||||
if (cont_can_yield(&g_cont) &&
|
||||
(system_get_time() - g_micros_at_task_start) > interval_us)
|
||||
{
|
||||
__yield();
|
||||
yield();
|
||||
}
|
||||
}
|
||||
|
||||
@ -107,10 +113,10 @@ static void loop_wrapper() {
|
||||
}
|
||||
|
||||
static void loop_task(os_event_t *events) {
|
||||
g_micros_at_last_task_yield = system_get_time();
|
||||
g_micros_at_task_start = system_get_time();
|
||||
cont_run(&g_cont, &loop_wrapper);
|
||||
if(cont_check(&g_cont) != 0) {
|
||||
ets_printf("\r\nheap collided with sketch stack\r\n");
|
||||
ets_printf("\r\nsketch stack overflow detected\r\n");
|
||||
abort();
|
||||
}
|
||||
}
|
||||
@ -127,13 +133,11 @@ void init_done() {
|
||||
esp_schedule();
|
||||
}
|
||||
|
||||
extern "C" {
|
||||
void user_init(void) {
|
||||
|
||||
extern "C" void user_init(void) {
|
||||
struct rst_info *rtc_info_ptr = system_get_rst_info();
|
||||
|
||||
memcpy((void *) &resetInfo, (void *) rtc_info_ptr, sizeof(resetInfo));
|
||||
|
||||
|
||||
uart_div_modify(0, UART_CLK_FREQ / (115200));
|
||||
|
||||
init();
|
||||
@ -148,5 +152,3 @@ void user_init(void) {
|
||||
|
||||
system_init_done_cb(&init_done);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -20,13 +20,13 @@
|
||||
#include <ctype.h>
|
||||
#include "pgmspace.h"
|
||||
|
||||
size_t strnlen_P(const char* s, size_t size) {
|
||||
size_t strnlen_P(PGM_P s, size_t size) {
|
||||
const char* cp;
|
||||
for (cp = s; size != 0 && pgm_read_byte(cp) != '\0'; cp++, size--);
|
||||
return (size_t) (cp - s);
|
||||
}
|
||||
|
||||
void* memcpy_P(void* dest, const void* src, size_t count) {
|
||||
void* memcpy_P(void* dest, PGM_VOID_P src, size_t count) {
|
||||
const uint8_t* read = reinterpret_cast<const uint8_t*>(src);
|
||||
uint8_t* write = reinterpret_cast<uint8_t*>(dest);
|
||||
|
||||
@ -39,7 +39,83 @@ void* memcpy_P(void* dest, const void* src, size_t count) {
|
||||
return dest;
|
||||
}
|
||||
|
||||
char* strncpy_P(char* dest, const char* src, size_t size) {
|
||||
int memcmp_P(const void* buf1, PGM_VOID_P buf2P, size_t size) {
|
||||
int result = 0;
|
||||
const uint8_t* read1 = (const uint8_t*)buf1;
|
||||
const uint8_t* read2 = (const uint8_t*)buf2P;
|
||||
|
||||
while (size > 0) {
|
||||
uint8_t ch2 = pgm_read_byte(read2);
|
||||
uint8_t ch1 = *read1;
|
||||
if (ch1 != ch2) {
|
||||
result = (int)(ch1)-(int)(ch2);
|
||||
break;
|
||||
}
|
||||
|
||||
read1++;
|
||||
read2++;
|
||||
size--;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
void* memccpy_P(void* dest, PGM_VOID_P src, int c, size_t count) {
|
||||
uint8_t* read = (uint8_t*)src;
|
||||
uint8_t* write = (uint8_t*)dest;
|
||||
void* result = NULL;
|
||||
|
||||
while (count > 0) {
|
||||
uint8_t ch = pgm_read_byte(read++);
|
||||
*write++ = ch;
|
||||
count--;
|
||||
if (c == ch) {
|
||||
return write; // the value after the found c
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
void* memmem_P(const void* buf, size_t bufSize, PGM_VOID_P findP, size_t findPSize) {
|
||||
const uint8_t* read = (const uint8_t*)buf;
|
||||
const uint8_t* find = (uint8_t*)findP;
|
||||
uint8_t first = pgm_read_byte(find++);
|
||||
|
||||
findPSize--;
|
||||
|
||||
while (bufSize > 0) {
|
||||
if (*read == first) {
|
||||
size_t findSize = findPSize;
|
||||
const uint8_t* tag = read + 1;
|
||||
size_t tagBufSize = bufSize - 1;
|
||||
const uint8_t* findTag = find;
|
||||
|
||||
while (tagBufSize > 0 && findSize > 0) {
|
||||
uint8_t ch = pgm_read_byte(findTag++);
|
||||
if (ch != *tag) {
|
||||
bufSize--;
|
||||
read++;
|
||||
break;
|
||||
}
|
||||
findSize--;
|
||||
tagBufSize--;
|
||||
tag++;
|
||||
}
|
||||
if (findSize == 0) {
|
||||
return (void*)read;
|
||||
}
|
||||
}
|
||||
else {
|
||||
bufSize--;
|
||||
read++;
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
char* strncpy_P(char* dest, PGM_P src, size_t size) {
|
||||
const char* read = src;
|
||||
char* write = dest;
|
||||
char ch = '.';
|
||||
@ -53,7 +129,7 @@ char* strncpy_P(char* dest, const char* src, size_t size) {
|
||||
return dest;
|
||||
}
|
||||
|
||||
char* strncat_P(char* dest, const char* src, size_t size) {
|
||||
char* strncat_P(char* dest, PGM_P src, size_t size) {
|
||||
char* write = dest;
|
||||
|
||||
while (*write != '\0')
|
||||
@ -80,7 +156,7 @@ char* strncat_P(char* dest, const char* src, size_t size) {
|
||||
return dest;
|
||||
}
|
||||
|
||||
int strncmp_P(const char* str1, const char* str2P, size_t size) {
|
||||
int strncmp_P(const char* str1, PGM_P str2P, size_t size) {
|
||||
int result = 0;
|
||||
|
||||
while (size > 0)
|
||||
@ -99,7 +175,7 @@ int strncmp_P(const char* str1, const char* str2P, size_t size) {
|
||||
return result;
|
||||
}
|
||||
|
||||
int strncasecmp_P(const char* str1, const char* str2P, size_t size) {
|
||||
int strncasecmp_P(const char* str1, PGM_P str2P, size_t size) {
|
||||
int result = 0;
|
||||
|
||||
while (size > 0)
|
||||
@ -118,7 +194,7 @@ int strncasecmp_P(const char* str1, const char* str2P, size_t size) {
|
||||
return result;
|
||||
}
|
||||
|
||||
int printf_P(const char* formatP, ...) {
|
||||
int printf_P(PGM_P formatP, ...) {
|
||||
int ret;
|
||||
va_list arglist;
|
||||
va_start(arglist, formatP);
|
||||
@ -135,7 +211,7 @@ int printf_P(const char* formatP, ...) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
int sprintf_P(char* str, const char* formatP, ...) {
|
||||
int sprintf_P(char* str, PGM_P formatP, ...) {
|
||||
int ret;
|
||||
va_list arglist;
|
||||
va_start(arglist, formatP);
|
||||
@ -146,7 +222,7 @@ int sprintf_P(char* str, const char* formatP, ...) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
int snprintf_P(char* str, size_t strSize, const char* formatP, ...) {
|
||||
int snprintf_P(char* str, size_t strSize, PGM_P formatP, ...) {
|
||||
int ret;
|
||||
va_list arglist;
|
||||
va_start(arglist, formatP);
|
||||
@ -157,7 +233,7 @@ int snprintf_P(char* str, size_t strSize, const char* formatP, ...) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
int vsnprintf_P(char* str, size_t strSize, const char* formatP, va_list ap) {
|
||||
int vsnprintf_P(char* str, size_t strSize, PGM_P formatP, va_list ap) {
|
||||
int ret;
|
||||
|
||||
size_t fmtLen = strlen_P(formatP);
|
||||
|
||||
@ -32,27 +32,40 @@ typedef uint32_t prog_uint32_t;
|
||||
|
||||
#define SIZE_IRRELEVANT 0x7fffffff
|
||||
|
||||
void* memcpy_P(void* dest, const void* src, size_t count);
|
||||
// memchr_P and memrchr_P are not implemented due to danger in its use, and
|
||||
// how uninteresting their use is
|
||||
// since its a flash string, you should already know where the char is within it,
|
||||
// further, it could return a pointer into the flash memory that is not 32bit aligned
|
||||
// which could cause an exception if read
|
||||
// PGM_VOID_P memchr_P(PGM_VOID_P bufP, int c, size_t count);
|
||||
// PGM_VOID_P memrchr_P(PGM_VOID_P bufP, int c, size_t count);
|
||||
|
||||
char* strncpy_P(char* dest, const char* src, size_t size);
|
||||
int memcmp_P(const void* buf1, PGM_VOID_P buf2P, size_t size);
|
||||
// memccpy_P is only valid when used with pointers to 8bit data, due to size aligned pointers
|
||||
// and endianess of the values greater than 8bit, matching c may return invalid aligned pointers
|
||||
void* memccpy_P(void* dest, PGM_VOID_P src, int c, size_t count);
|
||||
void* memmem_P(const void* buf, size_t bufSize, PGM_VOID_P findP, size_t findPSize);
|
||||
void* memcpy_P(void* dest, PGM_VOID_P src, size_t count);
|
||||
|
||||
char* strncpy_P(char* dest, PGM_P src, size_t size);
|
||||
#define strcpy_P(dest, src) strncpy_P((dest), (src), SIZE_IRRELEVANT)
|
||||
|
||||
char* strncat_P(char* dest, const char* src, size_t size);
|
||||
char* strncat_P(char* dest, PGM_P src, size_t size);
|
||||
#define strcat_P(dest, src) strncat_P((dest), (src), SIZE_IRRELEVANT)
|
||||
|
||||
int strncmp_P(const char* str1, const char* str2P, size_t size);
|
||||
int strncmp_P(const char* str1, PGM_P str2P, size_t size);
|
||||
#define strcmp_P(str1, str2P) strncmp_P((str1), (str2P), SIZE_IRRELEVANT)
|
||||
|
||||
int strncasecmp_P(const char* str1, const char* str2P, size_t size);
|
||||
int strncasecmp_P(const char* str1, PGM_P str2P, size_t size);
|
||||
#define strcasecmp_P(str1, str2P) strncasecmp_P((str1), (str2P), SIZE_IRRELEVANT)
|
||||
|
||||
size_t strnlen_P(const char *s, size_t size);
|
||||
size_t strnlen_P(PGM_P s, size_t size);
|
||||
#define strlen_P(strP) strnlen_P((strP), SIZE_IRRELEVANT)
|
||||
|
||||
int printf_P(const char *formatP, ...) __attribute__ ((format (printf, 1, 2)));
|
||||
int sprintf_P(char *str, const char *formatP, ...) __attribute__((format(printf, 2, 3)));
|
||||
int snprintf_P(char *str, size_t strSize, const char *formatP, ...) __attribute__((format(printf, 3, 4)));
|
||||
int vsnprintf_P(char *str, size_t strSize, const char *formatP, va_list ap) __attribute__ ((format (printf, 3, 0)));
|
||||
int printf_P(PGM_P formatP, ...) __attribute__((format(printf, 1, 2)));
|
||||
int sprintf_P(char *str, PGM_P formatP, ...) __attribute__((format(printf, 2, 3)));
|
||||
int snprintf_P(char *str, size_t strSize, PGM_P formatP, ...) __attribute__((format(printf, 3, 4)));
|
||||
int vsnprintf_P(char *str, size_t strSize, PGM_P formatP, va_list ap) __attribute__((format(printf, 3, 0)));
|
||||
|
||||
// flash memory must be read using 32 bit aligned addresses else a processor
|
||||
// exception will be triggered
|
||||
|
||||
145
doc/boards.md
Normal file
145
doc/boards.md
Normal file
@ -0,0 +1,145 @@
|
||||
---
|
||||
title: Supported Hardware
|
||||
---
|
||||
|
||||
- [Adafruit HUZZAH ESP8266 (ESP-12)](#adafruit-huzzah-esp8266-esp-12)
|
||||
- [NodeMCU 0.9](#nodemcu-0-9)
|
||||
- [NodeMCU 1.0](#nodemcu-1-0)
|
||||
- [Olimex MOD-WIFI-ESP8266](#olimex-mod-wifi-esp8266)
|
||||
- [SparkFun ESP8266 Thing](#sparkfun-esp8266-thing)
|
||||
- [SweetPea ESP-210](#sweetpea-esp-210)
|
||||
- [Generic ESP8266 modules](#generic-esp8266-modules)
|
||||
|
||||
### Adafruit HUZZAH ESP8266 (ESP-12)
|
||||
|
||||
*TODO: add notes*
|
||||
|
||||
### NodeMCU 0.9 <a name="nodemcu-0-9"></a>
|
||||
|
||||
#### Pin mapping
|
||||
|
||||
Pin numbers written on the board itself do not correspond to ESP8266 GPIO pin numbers. Constants are defined to make using this board easier:
|
||||
|
||||
```C++
|
||||
static const uint8_t D0 = 16;
|
||||
static const uint8_t D1 = 5;
|
||||
static const uint8_t D2 = 4;
|
||||
static const uint8_t D3 = 0;
|
||||
static const uint8_t D4 = 2;
|
||||
static const uint8_t D5 = 14;
|
||||
static const uint8_t D6 = 12;
|
||||
static const uint8_t D7 = 13;
|
||||
static const uint8_t D8 = 15;
|
||||
static const uint8_t D9 = 3;
|
||||
static const uint8_t D10 = 1;
|
||||
```
|
||||
|
||||
If you want to use NodeMCU pin 5, use D5 for pin number, and it will be translated to 'real' GPIO pin 14.
|
||||
|
||||
### NodeMCU 1.0 <a name="nodemcu-1-0"></a>
|
||||
|
||||
*TODO: add notes*
|
||||
|
||||
### Olimex MOD-WIFI-ESP8266
|
||||
|
||||
*TODO: add notes*
|
||||
|
||||
### SparkFun ESP8266 Thing ###
|
||||
|
||||
Product page: https://www.sparkfun.com/products/13231
|
||||
|
||||
*TODO: add notes*
|
||||
|
||||
### SweetPea ESP-210
|
||||
|
||||
*TODO: add notes*
|
||||
|
||||
### Generic ESP8266 modules
|
||||
|
||||
These modules come in different form factors and pinouts. See the page at ESP8266 community wiki for more info:
|
||||
[ESP8266 Module Family](http://www.esp8266.com/wiki/doku.php?id=esp8266-module-family).
|
||||
|
||||
Usually these modules have no bootstapping resistors on board, insufficient decoupling capacitors, no voltage regulator, no reset circuit, and no USB-serial adapter. This makes using them somewhat tricky, compared to development boards which add these features.
|
||||
|
||||
In order to use these modules, make sure to observe the following:
|
||||
|
||||
- **Provide sufficient power to the module.** For stable use of the ESP8266 a power supply with 3.3V and >= 250mA is required. Using the power available from USB to Serial adapter is not recommended, these adapters typically do not supply enough current to run ESP8266 reliably in every situation. An external supply or regulator along with filtering capacitors is preferred.
|
||||
|
||||
- **Connect bootstapping resistors** to GPIO0, GPIO2, GPIO15 according to the schematics below.
|
||||
|
||||
- **Put ESP8266 into bootloader mode** before uploading code.
|
||||
|
||||
### Serial Adapter
|
||||
|
||||
There are many different USB to Serial adapters / boards.
|
||||
|
||||
* Note
|
||||
- for full upload management you need RTS and DTR
|
||||
- the chip need to have 3.3V TTL (5V may damage the chip)
|
||||
- not all board have all pins of the ICs as breakout (check before order)
|
||||
- CTS and DSR are not useful for upload (they are Inputs)
|
||||
|
||||
* Working ICs
|
||||
- FT232RL
|
||||
- CP2102
|
||||
- CH340G
|
||||
- maybe others (drop a comment)
|
||||
|
||||
### Minimal Hardware Setup for Bootloading and Usage
|
||||
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Serial Adapter |
|
||||
| ------------- | -------- | -------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| TX or GPIO2* | | RX |
|
||||
| RX | | TX |
|
||||
| GPIO0 | PullUp | DTR |
|
||||
| Reset* | PullUp | RTS |
|
||||
| GPIO15* | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
* Note
|
||||
- GPIO15 is also named MTDO
|
||||
- Reset is also named RSBT or REST (adding PullUp improves the stability of the Module)
|
||||
- GPIO2 is alternative TX for the boot loader mode
|
||||
- **Directly connecting a pin to VCC or GND is not a substitute for a PullUp or PullDown resistor, doing this can break upload management and the serial console, instability has also been noted in some cases.**
|
||||
|
||||
### ESP to Serial
|
||||
|
||||
|
||||
#### Minimal Hardware Setup for Bootloading only ##
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Serial Adapter |
|
||||
| ------------- | -------- | --------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| TX or GPIO2 | | RX |
|
||||
| RX | | TX |
|
||||
| GPIO0 | | GND |
|
||||
| Reset | | RTS* |
|
||||
| GPIO15 | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
* Note
|
||||
- if no RTS is used a manual power toggle is needed
|
||||
|
||||
#### Minimal Hardware Setup for Running only ##
|
||||
|
||||
ESPxx Hardware
|
||||
|
||||
| PIN | Resistor | Power supply |
|
||||
| ------------- | -------- | --------------- |
|
||||
| VCC | | VCC (3.3V) |
|
||||
| GND | | GND |
|
||||
| GPIO0 | PullUp | |
|
||||
| GPIO15 | PullDown | |
|
||||
| CH_PD | PullUp | |
|
||||
|
||||
### Minimal
|
||||
|
||||
|
||||
### Improved Stability
|
||||
|
||||
@ -1,10 +1,28 @@
|
||||
# Change log
|
||||
---
|
||||
title: Change log
|
||||
---
|
||||
|
||||
## Current version
|
||||
*Future release*
|
||||
|
||||
### Core
|
||||
|
||||
- Updated I2C library to better handle repeated start for certain devices.
|
||||
- I2C library updated to better handle repeated start for certain devices,
|
||||
improved waveforms, higher frequencies for 160MHz core clock, fix case where
|
||||
using different pins would not work with libs calling begin internally.
|
||||
- Add Adafruit HUZZAH board
|
||||
- Add SparkFun Thing board
|
||||
- Add SweetPea ESP-210 board
|
||||
- Add eboot bootloader
|
||||
- Timer0 support
|
||||
- Add PWM range and frequency control
|
||||
- Add ESP.eraseConfig method
|
||||
- Fix pin change interrupt handling (#322)
|
||||
- Add SLC and I2S register definitions
|
||||
- Fix math functions calling themselves recursively (#233, #354)
|
||||
- Print stack on exception and soft WDT reset
|
||||
- Add Updater class
|
||||
- Remove implementations of WDT-related functions
|
||||
- Provide selection between A0 and VCC (#443, #338)
|
||||
|
||||
### Libraries
|
||||
|
||||
@ -12,11 +30,21 @@
|
||||
add setContentSize method.
|
||||
- ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode
|
||||
selection (#28).
|
||||
- Better handling of WiFi disconnect (#231)
|
||||
- Add API to set the beginning of local ports range for WiFiClient.
|
||||
- Add RSSI function
|
||||
- Add function to get the MAC / BSSID as String
|
||||
- Servo library support
|
||||
- Add ESP8266WiFiMesh library
|
||||
- Add ESP8266SSDP library
|
||||
|
||||
### Tools
|
||||
|
||||
- SDK updated to 1.1.0 (#306)
|
||||
- Update SDK to v1.2.0_15_07_03
|
||||
- Better sketch size reporting (#314)
|
||||
- Update esptool to 0.4.5
|
||||
|
||||
---
|
||||
|
||||
## 1.6.4-673-g8cd3697
|
||||
May 22, 2015
|
||||
@ -45,4 +73,3 @@ May 22, 2015
|
||||
May 19, 2015
|
||||
|
||||
- Initial release of Boards Manager package for ESP8266 platform.
|
||||
|
||||
|
||||
1187
doc/esp12.svg
Normal file
1187
doc/esp12.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 51 KiB |
213
doc/reference.md
Normal file
213
doc/reference.md
Normal file
@ -0,0 +1,213 @@
|
||||
---
|
||||
title: Reference
|
||||
---
|
||||
|
||||
## Digital IO
|
||||
|
||||
Pin numbers in Arduino correspond directly to the ESP8266 GPIO pin numbers. `pinMode`, `digitalRead`, and `digitalWrite` functions work as usual, so to read GPIO2, call `digitalRead(2)`.
|
||||
|
||||
Digital pins 0—15 can be `INPUT`, `OUTPUT`, or `INPUT_PULLUP`.
|
||||
Pin 16 can be `INPUT`, `OUTPUT` or `INPUT_PULLDOWN`. At startup, pins are configured as `INPUT`.
|
||||
|
||||
Pins may also serve other functions, like Serial, I2C, SPI. These functions are normally activated by the corresponding library. The diagram below shows pin mapping for the popular ESP-12 module.
|
||||
|
||||
|
||||
|
||||
Digital pins 6—11 are not shown on this diagram because they are used to connect flash memory chip on most modules. Trying to use these pins as IOs will likely cause the program to crash.
|
||||
|
||||
Note that some boards and modules (ESP-12ED, NodeMCU 1.0) also break out pins 9 and 11. These may be used as IO if flash chip works in DIO mode (as opposed to QIO, which is the default one).
|
||||
|
||||
Pin interrupts are supported through `attachInterrupt`, `detachInterrupt` functions.
|
||||
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
|
||||
types are supported: `CHANGE`, `RISING`, `FALLING`.
|
||||
|
||||
## Analog input
|
||||
|
||||
ESP8266 has a single ADC channel available to users. It may be used either to read voltage at ADC pin, or to read module supply voltage (VCC).
|
||||
|
||||
To read external voltage applied to ADC pin, use `analogRead(A0)`. Input voltage range is 0 — 1.0V.
|
||||
|
||||
To read VCC voltage, ADC pin must be kept unconnected. Additionally, the following line has to be added to the sketch:
|
||||
|
||||
```c++
|
||||
ADC_MODE(ADC_VCC);
|
||||
```
|
||||
|
||||
This line has to appear outside of any functions, for instance right after the `#include ` lines of your sketch.
|
||||
|
||||
## Analog output
|
||||
|
||||
`analogWrite(pin, value)` enables software PWM on the given pin. PWM may be used on pins 0 to 16.
|
||||
Call `analogWrite(pin, 0)` to disable PWM on the pin. `value` may be in range from 0 to `PWMRANGE`, which is equal to 1023 by default. PWM range may be changed by calling `analogWriteRange(new_range)`.
|
||||
|
||||
PWM frequency is 1kHz by default. Call `analogWriteFreq(new_frequency)` to change the frequency.
|
||||
|
||||
## Timing and delays
|
||||
`millis()` and `micros()` return the number of milliseconds and microseconds elapsed after reset, respectively.
|
||||
|
||||
`delay(ms)` pauses the sketch for a given number of milliseconds and allows WiFi and TCP/IP tasks to run.
|
||||
`delayMicroseconds(us)` pauses for a given number of microseconds.
|
||||
|
||||
Remember that there is a lot of code that needs to run on the chip besides the sketch
|
||||
when WiFi is connected. WiFi and TCP/IP libraries get a chance to handle any pending
|
||||
events each time the `loop()` function completes, OR when `delay` is called.
|
||||
If you have a loop somewhere in your sketch that takes a lot of time (>50ms) without
|
||||
calling `delay`, you might consider adding a call to `delay` function to keep the WiFi
|
||||
stack running smoothly.
|
||||
|
||||
There is also a `yield()` function which is equivalent to `delay(0)`. The `delayMicroseconds`
|
||||
function, on the other hand, does not yield to other tasks, so using it for delays
|
||||
more than 20 milliseconds is not recommended.
|
||||
|
||||
## Serial
|
||||
|
||||
`Serial` object works much the same way as on a regular Arduino. Apart from hardware FIFO (128 bytes for TX and RX) HardwareSerial has additional 256-byte TX and RX buffers. Both transmit and receive is interrupt-driven. Write and read functions only block the sketch execution when the respective FIFO/buffers are full/empty.
|
||||
|
||||
`Serial` uses UART0, which is mapped to pins GPIO1 (TX) and GPIO3 (RX). Serial may be remapped to GPIO15 (TX) and GPIO13 (RX) by calling `Serial.swap()` after `Serial.begin`. Calling `swap` again maps UART0 back to GPIO1 and GPIO3.
|
||||
|
||||
`Serial1` uses UART1, TX pin is GPIO2. UART1 can not be used to receive data because normally it's RX pin is occupied for flash chip connection. To use `Serial1`, call `Serial1.begin(baudrate)`.
|
||||
|
||||
By default the diagnostic output from WiFi libraries is disabled when you call `Serial.begin`. To enable debug output again, call `Serial.setDebugOutput(true)`. To redirect debug output to `Serial1` instead, call `Serial1.setDebugOutput(true)`.
|
||||
|
||||
You also need to use `Serial.setDebugOutput(true)` to enable output from `printf()` function.
|
||||
|
||||
Both `Serial` and `Serial1` objects support 5, 6, 7, 8 data bits, odd (O), even (E), and no (N) parity, and 1 or 2 stop bits. To set the desired mode, call `Serial.begin(baudrate, SERIAL_8N1)`, `Serial.begin(baudrate, SERIAL_6E2)`, etc.
|
||||
|
||||
## Progmem
|
||||
|
||||
The Program memory features work much the same way as on a regular Arduino; placing read only data and strings in read only memory and freeing heap for your application.
|
||||
The important difference is that on the ESP8266 the literal strings are not pooled. This means that the same literal string defined inside a `F("")` and/or `PSTR("")` will take up space for each instance in the code. So you will need to manage the duplicate strings yourself.
|
||||
|
||||
## WiFi(ESP8266WiFi library)
|
||||
|
||||
This is mostly similar to WiFi shield library. Differences include:
|
||||
|
||||
- `WiFi.mode(m)`: set mode to `WIFI_AP`, `WIFI_STA`, or `WIFI_AP_STA`.
|
||||
- call `WiFi.softAP(ssid)` to set up an open network
|
||||
- call `WiFi.softAP(ssid, password)` to set up a WPA2-PSK network (password should be at least 8 characters)
|
||||
- `WiFi.macAddress(mac)` is for STA, `WiFi.softAPmacAddress(mac)` is for AP.
|
||||
- `WiFi.localIP()` is for STA, `WiFi.softAPIP()` is for AP.
|
||||
- `WiFi.RSSI()` doesn't work
|
||||
- `WiFi.printDiag(Serial)` will print out some diagnostic info
|
||||
- `WiFiUDP` class supports sending and receiving multicast packets on STA interface.
|
||||
When sending a multicast packet, replace `udp.beginPacket(addr, port)` with
|
||||
`udp.beginPacketMulticast(addr, port, WiFi.localIP())`.
|
||||
When listening to multicast packets, replace `udp.begin(port)` with
|
||||
`udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port)`.
|
||||
You can use `udp.destinationIP()` to tell whether the packet received was
|
||||
sent to the multicast or unicast address.
|
||||
Also note that multicast doesn't work on softAP interface.
|
||||
|
||||
`WiFiServer`, `WiFiClient`, and `WiFiUDP` behave mostly the same way as with WiFi shield library.
|
||||
Four samples are provided for this library.
|
||||
You can see more commands here: [http://www.arduino.cc/en/Reference/WiFi](http://www.arduino.cc/en/Reference/WiFi)
|
||||
|
||||
## Ticker
|
||||
|
||||
Library for calling functions repeatedly with a certain period. Two examples included.
|
||||
|
||||
It is currently not recommended to do blocking IO operations (network, serial, file) from Ticker
|
||||
callback functions. Instead, set a flag inside the ticker callback and check for that flag inside the loop function.
|
||||
|
||||
## EEPROM
|
||||
|
||||
This is a bit different from standard EEPROM class. You need to call `EEPROM.begin(size)`
|
||||
before you start reading or writing, size being the number of bytes you want to use.
|
||||
Size can be anywhere between 4 and 4096 bytes.
|
||||
|
||||
`EEPROM.write` does not write to flash immediately, instead you must call `EEPROM.commit()`
|
||||
whenever you wish to save changes to flash. `EEPROM.end()` will also commit, and will
|
||||
release the RAM copy of EEPROM contents.
|
||||
|
||||
EEPROM library uses one sector of flash located at 0x7b000 for storage.
|
||||
|
||||
Three examples included.
|
||||
|
||||
## I2C (Wire library)
|
||||
|
||||
Wire library currently supports master mode up to approximately 450KHz.
|
||||
Before using I2C, pins for SDA and SCL need to be set by calling
|
||||
`Wire.begin(int sda, int scl)`, i.e. `Wire.begin(0, 2)` on ESP-01,
|
||||
else they default to pins 4(SDA) and 5(SCL).
|
||||
|
||||
## SPI
|
||||
|
||||
SPI library supports the entire Arduino SPI API including transactions, including setting phase (CPHA).
|
||||
Setting the Clock polarity (CPOL) is not supported, yet (SPI_MODE2 and SPI_MODE3 not working).
|
||||
|
||||
## ESP-specific APIs
|
||||
|
||||
APIs related to deep sleep and watchdog timer are available in the `ESP` object, only available in Alpha version.
|
||||
|
||||
`ESP.deepSleep(microseconds, mode)` will put the chip into deep sleep. `mode` is one of `WAKE_RF_DEFAULT`, `WAKE_RFCAL`, `WAKE_NO_RFCAL`, `WAKE_RF_DISABLED`. (GPIO16 needs to be tied to RST to wake from deepSleep.)
|
||||
|
||||
`ESP.restart()` restarts the CPU.
|
||||
|
||||
`ESP.getFreeHeap()` returns the free heap size.
|
||||
|
||||
`ESP.getChipId()` returns the ESP8266 chip ID as a 32-bit integer.
|
||||
|
||||
Several APIs may be used to get flash chip info:
|
||||
|
||||
`ESP.getFlashChipId()` returns the flash chip ID as a 32-bit integer.
|
||||
|
||||
`ESP.getFlashChipSize()` returns the flash chip size, in bytes, as seen by the SDK (may be less than actual size).
|
||||
|
||||
`ESP.getFlashChipSpeed(void)` returns the flash chip frequency, in Hz.
|
||||
|
||||
`ESP.getCycleCount()` returns the cpu instruction cycle count since start as an unsigned 32-bit. This is useful for accurate timing of very short actions like bit banging.
|
||||
|
||||
`ESP.getVcc()` may be used to measure supply voltage. ESP needs to reconfigure the ADC
|
||||
at startup in order for this feature to be available. Add the following line to the top
|
||||
of your sketch to use `getVcc`:
|
||||
|
||||
```c++
|
||||
ADC_MODE(ADC_VCC);
|
||||
```
|
||||
|
||||
TOUT pin has to be disconnected in this mode.
|
||||
|
||||
Note that by default ADC is configured to read from TOUT pin using `analogRead(A0)`, and
|
||||
`ESP.getVCC()` is not available.
|
||||
|
||||
## OneWire (from https://www.pjrc.com/teensy/td_libs_OneWire.html)
|
||||
|
||||
Library was adapted to work with ESP8266 by including register definitions into OneWire.h
|
||||
Note that if you already have OneWire library in your Arduino/libraries folder, it will be used
|
||||
instead of the one that comes with this package.
|
||||
|
||||
## mDNS and DNS-SD responder (ESP8266mDNS library)
|
||||
|
||||
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local", and DNS-SD (service dicovery) queries.
|
||||
Currently the library only works on STA interface, AP interface is not supported.
|
||||
See attached example for details.
|
||||
|
||||
## SSDP responder (ESP8266SSDP)
|
||||
|
||||
SSDP is another service discovery protocol, supported on Windows out of the box. See attached example for reference.
|
||||
|
||||
## DNS server (DNSServer library)
|
||||
|
||||
Implements a simple DNS server that can be used in both STA and AP modes. The DNS server currently supports only one domain (for all other domains it will reply with NXDOMAIN or custom status code). With it clients can open a web server running on ESP8266 using a domain name, not an IP address.
|
||||
See attached example for details.
|
||||
|
||||
## Servo
|
||||
|
||||
This library exposes the ability to control RC (hobby) servo motors. It will support upto 24 servos on any available output pin. By defualt the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be effected.
|
||||
While many RC servo motors will accept the 3.3V IO data pin from a ESP8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the ESP8266 and the servo motor power supply.
|
||||
|
||||
## Other libraries (not included with the IDE)
|
||||
|
||||
Libraries that don't rely on low-level access to AVR registers should work well. Here are a few libraries that were verified to work:
|
||||
|
||||
- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets) - WebSocket Server and Client compatible with ESP8266 (RFC6455)
|
||||
- [aREST](https://github.com/marcoschwartz/aREST) REST API handler library.
|
||||
- [Blynk](https://github.com/blynkkk/blynk-library) - easy IoT framework for Makers (check out the [Kickstarter page](http://tiny.cc/blynk-kick)).
|
||||
- [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library.git)
|
||||
- [DHT11](https://github.com/adafruit/DHT-sensor-library) - Download latest v1.1.0 library and no changes are necessary. Older versions should initialize DHT as follows: `DHT dht(DHTPIN, DHTTYPE, 15)`
|
||||
- [NeoPixel](https://github.com/adafruit/Adafruit_NeoPixel) - Adafruit's NeoPixel library, now with support for the ESP8266 (use version 1.0.2 or higher from Arduino's library manager).
|
||||
- [NeoPixelBus](https://github.com/Makuna/NeoPixelBus) - Arduino NeoPixel library compatible with ESP8266. Use the "NeoPixelAnimator" branch for ESP8266 to get HSL color support and more.
|
||||
- [PubSubClient](https://github.com/Imroy/pubsubclient) MQTT library by @Imroy.
|
||||
- [RTC](https://github.com/Makuna/Rtc) - Arduino Library for Ds1307 & Ds3231 compatible with ESP8266.
|
||||
- [Souliss, Smart Home](https://github.com/souliss/souliss) - Framework for Smart Home based on Arduino, Android and openHAB.
|
||||
- [ST7735](https://github.com/nzmichaelh/Adafruit-ST7735-Library) - Adafruit's ST7735 library modified to be compatible with ESP8266. Just make sure to modify the pins in the examples as they are still AVR specific.
|
||||
@ -1,5 +1,4 @@
|
||||
#include <ESP8266WiFi.h>
|
||||
#include <WiFiUDP.h>
|
||||
#include <ESP8266WebServer.h>
|
||||
#include <ESP8266SSDP.h>
|
||||
|
||||
|
||||
@ -38,9 +38,8 @@
|
||||
|
||||
const char* ssid = "**********";
|
||||
const char* password = "**********";
|
||||
const char* hostname = "esp8266sd";
|
||||
const char* host = "esp8266sd";
|
||||
|
||||
MDNSResponder mdns;
|
||||
ESP8266WebServer server(80);
|
||||
|
||||
static bool hasSD = false;
|
||||
@ -245,10 +244,11 @@ void setup(void){
|
||||
DBG_OUTPUT_PORT.print("Connected! IP address: ");
|
||||
DBG_OUTPUT_PORT.println(WiFi.localIP());
|
||||
|
||||
if (mdns.begin(hostname, WiFi.localIP())) {
|
||||
if (MDNS.begin(host)) {
|
||||
MDNS.addService("http", "tcp", 80);
|
||||
DBG_OUTPUT_PORT.println("MDNS responder started");
|
||||
DBG_OUTPUT_PORT.print("You can now connect to http://");
|
||||
DBG_OUTPUT_PORT.print(hostname);
|
||||
DBG_OUTPUT_PORT.print(host);
|
||||
DBG_OUTPUT_PORT.println(".local");
|
||||
}
|
||||
|
||||
|
||||
@ -108,20 +108,26 @@ bool ESP8266WebServer::_parseRequest(WiFiClient& client) {
|
||||
|
||||
if (!isForm){
|
||||
if (searchStr != "") searchStr += '&';
|
||||
String bodyLine = client.readStringUntil('\r');
|
||||
//some clients send headers first and data after (like we do)
|
||||
//give them a chance
|
||||
int tries = 100;//100ms max wait
|
||||
while(!client.available() && tries--)delay(1);
|
||||
size_t plainLen = client.available();
|
||||
char *plainBuf = (char*)malloc(plainLen+1);
|
||||
client.readBytes(plainBuf, plainLen);
|
||||
plainBuf[plainLen] = '\0';
|
||||
#ifdef DEBUG
|
||||
DEBUG_OUTPUT.print("Plain: ");
|
||||
DEBUG_OUTPUT.println(bodyLine);
|
||||
DEBUG_OUTPUT.println(plainBuf);
|
||||
#endif
|
||||
if(bodyLine.startsWith("{") || bodyLine.startsWith("[") || bodyLine.indexOf('=') == -1){
|
||||
if(plainBuf[0] == '{' || plainBuf[0] == '[' || strstr(plainBuf, "=") == NULL){
|
||||
//plain post json or other data
|
||||
searchStr += "plain=";
|
||||
searchStr += bodyLine;
|
||||
searchStr += client.readString();
|
||||
searchStr += plainBuf;
|
||||
} else {
|
||||
searchStr += bodyLine;
|
||||
client.readStringUntil('\n');
|
||||
searchStr += plainBuf;
|
||||
}
|
||||
free(plainBuf);
|
||||
}
|
||||
_parseArguments(searchStr);
|
||||
if (isForm){
|
||||
|
||||
@ -702,7 +702,7 @@ bool ESP8266WiFiClass::beginWPSConfig(void) {
|
||||
|
||||
disconnect();
|
||||
|
||||
DEBUGV("wps begin: %d\n", wps_type);
|
||||
DEBUGV("wps begin\n");
|
||||
|
||||
if(!wifi_wps_disable()) {
|
||||
DEBUGV("wps disable faild\n");
|
||||
|
||||
@ -179,14 +179,13 @@ size_t WiFiClient::write(const uint8_t *buf, size_t size)
|
||||
|
||||
int WiFiClient::available()
|
||||
{
|
||||
int result = 0;
|
||||
if (!_client)
|
||||
return false;
|
||||
|
||||
if (_client) {
|
||||
result = _client->getSize();
|
||||
}
|
||||
int result = _client->getSize();
|
||||
|
||||
if (!result) {
|
||||
optimistic_yield();
|
||||
optimistic_yield(100);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
@ -99,7 +99,7 @@ WiFiClient WiFiServer::available(byte* status)
|
||||
return result;
|
||||
}
|
||||
|
||||
optimistic_yield();
|
||||
optimistic_yield(1000);
|
||||
|
||||
return WiFiClient();
|
||||
}
|
||||
@ -161,4 +161,3 @@ void WiFiServer::_s_discard(void* server, ClientContext* ctx)
|
||||
{
|
||||
reinterpret_cast<WiFiServer*>(server)->_discard(ctx);
|
||||
}
|
||||
|
||||
|
||||
@ -123,7 +123,9 @@ int WiFiUDP::available() {
|
||||
}
|
||||
|
||||
if (!result) {
|
||||
optimistic_yield();
|
||||
// yielding here will not make more data "available",
|
||||
// but it will prevent the system from going into WDT reset
|
||||
optimistic_yield(1000);
|
||||
}
|
||||
|
||||
return result;
|
||||
@ -207,8 +209,12 @@ int WiFiUDP::parsePacket()
|
||||
{
|
||||
if (!_ctx)
|
||||
return 0;
|
||||
if (!_ctx->next())
|
||||
|
||||
if (!_ctx->next()) {
|
||||
optimistic_yield(100);
|
||||
return 0;
|
||||
}
|
||||
|
||||
return _ctx->getSize();
|
||||
}
|
||||
|
||||
@ -284,4 +290,3 @@ void WiFiUDP::stopAll()
|
||||
it->stop();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -19,12 +19,12 @@ Usage
|
||||
-----
|
||||
1. Download this repository as a zip (button on the right) and follow [these instructions to install into Arduino](http://arduino.cc/en/Guide/Libraries).
|
||||
2. Include the ESP8266mDNS library in the sketch.
|
||||
3. Create an instance of the MDNSResponder class.
|
||||
4. Call the begin method in the sketch's setup and provide a domain name (without
|
||||
the '.local' suffix, i.e. just provide 'foo' to resolve 'foo.local'), and the
|
||||
IP address to advertise. Optionally provide a time to live (in seconds)
|
||||
for the DNS record--the default is 1 hour.
|
||||
5. Call the update method in each iteration of the sketch's loop function.
|
||||
3. Call MDNS.begin method in the sketch's setup and provide a domain name (without
|
||||
the '.local' suffix, i.e. just provide 'foo' to resolve 'foo.local'). Optionally provide
|
||||
the IP address to advertise and time to live (in seconds) for the DNS record -- the default is 1 hour.
|
||||
4. To advertise DNS-SD services, call MDNS.addService(service, proto, port), where service and proto
|
||||
are strings with service and protocol name (e.g. "http", "tcp"), and port is an integer port number
|
||||
for this service (e.g. 80).
|
||||
|
||||
See the included MDNS + HTTP server sketch for a full example.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
#include <ESP8266WiFi.h>
|
||||
#include <ESP8266mDNS.h>
|
||||
#include <WiFiUDP.h>
|
||||
#include <WiFiUdp.h>
|
||||
|
||||
const char* host = "esp8266-ota";
|
||||
const char* ssid = "**********";
|
||||
|
||||
@ -165,9 +165,6 @@ uint8_t Servo::attach(int pin, int minUs, int maxUs)
|
||||
{
|
||||
ServoTimerSequence timerId;
|
||||
|
||||
Serial.print("_servoIndex ");
|
||||
Serial.println(_servoIndex);
|
||||
|
||||
if (_servoIndex < MAX_SERVOS) {
|
||||
pinMode(pin, OUTPUT); // set servo pin to output
|
||||
digitalWrite(pin, LOW);
|
||||
|
||||
@ -164,7 +164,9 @@ int TwoWire::available(void){
|
||||
int result = rxBufferLength - rxBufferIndex;
|
||||
|
||||
if (!result) {
|
||||
optimistic_yield();
|
||||
// yielding here will not make more data "available",
|
||||
// but it will prevent the system from going into WDT reset
|
||||
optimistic_yield(1000);
|
||||
}
|
||||
|
||||
return result;
|
||||
@ -242,4 +244,3 @@ void TwoWire::onRequest( void (*function)(void) ){
|
||||
// Preinstantiate Objects //////////////////////////////////////////////////////
|
||||
|
||||
TwoWire Wire = TwoWire();
|
||||
|
||||
|
||||
@ -0,0 +1,33 @@
|
||||
|
||||
/*
|
||||
* NativeSdk by Simon Peter
|
||||
* Access functionality from the Espressif ESP8266 SDK
|
||||
* This example code is in the public domain
|
||||
*
|
||||
* This is for advanced users.
|
||||
* Note that this makes your code dependent on the ESP8266, which is generally
|
||||
* a bad idea. So you should try to use esp8266/Arduino functionality
|
||||
* where possible instead, in order to abstract away the hardware dependency.
|
||||
*/
|
||||
|
||||
// Expose Espressif SDK functionality - wrapped in ifdef so that it still
|
||||
// compiles on other platforms
|
||||
#ifdef ESP8266
|
||||
extern "C" {
|
||||
#include "user_interface.h"
|
||||
}
|
||||
#endif
|
||||
|
||||
void setup() {
|
||||
Serial.begin(115200);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Call Espressif SDK functionality - wrapped in ifdef so that it still
|
||||
// compiles on other platforms
|
||||
#ifdef ESP8266
|
||||
Serial.print("wifi_station_get_hostname: ");
|
||||
Serial.println(wifi_station_get_hostname());
|
||||
#endif
|
||||
delay(1000);
|
||||
}
|
||||
22
tests/common.sh
Executable file
22
tests/common.sh
Executable file
@ -0,0 +1,22 @@
|
||||
#!/bin/bash
|
||||
|
||||
function build_sketches()
|
||||
{
|
||||
local arduino=$1
|
||||
local srcpath=$2
|
||||
local sketches=$(find $srcpath -name *.ino)
|
||||
for sketch in $sketches; do
|
||||
local sketchdir=$(dirname $sketch)
|
||||
if [[ -f "$sketchdir/.test.skip" ]]; then
|
||||
echo -e "\n\n ------------ Skipping $sketch ------------ \n\n";
|
||||
continue
|
||||
fi
|
||||
echo -e "\n\n ------------ Building $sketch ------------ \n\n";
|
||||
$arduino --verify --verbose $sketch;
|
||||
local result=$?
|
||||
if [ $result -ne 0 ]; then
|
||||
echo "Build failed ($1)"
|
||||
return $result
|
||||
fi
|
||||
done
|
||||
}
|
||||
@ -65,8 +65,8 @@ inline bool ETS_INTR_WITHINISR()
|
||||
{
|
||||
uint32_t ps;
|
||||
__asm__ __volatile__("rsr %0,ps":"=a" (ps));
|
||||
// PS.EXCM and PS.UM bit checks
|
||||
return ((ps & ((1 << 4) | (1 << 5))) > 0);
|
||||
// PS.EXCM bit check
|
||||
return ((ps & (1 << 4)) != 0);
|
||||
}
|
||||
|
||||
inline uint32_t ETS_INTR_ENABLED(void)
|
||||
|
||||
70
variants/thing/pins_arduino.h
Normal file
70
variants/thing/pins_arduino.h
Normal file
@ -0,0 +1,70 @@
|
||||
/*
|
||||
pins_arduino.h - Pin definition functions for Arduino
|
||||
Part of Arduino - http://www.arduino.cc/
|
||||
|
||||
Copyright (c) 2007 David A. Mellis
|
||||
Modified for ESP8266 platform by Ivan Grokhotkov, 2014-2015.
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General
|
||||
Public License along with this library; if not, write to the
|
||||
Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
||||
Boston, MA 02111-1307 USA
|
||||
|
||||
$Id: wiring.h 249 2007-02-03 16:52:51Z mellis $
|
||||
*/
|
||||
|
||||
#ifndef Pins_Arduino_h
|
||||
#define Pins_Arduino_h
|
||||
|
||||
#define EXTERNAL_NUM_INTERRUPTS 16
|
||||
#define NUM_DIGITAL_PINS 17
|
||||
#define NUM_ANALOG_INPUTS 1
|
||||
|
||||
#define analogInputToDigitalPin(p) ((p > 0)?NOT_A_PIN:0)
|
||||
#define digitalPinToInterrupt(p) (((p) < EXTERNAL_NUM_INTERRUPTS)?p:NOT_A_PIN)
|
||||
#define digitalPinHasPWM(p) (((p) < NUM_DIGITAL_PINS)?p:NOT_A_PIN)
|
||||
|
||||
static const uint8_t SDA = 2;
|
||||
static const uint8_t SCL = 14;
|
||||
|
||||
static const uint8_t SS = 15;
|
||||
static const uint8_t MOSI = 13;
|
||||
static const uint8_t MISO = 12;
|
||||
static const uint8_t SCK = 14;
|
||||
|
||||
static const uint8_t BUILTIN_LED = 5;
|
||||
|
||||
static const uint8_t A0 = 17;
|
||||
|
||||
|
||||
// These serial port names are intended to allow libraries and architecture-neutral
|
||||
// sketches to automatically default to the correct port name for a particular type
|
||||
// of use. For example, a GPS module would normally connect to SERIAL_PORT_HARDWARE_OPEN,
|
||||
// the first hardware serial port whose RX/TX pins are not dedicated to another use.
|
||||
//
|
||||
// SERIAL_PORT_MONITOR Port which normally prints to the Arduino Serial Monitor
|
||||
//
|
||||
// SERIAL_PORT_USBVIRTUAL Port which is USB virtual serial
|
||||
//
|
||||
// SERIAL_PORT_LINUXBRIDGE Port which connects to a Linux system via Bridge library
|
||||
//
|
||||
// SERIAL_PORT_HARDWARE Hardware serial port, physical RX & TX pins.
|
||||
//
|
||||
// SERIAL_PORT_HARDWARE_OPEN Hardware serial ports which are open for use. Their RX & TX
|
||||
// pins are NOT connected to anything by default.
|
||||
#define SERIAL_PORT_MONITOR Serial
|
||||
#define SERIAL_PORT_USBVIRTUAL Serial
|
||||
#define SERIAL_PORT_HARDWARE Serial
|
||||
#define SERIAL_PORT_HARDWARE_OPEN Serial
|
||||
|
||||
#endif /* Pins_Arduino_h */
|
||||
Loading…
x
Reference in New Issue
Block a user