Document Requests

ESP_Lvxinyue
Posts: 7
Joined: Fri Dec 25, 2015 6:13 am

Document Requests

Postby ESP_Lvxinyue » Mon Jan 09, 2017 4:36 am

If you have any other requests on ESP32-related documents apart from those on our website (http://www.espressif.com/en/support/download/documents?keys=&field_type_tid%5B%5D=13), please specify them here.

User avatar
kolban
Posts: 953
Joined: Mon Nov 16, 2015 4:43 pm
Location: Texas, USA

Re: Document Requests

Postby kolban » Mon Jan 09, 2017 3:52 pm

Howdy,
I'm really keen on technical documentation and have been producing a book of notes ... see ...

viewtopic.php?f=2&t=390

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

setAccelerator()
setBrake()
steerLeft()
steerRight()
initializeEngine()
stopEngine()
getSpeed()


... 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.
Free book on ESP32 available here: https://leanpub.com/kolban-ESP32

WiFive
Posts: 1013
Joined: Tue Dec 01, 2015 7:35 am

Re: Document Requests

Postby WiFive » Fri Jan 13, 2017 1:52 pm

Requesting documents on:
    WiFi low rate
    Tx power settings for wifi/BT
    Comprehensive power consumption study

WiFive
Posts: 1013
Joined: Tue Dec 01, 2015 7:35 am

Re: Document Requests

Postby WiFive » Thu Jan 19, 2017 2:35 am

Request:
Schematics of lyra audio board

User avatar
rudi ;-)
Posts: 1082
Joined: Fri Nov 13, 2015 3:25 pm
Contact:

Re: Document Requests

Postby rudi ;-) » Thu Jan 19, 2017 11:41 pm

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.


Features:

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


SRC INFO

:mrgreen:

best wishes
rudi ;-)
Last edited by rudi ;-) on Fri Jan 20, 2017 4:07 am, edited 1 time in total.
-------------------------------------
love it, change it or leave it.
-------------------------------------
問候飛出去的朋友遍全球魯迪

Lucas.Hutchinson
Posts: 38
Joined: Tue Apr 26, 2016 5:10 am

Re: Document Requests

Postby Lucas.Hutchinson » Fri Jan 20, 2017 4:04 am

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

Franco
Posts: 9
Joined: Thu Dec 10, 2015 1:11 pm

Re: Document Requests

Postby Franco » Mon Jan 23, 2017 10:51 am

An application note about the capacitive touch interface

User avatar
rudi ;-)
Posts: 1082
Joined: Fri Nov 13, 2015 3:25 pm
Contact:

Re: Document Requests

Postby rudi ;-) » Thu Jan 26, 2017 3:02 pm

WiFive wrote:Request:
Schematics of lyra audio board


not sure is this lyra audio board in final,
in first moment it looks like there are two different ones.

best wishes
rudi ;-)

( Because of flu - a few days out of action )
Attachments
esp32-psram-audio.png
esp32-psram-audio.png (271.81 KiB) Viewed 2965 times
-------------------------------------
love it, change it or leave it.
-------------------------------------
問候飛出去的朋友遍全球魯迪

User avatar
rudi ;-)
Posts: 1082
Joined: Fri Nov 13, 2015 3:25 pm
Contact:

Re: Document Requests

Postby rudi ;-) » Sun Feb 12, 2017 1:58 pm

hehe ;-)
btw:
spotted in the wild last weeks

ESP32-Lyra.png
ESP32-Lyra.png (418.56 KiB) Viewed 2639 times


best wishes
rudi ;-)
-------------------------------------
love it, change it or leave it.
-------------------------------------
問候飛出去的朋友遍全球魯迪

User avatar
rudi ;-)
Posts: 1082
Joined: Fri Nov 13, 2015 3:25 pm
Contact:

Re: Document Requests

Postby rudi ;-) » Wed Feb 15, 2017 1:43 pm

;-)
more and more infos about spotted: ESP32-Lyra32-T

V2

ESP32 PSRAM Modul

hope we get Documents about it?


best wishes
rudi ;-)
Attachments
LuyraT_s.jpg
LuyraT_s.jpg (309.3 KiB) Viewed 2537 times
-------------------------------------
love it, change it or leave it.
-------------------------------------
問候飛出去的朋友遍全球魯迪

Who is online

Users browsing this forum: No registered users and 1 guest