Skip to content

Commit 711f53c

Browse files
committed
Add lengthier overview of virtual devices
1 parent 603d3cc commit 711f53c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

blacs/plugins/virtual_device/__init__.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,19 @@
4242
CONNECT_CHECK_INTERVAL = 0.1
4343

4444
class Plugin(object):
45+
'''
46+
The `virtual_device` plugin provides a way to group analog, digital, and DDS outputs
47+
that are related in purpose but attached to different hardware devices into a single BLACS tab.
48+
49+
A typical use case might be creating a "MOT" panel from analog and digital channels on a dedicated analog card and digital card.
50+
51+
To enable the `virtual_device` plugin, add the line `virtual_device = True`
52+
to your `.ini` config file in the `labconfig` folder.
53+
After restarting BLACS, click the `Edit` option in the new `Virtual Devices` menu
54+
to begin constructing virtual devices.
55+
Modifying virtual devices requires restarting BLACS.
56+
'''
57+
4558
def __init__(self, initial_settings):
4659
self.menu = None
4760
self.notifications = {}

0 commit comments

Comments
 (0)