PluginManager

class PluginManagerClient
Canonical

kortex_api.autogen.client_stubs.PluginManagerClientRpc

__init__(router, namespace=None)

Constructs a PluginManagerClient with an initialized RouterClient and an optional namespace.

Parameters

  • router (RouterClient) – RouterClient used for the communication

  • namespace (string) – Optional namespace on which to initialize the PluginManagerClient (defaults to None)

IsAlive(timeoutMs: int = 1000)

Returns True if the Service Server is detected online before timeoutMs is expired, False otherwise.

Parameters

timeoutMs (unsigned int) – The maximum time to wait for an answer from the server

Return type

bool

LaunchPlugin(pluginhandle, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Launch an installed plugin
Parameters
ShutDownPlugin(pluginhandle, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Shut down a running plugin
Parameters
ShutDownAllPlugins(deviceId = 0, options = RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Shut down all running plugins
Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

OnNotificationPluginUpdatedTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Notification of plugin update events
Parameters

  • callback (function) – Function callback taking a Kinova.Api.PluginManager.PluginUpdatedNotification as only argument, and returning None.

  • notificationoptions (NotificationOptions) – Notification options

Return type

NotificationHandle

OnNotificationPluginInstallationTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Notification of plugin installation events
Parameters

  • callback (function) – Function callback taking a Kinova.Api.PluginManager.PluginInstallationNotification as only argument, and returning None.

  • notificationoptions (NotificationOptions) – Notification options

Return type

NotificationHandle

Unsubscribe(notificationhandle, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Unsubscribe from PUB/SUB
Parameters
GetPluginInfo(pluginhandle, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Get info for a specific plugin
Parameters
Return type

PluginInfo

GetPluginsList(deviceId = 0, options = RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Get info of all plugins
Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Return type

PluginInfoList