diff options
| -rw-r--r-- | qolab/hardware/basic.py | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/qolab/hardware/basic.py b/qolab/hardware/basic.py index 2e99767..44e8795 100644 --- a/qolab/hardware/basic.py +++ b/qolab/hardware/basic.py @@ -5,6 +5,22 @@ from qolab.tsdb import tsdb_append_metric_for_class_setter_or_getter class BasicInstrument: """This is the most basic instrument class. + It is intended to be used as a parent class for real instruments. + + Notable feature that when 'getConfig' is called, + it gathers values of the properties listed in 'deviceProperties' variable and + also if 'numberOfChannels' is set, it gathers configs of channels listed in + 'channelProperties'. The later case is intended for instruments with + global setting and channels, for example scopes. This is super handy + to include together with acquired and saved data to see under which condition + they are taken. + + Some property might have 'tsdb_append' decorator + which sends the property value to the time + series database (TSDB) for the log keeping. Use it only for properties + which are scalar, for example VoltsPerDiv, SampleRate, and similar. + Such logs could be later analysed with a help of systems like Grafana + or anything which could read TSDB entries. Parameters ---------- |