Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.11 KB

UPDATE_PLUGIN_API.md

File metadata and controls

61 lines (46 loc) · 2.11 KB
Raw

Shipdriver update to plugin API 118

Since version 3.3.0 the shipdriver template supports using API 118. Compared to the commonly used API 116 this offers some new capabilities:

  • Better version handling, plugin carries the complete version info. This avoids the needs for various hacks in main openpcn used for older API levels.

  • The new communication interface described in https://opencpn-manuals.github.io/main/opencpn-dev/plugin-messaging.html. This can handle NMEA2000 messages and also offers more performance and flexibility compared to the old interfaces.

  • Improved scalable interface support

  • Enhanced waypoint and route support.

The update process:

  1. Ensure that the template is updated to 3.3.0 or higher

  2. In Plugin.cmake, change set(PKG_API_LIB api-16) to set(PKG_API_LIB api-18)

  3. Add the following snippet to config.h.in:

    #define PLUGIN_VERSION_TWEAK @PROJECT_VERSION_TWEAK@

#define PKG_PRERELEASE "@PKG_PRERELEASE@"
#define PKG_BUILD_INFO "@pkg_vers_build_info@"

#define PLUGIN

  4. In the main header file for the plugin (Shipdriver_pi.h for shipdriver) find the snippet like

    class ShipDriver_pi : public opencpn_plugin_116 {

    Here, update to use public opencpn_plugin_118 instead.

  5. In the file which implements the constructor, find the snippet like

    ShipDriver_pi::ShipDriver_pi(void* ppimgr) : opencpn_plugin_116(ppimgr)

    Likewise, update this to opencpn_plugin_118(ppimgr). For shipdriver, this is in src/ShipDriver_pi.cpp.

  6. Implement new methods, typically in the file which implements GetAPIVersionMajor(). In the shipdriver case, this is src/ShipDriver_pi.cpp

    int GetPlugInVersionPatch() { return PLUGIN_VERSION_PATCH; }
int GetPlugInVersionPost() { return PLUGIN_VERSION_TWEAK; }
const char *GetPlugInVersionPre() { return PKG_PRERELEASE; }
const char *GetPlugInVersionBuild() { return PKG_BUILD_INFO; }

    This is boilerplate code, same for all plugins.

  7. Build and test plugin. When completed, remove this document.