simba icon indicating copy to clipboard operation
simba copied to clipboard

Missing serial port configuration parameters for shell example

Open alberand opened this issue 7 years ago • 2 comments

Hi, First of all, very cool project

The shell example documentation miss any information about serial port configuration. The shell library has link to the system configuration file description, but it also don't provide any information about the default settings. The parameters (e.g. baudrate) can be found in the default config.h

Therefore, to find this information is quite a challenging process. The shell example contains the config.h file but anyway you need to find out which constants need to be defined. I think there is need to add description of the default serial port configuration to the shell example.

alberand avatar Jun 22 '18 12:06 alberand

Hello,

glad you like the project!

Maybe add a Serial Port subsection in the User Guide section in the documentation, as the serial port is not only used in the shell example, but in almost all examples and user applications. Then we could add links from the examples to that page.

eerimoq avatar Jun 22 '18 21:06 eerimoq

Yeah, I think the User Guide -> Configuration is the right place for that (at the bottom of the page). I will make a draft and then PL it.

alberand avatar Jun 24 '18 18:06 alberand