Lacking basic examples & documentation

Elijahg
Posts: 11
Joined: Sat Dec 08, 2018 3:30 am

Lacking basic examples & documentation

Postby Elijahg » Sat Dec 08, 2018 3:39 am

Hi guys,
I come from an Arduino background (don't we all?) and the ESP SDKs are quite a step up on those. I would really like to use the ESP-MDF for my smart-home project, but I'm really struggling with the lack of documentation.

I've examined the mwifi example/function demo, but even that is quite complex; being full of custom Espressif functions such as MDF_ERROR_CONTINUE and MDF_LOGD. There are a lot of functions present with no documentation, for example both MDF_ERROR_CONTINUE and MDF_LOGD have no documentation at all on the SDK's API listing. Surely logging is one of the most basic functions that should be well documented! I realise the SDK is in active development, but even so it's pretty useless to give complex examples with the absolute minimum of documentation.

Would anyone be able to point me to some documentation for the most basic of mesh networks with the MDF SDK?
Many thanks :)

ESP_LBB
Posts: 101
Joined: Fri May 18, 2018 3:41 am

Re: Lacking basic examples & documentation

Postby ESP_LBB » Mon Dec 10, 2018 10:06 am

Hello Elijahg,

you may have the docs via this link, https://docs.espressif.com/projects/esp ... dge=latest.
This is marked on the readme "doc|passing" under the title, though it's not very obvious (even to me for the first time).

Hope this topic will help others who are also seeking for docs ;)
Please let us know if there is any other doc you will need, thanks.

Mahdibr
Posts: 4
Joined: Wed May 08, 2019 1:59 pm

Re: Lacking basic examples & documentation

Postby Mahdibr » Wed May 08, 2019 2:38 pm

hi thank you for document

i try to read but still confusing
i read API guide and also API reference but still a lot of your codes not define
like mdf_common.h
you use a lot of things in example but just a few was explained in the API reference
and there is no explanation for macro

and also still your example and code are very advance for me
do you have any suggestion to better understand your code and algorithms and patterns
like book or website or something ...

it_zzc
Posts: 45
Joined: Mon Apr 15, 2019 1:37 pm

Re: Lacking basic examples & documentation

Postby it_zzc » Thu May 09, 2019 8:26 am

The improvement of our current documentation is still in progress.
If you have any questions, feel free to ask (https://github.com/espressif/esp-mdf/issues) and we will get back to you as soon as possible.
 
About `mcommon.h` is mainly a package for log management and data storage in esp-idf:
1. Log printing, error checking: This is the encapsulation of esp_log in esp-idf, you can refer to: https://docs.espressif.com/projects/esp ... system/log .html?highlight=esp_log
2. Data Storage: See: https://docs.espressif.com/projects/esp ... hlight=nvs

socaltek
Posts: 1
Joined: Thu May 23, 2019 3:18 pm

Re: Lacking basic examples & documentation

Postby socaltek » Thu May 23, 2019 3:23 pm

it_zzc wrote: The improvement of our current documentation is still in progress.
If you have any questions, feel free to ask (https://github.com/espressif/esp-mdf/issues) and we will get back to you as soon as possible.
Thank you, that helps a lot!

Who is online

Users browsing this forum: No registered users and 0 guests