Class SmartDevicePlugin

Die Klasse SmartDevicePlugin implementiert die Basisklasse aller Device-Plugins. Die vorhandenen Methoden sind im Folgenden beschrieben.

Zusätzlich werden die Methoden der Klasse lib.utils.Utils vererbt.

class lib.model.smartdeviceplugin.SmartDevicePlugin(*args, **kargs)

Bases: SmartPlugin

The class SmartDevicePlugin implements the base class of smart-plugins designed especially for device connectivity.

It implements a fully functional plugin with all necessary methods to set up network or serial connections, handle item parsing and updating and converting data from shng to the device and vice versa.

In the easiest cases, only the command specifications in commands.py and possibly DT-* datatype classes are needed; additional command classes or plugin code can be added if necessary or desired.

The implemented methods are described below, inherited methods are only described if changed/overwritten.

remove_item(item)

remove item references from plugin

update_plugin_config(**kwargs)

update plugin configuration parameters and (re)run relevant configuration methods

suspend(by=None)

sets plugin into suspended mode, no network/serial activity and no item changed

resume(by=None)

disabled suspended mode, network/serial connections are resumed

on_suspend()

called when suspend is enabled. Overwrite as needed

on_resume()

called when suspend is disabled. Overwrite as needed

set_suspend(suspend_active=None, by=None)

enable / disable suspend mode: open/close connections, schedulers

run()

Run method for the plugin

stop()

Stop method for the plugin

connect()

Open connection

disconnect()

Close connection

parse_item(item)

Default plugin parse_item method. Is called when the plugin is initialized. The plugin can, corresponding to its attribute keywords, decide what to do with the item in future, like adding it to an internal array for future reference :type item: :param item: The item to process. :return: Recall function for item updates

update_item(item, caller=None, source=None, dest=None)

Item has been updated

This method is called, if the value of an item has been updated by SmartHomeNG. It should write the changed value out to the device (hardware/interface) that is managed by this plugin.

Parameter:

• item – item to be updated towards the plugin

• caller – if given it represents the callers name

• source – if given it represents the source

• dest – if given it represents the dest

send_command(command, value=None, return_result=False, **kwargs)

Sends the specified command to the device providing <value> as data Not providing data will issue a read command, trying to read the value from the device and writing it to the associated item.

Parameter:

• command (str) – the command to send

• value – the data to send, if applicable

Rückgabe:

True if send was successful, False otherwise

Rückgabetyp:

bool

on_data_received(by, data, command=None)

Callback function for received data e.g. from an event loop Processes data and dispatches value to plugin class

Parameter:

• command (str) – the command in reply to which data was received

• data – received data in ‚raw‘ connection format

• by – client object / name / identifier

dispatch_data(command, value, by=None)

Callback function - new data has been received from device. Value is already in item-compatible format, so find appropriate item and update value

Parameter:

• command (str) – command for or in reply to which data was received

• value – data

• by – str

read_all_commands(group='')

Triggers all configured read commands or all configured commands of given group

is_valid_command(command, read=None)

Validate if ‚command‘ is a valid command for this device Possible to check only for reading or writing

Parameter:

• command (str) – the command to test

• read (bool | NoneType) – check for read (True) or write (False), or both (None)

Rückgabe:

True if command is valid, False otherwise

Rückgabetyp:

bool

get_lookup(lookup, mode='fwd')

returns the lookup table for name <lookup>, None on error

has_recursive_custom_attribute(index=1)

set_custom_item(item, command, index, value)

this is called by parse_items if xx_custom[123] is found.

on_connect(by=None)

callback if connection is made.

on_disconnect(by=None)

callback if connection is broken.

read_initial_values()

control call of _read_initial_values - run instantly or delay