Skip to content

Commit 9b3ccfe

Browse files
committed
Update on the WiFi lib docs
1 parent 27bd619 commit 9b3ccfe

File tree

1 file changed

+50
-13
lines changed

1 file changed

+50
-13
lines changed

docs/source/api/wifi.rst

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ The ``WiFiAP`` is used to configure and manage the Wi-Fi as Access Point. Here a
5757
Basic Usage
5858
***********
5959

60-
6160
To start the Wi-Fi as AP
6261

6362
.. code-block:: arduino
@@ -75,26 +74,28 @@ begin
7574
7675
Where:
7776

78-
* ``const char* ssid``
79-
* ``const char *passphrase``
80-
* ``int32_t channel``
81-
* ``const uint8_t* bssid``
82-
* ``bool connect``
77+
* ``const char* ssid`` set the AP SSID.
78+
* ``const char *passphrase`` set the AP password. Set as ``NULL`` for open networks.
79+
* ``int32_t channel`` set the Wi-Fi channel.
80+
* ``const uint8_t* bssid`` set the AP BSSID.
81+
* ``bool connect`` set ``true`` to connect to the configured network automatically.
8382

8483
.. code-block:: arduino
8584
8685
wl_status_t begin(char* ssid, char *passphrase = NULL, int32_t channel = 0, const uint8_t* bssid = NULL, bool connect = true);
8786
8887
Where:
8988

90-
* ``char* ssid``
91-
* ``char *passphrase``
92-
* ``int32_t channel``
93-
* ``const uint8_t* bssid``
94-
* ``bool connect``
89+
* ``char* ssid`` set the AP SSID.
90+
* ``char *passphrase`` set the AP password. Set as ``NULL`` for open networks.
91+
* ``int32_t channel`` set the Wi-Fi channel.
92+
* ``const uint8_t* bssid`` set the AP BSSID.
93+
* ``bool connect`` set ``true`` to connect to the configured network automatically.
9594

9695
.. code-block:: arduino
9796
97+
Function to start the connection after being configured.
98+
9899
wl_status_t begin();
99100

100101
config
@@ -144,46 +145,62 @@ Return ``true`` if the configuration was successful.
144145
isConnected
145146
***********
146147

148+
Function used to get the connection state.
149+
147150
.. code-block:: arduino
148151
149152
bool isConnected();
150153
154+
Return the connection state.
155+
151156
setAutoConnect
152157
**************
153158

159+
Function used to set the automatic connection.
160+
154161
.. code-block:: arduino
155162
156163
bool setAutoConnect(bool autoConnect);
157164
158165
Where:
159166

160-
* ``bool autoConnect``
167+
* ``bool autoConnect`` is set to ``true`` to enable this option.
161168

162169
getAutoConnect
163170
**************
164171

172+
Function used to get the automatic connection setting value.
173+
165174
.. code-block:: arduino
166175
167176
bool getAutoConnect();
168177
178+
Return ``true`` is this setting is enabled.
179+
169180
setAutoReconnect
170181
****************
171182

183+
Function used to set the automatic reconnection if the connection is lost.
184+
172185
.. code-block:: arduino
173186
174187
bool setAutoReconnect(bool autoReconnect);
175188
176189
Where:
177190

178-
* ``bool autoConnect``
191+
* ``bool autoConnect`` is set to ``true`` to enable this option.
179192

180193
getAutoReconnect
181194
****************
182195

196+
Function used to get the automatic reconnection if the connection is lost state.
197+
183198
.. code-block:: arduino
184199
185200
bool getAutoReconnect();
186201
202+
Return ``true`` is this setting is enabled.
203+
187204
WiFiSTA
188205
-------
189206

@@ -274,13 +291,17 @@ softAPgetStationNum
274291
softAPIP
275292
********
276293

294+
Function to get the AP IPv4 address.
295+
277296
.. code-block:: arduino
278297
279298
IPAddress softAPIP();
280299
281300
softAPBroadcastIP
282301
*****************
283302

303+
Function to get the AP IPv4 broadcast address.
304+
284305
.. code-block:: arduino
285306
286307
IPAddress softAPBroadcastIP();
@@ -302,6 +323,8 @@ softAPSubnetCIDR
302323
softAPenableIpV6
303324
****************
304325

326+
Function used to enable the IPv6 support.
327+
305328
.. code-block:: arduino
306329
307330
bool softAPenableIpV6();
@@ -311,20 +334,26 @@ Return ``true`` if the configuration was successful.
311334
softAPIPv6
312335
**********
313336

337+
Function to get the IPv6 address.
338+
314339
.. code-block:: arduino
315340
316341
IPv6Address softAPIPv6();
317342
318343
softAPgetHostname
319344
*****************
320345

346+
Function to get the AP hostname.
347+
321348
.. code-block:: arduino
322349
323350
const char * softAPgetHostname();
324351
325352
softAPsetHostname
326353
*****************
327354

355+
Function to set the AP hostname.
356+
328357
.. code-block:: arduino
329358
330359
bool softAPsetHostname(const char * hostname);
@@ -338,6 +367,8 @@ Return ``true`` if the configuration was successful.
338367
softAPmacAddress
339368
****************
340369

370+
Function to define the AP MAC address.
371+
341372
.. code-block:: arduino
342373
343374
uint8_t* softAPmacAddress(uint8_t* mac);
@@ -346,17 +377,23 @@ Where:
346377

347378
* ``uint8_t* mac``
348379

380+
Function to get the AP MAC address.
381+
349382
.. code-block:: arduino
350383
351384
String softAPmacAddress(void);
352385
353386
softAPSSID
354387
**********
355388

389+
Function to get the AP SSID.
390+
356391
.. code-block:: arduino
357392
358393
String softAPSSID(void) const;
359394
395+
Returns the AP SSID.
396+
360397
WiFiClient
361398
----------
362399

0 commit comments

Comments
 (0)