Reconciling file names with reference

allow the argument of the run function to be a simple string

Change-Id: I1d5de3802b6adc22a01a262d4cb017bf7dd084c5
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/36343
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>

.description

@@ -1,2 +1,2 @@
-SECoP playground for creating specification and testing one implementation.
+Frappy framework for implementing SEC-nodes (see SECoP protocol on github).
 

.gitignore

@@ -1,13 +1,15 @@
+frappydemo.PID
 log/*
 html/*
 *.pyc
 pid/*
 
-# ide 
+# ide
 .idea
 
 RELEASE-VERSION
 build
+*.egg-info
 
 # Sphinx
 doc/_build
@@ -21,4 +23,8 @@ doc/_build
 ._*
 
 # pyinstaller
-dist/
+dist/
+
+*.cfg
+*.bk.tnt
+*.tps

.isort.cfg

@@ -0,0 +1,8 @@
+[settings]
+multi_line_output=2
+combine_as_imports=True
+
+known_qt=frappy.gui.qt
+known_core=frappy
+
+sections=FUTURE,STDLIB,QT,THIRDPARTY,CORE,FIRSTPARTY,LOCALFOLDER

.pylintrc

@@ -9,7 +9,7 @@
 
 # Add <file or directory> to the black list. It should be a base name, not a
 # path. You may set this option multiple times.
-ignore = .git
+ignore = .git,resources_qt5.py,resources_qt6.py
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -38,26 +38,23 @@ confidence=
 # multiple time.
 disable=missing-docstring
         ,locally-disabled
-        ,locally-enabled
         ,fixme
         ,no-member
-        ,bad-whitespace
+        ,not-callable
         ,wrong-import-position
         ,ungrouped-imports
         ,import-self
-        ,bad-continuation
         ,protected-access
         ,unused-argument
         ,duplicate-code
         ,attribute-defined-outside-init
         ,access-member-before-definition
-        ,no-self-use
         ,broad-except
         ,unneeded-not
         ,unidiomatic-typecheck
         ,undefined-loop-variable
-        ,redefined-variable-type
-        ,deprecated-lambda
+        ,consider-using-f-string
+        ,use-dict-literal
 
 [REPORTS]
 
@@ -67,10 +64,6 @@ disable=missing-docstring
 
 msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
 
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
 
 # Tells whether to display a full report or only the messages
 reports=no
@@ -93,14 +86,11 @@ dummy-variables-rgx=_|dummy
 
 # List of additional names supposed to be defined in builtins. Remember that
 # you should avoid to define new builtins when possible.
-additional-builtins=
+additional-builtins=Node,Mod,Param,Command,Group
 
 
 [BASIC]
 
-# List of builtins function names that should not be used, separated by a comma
-#bad-functions=map,filter,apply,input
-bad-functions=apply,input
 
 # Regular expression which should only match correct module names
 module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9_]+))$
@@ -155,14 +145,8 @@ notes=FIXME,XXX,TODO
 # Maximum number of characters on a single line.
 max-line-length=132
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
 # Maximum number of lines in a module
-max-module-lines=1200
+max-module-lines=1000
 
 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
 # tab).
@@ -212,13 +196,16 @@ max-locals=50
 max-returns=10
 
 # Maximum number of branch for function / method body
-max-branches=40
+max-branches=50
 
 # Maximum number of statements in function / method body
 max-statements=150
 
 # Maximum number of parents for a class (see R0901).
-max-parents=10
+max-parents=20
+
+# Maximum number of positional arguments
+max-positional-arguments=10
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=50

Makefile

@@ -3,12 +3,18 @@
 
 all: clean doc
 
+# Make spawns a new shell for each command.
+# Save each PID in temporary file
+# sleep in order for "test" to have started reliably
 demo:
-	@bin/secop-server -q demo &
-	@bin/secop-server -q test &
-	@bin/secop-server -q cryo &
-	@bin/secop-gui localhost:10767 localhost:10768 localhost:10769
-	@ps aux|grep [s]ecop-server|awk '{print $$2}'|xargs kill
+	@rm -f frappydemo.PID || true
+	@{ bin/frappy-server -q demo & echo $$! >> frappydemo.PID; }
+	@{ bin/frappy-server -q test & echo $$! >> frappydemo.PID; }
+	@{ bin/frappy-server -q cryo & echo $$! >> frappydemo.PID; }
+	@sleep 0.2 
+	@bin/frappy-gui localhost:10767 localhost:10768 localhost:10769
+	@cat frappydemo.PID | xargs kill || true
+	@rm frappydemo.PID
 
 build:
 	python3 setup.py build
@@ -32,18 +38,18 @@ test-verbose:
 	python3 $(shell which pytest) -v test -s
 
 test-coverage:
-	python3 $(shell which pytest) -v test --cov=secop
+	python3 $(shell which pytest) -v test --cov=frappy
 
 doc:
 	$(MAKE) -C doc html
 
 lint:
-	pylint -j 0 -f colorized -r n --rcfile=.pylintrc secop secop_* test
+	pylint -f colorized -r n --rcfile=.pylintrc frappy frappy_* test
 
 isort:
 	@find test -name '*.py' -print0 | xargs -0 isort -e -m 2 -w 80 -ns __init__.py
-	@find secop -name '*.py' -print0 | xargs -0 isort -e -m 2 -w 80 -ns __init__.py
-	@find . -wholename './secop_*.py' -print0 | xargs -0 isort -e -m 2 -w 80 -ns __init__.py
+	@find frappy -name '*.py' -print0 | xargs -0 isort -e -m 2 -w 80 -ns __init__.py
+	@find . -wholename './frappy_*.py' -print0 | xargs -0 isort -e -m 2 -w 80 -ns __init__.py
 
 release-patch:
 	MODE="patch" $(MAKE) release
@@ -55,8 +61,8 @@ release-major:
 	MODE="major" $(MAKE) release
 
 release:
-	ssh jenkinsng.admin.frm2 -p 29417 build -v -s -p GERRIT_PROJECT=$(shell git config --get remote.origin.url | rev | cut -d '/' -f -3 | rev) -p ARCH=all -p MODE=$(MODE) ReleasePipeline
+	ssh jenkins.admin.frm2.tum.de -p 29417 build -v -s -p GERRIT_PROJECT=$(shell git config --get remote.origin.url | rev | cut -d '/' -f -2 | rev) -p ARCH=all -p MODE=$(MODE) ReleasePipeline
 
 
 build-pkg:
-	debocker build --image jenkinsng.admin.frm2:5000/mlzbase/buster
+	debocker build --image docker.ictrl.frm2.tum.de:5443/mlzbase/buster

README.md

@@ -0,0 +1,33 @@
+Frappy: Framework for programming secnodes in Python
+====================================================
+
+Frappy is a Python-framework for writing [SECoP](https://github.com/SampleEnvironment/SECoP) servers (called SECNodes or Nodes) and Clients.
+It comes with its own Graphical client and a collection of example Nodes.
+It is able to use TCP and Serial connections.
+
+To get started, look at the provided demo, the provided examples, or have a look
+at the INTRODUCTION section.
+
+Main development is done
+[here](https://forge.frm2.tum.de/review/q/project:secop%252Ffrappy)
+and a readonly GitHub-mirror for easier access is available
+[here](https://github.com/SampleEnvironment/frappy).
+
+Requirements
+------------
+
+See `requirements.txt`.
+
+Demo
+----
+
+Use the following command after installing the dependencies:
+
+```
+$ make demo
+```
+
+Documentation
+-------------
+
+[See here for documentation of Frappy](https://forge.frm2.tum.de/public/doc/frappy/html/)

bin/frappy-cfg-editor

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # pylint: disable=invalid-name
-#  -*- coding: utf-8 -*-
 # *****************************************************************************
+# Copyright (c) 2015-2024 by the authors, see LICENSE
 #
 # This program is free software; you can redistribute it and/or modify it under
 # the terms of the GNU General Public License as published by the Free Software
@@ -29,8 +29,11 @@ from os import path
 # Add import path for inplace usage
 sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..')))
 
-from secop.gui.qt import QApplication
-from secop.gui.cfg_editor.mainwindow import MainWindow
+import logging
+from mlzlog import ColoredConsoleHandler
+
+from frappy.gui.qt import QApplication
+from frappy.gui.cfg_editor.mainwindow import MainWindow
 
 
 def main(argv=None):
@@ -38,9 +41,13 @@ def main(argv=None):
     parser.add_argument('-f', '--file', help='Configuration file to open.')
     args = parser.parse_args()
     app = QApplication(argv)
-    window = MainWindow(args.file)
+    logger = logging.getLogger('gui')
+    console = ColoredConsoleHandler()
+    console.setLevel(logging.INFO)
+    logger.addHandler(console)
+    window = MainWindow(args.file, log=logger)
     window.show()
-    return app.exec_()
+    return app.exec()
 
 
 if __name__ == '__main__':

bin/frappy-cli

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+# *****************************************************************************
+# Copyright (c) 2015-2024 by the authors, see LICENSE
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Module authors:
+#   Alexander Lenz <alexander.lenz@frm2.tum.de>
+#   Markus Zolliker <markus.zolliker@psi.ch>
+#
+# *****************************************************************************
+
+import sys
+import argparse
+from pathlib import Path
+
+# Add import path for inplace usage
+sys.path.insert(0, str(Path(__file__).absolute().parents[1]))
+
+from frappy.client.interactive import init, run, clientenv, interact
+
+
+def parseArgv(argv):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-i', '--include',
+                        help='file to execute after connecting to the clients', metavar='file',
+                        type=Path, action='append', default=[])
+    parser.add_argument('-o', '--only-execute',
+                        help='Do not go into interactive mode after executing files. \
+                        Has no effect without --include.', action='store_true')
+    parser.add_argument('node',
+                        help='Nodes the client should connect to.\n', metavar='host:port',
+                        nargs='*', type=str, default=[])
+    return parser.parse_args(argv)
+
+
+args = parseArgv(sys.argv[1:])
+
+success = init(*args.node)
+
+run_error = ''
+file_success = False
+try:
+    for file in args.include:
+        run(file)
+    file_success = True
+except Exception as e:
+    run_error = f'\n{clientenv.short_traceback()}'
+
+if success:
+    if args.include and file_success and args.only_execute:
+        print('skipping interactive mode')
+        exit()
+    interact(run_error)

bin/frappy-gui

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+# pylint: disable=invalid-name
+# *****************************************************************************
+# Copyright (c) 2015-2024 by the authors, see LICENSE
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Module authors:
+#   Alexander Lenz <alexander.lenz@frm2.tum.de>
+#
+# *****************************************************************************
+
+from __future__ import print_function
+
+import sys
+import argparse
+from pathlib import Path
+
+# Add import path for inplace usage
+sys.path.insert(0, str(Path(__file__).absolute().parents[1]))
+
+import logging
+from mlzlog import ColoredConsoleHandler
+
+from frappy.gui.qt import QApplication
+from frappy.gui.mainwindow import MainWindow
+
+def parseArgv(argv):
+    parser = argparse.ArgumentParser()
+    loggroup = parser.add_mutually_exclusive_group()
+    loggroup.add_argument('-d', '--debug',
+                          help='Enable debug output',
+                          action='store_true', default=False)
+    loggroup.add_argument('-q', '--quiet',
+                          help='Supress everything but errors',
+                          action='store_true', default=False)
+    parser.add_argument('-D', '--detailed',
+                        help='Start in detailed mode',
+                        action='store_true', default=False)
+    parser.add_argument('node',
+                        help='Nodes the GUI should connect to.\n', metavar='host[:port]',
+                        nargs='*', type=str, default=[])
+    return parser.parse_args(argv)
+
+
+def main(argv=None):
+    if argv is None:
+        argv = sys.argv
+
+    args = parseArgv(argv[1:])
+
+    loglevel = logging.DEBUG if args.debug else (logging.ERROR if args.quiet else logging.INFO)
+    logger = logging.getLogger('gui')
+    logger.setLevel(logging.DEBUG)
+    if sys.stdout is not None:
+        console = ColoredConsoleHandler()
+        console.setLevel(loglevel)
+        logger.addHandler(console)
+
+    app = QApplication(argv)
+
+    win = MainWindow(args, logger)
+    app.aboutToQuit.connect(win._onQuit)
+    win.show()
+
+    return app.exec()
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))

bin/frappy-play

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+# *****************************************************************************
+# Copyright (c) 2015-2024 by the authors, see LICENSE
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Module authors:
+#   Markus Zolliker <markus.zolliker@psi.ch>
+#
+# *****************************************************************************
+
+import sys
+from pathlib import Path
+from frappy.lib import generalConfig
+from frappy.logging import logger
+
+# Add import path for inplace usage
+sys.path.insert(0, str(Path(__file__).absolute().parents[1]))
+
+from frappy.client.interactive import Console
+from frappy.playground import play, USAGE
+
+generalConfig.init()
+logger.init()
+if len(sys.argv) > 1:
+    play(sys.argv[1])
+else:
+    print(USAGE)
+
+Console('play', sys.modules['__main__'].__dict__)

bin/frappy-scan

@@ -0,0 +1,128 @@
+#!/usr/bin/env python3
+# *****************************************************************************
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Module authors:
+#   Alexander Zaft <a.zaft@fz-juelich.de>
+#
+# *****************************************************************************
+
+"""SEC node autodiscovery tool."""
+
+import argparse
+import json
+import os
+import select
+import socket
+import sys
+from collections import namedtuple
+from time import time as currenttime
+
+UDP_PORT = 10767
+
+Answer = namedtuple('Answer',
+                    'address, port, equipment_id, firmware, description')
+
+
+def decode(msg, addr):
+    msg = msg.decode('utf-8')
+    try:
+        data = json.loads(msg)
+    except Exception:
+        return None
+    if not isinstance(data, dict):
+        return None
+    if data.get('SECoP') != 'node':
+        return None
+    try:
+        eq_id = data['equipment_id']
+        fw = data['firmware']
+        desc = data['description']
+        port = data['port']
+    except KeyError:
+        return None
+    addr, _scanport = addr
+    return Answer(addr, port, eq_id, fw, desc)
+
+
+def print_answer(answer, *, short=False):
+    if short:
+        # NOTE: keep this easily parseable!
+        print(f'{answer.equipment_id} {answer.address}:{answer.port}')
+        return
+    print(f'Found {answer.equipment_id} at {answer.address}:')
+    print(f'  Port: {answer.port}')
+    print(f'  Firmware: {answer.firmware}')
+    desc = answer.description.replace('\n', '\n    ')
+    print(f'  Node description: {desc}')
+    print()
+
+
+def scan(max_wait=1.0):
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+    # send a general broadcast
+    try:
+        s.sendto(json.dumps(dict(SECoP='discover')).encode('utf-8'),
+                 ('255.255.255.255', UDP_PORT))
+    except OSError as e:
+        print('could not send the broadcast:', e)
+        # we still keep listening for self-announcements
+    start = currenttime()
+    seen = set()
+    while currenttime() < start + max_wait:
+        res = select.select([s], [], [], 0.1)
+        if res[0]:
+            try:
+                msg, addr = s.recvfrom(1024)
+            except socket.error:  # pragma: no cover
+                continue
+            answer = decode(msg, addr)
+            if answer is None:
+                continue
+            if (answer.address, answer.equipment_id, answer.port) in seen:
+                continue
+            seen.add((answer.address, answer.equipment_id, answer.port))
+            yield answer
+
+
+def listen(*, short=False):
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    if os.name == 'nt':
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+    else:
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
+    s.bind(('0.0.0.0', UDP_PORT))
+    while True:
+        try:
+            msg, addr = s.recvfrom(1024)
+        except KeyboardInterrupt:
+            break
+        answer = decode(msg, addr)
+        if answer:
+            print_answer(answer, short=short)
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-l', '--listen', action='store_true',
+                        help='Print short info. '
+                        'Keep listening after the broadcast.')
+    args = parser.parse_args(sys.argv[1:])
+    for answer in scan():
+        print_answer(answer, short=args.listen)
+    if args.listen:
+        listen(short=args.listen)

bin/frappy-server

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 # pylint: disable=invalid-name
-#  -*- coding: utf-8 -*-
 # *****************************************************************************
 #
 # This program is free software; you can redistribute it and/or modify it under
@@ -23,21 +22,28 @@
 #
 # *****************************************************************************
 
-import sys
 import argparse
-from os import path
-
-import mlzlog
+import sys
+from pathlib import Path
 
 # Add import path for inplace usage
-sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..')))
+sys.path.insert(0, str(Path(__file__).absolute().parents[1]))
 
-from secop.lib import getGeneralConfig
-from secop.server import Server
+from frappy.lib import generalConfig
+from frappy.logging import logger
+from frappy.server import Server
 
 
 def parseArgv(argv):
-    parser = argparse.ArgumentParser(description="Manage a SECoP server")
+    parser = argparse.ArgumentParser(
+        description="Manage a SECoP server",
+        epilog="""The server needs some configuration, by default from the
+            generalConfig.cfg file. the keys confdir, logdir and piddir have to
+            be set.
+            Alternatively, one can set the environment variables FRAPPY_CONFDIR
+            FRAPPY_LOGDIR and FRAPPY_PIDDIR to set the required values.
+        """
+    )
     loggroup = parser.add_mutually_exclusive_group()
     loggroup.add_argument("-v", "--verbose",
                           help="Output lots of diagnostic information",
@@ -60,15 +66,27 @@ def parseArgv(argv):
     parser.add_argument('-c',
                         '--cfgfiles',
                         action='store',
-                        help="comma separated list of cfg files\n"
-                        "defaults to <name_of_the_instance>\n"
-                        "cfgfiles given without '.cfg' extension are searched in the configuration directory,"
-                        "else they are treated as path names",
+                        help="comma separated list of cfg files,\n"
+                        "defaults to <name_of_the_instance>.\n"
+                        "If a config file contains a slash, it is treated as a"
+                        "path, otherwise the file is searched for in the "
+                        "configuration directory.",
+                        default=None)
+    parser.add_argument('-g',
+                        '--gencfg',
+                        action='store',
+                        help="full path of general config file,\n"
+                        "defaults to env. variable FRAPPY_CONFIG_FILE\n",
                         default=None)
     parser.add_argument('-t',
                         '--test',
                         action='store_true',
-                        help='Check cfg files only',
+                        help='check cfg files only',
+                        default=False)
+    parser.add_argument('-r',
+                        '--relaxed',
+                        action='store_true',
+                        help='no checking of problematic behaviour',
                         default=False)
     return parser.parse_args(argv)
 
@@ -80,17 +98,21 @@ def main(argv=None):
     args = parseArgv(argv[1:])
 
     loglevel = 'debug' if args.verbose else ('error' if args.quiet else 'info')
-    mlzlog.initLogging('secop', loglevel, getGeneralConfig()['logdir'])
+    generalConfig.set_default('lazy_number_validation', args.relaxed)
+    generalConfig.set_default('legacy_hasiodev', args.relaxed)
+    generalConfig.set_default('tolerate_poll_property', args.relaxed)
+    generalConfig.init(args.gencfg)
+    logger.init(loglevel)
 
-    srv = Server(args.name, mlzlog.log, cfgfiles=args.cfgfiles, interface=args.port, testonly=args.test)
+    cfgfiles = [s.strip() for s in args.cfgfiles.split(',')] if args.cfgfiles else None
+
+    srv = Server(args.name, logger.log, cfgfiles=cfgfiles,
+                 interface=args.port, testonly=args.test)
 
     if args.daemonize:
         srv.start()
     else:
-        try:
-            srv.run()
-        except KeyboardInterrupt:
-            pass
+        srv.run()
 
 
 if __name__ == '__main__':

bin/make_doc.py

@@ -1,64 +0,0 @@
-#!/usr/bin/env python
-#  -*- coding: utf-8 -*-
-# *****************************************************************************
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
-# Module authors:
-#   Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
-#
-# *****************************************************************************
-
-
-import os
-from os import path
-
-import markdown
-
-BASE_PATH = path.abspath(path.join(path.dirname(__file__), '..'))
-DOC_SRC = path.join(BASE_PATH, 'doc')
-DOC_DST = path.join(BASE_PATH, 'html')
-
-conv = markdown.Markdown()
-
-for dirpath, dirnames, filenames in os.walk(DOC_SRC):
-    # re-create the dir-structure of DOC_SRC into DOC_DST
-    dst_path = path.join(DOC_DST, path.relpath(dirpath, DOC_SRC))
-    try:
-        os.mkdir(dst_path)
-    except OSError:
-        pass
-
-    for fn in filenames:
-        full_name = path.join(dirpath, fn)
-        sub_name = path.relpath(full_name, DOC_SRC)
-        final_name = path.join(DOC_DST, sub_name)
-
-        if not fn.endswith('md'):
-            # just copy everything else
-            with open(full_name, 'rb') as fi:
-                with open(final_name, 'wb') as fo:
-                    # WARNING: possible Memory hog!
-                    fo.write(fi.read())
-            continue
-        # treat .md files special
-        final_sub_name = path.splitext(sub_name)[0] + '.html'
-        final_name = path.join(DOC_DST, final_sub_name)
-        print("Converting %s to %s" %(sub_name, final_sub_name))
-        # transform one file
-        conv.reset()
-        conv.convertFile(input=full_name,
-                         output=final_name,
-                         encoding="utf-8")

bin/secop-console

@@ -1,76 +0,0 @@
-#!/usr/bin/env python3
-# pylint: disable=invalid-name
-#  -*- coding: utf-8 -*-
-# *****************************************************************************
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
-# Module authors:
-#   Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
-#
-# *****************************************************************************
-
-import sys
-import argparse
-from os import path
-
-# Path magic to make python find our stuff.
-# also remember our basepath (for etc, pid lookup, etc)
-basepath = path.abspath(path.join(sys.path[0], '..'))
-etc_path = path.join(basepath, 'etc')
-pid_path = path.join(basepath, 'pid')
-log_path = path.join(basepath, 'log')
-# sys.path[0] = path.join(basepath, 'src')
-sys.path[0] = basepath
-
-# do not move above!
-import mlzlog
-from secop.client.console import ClientConsole
-
-
-def parseArgv(argv):
-    parser = argparse.ArgumentParser(description="Connect to a SECoP server")
-    loggroup = parser.add_mutually_exclusive_group()
-    loggroup.add_argument("-v", "--verbose",
-                          help="Output lots of diagnostic information",
-                          action='store_true', default=False)
-    loggroup.add_argument("-q", "--quiet", help="suppress non-error messages",
-                          action='store_true', default=False)
-    parser.add_argument("name",
-                        type=str,
-                        help="Name of the instance.\n"
-                        " Uses etc/name.cfg for configuration\n",)
-    return parser.parse_args()
-
-
-def main(argv=None):
-    if argv is None:
-        argv = sys.argv
-
-    args = parseArgv(argv[1:])
-
-    loglevel = 'debug' if args.verbose else ('error' if args.quiet else 'info')
-    mlzlog.initLogging('console', loglevel, log_path)
-
-    console = ClientConsole(args.name, basepath)
-
-    try:
-        console.run()
-    except KeyboardInterrupt:
-        console.close()
-
-
-if __name__ == '__main__':
-    sys.exit(main(sys.argv))

bin/secop-gui

@@ -1,71 +0,0 @@
-#!/usr/bin/env python3
-# pylint: disable=invalid-name
-#  -*- coding: utf-8 -*-
-# *****************************************************************************
-# Copyright (c) 2015-2016 by the authors, see LICENSE
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
-# Module authors:
-#   Alexander Lenz <alexander.lenz@frm2.tum.de>
-#
-# *****************************************************************************
-
-from __future__ import print_function
-
-import sys
-from os import path
-
-# Add import path for inplace usage
-sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..')))
-
-import mlzlog
-
-from secop.gui.qt import QApplication
-from secop.gui.mainwindow import MainWindow
-
-
-def main(argv=None):
-    if argv is None:
-        argv = sys.argv
-
-    if '-h' in argv or '--help' in argv:
-        print("Usage: secop-gui [-d] [-h] [host:[port]]")
-        print()
-        print("Option   GNU long option   Meaning")
-        print("-h       --help            Show this message")
-        print("-d       --debug           Enable debug output")
-        print()
-        print("if not given, host defaults to 'localhost' and port to 10767")
-        sys.exit(0)
-
-    if '-d' in argv or '--debug' in argv:
-        mlzlog.initLogging('gui', 'debug')
-    else:
-        mlzlog.initLogging('gui', 'info')
-
-    app = QApplication(argv)
-
-    hosts = [host for host in argv[1:] if not host.startswith('-')]
-    if not hosts:
-        hosts = ['localhost:10767']
-    win = MainWindow(hosts)
-    win.show()
-
-    return app.exec_()
-
-
-if __name__ == '__main__':
-    sys.exit(main(sys.argv))

bin/sim-server

@@ -0,0 +1,197 @@
+#!/usr/bin/env python3
+# pylint: disable=invalid-name
+# *****************************************************************************
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# Module authors:
+#   Markus Zolliker <markus.zolliker@psi.ch>
+# *****************************************************************************
+"""server for a string communicator
+
+Usage:
+
+    bin/sim-server <communicator class> -p <server port> [-o <option1>=<value> <option2>=<value>]
+
+open a server on <server port> to communicate with the string based <communicator> over TCP/IP.
+
+Use cases, mainly for test purposes:
+
+- relay to a hardware simulation written as a communicator
+
+  > bin/sim-server frappy_psi.ls370sim.Ls370Sim
+
+- relay to a communicator not using TCP/IP, if Frappy should run on an other host
+
+  > bin/sim-server frappy.io.StringIO -o uri=serial:///dev/tty...
+
+- as a T, if the hardware allows only one connection, and more than one is needed:
+
+  > bin/sim-server frappy.io.StringIO -o uri=tcp://<host>:<port>
+
+  typically using communicator class frappy.io.StringIO
+"""
+
+import sys
+import argparse
+from pathlib import Path
+import socket
+import time
+import os
+from ast import literal_eval
+from socketserver import BaseRequestHandler, ThreadingTCPServer
+
+# Add import path for inplace usage
+sys.path.insert(0, str(Path(__file__).absolute().parents[1]))
+
+from frappy.lib import get_class, formatException, mkthread
+
+
+class Logger:
+    def debug(self, *args):
+        pass
+
+    def log(self, level, *args):
+        pass
+
+    def info(self, *args):
+        print(*args)
+
+    exception = error = warn = info
+
+
+class TcpRequestHandler(BaseRequestHandler):
+    def setup(self):
+        print(f'connection opened from {self.client_address}')
+        self.running = True
+        self.request.settimeout(1)
+        self.data = b''
+
+    def finish(self):
+        """called when handle() terminates, i.e. the socket closed"""
+        # close socket
+        try:
+            self.request.shutdown(socket.SHUT_RDWR)
+        except Exception:
+            pass
+        finally:
+            print(f'connection closed from {self.client_address}')
+            self.request.close()
+
+    def poller(self):
+        while True:
+            time.sleep(1.0)
+            self.module.doPoll()
+
+    def handle(self):
+        """handle a new connection"""
+        # do a copy of the options, as they are consumed
+        self.module = self.server.modulecls(
+            'mod', Logger(), dict(self.server.options), self.server)
+        self.module.earlyInit()
+
+        mkthread(self.poller)
+        while self.running:
+            try:
+                newdata = self.request.recv(1024)
+                if not newdata:
+                    return
+            except socket.timeout:
+                # no new data during read, continue
+                continue
+            self.data += newdata
+            while self.running:
+                message, sep, self.data = self.data.partition(b'\n')
+                if not sep:
+                    break
+                cmd = message.decode('latin-1')
+                try:
+                    reply = self.module.communicate(cmd.strip())
+                    if self.server.verbose:
+                        print('%-40s | %s' % (cmd, reply))
+                except Exception:
+                    print(formatException(verbose=True))
+                    return
+                outdata = reply.encode('latin-1') + b'\n'
+                try:
+                    self.request.sendall(outdata)
+                except Exception as e:
+                    print(repr(e))
+                    self.running = False
+
+
+class Server(ThreadingTCPServer):
+    allow_reuse_address = os.name != 'nt'  # False on Windows systems
+
+    class Dispatcher:
+        def announce_update(self, *_):
+            pass
+
+        def announce_update_error(self, *_):
+            pass
+
+    def __init__(self, port, modulecls, options, verbose=False):
+        super().__init__(('', port), TcpRequestHandler,
+                         bind_and_activate=True)
+        self.secnode = None
+        self.dispatcher = self.Dispatcher()
+        self.verbose = verbose
+        self.modulecls = get_class(modulecls)
+        self.options = options
+        print(f'started sim-server listening on port {port}')
+
+
+def parse_argv(argv):
+    parser = argparse.ArgumentParser(description="Relay to a communicator (simulated HW or other)")
+    parser.add_argument("-v", "--verbose",
+                        help="output full communication",
+                        action='store_true', default=False)
+    parser.add_argument("cls",
+                        type=str,
+                        help="communicator class.\n",)
+    parser.add_argument('-p',
+                        '--port',
+                        action='store',
+                        help='server port or uri',
+                        default=2089)
+    parser.add_argument('-o',
+                        '--options',
+                        action='store',
+                        nargs='*',
+                        help='options in the form key=value',
+                        default=None)
+    return parser.parse_args(argv)
+
+
+def main(argv=None):
+    if argv is None:
+        argv = sys.argv
+
+    args = parse_argv(argv[1:])
+    options = {'description': ''}
+    for item in args.options or ():
+        key, eq, value = item.partition('=')
+        if not eq:
+            raise ValueError(f"missing '=' in {item}")
+        try:
+            value = literal_eval(value)
+        except Exception:
+            pass
+        options[key] = value
+    srv = Server(int(args.port), args.cls, options, args.verbose)
+    srv.serve_forever()
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))

bin/stringio-server

@@ -1,154 +0,0 @@
-#!/usr/bin/env python3
-# pylint: disable=invalid-name
-#  -*- coding: utf-8 -*-
-# *****************************************************************************
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
-# Module authors:
-#   Markus Zolliker <markus.zolliker@psi.ch>
-# *****************************************************************************
-"""server for a string communicator
-
-Usage:
-
-    bin/stringio-server <communciator> <server port>
-
-open a server on <server port> to communicate with the string based <communicator> over TCP/IP.
-
-Use cases, mainly for test purposes:
-- as a T, if the hardware allows only one connection, and more than one is needed
-- relay to a communicator not using TCP/IP, if Frappy should run on an other host
-- relay to a hardware simulation written as a communicator
-"""
-
-import sys
-from os import path
-import asyncore
-import socket
-import ast
-
-# Add import path for inplace usage
-sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..')))
-
-from secop.lib import get_class, formatException
-
-class LineHandler(asyncore.dispatcher_with_send):
-
-    def __init__(self, sock):
-        self.buffer = b""
-        asyncore.dispatcher_with_send.__init__(self, sock)
-        self.crlf = 0
-
-    def handle_read(self):
-        data = self.recv(8192)
-        if data:
-            parts = data.split(b"\n")
-            if len(parts) == 1:
-                self.buffer += data
-            else:
-                self.handle_line((self.buffer + parts[0]).decode('latin_1'))
-                for part in parts[1:-1]:
-                    if part[-1] == b"\r":
-                        self.crlf = True
-                        part = part[:-1]
-                    else:
-                        self.crlf = False
-                    self.handle_line(part.decode('latin_1'))
-                self.buffer = parts[-1]
-
-    def send_line(self, line):
-        self.send((line + ("\r\n" if self.crlf else "\n")).encode('latin_1'))
-
-
-class LineServer(asyncore.dispatcher):
-
-    def __init__(self, host, port, lineHandlerClass):
-        asyncore.dispatcher.__init__(self)
-        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)
-        self.set_reuse_addr()
-        self.bind((host, port))
-        self.listen(5)
-        self.lineHandlerClass = lineHandlerClass
-
-    def handle_accept(self):
-        pair = self.accept()
-        if pair is not None:
-            sock, addr = pair
-            print("Incoming connection from %s" % repr(addr))
-            self.lineHandlerClass(sock)
-
-    def loop(self):
-        asyncore.loop()
-
-
-class Server(LineServer):
-
-    class Dispatcher:
-        def announce_update(self, *_):
-            pass
-
-        def announce_update_error(self, *_):
-            pass
-
-    def __init__(self, *args, **kwds):
-        super().__init__(*args, **kwds)
-        self.dispatcher = self.Dispatcher()
-
-
-class Handler(LineHandler):
-    def handle_line(self, line):
-        try:
-            reply = module.do_communicate(line.strip())
-            if verbose:
-                print('%-40s | %s' % (line, reply))
-        except Exception:
-            print(formatException(verbose=True))
-        self.send_line(reply)
-
-
-class Logger:
-    def debug(self, *args):
-        print(*args)
-    info = exception = debug
-
-
-opts = {'description': 'simulator'}
-args = []
-for arg in sys.argv[1:]:
-    k, sep, v = arg.partition('=')
-    if not k:
-        args.append(v)
-    try:
-        v = ast.literal_eval(v)
-    except Exception:
-        pass
-    opts[k] = v
-verbose = opts.pop('verbose', False)
-opts['cls'] = 'secop_psi.ls370sim.Ls370Sim'
-opts['port'] = 4567
-if len(args) > 2:
-    raise ValueError('do not know about: %s' % ' '.join(args[2:]))
-if len(args) == 2:
-    opts['port'] = int(args[1])
-if len(args) > 0:
-    opts['cls'] = args[0]
-    args.append(opts)
-
-cls = opts.pop('cls')
-port = opts.pop('port')
-srv = Server('localhost', int(port), Handler)
-module = get_class(cls)(cls, Logger(), opts, srv)
-module.earlyInit()
-srv.loop()

cfg/ah2700test.cfg

@@ -1,17 +0,0 @@
-[node AH2700Test.psi.ch]
-description = AH2700 capacitance bridge test
-
-[interface tcp]
-type = tcp
-bindto = 0.0.0.0
-bindport = 5000
-
-[module cap]
-class = secop_psi.ah2700.Capacitance
-description = capacitance
-uri=ldmse3-ts:3015
-
-#[module ahcom]
-#class = secop_psi.ah2700.StringIO
-#uri=ldmse3-ts:3015
-#description = serial communicator to an AH2700

cfg/ah2700test_cfg.py

@@ -0,0 +1,10 @@
+Node('AH2700Test.psi.ch',
+     'AH2700 capacitance bridge test',
+     'tcp://5000',
+)
+
+Mod('cap',
+    'frappy_psi.ah2700.Capacitance',
+    'capacitance',
+    uri='ldmse3-ts:3015',
+)

cfg/amagnet.cfg

@@ -1,111 +0,0 @@
-[node MLZ_amagnet(Garfield)]
-description=MLZ-Amagnet
-	.
-	Water cooled magnet from ANTARES@MLZ.
-	.
-        Use module to control the magnetic field.
-	Don't forget to select symmetry first (can be moved only at zero field!).
-	.
-	Monitor T1..T4 (Coil temps), if they get to hot, field will ramp down!
-	.
-	In case of Problems, contact the ANTARES people at MLZ.
-
-visibility=expert
-foo=bar
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module enable]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice='tango://localhost:10000/box/plc/_enable'
-value.datatype=["enum", {'On':1,'Off':0}]
-target.datatype=["enum", {'On':1,'Off':0}]
-.description='Enables to Output of the Powersupply'
-.visibility='advanced'
-
-[module polarity]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_polarity
-value.datatype=["enum", {'+1':1,'0':0,'-1':-1}]
-target.datatype=["enum", {'+1':1,'0':0,'-1':-1}]
-.description=polarity (+/-) switch
-	.
-	there is an interlock in the plc:
-	if there is current, switching polarity is forbidden
-	if polarity is short, powersupply is disabled
-.visibility=advanced
-comtries=50
-
-
-[module symmetry]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_symmetric
-value.datatype=["enum",{'symmetric':1,'short':0, 'asymmetric':-1}]
-target.datatype=["enum",{'symmetric':1,'short':0, 'asymmetric':-1}]
-.description=par/ser switch selecting (a)symmetric mode
-	.
-	symmetric is ser, asymmetric is par
-.visibility=advanced
-
-[module T1]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_t1
-.description=Temperature1 of the coils system
-#warnlimits=(0, 50)
-value.unit='degC'
-
-[module T2]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_t2
-.description=Temperature2 of the coils system
-#warnlimits=(0, 50)
-value.unit='degC'
-
-[module T3]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_t3
-.description=Temperature3 of the coils system
-#warnlimits=(0, 50)
-value.unit='degC'
-
-[module T4]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_t4
-.description=Temperature4 of the coils system
-#warnlimits=(0, 50)
-value.unit='degC'
-
-[module currentsource]
-class=secop_mlz.entangle.PowerSupply
-tangodevice=tango://localhost:10000/box/lambda/curr
-.description=Device for the magnet power supply (current mode)
-abslimits=(0,200)
-speed=1
-ramp=60
-precision=0.02
-current=0
-voltage=10
-#unit=A
-.visibility=advanced
-
-[module mf]
-class=secop_mlz.amagnet.GarfieldMagnet
-.description=magnetic field module, handling polarity switching and stuff
-subdev_currentsource=currentsource
-subdev_enable=enable
-subdev_polswitch=polarity
-subdev_symmetry=symmetry
-target.unit='T'
-value.unit='T'
-userlimits=(-0.35, 0.35)
-calibrationtable={'symmetric':[0.00186517, 0.0431937, -0.185956, 0.0599757, 0.194042],
-	'short': [0.0, 0.0, 0.0, 0.0, 0.0],
-	'asymmetric':[0.00136154, 0.027454, -0.120951, 0.0495289, 0.110689]}
-.meaning=The magnetic field
-.priority=100
-.visibility=user
-
-abslimits.default=-0.4,0.4

cfg/amagnet_cfg.py

@@ -0,0 +1,91 @@
+Node('MLZ_amagnet(Garfield)',
+    'MLZ-Amagnet\n'
+    '\n'
+    'Water cooled magnet from ANTARES@MLZ.\n'
+    '\n'
+    'Use module to control the magnetic field.\n'
+    'Don\'t forget to select symmetry first (can be moved only at zero field!).\n'
+    '\n'
+    'Monitor T1..T4 (Coil temps), if they get to hot, field will ramp down!\n'
+    '\n'
+    'In case of Problems, contact the ANTARES people at MLZ.',
+    'tcp://10767',
+    visibility = 'expert',
+    foo = 'bar',
+)
+
+Mod('enable',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'Enables to Output of the Powersupply',
+    tangodevice = 'tango://localhost:10000/box/plc/_enable',
+    value = Param(datatype=["enum", {'On':1,'Off':0}]),
+    target = Param(datatype=["enum", {'On':1,'Off':0}]),
+    visibility = 'advanced',
+)
+
+Mod('polarity',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'polarity (+/-) switch\n'
+    '\n'
+    'there is an interlock in the plc:\n'
+    'if there is current, switching polarity is forbidden\n'
+    'if polarity is short, powersupply is disabled',
+    tangodevice = 'tango://localhost:10000/box/plc/_polarity',
+    value = Param(datatype=["enum", {'+1':1,'0':0,'-1':-1}]),
+    target = Param(datatype=["enum", {'+1':1,'0':0,'-1':-1}]),
+    visibility = 'advanced',
+    comtries = 50,
+)
+
+Mod('symmetry',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'par/ser switch selecting (a)symmetric mode\n'
+    '\n'
+    'symmetric is ser, asymmetric is par',
+    tangodevice = 'tango://localhost:10000/box/plc/_symmetric',
+    value = Param(datatype=["enum",{'symmetric':1,'short':0, 'asymmetric':-1}]),
+    target = Param(datatype=["enum",{'symmetric':1,'short':0, 'asymmetric':-1}]),
+    visibility = 'advanced',
+)
+
+for i in range(1,5):
+    Mod('T%d' % i,
+        'frappy_mlz.entangle.AnalogInput',
+        'Temperature %d of the coils system' % i,
+        tangodevice = 'tango://localhost:10000/box/plc/_t%d' % i,
+        #warnlimits=(0, 50),
+        value = Param(unit='degC'),
+    )
+
+Mod('currentsource',
+    'frappy_mlz.entangle.PowerSupply',
+    'Device for the magnet power supply (current mode)',
+    tangodevice = 'tango://localhost:10000/box/lambda/curr',
+    abslimits = (0,200),
+    speed = 1,
+    ramp = 60,
+    precision = 0.02,
+    current = 0,
+    voltage = 10,
+    #value=Param(unit='A')
+    visibility = 'advanced',
+)
+
+Mod('mf',
+    'frappy_mlz.amagnet.GarfieldMagnet',
+    'magnetic field module, handling polarity switching and stuff',
+    currentsource = 'currentsource',
+    enable = 'enable',
+    polswitch = 'polarity',
+    symmetry = 'symmetry',
+    target = Param(unit='T'),
+    value = Param(unit='T'),
+    userlimits = (-0.35, 0.35),
+    calibrationtable = {'symmetric':[0.00186517, 0.0431937, -0.185956, 0.0599757, 0.194042],
+    'short': [0.0, 0.0, 0.0, 0.0, 0.0],
+    'asymmetric':[0.00136154, 0.027454, -0.120951, 0.0495289, 0.110689]},
+    meaning = ['The magnetic field', 1],
+    #priority=100,
+    visibility = 'user',
+    abslimits = (-0.4,0.4,),
+)

cfg/ccr.cfg

@@ -1,150 +0,0 @@
-[node MLZ_ccr12]
-description = CCR box of MLZ Sample environment group
-	.
-	Contains a Lakeshore 336 and an PLC controlling the compressor
-	and some valves.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module automatik]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_automatik
-mapping=dict(Off=0,p1=1,p2=2)
-description="controls the (simple) pressure regulation
-	.
-	selects between off, regulate on p1 or regulate on p2 sensor"
-
-[module compressor]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_cooler_onoff
-mapping=dict(Off=0,On=1)
-description=control the compressor (on/off)
-
-[module gas]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_gas_onoff
-mapping=dict(Off=0,On=1)
-description=control the gas inlet into the ccr (on/off)
-	.
-	note: this switches off automatically after 15 min.
-	note: activation de-activates the vacuum inlet
-	note: if the pressure regulation is active, it enslave this device
-
-[module vacuum]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_vacuum_Onoff
-mapping=dict(Off=0,On=1)
-description=control the vacuum inlet into the ccr (on/off)
-	.
-	note: activation de-activates the gas inlet
-	note: if the pressure regulation is active, it enslave this device
-
-[module p1]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_p1
-value.unit='mbar'
-description=pressure sensor 1 (linear scale)
-
-[module p2]
-class=secop_mlz.entangle.AnalogInput
-tangodevice=tango://localhost:10000/box/plc/_p2
-value.unit='mbar'
-description=pressure sensor 2 (selectable curve)
-
-[module curve_p2]
-class=secop_mlz.entangle.NamedDigitalInput
-tangodevice=tango://localhost:10000/box/plc/_curve
-value.default=0
-description=calibration curve for pressure sensor 2
-mapping="{'0-10V':0, '0-1000mbar':1, '1-9V to 0-1 mbar':2,
-	'DI200':3, 'DI2000':4, 'TTR100':7, 'PTR90':8,
-	'PTR225/237':9, 'ITR90':10, 'ITR100-D':11,
-	'ITR100-2':12, 'ITR100-3':13, 'ITR100-4':14,
-	'ITR100-5':15, 'ITR100-6':16, 'ITR100-7':17,
-	'ITR100-8':18, 'ITR100-9':19, 'ITR100-A':20,
-	'CMR361':21, 'CMR362':22, 'CMR363':23,
-	'CMR364':24, 'CMR365':25}"
-
-# sensors
-[module T_sample]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/sample/sensora
-value.unit='K'
-description=sample temperature
-
-[module T_stick]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/stick/sensorb
-value.unit='K'
-description=temperature at bottom of sample stick
-
-[module T_coldhead]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/coldhead/sensorc
-value.unit='K'
-description=temperature at coldhead
-
-[module T_tube]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/tube/sensord
-value.unit='K'
-description=temperature at thermal coupling tube <-> stick
-
-
-# regulations
-
-[module T_stick_regulation]
-class=secop_mlz.entangle.TemperatureController
-tangodevice=tango://localhost:10000/box/stick/control2
-heateroutput.default=0
-description=regulation of stick temperature
-ramp.default=6
-speed.default=0.1
-setpoint.default=0
-pid.default=(40,10,1)
-p.default=40
-i.default=10
-d.default=1
-abslimits=(0,500)
-value.unit='K'
-
-# OMG! a NamedDigitalOutput, but with float'ints' 0..3
-[module T_stick_regulation_heaterrange]
-class=secop_mlz.entangle.AnalogOutput
-tangodevice=tango://localhost:10000/box/stick/range2
-precision.default=1
-abslimits=(0,3)
-description=heaterrange for stick regulation
-
-
-[module T_tube_regulation]
-class=secop_mlz.entangle.TemperatureController
-tangodevice=tango://localhost:10000/box/tube/control1
-description=regulation of tube temperature
-heateroutput.default=0
-ramp.default=6
-speed.default=0.1
-setpoint.default=0
-pid.default=(40,10,1)
-p.default=40
-i.default=10
-d.default=1
-abslimits=(0,500)
-value.unit='K'
-
-# OMG! a NamedDigitalOutput, but with float'ints' 0..3
-#[module T_tube_regulation_heaterrange]
-#class=secop_mlz.entangle.AnalogOutput
-#tangodevice=tango://localhost:10000/box/tube/range1
-#precision.default=1
-#abslimits=(0,3)
-
-[module T_tube_regulation_heaterrange]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/tube/range1
-mapping=dict(Off=0, Low=1, Medium=2, High=3)
-description=heaterrange for tube regulation

cfg/ccr_cfg.py

@@ -0,0 +1,148 @@
+desc = '''CCR box of MLZ Sample environment group
+
+ Contains a Lakeshore 336 and an PLC controlling the compressor
+ and some valves.'''
+Node('MLZ_ccr',
+     desc,
+    'tcp://10767',
+)
+
+Mod('automatik',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'controls the (simple) pressure regulation\n'
+    '\n'
+    'selects between off, regulate on p1 or regulate on p2 sensor',
+    tangodevice = 'tango://localhost:10000/box/plc/_automatik',
+    mapping={'Off':0,'p1':1,'p2':2},
+)
+
+Mod('compressor',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'control the compressor (on/off)',
+    tangodevice = 'tango://localhost:10000/box/plc/_cooler_onoff',
+    mapping={'Off':0,'On':1},
+)
+
+Mod('gas',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'control the gas inlet into the ccr (on/off)\n'
+    '\n'
+    'note: this switches off automatically after 15 min.\n'
+    'note: activation de-activates the vacuum inlet\n'
+    'note: if the pressure regulation is active, it enslave this device',
+    tangodevice = 'tango://localhost:10000/box/plc/_gas_onoff',
+    mapping={'Off':0,'On':1},
+)
+
+Mod('vacuum',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'control the vacuum inlet into the ccr (on/off)\n'
+    '\n'
+    'note: activation de-activates the gas inlet\n'
+    'note: if the pressure regulation is active, it enslave this device',
+    tangodevice = 'tango://localhost:10000/box/plc/_vacuum_onoff',
+    mapping={'Off':0,'On':1},
+)
+
+Mod('p1',
+    'frappy_mlz.entangle.AnalogInput',
+    'pressure sensor 1 (linear scale)',
+    tangodevice = 'tango://localhost:10000/box/plc/_p1',
+    value = Param(unit='mbar')
+)
+
+Mod('p2',
+    'frappy_mlz.entangle.AnalogInput',
+    'pressure sensor 2 (selectable curve)',
+    tangodevice = 'tango://localhost:10000/box/plc/_p2',
+    value = Param(unit='mbar'),
+)
+
+Mod('curve_p2',
+    'frappy_mlz.entangle.NamedDigitalInput',
+    'calibration curve for pressure sensor 2',
+    tangodevice = 'tango://localhost:10000/box/plc/_curve',
+    value = 0,
+    mapping = {'0-10V':0, '0-1000mbar':1, '1-9V to 0-1 mbar':2,
+        'DI200':3, 'DI2000':4, 'TTR100':7, 'PTR90':8,
+        'PTR225/237':9, 'ITR90':10, 'ITR100-D':11,
+        'ITR100-2':12, 'ITR100-3':13, 'ITR100-4':14,
+        'ITR100-5':15, 'ITR100-6':16, 'ITR100-7':17,
+        'ITR100-8':18, 'ITR100-9':19, 'ITR100-A':20,
+        'CMR361':21, 'CMR362':22, 'CMR363':23,
+        'CMR364':24, 'CMR365':25},
+)
+
+Mod('T_tube_regulation',
+    'frappy_mlz.entangle.TemperatureController',
+    'regulation of tube temperature',
+    tangodevice = 'tango://localhost:10000/box/tube/control1',
+    value = Param(unit = 'K'),
+    heateroutput = 0,
+    ramp = 6,
+    speed = 0.1,
+    setpoint = 0,
+    pid = (40, 10, 1),
+    p = 40,
+    i = 10,
+    d = 1,
+    abslimits = (0, 500),
+)
+
+Mod('T_stick_regulation',
+    'frappy_mlz.entangle.TemperatureController',
+    'regualtion of stick temperature',
+    tangodevice = 'tango://localhost:10000/box/stick/control2',
+    value = Param(unit = 'K'),
+    heateroutput = 0,
+    ramp = 6,
+    speed = 0.1,
+    setpoint = 0,
+    pid = (40, 10, 1),
+    p = 40,
+    i = 10,
+    d = 1,
+    abslimits = (0, 500),
+)
+Mod('T_sample',
+    'frappy_mlz.entangle.Sensor',
+    'sample temperature',
+    tangodevice = 'tango://localhost:10000/box/sample/sensora',
+    value = Param(unit = 'K'),
+)
+
+Mod('T_stick',
+    'frappy_mlz.entangle.Sensor',
+    'temperature at bottom of sample stick',
+    tangodevice = 'tango://localhost:10000/box/stick/sensorb',
+    value = Param(unit = 'K'),
+)
+
+Mod('T_coldhead',
+    'frappy_mlz.entangle.Sensor',
+    'temperature at coldhead',
+    tangodevice = 'tango://localhost:10000/box/coldhead/sensorc',
+    value = Param(unit = 'K'),
+)
+
+Mod('T_tube',
+    'frappy_mlz.entangle.Sensor',
+    'temperature at thermal coupling tube <-> stick',
+    tangodevice = 'tango://localhost:10000/box/tube/sensord',
+    value = Param(unit = 'K'),
+)
+
+# THIS IS A HACK: due to entangle (in controller)
+Mod('T_tube_regulation_heaterrange',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'heaterrange for tube regulation',
+    tangodevice = 'tango://localhost:10000/box/tube/range1',
+    mapping={'Off':0,'Low':1,'Medium':2, 'High':3},
+)
+
+Mod('T_stick_regulation_heaterrange',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'heaterrange for stick regulation',
+    tangodevice = 'tango://localhost:10000/box/stick/range2',
+    mapping={'Off':0,'Low':1,'Medium':2, 'High':3},
+)

cfg/cryo.cfg

@@ -1,50 +0,0 @@
-[node cryo_7]
-# set SEC-node properties
-description = short description
-	.
-	This is a very long description providing all the glory details in all the glory details about the stuff we are describing
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10769
-
-[module cryo]
-# some (non-defaut) module properties
-.group=very important/stuff
-.description=A simulated cc cryostat with heat-load, specific heat for the sample
-	and a temperature dependend heat-link between sample and regulation.
-
-# class of module:
-class=secop_demo.cryo.Cryostat
-
-# some parameters
-jitter=0.1
-T_start=10.0
-target=10.0
-looptime=1
-ramp=6
-maxpower=20.0
-heater=4.1
-p=40
-i=10
-d=2
-mode=pid
-tolerance=0.1
-window=30
-timeout=900
-
-# some (non-default) parameter properties
-pollinterval.export=False
-
-# some parameter grouping
-p.group=pid
-i.group=pid
-d.group=pid
-
-value.unit=K
-
-# test custom properties
-value.test=customized value
-

cfg/cryo_cfg.py

@@ -0,0 +1,35 @@
+#####################################################################
+# Python version of frappy config
+#####################################################################
+
+Node('cryo_7.frappy.demo',
+    'short description\n\n'
+    'This is a very long description providing all the gory details '
+    'about the stuff we are describing.',
+    'tcp://10769',
+    more="blub",
+)
+
+Mod('cryo',
+    'frappy_demo.cryo.Cryostat',
+    'A simulated cc cryostat with heat-load, specific heat for the sample and a '
+    'temperature dependent heat-link between sample and regulation.',
+    group='very important/stuff',
+    jitter=0.1,
+    T_start=10.0,
+    target=10.0,
+    looptime=1,
+    ramp=6,
+    maxpower=20.0,
+    heater=4.1,
+    mode='pid',
+    tolerance=0.1,
+    window=30,
+    timeout=900,
+    p = Param(40, unit='%/K'),  # in case 'default' is the first arg, we can omit 'default='
+    i = 10,
+    d = 2,
+    pid = Group('p', 'i', 'd'),
+    pollinterval = Param(export=False),
+    value = Param(unit = 'K', test = 'customized value'),
+)

cfg/demo.cfg

@@ -1,43 +0,0 @@
-[node Equipment_ID_for_demonstration]
-description = virtual modules to play around with
-
-[interface tcp]
-bindto=0.0.0.0
-bindport=10767
-
-[module heatswitch]
-class=secop_demo.modules.Switch
-switch_on_time=5
-switch_off_time=10
-.description="Heatswitch for `mf` device"
-
-[module mf]
-class=secop_demo.modules.MagneticField
-heatswitch = heatswitch
-.description="simulates some cryomagnet with persistent/non-persistent switching"
-
-[module ts]
-class=secop_demo.modules.SampleTemp
-sensor = 'Q1329V7R3'
-ramp = 4
-target = 10
-value = 10
-.description = "some temperature"
-
-[module tc1]
-class=secop_demo.modules.CoilTemp
-sensor="X34598T7"
-.description = "some temperature"
-
-[module tc2]
-class=secop_demo.modules.CoilTemp
-sensor="X39284Q8'
-.description = "some temperature"
-
-[module label]
-class=secop_demo.modules.Label
-system=Cryomagnet MX15
-subdev_mf=mf
-subdev_ts=ts
-.description = "some label indicating the state of the magnet `mf`."
-

cfg/demo_cfg.py

@@ -0,0 +1,46 @@
+Node('demo.frappy.demo',
+     'Basic demo server for frappy',
+     'tcp://10767',
+)
+
+Mod('heatswitch',
+    'frappy_demo.modules.Switch',
+    'Heatswitch for `mf` device',
+    switch_on_time = 5,
+    switch_off_time = 10,
+)
+
+Mod('mf',
+    'frappy_demo.modules.MagneticField',
+    'simulates some cryomagnet with persistent/non-persistent switching',
+    heatswitch = 'heatswitch',
+)
+
+Mod('ts',
+    'frappy_demo.modules.SampleTemp',
+    'some temperature',
+    sensor = 'Q1329V7R3',
+    ramp = 4,
+    target = 10,
+    value = 10,
+)
+
+Mod('tc1',
+    'frappy_demo.modules.CoilTemp',
+    'some temperature',
+    sensor = 'X34598T7',
+)
+
+Mod('tc2',
+    'frappy_demo.modules.CoilTemp',
+    'some temperature',
+    sensor = 'X39284Q8',
+)
+
+Mod('label',
+    'frappy_demo.modules.Label',
+    'some label indicating the state of the magnet `mf`.',
+    system = 'Cryomagnet MX15',
+    mf = 'mf',
+    ts = 'ts',
+)

cfg/epics.cfg

@@ -1,50 +0,0 @@
-[node see_demo_equipment]
-description=Do  not use, it needs to be rewritten....
-
-[interface testing]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module tc1]
-class=secop_demo.modules.CoilTemp
-sensor="X34598T7"
-
-[module tc2]
-class=secop_demo.modules.CoilTemp
-sensor="X39284Q8'
-
-
-[module sensor1]
-class=secop_ess.epics.EpicsReadable
-epics_version="v4"
-.group="Lakeshore336"
-value_pv="DEV:KRDG1"
-
-
-[module loop1]
-class=secop_ess.epics.EpicsTempCtrl
-epics_version="v4"
-.group="Lakeshore336"
-
-value_pv="DEV:KRDG1"
-target_pv="DEV:SETP_S1"
-heaterrange_pv="DEV:RANGE_S1"
-
-
-[module sensor2]
-class=secop_ess.epics.EpicsReadable
-epics_version="v4"
-.group="Lakeshore336"
-value_pv="DEV:KRDG2"
-
-
-[module loop2]
-class=secop_ess.epics.EpicsTempCtrl
-epics_version="v4"
-.group="Lakeshore336"
-
-value_pv="DEV:KRDG2"
-target_pv="DEV:SETP_S2"
-heaterrange_pv="DEV:RANGE_S2"
-

cfg/epics_cfg.py

@@ -0,0 +1,36 @@
+Node('see_demo_equipment',
+    'Do  not use, it needs to be rewritten....',
+    'tcp://10767',
+)
+
+Mod('tc1',
+    'frappy_demo.modules.CoilTemp',
+    '',
+    sensor="X34598T7",
+)
+
+Mod('tc2',
+    'frappy_demo.modules.CoilTemp',
+    '',
+    sensor="X39284Q8",
+)
+
+
+for i in [1,2]:
+    Mod('sensor%d' % i,
+        'frappy_ess.epics.EpicsReadable',
+        '',
+        epics_version="v4",
+        value_pv="DEV:KRDG%d" % i,
+        group="Lakeshore336",
+    )
+
+    Mod('loop%d' % i,
+        'frappy_ess.epics.EpicsTempCtrl',
+        '',
+        epics_version="v4",
+        group="Lakeshore336",
+        value_pv="DEV:KRDG%d" % i,
+        target_pv="DEV:SETP_S%d" % i,
+        heaterrange_pv="DEV:RANGE_S%d" % i,
+    )

cfg/frappy_test_cfg.py

@@ -0,0 +1,7 @@
+import frappy.core as fc
+import TNMRExt.FlexibleModule as mod
+
+Node('example_TNMR.psi.ch', 'The NMR system running the Scout and controlled with TNMR', interface='tcp://5000')
+
+Mod('sequence0', mod.flexible_module('D:\\Users\\Garrad\\sequence_0.tps', 's0'), 'The zeroth sequence')
+Mod('sequence1', mod.flexible_module('D:\\Users\\Garrad\\sequence_1.tps', 's1'), 'The first sequence')

cfg/generalConfig.cfg

@@ -0,0 +1,5 @@
+[FRAPPY]
+# general config for running in git repo
+logdir = ./log
+piddir = ./pid
+confdir = ./cfg

cfg/ls336_cfg.py

@@ -0,0 +1,23 @@
+from os import environ
+
+# either change the uri or set the environment variable 'LS_URI'
+lakeshore_uri = environ.get('LS_URI', 'tcp://<host>:7777')
+
+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_demo.lakeshore.LakeshoreIO',  # the class used for communication
+    'communication to main controller',  # a description
+    uri=lakeshore_uri,  # the serial connection
+    )
+Mod('T',
+    'frappy_demo.lakeshore.TemperatureLoop',
+    'Sample Temperature',
+    io='io',
+    channel='A',  # the channel on the LakeShore for this module
+    loop=1,  # the loop to be used
+    value=Param(max=470),  # set the maximum expected T
+    target=Param(max=420),  # set the maximum allowed target T
+    heater_range=3,  # 5 for model 350
+    )

cfg/ls370sim.cfg

@@ -1,24 +0,0 @@
-[node LscSIM.psi.ch]
-description = Lsc Simulation at PSI
-
-[interface tcp]
-type = tcp
-bindto = 0.0.0.0
-bindport = 5000
-
-[module res]
-class = secop_psi.ls370res.ResChannel
-.channel = 3
-.description = resistivity
-.main = lsmain
-.iodev = lscom
-
-[module lsmain]
-class = secop_psi.ls370res.Main
-.description = main control of Lsc controller
-.iodev = lscom
-
-[module lscom]
-class = secop_psi.ls370sim.Ls370Sim
-.description = simulated serial communicator to a LS 370
-.visibility = 3

cfg/ls370sim_cfg.py

@@ -0,0 +1,30 @@
+Node('LscSIM.psi.ch',
+    'Lsc Simulation at PSI',
+     'tcp://5000',
+)
+
+Mod('lscom',
+    'frappy_psi.ls370sim.Ls370Sim',
+    'simulated serial communicator to a LS 370',
+    visibility = 3
+)
+
+Mod('sw',
+    'frappy_psi.ls370res.Switcher',
+    'channel switcher for Lsc controller',
+    io = 'lscom',
+)
+
+Mod('a',
+    'frappy_psi.ls370res.ResChannel',
+    'resistivity',
+    channel = 1,
+    switcher = 'sw',
+)
+
+Mod('b',
+    'frappy_psi.ls370res.ResChannel',
+    'resistivity',
+    channel = 3,
+    switcher = 'sw',
+)

cfg/ls370test.cfg

@@ -1,21 +0,0 @@
-[node LscSIM.psi.ch]
-description = Lsc370 Test
-
-[interface tcp]
-type = tcp
-bindto = 0.0.0.0
-bindport = 5000
-
-[module lsmain]
-class = secop_psi.ls370res.Main
-description = main control of Lsc controller
-uri = localhost:4567
-
-[module res]
-class = secop_psi.ls370res.ResChannel
-vexc = '2mV'
-channel = 3
-description = resistivity
-main = lsmain
-# the auto created iodev from lsmain:
-iodev = lsmain_iodev

cfg/ls370test_cfg.py

@@ -0,0 +1,29 @@
+Node('LscSIM.psi.ch',
+    'Lsc370 Test',
+     'tcp://5000',
+)
+
+Mod('io',
+    'frappy_psi.ls370res.StringIO',
+    'io for Ls370',
+    uri = 'localhost:2089',
+    )
+Mod('sw',
+    'frappy_psi.ls370res.Switcher',
+    'channel switcher',
+    io = 'io',
+)
+Mod('res1',
+    'frappy_psi.ls370res.ResChannel',
+    'resistivity chan 1',
+    vexc = '2mV',
+    channel = 1,
+    switcher = 'sw',
+)
+Mod('res2',
+    'frappy_psi.ls370res.ResChannel',
+    'resistivity chn 3',
+    vexc = '2mV',
+    channel = 3,
+    switcher = 'sw',
+)

cfg/multiplexer.cfg

@@ -1,8 +0,0 @@
-[NODE]
-class = protocol.router.Router
-id = multiplexer
-description = multiplexer node
-nodes = ['localhost:5000', 'localhost:10769']
-
-[INTERFACE]
-uri = tcp://5000

cfg/multiplexer_cfg.py

@@ -0,0 +1,6 @@
+Node('multiplexer',
+    'multiplexer node',
+    'tcp://5000',
+    cls = 'protocol.router.Router',
+    nodes = ['localhost:10768', 'localhost:10769'],
+)

cfg/network_analyser_cfg.py

@@ -0,0 +1,5 @@
+import frappy.core as fc
+
+Node('example_NA.psi.ch', 'A demo system showing how to connect network analysers', interface='tcp://5000')
+
+Mod('ZVLNode', 'frappy_psi.network_analysers.ZVL.ZVLNode.ZVLNode', 'ZVL Network Analyser', analyser_ip=Param('169.254.150.182')) # must be connected on the same ethernet network

cfg/nmr_scout_cfg.py

@@ -0,0 +1,14 @@
+import frappy.core as fc
+
+docstring = 'NMR pulse sequence.\
+Each pulse ``block`` consists of first a pulse with parameters pulse_width (microseconds), pulse_height (amplitude; for the SCOUT, percentage of max), and phase_cycle, and then a delay with parameter delay_time (microseconds).\
+\
+Please use the custom commands, ``generate_pulse``, ``scan_sequence``, and ``scan_sequences``. There exist example scripts in your NICOS install location/nicos_sinq/tnmr/example_scripts.\
+Durations are in microseconds, excepting post_acquisition_time (ms), and frequencies are in MHz.\
+'
+
+Node('example_TNMR.psi.ch', 'The NMR system running the Scout and controlled with TNMR', interface='tcp://5000')
+
+Mod('daq_scout', 'frappy_psi.tnmr.TNMRModule.TNMRModule', 'Tecmag SCOUT-based NMR System')
+
+print('TNMR Module loaded - please refer to https://www.psi.ch/en/lin/nmr-spectroscopy for help and documentation')

cfg/ppms.cfg

@@ -1,124 +0,0 @@
-[NODE]
-id = PPMS.psi.ch
-description = PPMS at PSI
-
-[INTERFACE]
-uri = tcp://5000
-
-[tt]
-class = secop_psi.ppms.Temp
-description = main temperature
-iodev = ppms
-
-[mf]
-class = secop_psi.ppms.Field
-target.min = -9
-target.max = 9
-.description = magnetic field
-.iodev = ppms
-
-[pos]
-class = secop_psi.ppms.Position
-.description = sample rotator
-.iodev = ppms
-
-[lev]
-class = secop_psi.ppms.Level
-.description = helium level
-.iodev = ppms
-
-[chamber]
-class = secop_psi.ppms.Chamber
-.description = chamber state
-.iodev = ppms
-
-[r1]
-class = secop_psi.ppms.BridgeChannel
-.description = resistivity channel 1
-.no = 1
-value.unit = Ohm
-.iodev = ppms
-
-[r2]
-class = secop_psi.ppms.BridgeChannel
-.description = resistivity channel 2
-.no = 2
-value.unit = Ohm
-.iodev = ppms
-
-[r3]
-class = secop_psi.ppms.BridgeChannel
-.description = resistivity channel 3
-.no = 3
-value.unit = Ohm
-.iodev = ppms
-
-[r4]
-class = secop_psi.ppms.BridgeChannel
-.description = resistivity channel 4
-.no = 4
-value.unit = Ohm
-.iodev = ppms
-
-[i1]
-class = secop_psi.ppms.Channel
-.description = current channel 1
-.no = 1
-value.unit = uA
-.iodev = ppms
-
-[i2]
-class = secop_psi.ppms.Channel
-.description = current channel 2
-.no = 2
-value.unit = uA
-.iodev = ppms
-
-[i3]
-class = secop_psi.ppms.Channel
-.description = current channel 3
-.no = 3
-value.unit = uA
-.iodev = ppms
-
-[i4]
-class = secop_psi.ppms.Channel
-.description = current channel 4
-.no = 4
-value.unit = uA
-.iodev = ppms
-
-[v1]
-class = secop_psi.ppms.DriverChannel
-.description = voltage channel 1
-.no = 1
-value.unit = V
-.iodev = ppms
-
-[v2]
-class = secop_psi.ppms.DriverChannel
-.description = voltage channel 2
-.no = 2
-value.unit = V
-.iodev = ppms
-
-[tv]
-class = secop_psi.ppms.UserChannel
-.description = VTI temperature
-enabled = 1
-value.unit = K
-.iodev = ppms
-
-[ts]
-class = secop_psi.ppms.UserChannel
-.description = sample temperature
-enabled = 1
-value.unit = K
-.iodev = ppms
-
-[ppms]
-class = secop_psi.ppms.Main
-.description = the main and poller module
-.class_id = QD.MULTIVU.PPMS.1
-.visibility = 3
-pollinterval = 2

cfg/ppms_cfg.py

@@ -0,0 +1,93 @@
+Node('PPMS.psi.ch',
+    'PPMS at PSI',
+    'tcp://5000',
+)
+
+Mod('tt',
+    'frappy_psi.ppms.Temp',
+    'main temperature',
+    io = 'ppms',
+)
+
+Mod('mf',
+    'frappy_psi.ppms.Field',
+    'magnetic field',
+    target = Param(min=-9, max=9),
+    io = 'ppms',
+)
+
+Mod('pos',
+    'frappy_psi.ppms.Position',
+    'sample rotator',
+    io = 'ppms',
+)
+
+Mod('lev',
+    'frappy_psi.ppms.Level',
+    'helium level',
+    io = 'ppms',
+)
+
+Mod('chamber',
+    'frappy_psi.ppms.Chamber',
+    'chamber state',
+    io = 'ppms',
+)
+
+for i in range(1,5):
+    Mod('r%d' % i,
+        'frappy_psi.ppms.BridgeChannel',
+        'resistivity channel %d' % i,
+        no = i,
+        value = Param(unit = 'Ohm'),
+        io = 'ppms',
+    )
+
+for i in range(1,5):
+    Mod('i%d' % i,
+        'frappy_psi.ppms.Channel',
+        'current channel %d' % i,
+        no = i,
+        value = Param(unit = 'uA'),
+        io = 'ppms',
+    )
+
+Mod('v1',
+    'frappy_psi.ppms.DriverChannel',
+    'voltage channel 1',
+    no = 1,
+    value = Param(unit = 'V'),
+    io = 'ppms',
+)
+
+Mod('v2',
+    'frappy_psi.ppms.DriverChannel',
+    'voltage channel 2',
+    no = 2,
+    value = Param(unit = 'V'),
+    io = 'ppms',
+)
+
+Mod('tv',
+    'frappy_psi.ppms.UserChannel',
+    'VTI temperature',
+    enabled = 1,
+    value = Param(unit = 'K'),
+    io = 'ppms',
+)
+
+Mod('ts',
+    'frappy_psi.ppms.UserChannel',
+    'sample temperature',
+    enabled = 1,
+    value = Param(unit = 'K'),
+    io = 'ppms',
+)
+
+Mod('ppms',
+    'frappy_psi.ppms.Main',
+    'the main and poller module',
+    class_id = 'QD.MULTIVU.PPMS.1',
+    visibility = 3,
+    pollinterval = 2,
+)

cfg/ppms_proxy_test.cfg

@@ -1,22 +0,0 @@
-[node filtered.PPMS.psi.ch]
-description = filtered PPMS at PSI
-
-[interface tcp]
-type = tcp
-bindto = 0.0.0.0
-bindport = 5002
-
-[module secnode]
-class = secop.SecNode
-description = a SEC node
-uri = tcp://localhost:5000
-
-[module mf]
-class = secop.Proxy
-remote_class = secop_psi.ppms.Field
-description = magnetic field
-iodev = secnode
-value.min = -0.1
-value.max = 0.1
-target.min = -8
-target.max = 8

cfg/ppms_proxy_test_cfg.py

@@ -0,0 +1,21 @@
+Node('filtered.PPMS.psi.ch',
+    'filtered PPMS at PSI',
+    'tcp://5002',
+)
+
+
+Mod('secnode',
+    'frappy.proxy.SecNode',
+    'a SEC node',
+    uri = 'tcp://localhost:5000',
+)
+
+Mod('mf',
+    'frappy.proxy.Proxy',
+    'magnetic field',
+    remote_class = 'frappy_psi.ppms.Field',
+    io = 'secnode',
+
+    value = Param(),
+    target = Param(min=-0.1, max=0.1),
+)

cfg/psi_nmr_setup_cfg.py

@@ -0,0 +1,34 @@
+import frappy.core as fc
+
+enabled_modules = [ 'TNMR', 'Razorbill', 'Capacitance', 'NetAnalyser' ] # default
+#enabled_modules = [ 'Capacitance' ]
+
+Node('uniaxial_nmr.psi.ch', 
+    'The NMR system running the Scout and controlled with TNMR. Also contains a uniaxial cell (Razorbill RP100), a network analyser (ZVL), and a capacitance reader (for more direct measurements of the strain cell\'s status) (TSSOP16 with Arduino Nano V3)', 
+    interface='tcp://5000')
+
+# TNMR
+if('TNMR' in enabled_modules):
+    Mod('tnmr_otf_module', 'frappy_psi.tnmr.OTFModule.ProgrammedSequence', 'NMR Sequence')
+
+# Razorbill RP100
+if('Razorbill' in enabled_modules):
+    Mod('io_razorbill',
+        'frappy_psi.uniaxial_cell.RP100.RP100IO',
+        'communication',
+        uri='serial://COM3?baudrate=9600+bytesize=8+parity=none+stopbits=1')
+    Mod('RP100Node_CH1', 'frappy_psi.uniaxial_cell.RP100.VoltageChannel', 'Razorbill RP100 PSU (CH1)', channel=1, io='io_razorbill')
+    Mod('RP100Node_CH2', 'frappy_psi.uniaxial_cell.RP100.VoltageChannel', 'Razorbill RP100 PSU (CH2)', channel=2, io='io_razorbill')
+
+# Capacitance readings (TSSOP16 with Arduino Nano V3)
+if('Capacitance' in enabled_modules):
+    Mod('io_capacitance',
+        'frappy_psi.capacitance_readings.TSSOP16.TSSOP16_IO',
+        'communication',
+        uri='serial://COM5?baudrate=9600+bytesize=8+parity=none+stopbits=1')
+
+    Mod('TSSOP16', 'frappy_psi.capacitance_readings.TSSOP16.TSSOP16', 'Capacitance-reading Arduino (with TSSOP16)', io='io_capacitance')
+
+# ZVL Network Analyser
+if('NetAnalyser' in enabled_modules):
+    Mod('ZVLNode', 'frappy_psi.network_analysers.ZVL.ZVLNode.ZVLNode', 'ZVL Network Analyser', analyser_ip=Param('129.129.156.201')) # must be connected on the same ethernet network

cfg/razorbill_rp100_cfg.py

@@ -0,0 +1,12 @@
+import frappy.core as fc
+import serial
+
+Node('example_RP100.psi.ch', 'A demo system showing how to connect the Razorbill PSU', interface='tcp://5000')
+
+Mod('io1',
+    'frappy_psi.uniaxial_cell.RP100.RP100IO',
+    'communication',
+    uri='serial://COM10?baudrate=9600+bytesize=8+parity=none+stopbits=1')
+
+Mod('RP100Node_CH1', 'frappy_psi.uniaxial_cell.RP100.VoltageChannel', 'Razorbill RP100 PSU (CH1)', channel=1, io='io1')
+Mod('RP100Node_CH2', 'frappy_psi.uniaxial_cell.RP100.VoltageChannel', 'Razorbill RP100 PSU (CH2)', channel=2, io='io1')

cfg/router.cfg

@@ -1,8 +0,0 @@
-[NODE]
-id = router
-class = protocol.router.Router
-description = router node
-node = localhost:5000
-
-[INTERFACE]
-uri=tcp://5002

cfg/router_cfg.py

@@ -0,0 +1,6 @@
+Node('router',
+    'router node',
+    'tcp://5002',
+    cls = 'protocol.router.Router',
+    node = 'localhost:5000',
+)

cfg/seop_cfg.py

@@ -0,0 +1,43 @@
+description = """
+3He system in Lab ...
+"""
+Node('mlz_seop',
+    description,
+    'tcp://10767',
+)
+
+Mod('cell',
+    'frappy_mlz.seop.Cell',
+    'interface module to the driver',
+    config_directory = '/home/jcns/daemon/config',
+)
+
+Mod('afp',
+    'frappy_mlz.seop.Afp',
+    'controls the afp flip of the cell',
+    cell = 'cell'
+)
+
+Mod('nmr',
+    'frappy_mlz.seop.Nmr',
+    'controls the ',
+    cell = 'cell'
+)
+
+fitparams = [
+    ('amplitude', 'V'),
+    ('T1', 's'),
+    ('T2', 's'),
+    ('b', ''),
+    ('frequency', 'Hz'),
+    ('phase', 'deg'),
+]
+for param, unit in fitparams:
+    Mod(f'nmr_{param.lower()}',
+        'frappy_mlz.seop.FitParam',
+        f'fittet parameter {param} of NMR',
+        cell = 'cell',
+        value = Param(unit=unit),
+        sigma = Param(unit=unit),
+        param = param,
+    )

cfg/sim.cfg

@@ -1,23 +0,0 @@
-[node test config]
-description=description of the simulation sec-node
-	.
-	Testing simulation dummy setup.
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-
-[module sim]
-class=secop.simulation.SimDrivable
-.description=simulation stuff
-.extra_params=param3,param4,jitter,ramp
-param3.datatype={"type":"bool"}
-param3.default=True
-param3.readonly=False
-jitter.default=1
-ramp.default=60
-value.default=123
-target.default=42
-

cfg/sim_cfg.py

@@ -0,0 +1,18 @@
+Node('sim.test.config',
+    'description of the simulation sec-node\n'
+    '\n'
+    'Testing simulation dummy setup.',
+    'tcp://10767',
+)
+
+
+Mod('sim',
+    'frappy.simulation.SimDrivable',
+    'simulation stuff',
+    extra_params = 'param3,param4,jitter,ramp',
+    param3 = Param(default=True, datatype={'type': 'bool'}, readonly=False),
+    jitter = 1,
+    ramp = 60,
+    value = 123,
+    target = 42,
+)

cfg/sim_mlz_amagnet.cfg

@@ -1,116 +0,0 @@
-[node SIM_MLZ_amagnet(Garfield)]
-description=MLZ-Amagnet
-	.
-	Water cooled magnet from ANTARES@MLZ.
-	.
-        Use module to control the magnetic field.
-	Don't forget to select symmetry first (can be moved only at zero field!).
-	.
-	Monitor T1..T4 (Coil temps), if they get to hot, field will ramp down!
-	.
-	In case of Problems, contact the ANTARES people at MLZ.
-
-visibility=expert
-foo=bar
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module enable]
-class=secop.simulation.SimWritable
-value.datatype={"type":"enum", "members":{'On':1,'Off':0}}
-target.datatype={"type":"enum", "members":{'On':1,'Off':0}}
-.description='Enables to Output of the Powersupply'
-.visibility='advanced'
-
-[module polarity]
-class=secop.simulation.SimWritable
-value.datatype={"type":"enum", "members":{'+1':1,'0':0,'-1':-1}}
-target.datatype={"type":"enum", "members":{'+1':1,'0':0,'-1':-1}}
-.description=polarity (+/-) switch
-	.
-	there is an interlock in the plc:
-	if there is current, switching polarity is forbidden
-	if polarity is short, powersupply is disabled
-.visibility=advanced
-
-
-[module symmetry]
-class=secop.simulation.SimWritable
-value.datatype={"type":"enum", "members":{'symmetric':1,'short':0, 'asymmetric':-1}}
-target.datatype={"type":"enum", "members":{'symmetric':1,'short':0, 'asymmetric':-1}}
-.description=par/ser switch selecting (a)symmetric mode
-	.
-	note: on the front panel symmetric is ser, asymmetric is par
-.visibility=advanced
-value.default = 'symmetric'
-
-[module T1]
-class=secop.simulation.SimReadable
-.description=Temperature1 of the coils system
-value.unit='degC'
-value.default = 23.45
-
-[module T2]
-class=secop.simulation.SimReadable
-.description=Temperature2 of the coils system
-value.unit='degC'
-value.default = 23.45
-
-[module T3]
-class=secop.simulation.SimReadable
-.description=Temperature3 of the coils system
-value.unit='degC'
-value.default = 23.45
-
-[module T4]
-class=secop.simulation.SimReadable
-.description=Temperature4 of the coils system
-value.unit='degC'
-value.default = 23.45
-
-[module currentsource]
-class=secop.simulation.SimDrivable
-.description=Device for the magnet power supply (current mode)
-abslimits=(0,200)
-speed=1
-ramp=60
-precision=0.02
-current=0
-voltage=10
-.visibility=advanced
-.extra_params = abslimits, speed, ramp, precision, current, voltage, window
-abslimits.datatype = {"type":"limit", "members":{"type":"double", "min":0, "max":200, "unit":"A"}}
-abslimits.default = (0, 200)
-speed.datatype = {"type":"double", "min":0, "max":10, "unit":"A/s"}
-speed.default = 10
-ramp.datatype = {"type":"double", "min":0, "max":600, "unit":"A/min"}
-ramp.default = 600
-precision.datatype = {"type":"double", "unit":"A"}
-precision.default = 0.1
-current.datatype = {"type":"double", "min":0, "max":200, "unit":"A"}
-current.default = 0
-voltage.datatype = {"type":"double", "min":0, "max":10, "unit":"V"}
-voltage.default = 0
-window.datatype = {"type":"double", "min":0, "max":120, "unit":"s"}
-window.default = 10
-
-[module mf]
-class=secop_mlz.amagnet.GarfieldMagnet
-.description=magnetic field module, handling polarity switching and stuff
-subdev_currentsource=currentsource
-subdev_enable=enable
-subdev_polswitch=polarity
-subdev_symmetry=symmetry
-target.unit='T'
-value.unit='T'
-userlimits=(-0.35, 0.35)
-calibrationtable={'symmetric':[0.00186517, 0.0431937, -0.185956, 0.0599757, 0.194042],
-	'short': [0.0, 0.0, 0.0, 0.0, 0.0],
-	'asymmetric':[0.00136154, 0.027454, -0.120951, 0.0495289, 0.110689]}
-.meaning=["magneticfield", 20]
-.visibility=user
-
-abslimits.default=-0.4,0.4

cfg/sim_mlz_amagnet_cfg.py

@@ -0,0 +1,116 @@
+Node('SIM_MLZ_amagnet(Garfield)',
+    'MLZ-Amagnet\n'
+    '\n'
+    'Water cooled magnet from ANTARES@MLZ.\n'
+    '\n'
+    '    Use module to control the magnetic field.\n'
+    'Don\'t forget to select symmetry first (can be moved only at zero field!).\n'
+    '\n'
+    'Monitor T1..T4 (Coil temps), if they get to hot, field will ramp down!\n'
+    '\n'
+    'In case of Problems, contact the ANTARES people at MLZ.',
+    'tcp://10767',
+    visibility = 'expert',
+    foo = 'bar',
+)
+
+Mod('enable',
+    'frappy.simulation.SimWritable',
+    'Enables to Output of the Powersupply',
+    value = Param(datatype={"type":"enum", "members":{'On':1,'Off':0}}),
+    target = Param(datatype={"type":"enum", "members":{'On':1,'Off':0}}),
+    visibility = 'advanced',
+)
+
+Mod('polarity',
+    'frappy.simulation.SimWritable',
+    'polarity (+/-) switch\n'
+    '\n'
+    'there is an interlock in the plc:\n'
+    'if there is current, switching polarity is forbidden\n'
+    'if polarity is short, powersupply is disabled',
+    value = Param(datatype={"type":"enum", "members":{'+1':1,'0':0,'-1':-1}}),
+    target = Param(datatype={"type":"enum", "members":{'+1':1,'0':0,'-1':-1}}),
+    visibility = 'advanced',
+)
+
+
+Mod('symmetry',
+    'frappy.simulation.SimWritable',
+    'par/ser switch selecting (a)symmetric mode\n'
+    '\n'
+    'note: on the front panel symmetric is ser, asymmetric is par',
+    value = Param(
+        datatype={"type":"enum", "members":{'symmetric':1,'short':0, 'asymmetric':-1}},
+        default = 'symmetric'
+        ),
+    target = Param(datatype={"type":"enum", "members":{'symmetric':1,'short':0, 'asymmetric':-1}}),
+    visibility = 'advanced',
+)
+
+for i in range(1,5):
+    Mod('T%d' % i,
+        'frappy.simulation.SimReadable',
+        'Temperature%d of the coils system' % i,
+        value = Param(default = 23.45, unit='degC'),
+    )
+
+Mod('currentsource',
+    'frappy.simulation.SimDrivable',
+    'Device for the magnet power supply (current mode)',
+    value = 0,
+    #abslimits = (0,200),
+    #speed = 1,
+    #ramp = 60,
+    #precision = 0.02,
+    #current = 0,
+    #voltage = 10,
+    visibility = 'advanced',
+    extra_params = 'abslimits, speed, ramp, precision, current, voltage, window',
+    abslimits = Param(
+        default = (0, 200),
+        datatype = {"type":"limit", "members":{"type":"double", "min":0, "max":200, "unit":"A"}}
+    ),
+    speed = Param(
+        default = 10,
+        datatype = {"type":"double", "min":0, "max":10, "unit":"A/s"}
+        ),
+    ramp = Param(
+        default = 600,
+        datatype = {"type":"double", "min":0, "max":600, "unit":"A/min"}
+        ),
+    precision = Param(
+        default = 0.1,
+        datatype = {"type":"double", "unit":"A"}
+        ),
+    current = Param(
+        default = 0,
+        datatype = {"type":"double", "min":0, "max":200, "unit":"A"}
+        ),
+    voltage = Param(
+        default = 0,
+        datatype = {"type":"double", "min":0, "max":10, "unit":"V"}
+        ),
+    window = Param(
+        default = 10,
+        datatype = {"type":"double", "min":0, "max":120, "unit":"s"}
+    )
+)
+
+Mod('mf',
+    'frappy_mlz.amagnet.GarfieldMagnet',
+    'magnetic field module, handling polarity switching and stuff',
+    currentsource='currentsource',
+    enable='enable',
+    polswitch='polarity',
+    symmetry='symmetry',
+    target = Param(unit='T'),
+    value = Param(unit='T'),
+    userlimits=(-0.35, 0.35),
+    calibrationtable={'symmetric':[0.00186517, 0.0431937, -0.185956, 0.0599757, 0.194042],
+        'short': [0.0, 0.0, 0.0, 0.0, 0.0],
+        'asymmetric':[0.00136154, 0.027454, -0.120951, 0.0495289, 0.110689]},
+    meaning=("magneticfield", 20),
+    visibility='user',
+    abslimits=(-0.4,0.4),
+)

cfg/sim_mlz_cci3he1.cfg

@@ -1,93 +0,0 @@
-[node cci3he1]
-description = [sim] cci3he box of MLZ Sample environment group
-	.
-	Controls an 3He insert with an ls370 and an PLC controlling
-        the compressor and the valves of the gas handling.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_cci3he1]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of cci3he1.
-	.
-	Controls the regulation loop of the ls370.
-value.datatype={"type":"double","unit":"K"}
-value.default=300
-target.datatype={"type":"double", "min":0, "max":300, "unit":"K"}
-target.default=300
-.extra_params=ramp
-ramp.datatype={"type":"double","min":0,"max":600,"unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-.meaning=["temperature_regulation",40]
-
-[module T_cci3he1_A]
-class=secop.simulation.SimReadable
-.description=3He pot temperature sensor. Also used for the regulation.
-.visibility=expert
-value.default=300
-value.datatype={"type":"double","unit":"K"}
-.meaning=["temperature",38]
-
-[module T_cci3he1_B]
-class=secop.simulation.SimReadable
-.description=(optional) sample temperature sensor close to sample.
-.visibility=user
-value.default=300
-value.datatype={"type":"double","unit":"K"}
-.meaning=["temperature",39]
-
-[module cci3he1_p1]
-class=secop.simulation.SimReadable
-.description=Pressure at turbo pump inlet.
-.visibility=expert
-value.default=2e-3
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_p2]
-class=secop.simulation.SimReadable
-.description=Pressure at turbo pump outlet.
-.visibility=expert
-value.default=9.87
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_p3]
-class=secop.simulation.SimReadable
-.description=Pressure at compressor inlet.
-.visibility=expert
-value.default=19.99
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_p4]
-class=secop.simulation.SimReadable
-.description=Pressure at compressor outlet.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_p5]
-class=secop.simulation.SimReadable
-.description=Pressure in dump tank.
-.visibility=expert
-value.default=567
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_p6]
-class=secop.simulation.SimReadable
-.description=Pressure in the vacuum dewar (ivc).
-.visibility=expert
-value.default=1e-3
-value.datatype={"type":"double","unit":"mbar"}
-
-[module cci3he1_flow]
-class=secop.simulation.SimReadable
-.description=Gas Flow (condensing line).
-.visibility=expert
-value.default=12.34
-value.datatype={"type":"double","unit":"mln/min"}
-
-# note: all valves and switches are missing: use VNC to control them

cfg/sim_mlz_cci3he1_cfg.py

@@ -0,0 +1,88 @@
+Node('cci3he1',
+    '[sim] cci3he box of MLZ Sample environment group\n'
+    '\n'
+    'Controls an 3He insert with an ls370 and an PLC controlling \n'
+    'the compressor and the valves of the gas handling.',
+    'tcp://10767',
+)
+
+Mod('T_cci3he1',
+    'frappy.simulation.SimDrivable',
+    'Main temperature control node of cci3he1.\n'
+    '\n'
+    'Controls the regulation loop of the ls370.',
+    value = Param(default=300, datatype={"type":"double","unit":"K"}),
+    target = Param(default=300, datatype={"type":"double", "min":0, "max":300, "unit":"K"}),
+    extra_params='ramp',
+    ramp = Param(default=60,
+        datatype={"type":"double","min":0,"max":600,"unit":"K/min"},
+        description='target ramping speed in K/min.',
+    ),
+    meaning=["temperature_regulation",40]
+)
+
+Mod('T_cci3he1_A',
+    'frappy.simulation.SimReadable',
+    '3He pot temperature sensor. Also used for the regulation.',
+    visibility='expert',
+    value = Param(default=300, datatype={"type":"double","unit":"K"}),
+    meaning=["temperature",38]
+)
+
+Mod('T_cci3he1_B',
+    'frappy.simulation.SimReadable',
+    '(optional) sample temperature sensor close to sample.',
+    visibility='user',
+    value = Param(default=300, datatype={"type":"double","unit":"K"}),
+    meaning=["temperature",39]
+)
+
+Mod('cci3he1_p1',
+    'frappy.simulation.SimReadable',
+    'Pressure at turbo pump inlet.',
+    value = Param(default=2e-3, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_p2',
+    'frappy.simulation.SimReadable',
+    'Pressure at turbo pump outlet.',
+    value = Param(default=9.87, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_p3',
+    'frappy.simulation.SimReadable',
+    'Pressure at compressor inlet.',
+    value = Param(default=19.99, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_p4',
+    'frappy.simulation.SimReadable',
+    'Pressure at compressor outlet.',
+    value = Param(default=999, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_p5',
+    'frappy.simulation.SimReadable',
+    'Pressure in dump tank.',
+    value = Param(default=567, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_p6',
+    'frappy.simulation.SimReadable',
+    'Pressure in the vacuum dewar (ivc).',
+    value = Param(default=1e-3, datatype={"type":"double","unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('cci3he1_flow',
+    'frappy.simulation.SimReadable',
+    'Gas Flow (condensing line).',
+    value = Param(default=12.34, datatype={"type":"double","unit":"mln/min"}),
+    visibility='expert',
+)
+# note: all valves and switches are missing: use VNC to control them

cfg/sim_mlz_ccidu1.cfg

@@ -1,107 +0,0 @@
-[node ccidu1]
-description = [sim] ccidu box of MLZ Sample environment group
-	.
-	Controls an 3He/4He dilution insert with an ls372 and an PLC controlling
-        the compressor and the valves of the gas handling.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_ccidu1]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of ccidu1.
-	.
-	Controls the regulation loop of the ls372.
-value.unit='K'
-value.default=300
-target.datatype={"type":"double", "min":0, "max":300, "unit":"K"}
-target.default=300
-.extra_params=ramp
-ramp.datatype={"type":"double", "min":0, "max":600, "unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-.meaning=["temperature_regulation",40]
-
-[module T_ccidu1_A]
-class=secop.simulation.SimReadable
-.description=mixing chamber temperature sensor. Also used for the regulation.
-.visibility=expert
-value.default=300
-value.datatype={"type":"double", "unit":"K"}
-.meaning=["temperature",38]
-
-[module T_ccidu1_B]
-class=secop.simulation.SimReadable
-.description=(optional) sample temperature sensor close to sample.
-.visibility=user
-value.default=300
-value.datatype={"type":"double", "unit":"K"}
-.meaning=["temperature",39]
-
-[module ccidu1_pstill]
-class=secop.simulation.SimReadable
-.description=Pressure at the still/turbo pump inlet.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_pinlet]
-class=secop.simulation.SimReadable
-.description=Pressure at forepump inlet/turbo pump outlet.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_poutlet]
-class=secop.simulation.SimReadable
-.description=Pressure at forepump outlet/compressor inlet.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_pkond]
-class=secop.simulation.SimReadable
-.description=Pressure at condensing line/compressor outlet.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_ptank]
-class=secop.simulation.SimReadable
-.description=Pressure in dump tank.
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_pvac]
-class=secop.simulation.SimReadable
-.description=Pressure in the vacuum dewar (ivc).
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-[module ccidu1_flow]
-class=secop.simulation.SimReadable
-.description=Gas Flow (condensing line).
-.visibility=expert
-value.default=999
-value.datatype={"type":"double", "unit":"mbar"}
-
-# note: all valves and switches are missing: use VNC to control them
-[module ccidu1_V6]
-class=secop.simulation.SimDrivable
-.description=Needle valve
-.visibility=expert
-value.default=99
-value.datatype={"type":"double", "min":0, "max":100, "unit":"%%"}
-
-[module ccidu1_V3]
-class=secop.simulation.SimWritable
-.description=Dump Valve
-.visibility=expert
-value.default="OFF"
-value.datatype={"type":"enum", "members":{"on": 1, "OFF":0}}
-target.datatype={"type":"enum", "members":{"on": 1, "OFF":0}}

cfg/sim_mlz_ccidu1_cfg.py

@@ -0,0 +1,107 @@
+Node('ccidu1',
+    '[sim] ccidu box of MLZ Sample environment group\n'
+    '\n'
+    'Controls an 3He/4He dilution insert with an ls372 and an PLC controlling\n'
+    'the compressor and the valves of the gas handling.',
+    'tcp://10767',
+)
+
+Mod('T_ccidu1',
+    'frappy.simulation.SimDrivable',
+    'Main temperature control node of ccidu1.\n'
+    '\n'
+    'Controls the regulation loop of the ls372.',
+    value = Param(default=300, unit='K'),
+    target = Param(default=300, datatype={"type":"double", "min":0, "max":300, "unit":"K"}),
+    extra_params='ramp',
+    ramp = Param(default=60,
+        datatype={"type":"double", "min":0, "max":600, "unit":"K/min"},
+        description='target ramping speed in K/min.',
+    ),
+    meaning=["temperature_regulation",40]
+)
+
+Mod('T_ccidu1_A',
+    'frappy.simulation.SimReadable',
+    'mixing chamber temperature sensor. Also used for the regulation.',
+    value = Param(default=300, datatype={"type":"double", "unit":"K"}),
+    visibility='expert',
+    meaning=["temperature",38],
+)
+
+Mod('T_ccidu1_B',
+    'frappy.simulation.SimReadable',
+    '(optional) sample temperature sensor close to sample.',
+    value = Param(default=300, datatype={"type":"double", "unit":"K"}),
+    visibility='user',
+    meaning=["temperature",39],
+)
+
+Mod('ccidu1_pstill',
+    'frappy.simulation.SimReadable',
+    'Pressure at the still/turbo pump inlet.',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_pinlet',
+    'frappy.simulation.SimReadable',
+    'Pressure at forepump inlet/turbo pump outlet.',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_poutlet',
+    'frappy.simulation.SimReadable',
+    'Pressure at forepump outlet/compressor inlet.',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_pkond',
+    'frappy.simulation.SimReadable',
+    'Pressure at condensing line/compressor outlet.',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_ptank',
+    'frappy.simulation.SimReadable',
+    'Pressure in dump tank.',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_pvac',
+    'frappy.simulation.SimReadable',
+    'Pressure in the vacuum dewar (ivc).',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+Mod('ccidu1_flow',
+    'frappy.simulation.SimReadable',
+    'Gas Flow (condensing line).',
+    value = Param(default=999, datatype={"type":"double", "unit":"mbar"}),
+    visibility='expert',
+)
+
+# note: all valves and switches are missing: use VNC to control them
+Mod('ccidu1_V6',
+    'frappy.simulation.SimDrivable',
+    'Needle valve',
+    value = Param(default=99, datatype={"type":"double", "min":0, "max":100, "unit":"%%"}),
+    target = Param(min=0, max=100),
+    visibility='expert',
+)
+
+Mod('ccidu1_V3',
+    'frappy.simulation.SimWritable',
+    'Dump Valve',
+    value = Param(
+        default="OFF",
+        datatype={"type":"enum", "members":{"on": 1, "OFF":0}}
+    ),
+    target = Param(datatype={"type":"enum", "members":{"on": 1, "OFF":0}}),
+    visibility='expert',
+)

cfg/sim_mlz_ccr12.cfg

@@ -1,164 +0,0 @@
-[node ccr12]
-description = [sim] CCR12 box of MLZ Sample environment group
-	.
-	Contains a Lakeshore 336 and an PLC controlling the compressor
-	and some valves.
-	.
-	This is how we use it now.
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_ccr12]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of CCR12.
-	.
-	Switches between regulation on stick and regulation on tube depending on temperature requested.
-	May also pump gas for higher temperatures, if configured.
-    .
-    Note: in nicos this is handled by its own class which manages T_ccr12_stick and T_ccr12_tube.
-          in this simulation this module is isolated.
-.extra_params=ramp
-ramp.datatype={"type":"double", "min":0,"max":60, "unit":"K/min"}
-ramp.default=60
-value.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-value.default=300
-target.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-target.default=300
-.meaning=["temperature_regulation", 20]
-
-[module T_ccr12_stick]
-class=secop.simulation.SimDrivable
-.description=Temperature regulation for the sample stick in ccr12.
-.extra_params=ramp
-ramp.datatype={"type":"double", "min":0,"max":60, "unit":"K/min"}
-ramp.default=60
-value.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-value.default=300
-target.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-target.default=300
-.meaning=["temperature_regulation", 15]
-
-[module T_ccr12_tube]
-class=secop.simulation.SimDrivable
-.description=Temperature regulation for the tube of ccr12.
-.extra_params=ramp
-ramp.datatype={"type":"double", "min":0,"max":60, "unit":"K/min"}
-ramp.default=60
-value.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-value.default=300
-target.datatype={"type":"double", "min":0,"max":600, "unit":"K"}
-target.default=300
-.meaning=["temperature_regulation", 10]
-
-[module T_ccr12_A]
-class=secop.simulation.SimReadable
-.description=(optional) Sample temperature sensor.
-value.datatype={"type":"double", "unit":"K"}
-value.default=300
-.meaning=["temperature", 9]
-
-[module T_ccr12_B]
-class=secop.simulation.SimReadable
-.description=(regulation) temperature sensor on stick.
-value.datatype={"type":"double", "unit":"K"}
-value.default=300
-.meaning=["temperature", 10]
-
-[module T_ccr12_C]
-class=secop.simulation.SimReadable
-.description=Temperature at the coldhead.
-value.datatype={"type":"double", "unit":"K"}
-value.default=70
-.meaning=["temperature", 1]
-
-[module T_ccr12_D]
-class=secop.simulation.SimReadable
-.description=(regulation) temperature at coupling to stick.
-value.datatype={"type":"double", "unit":"K"}
-value.default=80
-.meaning=["temperature", 2]
-
-
-
-[module ccr12_pressure_regulate]
-class=secop.simulation.SimWritable
-.description=Selects on which Sensor the pressure regulation works, or switches it off.
-.visibility=expert
-value.datatype={"type":"enum", "members":{'off':0,'p1':1,'p2':2}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'p1':1,'p2':2}}
-target.default='off'
-
-[module ccr12_compressor]
-class=secop.simulation.SimDrivable
-.description=Switches the compressor for the cooling stage on or off.
-	.
-	Note: This should always be on, except for fast heatup for sample change.
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='on'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='on'
-
-[module ccr12_gas_switch]
-class=secop.simulation.SimWritable
-.description=Switches the gas inlet on or off.
-	.
-	note: in reality this switches itself off after 15min.
-    note: in reality this is interlocked with ccr12_vacuum_switch, only one can be on!
-    note: in this simulation this module is isolated.
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module ccr12_vacuum_switch]
-class=secop.simulation.SimWritable
-.description=Switches the vacuum pumping valve on or off.
-	.
-    note: in reality this is interlocked with ccr12_gas_switch, only one can be on!
-    note: in this simulation this module is isolated.
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module ccr12_p1]
-class=secop.simulation.SimReadable
-.description=Default pressure Sensor, linear scale 0..1000mbar
-value.datatype={"type":"double", "unit":"mbar"}
-value.default=999
-
-[module ccr12_p2]
-class=secop.simulation.SimReadable
-.description=Auxillary pressure Sensor.
-value.datatype={"type":"double", "unit":"mbar"}
-value.default=1e-6
-
-[module ccr12_curve_p2]
-class=secop.simulation.SimWritable
-.description=Curve for Aux pressure Sensor p2
-.visibility=expert
-value.default='TTR100'
-value.datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}}
-target.datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}}
-
-[module ccr12_p1_limits]
-class=secop.simulation.SimWritable
-.description=Limits for pressure regulation in P1.
-.visibility=expert
-value.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-value.default=[0,10]
-target.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-target.default=[0,10]
-
-[module ccr12_p2_limits]
-class=secop.simulation.SimWritable
-.description=Limits for pressure regulation in P2.
-.visibility=expert
-value.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-value.default=[1e-5,1e-3]
-target.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-target.default=[1e-5,1e-3]

cfg/sim_mlz_ccr12_v2.cfg

@@ -1,155 +0,0 @@
-[node ccr12]
-description = [sim] CCR12 box of MLZ Sample environment group
-	.
-	Contains a Lakeshore 336 and an PLC controlling the compressor
-	and some valves.
-	.
-	This is an improved version, how we think it should be.
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_ccr12]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of CCR12.
-	.
-	Switches between regulation on stick and regulation on tube depending on temperature requested.
-	May also pump gas for higher temperatures, if configured.
-	Manual switching of the regulation node is supported via the regulationmode parameter.
-value.datatype={"type":"double", "min":0, "max":600, "unit":"K"}
-value.default=300
-target.datatype={"type":"double", "min":0, "max":600, "unit":"K"}
-target.default=300
-.extra_params=ramp,regulationmode,abslimits,userlimits
-ramp.datatype={"type":"double", "min":0, "max":60, "unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-ramp.readonly=False
-regulationmode.datatype={"type":"enum","members":{"stick":1,"tube":2,"both":3}}
-regulationmode.default='both'
-regulationmode.description=regulate only stick, tube or select based upon the target value.
-regulationmode.readonly=False
-abslimits.datatype={"type":"limit","members":{"type":"double", "min":0,"max":600, "unit":"K"}}
-abslimits.default=[0,600]
-abslimits.description=currently active absolute limits for the setpoint. depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).
-userlimits.datatype={"type":"limit","members":{"type":"double", "min":0,"max":600, "unit":"K"}}
-userlimits.default=[0,300]
-userlimits.description=current user set limits for the setpoint. must be inside abslimits.
-userlimits.readonly=False
-.meaning=["temperature_regulation", 20]
-
-[module T_ccr12_A]
-class=secop.simulation.SimReadable
-.description=(optional) Sample temperature sensor.
-.visibility=expert
-value.datatype={"type":"double", "min":0, "unit":"K"}
-value.default=300
-.meaning=["temperature", 9]
-
-[module T_ccr12_B]
-class=secop.simulation.SimReadable
-.description=(regulation) temperature sensor on stick.
-.visibility=expert
-value.datatype={"type":"double", "min":0, "unit":"K"}
-value.default=300
-.meaning=["temperature", 10]
-
-[module T_ccr12_C]
-class=secop.simulation.SimReadable
-.description=Temperature at the coldhead.
-.visibility=expert
-value.datatype={"type":"double", "min":0, "unit":"K"}
-value.default=70
-.meaning=["temperature", 1]
-
-[module T_ccr12_D]
-class=secop.simulation.SimReadable
-.description=(regulation) temperature at coupling to stick.
-.visibility=expert
-value.datatype={"type":"double", "min":0, "unit":"K"}
-value.default=80
-.meaning=["temperature", 2]
-
-
-
-[module ccr12_pressure_regulation]
-class=secop.simulation.SimReadable
-.description=Simple two-point presssure regulation. the mode parameter selects the readout on which to regulate, or 'none' for no regulation.
-.visibility=user
-.extra_params=switchpoints, mode
-mode.datatype={"type":"enum", "members":{"none":0,"p1":1,"p2":2}}
-mode.description=Select pressure sensor to regulate on, or 'none' to disable regulation.
-mode.default='none'
-# struct is more explicit, but ugly to read....
-switchpoints.datatype={"type":"struct", "members":{"lower":{"type":"double", "unit":"mbar"},"upper":{"type":"double", "unit":"mbar"}}, "optional":["upper","lower"]}
-switchpoints.description=Switching points for regulation. If the selected pressure is below 'lower' value, the gas valve is opened, above 'upper' the value vacuum valve is openend, else both are closed. values for switchpoints are taken from the selected pressure sensors userlimits.
-switchpoints.default={'lower':1e-6,'upper':1e-3}
-switchpoints.readonly=True
-value.datatype={"type":"double", "min":0, "max":1000, "unit":"mbar"}
-value.default = 1e-5
-
-[module ccr12_compressor]
-class=secop.simulation.SimDrivable
-.description=Switches the compressor for the cooling stage on or off.
-	.
-	Note: This should always be on, except for fast heatup for sample change.
-.visibility=user
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-
-[module ccr12_gas_switch]
-class=secop.simulation.SimWritable
-.description=Switches the gas inlet on or off.
-	.
-	note: in reality this switches itself off after 15min.
-    note: in reality this is interlocked with ccr12_vacuum_switch, only one can be on!
-    note: in this simulation this module is isolated.
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module ccr12_vacuum_switch]
-class=secop.simulation.SimWritable
-.description=Switches the vacuum pumping valve on or off.
-	.
-    note: in reality this is interlocked with ccr12_gas_switch, only one can be on!
-    note: in this simulation this module is isolated.
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-value.default='off'
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module ccr12_p1]
-class=secop.simulation.SimReadable
-.description=Default pressure Sensor, linear scale 0..1000 mbar
-    .
-    Good candidate for a 'Sensor' Interface class!
-value.default=999
-value.unit=mbar
-.extra_params=curve, userlimits
-curve.datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}}
-curve.description=Calibration curve for pressure sensor
-curve.default='TTR100'
-userlimits.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-userlimits.default=[1, 100]
-userlimits.description=current user set limits for the pressure regulation.
-userlimits.readonly=False
-
-[module ccr12_p2]
-class=secop.simulation.SimReadable
-.description=Auxillary pressure Sensor.
-value.default=1e-6
-value.unit=mbar
-.extra_params=curve,userlimits
-curve.datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}}
-curve.description=Calibration curve for pressure sensor
-curve.default='PTR90'
-userlimits.datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}}
-userlimits.default=[1e-6, 1e-3]
-userlimits.description=current user set limits for the pressure regulation.
-userlimits.readonly=False
-pollinterval.visibility='expert'

cfg/sim_mlz_ccr12_v2_cfg.py

@@ -0,0 +1,177 @@
+# pylint: skip-file
+Node('ccr12',
+    '[sim] CCR12 box of MLZ Sample environment group'
+    ''
+    'Contains a Lakeshore 336 and an PLC controlling the compressor'
+    'and some valves.'
+    ''
+    'This is an improved version, how we think it should be.',
+    'tcp://10767',
+)
+
+Mod('T_ccr12',
+    'frappy.simulation.SimDrivable',
+    'Main temperature control node of CCR12.'
+    ''
+    'Switches between regulation on stick and regulation on tube depending on temperature requested.'
+    'May also pump gas for higher temperatures, if configured.'
+    'Manual switching of the regulation node is supported via the regulationmode parameter.',
+    value = Param(default=300,
+                datatype={"type":"double", "min":0, "max":600, "unit":"K"}),
+    target = Param(default=300,
+                datatype={"type":"double", "min":0, "max":600, "unit":"K"}),
+    extra_params='ramp,regulationmode,abslimits,userlimits',
+    ramp = Param(
+        default=60,
+        datatype={"type":"double", "min":0, "max":60, "unit":"K/min"},
+        description='target ramping speed in K/min.',
+        readonly=False,
+    ),
+    regulationmode = Param(
+        default='both',
+        datatype={"type":"enum","members":{"stick":1,"tube":2,"both":3}},
+        description='regulate only stick, tube or select based upon the target value.',
+        readonly=False,
+    ),
+    abslimits = Param(
+        default=[0,600],
+        datatype={"type":"limit","members":{"type":"double", "min":0,"max":600, "unit":"K"}},
+        description='currently active absolute limits for the setpoint. depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).',
+    ),
+    userlimits = Param(
+        default=[0,300],
+        datatype={"type":"limit","members":{"type":"double", "min":0,"max":600, "unit":"K"}},
+        description='current user set limits for the setpoint. must be inside abslimits.',
+        readonly=False,
+    ),
+    meaning=["temperature_regulation", 20],
+)
+
+Mod('T_ccr12_A',
+    'frappy.simulation.SimReadable',
+    '(optional) Sample temperature sensor.',
+    value = Param(default=300,
+                datatype={"type":"double", "min":0, "unit":"K"}),
+    visibility='expert',
+    meaning=["temperature", 9],
+)
+
+Mod('T_ccr12_B',
+    'frappy.simulation.SimReadable',
+    '(regulation) temperature sensor on stick.',
+    value = Param(default=300, datatype={"type":"double", "min":0, "unit":"K"}),
+    visibility='expert',
+    meaning=["temperature", 10],
+)
+
+Mod('T_ccr12_C',
+    'frappy.simulation.SimReadable',
+    'Temperature at the coldhead.',
+    value = Param(default=70, datatype={"type":"double", "min":0, "unit":"K"}),
+    visibility='expert',
+    meaning=["temperature", 1],
+)
+
+Mod('T_ccr12_D',
+    'frappy.simulation.SimReadable',
+    '(regulation) temperature at coupling to stick.',
+    value = Param(default=80, datatype={"type":"double", "min":0, "unit":"K"}),
+    visibility='expert',
+    meaning=["temperature", 2],
+)
+
+Mod('ccr12_pressure_regulation',
+    'frappy.simulation.SimReadable',
+    'Simple two-point presssure regulation. the mode parameter selects the readout on which to regulate, or, \'none\' for no regulation.',
+    value = Param(default = 1e-5,
+                datatype={"type":"double", "min":0, "max":1000, "unit":"mbar"}),
+    extra_params='switchpoints, mode',
+    mode = Param(
+        default='none',
+        datatype={"type":"enum", "members":{"none":0,"p1":1,"p2":2}},
+        description='Select pressure sensor to regulate on, or \'none\' to disable regulation.',
+    ),
+    switchpoints = Param(
+        default={'lower':1e-6,'upper':1e-3},
+        # struct is more explicit, but ugly to read....
+        datatype={"type":"struct", "members":{"lower":{"type":"double", "unit":"mbar"},"upper":{"type":"double", "unit":"mbar"}}, "optional":["upper","lower"]},
+        description='Switching points for regulation. If the selected pressure is below \'lower\' value, the gas valve is opened, above \'upper\' the value vacuum valve is openend, else both are closed. values for switchpoints are taken from the selected pressure sensors userlimits.',
+        readonly=True,
+    ),
+    visibility='user',
+)
+
+Mod('ccr12_compressor',
+    'frappy.simulation.SimDrivable',
+    'Switches the compressor for the cooling stage on or off.\n'
+    '\n'
+    'Note: This should always be on, except for fast heatup for sample change.',
+    value = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    visibility='user',
+)
+
+Mod('ccr12_gas_switch',
+    'frappy.simulation.SimWritable',
+    'Switches the gas inlet on or off.\n'
+    '\n'
+    'note: in reality this switches itself off after 15min.\n'
+    'note: in reality this is interlocked with ccr12_vacuum_switch, only one can be on!\n'
+    'note: in this simulation this module is isolated.',
+    value = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+)
+
+Mod('ccr12_vacuum_switch',
+    'frappy.simulation.SimWritable',
+    'Switches the vacuum pumping valve on or off.\n'
+    '\n'
+    'note: in reality this is interlocked with ccr12_gas_switch, only one can be on!\n'
+    'note: in this simulation this module is isolated.',
+    value = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+)
+
+Mod('ccr12_p1',
+    'frappy.simulation.SimReadable',
+    'Default pressure Sensor, linear scale 0..1000 mbar\n'
+    '\n'
+    'Good candidate for a \'Sensor\' Interface class!',
+    value = Param(default=999, unit='mbar'),
+    extra_params='curve, userlimits',
+    curve = Param(
+        default='TTR100',
+        datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}},
+        description='Calibration curve for pressure sensor',
+    ),
+    userlimits = Param(
+        default=[1, 100],
+        datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}},
+        description='current user set limits for the pressure regulation.',
+        readonly=False,
+    ),
+)
+
+Mod('ccr12_p2',
+    'frappy.simulation.SimReadable',
+    'Auxillary pressure Sensor.',
+    value = Param(default=1e-6, unit='mbar'),
+    extra_params='curve,userlimits',
+    curve = Param(
+        default='PTR90',
+        datatype={"type":"enum", "members":{'0..10V':0,'default':1,'0..9V':2,'DI200':3,'DI2000':4,'TTR100':7,'PTR90':8,'PTR225/PTR237':9,'ITR90':10,'ITR100 curve D':11, 'ITR100 curve 2':12, 'ITR100 curve 3':13,'ITR100 curve 4':14,'ITR100 curve 5':15, 'ITR100 curve 6':16, 'ITR100 curve 7':17, 'ITR100 curve 8':18, 'ITR100 curve 9':19, 'ITR100 curve A':20,'CMR361':21, 'CMR362':22, 'CMR363':23, 'CMR364':24, 'CMR365':25}},
+        description='Calibration curve for pressure sensor',
+    ),
+    userlimits = Param(
+        default=[1e-6, 1e-3],
+        datatype={"type":"limit","members":{"type":"double", "min":0,"max":1000, "unit":"mbar"}},
+        description='current user set limits for the pressure regulation.',
+        readonly=False,
+    ),
+    pollinterval = Param(visibility='expert'),
+)

cfg/sim_mlz_entangle_simulation_cfg.py

@@ -0,0 +1,49 @@
+Node('simulation',
+    'Auto-generated configuration by frappy.',
+    'tcp://10767',
+)
+Mod('analoginput',
+    'frappy_mlz.entangle.AnalogInput',
+    'from test/sim/analoginput',
+    tangodevice = 'tango://localhost:10000/test/sim/analoginput',
+)
+Mod('sensor',
+    'frappy_mlz.entangle.Sensor',
+    'from test/sim/sensor',
+    tangodevice = 'tango://localhost:10000/test/sim/sensor',
+)
+Mod('analogoutput',
+    'frappy_mlz.entangle.AnalogOutput',
+    'from test/sim/analogoutput',
+    tangodevice = 'tango://localhost:10000/test/sim/analogoutput',
+)
+Mod('actuator',
+    'frappy_mlz.entangle.Actuator',
+    'from test/sim/actuator',
+    tangodevice = 'tango://localhost:10000/test/sim/actuator',
+)
+Mod('motor',
+    'frappy_mlz.entangle.Motor',
+    'from test/sim/motor',
+    tangodevice = 'tango://localhost:10000/test/sim/motor',
+)
+Mod('powersupply',
+    'frappy_mlz.entangle.PowerSupply',
+    'from test/sim/powersupply',
+    tangodevice = 'tango://localhost:10000/test/sim/powersupply',
+)
+Mod('digitalinput',
+    'frappy_mlz.entangle.DigitalInput',
+    'from test/sim/digitalinput',
+    tangodevice = 'tango://localhost:10000/test/sim/digitalinput',
+)
+Mod('digitaloutput',
+    'frappy_mlz.entangle.DigitalOutput',
+    'from test/sim/digitaloutput',
+    tangodevice = 'tango://localhost:10000/test/sim/digitaloutput',
+)
+Mod('stringio',
+    'frappy_mlz.entangle.StringIO',
+    'from test/sim/stringio',
+    tangodevice = 'tango://localhost:10000/test/sim/stringio',
+)

cfg/sim_mlz_htf02.cfg

@@ -1,33 +0,0 @@
-[node htf02]
-description = [sim] htf02 box of MLZ Sample environment group
-	.
-	Controls an High Temperature Furnace with an eurotherm controller and an PLC checking the cooing water.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_htf02]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of htf02.
-	.
-	Controls the regulation loop of the Eurotherm.
-value.datatype={"type":"double", "min":0, "unit":"degC"}
-value.default=300
-target.datatype={"type":"double", "min":0, "max": 2000, "unit":"degC"}
-target.default=300
-.extra_params=ramp
-ramp.datatype={"type":"double", "min":0, "max": 600, "unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-ramp.readonly=False
-.meaning=["temperature", 10]
-
-[module htf02_p]
-class=secop.simulation.SimReadable
-.description=Pressure Sensor at sample space (ivc).
-value.datatype={"type":"double", "min":0, "unit":"mbar"}
-value.default=989
-

cfg/sim_mlz_htf02_cfg.py

@@ -0,0 +1,30 @@
+Node('htf02',
+    '[sim] htf02 box of MLZ Sample environment group\n'
+    '\n'
+    'Controls an High Temperature Furnace with an eurotherm controller and an PLC checking the cooing water.',
+    'tcp://10767',
+)
+
+Mod('T_htf02',
+    'frappy.simulation.SimDrivable',
+    'Main temperature control node of htf02.\n'
+    '\n'
+    'Controls the regulation loop of the Eurotherm.',
+    value = Param(default=300,
+        datatype={"type":"double", "min":0, "unit":"degC"}),
+    target = Param(default=300,
+        datatype={"type":"double", "min":0, "max": 2000, "unit":"degC"}),
+    extra_params='ramp',
+    ramp = Param(default=60,
+        datatype={"type":"double", "min":0, "max": 600, "unit":"K/min"},
+        description='target ramping speed in K/min.',
+        readonly=False,
+    ),
+    meaning=["temperature", 10],
+)
+
+Mod('htf02_p',
+    'frappy.simulation.SimReadable',
+    'Pressure Sensor at sample space (ivc).',
+    value = Param(default=989, datatype={"type":"double", "min":0, "unit":"mbar"}),
+)

cfg/sim_mlz_stressihtf2.cfg

@@ -1,73 +0,0 @@
-[node stressihtf2]
-description = [sim] Stressihtf2 box of MLZ Sample environment group
-	.
-	Controls an High Temperature Furnace with an Eurotherm and an PLC controlling some valves and checking cooling water.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T_stressihtf2]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of Stressihtf2.
-value.datatype={"type":"double", "min":0, "unit":"degC"}
-value.default=20
-target.datatype={"type":"double", "min":0, "max":2000, "unit":"degC"}
-target.default=20
-.extra_params=ramp,regulationmode,abslimits,userlimits
-ramp.datatype={"type":"double", "min":0, "max":600, "unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-abslimits.datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}}
-abslimits.default=[0,2000]
-abslimits.description=currently active absolute limits for the setpoint. depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).
-userlimits.datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}}
-userlimits.default=[0,300]
-userlimits.description=current user set limits for the setpoint. must be inside abslimits.
-userlimits.readonly=False
-.meaning=['temperature_regulation', 10]
-
-[module T_stressihtf2_sample]
-class=secop.simulation.SimReadable
-.description=(optional) Sample temperature sensor.
-.visibility=expert
-value.default=300
-value.datatype={"type":"double", "min":0, "unit":"degC"}
-.meaning=["temperature", 9]
-
-[module stressihtf2_n2]
-class=secop.simulation.SimWritable
-.description=Switches the N2 gas inlet on or off.
-.visibility=expert
-value.default='off'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module stressihtf2_he]
-class=secop.simulation.SimWritable
-.description=Switches the He gas inlet on or off.
-.visibility=expert
-value.default='off'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module stressihtf2_lamps]
-class=secop.simulation.SimWritable
-.description=Switches the heating lamps on or off.
-.visibility=expert
-value.default='on'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='on'
-
-[module stressihtf2_water_ok]
-class=secop.simulation.SimReadable
-.description=Readout of the cooling water state.
-.visibility=expert
-value.default='ok'
-value.datatype={"type":"enum", "members":{'failed':0,'ok':1}}
-

cfg/sim_mlz_stressihtf2_v2.cfg

@@ -1,73 +0,0 @@
-[node stressihtf2_v2]
-description = [sim] Stressihtf2 box of MLZ Sample environment group
-	.
-	Controls an High Temperature Furnace with an Eurotherm and an PLC controlling some valves and checking cooling water.
-
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T]
-class=secop.simulation.SimDrivable
-.description=Main temperature control node of Stressihtf2.
-value.datatype={"type":"double", "min":0, "unit":"degC"}
-value.default=20
-target.datatype={"type":"double", "min":0, "max":2000, "unit":"degC"}
-target.default=20
-.extra_params=ramp,regulationmode,abslimits,userlimits
-ramp.datatype={"type":"double", "min":0, "max":600, "unit":"K/min"}
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-abslimits.datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}}
-abslimits.default=[0,2000]
-abslimits.description=currently active absolute limits for the setpoint. depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).
-userlimits.datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}}
-userlimits.default=[0,300]
-userlimits.description=current user set limits for the setpoint. must be inside abslimits.
-userlimits.readonly=False
-.meaning=['temperature_regulation', 10]
-
-[module T_sample]
-class=secop.simulation.SimReadable
-.description=(optional) Sample temperature sensor.
-.visibility=expert
-value.default=300
-value.datatype={"type":"double", "min":0, "unit":"degC"}
-.meaning=["temperature", 9]
-
-[module N2]
-class=secop.simulation.SimWritable
-.description=Switches the N2 gas inlet on or off.
-.visibility=expert
-value.default='off'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module He]
-class=secop.simulation.SimWritable
-.description=Switches the He gas inlet on or off.
-.visibility=expert
-value.default='off'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='off'
-
-[module lamps]
-class=secop.simulation.SimWritable
-.description=Switches the heating lamps on or off.
-.visibility=expert
-value.default='on'
-value.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.datatype={"type":"enum", "members":{'off':0,'on':1}}
-target.default='on'
-
-[module water_ok]
-class=secop.simulation.SimReadable
-.description=Readout of the cooling water state.
-.visibility=expert
-value.default='ok'
-value.datatype={"type":"enum", "members":{'failed':0,'ok':1}}
-

cfg/sim_mlz_stressihtf2_v2_cfg.py

@@ -0,0 +1,82 @@
+Node('stressihtf2_v2',
+    '[sim] Stressihtf2 box of MLZ Sample environment group\n'
+    '\n'
+    'Controls an High Temperature Furnace with an Eurotherm and an PLC controlling some valves and checking cooling water.',
+    'tcp://10767',
+)
+
+
+Mod('T',
+    'frappy.simulation.SimDrivable',
+    'Main temperature control node of Stressihtf2.',
+    value = Param(default=20,
+                datatype={"type":"double", "min":0, "unit":"degC"}),
+    target = Param(default=20,
+                datatype={"type":"double", "min":0, "max":2000, "unit":"degC"}),
+    extra_params='ramp,regulationmode,abslimits,userlimits',
+    ramp = Param(
+        default=60,
+        datatype={"type":"double", "min":0, "max":600, "unit":"K/min"},
+        description='target ramping speed in K/min.',
+    ),
+    abslimits = Param(
+        default=[0,2000],
+        datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}},
+        description='currently active absolute limits for the setpoint. depend \
+                on the regulationmode parameter (both/stick->0..600, tube->0..300K).',
+    ),
+    userlimits = Param(
+        default=[0,300],
+        datatype={"type":"limit", "members":{"type":"double", "min":0, "max":2000, "unit":"degC"}},
+        description='current user set limits for the setpoint. must be inside abslimits.',
+        readonly=False,
+    ),
+    meaning=['temperature_regulation', 10],
+)
+
+Mod('T_sample',
+    'frappy.simulation.SimReadable',
+    '(optional) Sample temperature sensor.',
+    value = Param(default=300,
+                datatype={"type":"double", "min":0, "unit":"degC"}),
+    visibility='expert',
+    meaning=["temperature", 9],
+)
+
+Mod('N2',
+    'frappy.simulation.SimWritable',
+    'Switches the N2 gas inlet on or off.',
+    value = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    visibility='expert',
+)
+
+Mod('He',
+    'frappy.simulation.SimWritable',
+    'Switches the He gas inlet on or off.',
+    value = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(default='off',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    visibility='expert',
+)
+
+Mod('lamps',
+    'frappy.simulation.SimWritable',
+    'Switches the heating lamps on or off.',
+    value = Param(default='on',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    target = Param(default='on',
+                datatype={"type":"enum", "members":{'off':0,'on':1}}),
+    visibility='expert',
+)
+
+Mod('water_ok',
+    'frappy.simulation.SimReadable',
+    'Readout of the cooling water state.',
+    value = Param(default='ok',
+                datatype={"type":"enum", "members":{'failed':0,'ok':1}}),
+    visibility='expert',
+)

cfg/softcal.cfg

@@ -1,12 +0,0 @@
-[r3]
-class = secop.core.Proxy
-remote_class = secop.core.Readable
-description = temp sensor on 3He system
-uri = tcp://pc12694:5000
-export = False
-
-[t3]
-class = secop_psi.softcal.Sensor
-rawsensor = r3
-calib = X131346
-value.unit = K

cfg/softcal_cfg.py

@@ -0,0 +1,20 @@
+Node('softcal.demo.example',
+    'convert r2 from PPMS to a temperature',
+    'tcp://5001',
+)
+
+Mod('r2',
+    'frappy.core.Proxy',
+    'convert r2 from PPMS to a temperature',
+    remote_class = 'frappy.core.Readable',
+    uri = 'tcp://localhost:5000',
+    export = False,
+)
+
+Mod('T2',
+    'frappy_psi.softcal.Sensor',
+    '',
+    value = Param(unit = 'K'),
+    rawsensor = 'r2',
+    calib = 'X131346',
+)

cfg/stressihtf2.cfg

@@ -1,83 +0,0 @@
-[node stressihtf2]
-description = Stressihtf2 box of MLZ Sample environment group
-	.
-	Controls an High Temperature Furnace with an Eurotherm and an PLC controlling some valves and checking cooling water.
-
-meaning={'T_regulation':{'T':100}, 'T_sample':{'T_sample':100}}
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10767
-
-[module T]
-class=secop_mlz.entangle.TemperatureController
-tangodevice=tango://localhost:10000/box/eurotherm/ctrl
-.description=Main temperature control node of Stressihtf2.
-value.unit='degC'
-target.datatype=["double", 0, 2000]
-ramp.datatype=["double",0,9999]
-ramp.description=target ramping speed in K/min.
-ramp.default=60
-ramp.unit=K/min
-abslimits.datatype=["tuple",[["double"],["double"]]]
-abslimits.default=[0,2000]
-abslimits.description=currently active absolute limits for the setpoint. depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).
-abslimits.unit='degC'
-abslimits.readonly=True
-userlimits.datatype=["tuple",[["double"],["double"]]]
-userlimits.default=[0,300]
-userlimits.description=current user set limits for the setpoint. must be inside abslimits.
-userlimits.unit='degC'
-heateroutput.datatype=["double",0,100]
-heateroutput.description=output to the heater
-heateroutput.unit='%%'
-heateroutput.default=0
-setpoint.default=0
-p.default=1
-i.default=0
-d.default=0
-pid.default=[1,0,0]
-speed.default=0
-
-[module T_sample_a]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/eurotherm/sensora
-.description=Regulation temperature sensor.
-.visibility=user
-value.unit='degC'
-
-[module T_sample_b]
-class=secop_mlz.entangle.Sensor
-tangodevice=tango://localhost:10000/box/eurotherm/sensorb
-.description=(optional) Sample temperature sensor.
-.visibility=expert
-value.unit='degC'
-
-[module N2]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_gas1
-.description=Switches the N2 gas inlet on or off.
-.visibility=expert
-mapping=dict(off=0,on=1)
-
-[module He]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_gas2
-.description=Switches the He gas inlet on or off.
-.visibility=expert
-mapping=dict(off=0,on=1)
-
-[module lamps]
-class=secop_mlz.entangle.NamedDigitalOutput
-tangodevice=tango://localhost:10000/box/plc/_onoff
-.description=Switches the heating lamps on or off.
-.visibility=expert
-mapping=dict(off=0,on=1)
-
-[module water_ok]
-class=secop_mlz.entangle.NamedDigitalInput
-tangodevice=tango://localhost:10000/box/plc/_waterok
-.description=Readout of the cooling water state.
-.visibility=expert
-mapping=dict(failed=0,ok=1)

cfg/stressihtf2_cfg.py

@@ -0,0 +1,96 @@
+Node('stressihtf2',
+    'Stressihtf2 box of MLZ Sample environment group\n'
+    '\n'
+    'Controls an High Temperature Furnace with an Eurotherm and an PLC controlling some valves and checking cooling water.',
+     'localhost:10767',
+    meaning={'T_regulation':{'T':100}, 'T_sample':{'T_sample':100}},
+)
+
+
+Mod('T',
+    'frappy_mlz.entangle.TemperatureController',
+    'Main temperature control node of Stressihtf2.',
+    tangodevice='tango://localhost:10000/box/eurotherm/ctrl',
+    value = Param(unit='degC'),
+    target = Param(datatype=["double", 0, 2000]),
+    ramp = Param(
+        default=60,
+        datatype=["double",0,9999],
+        unit='K/min',
+        description='target ramping speed in K/min.',
+    ),
+    abslimits = Param(
+        default=[0,2000],
+        datatype=["tuple",[["double"],["double"]]],
+        unit='degC',
+        description='currently active absolute limits for the setpoint.\
+                depend on the regulationmode parameter (both/stick->0..600, tube->0..300K).',
+        readonly=True,
+    ),
+    userlimits = Param(
+        default=[0,300],
+        datatype=["tuple",[["double"],["double"]]],
+        unit='degC',
+        description='current user set limits for the setpoint. must be inside abslimits.',
+    ),
+    heateroutput = Param(
+        default=0,
+        datatype=["double",0,100],
+        unit='%%',
+        description='output to the heater',
+    ),
+    setpoint = 0,
+    p = 1,
+    i = 0,
+    d = 0,
+    pid = [1,0,0],
+    speed = 0,
+)
+
+Mod('T_sample_a',
+    'frappy_mlz.entangle.Sensor',
+    'Regulation temperature sensor.',
+    tangodevice='tango://localhost:10000/box/eurotherm/sensora',
+    value = Param(unit='degC'),
+    visibility='user',
+)
+
+Mod('T_sample_b',
+    'frappy_mlz.entangle.Sensor',
+    '(optional) Sample temperature sensor.',
+    tangodevice='tango://localhost:10000/box/eurotherm/sensorb',
+    value = Param(unit='degC'),
+    visibility='expert',
+)
+
+Mod('N2',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'Switches the N2 gas inlet on or off.',
+    tangodevice='tango://localhost:10000/box/plc/_gas1',
+    mapping={'off':0,'on':1},
+    visibility='expert',
+)
+
+Mod('He',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'Switches the He gas inlet on or off.',
+    tangodevice='tango://localhost:10000/box/plc/_gas2',
+    mapping={'off':0,'on':1},
+    visibility='expert',
+)
+
+Mod('lamps',
+    'frappy_mlz.entangle.NamedDigitalOutput',
+    'Switches the heating lamps on or off.',
+    tangodevice='tango://localhost:10000/box/plc/_onoff',
+    mapping={'off':0,'on':1},
+    visibility='expert',
+)
+
+Mod('water_ok',
+    'frappy_mlz.entangle.NamedDigitalInput',
+    'Readout of the cooling water state.',
+    tangodevice='tango://localhost:10000/box/plc/_waterok',
+    mapping={'failed':0,'ok':1},
+    visibility='expert',
+)

cfg/test.cfg

@@ -1,46 +0,0 @@
-[node test config]
-description=description of the testing sec-node
-	.
-	Here should be the long description.
-	It can be very long.
-        .
-        a single . on a line gets stripped so you can make paragraphs.
-	.
-	These texts are supposed to be possibly very long.
-
-[interface tcp]
-type=tcp
-bindto=0.0.0.0
-bindport=10768
-
-
-[module LN2]
-class=secop_demo.test.LN2
-.description="random value between 0..100%%"
-value.unit = "%%"
-
-[module heater]
-class=secop_demo.test.Heater
-maxheaterpower=10
-.description="some heater"
-
-[module T1]
-class=secop_demo.test.Temp
-sensor="X34598T7"
-.description="some temperature"
-
-[module T2]
-class=secop_demo.modules.CoilTemp
-sensor="X34598T8"
-.description="some temperature"
-
-[module T3]
-class=secop_demo.modules.CoilTemp
-sensor="X34598T9"
-.description="some temperature"
-
-
-[module Lower]
-class=secop_demo.test.Lower
-.description="something else"
-

cfg/test_cfg.py

@@ -0,0 +1,74 @@
+Node('test.config.frappy.demo',
+     '''short description of the testing sec-node
+
+This description for the node can be as long as you need if you use a multiline string.
+
+Very long!
+The needed fields are Equipment id (1st argument), description (this)
+ and the main interface of the node (3rd arg)
+''',
+     'tcp://10768',
+)
+
+Mod('attachtest',
+    'frappy_demo.test.WithAtt',
+    'test attached',
+    att = 'LN2',
+)
+
+Mod('pinata',
+    'frappy_demo.test.Pin',
+    'scan test',
+)
+
+Mod('recursive',
+    'frappy_demo.test.RecPin',
+    'scan test',
+)
+
+Mod('LN2',
+    'frappy_demo.test.LN2',
+    'random value between 0..100%',
+    value = Param(default = 0, unit = '%'),
+)
+
+Mod('heater',
+    'frappy_demo.test.Heater',
+    'some heater',
+    maxheaterpower = 10,
+)
+
+Mod('T1',
+    'frappy_demo.test.Temp',
+    'some temperature',
+    sensor = 'X34598T7',
+)
+
+Mod('T2',
+    'frappy_demo.test.Temp',
+    'some temperature',
+    sensor = 'X34598T8',
+)
+
+Mod('T3',
+    'frappy_demo.test.Temp',
+    'some temperature',
+    sensor = 'X34598T9',
+)
+
+Mod('Lower',
+    'frappy_demo.test.Lower',
+    'something else',
+)
+
+Mod('Decision',
+    'frappy_demo.test.Mapped',
+    'Random value from configured property choices. Config accepts anything ' \
+    'that can be converted to a list',
+    choices = ['Yes', 'Maybe', 'No'],
+)
+
+Mod('c',
+    'frappy_demo.test.Commands',
+    'a command test',
+)

cfg/tssop16_cfg.py

@@ -0,0 +1,11 @@
+import frappy.core as fc
+import serial
+
+Node('example_TSSOP16.psi.ch', 'A demo system showing how to connect the TSSOP16 Arduino', interface='tcp://5000')
+
+Mod('io1',
+    'frappy_psi.capacitance_readings.TSSOP16.TSSOP16_IO',
+    'communication',
+    uri='serial://COM11?baudrate=9600+bytesize=8+parity=none+stopbits=1')
+
+Mod('TSSOP16', 'frappy_psi.capacitance_readings.TSSOP16.TSSOP16', 'Capacitance-reading Arduino (with TSSOP16)', io='io1')

ci/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3-buster AS base
+FROM python:3.9 AS base
 ARG PYVER=python3
 ENV  DEBIAN_FRONTEND=noninteractive
 RUN apt-get update && \
@@ -9,10 +9,11 @@ RUN apt-get update && \
           openssh-client \
           make \
           locales \
+          libgl1 \
           python3 \
           python3-dev \
-          python3-pytango \
-          python3-venv python3-setuptools \
+          python3-venv \
+          python3-setuptools \
           virtualenv
 
 
@@ -33,14 +34,17 @@ RUN virtualenv /home/jenkins/tools2 && \
     rm -rf /home/jenkins/tools2src
 
 RUN virtualenv -p /usr/bin/python3 --system-site-packages /home/jenkins/secopvenv && \
-    git clone https://forge.frm2.tum.de/review/sine2020/secop/playground /home/jenkins/playground && \
+    git clone https://forge.frm2.tum.de/review/secop/frappy /home/jenkins/frappy && \
     . /home/jenkins/secopvenv/bin/activate && \
-    pip install -U pip wheel setuptools && \
-    pip install -r /home/jenkins/playground/requirements-dev.txt -r /home/jenkins/playground/requirements.txt pylint pytest && \
-    rm -rf /home/jenkins/playground
+    pip install -U pip wheel setuptools importlib_metadata && \
+    pip install -r /home/jenkins/frappy/requirements-dev.txt \
+                -r /home/jenkins/frappy/requirements-gui.txt \
+                -r /home/jenkins/frappy/requirements.txt pylint pytest && \
+    rm -rf /home/jenkins/frappy
 
 
 FROM base AS docs
+ARG PYVER=python3
 ENV  DEBIAN_FRONTEND=noninteractive
 
 USER root
@@ -50,6 +54,8 @@ RUN apt-get update && \
      texlive-latex-base \
      texlive-latex-recommended \
      texlive-fonts-recommended \
+     texlive-fonts-extra \
+     tex-gyre \
      texlive-base \
      texlive-binaries \
      latexmk

ci/Jenkinsfile

@@ -4,7 +4,7 @@ properties([
                               daysToKeepStr: '',
                               numToKeepStr: '50')),
     parameters([
-         string(defaultValue: 'sine2020/secop/playground',
+         string(defaultValue: 'secop/frappy',
                 description: '', name: 'GERRIT_PROJECT'),
          string(defaultValue: 'master',
                 description: '', name: 'GERRIT_BRANCH'),
@@ -13,11 +13,6 @@ properties([
          choice(choices: '''\
 patchset-created
 ref-updated
-change-merged''',
-               description: '', name: 'GERRIT_EVENT'),
-         choice(choices: '''\
-patchset-created
-ref-updated
 change-merged''',
                 description: '', name: 'GERRIT_EVENT_TYPE')])
 ])
@@ -41,23 +36,24 @@ git diff HEAD~1... --name-only --diff-filter=ARCM -- \\*.py
 #!/bin/bash -x
 . /home/jenkins/secopvenv/bin/activate
 pip install -r requirements-dev.txt
+pip install -r requirements-gui.txt
 pip install -r requirements.txt
 pip install isort pylint
-python3 setup.py develop
+pip install -e .
 export PYTHONIOENCODING=utf8
 
 echo "$changedFiles"
 if [[  -n "$changedFiles" ]]; then
    set -o pipefail
    pylint $changedFiles | tee pylint_results.txt
-   isort -df $changedFiles | tee isort_results.txt
+   isort --df $changedFiles || true | tee isort_results.txt
 fi
 """
     withCredentials([string(credentialsId: 'GERRITHTTP',
                      variable: 'GERRITHTTP')]) {
         sh """\
-        #!/bin/bash
-	if [ -f pylint_results.txt ] ; then
+#!/bin/bash
+        if [ -f pylint_results.txt ] ; then
           /home/jenkins/tools2/bin/pylint2gerrit
           mv pylint_results.txt pylint-${pyver}.txt
         else
@@ -67,19 +63,11 @@ fi
     } // credentials
 
     echo "pylint result: $res"
-    this.verifyresult.put('pylint'+pyver, 1)
     if ( res != 0 ) {
         currentBuild.result='FAILURE'
-        this.verifyresult.put('pylint'+ pyver, -1)
         status = 'FAILURE'
     }
 
-    gerritverificationpublisher([
-        verifyStatusValue: this.verifyresult['pylint'+pyver],
-        verifyStatusCategory: 'pylint ',
-        verifyStatusName: 'pylint-'+pyver,
-        verifyStatusReporter: 'jenkins',
-        verifyStatusRerun: '!recheck'])
     archiveArtifacts([allowEmptyArchive: true,
                           artifacts: 'pylint-*.txt'])
     recordIssues([enabledForFailure: true,
@@ -90,50 +78,36 @@ fi
                   failedTotalAll: 1])
 
 
-    if (status == 'FAILURE') {
-        throw new Exception('Failure in pylint with ' + pyver)
-    }
   }
 } // run_pylint
 
 
 def run_tests(pyver) {
     stage('Test:' + pyver) {
-       writeFile file: 'setup.cfg', text: '''
+        writeFile file: 'setup.cfg', text: '''
 [tool:pytest]
 addopts = --junit-xml=pytest.xml --junit-prefix=''' + pyver
 
     def status = "OK"
-    verifyresult.put(pyver, 0)
     try {
         timeout(5) {
             sh '''\
 #!/bin/bash
 . /home/jenkins/secopvenv/bin/activate
 pip install -r requirements-dev.txt
+pip install -r requirements-gui.txt
 pip install -r requirements.txt
-python3 setup.py develop
+pip install -e .
 make test
 '''
-        verifyresult.put(pyver, 1)
         }
     } catch (all) {
         currentBuild.result = 'FAILURE'
         status = 'FAILURE'
-        verifyresult.put(pyver, -1)
     }
-    gerritverificationpublisher([
-    verifyStatusValue: verifyresult[pyver],
-    verifyStatusCategory: 'test ',
-    verifyStatusName: 'pytest-'+pyver,
-    verifyStatusReporter: 'jenkins',
-    verifyStatusRerun: '!recheck'])
 
     step([$class: 'JUnitResultArchiver', allowEmptyResults: true,
           keepLongStdio: true, testResults: 'pytest.xml'])
-    if (status == 'FAILURE') {
-        throw new Exception('Failure in test with ' + pyver)
-    }
   }
 }
 
@@ -142,8 +116,9 @@ def run_docs() {
         sh '''
         . /home/jenkins/secopvenv/bin/activate
         pip install -r requirements-dev.txt
+        pip install -r requirements-gui.txt
         pip install -r requirements.txt
-        python3 setup.py develop
+        pip install -e .
         '''
     }
 
@@ -169,12 +144,23 @@ def run_docs() {
         '''
     }
 
+    /* does not work with too many quote levels
+     * alternatively use pdf (based on rst2pdf)
+     * or singlehtml converted to pdf manually from a browser (may produce nicer output)
     stage('build latexpdf') {
         sh '''
         . /home/jenkins/secopvenv/bin/activate
         make -C doc latexpdf
         '''
     }
+    */
+
+    stage('build pdf') {
+        sh '''
+        . /home/jenkins/secopvenv/bin/activate
+        make -C doc pdf
+        '''
+    }
 
     stage('build man') {
         sh '''
@@ -185,15 +171,7 @@ def run_docs() {
 
     stage('store html doc for build') {
         publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: true, reportDir: 'doc/_build/html', reportFiles: 'index.html', reportName: 'Built documentation', reportTitles: ''])
-        gerritverificationpublisher([
-        verifyStatusValue: 1,
-        verifyStatusCategory: 'test ',
-        verifyStatusName: 'doc',
-        verifyStatusReporter: 'jenkins',
-        verifyStatusRerun: '@recheck'
-    ])
     }
-
 }
 
 
@@ -225,16 +203,16 @@ node("dockerhost") {
        sh '''#!/bin/bash
         git worktree add tmpmaster origin/master
         cd tmpmaster
-        docker build --target base --tag secop_base:latest ci
-        docker build --target docs --tag secop_docs:latest ci
+        docker build --target base --tag frappy_base:latest ci
+        docker build --target docs --tag frappy_docs:latest ci
         cd ..
         rm -rf tmpmaster
         '''
    }
 
     stage('execute tests') {
-    def img = docker.image('secop_base:latest')
-    def docimg = docker.image('secop_docs:latest')
+    def img = docker.image('frappy_base:latest')
+    def docimg = docker.image('frappy_docs:latest')
 
     parallel 'Test': {
         img.inside {
@@ -252,9 +230,10 @@ node("dockerhost") {
             if (GERRIT_EVENT_TYPE == 'change-merged')
             {
                 sh '''
-                rsync -rlv doc/_build/* /ictrlsrv/share/public/doc/secop
+                rsync -rlv doc/_build/* /ictrlsrv/share/public/doc/frappy
                 '''
             }
-        }}
+        }}, failFast: false
     }
+    setGerritReview()
 }

ci/README

@@ -10,10 +10,10 @@ The Dockerfile defines two images:
 
 To create the images:
 
-  docker build --target <base|docs> --tag secop_<base|docs>:latest .
+  docker build --target <base|docs> --tag frappy_<base|docs>:latest .
 
 To test images interactivly:
-  docker run -u jenkins -i -t secop<base|docs> /bin/bash
+  docker run -u jenkins -i -t frappy<base|docs> /bin/bash
 
 The Jenkinsfile uses this Dockerfile (only approved checked-in versions from master)
 to build the images (a rebuild will only happen if the Dockerfile is changed as docker

debian/README

@@ -1,4 +1,4 @@
-The Debian Package secop-core
+The Debian Package frappy-core
 -----------------------------
 
 SECoP is currently under development.

debian/compat

@@ -1 +0,0 @@
-11

debian/control

@@ -1,8 +1,8 @@
-Source: secop-core
+Source: frappy-core
 Section: contrib/misc
 Priority: optional
 Maintainer: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
-Build-Depends: debhelper (>= 11~),
+Build-Depends: debhelper-compat (= 13),
  dh-python,
  python3 (>=3.6),
  python3-all,
@@ -20,10 +20,10 @@ Build-Depends: debhelper (>= 11~),
  git,
  markdown,
  python3-daemon
-Standards-Version: 4.1.4
+Standards-Version: 4.6.2
 X-Python3-Version: >= 3.6
 
-Package: secop-core
+Package: frappy-core
 Architecture: all
 Depends: python3 (>= 3.6),
  ${misc:Depends},
@@ -35,60 +35,64 @@ Depends: python3 (>= 3.6),
  python3-mlzlog,
  markdown,
  python3-daemon
+Replaces: secop-core (<= 0.14.3),
+ frappy-demo (<= 0.19.7)
+Breaks: secop-core (<= 0.14.3),
+ frappy-demo (<= 0.19.7)
 Description: Frappy SECoP core system
  contains the core server and client libraries and the server binary
  as well as the systemd integration
 
-#Package: secop-doc
+#Package: frappy-doc
 #Architecture: all
 #Section: doc
 #Depends: ${sphinxdoc:Depends},
 # ${misc:Depends}
 #Description: Frappy SECoP docu
-# This is the documentation to all the secop-* packages
+# This is the documentation to all the frappy-* packages
 
-Package: secop-gui
+Package: frappy-gui
 Architecture: all
-Depends: secop-core,
+Depends: frappy-core,
  ${misc:Depends},
  ${python3:Depends},
- python3-pyqt (>=4)
+ python3-pyqtgraph (>=0.11.0),
+ python3-pyqt5 (>=5)
+Replaces: secop-gui (<= 0.14.3)
+Breaks: secop-gui (<= 0.14.3)
 Description: Frappy SECoP gui client + cfgtool
  contains the GUI client and the configurator
 
-Package: secop-demo
+Package: frappy-ess
 Architecture: all
-Depends: secop-core,
+Depends: frappy-core,
  ${misc:Depends},
  ${python3:Depends}
-Recommends: secop-gui
-Description: SECoP demo files
- for demonstration purposes
-
-Package: secop-ess
-Architecture: all
-Depends: secop-core,
- ${misc:Depends},
- ${python3:Depends}
-Recommends: secop-gui
+Replaces: secop-ess (<= 0.14.3)
+Breaks: secop-ess (<= 0.14.3)
+Recommends: frappy-gui
 Description: SECoP ess files
  Modules specific for ESS
 
-Package: secop-mlz
+Package: frappy-mlz
 Architecture: all
-Depends: secop-core,
+Depends: frappy-core,
  ${misc:Depends},
  ${python3:Depends},
  python3-tango (>=9)
-Recommends: secop-gui
+Replaces: secop-mlz (<= 0.14.3)
+Breaks: secop-mlz (<= 0.14.3)
+Recommends: frappy-gui
 Description: SECoP mlz files
  Modules specific for MLZ
 
-Package: secop-psi
+Package: frappy-psi
 Architecture: all
-Depends: secop-core,
+Depends: frappy-core,
  ${misc:Depends},
  ${python3:Depends}
-Recommends: secop-gui
+Replaces: secop-psi (<= 0.14.3)
+Breaks: secop-psi (<= 0.14.3)
+Recommends: frappy-gui
 Description: SECoP psi files
  Modules specific for PSI

debian/copyright

@@ -1,15 +1,15 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: frappy
-Source: http://forge.frm2.tum.de/cgit/cgit.cgi/frm2/sine2020/secop/playground.git
+Source: http://forge.frm2.tum.de/cgit/cgit.cgi/secop/frappy.git
 Comment: FRAPPY is an implementation of the free SECoP protocol
  see https://www.github.com/SampleEnvironment/SECoP
 
 Files: *
-Copyright: 2016-2019 by the FRAPPY-SECOP contributors (see AUTHORS)
+Copyright: 2016-2024 by the FRAPPY-SECOP contributors (see AUTHORS)
 License: GPL-2
 
 Files: debian/*
-Copyright: 2015-2019 Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
+Copyright: 2015-2024 Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
 License: GPL-2
 
 License: GPL-2

debian/frappy-core.install

@@ -0,0 +1,15 @@
+usr/bin/frappy-cli
+usr/bin/frappy-server
+usr/bin/frappy-play
+usr/bin/frappy-scan
+usr/lib/python3.*/dist-packages/frappy/*.py
+usr/lib/python3.*/dist-packages/frappy/__pycache__
+usr/lib/python3.*/dist-packages/frappy/lib
+usr/lib/python3.*/dist-packages/frappy/client
+usr/lib/python3.*/dist-packages/frappy/protocol
+usr/lib/python3.*/dist-packages/frappy_core-*
+usr/lib/python3.*/dist-packages/frappy/RELEASE-VERSION
+usr/lib/python3.*/dist-packages/frappy_demo
+lib/systemd
+var/log/frappy
+etc/frappy/generalConfig.cfg

debian/frappy-ess.install

@@ -0,0 +1 @@
+usr/lib/python3.*/dist-packages/frappy_ess

debian/frappy-gui.install

@@ -0,0 +1,2 @@
+usr/bin/frappy-gui
+usr/lib/python3.*/dist-packages/frappy/gui

debian/frappy-mlz.install

@@ -0,0 +1 @@
+usr/lib/python3.*/dist-packages/frappy_mlz

debian/frappy-psi.install

@@ -0,0 +1 @@
+usr/lib/python3.*/dist-packages/frappy_psi

debian/rules

@@ -4,13 +4,14 @@
 # Uncomment this to turn on verbose mode.
 #export DH_VERBOSE=1
 
-export PYBUILD_NAME=secop
+export PYBUILD_NAME=frappy
 export PYBUILD_TEST_PYTEST=1
 
 override_dh_install:
 	rmdir debian/tmp
-	mv debian/python3-secop debian/tmp
+	mv debian/python3-frappy debian/tmp
 
+	install -m644 -Dt debian/tmp/etc/frappy etc/generalConfig.cfg
 	dh_install -i -O--buildsystem=pybuild
 	dh_missing --fail-missing
 

debian/secop-core.install

@@ -1,10 +0,0 @@
-usr/bin/secop-server
-usr/bin/secop-console
-usr/lib/python3.*/dist-packages/secop/*.py
-usr/lib/python3.*/dist-packages/secop/lib
-usr/lib/python3.*/dist-packages/secop/client
-usr/lib/python3.*/dist-packages/secop/protocol
-usr/lib/python3.*/dist-packages/secop_core-*
-usr/lib/python3.*/dist-packages/secop/RELEASE-VERSION
-lib/systemd
-var/log/secop

debian/secop-demo.install

@@ -1,2 +0,0 @@
-usr/lib/python3.*/dist-packages/secop_demo
-usr/lib/python3.*/dist-packages/secop/__pycache__

debian/secop-ess.install

@@ -1 +0,0 @@
-usr/lib/python3.*/dist-packages/secop_ess

debian/secop-gui.install

@@ -1,3 +0,0 @@
-usr/bin/secop-gui
-usr/bin/secop-cfg-editor
-usr/lib/python3.*/dist-packages/secop/gui

debian/secop-mlz.install

@@ -1 +0,0 @@
-usr/lib/python3.*/dist-packages/secop_mlz

debian/secop-psi.install

@@ -1 +0,0 @@
-usr/lib/python3.*/dist-packages/secop_psi

doc/source/_static/custom.css

@@ -2,3 +2,19 @@ div.wy-nav-content
 {
 	    max-width: 100% !important;
 }
+
+/* make some bullet lists more dense (this rule exists in theme.css, but not important)*/
+.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child {
+   margin-bottom: 0 !important;
+}
+
+/* overwrite custom font (to save bandwidth not using a custom font) */
+body {
+    font-family: "proxima-nova", "Helvetica Neue", Arial, sans-serif;
+}
+
+h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend {
+    font-family: "ff-tisa-web-pro", "Georgia", Arial, sans-serif;
+}
+
+

doc/source/client/index.rst

@@ -1,6 +0,0 @@
-Client documentation
-====================
-
-.. toctree::
-   :maxdepth: 2
-

doc/source/conf.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
-# SECoP documentation build configuration file, created by
+# Frappy documentation build configuration file, created by
 # sphinx-quickstart on Mon Sep 11 10:58:28 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -27,7 +26,7 @@ from os import path
 # Add import path for inplace usage
 sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..', '..')))
 
-from secop.version import get_version
+from frappy.version import get_version
 
 
 # -- General configuration ------------------------------------------------
@@ -43,7 +42,9 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
               'sphinx.ext.mathjax',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'rst2pdf.pdfbuilder',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -57,26 +58,29 @@ source_suffix = ['.rst', '.md']
 master_doc = 'index'
 
 # General information about the project.
-project = 'SECoP'
-#copyright = '2017, Enrico Faulhaber, Markus Zolliker'
-copyright = '2017, SECoP Committee'
+project = 'Frappy'
+copyright = '2017-2024, Enrico Faulhaber, Markus Zolliker'
+#copyright = '2017, SECoP Committee'
 author = 'Enrico Faulhaber, Markus Zolliker'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The full version, including alpha/beta/rc tags.
-release = get_version()
-# The short X.Y version.
-version = release.split('-')[0]
+try:
+    # The full version, including alpha/beta/rc tags.
+    release = get_version()
+    # The short X.Y version.
+    version = release.split('-')[0]
+except ValueError:
+    pass
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -89,6 +93,10 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+autodoc_default_options = {
+    'member-order': 'bysource',
+    'show-inheritance': True,
+}
 default_role = 'any'
 
 # -- Options for HTML output ----------------------------------------------
@@ -106,11 +114,6 @@ html_theme = 'sphinx_rtd_theme'
 html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -136,7 +139,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SECoPdoc'
+htmlhelp_basename = 'Frappydoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -163,7 +166,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'SECoP.tex', 'SECoP source documentation',
+    (master_doc, 'Frappy.tex', 'Frappy source documentation',
      'Enrico Faulhaber, Markus Zolliker', 'manual'),
 ]
 
@@ -173,7 +176,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'secop', 'SECoP source documentation',
+    (master_doc, 'frappy', 'Frappy source documentation',
      [author], 1)
 ]
 
@@ -184,8 +187,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'SECoP', 'SECoP source documentation',
-     author, 'SECoP', 'One line description of project.',
+    (master_doc, 'Frappy', 'Frappy source documentation',
+     author, 'Frappy', 'One line description of project.',
      'Miscellaneous'),
 ]
 
@@ -212,4 +215,86 @@ epub_exclude_files = ['search.html']
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+# intersphinx_mapping = {'https://docs.python.org/3/': None}
+
+from frappy.lib.classdoc import class_doc_handler
+
+def setup(app):
+    app.connect('autodoc-process-docstring', class_doc_handler)
+
+
+# -- Options for PDF output --------------------------------------------------
+# Grouping the document tree into PDF files. List of tuples
+# (source start file, target name, title, author, options).
+#
+# If there is more than one author, separate them with \\.
+# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
+#
+# The options element is a dictionary that lets you override
+# this config per-document. For example:
+#
+# ('index', 'MyProject', 'My Project', 'Author Name', {'pdf_compressed': True})
+#
+# would mean that specific document would be compressed
+# regardless of the global 'pdf_compressed' setting.
+pdf_documents = [
+    ('index', project, project, author),
+]
+# A comma-separated list of custom stylesheets. Example:
+pdf_stylesheets = ['sphinx', 'a4']
+# A list of folders to search for stylesheets. Example:
+pdf_style_path = ['.', '_styles']
+# Create a compressed PDF
+# Use True/False or 1/0
+# Example: compressed=True
+# pdf_compressed = False
+# A colon-separated list of folders to search for fonts. Example:
+# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
+# Language to be used for hyphenation support
+# pdf_language = "en_US"
+# Mode for literal blocks wider than the frame. Can be
+# overflow, shrink or truncate
+# pdf_fit_mode = "shrink"
+# Section level that forces a break page.
+# For example: 1 means top-level sections start in a new page
+# 0 means disabled
+# pdf_break_level = 0
+# When a section starts in a new page, force it to be 'even', 'odd',
+# or just use 'any'
+# pdf_breakside = 'any'
+# Insert footnotes where they are defined instead of
+# at the end.
+# pdf_inline_footnotes = True
+# verbosity level. 0 1 or 2
+# pdf_verbosity = 0
+# If false, no index is generated.
+# pdf_use_index = True
+# If false, no modindex is generated.
+# pdf_use_modindex = True
+# If false, no coverpage is generated.
+# pdf_use_coverpage = True
+# Name of the cover page template to use
+# pdf_cover_template = 'sphinxcover.tmpl'
+# Documents to append as an appendix to all manuals.
+# pdf_appendices = []
+# Enable experimental feature to split table cells. Use it
+# if you get "DelayedTable too big" errors
+# pdf_splittables = False
+# Set the default DPI for images
+# pdf_default_dpi = 72
+# Enable rst2pdf extension modules
+# pdf_extensions = []
+# Page template name for "regular" pages
+# pdf_page_template = 'cutePage'
+# Show Table Of Contents at the beginning?
+# pdf_use_toc = True
+# How many levels deep should the table of contents be?
+pdf_toc_depth = 9999
+# Add section number to section references
+pdf_use_numbered_links = False
+# Background images fitting mode
+pdf_fit_background_mode = 'scale'
+# Repeat table header on tables that cross a page boundary?
+pdf_repeat_table_rows = True
+# Enable smart quotes (1, 2 or 3) or disable by setting to 0
+pdf_smartquotes = 0

doc/source/configuration.rst

@@ -0,0 +1,58 @@
+Configuration File
+..................
+
+.. _node configuration:
+
+:Node(equipment_id, description, interface, \*\*kwds):
+
+    Specify the SEC-node properties.
+
+    The arguments are SECoP node properties and additional internal node configurations
+
+    :Parameters:
+
+        - **equipment_id** - a globally unique string identifying the SEC node
+        - **description** - a human readable description of the SEC node
+        - **interface** - an uri style string indication the address for the server
+        - **kwds** - other SEC node properties
+
+.. _mod configuration:
+
+:Mod(name, cls, description, \*\*kwds):
+
+    Create a SECoP module.
+    Keyworded argument matching a parameter name are used to configure
+    the initial value of a parameter. For configuring the parameter properties
+    the value must be an instance of **Param**, using the keyworded arguments
+    for modifying the default values of the parameter properties. In this case,
+    the initial value may be given as the first positional argument.
+    In case command properties are to be modified **Command** has to be used.
+
+    :Parameters:
+
+        - **name** - the module name
+        - **cls** - a qualified class name or the python class of a module
+        - **description** - a human readable description of the module
+        - **kwds** - parameter, property or command configurations
+
+.. _param configuration:
+
+:Param(value=<undef>, \*\*kwds):
+
+    Configure a parameter
+
+    :Parameters:
+
+        - **value** - if given, the initial value of the parameter
+        - **kwds** - parameter or datatype SECoP properties (see :class:`frappy.param.Parameter`
+          and :class:`frappy.datatypes.Datatypes`)
+
+.. _command configuration:
+
+:Command(\*\*kwds):
+
+    Configure a command
+
+    :Parameters:
+
+        - **kwds** - command SECoP properties (see :class:`frappy.param.Commands`)

doc/source/facility/demo/cryo.rst

@@ -1,6 +0,0 @@
-Demo cryostat
-=============
-
-.. automodule:: secop_demo.cryo
-    :members:
-

doc/source/facility/demo/index.rst

@@ -1,12 +0,0 @@
-Demo
-====
-
-Specific sample environments
-----------------------------
-
-.. toctree::
-   :maxdepth: 3
-
-   cryo
-   test
-

doc/source/facility/demo/test.rst

@@ -1,6 +0,0 @@
-Test devices
-=============
-
-.. automodule:: secop_demo.test
-    :members:
-