+- OpenMarine (https://forum.openmarine.net)
+-- Forum: OpenPlotter (https://forum.openmarine.net/forumdisplay.php?fid=1)
+--- Forum: Documentation (https://forum.openmarine.net/forumdisplay.php?fid=16)
+--- Thread: Signal K Server FAQ (/showthread.php?tid=2782)
Signal K Server FAQ - tkurki - 2020-07-24
We recently created an FAQ page for Signal K server at https://github.com/SignalK/signalk-server-node/wiki/FAQ:-Frequently-Asked-Questions
What do you think should be there? Now the entries are what we've bumped against in Signal K Slack.
Naturally there is going to be an area of overlap between OpenPlotter documentation and this page, stuff that could be in both places, but I am not overly worried about that at present.
RE: Signal K Server FAQ - olewsaa - 2020-12-25
(2020-07-24, 05:31 PM)tkurki Wrote: We recently created an FAQ page for Signal K server at https://github.com/SignalK/signalk-server-node/wiki/FAQ:-Frequently-Asked-Questions
What do you think should be there? Now the entries are what we've bumped against in Signal K Slack.
Naturally there is going to be an area of overlap between OpenPlotter documentation and this page, stuff that could be in both places, but I am not overly worried about that at present.
I agree with respect to overlap. So far I have not contributed to the documentation. I am not sure where the border between OpenPlotter and SignalK lies when it comes to the documentation ?
The chapter https://openplotter.readthedocs.io/en/latest/can/can_app.html and https://openplotter.readthedocs.io/en/latest/i2c/i2c_app.html not populated, the CAN bus is covered in SignalK, with several options for hardware and solutions, while the I2C is well known and deserve a page or so.
I have worked with both (implementing solution and documented it), I thought I might contribute some text and examples.
My work with NMEA 2000 implementation (close to the suggestions): https://sites.google.com/site/olewsaa/yacht-server-with-raspberry/interfacing-with-nmea-2000
With respect to I2C I have worked on the issue of extending the I2C over some meters using an extender: https://sites.google.com/site/olewsaa/yacht-server-with-raspberry/interfacing-with-nmea-2000 . I2C is very common and deserve some documetation.
Personal I think examples and cases are a natural part of the documentation.