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

Improve Docs / Error Msg for Protocol Param Syntax #265

Open
MikeHart85 opened this issue Oct 25, 2017 · 0 comments
Open

Improve Docs / Error Msg for Protocol Param Syntax #265

MikeHart85 opened this issue Oct 25, 2017 · 0 comments

Comments

@MikeHart85
Copy link
Contributor

Due to being YAML, the protocol parameters are very sensitive to whitespace (or lack thereof) and other quirks of the standard.

If the entered syntax does not parse correctly, the resulting error message isn't very useful:

$ lewis -p "stream:{bind_address:localhost,port:57677}" linkam_t95
2017-10-24 15:55:41,503 INFO lewis.DeviceBase: Creating device, setting up state machine
An error occurred:
'stream:{bind_address:localhost,port:57677}' is not a valid protocol for device 'linkam_t95', select one via the -p option.
Available protocols are:
    stream

The message should at least suggest that syntax might be the issue.

Also, documentation should do a better job of drawing attention to the fact that this is YAML and whitespace is significant.

@MikeHart85 MikeHart85 added this to the Release 1.3 milestone Oct 25, 2017
@mattclarke mattclarke removed this from the Release 1.3 milestone Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants