diff options
| -rw-r--r-- | qolab/hardware/basic.py | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/qolab/hardware/basic.py b/qolab/hardware/basic.py index 387c4b2..03d98c6 100644 --- a/qolab/hardware/basic.py +++ b/qolab/hardware/basic.py @@ -3,7 +3,15 @@ from qolab.file_utils import get_next_data_file from qolab.tsdb import tsdb_append_metric_for_class_setter_or_getter class BasicInstrument: + """ This is the most basic instrument class """ def __init__(self, config={}, device_nickname=None, tsdb_ingester=None): + """ + device_nickname - used to separate similar instruments, + also used as a tag in Time Series DB (TSDB) logging, + if not set we fallbacl to 'Device type' + tsdb_ingester - used to log to TSDB if not set, the log entry is skipped + config - used to add or override default entries + """ self.config = {} self.config['Device type'] = 'Basic Instrument' self.config['Device model'] = 'Model is unset' |