OCPN messaging

[Antipole]

As far as I am aware, there is no documentation of what messages OpenCPN (v5.6.2) messaging supports. I have just started the following list. It really needs adding to the manual section on Messaging but I do not know how it can get added.

[This list does not cover messaging between plugins, such as supported by OcpnDraw, and which are documented by plugin.]

Receivable by OCPN

• WMM_VARIATION_BOAT
• WMM_VARIATION
• GRIB_TIMELINE
• OCPN_TRACK_REQUEST
• OCPN_ROUTE_REQUEST
• OCPN_ROUTELIST_REQUEST
• OCPN_ACTIVE_ROUTELEG_REQUEST

JSON messages sent by OCPN

• AIS
• OCPN_MAN_OVERBOARD
• WMM_VARIATION_REQUEST
• OCPN_ROUTE_RESPONSE
• OCPN_ROUTELIST_RESPONSE
• OCPN_ACTIVE_ROUTELEG_RESPONSE
• OCPN_OPENGL_CONFIG
• OCPN_CORE_SIGNALK
• OCPN_WPT_ARRIVED
• OCPN_RTE_ACTIVATED
• OCPN_RTE_DEACTIVATED
• OCPN_RTE_ENDED
• OCPN_TRK_ACTIVATED
• OCPN_TRK_DEACTIVATED
• OCPN_TRK_POINT_ADDED
• OCPN_TRACKPOINTS_COORDS

Non-JSON messages sent by OCPN

• OpenCPN Config
• OCPN_CORE_SIGNALK

[nohal]

Ideally these should be added to the manual, see https://opencpn-manuals.github.io/ma...ual-maint.html for instructions how you can do that.

[Antipole]

Originally Posted by nohal

Ideally these should be added to the manual, see https://opencpn-manuals.github.io/ma...ual-maint.html for instructions how you can do that.

Thanks - I have been able to add this to the Messaging section in the (OLD) Developer Manual. There is no relevant section in the new manual but hopefully it will get carried across in due course.

[nohal]

Originally Posted by Antipole

Thanks - I have been able to add this to the Messaging section in the (OLD) Developer Manual. There is no relevant section in the new manual but hopefully it will get carried across in due course.

I kind of doubt that, if you added that section to the new manual, it would probably be much better...

[rgleason]

I will try to add it. @Antipole For the new Dev manual, those with git accounts can edit a page which is very similar, almost identical, to making a normal commit.

As you noted, the problem is we need a new page and it is not clear how to do that without knowing ascii/doc antora.

[rgleason]

BTW Alec deleted the messaging page because he said it did not belong there, but in the OCPN_Draw page because it did not apply to the main program, although it does involve a number of the program's plugins. Now no one knows about it because it is buried.


https://opencpn-manuals.github.io/ma...messaging.html

[rgleason]

I think we need a new page "Messaging" under "OpenCPN Development"

Originally Posted by rgleason

BTW Alec deleted the messaging page because he said it did not belong there, but in the OCPN_Draw page because it did not apply to the main program, although it does involve a number of the program's plugins. Now no one knows about it because it is buried.


https://opencpn-manuals.github.io/ma...messaging.html

[Antipole]

Originally Posted by rgleason

I think we need a new page "Messaging" under "OpenCPN Development"

I see a need for a section on OCPN messaging in the documentation for OCPN itself, which can also include a link to OcpnDraw for the present description of its interplugin messaging, which belongs in the plugin details.

[rgleason]

Ok, you'd like this information in both

1. OpenCPN User Manual? Where would you suggest?
2. OpenCPN Developer Manual - Title "Messaging" with your information, I have a good location.
3. Yes a link to OcpnDraw Ocpn_API Messaging. I like that.

Is this what you'd like to see?

Originally Posted by Antipole

I see a need for a section on OCPN messaging in the documentation for OCPN itself, which can also include a link to OcpnDraw for the present description of its interplugin messaging, which belongs in the plugin details.

[Antipole]

Originally Posted by rgleason

Ok, you'd like this information in both

1. OpenCPN User Manual? Where would you suggest?
2. OpenCPN Developer Manual - Title "Messaging" with your information, I have a good location.
3. Yes a link to OcpnDraw Ocpn_API Messaging. I like that.

Is this what you'd like to see?

I think 2 & 3 sufficient. I cannot see a place for or need for this topic in the user manual.

[rgleason]

Then I misunderstood what you wanted. BTW...nor do I.

Originally Posted by Antipole

I think 2 & 3 sufficient. I cannot see a place for or need for this topic in the user manual.

[rgleason]

Tony,
I've created the page and linked it to the manual here
https://github.com/opencpn-manuals/d...t/commits/main

https://github.com/opencpn-manuals/d...554a892d47e5c8

I hope it formats ok.

Next thing that needs to happen is to rebuild the html. I haven't done that recently.
Will ask Alec.


Thank you.