Skip to content

Commit d06ec22

Browse files
committed
Update readme
[ci skip]
1 parent 7e8cd1e commit d06ec22

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

README.md

+33-13
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,15 @@ $ cd Arduino/build
1919
$ ant dist
2020
```
2121

22+
### Supported boards ###
23+
- [Wifio](http://wifio.cc)
24+
- Generic esp8266 modules (without auto-reset support)
25+
2226
### Things that work ###
2327

24-
#### pinMode, digitalRead, digitalWrite, analogRead ####
28+
#### Basic Wiring functions ####
29+
30+
```pinMode```, ```digitalRead```, ```digitalWrite``` work as usual.
2531

2632
Pin numbers correspond directly to the esp8266 GPIO pin numbers. To read GPIO2,
2733
call ```digitalRead(2);```
@@ -31,14 +37,15 @@ GPIO16 can be ```INPUT``` or ```OUTPUT```.
3137

3238
```analogRead(0)``` reads the value of the ADC channel connected to the TOUT pin.
3339

34-
#### Pin interrupts (attachInterrupt, detachInterrupt) ####
35-
40+
Pin interrupts are supported through ```attachInterrupt```, ```detachInterrupt``` functions.
3641
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
3742
types are supported: ```CHANGE```, ```RISING```, ```FALLING```.
3843

39-
#### shiftIn, shiftOut ####
40-
#### millis, micros ####
41-
#### delay, delayMicroseconds, yield ###
44+
#### Timing and delays ####
45+
```millis``` and ```micros``` return the number of milliseconds and microseconds elapsed after reset, respectively.
46+
47+
```delay``` pauses the sketch for a given number of milliseconds and allows WiFi and TCP/IP tasks to run.
48+
```delayMicroseconds``` pauses for a given number of microseconds.
4249

4350
Remember that there is a lot of code that needs to run on the chip besides the sketch
4451
when WiFi is connected. WiFi and TCP/IP libraries get a chance to handle any pending
@@ -53,9 +60,11 @@ more than 20 milliseconds is not recommended.
5360

5461
#### Serial ####
5562

56-
Only 8n1 is supported right now. By default the diagnostic output from WiFi
57-
libraries is disabled when you call ```Serial.begin```. To enable debug output again,
58-
call ```Serial.setDebugOutput(true);```
63+
```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.
64+
65+
Only 8n1 mode is supported right now.
66+
67+
By default the diagnostic output from WiFi libraries is disabled when you call ```Serial.begin```. To enable debug output again, call ```Serial.setDebugOutput(true);```
5968

6069
#### WiFi(ESP8266WiFi library) ####
6170

@@ -81,6 +90,7 @@ Library for calling functions repeatedly with a certain period. Two examples inc
8190
This is a bit different from standard EEPROM class. You need to call ```EEPROM.begin(size)```
8291
before you start reading or writing, size being the number of bytes you want to use.
8392
Size can be anywhere between 4 and 4096 bytes.
93+
8494
```EEPROM.write``` does not write to flash immediately, instead you must call ```EEPROM.commit()```
8595
whenever you wish to save changes to flash. ```EEPROM.end()``` will also commit, and will
8696
release the RAM copy of EEPROM contents.
@@ -89,8 +99,8 @@ Three examples included.
8999

90100
#### I2C (Wire library) ####
91101

92-
Only master mode works, and I haven't tested if Wire.setClock gives correct frequency.
93-
Before using I2C, you need to set pins you will use for SDA and SCL by calling
102+
Only master mode works, and ```Wire.setClock``` has not been verified to give exactly correct frequency.
103+
Before using I2C, pins for SDA and SCL need to be set by calling
94104
```Wire.pins(int sda, int scl)```, i.e. ```Wire.pins(0, 2);``` on ESP-01.
95105

96106
#### OneWire (from https://www.pjrc.com/teensy/td_libs_OneWire.html) ####
@@ -104,9 +114,14 @@ instead of the one that comes with the Arduino IDE (this one).
104114
Allows the sketch to respond to multicast DNS queries for domain names like "foo.local".
105115
See attached example and library README file for details.
106116

107-
#### Other libraries that don't rely on low-level access to AVR registers.
117+
#### Other libraries
118+
119+
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:
120+
121+
- [PubSubClient](https://github.com/knolleary/pubsubclient) MQTT library - [sample](https://gist.github.com/igrr/7f7e7973366fc01d6393)
122+
- [DHT11](https://github.com/adafruit/DHT-sensor-library) - initialize DHT as follows: ```DHT dht(DHTPIN, DHTTYPE, 15);```
123+
- [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library.git)
108124

109-
- [PubSubClient](https://github.com/knolleary/pubsubclient) - [sample](https://gist.github.com/igrr/7f7e7973366fc01d6393)
110125

111126
#### Upload via serial port ####
112127
Select "esptool" as a programmer, and pick the correct serial port.
@@ -125,6 +140,11 @@ toggle power).
125140
- Upload sketches via WiFi. Conceptually and technically simple, but need to figure out how to provide the best UX for this feature.
126141
- Samples for all the libraries
127142

143+
### Issues and support ###
144+
145+
Forum: http://www.esp8266.com/arduino
146+
147+
Submit issues on Github: https://github.com/esp8266/Arduino/issues
128148

129149
### License and credits ###
130150

0 commit comments

Comments
 (0)