Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for ESP8266WiFi library #2298

Closed
igrr opened this issue Jul 19, 2016 · 2 comments
Closed

Add documentation for ESP8266WiFi library #2298

igrr opened this issue Jul 19, 2016 · 2 comments

Comments

@igrr
Copy link
Member

igrr commented Jul 19, 2016

Provide methods documentation, driven by examples. I.e. not formal "doxygen" style, but rather through short code snippets which illustrate usage of different methods.

In addition to methods documentation, describe typical flows for the following actions:

  • initiating connection to STA and checking result (blocking way and asynchronous way)
  • setting up an AP (and getting callbacks when clients connect)
  • scanning networks (blocking and asynchronous ways)
    (these items may be among snippets mentioned above)

Mention persistent/non-persistent settings (i.e. "why does my Blink sketch set up an AP?").
Mention that ESP will automatically reconnect by default (there is no need to call WiFi.begin(stuff) each time connection drops).

Other classes to be documented include WiFiClient, WiFiServer, WiFiUDP, WiFiClientSecure.
We can probably refer users to Arduino documentation, because unlike WiFi class, our changes to these are relatively minor. Just document additional APIs (multicast UDP, setNoDelay for TCP). For WiFiClientSecure, need to describe: a) way to verify remote server identity, and b) how to load client certificates from C arrays and file system. Also mention current limitations of WiFiClientSecure (needs lots of RAM, no TLS 1.2 support, etc).


$300 bounty on BountySource

@Potato-Matic
Copy link

Potato-Matic commented Jul 21, 2016

So I suppose this would take the form of various code examples demonstrating the use of the different classes in all the various different ways? I've actually compiled a couple of examples that I'm planning to upload to github that might be of use.

@Potato-Matic
Copy link

@igrr I've started putting up a few examples here, which might provide a useful starting point:
https://github.com/Matthew-Bradley/ESP8266Examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants