Skip to content

Commit 858311e

Browse files
committed
New section with ESP8266WiFi library documentation
1 parent 8cd331a commit 858311e

File tree

1 file changed

+3
-19
lines changed

1 file changed

+3
-19
lines changed

doc/libraries.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,9 @@ title: Libraries
1818

1919
## WiFi(ESP8266WiFi library)
2020

21-
This is mostly similar to WiFi shield library. Differences include:
22-
23-
- `WiFi.mode(m)`: set mode to `WIFI_AP`, `WIFI_STA`, `WIFI_AP_STA` or `WIFI_OFF`.
24-
- call `WiFi.softAP(ssid)` to set up an open network
25-
- call `WiFi.softAP(ssid, password)` to set up a WPA2-PSK network (password should be at least 8 characters)
26-
- `WiFi.macAddress(mac)` is for STA, `WiFi.softAPmacAddress(mac)` is for AP.
27-
- `WiFi.localIP()` is for STA, `WiFi.softAPIP()` is for AP.
28-
- `WiFi.printDiag(Serial)` will print out some diagnostic info
29-
- `WiFiUDP` class supports sending and receiving multicast packets on STA interface.
30-
When sending a multicast packet, replace `udp.beginPacket(addr, port)` with
31-
`udp.beginPacketMulticast(addr, port, WiFi.localIP())`.
32-
When listening to multicast packets, replace `udp.begin(port)` with
33-
`udp.beginMulticast(WiFi.localIP(), multicast_ip_addr, port)`.
34-
You can use `udp.destinationIP()` to tell whether the packet received was
35-
sent to the multicast or unicast address.
36-
37-
`WiFiServer`, `WiFiClient`, and `WiFiUDP` behave mostly the same way as with WiFi shield library.
38-
Four samples are provided for this library.
39-
You can see more commands here: [http://www.arduino.cc/en/Reference/WiFi](http://www.arduino.cc/en/Reference/WiFi)
21+
The [Wi-Fi library for ESP8266](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi) has been developed basing on [ESP8266 SDK](http://bbs.espressif.com/viewtopic.php?f=51&t=1023), using naming convention and overall functionality philosophy of [Arduino WiFi library](https://www.arduino.cc/en/Reference/WiFi). Over time the wealth Wi-Fi features ported from ESP9266 SDK to [esp8266 / Adruino](https://github.com/esp8266/Arduino) outgrow [Arduino WiFi library](https://www.arduino.cc/en/Reference/WiFi) and it became apparent that we need to provide separate documentation on what is new and extra.
22+
23+
[ESP8266WiFi library documentation](esp8266wifi/readme.md) : [Quick Start](esp8266wifi/readme.md#quick-start) | [Who is Who](esp8266wifi/readme.md#who-is-who) | [Station](esp8266wifi/readme.md#station) | [Soft Access Point](esp8266wifi/readme.md#soft-access-point) | [Scan](esp8266wifi/readme.md#scan) | [Client](esp8266wifi/readme.md#client) | [Client Secure](esp8266wifi/readme.md#client-secure) | [Server](esp8266wifi/readme.md#server) | [UDP](esp8266wifi/readme.md#udp) | [Generic](esp8266wifi/readme.md#generic) | [Diagnostics](esp8266wifi/readme.md#diagnostics)
4024

4125
## Ticker
4226

0 commit comments

Comments
 (0)