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

Missing serial port configuration parameters for shell example #188

Open
alberand opened this issue Jun 22, 2018 · 2 comments
Open

Missing serial port configuration parameters for shell example #188

alberand opened this issue Jun 22, 2018 · 2 comments

Comments

@alberand
Copy link
Contributor

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.

@eerimoq
Copy link
Owner

eerimoq commented Jun 22, 2018

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.

@alberand
Copy link
Contributor Author

alberand commented Jun 24, 2018

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.

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

No branches or pull requests

2 participants