diff options
| author | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-14 01:19:42 -0400 |
|---|---|---|
| committer | Eugeniy E. Mikhailov <evgmik@gmail.com> | 2024-07-14 01:19:42 -0400 |
| commit | 7c070588a84aeb3ff7e665ee35eff6f3b8052235 (patch) | |
| tree | 348a24f5b112c970b3c9e787aeb17e9b61a7d963 /qolab/hardware | |
| parent | 09390c29e814641e4ad697a54ae4c424a486488c (diff) | |
| download | qolab-7c070588a84aeb3ff7e665ee35eff6f3b8052235.tar.gz qolab-7c070588a84aeb3ff7e665ee35eff6f3b8052235.zip | |
impoved doc string
Diffstat (limited to 'qolab/hardware')
| -rw-r--r-- | qolab/hardware/basic.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/qolab/hardware/basic.py b/qolab/hardware/basic.py index 1e9e920..6422002 100644 --- a/qolab/hardware/basic.py +++ b/qolab/hardware/basic.py @@ -31,11 +31,13 @@ class BasicInstrument: also used as a tag in Time Series DB (TSDB) logging. If not set we fallback to 'Device type' in config. tsdb_ingester : None or tsdb ingester - used to log properties (with setter/getter) to TSDB. If 'None', the log entry is skipped + used to log properties (with setter/getter) to TSDB. + If 'None', the log entry is skipped config : dictionary, default is empty dictionary used to add or override default entries describing instrument It is good idea to set the following keys in the dictionary: - 'Device type', 'Device model', 'DeviceId', 'DeviceNickname', 'FnamePrefix', 'SavePath'. + 'Device type', 'Device model', 'DeviceId', 'DeviceNickname', + 'FnamePrefix', 'SavePath'. Example ------- |