T controller tutorial and improve documentation

add tutorial for Berlin hands-on workshop

+ improve the documentation (hints for structure welcome)
+ remove 'optional' parameter property
  (is not yet used - should not appear in doc)
+ added test property in frappy_demo.cryo alters Parameter class
  ('test' property appears in Parameter doc)

Change-Id: I3ea08f955a92f72451fd23a5ff00d1185c7fb00e
This commit is contained in:
2023-01-26 16:34:48 +01:00
parent 60f6c2dda5
commit 10a61aa760
21 changed files with 956 additions and 126 deletions

View File

@@ -157,6 +157,12 @@ class AsynConn:
class AsynTcp(AsynConn):
"""a tcp/ip connection
uri syntax::
tcp://<host address>:<port number>
"""
scheme = 'tcp'
def __init__(self, uri, *args, **kwargs):
@@ -210,18 +216,19 @@ class AsynTcp(AsynConn):
class AsynSerial(AsynConn):
"""a serial connection using pyserial
uri syntax:
serial://<path>?[<option>=<value>[+<option>=<value> ...]]
uri syntax::
options (defaults, other examples):
serial://<serial device>?[<option>=<value>[+<option>=<value> ...]]
baudrate=9600 # 4800, 115200
bytesize=8 # 5,6,7
parity=none # even, odd, mark, space
stopbits=1 # 1.5, 2
xonxoff=False # True
options (defaults, other examples):
and others (see documentation of serial.Serial)
baudrate=9600 # 4800, 115200
bytesize=8 # 5,6,7
parity=none # even, odd, mark, space
stopbits=1 # 1.5, 2
xonxoff=False # True
and others (see documentation of serial.Serial)
"""
scheme = 'serial'
PARITY_NAMES = {name[0]: name for name in ['NONE', 'ODD', 'EVEN', 'MASK', 'SPACE']}