From 387c7c4fdea37daf66605fa42caa40cd0373e855 Mon Sep 17 00:00:00 2001 From: Markus Zolliker Date: Tue, 25 Aug 2026 09:05:10 +0200 Subject: [PATCH] adapt tutorials to use the simplified IO configuration - define ioClass not only in the example class for the temperature controller tutorial, but also in the tutorial text - adapt also the He level tutorial this is a followup fix after 38071 Change-Id: I0c9375093bb5706a09032e67c828ed52f643f720 Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/40080 Reviewed-by: Markus Zolliker Tested-by: Jenkins Automated Tests --- doc/source/tutorial_helevel.rst | 16 +++++++++++----- doc/source/tutorial_t_control.rst | 9 +++------ 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/source/tutorial_helevel.rst b/doc/source/tutorial_helevel.rst index 73201e21..e0e237cd 100644 --- a/doc/source/tutorial_helevel.rst +++ b/doc/source/tutorial_helevel.rst @@ -39,7 +39,7 @@ CCU4 luckily has a very simple and logical protocol: class HeLevel(HasIO, Readable): """He Level channel of CCU4""" - # define the communication class for automatic creation of the IO module + # the class needed for the communication module ioClass = CCU4IO # define or alter the parameters @@ -214,10 +214,11 @@ We choose the name *example_cryo* and create therefore a configuration file Node('example_cryo.psi.ch', 'this is an example cryostat for the Frappy tutorial', interface='tcp://5000') + IO('helev_io', 'linse-moxa-4.psi.ch:3001') Mod('helev', 'frappy_psi.ccu4.HeLevel', 'He level of the cryostat He reservoir', - uri='linse-moxa-4.psi.ch:3001', + io='helev_io', empty_length=380, full_length=0) @@ -234,8 +235,8 @@ All the other sections define the SECoP modules to be used. This first arguments * the python class to be used for the creation of the module * a human readable description is its -Other properties or parameter values may follow, in this case the *uri* for the communication -with the He level monitor and the values for configuring the He Level sensor. +Other properties or parameter values may follow, in this case the name of the *io* module for +the communication with the He level monitor and the values for configuring the He Level sensor. We might also alter parameter properties, for example we may hide the parameters *empty_length* and *full_length* from the client by defining: @@ -244,11 +245,16 @@ the parameters *empty_length* and *full_length* from the client by defining: Mod('helev', 'frappy_psi.ccu4.HeLevel', 'He level of the cryostat He reservoir', - uri='linse-moxa-4.psi.ch:3001', + io='helev_io', empty_length=Param(380, export=False), full_length=Param(0, export=False)) As we configure more than just an initial value, we have to call *Param* and give the value as the first argument, and additional properties as keyworded arguments. +*IO(* is a special case of a module. It defines the name and the uri for a +communication module. Its class is determined when its name if assigned to +the io property of a module, using the *ioClass* attribute of this modules +class. + *to be continued* diff --git a/doc/source/tutorial_t_control.rst b/doc/source/tutorial_t_control.rst index 2bad89e8..605c5546 100644 --- a/doc/source/tutorial_t_control.rst +++ b/doc/source/tutorial_t_control.rst @@ -61,7 +61,8 @@ See :ref:`lsc_manual_extract` for details of the needed commands. class TemperatureSensor(HasIO, Readable): """a temperature sensor (generic for different models)""" - # internal property to configure the channel + ioClass = LakeshoreIO # class to be used for communication + # internal property to configure the channel # see below for the difference of 'Property' and 'Parameter' channel = Property('the Lakeshore channel', datatype=StringType()) # 0, 1500 is the allowed range by the LakeShore controller @@ -308,11 +309,7 @@ Finally, the config file would be: Node('example_cryo.psi.ch', # a globally unique identification 'this is an example cryostat for the Frappy tutorial', # describes the node interface='tcp://10767') # you might choose any port number > 1024 - Mod('io', # the name of the module - 'frappy_psi.lakeshore.LakeshoreIO', # the class used for communication - 'communication to main controller', # a description - uri='serial://COM6:?baudrate=57600+parity=odd+bytesize=7', # the serial connection - ) + IO('io', 'serial://COM6:?baudrate=57600+parity=odd+bytesize=7') # the serial connection Mod('T', 'frappy_psi.lakeshore.TemperatureLoop', 'Sample Temperature',