Where should I post documentation suggestions?
I spent quite a bit of time figuring out the TCP streaming API and couldn't get a subscription working until I appended \r\n to the subscription message, which is not obvious. I'd like to save other people some time on this issue and others.
thanks, Tom
6 Replies
As issues or PRs at https://github.com/SignalK/signalk-server or https://github.com/signalk/specification
GitHub
GitHub - SignalK/signalk-server: An implementation of a Signal K ce...
An implementation of a Signal K central server for boats. - SignalK/signalk-server
GitHub
GitHub - SignalK/specification: Signal K is a JSON-based format for...
Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc) - SignalK/specification
Yes I read it thoroughly. The docs are minimal in some areas - nowhere does it mention a newline is required - I'm just trying to help out and save other people some work.
it literally says
\r\n is required.....
i am very open to improving documentation, but while this particular segment is minimal it spells out that requirement pretty explicitly
Thanks for pointing that out...I missed it!