Der Core von SmartHomeNG

Der Core von SmartHomeNG besteht aus einem Haupt-Objekt welches in bin/smarthome.py definiert ist und einer Reihe von Programm Modulen, die exklusiv für die Nutzung durch den Core Hilfs-Objekte implementieren. Die Programm Module sind in dem Ordner ../lib abgelegt und im Unterpunkt Programm Modulen beschrieben.

smarthome.py

Das Haupt-Objekt von SmartHomeNG ist im folgenden beschrieben:

class lib.smarthome.SmartHome(MODE, extern_conf_dir='')[Quellcode]

Bases: object

SmartHome ist the main class of SmartHomeNG. All other objects can be addressed relative to the main oject, which is an instance of this class. Mostly it is reffered to as sh, _sh or smarthome.

BASE = '/usr/local/shng_doc/work'

initialize_vars()[Quellcode]

initialize_dir_vars()[Quellcode]

create_directories()[Quellcode]: Create directories used by SmartHomeNG if they don’t exist

get_defaultlanguage()[Quellcode]: Returns the configured default language of SmartHomeNG

set_defaultlanguage(language)[Quellcode]: Returns the configured default language of SmartHomeNG

get_basedir()[Quellcode]

Function to return the base directory of the running SmartHomeNG installation

Rückgabe: Base directory as an absolute path
Rückgabetyp: str

get_confdir()[Quellcode]

Function to return the config directory (that contain ‚etc‘, ‚logics‘ and ‚items‘ subdirectories)

Rückgabe: Config directory as an absolute path
Rückgabetyp: str

get_etcdir()[Quellcode]

Function to return the etc config directory

Rückgabe: Config directory as an absolute path
Rückgabetyp: str

get_vardir()[Quellcode]

Function to return the var directory used by SmartHomeNG

Rückgabe: var directory as an absolute path
Rückgabetyp: str

getBaseDir()[Quellcode]

Function to return the base directory of the running SmartHomeNG installation

getBaseDir() is deprecated. Use method get_basedir() instead.

Rückgabe: Base directory as an absolute path
Rückgabetyp: str

checkConfigFiles()[Quellcode]

This function checks if the needed configuration files exist. It checks for CONF and YAML files. If they dont exist, it is checked if a default configuration exist. If so, the default configuration is copied to corresponding configuration file.

The check is done for the files that have to exist (with some content) or SmartHomeNG won’t start:

smarthome.yaml / smarthome.conf
logging.yaml
plugin.yaml / plugin.conf
module.yaml / module.conf
logic.yaml / logic.conf

init_logging(conf_basename='', MODE='default')[Quellcode]: This function initiates the logging for SmartHomeNG.

start()[Quellcode]

This function starts the threads of the main smarthome object.

The main thread that is beeing started is called Main

stop(signum=None, frame=None)[Quellcode]: This method is used to stop SmartHomeNG and all it’s threads

restart(source='')[Quellcode]

This method is used to restart the python interpreter and SmartHomeNG

If SmartHomeNG was started in one of the foreground modes (-f, -i, -d), just quit and let the user restart manually.

list_threads(txt)[Quellcode]

add_event_listener(events, method)[Quellcode]

This Function adds listeners for a list of events. This function is called from plugins interfacing with visus (e.g. visu_websocket)

Parameter

events (list) – List of events to add listeners for
method (object) – Method used by the visu-interface

return_event_listeners(event='all')[Quellcode]

This function returns the listeners for a specified event.

Parameter: event (str) – Name of the event or ‚all‘ to return all listeners
Rückgabe: List of listeners
Rückgabetyp: list

object_refcount()[Quellcode]

Function to return the number of defined objects in SmartHomeNG

Rückgabe: Number of objects
Rückgabetyp: int

string2bool(string)[Quellcode]

Returns the boolean value of a string

DEPRECATED - Use lib.utils.Utils.to_bool(string) instead

Parameter: string (str) – string to convert
Rückgabe: Parameter converted to bool
Rückgabetyp: bool

add_item(path, item)[Quellcode]

Function to to add an item to the dictionary of items. If the path does not exist, it is created