Signal K
    Preparing search index...

    Interface AutopilotApi

    interface AutopilotApi {
        apUpdate(
            pluginId: string,
            deviceId: string,
            apInfo: { [path: string]: Value },
        ): void;
        register(pluginId: string, provider: AutopilotProvider): void;
        unRegister(pluginId: string): void;
    }
    Index

    Methods

    apUpdate register unRegister

    Methods

    • This method instructs the server to send deltas for the provided paths.

      Note

      Valid apInfo paths are defined in AutopilotUpdateAttrib apInfo.actions value (like options.actions) must contain an Array<AutopilotActionDef>

      Parameters

      • pluginId: string
      • deviceId: string
      • apInfo: { [path: string]: Value }

      Returns void

      apUpdate({
       'mode': 'gps',
       'actions': [{id: 'tack', name: 'Tack', available: true}]
      });

    • Parameters

      • pluginId: string

      Returns void

    On This Page

    Methods