Retrieve live data from InfluxDB as if the measurement device was connected directly. More...
Inheritance diagram for influx_data_client.InfluxDataClient:
Collaboration diagram for influx_data_client.InfluxDataClient:
Public Member Functions | |
| def | on_activate (self) |
| Activate module. | |
| def | on_deactivate (self) |
| Deactivate module. | |
| def | connect_db (self) |
| Connect to Influx database. | |
| def | getProcessValue (self) |
| Return a measured value. | |
| def | getProcessUnit (self) |
| Return the unit that the value is measured in. More... | |
 Public Member Functions inherited from core.module.BaseMixin | |
| def | __init__ (self, manager, name, config=None, callbacks=None, kwargs) |
| Initialise Base class object and set up its state machine. More... | |
| def | log (self) |
| Returns a logger object. | |
| def | is_module_threaded (self) |
| Returns whether the module shall be started in a thread. | |
| def | on_activate (self) |
| Method called when module is activated. More... | |
| def | on_deactivate (self) |
| Method called when module is deactivated. More... | |
| def | getStatusVariables (self) |
| Return a dict of variable names and their content representing the module state for saving. More... | |
| def | setStatusVariables (self, variableDict) |
| Give a module a dict of variable names and their content representing the module state. More... | |
| def | getConfiguration (self) |
| Return the configration dictionary for this module. More... | |
| def | get_connector (self, connector_name) |
| Return module connected to the given named connector. More... | |
| Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Public Attributes | |
| conn | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Static Public Attributes | |
| user = ConfigOption('user', missing='error') | |
| pw = ConfigOption('password', missing='error') | |
| dbname = ConfigOption('dbname', missing='error') | |
| host = ConfigOption('host', missing='error') | |
| port = ConfigOption('port', default=8086) | |
| series = ConfigOption('dataseries', missing='error') | |
| field = ConfigOption('field', missing='error') | |
| cr = ConfigOption('criterion', missing='error') | |
Detailed Description
Retrieve live data from InfluxDB as if the measurement device was connected directly.
Example config for copy-paste:
influx_data_client: module 'influx_data_client.InfluxDataClient' user 'client_user' password 'client_password' dbname 'db_name' host 'localhost' port 8086 dataseries 'data_series_name' field 'field_name' criterion 'criterion_name'
Member Function Documentation
◆ getProcessUnit()
| def influx_data_client.InfluxDataClient.getProcessUnit | ( | self | ) |
Return the unit that the value is measured in.
- Returns
- (str, str): a tuple of ('abreviation', 'full unit name')
The documentation for this class was generated from the following file:
- hardware/influx_data_client.py
