Page 1 of 1

Document Requests

Posted: Mon Jan 09, 2017 4:36 am
by ESP_Lvxinyue
If you have any other requests on ESP32-related documents apart from those on our website (, please specify them here.

Re: Document Requests

Posted: Mon Jan 09, 2017 3:52 pm
by kolban
I'm really keen on technical documentation and have been producing a book of notes ... see ...


In my opinion, the most important documentation areas that need to be covered are "architectural". While the ESP-IDF is a vitally important component in the development of ESP32 solutions, the documentation covering the growing array of rich APIs isn't currently easily consumed. An API description is not the same as an architectural or programmers guide.

For example:

Code: Select all


... may be necessary APIs for controlling a car but they aren't sufficient in order to learn to drive. For example, these APIs don't describe that one shouldn't setBrake() and setAccelerator() at the same time not should one stopEngine() while the return from getSpeed() > 0.

I fancy myself as a programmer and when I am in the midst of writing APIs for others to use, the last thing on my mind is documentation. By the time I have finished writing my APIs, I am usually so "buried" in how they work that I fail to consider how they will appear to others who try and use them. This is a shame as the purpose of me writing APIs in the first place was never to "get them working" but was to allow "others to use them".

What I would suggest, if I may be so bold, is to get folks from the community who are technically skilled but at a variety of different levels (novice, practitioner, expert) and for each area of ESP32 function ... give them your first pass at the docs to read and then have them collaborate to write up their experiences on comprehending the material AND attempting to build something from it.

Do this on-line (public or private or semi private). Make sure each of the functional areas is not too big ... i.e. not THE WHOLE OF ESP-IDF ... but for example "I2C" or "SPI" or "RMT" or "BT GATT" or "BT GAP" etc etc.

As the comments come in ... do NOT be tempted to respond to them in the electronic media ... this exercise is not a forum alternative. Instead, update the docs with the responses to the comments and cycle around again. It is vital that the documentation become the source of knowledge and not the documentation + forums.

In summary ... I think we don't need more new types of documents ... we need to consider content in the existing documents and make it focused on consumability ... and make it consumer driven.

Re: Document Requests

Posted: Fri Jan 13, 2017 1:52 pm
by WiFive
Requesting documents on:
    WiFi low rate
    Tx power settings for wifi/BT
    Comprehensive power consumption study

Re: Document Requests

Posted: Thu Jan 19, 2017 2:35 am
by WiFive
Schematics of lyra audio board

Re: Document Requests

Posted: Thu Jan 19, 2017 11:41 pm
by rudi ;-)
WiFive wrote:Request:
Schematics of lyra audio board

[no hurry]
yeap 1+

At the press conference, Espressif Systems showcased the ESP32-Lyra series of audio solution. ESP32-Lyra is a smart audio platform with top value for money, which is specifically designed for IoT application. With its ESP32 dual-core processor and Wi-Fi + BT capability, ESP32-Lyra possesses the functions of voice recognition, audio playing, and cloud service. With its superior computing power, the ESP32-Lyra platform can support systems of artificial intelligence, voice and image recognition, wireless audio systems, as well as smart home networks.

This latest solution can cut 50% off the cost of Wi-Fi stereo’s electronic module, thus greatly lowering the cost of Wi-Fi audio solutions. It is expected that Wi-Fi will become the most popular mainstream audio configuration, compared to Bluetooth.


Multiple audio interfaces with high extensibility
Touch button support
Multiple audio formats support: WMA, ALAC, AAC, FLAC, OPUS, MP3, WAV, and OGG
Multiple wireless audio standards support: DLNA, AirPlay, and QPlay
Multiple cloud platforms support: Ximalaya FM, Alibaba YunOS, and Amazon
Multiple distribution network protocols support: ESP-Touch, Alink, Joylink3.0, and AirKiss



best wishes
rudi ;-)

Re: Document Requests

Posted: Fri Jan 20, 2017 4:04 am
by Lucas.Hutchinson
WiFive wrote:Requesting documents on:
    WiFi low rate
    Tx power settings for wifi/BT
    Comprehensive power consumption study

+1 for Tx power settings for wifi/BT and Comprehensive power consumption study