Class Plugins

This class implements the following methods and properties:

class lib.plugin.Plugins(smarthome, configfile)

Bases: object

Plugin loader Class. Parses config file and creates a worker thread for each plugin

Parameter:

• smarthome – Instance of the smarthome master-object

• configfile (str) – Basename of the plugin configuration file

get(plugin_name, instance=None)

Get plugin object by plugin name and instance (optional)

Parameter:

• plugin_name – name of the plugin (not the plugin configuration)

• instance – name of the instance of the plugin (optional)

Rückgabe:

plugin object

get_logic_parameters()

Returns the list of all logic parameter definitions of all configured/loaded plugins

Rückgabe:

get_loaded_plugins()

Returns a list with the names of all loaded plugins

if multiple instances of a plugin are loaded, the plugin name is returned only once

Rückgabe:

list of plugin names

Rückgabetyp:

list

get_loaded_plugin_instances()

Returns a list of tuples of all loaded plugins with the plugin name and the instance name

Rückgabe:

list of (plugin name, instance name)

Rückgabetyp:

list of tuples

static get_instance()

Returns the instance of the Plugins class, to be used to access the plugin-api

Use it the following way to access the api:

from lib.plugin import Plugins
plugins = Plugins.get_instance()

# to access a method (eg. xxx()):
plugins.xxx()

Rückgabe:

logics instance

Rückgabetyp:

object of None

return_plugin(configname)

Returns (the object of) one loaded smartplugin with given configname

Parameter:

name (str) – name of the plugin to get

Rückgabe:

object of the plugin

Rückgabetyp:

object

return_plugins()

Returns a list with the instances of all loaded plugins

Rückgabe:

list of plugin names

Rückgabetyp:

list

class PyObject

Bases: Structure

refcnt

Structure/Union member

unload_plugin(configname)

Unloads (the object of) one loaded plugin with given configname

Parameter:

name (str) – name of the plugin to unload

Rückgabe:

success or failure

Rückgabetyp:

bool

start()

stop()

get_pluginthread(configname)

Returns one plugin with given name

Rückgabe:

Thread object for the given plugin name

Rückgabetyp:

object