Skip to content

Commit 90fb9ce

Browse files
noahwilliamssonigrr
authored andcommitted
README.md: Remove semicolons from inline function call examples
Conflicts: README.md
1 parent c774466 commit 90fb9ce

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ ant dist
3636
```pinMode```, ```digitalRead```, ```digitalWrite```, ```analogWrite``` work as usual.
3737

3838
Pin numbers correspond directly to the esp8266 GPIO pin numbers. To read GPIO2,
39-
call ```digitalRead(2);```
39+
call ```digitalRead(2)```
4040

4141
GPIO0-GPIO15 can be ```INPUT```, ```OUTPUT```, ```INPUT_PULLUP```, and ```INPUT_PULLDOWN```.
4242
GPIO16 can be ```INPUT```, ```OUTPUT``` or ```INPUT_PULLDOWN```.
@@ -77,15 +77,15 @@ more than 20 milliseconds is not recommended.
7777

7878
```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.
7979

80-
```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.
80+
```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.
8181

8282
```Serial1``` uses UART1 which is a transmit-only UART. UART1 TX pin is GPIO2. To use ```Serial1```, call ```Serial1.begin```.
8383

84-
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);```.
84+
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)```.
8585

8686
You also need to use ```Serial.setDebugOutput(true)``` to enable output from the Arduino ```printf()``` function.
8787

88-
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.
88+
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.
8989

9090
#### Progmem ####
9191

@@ -102,7 +102,7 @@ This is mostly similar to WiFi shield library. Differences include:
102102
- ```WiFi.macAddress(mac)``` is for STA, ```WiFi.softAPmacAddress(mac)``` is for AP.
103103
- ```WiFi.localIP()``` is for STA, ```WiFi.softAPIP()``` is for AP.
104104
- ```WiFi.RSSI()``` doesn't work
105-
- ```WiFi.printDiag(Serial);``` will print out some diagnostic info
105+
- ```WiFi.printDiag(Serial)``` will print out some diagnostic info
106106
- ```WiFiUDP``` class supports sending and receiving multicast packets on STA interface.
107107
When sending a multicast packet, replace ```udp.beginPacket(addr, port)``` with
108108
```udp.beginPacketMulticast(addr, port, WiFi.localIP())```.
@@ -141,7 +141,7 @@ Three examples included.
141141

142142
Wire library currently supports master mode up to approximately 450KHz.
143143
Before using I2C, pins for SDA and SCL need to be set by calling
144-
```Wire.begin(int sda, int scl)```, i.e. ```Wire.begin(0, 2);``` on ESP-01,
144+
```Wire.begin(int sda, int scl)```, i.e. ```Wire.begin(0, 2)``` on ESP-01,
145145
else they default to pins 4(SDA) and 5(SCL).
146146

147147
#### SPI ####
@@ -212,7 +212,7 @@ Libraries that don't rely on low-level access to AVR registers should work well.
212212
- [aREST](https://github.com/marcoschwartz/aREST) REST API handler library.
213213
- [Blynk](https://github.com/blynkkk/blynk-library) - easy IoT framework for Makers (check out the [Kickstarter page](http://tiny.cc/blynk-kick)).
214214
- [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library.git)
215-
- [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);```
215+
- [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)```
216216
- [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).
217217
- [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.
218218
- [PubSubClient](https://github.com/Imroy/pubsubclient) MQTT library by @Imroy.

0 commit comments

Comments
 (0)