From b714d2000451892f5bbe8f7345e543c0223d596f Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Fri, 31 May 2024 07:28:42 +0000 Subject: [PATCH 01/24] add root level shared to Support --- src/ibek/support.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/ibek/support.py b/src/ibek/support.py index 866bdf1d4..fee58d870 100644 --- a/src/ibek/support.py +++ b/src/ibek/support.py @@ -5,7 +5,7 @@ from __future__ import annotations import json -from typing import Sequence +from typing import Any, Sequence from pydantic import Field @@ -20,6 +20,11 @@ class Support(BaseSettings): Provides the deserialize entry point. """ + shared: Sequence[Any] = Field( + description="A place to create any anchors required for repeating YAML", + default=(), + ) + module: str = Field(description="Support module name, normally the repo name") defs: Sequence[EntityDefinition] = Field( description="The definitions an IOC can create using this module" From 556839765b90e727b922c22f92d678f8d4f6507b Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Fri, 31 May 2024 08:54:58 +0000 Subject: [PATCH 02/24] add list type to args --- tests/generate_samples.sh | 11 +++ tests/samples/iocs/listarg.ibek.ioc.yaml | 7 ++ tests/samples/outputs/listarg/index.bob | 28 +++++++ tests/samples/outputs/listarg/ioc.subst | 3 + tests/samples/outputs/listarg/st.cmd | 16 ++++ .../samples/schemas/ibek.support.schema.json | 50 +++++++++++ .../samples/schemas/listarg.ibek.schema.json | 83 +++++++++++++++++++ tests/samples/support/ipac.ibek.support.yaml | 2 +- .../samples/support/listarg.ibek.support.yaml | 28 +++++++ tests/test_cli.py | 12 +++ 10 files changed, 239 insertions(+), 1 deletion(-) create mode 100644 tests/samples/iocs/listarg.ibek.ioc.yaml create mode 100644 tests/samples/outputs/listarg/index.bob create mode 100644 tests/samples/outputs/listarg/ioc.subst create mode 100644 tests/samples/outputs/listarg/st.cmd create mode 100644 tests/samples/schemas/listarg.ibek.schema.json create mode 100644 tests/samples/support/listarg.ibek.support.yaml diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index 726879c57..67de2c414 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -72,3 +72,14 @@ ibek ioc generate-schema --no-ibek-defs support/technosoft.ibek.support.yaml --o echo making techosoft ioc EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/technosoft.ibek.ioc.yaml support/technosoft.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/technosoft + +# list example + +echo making an ioc schema using listarg support yaml +ibek ioc generate-schema --no-ibek-defs support/listarg.ibek.support.yaml --output schemas/listarg.ibek.schema.json + +echo making listarg ioc +EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/listarg.ibek.ioc.yaml support/listarg.ibek.support.yaml +mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/listarg + + diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml new file mode 100644 index 000000000..bbc793da5 --- /dev/null +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -0,0 +1,7 @@ +# yaml-language-server: $schema=../schemas/listarg.ibek.schema.json +ioc_name: counter +description: an example motion ioc for ibek testing + +entities: + - type: listtest.lister + friends: ["Rimmer", "Holly", "Cat", "Kryten"] diff --git a/tests/samples/outputs/listarg/index.bob b/tests/samples/outputs/listarg/index.bob new file mode 100644 index 000000000..7753a980d --- /dev/null +++ b/tests/samples/outputs/listarg/index.bob @@ -0,0 +1,28 @@ + + counter + 0 + 0 + 10 + 35 + 4 + 4 + + Title + TITLE + counter + 0 + 0 + 10 + 25 + + + + + + + + + true + 1 + + diff --git a/tests/samples/outputs/listarg/ioc.subst b/tests/samples/outputs/listarg/ioc.subst new file mode 100644 index 000000000..535e1a86b --- /dev/null +++ b/tests/samples/outputs/listarg/ioc.subst @@ -0,0 +1,3 @@ +############################################################################# +# DB substitution file generated by http://github.com/epics-containers/ibek # +############################################################################# diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd new file mode 100644 index 000000000..2701f037e --- /dev/null +++ b/tests/samples/outputs/listarg/st.cmd @@ -0,0 +1,16 @@ +# EPICS IOC Startup Script generated by https://github.com/epics-containers/ibek + +cd "/epics/ioc" +dbLoadDatabase dbd/ioc.dbd +ioc_registerRecordDeviceDriver pdbbase + +Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: +- Rimmer +- Holly +- Cat +- Kryten +First friend is Rimmer + +dbLoadRecords /epics/runtime/ioc.db +iocInit + diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index c8525acdc..d1b85d012 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -124,6 +124,9 @@ "description": "The arguments IOC instance should supply", "items": { "anyOf": [ + { + "$ref": "#/$defs/ListArg" + }, { "$ref": "#/$defs/FloatArg" }, @@ -486,6 +489,46 @@ "title": "IntArg", "type": "object" }, + "ListArg": { + "additionalProperties": false, + "description": "An argument with a float value", + "properties": { + "type": { + "const": "list", + "default": "list", + "title": "Type" + }, + "name": { + "description": "Name of the argument that the IOC instance should pass", + "title": "Name", + "type": "string" + }, + "description": { + "description": "Description of what the argument will be used for", + "title": "Description", + "type": "string" + }, + "default": { + "anyOf": [ + { + "items": {}, + "type": "array" + }, + { + "type": "null" + } + ], + "default": null, + "title": "Default" + } + }, + "required": [ + "name", + "description" + ], + "title": "ListArg", + "type": "object" + }, "ObjectArg": { "additionalProperties": false, "description": "A reference to another entity defined in this IOC", @@ -652,6 +695,13 @@ "additionalProperties": false, "description": "Lists the definitions for a support module, this defines what Entities it supports\n\nProvides the deserialize entry point.", "properties": { + "shared": { + "default": [], + "description": "A place to create any anchors required for repeating YAML", + "items": {}, + "title": "Shared", + "type": "array" + }, "module": { "description": "Support module name, normally the repo name", "title": "Module", diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json new file mode 100644 index 000000000..a3cf2ff73 --- /dev/null +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -0,0 +1,83 @@ +{ + "$defs": { + "listtest_lister": { + "additionalProperties": false, + "properties": { + "type": { + "const": "listtest.lister", + "default": "listtest.lister", + "description": "The protagonist from Red Dwarf", + "title": "Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "quote": { + "default": "Smoke me a kipper, I'll be back for breakfast", + "description": "most hated quote", + "title": "Quote", + "type": "string" + }, + "friends": { + "description": "List of friends", + "items": {}, + "title": "Friends", + "type": "array" + } + }, + "required": [ + "friends" + ], + "title": "listtest_lister", + "type": "object" + } + }, + "additionalProperties": false, + "properties": { + "ioc_name": { + "description": "Name of IOC instance", + "title": "Ioc Name", + "type": "string" + }, + "description": { + "description": "Description of what the IOC does", + "title": "Description", + "type": "string" + }, + "entities": { + "description": "List of entities this IOC instantiates", + "items": { + "discriminator": { + "mapping": { + "listtest.lister": "#/$defs/listtest_lister" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/$defs/listtest_lister" + } + ] + }, + "title": "Entities", + "type": "array" + }, + "shared": { + "default": [], + "description": "A place to create any anchors required for repeating YAML", + "items": {}, + "title": "Shared", + "type": "array" + } + }, + "required": [ + "ioc_name", + "description", + "entities" + ], + "title": "NewIOC", + "type": "object" +} \ No newline at end of file diff --git a/tests/samples/support/ipac.ibek.support.yaml b/tests/samples/support/ipac.ibek.support.yaml index b7b9a9a72..578ea3e2f 100644 --- a/tests/samples/support/ipac.ibek.support.yaml +++ b/tests/samples/support/ipac.ibek.support.yaml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/1.2.0/ibek.support.schema.json +# yaml-language-server: $schema=../schemas/ibek.support.schema.json module: ipac diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml new file mode 100644 index 000000000..8816da1e5 --- /dev/null +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=../schemas/ibek.support.schema.json +module: listtest + +defs: + - name: lister + description: |- + The protagonist from Red Dwarf + args: + - type: str + name: quote + description: |- + most hated quote + default: |- + Smoke me a kipper, I'll be back for breakfast + + - type: list + name: friends + description: |- + List of friends + + pre_init: + - value: | + Lister does not like to hear "{{quote}}" has friends: + {% for friend in friends -%} + - {{friend}} + {% endfor -%} + + First friend is {{friends[0]}} diff --git a/tests/test_cli.py b/tests/test_cli.py index af84e12de..36c8e6c1c 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -235,3 +235,15 @@ def test_andreas_motors(tmp_epics_root: Path, samples: Path): "technosoft", ["asyn", "technosoft"], ) + + +def test_list(tmp_epics_root: Path, samples: Path): + """ + Motor and axis example + """ + generic_generate( + tmp_epics_root, + samples, + "listarg", + ["listarg"], + ) From 7d3efceaf17c8e4c5aaacabbfd267476fe5f23f7 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Fri, 31 May 2024 09:25:30 +0000 Subject: [PATCH 03/24] simplify cli tests --- docs/developer/explanations/entities.rst | 2 +- src/ibek/args.py | 7 ++ tests/generate_samples.sh | 6 +- ...ipac-test.yaml => ipac-test.ibek.ioc.yaml} | 0 ...-mo-ioc-01.yaml => motorSim.ibek.ioc.yaml} | 0 .../outputs/{ipac => ipac-test}/index.bob | 0 .../outputs/{ipac => ipac-test}/ioc.subst | 0 .../outputs/{ipac => ipac-test}/st.cmd | 0 tests/samples/outputs/motorSim/index.bob | 4 +- tests/samples/outputs/motorSim/ioc.subst | 2 +- .../samples/outputs/technosoft/reference.cmd | 6 - tests/test_cli.py | 114 ++++++------------ tests/test_support.py | 1 + 13 files changed, 51 insertions(+), 91 deletions(-) rename tests/samples/iocs/{ipac-test.yaml => ipac-test.ibek.ioc.yaml} (100%) rename tests/samples/iocs/{ibek-mo-ioc-01.yaml => motorSim.ibek.ioc.yaml} (100%) rename tests/samples/outputs/{ipac => ipac-test}/index.bob (100%) rename tests/samples/outputs/{ipac => ipac-test}/ioc.subst (100%) rename tests/samples/outputs/{ipac => ipac-test}/st.cmd (100%) delete mode 100644 tests/samples/outputs/technosoft/reference.cmd diff --git a/docs/developer/explanations/entities.rst b/docs/developer/explanations/entities.rst index 2f748f4c3..ef73b3484 100644 --- a/docs/developer/explanations/entities.rst +++ b/docs/developer/explanations/entities.rst @@ -149,7 +149,7 @@ Click the arrows to reveal the files.
all.ibek.ioc.yaml - .. include:: ../../../tests/samples/iocs/ibek-mo-ioc-01.yaml + .. include:: ../../../tests/samples/iocs/motorSim.ibek.ioc.yaml :literal: .. raw:: html diff --git a/src/ibek/args.py b/src/ibek/args.py index a9ccef2e7..2154e73cd 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -34,6 +34,13 @@ class Arg(BaseSettings): ) +class ListArg(Arg): + """An argument with a float value""" + + type: Literal["list"] = "list" + default: Optional[list] = None + + class FloatArg(Arg): """An argument with a float value""" diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index 67de2c414..5caf63cc3 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -42,7 +42,7 @@ echo making an ioc schema using ADCore and quadem support yaml ibek ioc generate-schema --no-ibek-defs support/ADCore.ibek.support.yaml support/quadem.ibek.support.yaml --output schemas/quadem.ibek.ioc.schema.json echo making ioc based on ibek-mo-ioc-01.yaml -EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/ibek-mo-ioc-01.yaml support/asyn.ibek.support.yaml support/motorSim.ibek.support.yaml +EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/motorSim.ibek.ioc.yaml support/asyn.ibek.support.yaml support/motorSim.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/motorSim echo making ioc based on utils support yaml @@ -50,8 +50,8 @@ EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/utils.ibek.ioc.yaml support/ut mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/utils echo making ioc based on ipac support yaml -EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/ipac-test.yaml support/ipac.ibek.support.yaml support/epics.ibek.support.yaml -mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/ipac +EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/ipac-test.ibek.ioc.yaml support/ipac.ibek.support.yaml support/epics.ibek.support.yaml +mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/ipac-test echo making ioc based on gauges support yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/gauges.ibek.ioc.yaml support/asyn.ibek.support.yaml support/gauges.ibek.support.yaml diff --git a/tests/samples/iocs/ipac-test.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml similarity index 100% rename from tests/samples/iocs/ipac-test.yaml rename to tests/samples/iocs/ipac-test.ibek.ioc.yaml diff --git a/tests/samples/iocs/ibek-mo-ioc-01.yaml b/tests/samples/iocs/motorSim.ibek.ioc.yaml similarity index 100% rename from tests/samples/iocs/ibek-mo-ioc-01.yaml rename to tests/samples/iocs/motorSim.ibek.ioc.yaml diff --git a/tests/samples/outputs/ipac/index.bob b/tests/samples/outputs/ipac-test/index.bob similarity index 100% rename from tests/samples/outputs/ipac/index.bob rename to tests/samples/outputs/ipac-test/index.bob diff --git a/tests/samples/outputs/ipac/ioc.subst b/tests/samples/outputs/ipac-test/ioc.subst similarity index 100% rename from tests/samples/outputs/ipac/ioc.subst rename to tests/samples/outputs/ipac-test/ioc.subst diff --git a/tests/samples/outputs/ipac/st.cmd b/tests/samples/outputs/ipac-test/st.cmd similarity index 100% rename from tests/samples/outputs/ipac/st.cmd rename to tests/samples/outputs/ipac-test/st.cmd diff --git a/tests/samples/outputs/motorSim/index.bob b/tests/samples/outputs/motorSim/index.bob index ad7f566bc..3dac9f034 100644 --- a/tests/samples/outputs/motorSim/index.bob +++ b/tests/samples/outputs/motorSim/index.bob @@ -1,5 +1,5 @@ - ibek-mo-ioc-01 + motorSim.ibek.ioc 0 0 388 @@ -9,7 +9,7 @@ Title TITLE - ibek-mo-ioc-01 + motorSim.ibek.ioc 0 0 388 diff --git a/tests/samples/outputs/motorSim/ioc.subst b/tests/samples/outputs/motorSim/ioc.subst index b56b1a843..30222bf52 100644 --- a/tests/samples/outputs/motorSim/ioc.subst +++ b/tests/samples/outputs/motorSim/ioc.subst @@ -11,7 +11,7 @@ pattern file "basic_asyn_motor.db" { pattern { "P", "M", "DTYP", "PORT", "ADDR", "DESC", "EGU", "DIR", "VELO", "VMAX", "MRES", "DHLM", "DLLM", "INIT" } - { "IBEK-MO-TST-01:", "M0", "asynMotor", "controllerOne", "0", "Motor 0 for ioc ibek-mo-ioc-01", "degrees", "0", "10.0", "10.0", ".01", "20000", "-20000", "" } + { "IBEK-MO-TST-01:", "M0", "asynMotor", "controllerOne", "0", "Motor 0 for ioc motorSim.ibek.ioc", "degrees", "0", "10.0", "10.0", ".01", "20000", "-20000", "" } { "IBEK-MO-TST-01:", "M1", "asynMotor", "controllerOne", "1", "Motor 1 {{enclosed in escaped curly braces}} ", "degrees", "0", "10.0", "10.0", ".01", "20000", "-20000", "" } { "IBEK-MO-TST-01:", "M2", "asynMotor", "controllerOne", "2", "Motor 2", "degrees", "0", "10.0", "10.0", ".01", "20000", "-20000", "" } { "IBEK-MO-TST-01:", "M3", "asynMotor", "controllerOne", "3", "Motor 3", "degrees", "0", "10.0", "10.0", ".01", "20000", "-20000", "" } diff --git a/tests/samples/outputs/technosoft/reference.cmd b/tests/samples/outputs/technosoft/reference.cmd deleted file mode 100644 index 33b4dc5f8..000000000 --- a/tests/samples/outputs/technosoft/reference.cmd +++ /dev/null @@ -1,6 +0,0 @@ -ndsCreateDevice "TechnosoftTML", "", "FILE=/tmp/,NAXIS=4,DEV_PATH=/dev/ttyS0,HOST_ID=1, - AXIS_SETUP_0=$(SUPPORT)/motorTechnosoft/tml_lib/config/config.txt,AXIS_ID_0=1,AXIS_HOMING_SW_0=LSN, - AXIS_SETUP_1=$(SUPPORT)/motorTechnosoft/tml_lib/config/config.txt,AXIS_ID_1=2,AXIS_HOMING_SW_1=LSN, - AXIS_SETUP_2=$(SUPPORT)/motorTechnosoft/tml_lib/config/config.txt,AXIS_ID_2=3,AXIS_HOMING_SW_2=LSN, - AXIS_SETUP_3=$(SUPPORT)/motorTechnosoft/tml_lib/config/config.txt,AXIS_ID_3=4,AXIS_HOMING_SW_3=LSN" - diff --git a/tests/test_cli.py b/tests/test_cli.py index 36c8e6c1c..37f9df86a 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -88,50 +88,25 @@ def test_build_runtime_motorSim(tmp_epics_root: Path, samples: Path): Also verifies database subst file generation for multiple entity instantiations. """ - ioc_yaml = samples / "iocs" / "ibek-mo-ioc-01.yaml" - support_yaml1 = samples / "support" / "asyn.ibek.support.yaml" - support_yaml2 = samples / "support" / "motorSim.ibek.support.yaml" - expected_outputs = samples / "outputs" / "motorSim" - generate(ioc_yaml, [support_yaml1, support_yaml2]) - - example_boot = (expected_outputs / "st.cmd").read_text() - actual_boot = (tmp_epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot - - example_db = (expected_outputs / "ioc.subst").read_text() - actual_db = (tmp_epics_root / "runtime" / "ioc.subst").read_text() - assert example_db == actual_db - - example_index = (expected_outputs / "index.bob").read_text() - actual_index = (tmp_epics_root / "opi" / "index.bob").read_text() - assert example_index == actual_index - - example_bob = (expected_outputs / "simple.pvi.bob").read_text() - actual_bob = (tmp_epics_root / "opi" / "simple.pvi.bob").read_text() - assert example_bob == actual_bob - - example_template = (expected_outputs / "simple.pvi.template").read_text() - actual_template = (tmp_epics_root / "runtime" / "simple.pvi.template").read_text() - assert example_template == actual_template + generic_generate( + tmp_epics_root, + samples, + "motorSim", + ["motorSim", "asyn"], + ) def test_build_utils_features(tmp_epics_root: Path, samples: Path): """ build an ioc runtime script to verify utils features """ - ioc_yaml = samples / "iocs" / "utils.ibek.ioc.yaml" - support_yaml = samples / "support" / "utils.ibek.support.yaml" - - run_cli("runtime", "generate", ioc_yaml, support_yaml) - - example_boot = (samples / "outputs" / "utils" / "st.cmd").read_text() - actual_boot = (tmp_epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot - - example_db = (samples / "outputs" / "utils" / "ioc.subst").read_text() - actual_db = (tmp_epics_root / "runtime" / "ioc.subst").read_text() - assert example_db == actual_db + generic_generate( + tmp_epics_root, + samples, + "utils", + ["utils"], + ) def test_generate_links_ibek(samples: Path, mocker: MockerFixture): @@ -152,36 +127,28 @@ def test_ipac(tmp_epics_root: Path, samples: Path): Tests that an id argument can include another argument in its default value """ - ioc_yaml = samples / "iocs" / "ipac-test.yaml" - support_yaml1 = samples / "support" / "ipac.ibek.support.yaml" - support_yaml2 = samples / "support" / "epics.ibek.support.yaml" - expected_outputs = samples / "outputs" / "ipac" - # reset the InterruptVector counter to its initial state (if already used) if "InterruptVector" in utils.UTILS.counters: utils.UTILS.counters["InterruptVector"].current = 192 - generate(ioc_yaml, [support_yaml1, support_yaml2]) - - example_boot = (expected_outputs / "st.cmd").read_text() - actual_boot = (tmp_epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot + generic_generate( + tmp_epics_root, + samples, + "ipac-test", + ["ipac", "epics"], + ) def test_gauges(tmp_epics_root: Path, samples: Path): """ Tests that an id argument can include another argument in its default value """ - ioc_yaml = samples / "iocs" / "gauges.ibek.ioc.yaml" - support_yaml1 = samples / "support" / "asyn.ibek.support.yaml" - support_yaml2 = samples / "support" / "gauges.ibek.support.yaml" - expected_outputs = samples / "outputs" / "gauges" - - generate(ioc_yaml, [support_yaml1, support_yaml2]) - - example_boot = (expected_outputs / "st.cmd").read_text() - actual_boot = (tmp_epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot + generic_generate( + tmp_epics_root, + samples, + "gauges", + ["asyn", "gauges"], + ) def test_quadem(tmp_epics_root: Path, samples: Path): @@ -189,20 +156,12 @@ def test_quadem(tmp_epics_root: Path, samples: Path): Tests the use of CollectionDefinitions in an IOC instance this example uses the tetramm beam position monitor module """ - ioc_yaml = samples / "iocs" / "quadem.ibek.ioc.yaml" - support_yaml1 = samples / "support" / "ADCore.ibek.support.yaml" - support_yaml2 = samples / "support" / "quadem.ibek.support.yaml" - expected_outputs = samples / "outputs" / "quadem" - - generate(ioc_yaml, [support_yaml1, support_yaml2]) - - example_boot = (expected_outputs / "st.cmd").read_text() - actual_boot = (tmp_epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot - - example_db = (samples / "outputs" / "quadem" / "ioc.subst").read_text() - actual_db = (tmp_epics_root / "runtime" / "ioc.subst").read_text() - assert example_db == actual_db + generic_generate( + tmp_epics_root, + samples, + "quadem", + ["ADCore", "quadem"], + ) def generic_generate( @@ -216,13 +175,12 @@ def generic_generate( generate(ioc_yaml, support_yamls) - example_boot = (expected_outputs / "st.cmd").read_text() - actual_boot = (epics_root / "runtime" / "st.cmd").read_text() - assert example_boot == actual_boot - - example_db = (expected_outputs / "ioc.subst").read_text() - actual_db = (epics_root / "runtime" / "ioc.subst").read_text() - assert example_db == actual_db + for output in expected_outputs.glob("*"): + actual = epics_root / "runtime" / output.name + if not actual.exists(): + actual = epics_root / "opi" / output.name + assert actual.exists(), "Missing output file" + assert output.read_text() == actual.read_text() def test_andreas_motors(tmp_epics_root: Path, samples: Path): diff --git a/tests/test_support.py b/tests/test_support.py index 5386cb543..287ced9ab 100644 --- a/tests/test_support.py +++ b/tests/test_support.py @@ -19,6 +19,7 @@ def test_symlink_ibek(tmp_path: Path, samples: Path): "epics.ibek.support.yaml", "gauges.ibek.support.yaml", "ipac.ibek.support.yaml", + "listarg.ibek.support.yaml", "motorSim.ibek.support.yaml", "quadem.ibek.support.yaml", "technosoft.ibek.support.yaml", From 881e9229c1dc9bb02b390bb1a14804e8865dfb1b Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 08:17:16 +0000 Subject: [PATCH 04/24] change entity "type" field to "entity_type" This allows us to use the discriminator entity_type to determine the type of entity to create when deserializing IOC yaml. BUT does not clash with the type field used for Entity Args. This will allow us to switch to using union of types for Args and therefore have them defined as their type or a Jinja template. --- .vscode/settings.json | 4 +- src/ibek/entity_factory.py | 13 +- src/ibek/ioc.py | 2 +- src/ibek/ioc_factory.py | 2 +- src/ibek/sub_entity.py | 2 +- tests/samples/iocs/bad_counter.ibek.ioc.yaml | 4 +- tests/samples/iocs/bad_counter2.ibek.ioc.yaml | 8 +- tests/samples/iocs/bad_db.ibek.ioc.yaml | 2 +- tests/samples/iocs/bad_default.ibek.ioc.yaml | 2 +- tests/samples/iocs/bad_ref.ibek.ioc.yaml | 4 +- tests/samples/iocs/gauges.ibek.ioc.yaml | 12 +- tests/samples/iocs/ipac-test.ibek.ioc.yaml | 8 +- tests/samples/iocs/listarg.ibek.ioc.yaml | 5 +- tests/samples/iocs/motorSim.ibek.ioc.yaml | 16 +- tests/samples/iocs/quadem.ibek.ioc.yaml | 4 +- tests/samples/iocs/technosoft.ibek.ioc.yaml | 4 +- tests/samples/iocs/utils.ibek.ioc.yaml | 2 +- .../schemas/gauges.ibek.ioc.schema.json | 20 +- .../samples/schemas/ibek.support.schema.json | 6 +- .../samples/schemas/listarg.ibek.schema.json | 8 +- .../schemas/motorSim.ibek.ioc.schema.json | 20 +- .../schemas/quadem.ibek.ioc.schema.json | 199 ++++++++++-------- .../schemas/single.ibek.ioc.schema.json | 14 +- .../schemas/technosoft.ibek.ioc.schema.json | 14 +- .../schemas/utils.ibek.ioc.schema.json | 14 +- .../samples/support/ADCore.ibek.support.yaml | 2 +- .../samples/support/quadem.ibek.support.yaml | 4 +- tests/test_render.py | 40 +++- tests/test_unit.py | 8 +- 29 files changed, 239 insertions(+), 204 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 8cd0fbd66..d98d3a644 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,8 +1,6 @@ { "python.testing.pytestArgs": [ - "--cov=ibek", - "--cov-report", - "xml:cov.xml" + "tests" ], "python.testing.unittestEnabled": false, "python.testing.pytestEnabled": true, diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 16c4a47f3..0f861d37b 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -6,9 +6,9 @@ import builtins from pathlib import Path -from typing import Any, Dict, List, Literal, Tuple, Type +from typing import Annotated, Any, Dict, List, Literal, Tuple, Type -from pydantic import create_model, field_validator +from pydantic import Field, create_model, field_validator from pydantic.fields import FieldInfo from pydantic_core import PydanticUndefined, ValidationError from ruamel.yaml.main import YAML @@ -64,10 +64,7 @@ def _make_entity_model( def add_arg(name, typ, description, default): if default is None: default = PydanticUndefined - args[name] = ( - typ, - FieldInfo(description=description, default=default), - ) + args[name] = (Annotated[typ, Field(description=description)], default) args: Dict[str, Tuple[type, Any]] = {} validators: Dict[str, Any] = {} @@ -120,7 +117,7 @@ def lookup_instance(cls, id): # add the type literal which discriminates between the different Entity classes typ = Literal[full_name] # type: ignore - add_arg("type", typ, definition.description, full_name) + args["entity_type"] = (typ, Field(description=definition.description)) class_name = full_name.replace(".", "_") entity_cls = create_model( @@ -168,7 +165,7 @@ def resolve_sub_entities(self, entities: List[Entity]) -> List[Entity]: # add in SubEntities if any for sub_entity in definition.sub_entities: # find the Entity Class that the SubEntity represents - entity_cls = self._entity_models[sub_entity.type] + entity_cls = self._entity_models[sub_entity.entity_type] # get the SubEntity arguments sub_args_dict = sub_entity.model_dump() # jinja render any references to parent Args in the SubEntity Args diff --git a/src/ibek/ioc.py b/src/ibek/ioc.py index 29d1ab0e1..719d92052 100644 --- a/src/ibek/ioc.py +++ b/src/ibek/ioc.py @@ -49,7 +49,7 @@ class Entity(BaseSettings): A baseclass for all generated Entity classes. """ - type: str = Field(description="The type of this entity") + entity_type: str = Field(description="The type of this entity") entity_enabled: bool = Field( description="enable or disable this entity instance", default=True ) diff --git a/src/ibek/ioc_factory.py b/src/ibek/ioc_factory.py index 7ebff476d..df1b30b57 100644 --- a/src/ibek/ioc_factory.py +++ b/src/ibek/ioc_factory.py @@ -59,7 +59,7 @@ def make_ioc_model(self, entity_models: List[Type[Entity]]) -> Type[IOC]: """ entity_union = Union[tuple(entity_models)] # type: ignore - discriminated = Annotated[entity_union, Field(discriminator="type")] # type: ignore + discriminated = Annotated[entity_union, Field(discriminator="entity_type")] # type: ignore class NewIOC(IOC): entities: Sequence[discriminated] = Field( # type: ignore diff --git a/src/ibek/sub_entity.py b/src/ibek/sub_entity.py index 9d8cf23d8..c6fd41599 100644 --- a/src/ibek/sub_entity.py +++ b/src/ibek/sub_entity.py @@ -8,7 +8,7 @@ class SubEntity(BaseModel, extra="allow"): section """ - type: str = Field(description="The type of this entity") + entity_type: str = Field(description="The type of this entity") entity_enabled: bool = Field( description="enable or disable this entity instance", default=True diff --git a/tests/samples/iocs/bad_counter.ibek.ioc.yaml b/tests/samples/iocs/bad_counter.ibek.ioc.yaml index fb6289d78..e7a2ab679 100644 --- a/tests/samples/iocs/bad_counter.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_counter.ibek.ioc.yaml @@ -3,7 +3,7 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - type: epics.InterruptVectorVME + - entity_type: epics.InterruptVectorVME name: Vec0 - - type: epics.InterruptVectorVME2 + - entity_type: epics.InterruptVectorVME2 name: Vec1 diff --git a/tests/samples/iocs/bad_counter2.ibek.ioc.yaml b/tests/samples/iocs/bad_counter2.ibek.ioc.yaml index b3e4af463..f6f6ae188 100644 --- a/tests/samples/iocs/bad_counter2.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_counter2.ibek.ioc.yaml @@ -3,11 +3,11 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - type: epics.InterruptVectorVME2 + - entity_type: epics.InterruptVectorVME2 name: Vec1 - - type: epics.InterruptVectorVME2 + - entity_type: epics.InterruptVectorVME2 name: Vec2 - - type: epics.InterruptVectorVME2 + - entity_type: epics.InterruptVectorVME2 name: Vec3 - - type: epics.InterruptVectorVME2 + - entity_type: epics.InterruptVectorVME2 name: Vec4 diff --git a/tests/samples/iocs/bad_db.ibek.ioc.yaml b/tests/samples/iocs/bad_db.ibek.ioc.yaml index 9c18bcdc7..315cd8a04 100644 --- a/tests/samples/iocs/bad_db.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_db.ibek.ioc.yaml @@ -2,5 +2,5 @@ ioc_name: test-bad-db-ioc description: demo bad database definition entities: - - type: object_module.RefObject + - entity_type: object_module.RefObject name: Ref1 diff --git a/tests/samples/iocs/bad_default.ibek.ioc.yaml b/tests/samples/iocs/bad_default.ibek.ioc.yaml index c1b5fc4e3..c8a57187f 100644 --- a/tests/samples/iocs/bad_default.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_default.ibek.ioc.yaml @@ -5,5 +5,5 @@ description: an example for testing missing non-default values entities: # deliberately do not specify port to test failure case - - type: asyn.AsynIP + - entity_type: asyn.AsynIP name: controllerOnePort diff --git a/tests/samples/iocs/bad_ref.ibek.ioc.yaml b/tests/samples/iocs/bad_ref.ibek.ioc.yaml index 0860d9174..b4a4bcaf5 100644 --- a/tests/samples/iocs/bad_ref.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_ref.ibek.ioc.yaml @@ -4,11 +4,11 @@ ioc_name: test-multiple-ioc description: demo bad object reference entities: - - type: asyn.AsynIP + - entity_type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - type: motorSim.simMotorController + - entity_type: motorSim.simMotorController port: controllerOnePort_BAD_REF controllerName: controllerOne numAxes: 4 diff --git a/tests/samples/iocs/gauges.ibek.ioc.yaml b/tests/samples/iocs/gauges.ibek.ioc.yaml index a24c348db..b129ce6ee 100644 --- a/tests/samples/iocs/gauges.ibek.ioc.yaml +++ b/tests/samples/iocs/gauges.ibek.ioc.yaml @@ -4,31 +4,31 @@ ioc_name: "{{ ioc_yaml_file_name }}" description: Example of initialising a gauge group with defaults to gauge1 entities: - - type: asyn.AsynIP + - entity_type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - type: asyn.AsynIP + - entity_type: asyn.AsynIP name: controllerTwoPort port: 192.168.0.55:2002 - - type: gauges.Mks937bGauge + - entity_type: gauges.Mks937bGauge port: controllerOnePort name: MyGauge1 P: "IBEK-VA-GAUGE-01:" - - type: gauges.Mks937bGauge + - entity_type: gauges.Mks937bGauge port: controllerTwoPort name: MyGauge2 P: "IBEK-VA-GAUGE-02:" # an un-referenced Gauge - - type: gauges.Mks937bGauge + - entity_type: gauges.Mks937bGauge port: controllerTwoPort name: MyGauge3 P: "IBEK-VA-GAUGE-03:" - - type: gauges.GaugeGroup + - entity_type: gauges.GaugeGroup name: MyGaugeGroup gauge1: MyGauge1 gauge2: MyGauge2 diff --git a/tests/samples/iocs/ipac-test.ibek.ioc.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml index a73cd1df3..bd7695a27 100644 --- a/tests/samples/iocs/ipac-test.ibek.ioc.yaml +++ b/tests/samples/iocs/ipac-test.ibek.ioc.yaml @@ -5,15 +5,15 @@ ioc_name: ipac-test description: example IOC with IPAC modules entities: - - type: epics.InterruptVectorVME + - entity_type: epics.InterruptVectorVME name: Vec1 - - type: epics.InterruptVectorVME + - entity_type: epics.InterruptVectorVME name: Vec2 - - type: ipac.Hy8002 + - entity_type: ipac.Hy8002 slot: 4 interrupt_vector: Vec1 - - type: ipac.Hy8002 + - entity_type: ipac.Hy8002 slot: 5 interrupt_vector: Vec2 diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index bbc793da5..aa1736d47 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -3,5 +3,8 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - type: listtest.lister + - entity_type: listtest.lister friends: ["Rimmer", "Holly", "Cat", "Kryten"] + + # - entity_entity_type: listtest.lister + # friends: '{{ ["Rimmer"] + ["tt"] | list }}' diff --git a/tests/samples/iocs/motorSim.ibek.ioc.yaml b/tests/samples/iocs/motorSim.ibek.ioc.yaml index 7a833a03d..becd28d4d 100644 --- a/tests/samples/iocs/motorSim.ibek.ioc.yaml +++ b/tests/samples/iocs/motorSim.ibek.ioc.yaml @@ -4,17 +4,17 @@ ioc_name: "{{ ioc_yaml_file_name }}" description: Example simulated motion IOC for Testing ibek entities: - - type: asyn.AsynIP + - entity_type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - type: motorSim.simMotorController + - entity_type: motorSim.simMotorController port: controllerOnePort controllerName: controllerOne numAxes: 4 P: "IBEK-MO-TST-01:" - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne # Use ADDR in other fields to verify jinja templating between Args M: M{{ADDR}} @@ -23,7 +23,7 @@ entities: DESC: "Motor {{ADDR}} for ioc {{ioc_name}}" home: 500 - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 1 @@ -31,21 +31,21 @@ entities: DESC: "Motor {{ADDR}} {% raw %} {{enclosed in escaped curly braces}} {% endraw %}" home: 500 - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 2 # testing default DESC home: 1500 - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 3 DESC: "Motor {{ADDR}}" home: 2500 - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne M: CS_M{{ADDR}} ADDR: 1 @@ -54,7 +54,7 @@ entities: CS_NUM: 3 is_cs: true - - type: motorSim.simMotorAxis + - entity_type: motorSim.simMotorAxis controller: controllerOne M: CS_M{{ADDR}} ADDR: 2 diff --git a/tests/samples/iocs/quadem.ibek.ioc.yaml b/tests/samples/iocs/quadem.ibek.ioc.yaml index d40034fe8..b4b8bce02 100644 --- a/tests/samples/iocs/quadem.ibek.ioc.yaml +++ b/tests/samples/iocs/quadem.ibek.ioc.yaml @@ -4,14 +4,14 @@ ioc_name: "{{ __utils__.get_env('IOC_NAME') }}" description: Example TetrAMM for BL03I entities: - - type: quadEM.TetrAMM + - entity_type: quadEM.TetrAMM PORT: XBPM1.DRV P: BL03I-EA-XBPM-01 R: ":DRV:" QSIZE: 20 IP: "172.23.103.85:10001" - - type: quadEM.Plugins + - entity_type: quadEM.Plugins DEVICE: XBPM1.DRV PORTPREFIX: XBPM1 STAT_NCHAN: 1000 diff --git a/tests/samples/iocs/technosoft.ibek.ioc.yaml b/tests/samples/iocs/technosoft.ibek.ioc.yaml index 651547f12..650ba1697 100644 --- a/tests/samples/iocs/technosoft.ibek.ioc.yaml +++ b/tests/samples/iocs/technosoft.ibek.ioc.yaml @@ -5,7 +5,7 @@ description: YAG motors shared: - &motor - type: motorTML.motorAxis + entity_type: motorTML.motorAxis controller: TML NSTEPS: 200 NMICROSTEPS: 256 @@ -25,7 +25,7 @@ shared: TIMEOUT: 0 entities: - - type: motorTML.CreateController + - entity_type: motorTML.CreateController controllerName: TML P: "SPARC:TML" TTY: /tmp # /var/tmp/ttyV0 diff --git a/tests/samples/iocs/utils.ibek.ioc.yaml b/tests/samples/iocs/utils.ibek.ioc.yaml index d4eabe21c..d52fbf014 100644 --- a/tests/samples/iocs/utils.ibek.ioc.yaml +++ b/tests/samples/iocs/utils.ibek.ioc.yaml @@ -3,5 +3,5 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - type: epics.InterruptVectorVME + - entity_type: epics.InterruptVectorVME name: Vec0 diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json index 113f716b9..2eedcb5b6 100644 --- a/tests/samples/schemas/gauges.ibek.ioc.schema.json +++ b/tests/samples/schemas/gauges.ibek.ioc.schema.json @@ -3,11 +3,10 @@ "asyn_AsynIP": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "asyn.AsynIP", - "default": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -108,6 +107,7 @@ } }, "required": [ + "entity_type", "port", "name" ], @@ -143,11 +143,10 @@ "gauges_GaugeGroup": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "gauges.GaugeGroup", - "default": "gauges.GaugeGroup", "description": "Group of gauges", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -181,6 +180,7 @@ } }, "required": [ + "entity_type", "name", "gauge1" ], @@ -190,11 +190,10 @@ "gauges_Mks937bGauge": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "gauges.Mks937bGauge", - "default": "gauges.Mks937bGauge", "description": "MKS 937b Gauge controller", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -218,6 +217,7 @@ } }, "required": [ + "entity_type", "port", "name", "P" @@ -264,7 +264,7 @@ "gauges.GaugeGroup": "#/$defs/gauges_GaugeGroup", "gauges.Mks937bGauge": "#/$defs/gauges_Mks937bGauge" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index d1b85d012..e758e8ec7 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -611,9 +611,9 @@ "additionalProperties": true, "description": "A loosely defined class to declare the Entities\nin an ibek.support.yaml file in the 'sub_entities' property of an Entity\nsection", "properties": { - "type": { + "entity_type": { "description": "The type of this entity", - "title": "Type", + "title": "Entity Type", "type": "string" }, "entity_enabled": { @@ -624,7 +624,7 @@ } }, "required": [ - "type" + "entity_type" ], "title": "SubEntity", "type": "object" diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index a3cf2ff73..e85afcf54 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -3,11 +3,10 @@ "listtest_lister": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "listtest.lister", - "default": "listtest.lister", "description": "The protagonist from Red Dwarf", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -29,6 +28,7 @@ } }, "required": [ + "entity_type", "friends" ], "title": "listtest_lister", @@ -54,7 +54,7 @@ "mapping": { "listtest.lister": "#/$defs/listtest_lister" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json index 832dfe9a6..746616f7e 100644 --- a/tests/samples/schemas/motorSim.ibek.ioc.schema.json +++ b/tests/samples/schemas/motorSim.ibek.ioc.schema.json @@ -11,11 +11,10 @@ "asyn_AsynIP": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "asyn.AsynIP", - "default": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -116,6 +115,7 @@ } }, "required": [ + "entity_type", "port", "name" ], @@ -151,11 +151,10 @@ "motorSim_simMotorAxis": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorSim.simMotorAxis", - "default": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -242,6 +241,7 @@ } }, "required": [ + "entity_type", "controller", "M", "ADDR" @@ -252,11 +252,10 @@ "motorSim_simMotorController": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorSim.simMotorController", - "default": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -291,6 +290,7 @@ } }, "required": [ + "entity_type", "controllerName", "P", "numAxes", @@ -338,7 +338,7 @@ "motorSim.simMotorAxis": "#/$defs/motorSim_simMotorAxis", "motorSim.simMotorController": "#/$defs/motorSim_simMotorController" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/quadem.ibek.ioc.schema.json b/tests/samples/schemas/quadem.ibek.ioc.schema.json index 7d93f5a09..d31a81cb4 100644 --- a/tests/samples/schemas/quadem.ibek.ioc.schema.json +++ b/tests/samples/schemas/quadem.ibek.ioc.schema.json @@ -3,11 +3,10 @@ "ADCore_NDAttrPlot": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDAttrPlot", - "default": "ADCore.NDAttrPlot", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -107,6 +106,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -122,11 +122,10 @@ "ADCore_NDAttribute": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDAttribute", - "default": "ADCore.NDAttribute", "description": "This plugin displays NDArray attributes", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -218,6 +217,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -229,11 +229,10 @@ "ADCore_NDAttributes": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDAttributes", - "default": "ADCore.NDAttributes", "description": "Add an attribute to the NDAttributes file for a particular ADDriver or\n NDPlugin, and associate it with the NDAttributes file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -260,6 +259,15 @@ "title": "Attrname", "type": "string" }, + "type": { + "allOf": [ + { + "$ref": "#/$defs/type" + } + ], + "default": "EPICS_PV", + "description": "Where the data should be picked up from" + }, "dbrtype": { "allOf": [ { @@ -291,6 +299,7 @@ } }, "required": [ + "entity_type", "port", "source", "name", @@ -303,11 +312,10 @@ "ADCore_NDCircularBuff": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDCircularBuff", - "default": "ADCore.NDCircularBuff", "description": "This plugin provides a pre and post external trigger frame capture buffer", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -399,6 +407,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -410,11 +419,10 @@ "ADCore_NDCodec": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDCodec", - "default": "ADCore.NDCodec", "description": "This plugin can compress or decompress NDArrays", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -494,6 +502,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -505,11 +514,10 @@ "ADCore_NDColorConvert": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDColorConvert", - "default": "ADCore.NDColorConvert", "description": "This plugin converts arrays from one colour type to another, e.g. Bayer -> RGB1", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -589,6 +597,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -600,11 +609,10 @@ "ADCore_NDFFT": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFFT", - "default": "ADCore.NDFFT", "description": "This plugin is used to calculate the FFT of a time series", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -713,6 +721,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -725,11 +734,10 @@ "ADCore_NDFileHDF5": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileHDF5", - "default": "ADCore.NDFileHDF5", "description": "This plugin can compress NDArrays to HDF5 and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -809,6 +817,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -820,11 +829,10 @@ "ADCore_NDFileJPEG": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileJPEG", - "default": "ADCore.NDFileJPEG", "description": "This plugin can compress NDArrays to JPEG and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -898,6 +906,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -909,11 +918,10 @@ "ADCore_NDFileMagick": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileMagick", - "default": "ADCore.NDFileMagick", "description": "This plugin can compress NDArrays to a range of formats supported by\n graphics magick and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -987,6 +995,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -998,11 +1007,10 @@ "ADCore_NDFileNetCDF": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileNetCDF", - "default": "ADCore.NDFileNetCDF", "description": "This plugin can compress NDArrays to NetCDF and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1076,6 +1084,7 @@ } }, "required": [ + "entity_type", "P", "R", "NDARRAY_PORT", @@ -1087,11 +1096,10 @@ "ADCore_NDFileNexus": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileNexus", - "default": "ADCore.NDFileNexus", "description": "This plugin can compress NDArrays to Nexus and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1165,6 +1173,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -1176,11 +1185,10 @@ "ADCore_NDFileNull": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileNull", - "default": "ADCore.NDFileNull", "description": "Null file plugin for deleting driver files", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1254,6 +1262,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -1265,11 +1274,10 @@ "ADCore_NDFileTIFF": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDFileTIFF", - "default": "ADCore.NDFileTIFF", "description": "This plugin can compress NDArrays to TIFF and write them to file", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1343,6 +1351,7 @@ } }, "required": [ + "entity_type", "P", "R", "NDARRAY_PORT", @@ -1354,11 +1363,10 @@ "ADCore_NDGather": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDGather", - "default": "ADCore.NDGather", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1439,6 +1447,7 @@ } }, "required": [ + "entity_type", "NDARRAY_PORT", "PORT", "P", @@ -1450,11 +1459,10 @@ "ADCore_NDGather8": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDGather8", - "default": "ADCore.NDGather8", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1539,6 +1547,7 @@ } }, "required": [ + "entity_type", "NDARRAY_PORT", "PORT", "P", @@ -1552,11 +1561,10 @@ "ADCore_NDOverlay": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDOverlay", - "default": "ADCore.NDOverlay", "description": "This plugin writes overlays on the array, like cursors and boxes", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1691,6 +1699,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -1713,11 +1722,10 @@ "ADCore_NDPosPlugin": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDPosPlugin", - "default": "ADCore.NDPosPlugin", "description": "This plugin attaches position information to NDArrays", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1803,6 +1811,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -1814,11 +1823,10 @@ "ADCore_NDProcess": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDProcess", - "default": "ADCore.NDProcess", "description": "This plugin does image processing like flat field correction, background\n subtraction, and recursive filtering", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1892,6 +1900,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -1903,11 +1912,10 @@ "ADCore_NDPvaPlugin": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDPvaPlugin", - "default": "ADCore.NDPvaPlugin", "description": "This plugin makes NDArrays available through PVAccess", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -1998,6 +2006,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2010,11 +2019,10 @@ "ADCore_NDROI": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDROI", - "default": "ADCore.NDROI", "description": "This plugin selects a region of interest and optionally scales it to\n fit in a particular data type", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2094,6 +2102,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2105,11 +2114,10 @@ "ADCore_NDROIStat": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDROIStat", - "default": "ADCore.NDROIStat", "description": "This plugin calculates statistics of ROIs", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2201,6 +2209,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2212,11 +2221,10 @@ "ADCore_NDScatter": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDScatter", - "default": "ADCore.NDScatter", "description": "This plugin is used to distribute processing of NDArrays to multiple downstream plugins", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2296,6 +2304,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2307,11 +2316,10 @@ "ADCore_NDStats": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDStats", - "default": "ADCore.NDStats", "description": "This plugin calculates statistics like X and Y profile, centroid, and plots a histogram of binned pixels", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2418,6 +2426,7 @@ } }, "required": [ + "entity_type", "PORT", "NDARRAY_PORT", "HIST_SIZE", @@ -2432,11 +2441,10 @@ "ADCore_NDStdArrays": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDStdArrays", - "default": "ADCore.NDStdArrays", "description": "This plugin provides a waveform record that can display the NDArrays\n produced by its NDARRAY_PORT", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2534,6 +2542,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2548,11 +2557,10 @@ "ADCore_NDTimeSeries": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDTimeSeries", - "default": "ADCore.NDTimeSeries", "description": "This plugin creates time series arrays from callback data", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2660,6 +2668,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2673,11 +2682,10 @@ "ADCore_NDTransform": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore.NDTransform", - "default": "ADCore.NDTransform", "description": "This plugin selects a region of interest and optionally scales it to fit in a particular data type", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2757,6 +2765,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2768,11 +2777,10 @@ "ADCore__NDCircularBuff": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "ADCore._NDCircularBuff", - "default": "ADCore._NDCircularBuff", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2847,6 +2855,7 @@ } }, "required": [ + "entity_type", "P", "R", "PORT", @@ -2913,11 +2922,10 @@ "quadEM_Plugins": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "quadEM.Plugins", - "default": "quadEM.Plugins", "description": "Instantiates\n 12 NDStats plugins for Current, Sum, Diff and Pos Channels\n 12 NDTimeSeries plugins\n 12 NDArray plugins", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -2958,6 +2966,7 @@ } }, "required": [ + "entity_type", "DEVICE", "PORTPREFIX", "STAT_NCHAN", @@ -2969,11 +2978,10 @@ "quadEM_TetrAMM": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "quadEM.TetrAMM", - "default": "quadEM.TetrAMM", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -3015,6 +3023,7 @@ } }, "required": [ + "entity_type", "PORT", "P", "R", @@ -3022,6 +3031,14 @@ ], "title": "quadEM_TetrAMM", "type": "object" + }, + "type": { + "enum": [ + "EPICS_PV", + "PARAM" + ], + "title": "type", + "type": "string" } }, "additionalProperties": false, @@ -3072,7 +3089,7 @@ "quadEM.Plugins": "#/$defs/quadEM_Plugins", "quadEM.TetrAMM": "#/$defs/quadEM_TetrAMM" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/single.ibek.ioc.schema.json b/tests/samples/schemas/single.ibek.ioc.schema.json index 6dca67d83..941efa439 100644 --- a/tests/samples/schemas/single.ibek.ioc.schema.json +++ b/tests/samples/schemas/single.ibek.ioc.schema.json @@ -11,11 +11,10 @@ "motorSim_simMotorAxis": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorSim.simMotorAxis", - "default": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -102,6 +101,7 @@ } }, "required": [ + "entity_type", "controller", "M", "ADDR" @@ -112,11 +112,10 @@ "motorSim_simMotorController": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorSim.simMotorController", - "default": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -151,6 +150,7 @@ } }, "required": [ + "entity_type", "controllerName", "P", "numAxes", @@ -180,7 +180,7 @@ "motorSim.simMotorAxis": "#/$defs/motorSim_simMotorAxis", "motorSim.simMotorController": "#/$defs/motorSim_simMotorController" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index a70c4423d..c366e5552 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -11,11 +11,10 @@ "motorTML_CreateController": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorTML.CreateController", - "default": "motorTML.CreateController", "description": "Creates a Technosoft motion controller connected to a serial line", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -63,6 +62,7 @@ } }, "required": [ + "entity_type", "controllerName", "P", "TTY", @@ -74,11 +74,10 @@ "motorTML_motorAxis": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "motorTML.motorAxis", - "default": "motorTML.motorAxis", "description": "Creates a motor axis", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -244,6 +243,7 @@ } }, "required": [ + "entity_type", "controller", "axid" ], @@ -271,7 +271,7 @@ "motorTML.CreateController": "#/$defs/motorTML_CreateController", "motorTML.motorAxis": "#/$defs/motorTML_motorAxis" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/schemas/utils.ibek.ioc.schema.json b/tests/samples/schemas/utils.ibek.ioc.schema.json index fd064d180..3c1a26ea1 100644 --- a/tests/samples/schemas/utils.ibek.ioc.schema.json +++ b/tests/samples/schemas/utils.ibek.ioc.schema.json @@ -3,11 +3,10 @@ "epics_InterruptVectorVME": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "epics.InterruptVectorVME", - "default": "epics.InterruptVectorVME", "description": "Reserve an interrupt vector for use with VME hardware.\n", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -34,6 +33,7 @@ } }, "required": [ + "entity_type", "name" ], "title": "epics_InterruptVectorVME", @@ -42,11 +42,10 @@ "epics_InterruptVectorVME2": { "additionalProperties": false, "properties": { - "type": { + "entity_type": { "const": "epics.InterruptVectorVME2", - "default": "epics.InterruptVectorVME2", "description": "naughty second use of same counter", - "title": "Type" + "title": "Entity Type" }, "entity_enabled": { "default": true, @@ -61,6 +60,7 @@ } }, "required": [ + "entity_type", "name" ], "title": "epics_InterruptVectorVME2", @@ -87,7 +87,7 @@ "epics.InterruptVectorVME": "#/$defs/epics_InterruptVectorVME", "epics.InterruptVectorVME2": "#/$defs/epics_InterruptVectorVME2" }, - "propertyName": "type" + "propertyName": "entity_type" }, "oneOf": [ { diff --git a/tests/samples/support/ADCore.ibek.support.yaml b/tests/samples/support/ADCore.ibek.support.yaml index fd1ed3a46..82a0baf71 100644 --- a/tests/samples/support/ADCore.ibek.support.yaml +++ b/tests/samples/support/ADCore.ibek.support.yaml @@ -1977,7 +1977,7 @@ defs: NDStatsConfigure("{{PORT}}", {{QUEUE}}, {{BLOCK}}, "{{NDARRAY_PORT}}", {{NDARRAY_ADDR}}, 0, 0, 0, 0, {{MAX_THREADS}}) sub_entities: - - { type: ADCore.NDTimeSeries, P: "{{P}}", R: "{{R}}TS:", PORT: "{{PORT}}_TS", NDARRAY_PORT: "{{PORT}}", NAME: "{{PORT}}_TS", NCHANS: "{{NCHANS}}", TIMEOUT: "{{TIMEOUT}}", ADDR: 0, NDARRAY_ADDR: 1, ENABLED: "{{ENABLED}}", QUEUE: "{{QUEUE}}", BLOCK: "{{BLOCK}}", NSIGNALS: 23 } + - { entity_type: ADCore.NDTimeSeries, P: "{{P}}", R: "{{R}}TS:", PORT: "{{PORT}}_TS", NDARRAY_PORT: "{{PORT}}", NAME: "{{PORT}}_TS", NCHANS: "{{NCHANS}}", TIMEOUT: "{{TIMEOUT}}", ADDR: 0, NDARRAY_ADDR: 1, ENABLED: "{{ENABLED}}", QUEUE: "{{QUEUE}}", BLOCK: "{{BLOCK}}", NSIGNALS: 23 } pvi: yaml_path: NDPluginStats.pvi.device.yaml diff --git a/tests/samples/support/quadem.ibek.support.yaml b/tests/samples/support/quadem.ibek.support.yaml index d7f682be4..e0336d23c 100644 --- a/tests/samples/support/quadem.ibek.support.yaml +++ b/tests/samples/support/quadem.ibek.support.yaml @@ -110,8 +110,8 @@ defs: # shared: - - &stats { type: ADCore.NDStats, P: "{{DEVICE.P}}", NCHANS: "{{STAT_NCHAN}}", XSIZE: "{{STAT_XSIZE}}", YSIZE: 0, HIST_SIZE: "{{HIST_SIZE}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1 } - - &arrays { type: ADCore.NDStdArrays, P: "{{DEVICE.P}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1, TYPE: "Float64", FTVL: "DOUBLE", NELEMENTS: "{{STAT_XSIZE}}" } + - &stats { entity_type: ADCore.NDStats, P: "{{DEVICE.P}}", NCHANS: "{{STAT_NCHAN}}", XSIZE: "{{STAT_XSIZE}}", YSIZE: 0, HIST_SIZE: "{{HIST_SIZE}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1 } + - &arrays { entity_type: ADCore.NDStdArrays, P: "{{DEVICE.P}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1, TYPE: "Float64", FTVL: "DOUBLE", NELEMENTS: "{{STAT_XSIZE}}" } sub_entities: - { <<: *stats, PORT: "{{PORTPREFIX}}.STATS.I1", R: Cur1 } diff --git a/tests/test_render.py b/tests/test_render.py index de8e9e5b2..38c17ea6b 100644 --- a/tests/test_render.py +++ b/tests/test_render.py @@ -12,7 +12,7 @@ def find_entity_class(entity_classes, entity_type): for entity_class in entity_classes: literal = Literal[entity_type] # type: ignore - if entity_class.model_fields["type"].annotation == literal: + if entity_class.model_fields["entity_type"].annotation == literal: return entity_class else: raise ValueError(f"{entity_type} not found in entity_classes") @@ -21,8 +21,11 @@ def find_entity_class(entity_classes, entity_type): def test_pre_init_script(asyn_classes): definition = find_entity_class(asyn_classes, "asyn.AsynIP") - port1 = definition(name="asyn1", port="10.0.1.1") - port2 = definition(name="asyn2", port="10.0.1.2") + # NOTE: because we have switched from type to entity_type in the + # we need to pass it to the constructor + # Not ideal - but does not affect deserialization of these types + port1 = definition(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") + port2 = definition(name="asyn2", port="10.0.1.2", entity_type="asyn.AsynIP") render = Render() script_txt = render.render_script(port1, port1.__definition__.pre_init) @@ -46,9 +49,13 @@ def test_obj_ref_script(motor_classes): asyn_def = find_entity_class(motor_classes, "asyn.AsynIP") motor_def = find_entity_class(motor_classes, "motorSim.simMotorController") - asyn_def(name="asyn1", port="10.0.1.1") + asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") motor_obj = motor_def( - port="asyn1", controllerName="ctrl1", P="IBEK-MO-01:", numAxes=4 + port="asyn1", + controllerName="ctrl1", + P="IBEK-MO-01:", + numAxes=4, + entity_type="motorSim.simMotorController", ) render = Render() @@ -66,16 +73,29 @@ def test_database_render(motor_classes): sim_def = find_entity_class(motor_classes, "motorSim.simMotorController") motor_def = find_entity_class(motor_classes, "motorSim.simMotorAxis") - asyn1 = asyn_def(name="asyn1", port="10.0.1.1") + asyn1 = asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") # TODO removing DESC below causes a failure in jinja templating # The default DESC field contains jinja escaping and this fails for some # reason. But it works fine in the test test_build_runtime_motorSim which # is what really counts I guess. sim_motor = sim_def( - port="asyn1", controllerName="ctrl1", P="IBEK-MO-01:", numAxes=4, DESC="test" + port="asyn1", + controllerName="ctrl1", + P="IBEK-MO-01:", + numAxes=4, + DESC="test", + entity_type="motorSim.simMotorController", + ) + motor1 = motor_def( + controller="ctrl1", M="M1", ADDR=1, entity_type="motorSim.simMotorAxis" + ) + motor2 = motor_def( + controller="ctrl1", + M="M2", + ADDR=2, + is_cs=True, + entity_type="motorSim.simMotorAxis", ) - motor1 = motor_def(controller="ctrl1", M="M1", ADDR=1) - motor2 = motor_def(controller="ctrl1", M="M2", ADDR=2, is_cs=True) # make a dummy IOC with two entities as database render works against # a whole IOC rather than a single entity at a time. @@ -103,7 +123,7 @@ def test_database_render(motor_classes): def test_environment_variables(motor_classes): asyn_def = find_entity_class(motor_classes, "asyn.AsynIP") - asyn_obj = asyn_def(name="asyn1", port="10.0.1.1") + asyn_obj = asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") render = Render() env_text = render.render_environment_variables(asyn_obj) diff --git a/tests/test_unit.py b/tests/test_unit.py index 9575c2304..c2559acb9 100644 --- a/tests/test_unit.py +++ b/tests/test_unit.py @@ -45,15 +45,15 @@ def test_object_references(entity_factory): ioc_name="", description="", entities=[ - dict(type="mymodule.port", name="PORT"), - dict(type="mymodule.device", port="PORT"), + dict(entity_type="mymodule.port", name="PORT"), + dict(entity_type="mymodule.device", port="PORT"), ], ) ioc = ioc_model(**d) port, device = ioc.entities # TODO try to get rid of the need for '' - assert port.type == "mymodule.port" - assert device.type == "mymodule.device" + assert port.entity_type == "mymodule.port" + assert device.entity_type == "mymodule.device" assert device.port is port assert id_to_entity == {"PORT": port} From f422713898d1f632f0f7ea220c8378f7d2977fe3 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 08:20:25 +0000 Subject: [PATCH 05/24] linting --- src/ibek/entity_factory.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 0f861d37b..afd531b88 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -9,7 +9,6 @@ from typing import Annotated, Any, Dict, List, Literal, Tuple, Type from pydantic import Field, create_model, field_validator -from pydantic.fields import FieldInfo from pydantic_core import PydanticUndefined, ValidationError from ruamel.yaml.main import YAML From a63dbf8da358de7ec0c520dd68d2d0a6f9bc9f40 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 17:51:43 +0000 Subject: [PATCH 06/24] change type on args to arg_type --- src/ibek/args.py | 18 +- src/ibek/definition.py | 18 +- src/ibek/entity_factory.py | 15 +- tests/generate_samples.sh | 2 +- tests/samples/output | 9283 ----------------- .../samples/outputs/dlsPLC.ibek.support.yaml | 3446 +++--- .../samples/schemas/ibek.support.schema.json | 56 +- .../samples/support/ADCore.ibek.support.yaml | 736 +- tests/samples/support/asyn.ibek.support.yaml | 26 +- .../samples/support/bad_db.ibek.support.yaml | 2 +- .../samples/support/dlsPLC.ibek.support.yaml | 3448 +++--- tests/samples/support/epics.ibek.support.yaml | 24 +- .../samples/support/gauges.ibek.support.yaml | 16 +- tests/samples/support/ipac.ibek.support.yaml | 56 +- .../samples/support/listarg.ibek.support.yaml | 4 +- .../support/motorSim.ibek.support.yaml | 36 +- .../samples/support/quadem.ibek.support.yaml | 24 +- .../support/technosoft.ibek.support.yaml | 60 +- tests/samples/support/utils.ibek.support.yaml | 10 +- 19 files changed, 4011 insertions(+), 13269 deletions(-) delete mode 100644 tests/samples/output diff --git a/src/ibek/args.py b/src/ibek/args.py index 2154e73cd..a8fe0e3a2 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -25,7 +25,7 @@ class Value(BaseSettings): class Arg(BaseSettings): """Base class for all Argument Types""" - type: str + arg_type: str name: str = Field( description="Name of the argument that the IOC instance should pass" ) @@ -37,56 +37,56 @@ class Arg(BaseSettings): class ListArg(Arg): """An argument with a float value""" - type: Literal["list"] = "list" + arg_type: Literal["list"] = "list" default: Optional[list] = None class FloatArg(Arg): """An argument with a float value""" - type: Literal["float"] = "float" + arg_type: Literal["float"] = "float" default: Optional[float] = None class StrArg(Arg): """An argument with a str value""" - type: Literal["str"] = "str" + arg_type: Literal["str"] = "str" default: Optional[str] = None class IntArg(Arg): """An argument with an int value""" - type: Literal["int"] = "int" + arg_type: Literal["int"] = "int" default: Optional[int] = None class BoolArg(Arg): """An argument with an bool value""" - type: Literal["bool"] = "bool" + arg_type: Literal["bool"] = "bool" default: Optional[bool] = None class ObjectArg(Arg): """A reference to another entity defined in this IOC""" - type: Literal["object"] = "object" + arg_type: Literal["object"] = "object" default: Optional[str] = None class IdArg(Arg): """Explicit ID argument that an object can refer to""" - type: Literal["id"] = "id" + arg_type: Literal["id"] = "id" default: Optional[str] = None class EnumArg(Arg): """An argument with an enum value""" - type: Literal["enum"] = "enum" + arg_type: Literal["enum"] = "enum" default: Optional[Any] = None values: Dict[str, Any] = Field( diff --git a/src/ibek/definition.py b/src/ibek/definition.py index 3778e6b67..95192cb41 100644 --- a/src/ibek/definition.py +++ b/src/ibek/definition.py @@ -5,7 +5,7 @@ from __future__ import annotations from enum import Enum -from typing import Any, Mapping, Optional, Sequence, Union +from typing import Annotated, Any, Mapping, Optional, Sequence, Union from pydantic import Field, PydanticUndefinedAnnotation from typing_extensions import Literal @@ -68,7 +68,7 @@ class Comment(BaseSettings): for insertion into the startup script """ - type: Literal["comment"] = "comment" + arg_type: Literal["comment"] = "comment" when: When = Field(description="One of first / every / last", default="every") value: str = Field( description="A comment to add into the startup script", default="" @@ -80,7 +80,7 @@ class Text(BaseSettings): A script snippet to insert into the startup script """ - type: Literal["text"] = "text" + arg_type: Literal["text"] = "text" when: str = Field(description="One of first / every / last", default="every") value: str = Field(description="raw text to add to the startup script", default="") @@ -115,6 +115,12 @@ class EntityPVI(BaseSettings): pv_prefix: str = Field("", description='PV prefix for PVI PV - e.g. "$(P)"') +discriminated = Annotated[ # type: ignore + Union[tuple(Arg.__subclasses__())], + Field(discriminator="arg_type", description="union of arg types"), +] + + class EntityDefinition(BaseSettings): """ A single definition of a class of Entity that an IOC instance may instantiate @@ -127,8 +133,10 @@ class EntityDefinition(BaseSettings): description="A description of the Support module defined here" ) # declare Arg as Union of its subclasses for Pydantic to be able to deserialize - args: Sequence[Union[tuple(Arg.__subclasses__())]] = Field( # type: ignore - description="The arguments IOC instance should supply", default=() + + args: Sequence[discriminated] = Field( # type: ignore + description="The arguments IOC instance should supply", + default=(), ) values: Sequence[Value] = Field( description="Calculated values to use as additional arguments " diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index afd531b88..1f2c1b47c 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -79,12 +79,14 @@ def add_arg(name, typ, description, default): # add in each of the arguments as a Field in the Entity for arg in definition.args: - full_arg_name = f"{full_name}.{arg.name}" + # TODO - don't understand why I need type ignore here + # arg is 'discriminated' which is a Union of all the Arg subclasses + full_arg_name = f"{full_name}.{arg.name}" # type: ignore arg_type: Any if isinstance(arg, ObjectArg): - - @field_validator(arg.name, mode="after") + # TODO look into why arg.name requires type ignore + @field_validator(arg.name, mode="after") # type: ignore def lookup_instance(cls, id): return get_entity_by_id(id) @@ -106,9 +108,10 @@ def lookup_instance(cls, id): arg_type = val_enum else: - # arg.type is str, int, float, etc. - arg_type = getattr(builtins, arg.type) - add_arg(arg.name, arg_type, arg.description, getattr(arg, "default")) + # arg.arg_type is str, int, float, etc. + arg_type = getattr(builtins, arg.arg_type) + # TODO look into why arg.name requires type ignore + add_arg(arg.name, arg_type, arg.description, getattr(arg, "default")) # type: ignore # add in the calculated values Jinja Templates as Fields in the Entity for value in definition.values: diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index 5caf63cc3..6c607649d 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -18,7 +18,7 @@ cd $SAMPLES_DIR mkdir -p schemas mkdir -p outputs -set -ex +set -e mkdir -p epics/pvi-defs cp support/simple.pvi.device.yaml epics/pvi-defs/simple.pvi.device.yaml diff --git a/tests/samples/output b/tests/samples/output deleted file mode 100644 index 08c418588..000000000 --- a/tests/samples/output +++ /dev/null @@ -1,9283 +0,0 @@ -module: dlsPLC -defs: -- name: overrideRequestIndividual - description: Template allowing override of individual interlock bits - args: - - type: str - name: P - description: device prefix - - type: str - name: DESC - description: Description (e.g. DCM piezo override) - - type: str - name: PRESSURE1 - description: Pressure in mbar that needs to be over setpoint to allow override - - type: str - name: PRESSURE2 - description: Pressure in mbar that needs to be over setpoint to allow override - - type: str - name: OVERRIDE - description: P of overrideRequestMain instance - - type: str - name: BIT - description: Bit of overrideRequestMain instance to use (0-8) - - type: str - name: SETPOINT - description: Setpoint in mbar that both pressures need to be higher than to allow - override - - type: id - name: name - description: This associates an edm screen with the template - databases: - - file: $(DLSPLC)/db/dlsPLC_overrideRequestIndividual.template - args: - name: - SETPOINT: - PRESSURE2: - P: - PRESSURE1: - OVERRIDE: - BIT: - DESC: -- name: softwareVersion - description: Template that reads software version from a PLC. - args: - - type: str - name: device - description: Device prefix - databases: - - file: $(DLSPLC)/db/dlsPLC_softwareVersion.template - args: - device: -- name: vacValveBistable - description: Template database for a vacuum valve with different interlocks for - open and close operations - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: device name of valve control crate - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is - in DM150..159 then addr=150 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: cilk0 - description: Gauge interlock description 0 - default: unused - - type: str - name: cilk1 - description: Gauge interlock description 1 - default: unused - - type: str - name: cilk2 - description: Gauge interlock description 2 - default: unused - - type: str - name: cilk3 - description: Gauge interlock description 3 - default: unused - - type: str - name: cilk4 - description: Gauge interlock description 4 - default: unused - - type: str - name: cilk5 - description: Gauge interlock description 5 - default: unused - - type: str - name: cilk6 - description: Gauge interlock description 6 - default: unused - - type: str - name: cilk7 - description: Gauge interlock description 7 - default: unused - - type: str - name: cilk8 - description: Gauge interlock description 8 - default: unused - - type: str - name: cilk9 - description: Gauge interlock description 9 - default: unused - - type: str - name: cilk10 - description: Gauge interlock description 10 - default: unused - - type: str - name: cilk11 - description: Gauge interlock description 11 - default: unused - - type: str - name: cilk12 - description: Gauge interlock description 12 - default: unused - - type: str - name: cilk13 - description: Gauge interlock description 13 - default: unused - - type: str - name: cilk14 - description: Gauge interlock description 14 - default: unused - - type: str - name: cilk15 - description: Gauge interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: valvetype - description: Template argument - default: valve - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - - type: str - name: mode1 - description: Template argument - default: Operational - - type: str - name: mode2 - description: Template argument - default: Service - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValveBistable.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - ilk13: - gda_name: - allowpv: - cilk10: - ilksta_label4: - vlvcc: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - port: - ilksta_sv4: - con_label6: - ilk8: - ilksta_label1: - addr: - mode1: - con_label5: - con_label4: - ilksta_label5: - whylocked: - sta_label5: - sta_label4: - sta_label6: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - cilk12: - cilk13: - ilksta_label2: - cilk11: - timeout: - cilk14: - cilk15: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - valvetype: - ilk6: - ilk2: - ilk7: - device: - mode2: - cilk2: - ilksta_label3: - ilk1: - ilk5: - name: - ilk4: - ilk3: - cilk8: - cilk9: - ilk0: - con_label3: - ilk9: - cilk0: - cilk1: - gda_desc: - cilk3: - cilk4: - cilk5: - cilk6: - cilk7: -- name: writeEnum - description: Write the Enum value into a DM variable in a PLC - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: DM variable of the int - - type: id - name: name - description: Object name and gui association name - - type: int - name: timeout - description: timeout on PV write attempts - default: 0 - - type: int - name: VAL0 - description: Value for state 0 - default: 0 - - type: int - name: VAL1 - description: Value for state 1 - default: 1 - - type: int - name: VAL2 - description: Value for state 2 - default: 2 - - type: int - name: VAL3 - description: Value for state 3 - default: 3 - - type: int - name: VAL4 - description: Value for state 4 - default: 4 - - type: int - name: VAL5 - description: Value for state 5 - default: 5 - - type: int - name: VAL6 - description: Value for state 6 - default: 6 - - type: int - name: VAL7 - description: Value for state 7 - default: 7 - - type: str - name: STR0 - description: String Value for state 0 - default: '' - - type: str - name: STR1 - description: String Value for state 1 - default: '' - - type: str - name: STR2 - description: String Value for state 2 - default: '' - - type: str - name: STR3 - description: String Value for state 3 - default: '' - - type: str - name: STR4 - description: String Value for state 4 - default: '' - - type: str - name: STR5 - description: String Value for state 5 - default: '' - - type: str - name: STR6 - description: String Value for state 6 - default: '' - - type: str - name: STR7 - description: String Value for state 7 - default: '' - databases: - - file: $(DLSPLC)/db/dlsPLC_writeEnum.template - args: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - port: - addr: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: - Q: - P: - name: - timeout: -- name: flow - description: "This template defines a bi records for representing low and lolo\n - water flow switched read from MPS RIO boxes. Low switches will be read from\n - their normal DM variable (E.g. DM4), Lolo switches from the relevant interlock\n - bits. E.g. if interlock DM816..818 bit 4 is S1 water,\nuse loloaddress=818,lolobit=4 - for instantaneous lolo signal" - args: - - type: str - name: P - description: EPICS prefix - - type: str - name: Q - description: EPICS suffix - - type: str - name: DESC - description: Description - - type: str - name: device - description: EPICS name of the vacuum valve crate that connects to the RIO - - type: str - name: loaddress - description: Address of lo DM variable. E.g. if lo signal is in DM4 bit1 then - loaddress=4 lobit=1 - - type: str - name: lobit - description: Bit of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 - lobit=1 - - type: str - name: loloaddress - description: Address of lolo DM variable. E.g. if lolo signal is in DM818 bit4 - then loloaddress=818 lolobit=4 - - type: str - name: lolobit - description: Bit of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then - loloaddress=818 lolobit=4 - - type: id - name: name - description: This associates an edm screen with the template - databases: - - file: $(DLSPLC)/db/dlsPLC_flow.template - args: - loloaddress: - name: - lolobit: - P: - Q: - lobit: - device: - loaddress: - DESC: -- name: readEnum - description: Read the Enum value stored in a DM variable in a PLC - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: vlvcc - description: PLC control crate device prefix - - type: str - name: addr - description: DM variable of the int - - type: id - name: name - description: Object name and gui association name - - type: int - name: VAL0 - description: Value for state 0 - default: 0 - - type: int - name: VAL1 - description: Value for state 1 - default: 1 - - type: int - name: VAL2 - description: Value for state 2 - default: 2 - - type: int - name: VAL3 - description: Value for state 3 - default: 3 - - type: int - name: VAL4 - description: Value for state 4 - default: 4 - - type: int - name: VAL5 - description: Value for state 5 - default: 5 - - type: int - name: VAL6 - description: Value for state 6 - default: 6 - - type: int - name: VAL7 - description: Value for state 7 - default: 7 - - type: str - name: STR0 - description: String Value for state 0 - default: '' - - type: str - name: STR1 - description: String Value for state 1 - default: '' - - type: str - name: STR2 - description: String Value for state 2 - default: '' - - type: str - name: STR3 - description: String Value for state 3 - default: '' - - type: str - name: STR4 - description: String Value for state 4 - default: '' - - type: str - name: STR5 - description: String Value for state 5 - default: '' - - type: str - name: STR6 - description: String Value for state 6 - default: '' - - type: str - name: STR7 - description: String Value for state 7 - default: '' - databases: - - file: $(DLSPLC)/db/dlsPLC_readEnum.template - args: - vlvcc: - addr: - name: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - Q: - P: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: -- name: motionInterlockPLC - description: TODO:ADD DESCRIPTION - args: - - type: id - name: name - description: Name - - type: str - name: device - description: Device Prefix - - type: object - name: port - description: Fins port - - type: int - name: addr - description: First interlock work - - type: str - name: axis1Description - description: Axis 1 Description - default: unused - - type: str - name: axis2Description - description: Axis 2 Description - default: unused - - type: str - name: axis3Description - description: Axis 3 Description - default: unused - - type: str - name: axis4Description - description: Axis 4 Description - default: unused - - type: str - name: axis5Description - description: Axis 5 Description - default: unused - - type: str - name: axis6Description - description: Axis 6 Description - default: unused - - type: str - name: axis7Description - description: Axis 7 Description - default: unused - - type: str - name: axis8Description - description: Axis 8 Description - default: unused - - type: str - name: interlock - description: Interlock suffix (e.g. :INT1) - - type: str - name: desc - description: Permit description (e.g. Front end permit) - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: int - name: auto_reset - description: Set to 1 to push the reset button whenever the raw interlocks are - all ok - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_interlock.template - args: - ilk14: - ilk15: - ilk10: - ilk11: - ilk12: - ilk13: - interlock: - port: - addr: - timeout: - device: - desc: - name: - auto_reset: - ilk8: - ilk9: - ilk6: - ilk7: - ilk4: - ilk5: - ilk2: - ilk3: - ilk0: - ilk1: -- name: NX102_robotDX200_RW - description: Template database for reading and writing a real value for a DX200 - controller variable through NX102 PLC - args: - - type: str - name: device - description: PV prefix - - type: str - name: variable - description: PV suffix (its associated _RBV will be autogenerated). - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tagread - description: tag name of ether_ip read value - - type: str - name: tagwrite - description: tag name of ether_ip write value - - type: str - name: drvl - description: Lowest accepted value - - type: str - name: drvh - description: This associates an edm screen with the template - - type: id - name: name - description: Object name and gui association name - - type: str - name: desc - description: Description - default: '' - - type: str - name: readscan - description: value update time for readback value - default: 1 second - - type: float - name: writescan - description: value for Ethernet/IP update time - use value without "seconds", - e.g. 0.5 - default: 0.5 - - type: str - name: egu - description: Engineering units - default: '' - - type: int - name: prec - description: precision for reporting value back - default: 2 - databases: - - file: $(DLSPLC)/db/NX102_robotDXrealRW.template - args: - tagread: - name: - drvh: - drvl: - tagwrite: - egu: - device: - prec: - variable: - desc: - writescan: - port: - readscan: -- name: externalValve - description: Valve interface for a valve that lives in another IOC - args: - - type: str - name: device - description: Device macro of valve that exists in another IOC - - type: enum - name: valvetype - description: Type of Device - default: valve - values: - '"valve"': - '"absorber"': - '"shutter"': -- name: dummyValve - description: "Template database for a dummy vacuum valve, enough to keep\nvacuum - space happy\nPeter Denison 30/9/2005, based on vacuum valve by\nPete Owens - 26/4/04" - args: - - type: str - name: device - description: device name - - type: str - name: con_label0 - description: con_label0 - default: Open - - type: str - name: con_label1 - description: con_label1 - default: Close - - type: str - name: con_label2 - description: con_label2 - default: Reset - - type: str - name: con_label3 - description: con_label3 - default: '' - - type: str - name: con_label4 - description: con_label4 - default: '' - - type: str - name: con_label5 - description: con_label5 - default: '' - - type: str - name: con_label6 - description: con_label6 - default: '' - - type: str - name: ilksta_label0 - description: ilksta_label0 - default: Failed - - type: str - name: ilksta_label1 - description: ilksta_label1 - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: ilksta_label2 - default: OK - - type: str - name: ilksta_label3 - description: ilksta_label3 - default: Disarmed - - type: str - name: ilksta_label4 - description: ilksta_label4 - default: '' - - type: str - name: ilksta_label5 - description: ilksta_label5 - default: '' - - type: str - name: ilksta_sv0 - description: ilksta_sv0 - default: MAJOR - - type: str - name: ilksta_sv1 - description: ilksta_sv1 - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: ilksta_sv2 - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: ilksta_sv3 - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: ilksta_sv4 - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: ilksta_sv5 - default: NO_ALARM - - type: str - name: allowpv - description: Template argument - default: '' - databases: - - file: $(DLSPLC)/db/dlsPLC_dummyValve.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - ilksta_label0: - con_label6: - con_label5: - con_label4: - ilksta_label1: - allowpv: - ilksta_label3: - ilksta_label5: - ilksta_label4: - device: - ilksta_sv2: - ilksta_sv3: - ilksta_sv0: - ilksta_sv1: - ilksta_sv5: - ilksta_sv4: - ilksta_label2: -- name: fastValve - description: Template database for a vacuum valve without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: device name of valve control crate - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is in - DM110..118 then addr=110 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: gilk0 - description: Gauge interlock description 0 - default: unused - - type: str - name: gilk1 - description: Gauge interlock description 1 - default: unused - - type: str - name: gilk2 - description: Gauge interlock description 2 - default: unused - - type: str - name: gilk3 - description: Gauge interlock description 3 - default: unused - - type: str - name: gilk4 - description: Gauge interlock description 4 - default: unused - - type: str - name: gilk5 - description: Gauge interlock description 5 - default: unused - - type: str - name: gilk6 - description: Gauge interlock description 6 - default: unused - - type: str - name: gilk7 - description: Gauge interlock description 7 - default: unused - - type: str - name: gilk8 - description: Gauge interlock description 8 - default: unused - - type: str - name: gilk9 - description: Gauge interlock description 9 - default: unused - - type: str - name: gilk10 - description: Gauge interlock description 10 - default: unused - - type: str - name: gilk11 - description: Gauge interlock description 11 - default: unused - - type: str - name: gilk12 - description: Gauge interlock description 12 - default: unused - - type: str - name: gilk13 - description: Gauge interlock description 13 - default: unused - - type: str - name: gilk14 - description: Gauge interlock description 14 - default: unused - - type: str - name: gilk15 - description: Gauge interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: Arm - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open Armed - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: Open Disarmed - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: desc - description: Box label for gui - default: $(device) - - type: int - name: showilk - description: 0 (default) => Gauge, 1 => Arm - default: 0 - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - - type: str - name: mode1 - description: Template argument - default: Operational - - type: str - name: mode2 - description: Template argument - default: Service - databases: - - file: $(DLSPLC)/db/dlsPLC_fastValve.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - ilk13: - gda_name: - allowpv: - ilk8: - ilksta_label4: - ilk5: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - gilk14: - gilk15: - gilk12: - port: - gilk10: - con_label6: - ilksta_sv1: - ilksta_label1: - addr: - ilksta_sv0: - mode1: - con_label5: - con_label4: - ilksta_label5: - gilk13: - sta_label5: - sta_label4: - sta_label6: - gilk8: - sta_label0: - sta_label3: - sta_label2: - gilk4: - gilk5: - gilk6: - gilk11: - gilk0: - gilk1: - gilk2: - gilk9: - ilksta_label2: - vlvcc: - timeout: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - showilk: - ilksta_sv4: - device: - mode2: - whylocked: - desc: - ilksta_label3: - ilk4: - gilk7: - name: - ilksta_sv5: - sta_label1: - con_label3: - ilk9: - ilk6: - ilk7: - gda_desc: - gilk3: - ilk2: - ilk3: - ilk0: - ilk1: -- name: NX102_mpsPermit - description: TODO:ADD DESCRIPTION - args: - - type: str - name: device - description: Template argument - - type: str - name: port - description: Template argument - - type: str - name: tag - description: Template argument - - type: int - name: tagidx - description: Template argument - - type: str - name: DIRILK1 - description: Template argument - default: '' - databases: - - file: $(DLSPLC)/db/NX102_mpsPermit.template - args: - device: - tagidx: - tag: - port: - DIRILK1: -- name: BeamRecords - description: "Creates beam records that the gui can connect to to see which valves - and\n shutters are open" - args: - - type: str - name: P - description: Device prefix for summary PV, records will be $(P):STA$(N) for 1<=N<=#objects - - type: object - name: object0 - description: vacuumValve object - - type: object - name: object1 - description: vacuumValve object - - type: object - name: object2 - description: vacuumValve object - - type: object - name: object3 - description: vacuumValve object - - type: object - name: object4 - description: vacuumValve object - - type: object - name: object5 - description: vacuumValve object - - type: object - name: object6 - description: vacuumValve object - - type: object - name: object7 - description: vacuumValve object - - type: object - name: object8 - description: vacuumValve object - - type: object - name: object9 - description: vacuumValve object - - type: object - name: object10 - description: vacuumValve object - - type: object - name: object11 - description: vacuumValve object -- name: readFloat32 - description: Read the Float32 value stored in 2 DM variables in a PLC - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: DM variable of the LOWERer address of the float32 - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: id - name: name - description: Object name and gui association name - - type: str - name: SCAN - description: Scan rate of read record - default: 1 second - databases: - - file: $(DLSPLC)/db/dlsPLC_readFloat32.template - args: - name: - SCAN: - Q: - P: - timeout: - port: - addr: -- name: DCMHeater - description: "Initially created for use with I22's new (2021) DCM.\n Calc records - are created in the dlsPLC_DCMHeater.template file so that they have the archiver - tag applied." - args: - - type: id - name: name - description: Object name and gui association name - - type: str - name: P - description: Device Prefix - - type: str - name: Q - description: Device Suffix - - type: str - name: desc - description: Description - - type: str - name: vlvcc - description: Parent PLC control crate device prefix - - type: object - name: port - description: asyn port name of FINS driver - - type: int - name: C_addr - description: Address of the demand register - - type: int - name: UTSP_addr - description: Address of the under temperature setpoint register - - type: int - name: PID_offset - description: 2 digit integer offset of DM variables. E.g. if Proportional gain - constant setpoint is in DM150 and readback in DM250 offset=50 - - type: int - name: PID_output_addr - description: Address of the PID loop output - - type: str - name: addr - description: DM variable of the int - - type: int - name: VAL0 - description: Value for state 0 - default: 0 - - type: int - name: VAL1 - description: Value for state 1 - default: 1 - - type: int - name: VAL2 - description: Value for state 2 - default: 2 - - type: int - name: VAL3 - description: Value for state 3 - default: 3 - - type: int - name: VAL4 - description: Value for state 4 - default: 4 - - type: int - name: VAL5 - description: Value for state 5 - default: 5 - - type: int - name: VAL6 - description: Value for state 6 - default: 6 - - type: int - name: VAL7 - description: Value for state 7 - default: 7 - - type: str - name: STR0 - description: String Value for state 0 - default: '' - - type: str - name: STR1 - description: String Value for state 1 - default: '' - - type: str - name: STR2 - description: String Value for state 2 - default: '' - - type: str - name: STR3 - description: String Value for state 3 - default: '' - - type: str - name: STR4 - description: String Value for state 4 - default: '' - - type: str - name: STR5 - description: String Value for state 5 - default: '' - - type: str - name: STR6 - description: String Value for state 6 - default: '' - - type: str - name: STR7 - description: String Value for state 7 - default: '' - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: str - name: ftvl - description: Type of data in subArray - default: USHORT - databases: - - file: $(DLSPLC)/db/dlsPLC_readEnum.template - args: - vlvcc: - addr: - name: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - Q: - P: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: - - file: $(DLSPLC)/db/dlsPLC_DCMHeater.template - args: - Q: - P: - name: - desc: - - file: $(DLSPLC)/db/dlsPLC_writeInt16.template - args: - addr: - Q: - P: - timeout: - port: - name: - - file: $(DLSPLC)/db/dlsPLC_readInt16.template - args: - vlvcc: - ftvl: - addr: - Q: - P: - name: - - file: $(DLSPLC)/db/dlsPLC_writeEnum.template - args: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - port: - addr: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: - Q: - P: - name: - timeout: -- name: NX102_vacValve - description: Template database for a vacuum valve without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: port - description: EtherIP Port Name - - type: str - name: tag - description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int - name: ILKNUM - description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it. (Optional - defaults to "") - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom. (Optional. Defaults to "Open command not allowed") - default: Open command not allowed - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: con_label7 - description: Label string for control value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Alarm severity for status value 0 (Optional - defaults to MAJOR) - default: MAJOR - - type: str - name: sta_sv1 - description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv2 - description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv3 - description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv4 - description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv5 - description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv6 - description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv7 - description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for status value 0 (Optional - defaults to Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for status value 1 (Optional - defaults to Run Ilks - Ok) - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Label string for status value 2 (Optional - defaults to OK) - default: OK - - type: str - name: ilksta_label3 - description: Label string for status value 3 (Optional - defaults to Disarmed) - default: Disarmed - - type: str - name: ilksta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Alarm severity for interlock status value 6 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Alarm severity for interlock status value 7 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: mode1 - description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults - Operational) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE.ONAM) (Optional - defaults - Service) - default: Service - - type: str - name: DIRILK1 - description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for - "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve - or leave blank for ordinary valve. (Optional - defaults to "") - default: '' - - type: str - name: DIRILK2 - description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for - "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable - valves (Optional - defaults to "ILK2") - default: ILK2 - - type: id - name: name - description: Object name and associated gui name (Optional - defaults to - "") - - type: str - name: desc - description: Box label for gui (Optional - defaults to - value of device macro) - default: $(device) - databases: - - file: $(DLSPLC)/db/NX102_vacValve.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - ilksta_label5: - DIRILK1: - DIRILK2: - ilksta_sv7: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - sta_label6: - device: - whylocked: - desc: - ILKNUM: - name: - ilksta_label7: -- name: fastVacuumMaster - description: TODO:ADD DESCRIPTION - args: - - type: id - name: name - description: Gui tag - - type: str - name: dom - description: Domain, eg, FE06I - - type: object - name: fins_port - description: FINS port - - type: str - name: eip_port - description: EtherIP port - - type: str - name: device - description: Device prefix - values: - - description: device name - name: device - value: :- {{dom}}-VA-FAST-01 - databases: - - file: $(DLSPLC)/db/dlsPLC_fastVacuumMaster.template - args: - device: - eip_port: -- name: read100 - description: "Template that reads 100 blocks of memory into records so\nthat it - can be used in various templates." - args: - - type: str - name: device - description: Device prefix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: century - description: Read DM$(century)00..DM$(century)99 - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: str - name: SCAN - description: Scan rate of read record - default: 1 second - databases: - - file: $(DLSPLC)/db/dlsPLC_read100.template - args: - device: - century: - port: - timeout: - SCAN: -- name: NX102_temperature - description: "Template database for an individual temperature on a\ntemperature - PLC." - args: - - type: str - name: device - description: PV prefix - - type: str - name: temp - description: PV suffix - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: lolo - description: Lolo alarm limit - - type: str - name: low - description: Low alarm limit - - type: str - name: high - description: High alarm limit - - type: str - name: hihi - description: Hihi alarm limit - - type: str - name: hopr - description: High operating range - - type: str - name: lopr - description: Low operating range - - type: str - name: tag - description: Tag name on PLC -- default "Temp" for e.g. Temp.Value[tagindex] E - default: '"' - - type: str - name: llsv - description: Lolo severity - default: NO_ALARM - - type: str - name: lsv - description: Low severity - default: NO_ALARM - - type: int - name: hyst - description: alarm deadband - default: 0 - - type: float - name: adel - description: archiver deadband - default: 0.2 - - type: int - name: scalefac - description: scale factor for temperature/setpoint (1 for new PLC templates, 10 - for old where PLC reports in 10ths of a degree) - default: 1 - - type: int - name: tempcal - description: temperature calibration offset in egu (default=0) - default: 0 - - type: int - name: prec - description: precision for reporting value back - default: 1 - - type: id - name: name - description: Object and gui association name - - type: str - name: disable_pv - description: If set, then this is the value of A in disable_calc - default: $(device)$(temp):ZERO - - type: str - name: disable_calc - description: If this condition is met then save the current limit and set the - limit to 3276.7, disabling the interlock for this PV - default: A=1 - - type: str - name: egu - description: This associates an edm screen with the template - default: C - - type: str - name: desc - description: Description - databases: - - file: $(DLSPLC)/db/NX102_temperature.template - args: - lsv: - tag: - disable_calc: - port: - hyst: - tempcal: - lopr: - hopr: - lolo: - prec: - low: - disable_pv: - scalefac: - device: - desc: - high: - name: - temp: - hihi: - egu: - llsv: - adel: -- name: PIDControl - description: "Associates a PID control that runs on the PLC.\n Calc records are - created in the associated template file so that they have the archiver tag applied.\n\ - \ Initially created for use with K11's proportional valve (2021)." - args: - - type: id - name: name - description: Object name and gui association name - - type: str - name: P - description: Device Prefix - - type: str - name: Q - description: Device Suffix - - type: str - name: desc - description: Description - - type: str - name: vlvcc - description: Parent PLC control crate device prefix - - type: object - name: port - description: asyn port name of FINS driver - - type: int - name: SetValue_addr - description: Address of the value register for value setting - - type: int - name: PID_output_addr - description: Address of the current PID output value read - - type: int - name: Control_addr - description: Address of the demand register for mode setting - - type: int - name: PID_addr - description: Address of the PID values group read block (starting by Proportional - constant) - - type: int - name: PIDwrite_addr - description: Address of the PID values group write block (starting by Proportional - constant) - - type: str - name: units - description: Value units - - type: int - name: precision - description: Decimal precision for setpoint (converted from integer) - - type: str - name: addr - description: DM variable of the int - - type: int - name: VAL0 - description: Value for state 0 - default: 0 - - type: int - name: VAL1 - description: Value for state 1 - default: 1 - - type: int - name: VAL2 - description: Value for state 2 - default: 2 - - type: int - name: VAL3 - description: Value for state 3 - default: 3 - - type: int - name: VAL4 - description: Value for state 4 - default: 4 - - type: int - name: VAL5 - description: Value for state 5 - default: 5 - - type: int - name: VAL6 - description: Value for state 6 - default: 6 - - type: int - name: VAL7 - description: Value for state 7 - default: 7 - - type: str - name: STR0 - description: String Value for state 0 - default: '' - - type: str - name: STR1 - description: String Value for state 1 - default: '' - - type: str - name: STR2 - description: String Value for state 2 - default: '' - - type: str - name: STR3 - description: String Value for state 3 - default: '' - - type: str - name: STR4 - description: String Value for state 4 - default: '' - - type: str - name: STR5 - description: String Value for state 5 - default: '' - - type: str - name: STR6 - description: String Value for state 6 - default: '' - - type: str - name: STR7 - description: String Value for state 7 - default: '' - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: str - name: ftvl - description: Type of data in subArray - default: USHORT - - type: str - name: UNITS - description: common units - - type: int - name: PREC - description: decimal precision for SetPoint and Proportional Constant - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_readEnum.template - args: - vlvcc: - addr: - name: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - Q: - P: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: - - file: $(DLSPLC)/db/dlsPLC_writeInt16.template - args: - addr: - Q: - P: - timeout: - port: - name: - - file: $(DLSPLC)/db/dlsPLC_readInt16.template - args: - vlvcc: - ftvl: - addr: - Q: - P: - name: - - file: $(DLSPLC)/db/dlsPLC_writeEnum.template - args: - STR3: - STR2: - STR1: - STR0: - STR7: - STR6: - STR5: - STR4: - port: - addr: - VAL3: - VAL2: - VAL1: - VAL0: - VAL7: - VAL6: - VAL5: - VAL4: - Q: - P: - name: - timeout: - - file: $(DLSPLC)/db/dlsPLC_PIDControl.template - args: - name: - PREC: - Q: - P: - UNITS: - desc: -- name: writeFloat32 - description: Write an float32 value into a PLC DM variable - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: DM variable of the LOWERer address of the float32 - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: id - name: name - description: Object name and gui association name - - type: int - name: drvl - description: Drive low limit - default: 0 - - type: int - name: drvh - description: Drive high limit - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_writeFloat32.template - args: - name: - drvh: - drvl: - Q: - P: - timeout: - port: - addr: -- name: NX102_robotDX200_status - description: Template database for reading the status of a DX200 controller through - NX102 PLC - args: - - type: str - name: P - description: PV prefix - - type: str - name: Q - description: PV suffix - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tag - description: ether_ip tag name of robot status - - type: str - name: numbits - description: number of bits used - - type: id - name: name - description: Object name and gui association name - - type: str - name: scan - description: value update time - default: 1 second - - type: str - name: desc - description: Description - default: '' - - type: str - name: label0 - description: Label string for status bit 0 - default: unused - - type: str - name: label1 - description: Label string for status bit 1 - default: unused - - type: str - name: label2 - description: Label string for status bit 2 - default: unused - - type: str - name: label3 - description: Label string for status bit 3 - default: unused - - type: str - name: label4 - description: Label string for status bit 4 - default: unused - - type: str - name: label5 - description: Label string for status bit 5 - default: unused - - type: str - name: label6 - description: Label string for status bit 6 - default: unused - - type: str - name: label7 - description: Label string for status bit 7 - default: unused - - type: str - name: label8 - description: Label string for status bit 8 - default: unused - - type: str - name: label9 - description: Label string for status bit 9 - default: unused - - type: str - name: labelA - description: Label string for status bit 10 - default: unused - - type: str - name: labelB - description: Label string for status bit 11 - default: unused - - type: str - name: labelC - description: Label string for status bit 12 - default: unused - - type: str - name: labelD - description: Label string for status bit 13 - default: unused - - type: str - name: labelE - description: Label string for status bit 14 - default: unused - - type: str - name: labelF - description: This associates a BOY screen with the template - default: unused - databases: - - file: $(DLSPLC)/db/NX102_robotDXstatus.template - args: - scan: - numbits: - tag: - port: - labelA: - labelB: - labelC: - labelD: - labelE: - labelF: - label8: - label9: - label0: - label1: - label2: - label3: - label4: - label5: - label6: - label7: - Q: - P: - desc: - name: -- name: interlockNameOverride - description: Template allowing interlock names to be overriden. - args: - - type: str - name: device - description: device prefix - - type: str - name: interlock - description: Interlock suffix (e.g. :INT1) - - type: str - name: ilk0 - description: Interlock description 0 - - type: str - name: ilk1 - description: Interlock description 1 - - type: str - name: ilk2 - description: Interlock description 2 - - type: str - name: ilk3 - description: Interlock description 3 - - type: str - name: ilk4 - description: Interlock description 4 - - type: str - name: ilk5 - description: Interlock description 5 - - type: str - name: ilk6 - description: Interlock description 6 - - type: str - name: ilk7 - description: Interlock description 7 - - type: str - name: ilk8 - description: Interlock description 8 - - type: str - name: ilk9 - description: Interlock description 9 - - type: str - name: ilk10 - description: Interlock description 10 - - type: str - name: ilk11 - description: Interlock description 11 - - type: str - name: ilk12 - description: Interlock description 12 - - type: str - name: ilk13 - description: Interlock description 13 - - type: str - name: ilk14 - description: Interlock description 14 - - type: str - name: ilk15 - description: Interlock description 15 - databases: - - file: $(DLSPLC)/db/dlsPLC_valveIlkNameOverride.template - args: - ilk14: - ilk15: - ilk10: - ilk11: - ilk12: - ilk13: - interlock: - device: - ilk8: - ilk9: - ilk6: - ilk7: - ilk4: - ilk5: - ilk2: - ilk3: - ilk0: - ilk1: -- name: temperature - description: "Template database for an individual temperature on a\ntemperature - PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" - args: - - type: str - name: device - description: PV prefix - - type: str - name: temp - description: PV suffix - - type: str - name: desc - description: Description - - type: str - name: tmpcc - description: Parent temperature control crate prefix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: offset - description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 - and readback in DM236 offset=36 - - type: str - name: lolo - description: Lolo alarm limit - - type: str - name: low - description: Low alarm limit - - type: str - name: high - description: High alarm limit - - type: str - name: hihi - description: Hihi alarm limit - - type: str - name: hopr - description: High operating range - - type: str - name: lopr - description: Low operating range - - type: str - name: llsv - description: Lolo severity - default: NO_ALARM - - type: str - name: lsv - description: Low severity - default: NO_ALARM - - type: int - name: hyst - description: alarm deadband - default: 0 - - type: float - name: adel - description: archiver deadband - default: 0.2 - - type: int - name: scalefac - description: scale factor for temperature/setpoint - default: 10 - - type: int - name: tempcal - description: temperature calibration offset in egu (default=0) - default: 0 - - type: int - name: prec - description: precision for reporting value back - default: 1 - - type: id - name: name - description: Object and gui association name - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: disable_pv - description: If set, then this is the value of A in disable_calc - default: $(device)$(temp):ZERO - - type: str - name: disable_calc - description: If this condition is met then save the current limit and set the - limit to 3276.7, disabling the interlock for this PV - default: A=1 - - type: int - name: incentury - description: The Century digit(s) for the PLC D address to read temperature values - default: 2 - - type: int - name: outcentury - description: The Century digit(s) for the PLC D address to write setpoints - default: 1 - - type: str - name: egu - description: This associates an edm screen with the template - default: C - databases: - - file: $(DLSPLC)/db/dlsPLC_temperature.template - args: - gda_name: - lsv: - llsv: - prec: - disable_calc: - port: - hyst: - tempcal: - incentury: - lopr: - hopr: - lolo: - outcentury: - low: - disable_pv: - tmpcc: - scalefac: - offset: - device: - desc: - high: - name: - temp: - hihi: - egu: - timeout: - adel: - gda_desc: -- name: motionLimitInterlock - description: TODO:ADD DESCRIPTION - args: - - type: object - name: PLC - description: Instance of motionInterlockPLC to belong to - - type: enum - name: axisNo - description: Axis Number - values: - '"1"': - '"6"': - '"7"': - '"4"': - '"5"': - '"8"': - '"2"': - '"3"': - - type: enum - name: pLim - description: 1 for +lim, 0 for -lim - values: - '"0"': - '"1"': - - type: str - name: ilk0 - description: Interlock 0 description - default: unused - - type: str - name: ilk1 - description: Interlock 1 description - default: unused - - type: str - name: ilk2 - description: Interlock 2 description - default: unused - - type: str - name: ilk3 - description: Interlock 3 description - default: unused - - type: str - name: ilk4 - description: Interlock 4 description - default: unused - - type: str - name: ilk5 - description: Interlock 5 description - default: unused - - type: str - name: ilk6 - description: Interlock 6 description - default: unused - - type: str - name: ilk7 - description: Interlock 7 description - default: unused - - type: str - name: ilk8 - description: Interlock 8 description - default: unused - - type: str - name: ilk9 - description: Interlock 9 description - default: unused - - type: str - name: ilk10 - description: Interlock 10 description - default: unused - - type: str - name: ilk11 - description: Interlock 11 description - default: unused - - type: str - name: ilk12 - description: Interlock 12 description - default: unused - - type: str - name: ilk13 - description: Interlock 13 description - default: unused - - type: str - name: ilk14 - description: Interlock 14 description - default: unused - - type: str - name: ilk15 - description: Interlock 15 description - default: unused -- name: vacPump - description: Template database for a vacuum Pump without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: device name of Pump control crate - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if pump is in - DM110..118 then addr=110 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to On) - default: On - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Off) - default: Off - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to On) - default: On - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Turning On) - default: Turning On - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Off) - default: Off - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Turning Off) - default: Turning Off - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: mode1 - description: name of remote operational mode (:MODE) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) - default: Service - - type: enum - name: pumptype - description: Type of Pump - default: turbo - values: - '"cryo"': - '"scroll"': - '"turbo"': - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - databases: - - file: $(DLSPLC)/db/dlsPLC_vacPump.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - ilk13: - gda_name: - allowpv: - ilk8: - ilksta_label4: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - port: - ilksta_sv4: - con_label6: - mode2: - addr: - mode1: - ilksta_label1: - con_label5: - con_label4: - ilksta_label5: - sta_label5: - sta_label4: - sta_label6: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - ilksta_label2: - vlvcc: - timeout: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - device: - whylocked: - ilksta_label3: - ilk5: - name: - pumptype: - con_label3: - ilk9: - ilk6: - ilk7: - gda_desc: - ilk4: - ilk2: - ilk3: - ilk0: - ilk1: -- name: readInt32 - description: Read the Int32 value stored in 2 DM variables in a PLC - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: addr - description: DM variable of the int - - type: str - name: port - description: Template argument - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: int - name: scale - description: Scaling of raw value into EGUs - default: 1 - - type: int - name: roffset - description: Pre scaling offset in cts - default: 0 - - type: int - name: offset - description: Offset of value in EGUs - default: 0 - - type: id - name: name - description: Object name and gui association name - - type: str - name: scan - description: Template argument - default: 1 second - - type: str - name: egu - description: Template argument - default: mm - - type: int - name: prec - description: Template argument - default: 3 - databases: - - file: $(DLSPLC)/db/dlsPLC_readInt32.template - args: - scale: - addr: - scan: - roffset: - egu: - Q: - P: - prec: - timeout: - offset: - port: - name: -- name: vacValveGroup - description: "Template database for a group of up to 8 vacuum valves\nPete Owens - - 3/5/05" - args: - - type: str - name: device - description: device name - - type: float - name: delay - description: delay between opening valves - - type: str - name: valve1 - description: Valve 1 device name - - type: str - name: valve2 - description: Valve 2 device name - - type: str - name: valve3 - description: Valve 3 device name - - type: str - name: valve4 - description: Valve 4 device name - - type: str - name: valve5 - description: Valve 5 device name - - type: str - name: valve6 - description: Valve 6 device name - - type: str - name: valve7 - description: Valve 7 device name - - type: str - name: valve8 - description: Valve 8 device name - - type: str - name: mode1 - description: name of remote operational mode (:MODE) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) - default: Service - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValveGroup.template - args: - mode2: - mode1: - delay: - device: - valve8: - valve4: - valve5: - valve6: - valve7: - valve1: - valve2: - valve3: -- name: NX102_fastValve - description: Template database for a fast vacuum valve. - args: - - type: str - name: device - description: Mandatory. Device name of the fast valve used as PV name prefix. - - type: str - name: port - description: Mandatory. EtherIP communication port name. - - type: str - name: tag - description: Mandatory. NX PLC protocol tag string. - - type: int - name: tagidx - description: Mandatory. NX PLC tag index number. - - type: int - name: ILKNUM - description: Mandatory. Part of definition of gauge interlocks, Gauge NX PLC - tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str - name: allowpv - description: Optional. Defaults to "". If specified, then only write an open - command when this is non-zero. MUST have CP at the end of it. - default: '' - - type: str - name: whylocked - description: Optional. Defaults to "Open command not allowed". String for GUI - screen as to precisely why the device is locked and by whom. - default: Open command not allowed - - type: str - name: con_label0 - description: Optional. Defaults to Open. Label string for control value 0. - default: Open - - type: str - name: con_label1 - description: Optional. Defaults to Close. Label string for control value 1. - default: Close - - type: str - name: con_label2 - description: Optional. Defaults to Reset. Label string for control value 2. - default: Reset - - type: str - name: con_label3 - description: Optional. Defaults to Arm. Label string for control value 3. - default: Arm - - type: str - name: con_label4 - description: Optional. Defaults to "". Label string for control value 4. - default: Partially Arm - - type: str - name: con_label5 - description: Optional. Defaults to "". Label string for control value 5. - default: '' - - type: str - name: con_label6 - description: Optional. Defaults to "". Label string for control value 6. - default: '' - - type: str - name: con_label7 - description: Optional. Defaults to "". Label string for control value 7. - default: '' - - type: str - name: sta_label0 - description: "Optional. Defaults to Fault.\t\t Label string for status value - 0." - default: Fault - - type: str - name: sta_label1 - description: "Optional. Defaults to Open Fully Armed.\t Label string for status - value 1." - default: Open Armed - - type: str - name: sta_label2 - description: "Optional. Defaults to Opening.\t\t Label string for status value - 2." - default: Opening - - type: str - name: sta_label3 - description: "Optional. Defaults to Closed.\t\t Label string for status value - 3." - default: Closed - - type: str - name: sta_label4 - description: "Optional. Defaults to Closing.\t\t Label string for status value - 4." - default: Closing - - type: str - name: sta_label5 - description: "Optional. Defaults to Open Disarmed.\t Label string for status - value 5." - default: Open Disarmed - - type: str - name: sta_label6 - description: Optional. Defaults to Open Partially Armed. Label string for status - value 6. - default: Partially Armed - - type: str - name: sta_label7 - description: "Optional. Defaults to \"\". \t \t Label string for status - value 7." - default: '' - - type: str - name: sta_sv0 - description: "Optional. Defaults to MAJOR. \t Alarm severity for status - value 0." - default: MAJOR - - type: str - name: sta_sv1 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 1." - default: NO_ALARM - - type: str - name: sta_sv2 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 2." - default: NO_ALARM - - type: str - name: sta_sv3 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 3." - default: NO_ALARM - - type: str - name: sta_sv4 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 4." - default: NO_ALARM - - type: str - name: sta_sv5 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 5." - default: NO_ALARM - - type: str - name: sta_sv6 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 6." - default: NO_ALARM - - type: str - name: sta_sv7 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 7." - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Optional. Defaults to Failed. Label string for status value - 0. - default: Failed - - type: str - name: ilksta_label1 - description: Optional. Defaults to Run Ilks Ok. Label string for status value - 1. - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: "Optional. Defaults to OK. \t Label string for status value - 2." - default: OK - - type: str - name: ilksta_label3 - description: Optional. Defaults to Disarmed. Label string for status value - 3. - default: Disarmed - - type: str - name: ilksta_label4 - description: "Optional. Defaults to \"\".\t Label string for status value - 4." - default: '' - - type: str - name: ilksta_label5 - description: "Optional. Defaults to \"\".\t Label string for status value - 5." - default: '' - - type: str - name: ilksta_label6 - description: "Optional. Defaults to \"\".\t Label string for status value - 6." - default: '' - - type: str - name: ilksta_label7 - description: Optional. Defaults to "". Label string for status value - 7. - default: '' - - type: str - name: ilksta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for interlock - status value 0. - default: MAJOR - - type: str - name: ilksta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 1. - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 2. - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 3. - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 4. - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 5. - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 6. - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 7. - default: NO_ALARM - - type: str - name: mode1 - description: Optional. Defaults to Operational. Name of first mode of operation, - remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) - default: Operational - - type: str - name: mode2 - description: Optional. Defaults to Service. Name of second mode of operation, - local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) - default: Service - - type: str - name: DIRILK1 - description: Optional. Defaults to "". Component interlock PV names - (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled - by ILK1. - default: '' - - type: int - name: showilk - description: 'Optional. Defaults to 0. Which set of interlocks to - display - 0: Gauge 1: Arm' - default: 0 - - type: id - name: name - description: Optional. Defaults to "". Object name and associated gui - name. - databases: - - file: $(DLSPLC)/db/NX102_fastValve.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - ilksta_label5: - DIRILK1: - ilksta_sv7: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - sta_label6: - device: - whylocked: - ILKNUM: - name: - ilksta_label7: - showilk: -- name: NX102_radmonreset - description: "Template database for a vacuum valve\nIan Gillingham October 2012" - args: - - type: str - name: device - description: device name - - type: str - name: port - description: asyn port name - - type: str - name: radmon_device - description: full PV name of RAD MON :RESET:OK - databases: - - file: $(DLSPLC)/db/NX102_radmonreset.template - args: - device: - port: - radmon_device: -- name: vacValveSoftOpening - description: Template database for a soft opening vacuum valve. - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: 'device name of valve control crate (prefix of device name), NOTE: - make sure there is a read100 component whose century (0 means 0-99) includes - the object address' - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is in - DM110..119 then addr=110 - - type: str - name: fullilk0 - description: Interlock description 0 - default: unused - - type: str - name: fullilk1 - description: Interlock description 1 - default: unused - - type: str - name: fullilk2 - description: Interlock description 2 - default: unused - - type: str - name: fullilk3 - description: Interlock description 3 - default: unused - - type: str - name: fullilk4 - description: Interlock description 4 - default: unused - - type: str - name: fullilk5 - description: Interlock description 5 - default: unused - - type: str - name: fullilk6 - description: Interlock description 6 - default: unused - - type: str - name: fullilk7 - description: Interlock description 7 - default: unused - - type: str - name: fullilk8 - description: Interlock description 8 - default: unused - - type: str - name: fullilk9 - description: Interlock description 9 - default: unused - - type: str - name: fullilk10 - description: Interlock description 10 - default: unused - - type: str - name: fullilk11 - description: Interlock description 11 - default: unused - - type: str - name: fullilk12 - description: Interlock description 12 - default: unused - - type: str - name: fullilk13 - description: Interlock description 13 - default: unused - - type: str - name: fullilk14 - description: Interlock description 14 - default: unused - - type: str - name: fullilk15 - description: Interlock description 15 - default: unused - - type: str - name: softilk0 - description: Interlock description 0 - default: unused - - type: str - name: softilk1 - description: Interlock description 1 - default: unused - - type: str - name: softilk2 - description: Interlock description 2 - default: unused - - type: str - name: softilk3 - description: Interlock description 3 - default: unused - - type: str - name: softilk4 - description: Interlock description 4 - default: unused - - type: str - name: softilk5 - description: Interlock description 5 - default: unused - - type: str - name: softilk6 - description: Interlock description 6 - default: unused - - type: str - name: softilk7 - description: Interlock description 7 - default: unused - - type: str - name: softilk8 - description: Interlock description 8 - default: unused - - type: str - name: softilk9 - description: Interlock description 9 - default: unused - - type: str - name: softilk10 - description: Interlock description 10 - default: unused - - type: str - name: softilk11 - description: Interlock description 11 - default: unused - - type: str - name: softilk12 - description: Interlock description 12 - default: unused - - type: str - name: softilk13 - description: Interlock description 13 - default: unused - - type: str - name: softilk14 - description: Interlock description 14 - default: unused - - type: str - name: softilk15 - description: Interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Soft Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to Full Open) - default: Full Open - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Full Open) - default: Full Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Soft Open) - default: Soft Open - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for interlock status value 0 (Optional - defaults to - Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for interlock status value 1 (Optional - defaults to - Run Ilks Ok) - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Label string for interlock status value 2 (Optional - defaults to - OK) - default: OK - - type: str - name: ilksta_label3 - description: Label string for interlock status value 3 (Optional - defaults to - Disarmed) - default: Disarmed - - type: str - name: ilksta_label4 - description: Label string for interlock status value 4 (Optional - defaults to - "") - default: '' - - type: str - name: ilksta_label5 - description: Label string for interlock status value 5 (Optional - defaults to - "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: allowpv - description: Template argument - default: '' - - type: str - name: whylocked - description: Template argument - default: Open command not allowed - - type: int - name: timeout - description: Template argument - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValveSoftOpening.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - ilksta_label0: - con_label6: - con_label5: - con_label4: - ilksta_sv3: - allowpv: - ilksta_label4: - softilk1: - fullilk1: - fullilk0: - fullilk3: - fullilk2: - fullilk5: - fullilk4: - fullilk7: - fullilk6: - fullilk9: - fullilk8: - ilksta_sv0: - ilksta_sv1: - port: - ilksta_sv4: - ilksta_label1: - softilk10: - addr: - softilk11: - ilksta_label3: - ilksta_label5: - gda_name: - sta_label5: - sta_label4: - softilk12: - softilk13: - softilk14: - softilk15: - sta_label3: - sta_label2: - sta_label1: - ilksta_sv5: - softilk0: - sta_sv4: - sta_label0: - softilk8: - softilk9: - ilksta_label2: - softilk2: - softilk3: - sta_sv3: - sta_sv2: - softilk6: - softilk7: - softilk4: - softilk5: - sta_label6: - device: - sta_sv6: - sta_sv5: - whylocked: - sta_sv1: - name: - sta_sv0: - ilksta_sv2: - fullilk11: - fullilk10: - fullilk13: - fullilk12: - fullilk15: - fullilk14: - timeout: - gda_desc: - vlvcc: -- name: genericDevice - description: Template5B database for a vacuum valve without debounce or raw air - records - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: device name of valve control crate - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is in - DM110..118 then addr=110 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: On - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Off - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: On - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: '' - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Off - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: '' - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: mode1 - description: name of remote operational mode (:MODE) - default: Operational - - type: str - name: mode2 - description: This associates an edm screen with the template - default: Service - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - databases: - - file: $(DLSPLC)/db/dlsPLC_genericDevice.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - ilk13: - gda_name: - allowpv: - ilk8: - ilksta_label4: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - port: - ilksta_sv4: - con_label6: - mode2: - addr: - mode1: - ilksta_label1: - con_label5: - con_label4: - ilksta_label5: - sta_label5: - sta_label4: - sta_label6: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - ilksta_label2: - vlvcc: - timeout: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - device: - whylocked: - ilksta_label3: - ilk5: - name: - con_label3: - ilk9: - ilk6: - ilk7: - gda_desc: - ilk4: - ilk2: - ilk3: - ilk0: - ilk1: -- name: NX102_PreVacCoils_SMControl - description: 'Template database for a control of PreVac Sample Manipulator. Two - parameters for source and target chambers (where to transfer sample from and to - respectively) have to be written. Further writes to NX PLC registers act commands - to turn on motors and gas, and transfer commands for Prepare, Transfer, Abort, - Reset. Each of these writes has to have associated pulsed trigger writes to cause - the NX PLC to act on the latest value. The NX PLC processes the requested value - and decides whether to pass it to the PreVac Modbus PLC. If the latter, the PreVac - Modbus PLC also processes the requested value and decides whether to act on it - or not. EPICS does not have any direct communication with the PreVac Modbus PLC. Intentions - for macros as follows: (1) Strings for posportID_shortdesc macros should be - provided only for ports which are present, but they should be left alone as empty - strings for ports which are not present. (2) Alarm severities of MAJOR should - be defined for posportID_SV macros for ports which are not present, but those - which are present are left alone as NO_ALARM. (3) Setting the posportID_compass - macros must result in a unique compass direction for all ports n=1-8 for the embedded - diagram display on the Control screen to work properly. The default values conform - to this. (4) Set targetparam_init to a posport ID number of a port which is present. (5) - The value of posportIDs_allowedmask defaults to a safe value of 0, which causes - no transfers to be allowed, so you must define it according to the ports present - to allow transfers. (NOTE: In descriptions and macro names, "arm" is a noun referring - to the sample manipulator arm and not a verb as used for a fast valve).' - args: - - type: str - name: device - description: Mandatory. Device name. - - type: str - name: port - description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str - name: tag_sourceparam - description: Mandatory. NX PLC tag string to write the source chamber parameter. - - type: str - name: tag_targetparam - description: Mandatory. NX PLC tag string to write the target chamber parameter. - - type: str - name: tag_setcoil - description: Mandatory. NX PLC tag string to set a Coil to TRUE. - - type: str - name: tag_unsetcoil - description: Mandatory. NX PLC tag string to set a Coil to FALSE. - - type: str - name: tag_Tsourceparam - description: Optional. Defaults to T$(tag_sourceparam). NX PLC tag string to - set the trigger to set the source chamber parameter. - default: T$(tag_sourceparam) - - type: str - name: tag_Ttargetparam - description: Optional. Defaults to T$(tag_targetparam). NX PLC tag string to - set the trigger to set the target chamber parameter. - default: T$(tag_targetparam) - - type: str - name: tag_Tsetcoil - description: Optional. Defaults to T$(tag_setcoil). NX PLC tag string to - set the trigger to set a Coil to TRUE. - default: T$(tag_setcoil) - - type: str - name: tag_Tunsetcoil - description: Optional. Defaults to T$(tag_unsetcoil). NX PLC tag string to - set the trigger to set a Coil to FALSE. - default: T$(tag_unsetcoil) - - type: float - name: coilout_scanrate - description: Optional. Defaults to .2 The value of scanrate which when writing - to NX PLC the coil output records set the EtherIP scanrate S flag to in their - OUT field syntax to add the readback to one of the EtherIP scanlists. (These - are the records which run commands). - default: 0.2 - - type: float - name: paramout_scanrate - description: Optional. Defaults to .2 The value of scanrate which when writing - to NX PLC the parameter output records set the EtherIP scanrate S flag to in - their OUT field syntax to add the readback to one of the EtherIP scanlists. - default: 0.5 - - type: float - name: trigger_scanrate - description: Optional. Defaults to .2 The value of scanrate which when writing - to NX PLC triggers the trigger output records set the EtherIP scanrate S flag - to in their OUT field syntax to add the readback to one of the EtherIP scanlists. - default: 0.2 - - type: int - name: posportIDs_allowedmask - description: Optional. Defaults to 0. Mask of bits set for each posportID number - which is allowed as source and target. (i.e. a chamber is present). Bit 0 - represents the Arm - do NOT set that bit, it is not allowed as a target and - has special functionality for error recovery as a source. Although the macro - is optional, the default value doesnt allow any transfers, so you must set this. - default: 0 - - type: str - name: posportID0_shortdesc - description: Optional. Defaults to Arm. Short (for menu) description - of zeroth port (for error recovery only). The posportID1...7_shortdesc macros - are not populated by default, so you must set some of them to get a readable - menu button. - default: Arm - - type: str - name: posportID1_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 1. - default: '' - - type: str - name: posportID2_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 2. - default: '' - - type: str - name: posportID3_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 3. - default: '' - - type: str - name: posportID4_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 4. - default: '' - - type: str - name: posportID5_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 5. - default: '' - - type: str - name: posportID6_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 6. - default: '' - - type: str - name: posportID7_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 7. - default: '' - - type: str - name: posportID8_shortdesc - description: Optional. Defaults to empty string. Short (for menu) description - of posport 8. - default: '' - - type: str - name: posportID0_sourceSV - description: Optional. Defaults to MINOR. Alarm severity for posport - ID 0 for the Arm as source. It is allowed as part of error recovery. - default: MINOR - - type: str - name: posportID0_targetSV - description: Optional. Defaults to MAJOR. Alarm severity for posport - ID 0 for the Arm as target. - default: MAJOR - - type: str - name: posportID1_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 1, same for source and target. - default: NO_ALARM - - type: str - name: posportID2_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 2, same for source and target. - default: NO_ALARM - - type: str - name: posportID3_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 3, same for source and target. - default: NO_ALARM - - type: str - name: posportID4_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 4, same for source and target. - default: NO_ALARM - - type: str - name: posportID5_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 5, same for source and target. - default: NO_ALARM - - type: str - name: posportID6_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 6, same for source and target. - default: NO_ALARM - - type: str - name: posportID7_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 7, same for source and target. - default: NO_ALARM - - type: str - name: posportID8_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 8, same for source and target. - default: NO_ALARM - - type: str - name: posportID1_compass - description: Optional. Defaults to E. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen for posport ID1. - default: E - - type: str - name: posportID2_compass - description: Optional. Defaults to NE. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID2. - default: NE - - type: str - name: posportID3_compass - description: Optional. Defaults to N. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID3. - default: N - - type: str - name: posportID4_compass - description: Optional. Defaults to NW. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID4. - default: NW - - type: str - name: posportID5_compass - description: Optional. Defaults to W. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID5. - default: W - - type: str - name: posportID6_compass - description: Optional. Defaults to SW. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID6. - default: SW - - type: str - name: posportID7_compass - description: Optional. Defaults to S. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID7. - default: S - - type: str - name: posportID8_compass - description: Optional. Defaults to SE. Allowed values N,NW,W,SW,S,SE,E,NE. Position - in the layout of the sample manipulator diagram on the control screen brought - up from the Control button on the generated screen, posport ID8. - default: SE - - type: str - name: ctrlprefix - description: Optional. Defaults to :CTRL Prefix for SM control records. - default: :CTRL - - type: str - name: paramprefix - description: Optional. Defaults to :PARAM Prefix for SM parameter records. - default: :PARAM - - type: int - name: paramprec - description: Optional. Defaults to 0. Precision of the parameter - value. - default: 0 - - type: str - name: staprefix - description: Optional. Defaults to :STA Prefix for SM status records - for screens. Must match SM status template. - default: :STA - - type: str - name: posportprefix - description: Optional. Defaults to :POSPORT Prefix for SM port status records - for screens. Must match definitions for SM port status template. - default: :POSPORT - - type: str - name: sourceparam_shortdesc - description: Optional. Defaults to Source. Short description or name of - the Source parameter. - default: Source - - type: str - name: targetparam_shortdesc - description: Optional. Defaults to Target. Short description or name of - the Target parameter. - default: Target - - type: str - name: sourceparam_longdesc - description: Optional. Defaults to $(sourceparam_shortdesc=Source) chamber to - move from. Long description of the Source Parameter. - default: $(sourceparam_shortdesc=Source) chamber to move from. - - type: str - name: targetparam_longdesc - description: Optional. Defaults to $(targetparam_shortdesc=Target) chamber to - move to. Long description of the Target Parameter. - default: ' $(targetparam_shortdesc=Target) chamber to move to.' - - type: int - name: sourceparam_init - description: Optional. Defaults to 0 (Arm). Initial value of the user demand - for the Source parameter. Helps the display on reboot in the absence of autosave. - default: 0 - - type: int - name: targetparam_init - description: Optional. Defaults to 1. Initial value of the user demand - for the Target parameter. Helps the display on reboot in the absence of autosave. The - default value could not be left at 0 because the Arm is never allowed as target. The - value of 1 is arbitrary. Recommend set this to the ID of one of the ports which - is present in the manipulator configuration. - default: 1 - - type: int - name: trigger_onval - description: Optional. Defaults to 1. Value to write to a trigger - tag to pulse the trigger on. Must be consistent with trigger_offval. Together - they allow the defininition of the trigger pulse as a blip or a dip with blip - as the default. - default: 1 - - type: int - name: trigger_offval - description: Optional. Defaults to 0. Value to write to a trigger - tag to pulse the trigger off. Must be consistent with trigger_onval. Together - they allow the defininition of the trigger pulse as a blip or a dip with blip - as the default. - default: 0 - - type: str - name: trigger_ONAM - description: Optional. Defaults to Trigger On. Label for 1 state on a trigger - record. Must be consistent with trigger_onval and trigger_offval. - default: Trigger On - - type: str - name: trigger_ZNAM - description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger - record. Must be consistent with trigger_onval and trigger_offval. - default: Trigger Off - - type: float - name: trigger_pulseDLY - description: Optional. Defaults to 1.0. Delay in seconds between sending - Trigger On and Trigger Off writes when pulsing a trigger. - default: 1.0 - - type: int - name: ackprepare_bitno - description: Optional. Defaults to 0. Number (0 to 15) of the bit - in the status word which acknowledges response to the prepare transfer command. - default: 0 - - type: int - name: acktransfer_bitno - description: Optional. Defaults to 1. Number (0 to 15) of the bit - in the status word which acknowledges response to the transfer command. - default: 1 - - type: int - name: ackabort_bitno - description: Optional. Defaults to 2. Number (0 to 15) of the bit - in the status word which acknowledges response to the abort transfer command. - default: 2 - - type: int - name: ackclear_bitno - description: Optional. Defaults to 3. Number (0 to 15) of the bit - in the status word which acknowledges response to the clear error command. - default: 3 - - type: str - name: ackprepare_status - description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record - for status word to link to extract the acknowledgement to the prepare transfer - command from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: acktransfer_status - description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record - for status word to link to extract the acknowledgement to the transfer command - from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: ackabort_status - description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record - for status word to link to extract the acknowledgement to the abort transfer - command from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: ackclear_status - description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record - for status word to link to extract the acknowledgement to the clear error command - from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: ackprepare_ZNAM - description: Optional. Defaults to No Request. Label for off state (ZNAM - field) of prepare for transfer command acknowledgement. - default: No Request - - type: str - name: acktransfer_ZNAM - description: Optional. Defaults to No Request. Label for off state (ZNAM - field) of transfer command acknowledgement. - default: No Request - - type: str - name: ackabort_ZNAM - description: Optional. Defaults to No Request. Label for off state (ZNAM - field) of abort transfer command acknowledgement. - default: No Request - - type: str - name: ackclear_ZNAM - description: Optional. Defaults to No Request. Label for off state (ZNAM - field) of clear error command acknowledgement. - default: No Request - - type: str - name: ackprepare_ONAM - description: Optional. Defaults to Request. Label for on state (ONAM field) - of prepare for transfer command acknowledgement. - default: Request - - type: str - name: acktransfer_ONAM - description: Optional. Defaults to Request. Label for on state (ONAM field) - of transfer command acknowledgement. - default: Request - - type: str - name: ackabort_ONAM - description: Optional. Defaults to Request. Label for on state (ONAM field) - of abort transfer command acknowledgement. - default: Request - - type: str - name: ackclear_ONAM - description: Optional. Defaults to Request. Label for on state (ONAM field) - of clear error command acknowledgement. - default: Request - - type: str - name: acksource_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM - field) of source parameter acknowledgement. - default: No Trigger - - type: str - name: acktarget_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM - field) of target parameter acknowledgement. - default: No Trigger - - type: str - name: acksource_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of source parameter acknowledgement. - default: Trigger - - type: str - name: acktarget_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of target parameter acknowledgement. - default: Trigger - - type: str - name: ackmotorcurrenton_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of motor current on command acknowledgement. - default: No Trigger - - type: str - name: ackmotorcurrentoff_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of motor current off command acknowledgement. - default: No Trigger - - type: str - name: ackmotorcurrenton_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of motor current on command acknowledgement. - default: Trigger - - type: str - name: ackmotorcurrentoff_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of motor current off command acknowledgement. - default: Trigger - - type: str - name: ackcompressedairon_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of compressed air on command acknowledgement. - default: No Trigger - - type: str - name: ackcompressedairoff_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of compressed air off command acknowledgement. - default: No Trigger - - type: str - name: ackcompressedairon_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of compressed air on command acknowledgement. - default: Trigger - - type: str - name: ackcompressedairoff_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of compressed air off command acknowledgement. - default: Trigger - - type: str - name: ackholderonarmon_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of acknowledgement for command to set the Holder On Arm status to True. - default: No Trigger - - type: str - name: ackholderonarmoff_ZNAM - description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) - of acknowledgement for command to set the Holder On Arm status to False. - default: No Trigger - - type: str - name: ackholderonarmon_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of acknowledgement for command to set the Holder On Arm status to True. - default: Trigger - - type: str - name: ackholderonarmoff_ONAM - description: Optional. Defaults to Trigger. Label for on state (ONAM field) - of acknowledgement for command to set the Holder On Arm status to False. - default: Trigger - - type: str - name: ingprepare_ZNAM - description: Optional. Defaults to Not Preparing. Label for off state (ZNAM - field) of in progress for prepare command. - default: Not Preparing - - type: str - name: ingprepare_ONAM - description: Optional. Defaults to Preparing. Label for on state (ONAM - field) of in progress for prepare command. - default: Preparing - - type: str - name: ingtransfer_ZNAM - description: Optional. Defaults to Not Transferring. Label for off state (ZNAM - field) of in progress for transfer command. - default: Not Transferring - - type: str - name: ingtransfer_ONAM - description: Optional. Defaults to Transferring. Label for on state (ONAM - field) of in progress for transfer command. - default: Transferring - - type: str - name: ingabort_ZNAM - description: Optional. Defaults to Not Aborting. Label for off state (ZNAM - field) of in progress for abort command. - default: Not Aborting - - type: str - name: ingabort_ONAM - description: Optional. Defaults to Aborting. Label for on state (ONAM - field) of in progress for abort command. - default: Aborting - - type: str - name: ingclear_ZNAM - description: Optional. Defaults to Not Clearing. Label for off state (ZNAM - field) of in progress for clear command. - default: Not Clearing - - type: str - name: ingclear_ONAM - description: Optional. Defaults to Clearing. Label for on state (ONAM - field) of in progress for clear command. - default: Clearing - - type: int - name: ingprepare_bitno - description: Optional. Defaults to 11. Number (0 to 15) of the bit - in the status word for the in progress status for the prepare command. - default: 11 - - type: int - name: ingtransfer_bitno - description: Optional. Defaults to 10. Number (0 to 15) of the bit - in the status word for the in progress status for the transfer command. - default: 10 - - type: int - name: ingabort_bitno1 - description: Optional. Defaults to 1. Number (0 to 15) of the bit - in the status word for the in progress status for the abort command. - default: 1 - - type: int - name: ingabort_bitno2 - description: Optional. Defaults to 15. Number (0 to 15) of the bit - in the status word for the aborted status for the abort command. - default: 15 - - type: str - name: ingprepare_status - description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record - for status word to link to extract in progress status for the prepare command - from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: ingtransfer_status - description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record - for status word to link to extract in progress status for the transfer command - from. - default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str - name: ingabort_status1 - description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERERRORS2). Record - for status word to link to extract in progress status for the abort command - from. - default: $(device)$(staprefix=:STA):TRANSFERERRORS2 - - type: str - name: ingabort_status2 - description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERSTATUS). Record - for status word to link to extract aborted status for the abort command from. This - is required because of the behaviour during HiTES1 commissioning of the PreVac - Modbus PLC failing to update some of its status including the aborting in progress - bit which once set persists until the next command. - default: $(device)$(staprefix=:STA):TRANSFERSTATUS - - type: id - name: name - description: Optional. Defaults to empty. Object name and associated - gui name - databases: - - file: $(DLSPLC)/db/NX102_PreVacCoils_SMControl.template - args: - posportID6_compass: - posportID2_shortdesc: - ackcompressedairon_ONAM: - ackprepare_ONAM: - posportID1_SV: - posportID1_compass: - acktarget_ZNAM: - posportID3_compass: - ackclear_bitno: - sourceparam_shortdesc: - ackholderonarmoff_ONAM: - ackprepare_ZNAM: - posportID2_compass: - acktransfer_bitno: - posportID5_SV: - acktransfer_status: - ackabort_bitno: - ackmotorcurrenton_ZNAM: - ackclear_ONAM: - targetparam_longdesc: - name: - posportID0_shortdesc: - trigger_ONAM: - posportID7_shortdesc: - paramprefix: - sourceparam_longdesc: - ingabort_status1: - ingprepare_status: - ingprepare_bitno: - ackmotorcurrentoff_ONAM: - port: - posportprefix: - posportID4_compass: - posportID3_SV: - trigger_scanrate: - coilout_scanrate: - posportID1_shortdesc: - ackcompressedairon_ZNAM: - acktarget_ONAM: - tag_Ttargetparam: - ackholderonarmon_ZNAM: - ackprepare_bitno: - ingabort_status2: - tag_sourceparam: - tag_unsetcoil: - posportIDs_allowedmask: - ackabort_ZNAM: - ackclear_status: - posportID3_shortdesc: - paramout_scanrate: - posportID4_SV: - targetparam_shortdesc: - ctrlprefix: - posportID7_SV: - posportID6_SV: - ingabort_bitno2: - posportID8_SV: - posportID2_SV: - ackabort_status: - tag_Tsourceparam: - acksource_ZNAM: - paramprec: - ingprepare_ONAM: - acktransfer_ZNAM: - ackcompressedairoff_ZNAM: - posportID4_shortdesc: - ingabort_ONAM: - ingtransfer_ZNAM: - trigger_pulseDLY: - acktransfer_ONAM: - ingabort_bitno1: - ingprepare_ZNAM: - ingtransfer_status: - posportID5_compass: - tag_setcoil: - posportID5_shortdesc: - trigger_offval: - ackmotorcurrenton_ONAM: - acksource_ONAM: - ackholderonarmon_ONAM: - ingtransfer_ONAM: - ingclear_ONAM: - ackabort_ONAM: - tag_Tunsetcoil: - posportID8_shortdesc: - staprefix: - posportID0_sourceSV: - ackclear_ZNAM: - posportID0_targetSV: - sourceparam_init: - posportID7_compass: - ingclear_ZNAM: - ackprepare_status: - ackmotorcurrentoff_ZNAM: - targetparam_init: - device: - ingabort_ZNAM: - trigger_ZNAM: - ackcompressedairoff_ONAM: - trigger_onval: - ingtransfer_bitno: - ackholderonarmoff_ZNAM: - posportID8_compass: - tag_targetparam: - posportID6_shortdesc: - tag_Tsetcoil: -- name: vacValve - description: Template database for a vacuum valve without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: 'device name of valve control crate (prefix of device name), NOTE: - make sure there is a read100 component whose century (0 means 0-99) includes - the object address' - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is in - DM110..119 then addr=110 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: gilk0 - description: Gauge interlock description 0 - default: unused - - type: str - name: gilk1 - description: Gauge interlock description 1 - default: unused - - type: str - name: gilk2 - description: Gauge interlock description 2 - default: unused - - type: str - name: gilk3 - description: Gauge interlock description 3 - default: unused - - type: str - name: gilk4 - description: Gauge interlock description 4 - default: unused - - type: str - name: gilk5 - description: Gauge interlock description 5 - default: unused - - type: str - name: gilk6 - description: Gauge interlock description 6 - default: unused - - type: str - name: gilk7 - description: Gauge interlock description 7 - default: unused - - type: str - name: gilk8 - description: Gauge interlock description 8 - default: unused - - type: str - name: gilk9 - description: Gauge interlock description 9 - default: unused - - type: str - name: gilk10 - description: Gauge interlock description 10 - default: unused - - type: str - name: gilk11 - description: Gauge interlock description 11 - default: unused - - type: str - name: gilk12 - description: Gauge interlock description 12 - default: unused - - type: str - name: gilk13 - description: Gauge interlock description 13 - default: unused - - type: str - name: gilk14 - description: Gauge interlock description 14 - default: unused - - type: str - name: gilk15 - description: Gauge interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: desc - description: Box label for gui - default: $(device) - - type: str - name: mode1 - description: name of remote operational mode (:MODE) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) - default: Service - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValve.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - ilk13: - gda_name: - allowpv: - ilk8: - ilksta_label4: - ilk5: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - gilk14: - gilk15: - gilk12: - port: - gilk10: - con_label6: - ilksta_sv1: - mode2: - addr: - ilksta_sv0: - mode1: - ilksta_label1: - con_label5: - con_label4: - ilksta_label5: - gilk13: - sta_label5: - sta_label4: - sta_label6: - gilk8: - sta_label0: - sta_label3: - sta_label2: - gilk4: - gilk5: - gilk6: - gilk11: - gilk0: - gilk1: - gilk2: - gilk9: - ilksta_label2: - vlvcc: - timeout: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - ilksta_sv4: - device: - whylocked: - desc: - ilksta_label3: - ilk4: - gilk7: - name: - ilksta_sv5: - sta_label1: - con_label3: - ilk9: - ilk6: - ilk7: - gda_desc: - gilk3: - ilk2: - ilk3: - ilk0: - ilk1: -- name: NX102_sequence - description: Template database for control and interlock of a non-specific device. - args: - - type: str - name: device - description: device name - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tag - description: NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it (Optional - defaults to "") - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom (Optional. Defaults to "Open command not allowed") - default: Start command not allowed - - type: int - name: stastrSCAN - description: Scan rate for :STASTR PV string read in seconds, may be 10,5,2 or - 1. Use to reduce network traffic if comms problems (Optional - defaults to 1) - default: 1 - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Start) - default: Start - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Abort) - default: Abort - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: con_label7 - description: Label string for control value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Not running) - default: Not running - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Running) - default: Running - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Aborted) - default: Aborted - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Alarm severity for status value 0 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv1 - description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv2 - description: Alarm severity for status value 2 (Optional - defaults to MAJOR) - default: MAJOR - - type: str - name: sta_sv3 - description: Alarm severity for status value 3 (Optional - defaults to MINOR) - default: MINOR - - type: str - name: sta_sv4 - description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv5 - description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv6 - description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv7 - description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for status value 0 (Optional - defaults to Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for status value 1 (Optional - defaults to Run Ilks - Ok) - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Label string for status value 2 (Optional - defaults to OK) - default: OK - - type: str - name: ilksta_label3 - description: Label string for status value 3 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Alarm severity for interlock status value 6 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Alarm severity for interlock status value 7 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: p1_desc - description: Label string for parameter 1 (Optional - defaults to "Param1") - default: Param1 - - type: int - name: p1_isEnum - description: Display as enum(1) or number(0) (Optional - defaults to 1) - default: 1 - - type: int - name: p1_prec - description: Precision of p1 number (Optional - defaults to 0) - default: 0 - - type: str - name: p1_LOPR - description: LOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p1_HOPR - description: HOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p1_label0 - description: Label string for enum value 0 (Optional - defaults to "unused") - default: unused - - type: str - name: p1_label1 - description: Label string for enum value 1 (Optional - defaults to "") - default: '' - - type: str - name: p1_label2 - description: Label string for enum value 2 (Optional - defaults to "") - default: '' - - type: str - name: p1_label3 - description: Label string for enum value 3 (Optional - defaults to "") - default: '' - - type: str - name: p1_label4 - description: Label string for enum value 4 (Optional - defaults to "") - default: '' - - type: str - name: p1_label5 - description: Label string for enum value 5 (Optional - defaults to "") - default: '' - - type: str - name: p1_label6 - description: Label string for enum value 6 (Optional - defaults to "") - default: '' - - type: str - name: p1_label7 - description: Label string for enum value 7 (Optional - defaults to "") - default: '' - - type: str - name: p1_label8 - description: Label string for enum value 8 (Optional - defaults to "") - default: '' - - type: str - name: p1_label9 - description: Label string for enum value 9 (Optional - defaults to "") - default: '' - - type: str - name: p1_label10 - description: Label string for enum value 10 (Optional - defaults to "") - default: '' - - type: str - name: p1_label11 - description: Label string for enum value 11 (Optional - defaults to "") - default: '' - - type: str - name: p1_label12 - description: Label string for enum value 12 (Optional - defaults to "") - default: '' - - type: str - name: p1_label13 - description: Label string for enum value 13 (Optional - defaults to "") - default: '' - - type: str - name: p1_label14 - description: Label string for enum value 14 (Optional - defaults to "") - default: '' - - type: str - name: p1_label15 - description: Label string for enum value 15 (Optional - defaults to "") - default: '' - - type: str - name: p2_desc - description: Label string for parameter 2 (Optional - defaults to "Param2") - default: Param2 - - type: int - name: p2_isEnum - description: Display as enum(1) or number(0) (Optional - defaults to 1) - default: 1 - - type: int - name: p2_prec - description: Precision of p2 number (Optional - defaults to 0) - default: 0 - - type: str - name: p2_LOPR - description: LOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p2_HOPR - description: HOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p2_label0 - description: Label string for enum value 0 (Optional - defaults to "unused") - default: unused - - type: str - name: p2_label1 - description: Label string for enum value 1 (Optional - defaults to "") - default: '' - - type: str - name: p2_label2 - description: Label string for enum value 2 (Optional - defaults to "") - default: '' - - type: str - name: p2_label3 - description: Label string for enum value 3 (Optional - defaults to "") - default: '' - - type: str - name: p2_label4 - description: Label string for enum value 4 (Optional - defaults to "") - default: '' - - type: str - name: p2_label5 - description: Label string for enum value 5 (Optional - defaults to "") - default: '' - - type: str - name: p2_label6 - description: Label string for enum value 6 (Optional - defaults to "") - default: '' - - type: str - name: p2_label7 - description: Label string for enum value 7 (Optional - defaults to "") - default: '' - - type: str - name: p2_label8 - description: Label string for enum value 8 (Optional - defaults to "") - default: '' - - type: str - name: p2_label9 - description: Label string for enum value 9 (Optional - defaults to "") - default: '' - - type: str - name: p2_label10 - description: Label string for enum value 10 (Optional - defaults to "") - default: '' - - type: str - name: p2_label11 - description: Label string for enum value 11 (Optional - defaults to "") - default: '' - - type: str - name: p2_label12 - description: Label string for enum value 12 (Optional - defaults to "") - default: '' - - type: str - name: p2_label13 - description: Label string for enum value 13 (Optional - defaults to "") - default: '' - - type: str - name: p2_label14 - description: Label string for enum value 14 (Optional - defaults to "") - default: '' - - type: str - name: p2_label15 - description: Label string for enum value 15 (Optional - defaults to "") - default: '' - - type: str - name: p3_desc - description: Label string for parameter 3 (Optional - defaults to "Param3") - default: Param3 - - type: int - name: p3_isEnum - description: Display as enum(1) or number(0) (Optional - defaults to 1) - default: 1 - - type: int - name: p3_prec - description: Precision of p3 number (Optional - defaults to 0) - default: 0 - - type: str - name: p3_LOPR - description: LOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p3_HOPR - description: HOPR for p1 number, optionally set if not using enums (Optional - - defaults to "") - default: '' - - type: str - name: p3_label0 - description: Label string for enum value 0 (Optional - defaults to "unused") - default: unused - - type: str - name: p3_label1 - description: Label string for enum value 1 (Optional - defaults to "") - default: '' - - type: str - name: p3_label2 - description: Label string for enum value 2 (Optional - defaults to "") - default: '' - - type: str - name: p3_label3 - description: Label string for enum value 3 (Optional - defaults to "") - default: '' - - type: str - name: p3_label4 - description: Label string for enum value 4 (Optional - defaults to "") - default: '' - - type: str - name: p3_label5 - description: Label string for enum value 5 (Optional - defaults to "") - default: '' - - type: str - name: p3_label6 - description: Label string for enum value 6 (Optional - defaults to "") - default: '' - - type: str - name: p3_label7 - description: Label string for enum value 7 (Optional - defaults to "") - default: '' - - type: str - name: p3_label8 - description: Label string for enum value 8 (Optional - defaults to "") - default: '' - - type: str - name: p3_label9 - description: Label string for enum value 9 (Optional - defaults to "") - default: '' - - type: str - name: p3_label10 - description: Label string for enum value 10 (Optional - defaults to "") - default: '' - - type: str - name: p3_label11 - description: Label string for enum value 11 (Optional - defaults to "") - default: '' - - type: str - name: p3_label12 - description: Label string for enum value 12 (Optional - defaults to "") - default: '' - - type: str - name: p3_label13 - description: Label string for enum value 13 (Optional - defaults to "") - default: '' - - type: str - name: p3_label14 - description: Label string for enum value 14 (Optional - defaults to "") - default: '' - - type: str - name: p3_label15 - description: Label string for enum value 15 (Optional - defaults to "") - default: '' - - type: str - name: mode1 - description: name of remote operational mode (:MODE) (Optional - defaults to Operational) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) (Optional - defaults to Service) - default: Service - - type: id - name: name - description: Object name and associated gui name (Optional - defaults to - "") - databases: - - file: $(DLSPLC)/db/NX102_sequence.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - p3_label9: - p3_label8: - p3_label3: - p3_label2: - p2_label14: - p2_label15: - p2_isEnum: - p2_label10: - p2_label11: - p2_label12: - p3_label4: - p2_desc: - p3_desc: - p1_label12: - p3_label6: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - p1_label9: - p1_label8: - p3_LOPR: - p1_label2: - p1_label1: - p1_label0: - p1_label7: - p1_label6: - p1_label5: - p1_label4: - p3_isEnum: - p3_HOPR: - name: - p3_label11: - p3_label10: - p3_label13: - p3_label12: - p3_label15: - p3_label14: - p1_HOPR: - allowpv: - ilksta_sv2: - ilksta_sv3: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_sv5: - p1_prec: - p2_label13: - p3_label1: - ilksta_label4: - ilksta_label5: - ilksta_label6: - ilksta_label7: - ilksta_label0: - ilksta_label1: - ilksta_label2: - ilksta_label3: - p3_label0: - p1_label10: - p2_LOPR: - sta_label6: - p1_isEnum: - p1_desc: - stastrSCAN: - whylocked: - p3_label5: - p2_prec: - tag: - p3_prec: - mode2: - mode1: - p3_label7: - ilksta_sv7: - p1_label13: - p1_label3: - p1_label11: - p2_HOPR: - p1_label15: - p1_label14: - p1_LOPR: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - device: - p2_label8: - p2_label9: - p2_label2: - p2_label3: - p2_label0: - p2_label1: - p2_label6: - p2_label7: - p2_label4: - p2_label5: -- name: NX102_PreVacCoils_SMPort - description: Template database for status info regarding a Port on PreVac Sample - Manipulator. - args: - - type: str - name: device - description: Mandatory. Device name. - - type: str - name: posportID - description: Mandatory. ID of the vacuum port position for the sample manipulator. Must - be integer 1 to 8 or 0 for special case of Arm in RDC/UFO and overall status. - - type: str - name: port - description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str - name: tag - description: Mandatory. NX PLC tag string e.g. V (from V.Control[1]) - - type: int - name: tagidx - description: Mandatory. NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: str - name: tagname - description: Mandatory. NX PLC tag name. - - type: str - name: tagprefix - description: Mandatory. NX PLC prefix to tag name. - - type: str - name: posportprefix - description: Optional. Defaults to ":POSPORT". Prefix for the vacuum - port position records. - default: :POSPORT - - type: int - name: smready_bitno - description: 'Optional. Defaults to "1". Bit number in port - position status for whether sample manipulator inside the chamber is in position - ready to participate in the transfer, values 0-15. The Arm/RDC/UFO port is - likely to have non-default value, as it needs to address the "Master Interlock - Status" bit, whereas the other ports address the "ReadyForTransfer" bit. NOTE: - The intended use is for signals derived from GPIO on GeoBricks with other sample - manipulator motors on them.' - default: 1 - - type: int - name: sampleholder_bitno - description: 'Optional. Defaults to "2". Bit number in port position - status for whether sample holder is present inside the chamber, values 0-15. The - Arm/RDC/UFO port is likely to have non-default value, as it needs to address - the "Holder On Arm" bit, whereas the other ports address the "Sample Inside" - bit. NOTE: The sample holder might not have a sample in it!' - default: 2 - - type: str - name: desc_label0 - description: Optional. Defaults to "PrepareForTransfer". Descriptive label for - bit0 of the Coil word. - default: PrepareForTransfer - - type: str - name: desc_label1 - description: Optional. Defaults to "ReadyForTransfer". Descriptive label for - bit1 of the Coil word. - default: ReadyForTransfer - - type: str - name: desc_label2 - description: Optional. Defaults to "SampleInside". Descriptive label for - bit2 of the Coil word. - default: SampleInside - - type: str - name: desc_label3 - description: Optional. Defaults to "Error". Descriptive label for - bit3 of the Coil word. - default: Error - - type: str - name: desc_label4 - description: Optional. Defaults to "Busy". Descriptive label for - bit4 of the Coil word. - default: Busy - - type: str - name: desc_label5 - description: Optional. Defaults to "GateOpenRequest". Descriptive label for - bit5 of the Coil word. - default: GateOpenRequest - - type: str - name: desc_label6 - description: Optional. Defaults to "GateOpen". Descriptive label for - bit6 of the Coil word. - default: GateOpen - - type: str - name: desc_label7 - description: Optional. Defaults to "GateClosed". Descriptive label for - bit7 of the Coil word. - default: GateClosed - - type: str - name: desc_label8 - description: Optional. Defaults to "ArmOnPort". Descriptive label for - bit8 of the Coil word. - default: ArmOnPort - - type: str - name: desc_label9 - description: Optional. Defaults to "ReservedForFuture". Descriptive label for - bit9 of the Coil word. - default: ReservedForFuture - - type: str - name: desc_label10 - description: Optional. Defaults to "". Descriptive label for - bit10 of the Coil word. - default: '' - - type: str - name: desc_label11 - description: Optional. Defaults to "". Descriptive label for - bit11 of the Coil word. - default: '' - - type: str - name: desc_label12 - description: Optional. Defaults to "". Descriptive label for - bit12 of the Coil word. - default: '' - - type: str - name: desc_label13 - description: Optional. Defaults to "". Descriptive label for - bit13 of the Coil word. - default: '' - - type: str - name: desc_label14 - description: Optional. Defaults to "". Descriptive label for - bit14 of the Coil word. - default: '' - - type: str - name: desc_label15 - description: Optional. Defaults to "". Descriptive label for - bit15 of the Coil word. - default: '' - - type: str - name: longdesc - description: Optional. Defaults to "Manipulator Position Port $(posportID) status." Description - of position port. - default: Manipulator Position Port $(posportID) status. - - type: str - name: shortdesc - description: Optional. Defaults to "Posport$(posportID)" Short, abbreviated - description of position port. - default: Posport$(posportID) - - type: str - name: chamber_name - description: Optional. Defaults to "". Name of vacuum chamber associated - with position port. - default: '' - - type: str - name: chamber_shortname - description: Optional. Defaults to "". Short name of vacuum chamber - associated with position port. - default: '' - - type: str - name: valve_device - description: Optional. Defaults to "". Device name of vacuum valve - associated with position port. So far it is a string for info only, no calcs. - default: '' - - type: str - name: valve_shortname - description: Optional. Defaults to "". Short, abbreviated name - of vacuum valve associated with the position port. - default: '' - - type: str - name: valve_desc - description: Optional. Defaults to "". Description of vacuum valve - associated with position port. - default: '' - - type: id - name: name - description: Optional. Defaults to empty. Object name and associated - gui name - databases: - - file: $(DLSPLC)/db/NX102_PreVacCoils_SMPort.template - args: - tagprefix: - tag: - posportID: - valve_device: - port: - posportprefix: - valve_shortname: - tagidx: - desc_label15: - desc_label14: - desc_label13: - desc_label12: - desc_label11: - desc_label10: - desc_label9: - desc_label8: - desc_label3: - desc_label2: - desc_label1: - desc_label0: - desc_label7: - desc_label6: - desc_label5: - desc_label4: - chamber_name: - sampleholder_bitno: - device: - smready_bitno: - valve_desc: - name: - chamber_shortname: - tagname: - shortdesc: - longdesc: -- name: NX102_readReal - description: TODO:ADD DESCRIPTION - args: - - type: str - name: device - description: Template argument - - type: str - name: port - description: Template argument - - type: str - name: tag - description: Template argument - - type: str - name: desc - description: Template argument - default: '' - - type: str - name: scan - description: Template argument - default: 1 second - - type: str - name: egu - description: Template argument - default: '' - - type: int - name: prec - description: Template argument - default: 2 - databases: - - file: $(DLSPLC)/db/NX102_readReal.template - args: - scan: - prec: - tag: - egu: - device: - port: - desc: -- name: NX102_genericDevice - description: Template database for control and interlock of a non-specific device. - args: - - type: str - name: device - description: device name - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tag - description: NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it (Optional - defaults to "") - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom (Optional. Defaults to "Open command not allowed") - default: Open command not allowed - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: On - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Off - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: con_label7 - description: Label string for control value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: On - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: '' - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Off - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: '' - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Alarm severity for status value 0 (Optional - defaults to MAJOR) - default: MAJOR - - type: str - name: sta_sv1 - description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv2 - description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv3 - description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv4 - description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv5 - description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv6 - description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv7 - description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for status value 0 (Optional - defaults to Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for status value 1 (Optional - defaults to Run Ilks - Ok) - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Label string for status value 2 (Optional - defaults to OK) - default: OK - - type: str - name: ilksta_label3 - description: Label string for status value 3 (Optional - defaults to Disarmed) - default: Disarmed - - type: str - name: ilksta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Alarm severity for interlock status value 6 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Alarm severity for interlock status value 7 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: mode1 - description: name of remote operational mode (:MODE) (Optional - defaults to Operational) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) (Optional - defaults to Service) - default: Service - - type: id - name: name - description: Object name and associated gui name (Optional - defaults to - "") - databases: - - file: $(DLSPLC)/db/NX102_genericDevice.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - ilksta_label5: - ilksta_sv7: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - sta_label6: - device: - whylocked: - name: - ilksta_label7: -- name: reboot_rga - description: Power cycle an RGA where the PLC code has been setup to power cycle - when 1 is written to a particular DM variable - args: - - type: str - name: device - description: device name - - type: str - name: addr - description: DM variable to write to to reboot rga - - type: str - name: port - description: asyn port name of FINS driver - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: id - name: name - description: Object name and associated gui name - databases: - - file: $(DLSPLC)/db/dlsPLC_reboot_rga.template - args: - device: - port: - name: - timeout: - addr: -- name: NX102_realRW - description: Template database for reading and writing a real value for a DX200 - controller variable through NX102 PLC - args: - - type: str - name: device - description: PV prefix - - type: str - name: variable - description: PV suffix (its associated _RBV will be autogenerated). - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tagread - description: tag name of ether_ip read value - - type: str - name: tagwrite - description: tag name of ether_ip write value - - type: str - name: drvl - description: Lowest accepted value - - type: str - name: drvh - description: Highest accepted value - - type: int - name: tagidx - description: Template argument - - type: id - name: name - description: Object name and gui association name - - type: str - name: desc - description: Description - default: '' - - type: str - name: readscan - description: value update time for readback value - default: 1 second - - type: float - name: writescan - description: value for Ethernet/IP update time - use value without "seconds", - e.g. 0.5 - default: 0.5 - - type: str - name: egu - description: Engineering units - default: '' - - type: int - name: prec - description: precision for reporting value back - default: 2 - databases: - - file: $(DLSPLC)/db/NX102_realRW.template - args: - tagread: - name: - drvh: - drvl: - tagwrite: - egu: - device: - tagidx: - prec: - variable: - desc: - writescan: - port: - readscan: -- name: NX102_vacValveDebounce - description: Template database for a vacuum valve without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: port - description: EtherIP Port Name - - type: str - name: tag - description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int - name: ILKNUM - description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it. (Optional - defaults to "") - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom. (Optional. Defaults to "Open command not allowed") - default: Open command not allowed - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: con_label7 - description: Label string for control value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Alarm severity for status value 0 (Optional - defaults to MAJOR) - default: MAJOR - - type: str - name: sta_sv1 - description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv2 - description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv3 - description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv4 - description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv5 - description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv6 - description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv7 - description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for status value 0 (Optional - defaults to Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for status value 1 (Optional - defaults to Run Ilks - Ok) - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Label string for status value 2 (Optional - defaults to OK) - default: OK - - type: str - name: ilksta_label3 - description: Label string for status value 3 (Optional - defaults to Disarmed) - default: Disarmed - - type: str - name: ilksta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Alarm severity for interlock status value 6 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Alarm severity for interlock status value 7 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: mode1 - description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults - Operational) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE.ONAM) (Optional - defaults - Service) - default: Service - - type: str - name: DIRILK1 - description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for - "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve - or leave blank for ordinary valve. (Optional - defaults to "") - default: '' - - type: str - name: DIRILK2 - description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for - "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable - valves (Optional - defaults to "ILK2") - default: ILK2 - - type: id - name: name - description: Object name and associated gui name (Optional - defaults to - "") - - type: str - name: desc - description: Box label for gui (Optional - defaults to - value of device macro) - default: $(device) - databases: - - file: $(DLSPLC)/db/NX102_vacValveDebounce.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - ilksta_label5: - DIRILK1: - DIRILK2: - ilksta_sv7: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - sta_label6: - device: - whylocked: - desc: - ILKNUM: - name: - ilksta_label7: -- name: NX102_vacPump - description: 'Template for a NX PLC to control and interlock vacuum pumps of various - kinds, e.g. Scroll and Turbo pumps. NOTE: Covers basic commonly required control - only and excludes pump make and model or application specific control and monitoring - of the pump which might be available and also be required typically via serial - control, for example settings configuration or service period information.' - args: - - type: str - name: device - description: Mandatory. Device name of the pump. - - type: str - name: port - description: Mandatory. Name of port for the ether_ip driver for the PLC controlling/interlocking - the pump. - - type: str - name: tag - description: Mandatory. NX PLC tag string e.g. S for Scroll or T for Turbo. - - type: int - name: tagidx - description: Mandatory. NX PLC tag index number. Typically this is the same - as the id number in the device name, but - - type: str - name: allowpv - description: Optional. Defaults to "". If specified, then only write an "open" - i.e. on command when this is non-zero. MUST have CP at the end of it. The term - "open" here and in PV names is because of heritage from valve control. Generally - by default the "open" command for a pump actually signifies turn it on. - default: '' - - type: str - name: whylocked - description: Optional. Defaults to "On command not allowed". String to output - to EDM synoptic as to precisely why the device is locked and by whom. - default: On command not allowed - - type: str - name: con_label0 - description: Optional. Defaults to On. Label string for control value - 0 - default: On - - type: str - name: con_label1 - description: Optional. Defaults to Off. Label string for control value - 1 - default: Off - - type: str - name: con_label2 - description: Optional. Defaults to Reset. Label string for control value - 2 - default: Reset - - type: str - name: con_label3 - description: Optional. Defaults to Standby. Label string for control value - 3 - default: '' - - type: str - name: con_label4 - description: Optional. Defaults to FullSpeed. Label string for control value - 4 - default: '' - - type: str - name: con_label5 - description: Optional. Defaults to "". Label string for control value - 5 - default: '' - - type: str - name: con_label6 - description: Optional. Defaults to "". Label string for control value - 6 - default: '' - - type: str - name: con_label7 - description: Optional. Defaults to "". Label string for control value - 7 - default: '' - - type: str - name: sta_label0 - description: Optional. Defaults to Fault. Label string for status value 0 - default: Fault - - type: str - name: sta_label1 - description: Optional. Defaults to On. Label string for status value 1 - default: On - - type: str - name: sta_label2 - description: Optional. Defaults to Standby. Label string for status value 2 - default: Standby - - type: str - name: sta_label3 - description: Optional. Defaults to Off. Label string for status value 3 - default: Off - - type: str - name: sta_label4 - description: Optional. Defaults to "". Label string for status value 4 - default: FullSpeed - - type: str - name: sta_label5 - description: Optional. Defaults to "". Label string for status value 5 - default: '' - - type: str - name: sta_label6 - description: Optional. Defaults to "". Label string for status value 6 - default: '' - - type: str - name: sta_label7 - description: Optional. Defaults to "". Label string for status value 7 - default: '' - - type: str - name: sta_sv0 - description: "Optional. Defaults to MAJOR. \t Alarm severity for status - value 0." - default: MAJOR - - type: str - name: sta_sv1 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 1." - default: NO_ALARM - - type: str - name: sta_sv2 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 2." - default: NO_ALARM - - type: str - name: sta_sv3 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 3." - default: NO_ALARM - - type: str - name: sta_sv4 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 4." - default: NO_ALARM - - type: str - name: sta_sv5 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 5." - default: NO_ALARM - - type: str - name: sta_sv6 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 6." - default: NO_ALARM - - type: str - name: sta_sv7 - description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status - value 7." - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Optional. Defaults to Failed. Label string for status value - 0 - default: Failed - - type: str - name: ilksta_label1 - description: Optional. Defaults to Run Ilks OK. Label string for status value - 1 - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Optional. Defaults to OK. Label string for status value - 2 - default: OK - - type: str - name: ilksta_label3 - description: Optional. Defaults to "". Label string for status value - 3 - default: '' - - type: str - name: ilksta_label4 - description: Optional. Defaults to "". Label string for status value - 4 - default: '' - - type: str - name: ilksta_label5 - description: Optional. Defaults to "". Label string for status value - 5 - default: '' - - type: str - name: ilksta_label6 - description: Optional. Defaults to "". Label string for status value - 6 - default: '' - - type: str - name: ilksta_label7 - description: Optional. Defaults to "". Label string for status value - 7 - default: '' - - type: str - name: ilksta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for interlock - status value 0. - default: MAJOR - - type: str - name: ilksta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 1. - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 2. - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 3. - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 4. - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 5. - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 6. - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Optional. Defaults to NO_ALARM. Alarm severity for interlock - status value 7. - default: NO_ALARM - - type: str - name: mode1 - description: Optional. Defaults to Operational. Name of first mode of operation, - remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) - default: Operational - - type: str - name: mode2 - description: Optional. Defaults to Service. Name of second mode of operation, - local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) - default: Service - - type: str - name: short_desc - description: Optional. Defaults to Shorting Plug. Description field on the PLUG - record DESC field for whether a shorting plug is present. - default: Shorting Plug - - type: str - name: short_label0 - description: Optional. Defaults to Dummy. Label on the PLUG record ZNAM - field for no shorting plug present. - default: Dummy - - type: str - name: short_label1 - description: Optional. Defaults to Real. Label on the PLUG record ONAM - field for shorting plug present. - default: Real - - type: str - name: short_sv0 - description: Optional. Defaults to NO_ALARM. Severity on the PLUG record - ZSV field for the status value 0. - default: NO_ALARM - - type: str - name: short_sv1 - description: Optional. Defaults to NO_ALARM. Severity on the PLUG record - OSV field for the status value 1. - default: NO_ALARM - - type: id - name: name - description: Optional. Defaults to "". Object name and associated - gui name. - databases: - - file: $(DLSPLC)/db/NX102_vacPump.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - short_desc: - sta_label7: - ilksta_sv7: - sta_label5: - sta_label4: - short_label1: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - short_sv1: - short_sv0: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - short_label0: - ilksta_label5: - device: - whylocked: - name: - ilksta_label7: - sta_label6: -- name: NX102_powerSupply - description: Template showing the status of the power supply from the ether IP readings - args: - - type: str - name: device - description: device prefix - - type: str - name: port - description: port name of ether_ip driver - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from PSU.Voltage[1]) - - type: str - name: tag - description: NX PLC tag string e.g. PSU (from PSU.Voltage[1]) - default: PSU - - type: id - name: name - description: Object name and associated gui name - databases: - - file: $(DLSPLC)/db/NX102_powerSupply.template - args: - device: - tagidx: - tag: - port: - name: -- name: feTemperature - description: "Template database for an individual temperature on a\ntemperature - PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" - args: - - type: str - name: device - description: PV prefix - - type: str - name: temp - description: PV suffix - - type: str - name: desc - description: Description - - type: str - name: tmpcc - description: Parent temperature control crate prefix - - type: str - name: offset - description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 - and readback in DM236 offset=36 - - type: str - name: lolo - description: Lolo alarm limit - - type: str - name: low - description: Low alarm limit - - type: str - name: high - description: High alarm limit - - type: str - name: hihi - description: Hihi alarm limit - - type: str - name: hopr - description: High operating range - - type: str - name: lopr - description: Low operating range - - type: str - name: llsv - description: Lolo severity - default: NO_ALARM - - type: str - name: lsv - description: Low severity - default: NO_ALARM - - type: int - name: hyst - description: alarm deadband - default: 0 - - type: float - name: adel - description: archiver deadband - default: 0.2 - - type: int - name: scalefac - description: scale factor for temperature/setpoint - default: 10 - - type: int - name: tempcal - description: temperature calibration offset in egu (default=0) - default: 0 - - type: int - name: prec - description: precision for reporting value back - default: 1 - - type: id - name: name - description: Object and gui association name - - type: str - name: disable_pv - description: If set, then this is the value of A in disable_calc - default: $(device)$(temp):ZERO - - type: str - name: disable_calc - description: If this condition is met then save the current limit and set the - limit to 3276.7, disabling the interlock for this PV - default: A=1 - - type: int - name: incentury - description: The Century digit(s) for the PLC D address to read temperature values - default: 2 - - type: int - name: outcentury - description: The Century digit(s) for the PLC D address to write setpoints - default: 1 - - type: str - name: egu - description: This associates an edm screen with the template - default: C - databases: - - file: $(DLSPLC)/db/dlsPLC_feTemperature.template - args: - gda_name: - lsv: - llsv: - prec: - disable_calc: - hyst: - tempcal: - incentury: - lopr: - hopr: - lolo: - outcentury: - low: - disable_pv: - tmpcc: - scalefac: - offset: - device: - desc: - high: - name: - temp: - hihi: - egu: - adel: - gda_desc: -- name: NX102_interlock - description: "Template showing the status of various MPS interlocks in\nan Omron - NX102 PLC." - args: - - type: str - name: device - description: device prefix - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: interlock - description: Interlock suffix (e.g. :INT1) - - type: str - name: tag - description: NX PLC tag string e.g. ILK (from ILK.Control[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from ILK.Control[1]) - - type: str - name: desc - description: Permit description (e.g. Front end permit) - - type: id - name: name - description: Object name and gui association name - - type: int - name: auto_reset - description: Set to 1 to push the reset button whenever the raw interlocks are - all ok - default: 0 - databases: - - file: $(DLSPLC)/db/NX102_interlock.template - args: - name: - auto_reset: - tag: - interlock: - tagidx: - device: - port: - desc: -- name: NX102_digitalIn_Debounced - description: TODO:ADD DESCRIPTION - args: - - type: str - name: device - description: Template argument - - type: str - name: port - description: Template argument - - type: int - name: tagidx - description: Template argument - - type: id - name: name - description: Template argument - - type: str - name: tag - description: Template argument - default: Digital_In - databases: - - file: $(DLSPLC)/db/NX102_digitalIn_Debounced.template - args: - device: - tagidx: - tag: - port: - name: -- name: NX102_PreVacCoils_SMStaleBanner - description: Template for Warning GUI banner for stale data from the PreVac Sample - Manipulator controller. - args: - - type: str - name: device - description: Mandatory. Device name of sample manipulator. - - type: str - name: staprefix - description: Optional. Defaults to :STA Prefix for the SM status records. - default: :STA - - type: id - name: name - description: Optional. Defaults to empty. Object name and associated - gui name - databases: - - file: $(DLSPLC)/db/NX102_PreVacCoils_SMStaleBanner.template - args: - device: - staprefix: - name: -- name: NX102_robotDX200_R - description: Template database for reading a real value for a DX200 controller variable - through NX102 PLC - args: - - type: str - name: device - description: PV prefix - - type: str - name: variable - description: PV suffix for this robot variable - - type: str - name: port - description: port name of ether_ip driver - - type: str - name: tagread - description: tag name of ether_ip read value - - type: id - name: name - description: Object name and gui association name - - type: str - name: desc - description: Description - default: '' - - type: str - name: scan - description: value update time - default: 1 second - - type: str - name: egu - description: Engineering units - default: '' - - type: int - name: prec - description: This associates an edm screen with the template - default: 2 - databases: - - file: $(DLSPLC)/db/NX102_robotDXrealR.template - args: - name: - scan: - prec: - device: - egu: - variable: - tagread: - port: - desc: -- name: interlockSummary - description: Template database for a summary PV of up to 24 interlocks - args: - - type: str - name: device - description: device name - - type: str - name: ilk1 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk2 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk3 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk4 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk5 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk6 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk7 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk8 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk9 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk10 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk11 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk12 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk13 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk14 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk15 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk16 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk17 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk18 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk19 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk20 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk21 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk22 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk23 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - - type: str - name: ilk24 - description: Interlock suffix (e.g. INT1) - default: NO-INTERLOCK - databases: - - file: $(DLSPLC)/db/dlsPLC_interlock_summary.template - args: - ilk14: - ilk15: - ilk16: - ilk17: - ilk10: - ilk11: - ilk12: - ilk13: - ilk18: - ilk19: - device: - ilk24: - ilk21: - ilk20: - ilk23: - ilk22: - ilk8: - ilk9: - ilk6: - ilk7: - ilk4: - ilk5: - ilk2: - ilk3: - ilk1: -- name: NX102_PreVacCoils_SMStatus - description: Template database for status info on PreVac Sample Manipulator (in - addition to that for individual SM Ports). - args: - - type: str - name: device - description: Mandatory. Device name. - - type: str - name: port - description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str - name: staprefix - description: Optional. Defaults to :STA Prefix for the SM status records. - default: :STA - - type: str - name: posportprefix - description: Optional. Defaults to :POSPORT Prefix for records for individual - ports. Must match port template. - default: :POSPORT - - type: str - name: posportID0_shortdesc - description: Optional. Defaults to Arm. Short description of zeroth - port (for error recovery only). The posportID1...7_shortdesc macros are not - populated by default, so you must set some of them to make things sensible. Leave - the ones not present (i.e. no chamber connected as empty string.) - default: Arm - - type: str - name: posportID1_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 1, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID2_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 2, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID3_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 3, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID4_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 4, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID5_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 5, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID6_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 6, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID7_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 7, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID8_shortdesc - description: Optional. Defaults to empty string. Short description of posport - with ID 8, recommend use an abbreviated chamber name but only if a chamber is - present. - default: '' - - type: str - name: posportID0_sourceSV - description: Optional. Defaults to MINOR. Alarm severity for posport - ID 0 for the Arm as source. It is allowed as part of error recovery. - default: MINOR - - type: str - name: posportID0_targetSV - description: Optional. Defaults to MAJOR. Alarm severity for posport - ID 0 for the Arm as target. - default: MAJOR - - type: str - name: posportID1_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 1, same for source and target. - default: NO_ALARM - - type: str - name: posportID2_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 2, same for source and target. - default: NO_ALARM - - type: str - name: posportID3_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 3, same for source and target. - default: NO_ALARM - - type: str - name: posportID4_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 4, same for source and target. - default: NO_ALARM - - type: str - name: posportID5_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 5, same for source and target. - default: NO_ALARM - - type: str - name: posportID6_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 6, same for source and target. - default: NO_ALARM - - type: str - name: posportID7_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 7, same for source and target. - default: NO_ALARM - - type: str - name: posportID8_SV - description: Optional. Defaults to NO_ALARM. Alarm severity for posport - ID 8, same for source and target. - default: NO_ALARM - - type: id - name: name - description: Optional. Defaults to empty. Object name and associated - gui name - databases: - - file: $(DLSPLC)/db/NX102_PreVacCoils_SMStatus.template - args: - posportID2_shortdesc: - posportID6_SV: - posportID8_SV: - posportID1_SV: - posportID2_SV: - staprefix: - posportID0_sourceSV: - port: - posportprefix: - posportID3_SV: - posportID0_targetSV: - posportID1_shortdesc: - posportID5_SV: - posportID8_shortdesc: - posportID4_shortdesc: - device: - posportID4_SV: - posportID3_shortdesc: - name: - posportID0_shortdesc: - posportID5_shortdesc: - posportID7_shortdesc: - posportID6_shortdesc: - posportID7_SV: -- name: interlock - description: "Template showing the status of various MPS interlocks in\na PLC. Requires - dlsPLC_read100 for any century used" - args: - - type: str - name: device - description: device prefix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: interlock - description: Interlock suffix (e.g. :INT1) - - type: str - name: desc - description: Permit description (e.g. Front end permit) - - type: str - name: addr - description: First address in the DM variable range. E.g. if interlock is in DM800..808 - then addr=800 - - type: id - name: name - description: Object name and gui association name - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: int - name: auto_reset - description: Set to 1 to push the reset button whenever the raw interlocks are - all ok - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_interlock.template - args: - ilk14: - ilk15: - ilk10: - ilk11: - ilk12: - ilk13: - interlock: - port: - addr: - timeout: - device: - desc: - name: - auto_reset: - ilk8: - ilk9: - ilk6: - ilk7: - ilk4: - ilk5: - ilk2: - ilk3: - ilk0: - ilk1: -- name: fastVacuumChannel - description: TODO:ADD DESCRIPTION - args: - - type: id - name: name - description: Gui tag - - type: object - name: master - description: Master - - type: str - name: img - description: Base IMG PV - - type: enum - name: id - description: FV PLC gauge number - values: - '05': - '04': - '08': - '10': - '03': - '02': - '09': - '07': - '06': - '01': - - type: enum - name: em - description: EM block to use - default: 0 - values: - '"0"': - '"1"': - '"2"': - - type: int - name: timeout - description: asyn fins_port timeout - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_fastVacuumChannel.template - args: - em: - fins_port: '{{master.fins_port}}' - wave4_addr: w - eip_port: '{{master.eip_port}}' - wave3_addr: w - img: - wave2_addr: w - wave5_addr: w - combined_nelm: w - tagidx: '{{id}}' - wave1_addr: w - timeout: - wave0_addr: w - device: '{{master.device}}' - id: - waveform_nelm: wn -- name: vacValveDebounce - description: Template database for a vacuum valve without debounce or raw air records - args: - - type: str - name: device - description: device name - - type: str - name: vlvcc - description: device name of valve control crate - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if pump is in - DM110..118 then addr=110 - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom - default: Open command not allowed - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol - default: 0 - - type: enum - name: valvetype - description: Type of Device - default: valve - values: - '"valve"': - '"absorber"': - '"shutter"': - - type: str - name: ilk0 - description: Interlock description 0 - default: unused - - type: str - name: ilk1 - description: Interlock description 1 - default: unused - - type: str - name: ilk2 - description: Interlock description 2 - default: unused - - type: str - name: ilk3 - description: Interlock description 3 - default: unused - - type: str - name: ilk4 - description: Interlock description 4 - default: unused - - type: str - name: ilk5 - description: Interlock description 5 - default: unused - - type: str - name: ilk6 - description: Interlock description 6 - default: unused - - type: str - name: ilk7 - description: Interlock description 7 - default: unused - - type: str - name: ilk8 - description: Interlock description 8 - default: unused - - type: str - name: ilk9 - description: Interlock description 9 - default: unused - - type: str - name: ilk10 - description: Interlock description 10 - default: unused - - type: str - name: ilk11 - description: Interlock description 11 - default: unused - - type: str - name: ilk12 - description: Interlock description 12 - default: unused - - type: str - name: ilk13 - description: Interlock description 13 - default: unused - - type: str - name: ilk14 - description: Interlock description 14 - default: unused - - type: str - name: ilk15 - description: Interlock description 15 - default: unused - - type: str - name: gilk0 - description: Gauge interlock description 0 - default: unused - - type: str - name: gilk1 - description: Gauge interlock description 1 - default: unused - - type: str - name: gilk2 - description: Gauge interlock description 2 - default: unused - - type: str - name: gilk3 - description: Gauge interlock description 3 - default: unused - - type: str - name: gilk4 - description: Gauge interlock description 4 - default: unused - - type: str - name: gilk5 - description: Gauge interlock description 5 - default: unused - - type: str - name: gilk6 - description: Gauge interlock description 6 - default: unused - - type: str - name: gilk7 - description: Gauge interlock description 7 - default: unused - - type: str - name: gilk8 - description: Gauge interlock description 8 - default: unused - - type: str - name: gilk9 - description: Gauge interlock description 9 - default: unused - - type: str - name: gilk10 - description: Gauge interlock description 10 - default: unused - - type: str - name: gilk11 - description: Gauge interlock description 11 - default: unused - - type: str - name: gilk12 - description: Gauge interlock description 12 - default: unused - - type: str - name: gilk13 - description: Gauge interlock description 13 - default: unused - - type: str - name: gilk14 - description: Gauge interlock description 14 - default: unused - - type: str - name: gilk15 - description: Gauge interlock description 15 - default: unused - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to "") - default: '' - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Optional. Defaults to MAJOR. Alarm severity for status value - 0. - default: MAJOR - - type: str - name: sta_sv1 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 1. - default: NO_ALARM - - type: str - name: sta_sv2 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 2. - default: NO_ALARM - - type: str - name: sta_sv3 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 3. - default: NO_ALARM - - type: str - name: sta_sv4 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 4. - default: NO_ALARM - - type: str - name: sta_sv5 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 5. - default: NO_ALARM - - type: str - name: sta_sv6 - description: Optional. Defaults to NO_ALARM. Alarm severity for status value - 6. - default: NO_ALARM - - type: id - name: name - description: Object name and associated gui name - - type: str - name: desc - description: Box label for gui - default: $(device) - - type: str - name: mode1 - description: name of remote operational mode (:MODE) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE) - default: Service - - type: str - name: ilksta_label0 - description: Template argument - default: Failed - - type: str - name: ilksta_label1 - description: Template argument - default: Run Ilks Ok - - type: str - name: ilksta_label2 - description: Template argument - default: OK - - type: str - name: ilksta_label3 - description: Template argument - default: Disarmed - - type: str - name: ilksta_label4 - description: Template argument - default: '' - - type: str - name: ilksta_label5 - description: Template argument - default: '' - - type: str - name: ilksta_sv0 - description: Template argument - default: MAJOR - - type: str - name: ilksta_sv1 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Template argument - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Template argument - default: NO_ALARM - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValveDebounce.template - args: - ilk14: - ilk15: - con_label1: - con_label0: - ilk10: - ilk11: - ilk12: - valvetype: - gda_name: - allowpv: - ilk8: - ilksta_label4: - ilk5: - con_label2: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - gilk14: - gilk15: - gilk12: - port: - gilk10: - con_label6: - ilksta_sv1: - mode2: - addr: - ilksta_sv0: - mode1: - ilksta_label1: - con_label5: - ilk13: - ilksta_label5: - gilk13: - sta_label5: - sta_label4: - sta_label6: - gilk8: - sta_label0: - sta_label3: - sta_label2: - gilk4: - gilk5: - gilk6: - gilk11: - gilk0: - gilk1: - gilk2: - gilk9: - ilksta_label2: - vlvcc: - timeout: - con_label4: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv6: - ilksta_sv4: - device: - whylocked: - desc: - ilksta_label3: - ilk4: - gilk7: - sta_sv1: - name: - ilksta_sv5: - sta_label1: - con_label3: - ilk9: - ilk6: - ilk7: - gda_desc: - gilk3: - ilk2: - ilk3: - ilk0: - ilk1: -- name: readInt16 - description: Read the Int16 value stored in 1 DM variables in a PLC - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: vlvcc - description: PLC control crate device prefix - - type: str - name: addr - description: DM variable of the int - - type: id - name: name - description: Object name and gui association name - - type: str - name: ftvl - description: Type of data in subArray - default: USHORT - databases: - - file: $(DLSPLC)/db/dlsPLC_readInt16.template - args: - vlvcc: - ftvl: - addr: - Q: - P: - name: -- name: writeInt16 - description: Write an int32 value into a PLC DM variable - args: - - type: str - name: P - description: device prefix - - type: str - name: Q - description: device suffix - - type: str - name: port - description: asyn port name of FINS driver - - type: str - name: addr - description: DM variable of the LOWERer address of the float32 - - type: int - name: timeout - description: Timeout in seconds for the FINS protocol reads/writes - default: 0 - - type: id - name: name - description: Object name and gui association name - databases: - - file: $(DLSPLC)/db/dlsPLC_writeInt16.template - args: - addr: - Q: - P: - timeout: - port: - name: -- name: vacValveReadOnly - description: Template for read only vacuum valves - manual valves with limit switches - read back by valve controller PLC so their state is known, but control is not - available. - args: - - type: str - name: device - description: device name of the valve. - - type: str - name: vlvcc - description: device name of valve control crate - - type: str - name: addr - description: First address in the DM variable range decade. E.g. if valve is in - DM110..118 then addr=110 - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Partial) - default: Partial - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to "") - default: '' - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: id - name: name - description: This associates an edm screen with the template - - type: str - name: valvetype - description: Template argument - default: manualValve - databases: - - file: $(DLSPLC)/db/dlsPLC_vacValveReadOnly.template - args: - vlvcc: - addr: - valvetype: - sta_label5: - sta_label4: - sta_label6: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - device: - name: -- name: NX102_PreVacCoils_SMLVDT - description: Template database for an LVDT on PreVac Sample Manipulator. - args: - - type: str - name: device - description: Mandatory. Device name. - - type: str - name: port - description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str - name: lvdtID - description: Mandatory. ID of the LVDT. Defacto it is a number but it need not - be. - - type: str - name: tag - description: Mandatory. NX PLC tag string. - - type: str - name: lvdtprefix - description: Optional. Defaults to ":LVDT". Prefix for - SM LVDT records. - default: :LVDT - - type: str - name: lvdt_shortname - description: Optional. Defaults to "LVDT{{lvdtID}}". Short name - of the LVDT. - default: LVDT{{lvdtID}} - - type: str - name: lvdt_shortdesc - description: Optional. Defaults to "LVDT {{lvdtID}}". Short description - of the LVDT. - default: LVDT {{lvdtID}} - - type: str - name: lvdt_longdesc - description: Optional. Defaults to "Manipulator LVDT {{lvdtID}}". Longer description - of the LVDT. - default: Manipulator LVDT {{lvdtID}} - - type: str - name: tagidx - description: Optional. Defaults to "{{lvdtID}}". NX PLC tag - string array index. - default: '{{lvdtID}}' - - type: str - name: pos_SCAN - description: 'Optional. Defaults to ".5 second". EPICS .SCAN field. Scan rate - for reading encoder. NOTE: This is the normal EPICS .SCAN field scanrate and - the EtherIP S Flag for scanrate is not in use here.' - default: .5 second - - type: int - name: pos_PREC - description: Optional. Defaults to 3. Precision on the encoder position - value. - default: 3 - - type: str - name: pos_EGU - description: Optional. Defaults to empty string. Engineering units on the encoder - value. - default: '' - - type: str - name: pos_LINR - description: Optional. Defaults to empty string. Values can be "NO CONVERSION", - "SLOPE" (must define pos_ESLO and and pos_EOFF), "LINEAR" (must define pos_EGUL - and pos_EGUF), (or name of special table) and it will default to "NO CONVERSION". Conversion - method for encoder value. See EPICS record reference manual sections on the - ai record and the convert menu and conversion. - default: '' - - type: str - name: pos_EGUL - description: Optional. Defaults to empty string. Low end of LINEAR conversion - scale for encoder value. - default: '' - - type: str - name: pos_EGUF - description: Optional. Defaults to empty string. High end or full value on LINEAR - conversion scale for encoder value. - default: '' - - type: str - name: pos_EOFF - description: Optional. Defaults to empty string. The offset on the value for - SLOPE conversion. It will default to 0. - default: '' - - type: str - name: pos_ESLO - description: Optional. Defaults to empty string. The slope on the value for - SLOPE conversion. It will default to 1. - default: '' - - type: str - name: pos_AOFF - description: Optional. Defaults to empty string. The raw adjustment offset on - the value for conversion for all types of conversion. It will default to 0. - default: '' - - type: str - name: pos_ASLO - description: Optional. Defaults to empty string. The raw adjustment slope on - the value for conversion for all types of conversion. It will default to 1. - default: '' - - type: str - name: pos_SMOO - description: Optional. Defaults to empty string. The smoothing fraction parameter - on the smoothing algorithm, value between 0 (no smoothing) and 1 (value never - changes), it will default to 0. - default: '' - - type: str - name: pos_HOPR - description: Optional. Defaults to empty string. The position high operator - display value. Will default to 0. - default: '' - - type: str - name: pos_LOPR - description: Optional. Defaults to empty string. The position low operator display - value. Will default to 0. - default: '' - - type: str - name: pos_HIHI - description: Optional. Defaults to empty string. The position high high limit. It - will default to 0. - default: '' - - type: str - name: pos_HIGH - description: Optional. Defaults to empty string. The position high limit. It - will default to 0. - default: '' - - type: str - name: pos_LOW - description: Optional. Defaults to empty string. The position low limit. It - will default to 0. - default: '' - - type: str - name: pos_LOLO - description: Optional. Defaults to empty string. The position low low limit. It - will default to 0. - default: '' - - type: str - name: pos_HHSV - description: Optional. Defaults to empty string. The alarm severity for the - HIHI alarm. It will default to NO_ALARM. - default: '' - - type: str - name: pos_HSV - description: Optional. Defaults to empty string. The alarm severity for the - HIGH alarm. It will default to NO_ALARM. - default: '' - - type: str - name: pos_LSV - description: Optional. Defaults to empty string. The alarm severity for the - LOW alarm. It will default to NO_ALARM. - default: '' - - type: str - name: pos_LLSV - description: Optional. Defaults to empty string. The alarm severity for the - LOLO alarm. It will default to NO_ALARM. - default: '' - - type: str - name: pos_HYST - description: Optional. Defaults to empty string. The alarm deadband or hysteresis - for the scaled position. It will default to 0. - default: '' - - type: str - name: pos_ADEL - description: Optional. Defaults to empty string. The archiver deadband, to stop - archiving noise, for the scaled position. It will default to 0. - default: '' - - type: str - name: pos_MDEL - description: Optional. Defaults to empty string. The monitor deadband, to stop - reacting noise, for the scaled position. It will default to 0. - default: '' - - type: str - name: raw_EGU - description: Optional. Defaults to count. Engineering units on the encoder - raw value. - default: count - - type: str - name: raw_HYST - description: Optional. Defaults to empty string. The alarm deadband or hysteresis - for the raw position. It will default to 0. - default: '' - - type: str - name: raw_ADEL - description: Optional. Defaults to empty string. The archiver deadband, to stop - archiving noise, for the raw position. It will default to 0. - default: '' - - type: str - name: raw_MDEL - description: Optional. Defaults to empty string. The monitor deadband, to stop - reacting noise, for the raw position. It will default to 0. - default: '' - - type: int - name: slope_PREC - description: Optional. Defaults to 6. Precision on the derived encoder - slope value. - default: 6 - - type: str - name: cal_SCAN - description: 'Optional. Defaults to "1 second". EPICS .SCAN field. Scan rate - for reading calibration parameters. NOTE: This is the normal EPICS .SCAN field - scanrate and the EtherIP S Flag for scanrate is not in use here.' - default: 1 second - - type: float - name: calout_scanrate - description: Optional. Defaults to .5 The value of scanrate which when writing - to NX PLC the calibration output records set the EtherIP scanrate S flag to - in their OUT field syntax to add the readback to one of the EtherIP scanlists. - default: 0.5 - - type: float - name: trigger_scanrate - description: Optional. Defaults to .2 The value of scanrate which - when writing to NX PLC triggers the trigger output records set the EtherIP scanrate - S flag to in their OUT field syntax to add the readback to one of the EtherIP - scanlists. - default: 0.2 - - type: int - name: trigger_onval - description: Optional. Defaults to 1. Value to write to a trigger - tag to pulse the trigger on. Must be consistent with trigger_offval. Together - they allow the defininition of the trigger pulse as a blip or a dip with blip - as the default. - default: 1 - - type: int - name: trigger_offval - description: Optional. Defaults to 0. Value to write to a trigger - tag to pulse the trigger off. Must be consistent with trigger_onval. Together - they allow the defininition of the trigger pulse as a blip or a dip with blip - as the default. - default: 0 - - type: str - name: trigger_ONAM - description: Optional. Defaults to Trigger On. Label for 1 state on a trigger - record. Must be consistent with trigger_onval and trigger_offval. - default: Trigger On - - type: str - name: trigger_ZNAM - description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger - record. Must be consistent with trigger_onval and trigger_offval. - default: Trigger Off - - type: float - name: trigger_pulsestartDLY - description: Optional. Defaults to 1.0. Delay in seconds between last - calibration parameter write and pulsing the trigger. - default: 1.0 - - type: float - name: trigger_pulsewidthDLY - description: Optional. Defaults to 1.0. Delay in seconds between sending - Trigger On and Trigger Off writes when pulsing a trigger. - default: 1.0 - - type: id - name: name - description: Optional. Defaults to empty. Object name and associated - gui name. - databases: - - file: $(DLSPLC)/db/NX102_PreVacCoils_SMLVDT.template - args: - pos_LINR: - pos_ASLO: - raw_EGU: - pos_HIHI: - pos_HYST: - lvdt_shortname: - lvdtID: - tag: - lvdt_longdesc: - pos_ADEL: - pos_SCAN: - pos_SMOO: - port: - slope_PREC: - pos_PREC: - pos_EGUF: - pos_HIGH: - pos_EGUL: - pos_HOPR: - pos_LOW: - tagidx: - lvdtprefix: - pos_EGU: - cal_SCAN: - pos_LLSV: - trigger_ONAM: - pos_EOFF: - pos_HHSV: - calout_scanrate: - pos_LOPR: - pos_LOLO: - trigger_pulsestartDLY: - pos_AOFF: - pos_ESLO: - device: - trigger_pulsewidthDLY: - raw_HYST: - raw_MDEL: - name: - trigger_ZNAM: - pos_LSV: - trigger_scanrate: - pos_HSV: - trigger_onval: - raw_ADEL: - trigger_offval: - lvdt_shortdesc: - pos_MDEL: -- name: overrideRequestMain - description: Template allowing overrideRequestIndividual instances to be created - args: - - type: str - name: P - description: device prefix. This must match a dlsPLC_read100.template device macro - - type: str - name: Q - description: device suffix - - type: str - name: outaddr - description: Output address. Input address is $(outaddr)+1. E.g. if outaddr=80, - read DM81 and write DM80. - - type: str - name: port - description: Asyn port for doing serial comms - - type: int - name: timeout - description: Template argument - default: 0 - databases: - - file: $(DLSPLC)/db/dlsPLC_overrideRequestMain.template - args: - Q: - P: - outaddr: - port: - timeout: -- name: NX102_feTemperature - description: "Template database for an individual temperature on a front end\ntemperature - PLC." - args: - - type: str - name: device - description: PV prefix - - type: str - name: temp - description: PV suffix - - type: str - name: port - description: port name of ether_ip driver - - type: int - name: tagidx - description: temperature index on PLC - - type: str - name: lolo - description: Lolo alarm limit - - type: str - name: low - description: Low alarm limit - - type: str - name: high - description: High alarm limit - - type: str - name: hihi - description: Hihi alarm limit - - type: str - name: hopr - description: High operating range - - type: str - name: lopr - description: Low operating range - - type: str - name: tag - description: etherip tag - default: Temp - - type: str - name: llsv - description: Lolo severity - default: NO_ALARM - - type: str - name: lsv - description: Low severity - default: NO_ALARM - - type: int - name: hyst - description: alarm deadband - default: 0 - - type: float - name: adel - description: archiver deadband - default: 0.2 - - type: int - name: scalefac - description: scale factor for temperature/setpoint (1 for new PLC templates, 10 - for old where PLC reports in 10ths of a degree) - default: 1 - - type: int - name: tempcal - description: temperature calibration offset in egu (default=0) - default: 0 - - type: int - name: prec - description: precision for reporting value back - default: 1 - - type: id - name: name - description: Object and gui association name - - type: str - name: disable_pv - description: If set, then this is the value of A in disable_calc - default: $(device)$(temp):ZERO - - type: str - name: disable_calc - description: If this condition is met then save the current limit and set the - limit to 3276.7, disabling the interlock for this PV - default: A=1 - - type: str - name: egu - description: This associates an edm screen with the template - default: C - - type: str - name: desc - description: Description - databases: - - file: $(DLSPLC)/db/NX102_feTemperature.template - args: - lsv: - tag: - disable_calc: - port: - hyst: - tempcal: - lopr: - hopr: - lolo: - prec: - tagidx: - low: - disable_pv: - scalefac: - device: - desc: - high: - name: - temp: - hihi: - egu: - llsv: - adel: -- name: NX102_digitalIn - description: TODO:ADD DESCRIPTION - args: - - type: str - name: device - description: Template argument - - type: str - name: port - description: Template argument - - type: int - name: tagidx - description: Template argument - - type: id - name: name - description: Template argument - - type: str - name: tag - description: Template argument - default: Digital_In - databases: - - file: $(DLSPLC)/db/NX102_digitalIn.template - args: - device: - tagidx: - tag: - port: - name: -- name: NX102_vacValveBistable - description: Template database for a bistable vacuum valve without debounce or raw - air records. It has different interlocks for opening and closing it. - args: - - type: str - name: device - description: device name - - type: str - name: port - description: EtherIP Port Name - - type: str - name: tag - description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int - name: tagidx - description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int - name: ILKNUM - description: Part of Gauge PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str - name: allowpv - description: If specified, then only write an open command when this is non-zero. - MUST have CP at the end of it. (Optional - defaults to "") - default: '' - - type: str - name: whylocked - description: String to output to EDM synoptic as to precisely why the device is - locked and by whom (Optional. Defaults to "Open command not allowed") - default: Open command not allowed - - type: str - name: con_label0 - description: Label string for control value 0 (Optional - defaults to Open) - default: Open - - type: str - name: con_label1 - description: Label string for control value 1 (Optional - defaults to Close) - default: Close - - type: str - name: con_label2 - description: Label string for control value 2 (Optional - defaults to Reset) - default: Reset - - type: str - name: con_label3 - description: Label string for control value 3 (Optional - defaults to Close Enable) - default: Close Enable - - type: str - name: con_label4 - description: Label string for control value 4 (Optional - defaults to "") - default: '' - - type: str - name: con_label5 - description: Label string for control value 5 (Optional - defaults to "") - default: '' - - type: str - name: con_label6 - description: Label string for control value 6 (Optional - defaults to "") - default: '' - - type: str - name: con_label7 - description: Label string for control value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_label0 - description: Label string for status value 0 (Optional - defaults to Fault) - default: Fault - - type: str - name: sta_label1 - description: Label string for status value 1 (Optional - defaults to Open) - default: Open - - type: str - name: sta_label2 - description: Label string for status value 2 (Optional - defaults to Opening) - default: Opening - - type: str - name: sta_label3 - description: Label string for status value 3 (Optional - defaults to Closed) - default: Closed - - type: str - name: sta_label4 - description: Label string for status value 4 (Optional - defaults to Closing) - default: Closing - - type: str - name: sta_label5 - description: Label string for status value 5 (Optional - defaults to "") - default: '' - - type: str - name: sta_label6 - description: Label string for status value 6 (Optional - defaults to "") - default: '' - - type: str - name: sta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: sta_sv0 - description: Alarm severity for status value 0 (Optional - defaults to MAJOR) - default: MAJOR - - type: str - name: sta_sv1 - description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv2 - description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv3 - description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv4 - description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv5 - description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv6 - description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: sta_sv7 - description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_label0 - description: Label string for status value 0 (Optional - defaults to Failed) - default: Failed - - type: str - name: ilksta_label1 - description: Label string for status value 1 (Optional - defaults to Open Disabled) - default: Open Disabled - - type: str - name: ilksta_label2 - description: Label string for status value 2 (Optional - defaults to Closed, Open - Available) - default: Closed, Open Available - - type: str - name: ilksta_label3 - description: Label string for status value 3 (Optional - defaults to Open) - default: Open - - type: str - name: ilksta_label4 - description: Label string for status value 4 (Optional - defaults to Close Disabled) - default: Close Disabled - - type: str - name: ilksta_label5 - description: Label string for status value 5 (Optional - defaults to Open, Close - Available) - default: Open, Close Available - - type: str - name: ilksta_label6 - description: Label string for status value 6 (Optional - defaults to Closed) - default: Closed - - type: str - name: ilksta_label7 - description: Label string for status value 7 (Optional - defaults to "") - default: '' - - type: str - name: ilksta_sv0 - description: Alarm severity for interlock status value 0 (Optional - defaults - to MAJOR) - default: MAJOR - - type: str - name: ilksta_sv1 - description: Alarm severity for interlock status value 1 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv2 - description: Alarm severity for interlock status value 2 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv3 - description: Alarm severity for interlock status value 3 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv4 - description: Alarm severity for interlock status value 4 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv5 - description: Alarm severity for interlock status value 5 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv6 - description: Alarm severity for interlock status value 6 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: ilksta_sv7 - description: Alarm severity for interlock status value 7 (Optional - defaults - to NO_ALARM) - default: NO_ALARM - - type: str - name: mode1 - description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults - to Operational) - default: Operational - - type: str - name: mode2 - description: name of local operational mode (:MODE.ONAM) (Optional - defaults - to Service) - default: Service - - type: str - name: DIRILK1 - description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for - "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve - (Optional - defaults to OPEN) - default: OPEN - - type: str - name: DIRILK1_label - description: Label string for the interlock 1 "direction". (Optional - defaults - to Open) - default: Open - - type: str - name: DIRILK2 - description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for - "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable - valves (Optional - defaults to CLOSE) - default: CLOSE - - type: str - name: DIRILK2_label - description: Label string for the interlock 2 "direction". (Optional - defaults - to Close) - default: Close - - type: id - name: name - description: "Object name and associated gui name \t (Optional - defaults to - \"\")" - - type: str - name: desc - description: Box label for gui (Optional - defaults to - value of device macro) - default: $(device) - - type: str - name: valvetype - description: Type of valve for the gui. (Optional - defaults to valve). - default: valve - databases: - - file: $(DLSPLC)/db/NX102_vacValveBistable.template - args: - con_label3: - con_label2: - con_label1: - con_label0: - con_label7: - con_label6: - con_label5: - con_label4: - allowpv: - ilksta_label6: - ilksta_label4: - tag: - ilksta_sv3: - ilksta_sv2: - ilksta_label0: - ilksta_sv0: - ilksta_sv1: - ilksta_sv6: - port: - ilksta_sv4: - ilksta_label1: - mode2: - ilksta_label2: - mode1: - ilksta_label3: - ilksta_label5: - DIRILK1: - DIRILK2: - ilksta_sv7: - sta_label5: - sta_label4: - sta_label7: - tagidx: - sta_label1: - sta_label0: - sta_label3: - sta_label2: - ilksta_sv5: - DIRILK1_label: - sta_sv1: - sta_sv0: - sta_sv3: - sta_sv2: - sta_sv5: - sta_sv4: - sta_sv7: - sta_sv6: - valvetype: - sta_label6: - DIRILK2_label: - device: - whylocked: - desc: - ILKNUM: - name: - ilksta_label7: -- name: NX102_flowMeter - description: Template database for a machine flow meter - args: - - type: str - name: device - description: device name - - type: str - name: port - description: asyn port name of etherip driver - - type: int - name: tagidx - description: etherip tag index - - type: str - name: desc - description: Template argument - - type: str - name: tag - description: etherip tag - default: FlowRate - - type: str - name: egu - description: EGU - default: Litres / Hour - - type: int - name: prec - description: PREC - default: 1 - - type: int - name: hopr - description: HOPR - default: 300 - - type: float - name: lopr - description: LOPR - default: 0.0 - - type: int - name: hihi - description: HIHI - default: 295 - - type: int - name: lolo - description: LOLO - default: 100 - - type: int - name: high - description: HIGH - default: 275 - - type: int - name: adel - description: ADEL - default: 50 - - type: int - name: mdel - description: MDEL - default: 10 - - type: int - name: low - description: LOW - default: 120 - databases: - - file: $(DLSPLC)/db/NX102_flowMeter.template - args: - lopr: - lolo: - mdel: - tagidx: - egu: - high: - device: - tag: - low: - hopr: - adel: - prec: - hihi: - port: - desc: diff --git a/tests/samples/outputs/dlsPLC.ibek.support.yaml b/tests/samples/outputs/dlsPLC.ibek.support.yaml index 08c418588..e89a408bd 100644 --- a/tests/samples/outputs/dlsPLC.ibek.support.yaml +++ b/tests/samples/outputs/dlsPLC.ibek.support.yaml @@ -3,29 +3,29 @@ defs: - name: overrideRequestIndividual description: Template allowing override of individual interlock bits args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: DESC description: Description (e.g. DCM piezo override) - - type: str + - arg_type: str name: PRESSURE1 description: Pressure in mbar that needs to be over setpoint to allow override - - type: str + - arg_type: str name: PRESSURE2 description: Pressure in mbar that needs to be over setpoint to allow override - - type: str + - arg_type: str name: OVERRIDE description: P of overrideRequestMain instance - - type: str + - arg_type: str name: BIT description: Bit of overrideRequestMain instance to use (0-8) - - type: str + - arg_type: str name: SETPOINT description: Setpoint in mbar that both pressures need to be higher than to allow override - - type: id + - arg_type: id name: name description: This associates an edm screen with the template databases: @@ -42,7 +42,7 @@ defs: - name: softwareVersion description: Template that reads software version from a PLC. args: - - type: str + - arg_type: str name: device description: Device prefix databases: @@ -53,312 +53,312 @@ defs: description: Template database for a vacuum valve with different interlocks for open and close operations args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: device name of valve control crate - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM150..159 then addr=150 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: cilk0 description: Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: cilk1 description: Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: cilk2 description: Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: cilk3 description: Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: cilk4 description: Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: cilk5 description: Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: cilk6 description: Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: cilk7 description: Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: cilk8 description: Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: cilk9 description: Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: cilk10 description: Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: cilk11 description: Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: cilk12 description: Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: cilk13 description: Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: cilk14 description: Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: cilk15 description: Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: valvetype description: Template argument default: valve - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: Template argument default: Operational - - type: str + - arg_type: str name: mode2 description: Template argument default: Service @@ -417,7 +417,7 @@ defs: sta_sv5: sta_sv4: sta_sv6: - valvetype: + valvearg_type: ilk6: ilk2: ilk7: @@ -446,86 +446,86 @@ defs: - name: writeEnum description: Write the Enum value into a DM variable in a PLC args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: int + - arg_type: int name: timeout description: timeout on PV write attempts default: 0 - - type: int + - arg_type: int name: VAL0 description: Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: String Value for state 0 default: '' - - type: str + - arg_type: str name: STR1 description: String Value for state 1 default: '' - - type: str + - arg_type: str name: STR2 description: String Value for state 2 default: '' - - type: str + - arg_type: str name: STR3 description: String Value for state 3 default: '' - - type: str + - arg_type: str name: STR4 description: String Value for state 4 default: '' - - type: str + - arg_type: str name: STR5 description: String Value for state 5 default: '' - - type: str + - arg_type: str name: STR6 description: String Value for state 6 default: '' - - type: str + - arg_type: str name: STR7 description: String Value for state 7 default: '' @@ -561,35 +561,35 @@ defs: bits. E.g. if interlock DM816..818 bit 4 is S1 water,\nuse loloaddress=818,lolobit=4 for instantaneous lolo signal" args: - - type: str + - arg_type: str name: P description: EPICS prefix - - type: str + - arg_type: str name: Q description: EPICS suffix - - type: str + - arg_type: str name: DESC description: Description - - type: str + - arg_type: str name: device description: EPICS name of the vacuum valve crate that connects to the RIO - - type: str + - arg_type: str name: loaddress description: Address of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - type: str + - arg_type: str name: lobit description: Bit of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - type: str + - arg_type: str name: loloaddress description: Address of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - type: str + - arg_type: str name: lolobit description: Bit of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - type: id + - arg_type: id name: name description: This associates an edm screen with the template databases: @@ -607,82 +607,82 @@ defs: - name: readEnum description: Read the Enum value stored in a DM variable in a PLC args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: vlvcc description: PLC control crate device prefix - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: int + - arg_type: int name: VAL0 description: Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: String Value for state 0 default: '' - - type: str + - arg_type: str name: STR1 description: String Value for state 1 default: '' - - type: str + - arg_type: str name: STR2 description: String Value for state 2 default: '' - - type: str + - arg_type: str name: STR3 description: String Value for state 3 default: '' - - type: str + - arg_type: str name: STR4 description: String Value for state 4 default: '' - - type: str + - arg_type: str name: STR5 description: String Value for state 5 default: '' - - type: str + - arg_type: str name: STR6 description: String Value for state 6 default: '' - - type: str + - arg_type: str name: STR7 description: String Value for state 7 default: '' @@ -713,125 +713,125 @@ defs: - name: motionInterlockPLC description: TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: Name - - type: str + - arg_type: str name: device description: Device Prefix - - type: object + - arg_type: object name: port description: Fins port - - type: int + - arg_type: int name: addr description: First interlock work - - type: str + - arg_type: str name: axis1Description description: Axis 1 Description default: unused - - type: str + - arg_type: str name: axis2Description description: Axis 2 Description default: unused - - type: str + - arg_type: str name: axis3Description description: Axis 3 Description default: unused - - type: str + - arg_type: str name: axis4Description description: Axis 4 Description default: unused - - type: str + - arg_type: str name: axis5Description description: Axis 5 Description default: unused - - type: str + - arg_type: str name: axis6Description description: Axis 6 Description default: unused - - type: str + - arg_type: str name: axis7Description description: Axis 7 Description default: unused - - type: str + - arg_type: str name: axis8Description description: Axis 8 Description default: unused - - type: str + - arg_type: str name: interlock description: Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: desc description: Permit description (e.g. Front end permit) - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: int + - arg_type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -867,48 +867,48 @@ defs: description: Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: variable description: PV suffix (its associated _RBV will be autogenerated). - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: tag name of ether_ip read value - - type: str + - arg_type: str name: tagwrite description: tag name of ether_ip write value - - type: str + - arg_type: str name: drvl description: Lowest accepted value - - type: str + - arg_type: str name: drvh description: This associates an edm screen with the template - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: desc description: Description default: '' - - type: str + - arg_type: str name: readscan description: value update time for readback value default: 1 second - - type: float + - arg_type: float name: writescan description: value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - type: str + - arg_type: str name: egu description: Engineering units default: '' - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 2 @@ -931,10 +931,10 @@ defs: - name: externalValve description: Valve interface for a valve that lives in another IOC args: - - type: str + - arg_type: str name: device description: Device macro of valve that exists in another IOC - - type: enum + - arg_type: enum name: valvetype description: Type of Device default: valve @@ -946,86 +946,86 @@ defs: description: "Template database for a dummy vacuum valve, enough to keep\nvacuum space happy\nPeter Denison 30/9/2005, based on vacuum valve by\nPete Owens - 26/4/04" args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: con_label0 description: con_label0 default: Open - - type: str + - arg_type: str name: con_label1 description: con_label1 default: Close - - type: str + - arg_type: str name: con_label2 description: con_label2 default: Reset - - type: str + - arg_type: str name: con_label3 description: con_label3 default: '' - - type: str + - arg_type: str name: con_label4 description: con_label4 default: '' - - type: str + - arg_type: str name: con_label5 description: con_label5 default: '' - - type: str + - arg_type: str name: con_label6 description: con_label6 default: '' - - type: str + - arg_type: str name: ilksta_label0 description: ilksta_label0 default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: ilksta_label1 default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: ilksta_label2 default: OK - - type: str + - arg_type: str name: ilksta_label3 description: ilksta_label3 default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: ilksta_label4 default: '' - - type: str + - arg_type: str name: ilksta_label5 description: ilksta_label5 default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: ilksta_sv0 default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: ilksta_sv1 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: ilksta_sv2 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: ilksta_sv3 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: ilksta_sv4 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: ilksta_sv5 default: NO_ALARM - - type: str + - arg_type: str name: allowpv description: Template argument default: '' @@ -1056,316 +1056,316 @@ defs: - name: fastValve description: Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: device name of valve control crate - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: Arm - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open Armed - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: Open Disarmed - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: desc description: Box label for gui default: $(device) - - type: int + - arg_type: int name: showilk description: 0 (default) => Gauge, 1 => Arm default: 0 - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: Template argument default: Operational - - type: str + - arg_type: str name: mode2 description: Template argument default: Service @@ -1454,19 +1454,19 @@ defs: - name: NX102_mpsPermit description: TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: Template argument - - type: str + - arg_type: str name: port description: Template argument - - type: str + - arg_type: str name: tag description: Template argument - - type: int + - arg_type: int name: tagidx description: Template argument - - type: str + - arg_type: str name: DIRILK1 description: Template argument default: '' @@ -1482,68 +1482,68 @@ defs: description: "Creates beam records that the gui can connect to to see which valves and\n shutters are open" args: - - type: str + - arg_type: str name: P description: Device prefix for summary PV, records will be $(P):STA$(N) for 1<=N<=#objects - - type: object + - arg_type: object name: object0 description: vacuumValve object - - type: object + - arg_type: object name: object1 description: vacuumValve object - - type: object + - arg_type: object name: object2 description: vacuumValve object - - type: object + - arg_type: object name: object3 description: vacuumValve object - - type: object + - arg_type: object name: object4 description: vacuumValve object - - type: object + - arg_type: object name: object5 description: vacuumValve object - - type: object + - arg_type: object name: object6 description: vacuumValve object - - type: object + - arg_type: object name: object7 description: vacuumValve object - - type: object + - arg_type: object name: object8 description: vacuumValve object - - type: object + - arg_type: object name: object9 description: vacuumValve object - - type: object + - arg_type: object name: object10 description: vacuumValve object - - type: object + - arg_type: object name: object11 description: vacuumValve object - name: readFloat32 description: Read the Float32 value stored in 2 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: SCAN description: Scan rate of read record default: 1 second @@ -1562,109 +1562,109 @@ defs: are created in the dlsPLC_DCMHeater.template file so that they have the archiver tag applied." args: - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: P description: Device Prefix - - type: str + - arg_type: str name: Q description: Device Suffix - - type: str + - arg_type: str name: desc description: Description - - type: str + - arg_type: str name: vlvcc description: Parent PLC control crate device prefix - - type: object + - arg_type: object name: port description: asyn port name of FINS driver - - type: int + - arg_type: int name: C_addr description: Address of the demand register - - type: int + - arg_type: int name: UTSP_addr description: Address of the under temperature setpoint register - - type: int + - arg_type: int name: PID_offset description: 2 digit integer offset of DM variables. E.g. if Proportional gain constant setpoint is in DM150 and readback in DM250 offset=50 - - type: int + - arg_type: int name: PID_output_addr description: Address of the PID loop output - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: int + - arg_type: int name: VAL0 description: Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: String Value for state 0 default: '' - - type: str + - arg_type: str name: STR1 description: String Value for state 1 default: '' - - type: str + - arg_type: str name: STR2 description: String Value for state 2 default: '' - - type: str + - arg_type: str name: STR3 description: String Value for state 3 default: '' - - type: str + - arg_type: str name: STR4 description: String Value for state 4 default: '' - - type: str + - arg_type: str name: STR5 description: String Value for state 5 default: '' - - type: str + - arg_type: str name: STR6 description: String Value for state 6 default: '' - - type: str + - arg_type: str name: STR7 description: String Value for state 7 default: '' - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: ftvl description: Type of data in subArray default: USHORT @@ -1741,227 +1741,227 @@ defs: - name: NX102_vacValve description: Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: EtherIP Port Name - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - type: id + - arg_type: id name: name description: Object name and associated gui name (Optional - defaults to "") - - type: str + - arg_type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) @@ -2025,19 +2025,19 @@ defs: - name: fastVacuumMaster description: TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: Gui tag - - type: str + - arg_type: str name: dom description: Domain, eg, FE06I - - type: object + - arg_type: object name: fins_port description: FINS port - - type: str + - arg_type: str name: eip_port description: EtherIP port - - type: str + - arg_type: str name: device description: Device prefix values: @@ -2053,20 +2053,20 @@ defs: description: "Template that reads 100 blocks of memory into records so\nthat it can be used in various templates." args: - - type: str + - arg_type: str name: device description: Device prefix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: century description: Read DM$(century)00..DM$(century)99 - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: SCAN description: Scan rate of read record default: 1 second @@ -2082,83 +2082,83 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC." args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: temp description: PV suffix - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: lolo description: Lolo alarm limit - - type: str + - arg_type: str name: low description: Low alarm limit - - type: str + - arg_type: str name: high description: High alarm limit - - type: str + - arg_type: str name: hihi description: Hihi alarm limit - - type: str + - arg_type: str name: hopr description: High operating range - - type: str + - arg_type: str name: lopr description: Low operating range - - type: str + - arg_type: str name: tag description: Tag name on PLC -- default "Temp" for e.g. Temp.Value[tagindex] E default: '"' - - type: str + - arg_type: str name: llsv description: Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - type: int + - arg_type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: Object and gui association name - - type: str + - arg_type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: str + - arg_type: str name: egu description: This associates an edm screen with the template default: C - - type: str + - arg_type: str name: desc description: Description databases: @@ -2191,126 +2191,126 @@ defs: created in the associated template file so that they have the archiver tag applied.\n\ \ Initially created for use with K11's proportional valve (2021)." args: - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: P description: Device Prefix - - type: str + - arg_type: str name: Q description: Device Suffix - - type: str + - arg_type: str name: desc description: Description - - type: str + - arg_type: str name: vlvcc description: Parent PLC control crate device prefix - - type: object + - arg_type: object name: port description: asyn port name of FINS driver - - type: int + - arg_type: int name: SetValue_addr description: Address of the value register for value setting - - type: int + - arg_type: int name: PID_output_addr description: Address of the current PID output value read - - type: int + - arg_type: int name: Control_addr description: Address of the demand register for mode setting - - type: int + - arg_type: int name: PID_addr description: Address of the PID values group read block (starting by Proportional constant) - - type: int + - arg_type: int name: PIDwrite_addr description: Address of the PID values group write block (starting by Proportional constant) - - type: str + - arg_type: str name: units description: Value units - - type: int + - arg_type: int name: precision description: Decimal precision for setpoint (converted from integer) - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: int + - arg_type: int name: VAL0 description: Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: String Value for state 0 default: '' - - type: str + - arg_type: str name: STR1 description: String Value for state 1 default: '' - - type: str + - arg_type: str name: STR2 description: String Value for state 2 default: '' - - type: str + - arg_type: str name: STR3 description: String Value for state 3 default: '' - - type: str + - arg_type: str name: STR4 description: String Value for state 4 default: '' - - type: str + - arg_type: str name: STR5 description: String Value for state 5 default: '' - - type: str + - arg_type: str name: STR6 description: String Value for state 6 default: '' - - type: str + - arg_type: str name: STR7 description: String Value for state 7 default: '' - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: ftvl description: Type of data in subArray default: USHORT - - type: str + - arg_type: str name: UNITS description: common units - - type: int + - arg_type: int name: PREC description: decimal precision for SetPoint and Proportional Constant default: 0 @@ -2389,30 +2389,30 @@ defs: - name: writeFloat32 description: Write an float32 value into a PLC DM variable args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: int + - arg_type: int name: drvl description: Drive low limit default: 0 - - type: int + - arg_type: int name: drvh description: Drive high limit default: 0 @@ -2431,93 +2431,93 @@ defs: description: Template database for reading the status of a DX200 controller through NX102 PLC args: - - type: str + - arg_type: str name: P description: PV prefix - - type: str + - arg_type: str name: Q description: PV suffix - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tag description: ether_ip tag name of robot status - - type: str + - arg_type: str name: numbits description: number of bits used - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: scan description: value update time default: 1 second - - type: str + - arg_type: str name: desc description: Description default: '' - - type: str + - arg_type: str name: label0 description: Label string for status bit 0 default: unused - - type: str + - arg_type: str name: label1 description: Label string for status bit 1 default: unused - - type: str + - arg_type: str name: label2 description: Label string for status bit 2 default: unused - - type: str + - arg_type: str name: label3 description: Label string for status bit 3 default: unused - - type: str + - arg_type: str name: label4 description: Label string for status bit 4 default: unused - - type: str + - arg_type: str name: label5 description: Label string for status bit 5 default: unused - - type: str + - arg_type: str name: label6 description: Label string for status bit 6 default: unused - - type: str + - arg_type: str name: label7 description: Label string for status bit 7 default: unused - - type: str + - arg_type: str name: label8 description: Label string for status bit 8 default: unused - - type: str + - arg_type: str name: label9 description: Label string for status bit 9 default: unused - - type: str + - arg_type: str name: labelA description: Label string for status bit 10 default: unused - - type: str + - arg_type: str name: labelB description: Label string for status bit 11 default: unused - - type: str + - arg_type: str name: labelC description: Label string for status bit 12 default: unused - - type: str + - arg_type: str name: labelD description: Label string for status bit 13 default: unused - - type: str + - arg_type: str name: labelE description: Label string for status bit 14 default: unused - - type: str + - arg_type: str name: labelF description: This associates a BOY screen with the template default: unused @@ -2551,58 +2551,58 @@ defs: - name: interlockNameOverride description: Template allowing interlock names to be overriden. args: - - type: str + - arg_type: str name: device description: device prefix - - type: str + - arg_type: str name: interlock description: Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 databases: @@ -2630,96 +2630,96 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: temp description: PV suffix - - type: str + - arg_type: str name: desc description: Description - - type: str + - arg_type: str name: tmpcc description: Parent temperature control crate prefix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: offset description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - type: str + - arg_type: str name: lolo description: Lolo alarm limit - - type: str + - arg_type: str name: low description: Low alarm limit - - type: str + - arg_type: str name: high description: High alarm limit - - type: str + - arg_type: str name: hihi description: Hihi alarm limit - - type: str + - arg_type: str name: hopr description: High operating range - - type: str + - arg_type: str name: lopr description: Low operating range - - type: str + - arg_type: str name: llsv description: Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: scale factor for temperature/setpoint default: 10 - - type: int + - arg_type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: Object and gui association name - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: int + - arg_type: int name: incentury description: The Century digit(s) for the PLC D address to read temperature values default: 2 - - type: int + - arg_type: int name: outcentury description: The Century digit(s) for the PLC D address to write setpoints default: 1 - - type: str + - arg_type: str name: egu description: This associates an edm screen with the template default: C @@ -2757,10 +2757,10 @@ defs: - name: motionLimitInterlock description: TODO:ADD DESCRIPTION args: - - type: object + - arg_type: object name: PLC description: Instance of motionInterlockPLC to belong to - - type: enum + - arg_type: enum name: axisNo description: Axis Number values: @@ -2772,273 +2772,273 @@ defs: '"8"': '"2"': '"3"': - - type: enum + - arg_type: enum name: pLim description: 1 for +lim, 0 for -lim values: '"0"': '"1"': - - type: str + - arg_type: str name: ilk0 description: Interlock 0 description default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock 1 description default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock 2 description default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock 3 description default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock 4 description default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock 5 description default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock 6 description default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock 7 description default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock 8 description default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock 9 description default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock 10 description default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock 11 description default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock 12 description default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock 13 description default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock 14 description default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock 15 description default: unused - name: vacPump description: Template database for a vacuum Pump without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: device name of Pump control crate - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to On) default: On - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Off) default: Off - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to On) default: On - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Turning On) default: Turning On - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Off) default: Off - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Turning Off) default: Turning Off - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - type: enum + - arg_type: enum name: pumptype description: Type of Pump default: turbo @@ -3046,51 +3046,51 @@ defs: '"cryo"': '"scroll"': '"turbo"': - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -3148,7 +3148,7 @@ defs: ilksta_label3: ilk5: name: - pumptype: + pumparg_type: con_label3: ilk9: ilk6: @@ -3162,46 +3162,46 @@ defs: - name: readInt32 description: Read the Int32 value stored in 2 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: str + - arg_type: str name: port description: Template argument - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: int + - arg_type: int name: scale description: Scaling of raw value into EGUs default: 1 - - type: int + - arg_type: int name: roffset description: Pre scaling offset in cts default: 0 - - type: int + - arg_type: int name: offset description: Offset of value in EGUs default: 0 - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: scan description: Template argument default: 1 second - - type: str + - arg_type: str name: egu description: Template argument default: mm - - type: int + - arg_type: int name: prec description: Template argument default: 3 @@ -3224,41 +3224,41 @@ defs: description: "Template database for a group of up to 8 vacuum valves\nPete Owens - 3/5/05" args: - - type: str + - arg_type: str name: device description: device name - - type: float + - arg_type: float name: delay description: delay between opening valves - - type: str + - arg_type: str name: valve1 description: Valve 1 device name - - type: str + - arg_type: str name: valve2 description: Valve 2 device name - - type: str + - arg_type: str name: valve3 description: Valve 3 device name - - type: str + - arg_type: str name: valve4 description: Valve 4 device name - - type: str + - arg_type: str name: valve5 description: Valve 5 device name - - type: str + - arg_type: str name: valve6 description: Valve 6 device name - - type: str + - arg_type: str name: valve7 description: Valve 7 device name - - type: str + - arg_type: str name: valve8 description: Valve 8 device name - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) default: Service @@ -3280,246 +3280,246 @@ defs: - name: NX102_fastValve description: Template database for a fast vacuum valve. args: - - type: str + - arg_type: str name: device description: Mandatory. Device name of the fast valve used as PV name prefix. - - type: str + - arg_type: str name: port description: Mandatory. EtherIP communication port name. - - type: str + - arg_type: str name: tag description: Mandatory. NX PLC protocol tag string. - - type: int + - arg_type: int name: tagidx description: Mandatory. NX PLC tag index number. - - type: int + - arg_type: int name: ILKNUM description: Mandatory. Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: Optional. Defaults to "". If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. default: '' - - type: str + - arg_type: str name: whylocked description: Optional. Defaults to "Open command not allowed". String for GUI screen as to precisely why the device is locked and by whom. default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: Optional. Defaults to Open. Label string for control value 0. default: Open - - type: str + - arg_type: str name: con_label1 description: Optional. Defaults to Close. Label string for control value 1. default: Close - - type: str + - arg_type: str name: con_label2 description: Optional. Defaults to Reset. Label string for control value 2. default: Reset - - type: str + - arg_type: str name: con_label3 description: Optional. Defaults to Arm. Label string for control value 3. default: Arm - - type: str + - arg_type: str name: con_label4 description: Optional. Defaults to "". Label string for control value 4. default: Partially Arm - - type: str + - arg_type: str name: con_label5 description: Optional. Defaults to "". Label string for control value 5. default: '' - - type: str + - arg_type: str name: con_label6 description: Optional. Defaults to "". Label string for control value 6. default: '' - - type: str + - arg_type: str name: con_label7 description: Optional. Defaults to "". Label string for control value 7. default: '' - - type: str + - arg_type: str name: sta_label0 description: "Optional. Defaults to Fault.\t\t Label string for status value 0." default: Fault - - type: str + - arg_type: str name: sta_label1 description: "Optional. Defaults to Open Fully Armed.\t Label string for status value 1." default: Open Armed - - type: str + - arg_type: str name: sta_label2 description: "Optional. Defaults to Opening.\t\t Label string for status value 2." default: Opening - - type: str + - arg_type: str name: sta_label3 description: "Optional. Defaults to Closed.\t\t Label string for status value 3." default: Closed - - type: str + - arg_type: str name: sta_label4 description: "Optional. Defaults to Closing.\t\t Label string for status value 4." default: Closing - - type: str + - arg_type: str name: sta_label5 description: "Optional. Defaults to Open Disarmed.\t Label string for status value 5." default: Open Disarmed - - type: str + - arg_type: str name: sta_label6 description: Optional. Defaults to Open Partially Armed. Label string for status value 6. default: Partially Armed - - type: str + - arg_type: str name: sta_label7 description: "Optional. Defaults to \"\". \t \t Label string for status value 7." default: '' - - type: str + - arg_type: str name: sta_sv0 description: "Optional. Defaults to MAJOR. \t Alarm severity for status value 0." default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 1." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 2." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 3." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 4." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 5." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 6." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 7." default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Optional. Defaults to Failed. Label string for status value 0. default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Optional. Defaults to Run Ilks Ok. Label string for status value 1. default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: "Optional. Defaults to OK. \t Label string for status value 2." default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Optional. Defaults to Disarmed. Label string for status value 3. default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: "Optional. Defaults to \"\".\t Label string for status value 4." default: '' - - type: str + - arg_type: str name: ilksta_label5 description: "Optional. Defaults to \"\".\t Label string for status value 5." default: '' - - type: str + - arg_type: str name: ilksta_label6 description: "Optional. Defaults to \"\".\t Label string for status value 6." default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Optional. Defaults to "". Label string for status value 7. default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - type: str + - arg_type: str name: mode2 description: Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - type: str + - arg_type: str name: DIRILK1 description: Optional. Defaults to "". Component interlock PV names (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1. default: '' - - type: int + - arg_type: int name: showilk description: 'Optional. Defaults to 0. Which set of interlocks to display - 0: Gauge 1: Arm' default: 0 - - type: id + - arg_type: id name: name description: Optional. Defaults to "". Object name and associated gui name. @@ -3581,13 +3581,13 @@ defs: - name: NX102_radmonreset description: "Template database for a vacuum valve\nIan Gillingham October 2012" args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: asyn port name - - type: str + - arg_type: str name: radmon_device description: full PV name of RAD MON :RESET:OK databases: @@ -3599,312 +3599,312 @@ defs: - name: vacValveSoftOpening description: Template database for a soft opening vacuum valve. args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: 'device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address' - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - type: str + - arg_type: str name: fullilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: fullilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: fullilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: fullilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: fullilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: fullilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: fullilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: fullilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: fullilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: fullilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: fullilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: fullilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: fullilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: fullilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: fullilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: fullilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: softilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: softilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: softilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: softilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: softilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: softilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: softilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: softilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: softilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: softilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: softilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: softilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: softilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: softilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: softilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: softilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Soft Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to Full Open) default: Full Open - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Full Open) default: Full Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Soft Open) default: Soft Open - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for interlock status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for interlock status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Label string for interlock status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Label string for interlock status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Label string for interlock status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Label string for interlock status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: allowpv description: Template argument default: '' - - type: str + - arg_type: str name: whylocked description: Template argument default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Template argument default: 0 @@ -3990,244 +3990,244 @@ defs: description: Template5B database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: device name of valve control crate - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Off - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: '' - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Off - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: '' - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: This associates an edm screen with the template default: Service - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -4318,64 +4318,64 @@ defs: to allow transfers. (NOTE: In descriptions and macro names, "arm" is a noun referring to the sample manipulator arm and not a verb as used for a fast valve).' args: - - type: str + - arg_type: str name: device description: Mandatory. Device name. - - type: str + - arg_type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: tag_sourceparam description: Mandatory. NX PLC tag string to write the source chamber parameter. - - type: str + - arg_type: str name: tag_targetparam description: Mandatory. NX PLC tag string to write the target chamber parameter. - - type: str + - arg_type: str name: tag_setcoil description: Mandatory. NX PLC tag string to set a Coil to TRUE. - - type: str + - arg_type: str name: tag_unsetcoil description: Mandatory. NX PLC tag string to set a Coil to FALSE. - - type: str + - arg_type: str name: tag_Tsourceparam description: Optional. Defaults to T$(tag_sourceparam). NX PLC tag string to set the trigger to set the source chamber parameter. default: T$(tag_sourceparam) - - type: str + - arg_type: str name: tag_Ttargetparam description: Optional. Defaults to T$(tag_targetparam). NX PLC tag string to set the trigger to set the target chamber parameter. default: T$(tag_targetparam) - - type: str + - arg_type: str name: tag_Tsetcoil description: Optional. Defaults to T$(tag_setcoil). NX PLC tag string to set the trigger to set a Coil to TRUE. default: T$(tag_setcoil) - - type: str + - arg_type: str name: tag_Tunsetcoil description: Optional. Defaults to T$(tag_unsetcoil). NX PLC tag string to set the trigger to set a Coil to FALSE. default: T$(tag_unsetcoil) - - type: float + - arg_type: float name: coilout_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the coil output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. (These are the records which run commands). default: 0.2 - - type: float + - arg_type: float name: paramout_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the parameter output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - type: float + - arg_type: float name: trigger_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - type: int + - arg_type: int name: posportIDs_allowedmask description: Optional. Defaults to 0. Mask of bits set for each posportID number which is allowed as source and target. (i.e. a chamber is present). Bit 0 @@ -4383,200 +4383,200 @@ defs: has special functionality for error recovery as a source. Although the macro is optional, the default value doesnt allow any transfers, so you must set this. default: 0 - - type: str + - arg_type: str name: posportID0_shortdesc description: Optional. Defaults to Arm. Short (for menu) description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to get a readable menu button. default: Arm - - type: str + - arg_type: str name: posportID1_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 1. default: '' - - type: str + - arg_type: str name: posportID2_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 2. default: '' - - type: str + - arg_type: str name: posportID3_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 3. default: '' - - type: str + - arg_type: str name: posportID4_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 4. default: '' - - type: str + - arg_type: str name: posportID5_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 5. default: '' - - type: str + - arg_type: str name: posportID6_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 6. default: '' - - type: str + - arg_type: str name: posportID7_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 7. default: '' - - type: str + - arg_type: str name: posportID8_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 8. default: '' - - type: str + - arg_type: str name: posportID0_sourceSV description: Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - type: str + - arg_type: str name: posportID0_targetSV description: Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - type: str + - arg_type: str name: posportID1_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID2_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID3_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID4_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID5_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID6_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID7_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID8_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID1_compass description: Optional. Defaults to E. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen for posport ID1. default: E - - type: str + - arg_type: str name: posportID2_compass description: Optional. Defaults to NE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID2. default: NE - - type: str + - arg_type: str name: posportID3_compass description: Optional. Defaults to N. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID3. default: N - - type: str + - arg_type: str name: posportID4_compass description: Optional. Defaults to NW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID4. default: NW - - type: str + - arg_type: str name: posportID5_compass description: Optional. Defaults to W. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID5. default: W - - type: str + - arg_type: str name: posportID6_compass description: Optional. Defaults to SW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID6. default: SW - - type: str + - arg_type: str name: posportID7_compass description: Optional. Defaults to S. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID7. default: S - - type: str + - arg_type: str name: posportID8_compass description: Optional. Defaults to SE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID8. default: SE - - type: str + - arg_type: str name: ctrlprefix description: Optional. Defaults to :CTRL Prefix for SM control records. default: :CTRL - - type: str + - arg_type: str name: paramprefix description: Optional. Defaults to :PARAM Prefix for SM parameter records. default: :PARAM - - type: int + - arg_type: int name: paramprec description: Optional. Defaults to 0. Precision of the parameter value. default: 0 - - type: str + - arg_type: str name: staprefix description: Optional. Defaults to :STA Prefix for SM status records for screens. Must match SM status template. default: :STA - - type: str + - arg_type: str name: posportprefix description: Optional. Defaults to :POSPORT Prefix for SM port status records for screens. Must match definitions for SM port status template. default: :POSPORT - - type: str + - arg_type: str name: sourceparam_shortdesc description: Optional. Defaults to Source. Short description or name of the Source parameter. default: Source - - type: str + - arg_type: str name: targetparam_shortdesc description: Optional. Defaults to Target. Short description or name of the Target parameter. default: Target - - type: str + - arg_type: str name: sourceparam_longdesc description: Optional. Defaults to $(sourceparam_shortdesc=Source) chamber to move from. Long description of the Source Parameter. default: $(sourceparam_shortdesc=Source) chamber to move from. - - type: str + - arg_type: str name: targetparam_longdesc description: Optional. Defaults to $(targetparam_shortdesc=Target) chamber to move to. Long description of the Target Parameter. default: ' $(targetparam_shortdesc=Target) chamber to move to.' - - type: int + - arg_type: int name: sourceparam_init description: Optional. Defaults to 0 (Arm). Initial value of the user demand for the Source parameter. Helps the display on reboot in the absence of autosave. default: 0 - - type: int + - arg_type: int name: targetparam_init description: Optional. Defaults to 1. Initial value of the user demand for the Target parameter. Helps the display on reboot in the absence of autosave. The @@ -4584,278 +4584,278 @@ defs: value of 1 is arbitrary. Recommend set this to the ID of one of the ports which is present in the manipulator configuration. default: 1 - - type: int + - arg_type: int name: trigger_onval description: Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - type: int + - arg_type: int name: trigger_offval description: Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - type: str + - arg_type: str name: trigger_ONAM description: Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - type: str + - arg_type: str name: trigger_ZNAM description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - type: float + - arg_type: float name: trigger_pulseDLY description: Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - type: int + - arg_type: int name: ackprepare_bitno description: Optional. Defaults to 0. Number (0 to 15) of the bit in the status word which acknowledges response to the prepare transfer command. default: 0 - - type: int + - arg_type: int name: acktransfer_bitno description: Optional. Defaults to 1. Number (0 to 15) of the bit in the status word which acknowledges response to the transfer command. default: 1 - - type: int + - arg_type: int name: ackabort_bitno description: Optional. Defaults to 2. Number (0 to 15) of the bit in the status word which acknowledges response to the abort transfer command. default: 2 - - type: int + - arg_type: int name: ackclear_bitno description: Optional. Defaults to 3. Number (0 to 15) of the bit in the status word which acknowledges response to the clear error command. default: 3 - - type: str + - arg_type: str name: ackprepare_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the prepare transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: acktransfer_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackabort_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the abort transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackclear_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the clear error command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackprepare_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of prepare for transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: acktransfer_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackabort_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of abort transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackclear_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of clear error command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackprepare_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of prepare for transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: acktransfer_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: ackabort_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of abort transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: ackclear_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of clear error command acknowledgement. default: Request - - type: str + - arg_type: str name: acksource_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of source parameter acknowledgement. default: No Trigger - - type: str + - arg_type: str name: acktarget_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of target parameter acknowledgement. default: No Trigger - - type: str + - arg_type: str name: acksource_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of source parameter acknowledgement. default: Trigger - - type: str + - arg_type: str name: acktarget_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of target parameter acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackmotorcurrenton_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current on command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackmotorcurrentoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current off command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackmotorcurrenton_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current on command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackmotorcurrentoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current off command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackcompressedairon_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air on command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackcompressedairoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air off command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackcompressedairon_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air on command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackcompressedairoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air off command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackholderonarmon_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to True. default: No Trigger - - type: str + - arg_type: str name: ackholderonarmoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to False. default: No Trigger - - type: str + - arg_type: str name: ackholderonarmon_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to True. default: Trigger - - type: str + - arg_type: str name: ackholderonarmoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to False. default: Trigger - - type: str + - arg_type: str name: ingprepare_ZNAM description: Optional. Defaults to Not Preparing. Label for off state (ZNAM field) of in progress for prepare command. default: Not Preparing - - type: str + - arg_type: str name: ingprepare_ONAM description: Optional. Defaults to Preparing. Label for on state (ONAM field) of in progress for prepare command. default: Preparing - - type: str + - arg_type: str name: ingtransfer_ZNAM description: Optional. Defaults to Not Transferring. Label for off state (ZNAM field) of in progress for transfer command. default: Not Transferring - - type: str + - arg_type: str name: ingtransfer_ONAM description: Optional. Defaults to Transferring. Label for on state (ONAM field) of in progress for transfer command. default: Transferring - - type: str + - arg_type: str name: ingabort_ZNAM description: Optional. Defaults to Not Aborting. Label for off state (ZNAM field) of in progress for abort command. default: Not Aborting - - type: str + - arg_type: str name: ingabort_ONAM description: Optional. Defaults to Aborting. Label for on state (ONAM field) of in progress for abort command. default: Aborting - - type: str + - arg_type: str name: ingclear_ZNAM description: Optional. Defaults to Not Clearing. Label for off state (ZNAM field) of in progress for clear command. default: Not Clearing - - type: str + - arg_type: str name: ingclear_ONAM description: Optional. Defaults to Clearing. Label for on state (ONAM field) of in progress for clear command. default: Clearing - - type: int + - arg_type: int name: ingprepare_bitno description: Optional. Defaults to 11. Number (0 to 15) of the bit in the status word for the in progress status for the prepare command. default: 11 - - type: int + - arg_type: int name: ingtransfer_bitno description: Optional. Defaults to 10. Number (0 to 15) of the bit in the status word for the in progress status for the transfer command. default: 10 - - type: int + - arg_type: int name: ingabort_bitno1 description: Optional. Defaults to 1. Number (0 to 15) of the bit in the status word for the in progress status for the abort command. default: 1 - - type: int + - arg_type: int name: ingabort_bitno2 description: Optional. Defaults to 15. Number (0 to 15) of the bit in the status word for the aborted status for the abort command. default: 15 - - type: str + - arg_type: str name: ingprepare_status description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the prepare command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ingtransfer_status description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ingabort_status1 description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERERRORS2). Record for status word to link to extract in progress status for the abort command from. default: $(device)$(staprefix=:STA):TRANSFERERRORS2 - - type: str + - arg_type: str name: ingabort_status2 description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERSTATUS). Record for status word to link to extract aborted status for the abort command from. This @@ -4863,7 +4863,7 @@ defs: Modbus PLC failing to update some of its status including the aborting in progress bit which once set persists until the next command. default: $(device)$(staprefix=:STA):TRANSFERSTATUS - - type: id + - arg_type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -4979,314 +4979,314 @@ defs: - name: vacValve description: Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: 'device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address' - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: desc description: Box label for gui default: $(device) - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -5374,469 +5374,469 @@ defs: - name: NX102_sequence description: Template database for control and interlock of a non-specific device. args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Start command not allowed - - type: int + - arg_type: int name: stastrSCAN description: Scan rate for :STASTR PV string read in seconds, may be 10,5,2 or 1. Use to reduce network traffic if comms problems (Optional - defaults to 1) default: 1 - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Start) default: Start - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Abort) default: Abort - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Not running) default: Not running - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Running) default: Running - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Aborted) default: Aborted - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to MINOR) default: MINOR - - type: str + - arg_type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: p1_desc description: Label string for parameter 1 (Optional - defaults to "Param1") default: Param1 - - type: int + - arg_type: int name: p1_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p1_prec description: Precision of p1 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p1_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p1_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p1_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_desc description: Label string for parameter 2 (Optional - defaults to "Param2") default: Param2 - - type: int + - arg_type: int name: p2_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p2_prec description: Precision of p2 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p2_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p2_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p2_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_desc description: Label string for parameter 3 (Optional - defaults to "Param3") default: Param3 - - type: int + - arg_type: int name: p3_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p3_prec description: Precision of p3 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p3_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p3_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: p3_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - type: id + - arg_type: id name: name description: Object name and associated gui name (Optional - defaults to "") @@ -5960,34 +5960,34 @@ defs: description: Template database for status info regarding a Port on PreVac Sample Manipulator. args: - - type: str + - arg_type: str name: device description: Mandatory. Device name. - - type: str + - arg_type: str name: posportID description: Mandatory. ID of the vacuum port position for the sample manipulator. Must be integer 1 to 8 or 0 for special case of Arm in RDC/UFO and overall status. - - type: str + - arg_type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: tag description: Mandatory. NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: Mandatory. NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: str + - arg_type: str name: tagname description: Mandatory. NX PLC tag name. - - type: str + - arg_type: str name: tagprefix description: Mandatory. NX PLC prefix to tag name. - - type: str + - arg_type: str name: posportprefix description: Optional. Defaults to ":POSPORT". Prefix for the vacuum port position records. default: :POSPORT - - type: int + - arg_type: int name: smready_bitno description: 'Optional. Defaults to "1". Bit number in port position status for whether sample manipulator inside the chamber is in position @@ -5997,7 +5997,7 @@ defs: The intended use is for signals derived from GPIO on GeoBricks with other sample manipulator motors on them.' default: 1 - - type: int + - arg_type: int name: sampleholder_bitno description: 'Optional. Defaults to "2". Bit number in port position status for whether sample holder is present inside the chamber, values 0-15. The @@ -6005,122 +6005,122 @@ defs: the "Holder On Arm" bit, whereas the other ports address the "Sample Inside" bit. NOTE: The sample holder might not have a sample in it!' default: 2 - - type: str + - arg_type: str name: desc_label0 description: Optional. Defaults to "PrepareForTransfer". Descriptive label for bit0 of the Coil word. default: PrepareForTransfer - - type: str + - arg_type: str name: desc_label1 description: Optional. Defaults to "ReadyForTransfer". Descriptive label for bit1 of the Coil word. default: ReadyForTransfer - - type: str + - arg_type: str name: desc_label2 description: Optional. Defaults to "SampleInside". Descriptive label for bit2 of the Coil word. default: SampleInside - - type: str + - arg_type: str name: desc_label3 description: Optional. Defaults to "Error". Descriptive label for bit3 of the Coil word. default: Error - - type: str + - arg_type: str name: desc_label4 description: Optional. Defaults to "Busy". Descriptive label for bit4 of the Coil word. default: Busy - - type: str + - arg_type: str name: desc_label5 description: Optional. Defaults to "GateOpenRequest". Descriptive label for bit5 of the Coil word. default: GateOpenRequest - - type: str + - arg_type: str name: desc_label6 description: Optional. Defaults to "GateOpen". Descriptive label for bit6 of the Coil word. default: GateOpen - - type: str + - arg_type: str name: desc_label7 description: Optional. Defaults to "GateClosed". Descriptive label for bit7 of the Coil word. default: GateClosed - - type: str + - arg_type: str name: desc_label8 description: Optional. Defaults to "ArmOnPort". Descriptive label for bit8 of the Coil word. default: ArmOnPort - - type: str + - arg_type: str name: desc_label9 description: Optional. Defaults to "ReservedForFuture". Descriptive label for bit9 of the Coil word. default: ReservedForFuture - - type: str + - arg_type: str name: desc_label10 description: Optional. Defaults to "". Descriptive label for bit10 of the Coil word. default: '' - - type: str + - arg_type: str name: desc_label11 description: Optional. Defaults to "". Descriptive label for bit11 of the Coil word. default: '' - - type: str + - arg_type: str name: desc_label12 description: Optional. Defaults to "". Descriptive label for bit12 of the Coil word. default: '' - - type: str + - arg_type: str name: desc_label13 description: Optional. Defaults to "". Descriptive label for bit13 of the Coil word. default: '' - - type: str + - arg_type: str name: desc_label14 description: Optional. Defaults to "". Descriptive label for bit14 of the Coil word. default: '' - - type: str + - arg_type: str name: desc_label15 description: Optional. Defaults to "". Descriptive label for bit15 of the Coil word. default: '' - - type: str + - arg_type: str name: longdesc description: Optional. Defaults to "Manipulator Position Port $(posportID) status." Description of position port. default: Manipulator Position Port $(posportID) status. - - type: str + - arg_type: str name: shortdesc description: Optional. Defaults to "Posport$(posportID)" Short, abbreviated description of position port. default: Posport$(posportID) - - type: str + - arg_type: str name: chamber_name description: Optional. Defaults to "". Name of vacuum chamber associated with position port. default: '' - - type: str + - arg_type: str name: chamber_shortname description: Optional. Defaults to "". Short name of vacuum chamber associated with position port. default: '' - - type: str + - arg_type: str name: valve_device description: Optional. Defaults to "". Device name of vacuum valve associated with position port. So far it is a string for info only, no calcs. default: '' - - type: str + - arg_type: str name: valve_shortname description: Optional. Defaults to "". Short, abbreviated name of vacuum valve associated with the position port. default: '' - - type: str + - arg_type: str name: valve_desc description: Optional. Defaults to "". Description of vacuum valve associated with position port. default: '' - - type: id + - arg_type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -6164,28 +6164,28 @@ defs: - name: NX102_readReal description: TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: Template argument - - type: str + - arg_type: str name: port description: Template argument - - type: str + - arg_type: str name: tag description: Template argument - - type: str + - arg_type: str name: desc description: Template argument default: '' - - type: str + - arg_type: str name: scan description: Template argument default: 1 second - - type: str + - arg_type: str name: egu description: Template argument default: '' - - type: int + - arg_type: int name: prec description: Template argument default: 2 @@ -6202,206 +6202,206 @@ defs: - name: NX102_genericDevice description: Template database for control and interlock of a non-specific device. args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Off - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: '' - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Off - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: '' - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - type: id + - arg_type: id name: name description: Object name and associated gui name (Optional - defaults to "") @@ -6461,20 +6461,20 @@ defs: description: Power cycle an RGA where the PLC code has been setup to power cycle when 1 is written to a particular DM variable args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: addr description: DM variable to write to to reboot rga - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: id + - arg_type: id name: name description: Object name and associated gui name databases: @@ -6489,51 +6489,51 @@ defs: description: Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: variable description: PV suffix (its associated _RBV will be autogenerated). - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: tag name of ether_ip read value - - type: str + - arg_type: str name: tagwrite description: tag name of ether_ip write value - - type: str + - arg_type: str name: drvl description: Lowest accepted value - - type: str + - arg_type: str name: drvh description: Highest accepted value - - type: int + - arg_type: int name: tagidx description: Template argument - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: desc description: Description default: '' - - type: str + - arg_type: str name: readscan description: value update time for readback value default: 1 second - - type: float + - arg_type: float name: writescan description: value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - type: str + - arg_type: str name: egu description: Engineering units default: '' - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 2 @@ -6557,227 +6557,227 @@ defs: - name: NX102_vacValveDebounce description: Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: EtherIP Port Name - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - type: id + - arg_type: id name: name description: Object name and associated gui name (Optional - defaults to "") - - type: str + - arg_type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) @@ -6845,260 +6845,260 @@ defs: of the pump which might be available and also be required typically via serial control, for example settings configuration or service period information.' args: - - type: str + - arg_type: str name: device description: Mandatory. Device name of the pump. - - type: str + - arg_type: str name: port description: Mandatory. Name of port for the ether_ip driver for the PLC controlling/interlocking the pump. - - type: str + - arg_type: str name: tag description: Mandatory. NX PLC tag string e.g. S for Scroll or T for Turbo. - - type: int + - arg_type: int name: tagidx description: Mandatory. NX PLC tag index number. Typically this is the same as the id number in the device name, but - - type: str + - arg_type: str name: allowpv description: Optional. Defaults to "". If specified, then only write an "open" i.e. on command when this is non-zero. MUST have CP at the end of it. The term "open" here and in PV names is because of heritage from valve control. Generally by default the "open" command for a pump actually signifies turn it on. default: '' - - type: str + - arg_type: str name: whylocked description: Optional. Defaults to "On command not allowed". String to output to EDM synoptic as to precisely why the device is locked and by whom. default: On command not allowed - - type: str + - arg_type: str name: con_label0 description: Optional. Defaults to On. Label string for control value 0 default: On - - type: str + - arg_type: str name: con_label1 description: Optional. Defaults to Off. Label string for control value 1 default: Off - - type: str + - arg_type: str name: con_label2 description: Optional. Defaults to Reset. Label string for control value 2 default: Reset - - type: str + - arg_type: str name: con_label3 description: Optional. Defaults to Standby. Label string for control value 3 default: '' - - type: str + - arg_type: str name: con_label4 description: Optional. Defaults to FullSpeed. Label string for control value 4 default: '' - - type: str + - arg_type: str name: con_label5 description: Optional. Defaults to "". Label string for control value 5 default: '' - - type: str + - arg_type: str name: con_label6 description: Optional. Defaults to "". Label string for control value 6 default: '' - - type: str + - arg_type: str name: con_label7 description: Optional. Defaults to "". Label string for control value 7 default: '' - - type: str + - arg_type: str name: sta_label0 description: Optional. Defaults to Fault. Label string for status value 0 default: Fault - - type: str + - arg_type: str name: sta_label1 description: Optional. Defaults to On. Label string for status value 1 default: On - - type: str + - arg_type: str name: sta_label2 description: Optional. Defaults to Standby. Label string for status value 2 default: Standby - - type: str + - arg_type: str name: sta_label3 description: Optional. Defaults to Off. Label string for status value 3 default: Off - - type: str + - arg_type: str name: sta_label4 description: Optional. Defaults to "". Label string for status value 4 default: FullSpeed - - type: str + - arg_type: str name: sta_label5 description: Optional. Defaults to "". Label string for status value 5 default: '' - - type: str + - arg_type: str name: sta_label6 description: Optional. Defaults to "". Label string for status value 6 default: '' - - type: str + - arg_type: str name: sta_label7 description: Optional. Defaults to "". Label string for status value 7 default: '' - - type: str + - arg_type: str name: sta_sv0 description: "Optional. Defaults to MAJOR. \t Alarm severity for status value 0." default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 1." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 2." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 3." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 4." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 5." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 6." default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 7." default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Optional. Defaults to Failed. Label string for status value 0 default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Optional. Defaults to Run Ilks OK. Label string for status value 1 default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Optional. Defaults to OK. Label string for status value 2 default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Optional. Defaults to "". Label string for status value 3 default: '' - - type: str + - arg_type: str name: ilksta_label4 description: Optional. Defaults to "". Label string for status value 4 default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Optional. Defaults to "". Label string for status value 5 default: '' - - type: str + - arg_type: str name: ilksta_label6 description: Optional. Defaults to "". Label string for status value 6 default: '' - - type: str + - arg_type: str name: ilksta_label7 description: Optional. Defaults to "". Label string for status value 7 default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - type: str + - arg_type: str name: mode2 description: Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - type: str + - arg_type: str name: short_desc description: Optional. Defaults to Shorting Plug. Description field on the PLUG record DESC field for whether a shorting plug is present. default: Shorting Plug - - type: str + - arg_type: str name: short_label0 description: Optional. Defaults to Dummy. Label on the PLUG record ZNAM field for no shorting plug present. default: Dummy - - type: str + - arg_type: str name: short_label1 description: Optional. Defaults to Real. Label on the PLUG record ONAM field for shorting plug present. default: Real - - type: str + - arg_type: str name: short_sv0 description: Optional. Defaults to NO_ALARM. Severity on the PLUG record ZSV field for the status value 0. default: NO_ALARM - - type: str + - arg_type: str name: short_sv1 description: Optional. Defaults to NO_ALARM. Severity on the PLUG record OSV field for the status value 1. default: NO_ALARM - - type: id + - arg_type: id name: name description: Optional. Defaults to "". Object name and associated gui name. @@ -7162,20 +7162,20 @@ defs: - name: NX102_powerSupply description: Template showing the status of the power supply from the ether IP readings args: - - type: str + - arg_type: str name: device description: device prefix - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from PSU.Voltage[1]) - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. PSU (from PSU.Voltage[1]) default: PSU - - type: id + - arg_type: id name: name description: Object name and associated gui name databases: @@ -7190,89 +7190,89 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: temp description: PV suffix - - type: str + - arg_type: str name: desc description: Description - - type: str + - arg_type: str name: tmpcc description: Parent temperature control crate prefix - - type: str + - arg_type: str name: offset description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - type: str + - arg_type: str name: lolo description: Lolo alarm limit - - type: str + - arg_type: str name: low description: Low alarm limit - - type: str + - arg_type: str name: high description: High alarm limit - - type: str + - arg_type: str name: hihi description: Hihi alarm limit - - type: str + - arg_type: str name: hopr description: High operating range - - type: str + - arg_type: str name: lopr description: Low operating range - - type: str + - arg_type: str name: llsv description: Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: scale factor for temperature/setpoint default: 10 - - type: int + - arg_type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: Object and gui association name - - type: str + - arg_type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: int + - arg_type: int name: incentury description: The Century digit(s) for the PLC D address to read temperature values default: 2 - - type: int + - arg_type: int name: outcentury description: The Century digit(s) for the PLC D address to write setpoints default: 1 - - type: str + - arg_type: str name: egu description: This associates an edm screen with the template default: C @@ -7309,28 +7309,28 @@ defs: description: "Template showing the status of various MPS interlocks in\nan Omron NX102 PLC." args: - - type: str + - arg_type: str name: device description: device prefix - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: interlock description: Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. ILK (from ILK.Control[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from ILK.Control[1]) - - type: str + - arg_type: str name: desc description: Permit description (e.g. Front end permit) - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: int + - arg_type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -7349,19 +7349,19 @@ defs: - name: NX102_digitalIn_Debounced description: TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: Template argument - - type: str + - arg_type: str name: port description: Template argument - - type: int + - arg_type: int name: tagidx description: Template argument - - type: id + - arg_type: id name: name description: Template argument - - type: str + - arg_type: str name: tag description: Template argument default: Digital_In @@ -7377,14 +7377,14 @@ defs: description: Template for Warning GUI banner for stale data from the PreVac Sample Manipulator controller. args: - - type: str + - arg_type: str name: device description: Mandatory. Device name of sample manipulator. - - type: str + - arg_type: str name: staprefix description: Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - type: id + - arg_type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -7398,34 +7398,34 @@ defs: description: Template database for reading a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: variable description: PV suffix for this robot variable - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: tag name of ether_ip read value - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: desc description: Description default: '' - - type: str + - arg_type: str name: scan description: value update time default: 1 second - - type: str + - arg_type: str name: egu description: Engineering units default: '' - - type: int + - arg_type: int name: prec description: This associates an edm screen with the template default: 2 @@ -7444,102 +7444,102 @@ defs: - name: interlockSummary description: Template database for a summary PV of up to 24 interlocks args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: ilk1 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk2 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk3 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk4 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk5 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk6 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk7 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk8 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk9 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk10 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk11 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk12 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk13 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk14 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk15 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk16 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk17 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk18 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk19 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk20 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk21 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk22 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk23 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk24 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK @@ -7575,127 +7575,127 @@ defs: description: Template database for status info on PreVac Sample Manipulator (in addition to that for individual SM Ports). args: - - type: str + - arg_type: str name: device description: Mandatory. Device name. - - type: str + - arg_type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: staprefix description: Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - type: str + - arg_type: str name: posportprefix description: Optional. Defaults to :POSPORT Prefix for records for individual ports. Must match port template. default: :POSPORT - - type: str + - arg_type: str name: posportID0_shortdesc description: Optional. Defaults to Arm. Short description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to make things sensible. Leave the ones not present (i.e. no chamber connected as empty string.) default: Arm - - type: str + - arg_type: str name: posportID1_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 1, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID2_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 2, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID3_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 3, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID4_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 4, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID5_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 5, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID6_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 6, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID7_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 7, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID8_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 8, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - type: str + - arg_type: str name: posportID0_sourceSV description: Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - type: str + - arg_type: str name: posportID0_targetSV description: Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - type: str + - arg_type: str name: posportID1_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID2_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID3_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID4_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID5_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID6_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID7_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID8_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - type: id + - arg_type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -7730,94 +7730,94 @@ defs: description: "Template showing the status of various MPS interlocks in\na PLC. Requires dlsPLC_read100 for any century used" args: - - type: str + - arg_type: str name: device description: device prefix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: interlock description: Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: desc description: Permit description (e.g. Front end permit) - - type: str + - arg_type: str name: addr description: First address in the DM variable range. E.g. if interlock is in DM800..808 then addr=800 - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: int + - arg_type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -7852,16 +7852,16 @@ defs: - name: fastVacuumChannel description: TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: Gui tag - - type: object + - arg_type: object name: master description: Master - - type: str + - arg_type: str name: img description: Base IMG PV - - type: enum + - arg_type: enum name: id description: FV PLC gauge number values: @@ -7875,7 +7875,7 @@ defs: '07': '06': '01': - - type: enum + - arg_type: enum name: em description: EM block to use default: 0 @@ -7883,7 +7883,7 @@ defs: '"0"': '"1"': '"2"': - - type: int + - arg_type: int name: timeout description: asyn fins_port timeout default: 0 @@ -7909,34 +7909,34 @@ defs: - name: vacValveDebounce description: Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: vlvcc description: device name of valve control crate - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - type: enum + - arg_type: enum name: valvetype description: Type of Device default: valve @@ -7944,285 +7944,285 @@ defs: '"valve"': '"absorber"': '"shutter"': - - type: str + - arg_type: str name: ilk0 description: Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: Object name and associated gui name - - type: str + - arg_type: str name: desc description: Box label for gui default: $(device) - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - type: str + - arg_type: str name: ilksta_label0 description: Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_label5 description: Template argument default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -8236,7 +8236,7 @@ defs: ilk10: ilk11: ilk12: - valvetype: + valvearg_type: gda_name: allowpv: ilk8: @@ -8311,22 +8311,22 @@ defs: - name: readInt16 description: Read the Int16 value stored in 1 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: vlvcc description: PLC control crate device prefix - - type: str + - arg_type: str name: addr description: DM variable of the int - - type: id + - arg_type: id name: name description: Object name and gui association name - - type: str + - arg_type: str name: ftvl description: Type of data in subArray default: USHORT @@ -8342,23 +8342,23 @@ defs: - name: writeInt16 description: Write an int32 value into a PLC DM variable args: - - type: str + - arg_type: str name: P description: device prefix - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: port description: asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: Object name and gui association name databases: @@ -8375,48 +8375,48 @@ defs: read back by valve controller PLC so their state is known, but control is not available. args: - - type: str + - arg_type: str name: device description: device name of the valve. - - type: str + - arg_type: str name: vlvcc description: device name of valve control crate - - type: str + - arg_type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Partial) default: Partial - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: id + - arg_type: id name: name description: This associates an edm screen with the template - - type: str + - arg_type: str name: valvetype description: Template argument default: manualValve @@ -8425,7 +8425,7 @@ defs: args: vlvcc: addr: - valvetype: + valvearg_type: sta_label5: sta_label4: sta_label6: @@ -8438,61 +8438,61 @@ defs: - name: NX102_PreVacCoils_SMLVDT description: Template database for an LVDT on PreVac Sample Manipulator. args: - - type: str + - arg_type: str name: device description: Mandatory. Device name. - - type: str + - arg_type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: lvdtID description: Mandatory. ID of the LVDT. Defacto it is a number but it need not be. - - type: str + - arg_type: str name: tag description: Mandatory. NX PLC tag string. - - type: str + - arg_type: str name: lvdtprefix description: Optional. Defaults to ":LVDT". Prefix for SM LVDT records. default: :LVDT - - type: str + - arg_type: str name: lvdt_shortname description: Optional. Defaults to "LVDT{{lvdtID}}". Short name of the LVDT. default: LVDT{{lvdtID}} - - type: str + - arg_type: str name: lvdt_shortdesc description: Optional. Defaults to "LVDT {{lvdtID}}". Short description of the LVDT. default: LVDT {{lvdtID}} - - type: str + - arg_type: str name: lvdt_longdesc description: Optional. Defaults to "Manipulator LVDT {{lvdtID}}". Longer description of the LVDT. default: Manipulator LVDT {{lvdtID}} - - type: str + - arg_type: str name: tagidx description: Optional. Defaults to "{{lvdtID}}". NX PLC tag string array index. default: '{{lvdtID}}' - - type: str + - arg_type: str name: pos_SCAN description: 'Optional. Defaults to ".5 second". EPICS .SCAN field. Scan rate for reading encoder. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here.' default: .5 second - - type: int + - arg_type: int name: pos_PREC description: Optional. Defaults to 3. Precision on the encoder position value. default: 3 - - type: str + - arg_type: str name: pos_EGU description: Optional. Defaults to empty string. Engineering units on the encoder value. default: '' - - type: str + - arg_type: str name: pos_LINR description: Optional. Defaults to empty string. Values can be "NO CONVERSION", "SLOPE" (must define pos_ESLO and and pos_EOFF), "LINEAR" (must define pos_EGUL @@ -8500,186 +8500,186 @@ defs: method for encoder value. See EPICS record reference manual sections on the ai record and the convert menu and conversion. default: '' - - type: str + - arg_type: str name: pos_EGUL description: Optional. Defaults to empty string. Low end of LINEAR conversion scale for encoder value. default: '' - - type: str + - arg_type: str name: pos_EGUF description: Optional. Defaults to empty string. High end or full value on LINEAR conversion scale for encoder value. default: '' - - type: str + - arg_type: str name: pos_EOFF description: Optional. Defaults to empty string. The offset on the value for SLOPE conversion. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_ESLO description: Optional. Defaults to empty string. The slope on the value for SLOPE conversion. It will default to 1. default: '' - - type: str + - arg_type: str name: pos_AOFF description: Optional. Defaults to empty string. The raw adjustment offset on the value for conversion for all types of conversion. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_ASLO description: Optional. Defaults to empty string. The raw adjustment slope on the value for conversion for all types of conversion. It will default to 1. default: '' - - type: str + - arg_type: str name: pos_SMOO description: Optional. Defaults to empty string. The smoothing fraction parameter on the smoothing algorithm, value between 0 (no smoothing) and 1 (value never changes), it will default to 0. default: '' - - type: str + - arg_type: str name: pos_HOPR description: Optional. Defaults to empty string. The position high operator display value. Will default to 0. default: '' - - type: str + - arg_type: str name: pos_LOPR description: Optional. Defaults to empty string. The position low operator display value. Will default to 0. default: '' - - type: str + - arg_type: str name: pos_HIHI description: Optional. Defaults to empty string. The position high high limit. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_HIGH description: Optional. Defaults to empty string. The position high limit. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_LOW description: Optional. Defaults to empty string. The position low limit. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_LOLO description: Optional. Defaults to empty string. The position low low limit. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_HHSV description: Optional. Defaults to empty string. The alarm severity for the HIHI alarm. It will default to NO_ALARM. default: '' - - type: str + - arg_type: str name: pos_HSV description: Optional. Defaults to empty string. The alarm severity for the HIGH alarm. It will default to NO_ALARM. default: '' - - type: str + - arg_type: str name: pos_LSV description: Optional. Defaults to empty string. The alarm severity for the LOW alarm. It will default to NO_ALARM. default: '' - - type: str + - arg_type: str name: pos_LLSV description: Optional. Defaults to empty string. The alarm severity for the LOLO alarm. It will default to NO_ALARM. default: '' - - type: str + - arg_type: str name: pos_HYST description: Optional. Defaults to empty string. The alarm deadband or hysteresis for the scaled position. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_ADEL description: Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the scaled position. It will default to 0. default: '' - - type: str + - arg_type: str name: pos_MDEL description: Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the scaled position. It will default to 0. default: '' - - type: str + - arg_type: str name: raw_EGU description: Optional. Defaults to count. Engineering units on the encoder raw value. default: count - - type: str + - arg_type: str name: raw_HYST description: Optional. Defaults to empty string. The alarm deadband or hysteresis for the raw position. It will default to 0. default: '' - - type: str + - arg_type: str name: raw_ADEL description: Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the raw position. It will default to 0. default: '' - - type: str + - arg_type: str name: raw_MDEL description: Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the raw position. It will default to 0. default: '' - - type: int + - arg_type: int name: slope_PREC description: Optional. Defaults to 6. Precision on the derived encoder slope value. default: 6 - - type: str + - arg_type: str name: cal_SCAN description: 'Optional. Defaults to "1 second". EPICS .SCAN field. Scan rate for reading calibration parameters. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here.' default: 1 second - - type: float + - arg_type: float name: calout_scanrate description: Optional. Defaults to .5 The value of scanrate which when writing to NX PLC the calibration output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - type: float + - arg_type: float name: trigger_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - type: int + - arg_type: int name: trigger_onval description: Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - type: int + - arg_type: int name: trigger_offval description: Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - type: str + - arg_type: str name: trigger_ONAM description: Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - type: str + - arg_type: str name: trigger_ZNAM description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - type: float + - arg_type: float name: trigger_pulsestartDLY description: Optional. Defaults to 1.0. Delay in seconds between last calibration parameter write and pulsing the trigger. default: 1.0 - - type: float + - arg_type: float name: trigger_pulsewidthDLY description: Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - type: id + - arg_type: id name: name description: Optional. Defaults to empty. Object name and associated gui name. @@ -8737,20 +8737,20 @@ defs: - name: overrideRequestMain description: Template allowing overrideRequestIndividual instances to be created args: - - type: str + - arg_type: str name: P description: device prefix. This must match a dlsPLC_read100.template device macro - - type: str + - arg_type: str name: Q description: device suffix - - type: str + - arg_type: str name: outaddr description: Output address. Input address is $(outaddr)+1. E.g. if outaddr=80, read DM81 and write DM80. - - type: str + - arg_type: str name: port description: Asyn port for doing serial comms - - type: int + - arg_type: int name: timeout description: Template argument default: 0 @@ -8766,86 +8766,86 @@ defs: description: "Template database for an individual temperature on a front end\ntemperature PLC." args: - - type: str + - arg_type: str name: device description: PV prefix - - type: str + - arg_type: str name: temp description: PV suffix - - type: str + - arg_type: str name: port description: port name of ether_ip driver - - type: int + - arg_type: int name: tagidx description: temperature index on PLC - - type: str + - arg_type: str name: lolo description: Lolo alarm limit - - type: str + - arg_type: str name: low description: Low alarm limit - - type: str + - arg_type: str name: high description: High alarm limit - - type: str + - arg_type: str name: hihi description: Hihi alarm limit - - type: str + - arg_type: str name: hopr description: High operating range - - type: str + - arg_type: str name: lopr description: Low operating range - - type: str + - arg_type: str name: tag description: etherip tag default: Temp - - type: str + - arg_type: str name: llsv description: Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - type: int + - arg_type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: Object and gui association name - - type: str + - arg_type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: str + - arg_type: str name: egu description: This associates an edm screen with the template default: C - - type: str + - arg_type: str name: desc description: Description databases: @@ -8877,19 +8877,19 @@ defs: - name: NX102_digitalIn description: TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: Template argument - - type: str + - arg_type: str name: port description: Template argument - - type: int + - arg_type: int name: tagidx description: Template argument - - type: id + - arg_type: id name: name description: Template argument - - type: str + - arg_type: str name: tag description: Template argument default: Digital_In @@ -8905,243 +8905,243 @@ defs: description: Template database for a bistable vacuum valve without debounce or raw air records. It has different interlocks for opening and closing it. args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: EtherIP Port Name - - type: str + - arg_type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: Part of Gauge PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to Close Enable) default: Close Enable - - type: str + - arg_type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Open Disabled) default: Open Disabled - - type: str + - arg_type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to Closed, Open Available) default: Closed, Open Available - - type: str + - arg_type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to Close Disabled) default: Close Disabled - - type: str + - arg_type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to Open, Close Available) default: Open, Close Available - - type: str + - arg_type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - type: str + - arg_type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults to Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve (Optional - defaults to OPEN) default: OPEN - - type: str + - arg_type: str name: DIRILK1_label description: Label string for the interlock 1 "direction". (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to CLOSE) default: CLOSE - - type: str + - arg_type: str name: DIRILK2_label description: Label string for the interlock 2 "direction". (Optional - defaults to Close) default: Close - - type: id + - arg_type: id name: name description: "Object name and associated gui name \t (Optional - defaults to \"\")" - - type: str + - arg_type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) default: $(device) - - type: str + - arg_type: str name: valvetype description: Type of valve for the gui. (Optional - defaults to valve). default: valve @@ -9195,7 +9195,7 @@ defs: sta_sv4: sta_sv7: sta_sv6: - valvetype: + valvearg_type: sta_label6: DIRILK2_label: device: @@ -9207,59 +9207,59 @@ defs: - name: NX102_flowMeter description: Template database for a machine flow meter args: - - type: str + - arg_type: str name: device description: device name - - type: str + - arg_type: str name: port description: asyn port name of etherip driver - - type: int + - arg_type: int name: tagidx description: etherip tag index - - type: str + - arg_type: str name: desc description: Template argument - - type: str + - arg_type: str name: tag description: etherip tag default: FlowRate - - type: str + - arg_type: str name: egu description: EGU default: Litres / Hour - - type: int + - arg_type: int name: prec description: PREC default: 1 - - type: int + - arg_type: int name: hopr description: HOPR default: 300 - - type: float + - arg_type: float name: lopr description: LOPR default: 0.0 - - type: int + - arg_type: int name: hihi description: HIHI default: 295 - - type: int + - arg_type: int name: lolo description: LOLO default: 100 - - type: int + - arg_type: int name: high description: HIGH default: 275 - - type: int + - arg_type: int name: adel description: ADEL default: 50 - - type: int + - arg_type: int name: mdel description: MDEL default: 10 - - type: int + - arg_type: int name: low description: LOW default: 120 diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index e758e8ec7..c96c93515 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -4,10 +4,10 @@ "additionalProperties": false, "description": "An argument with an bool value", "properties": { - "type": { + "arg_type": { "const": "bool", "default": "bool", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -43,10 +43,10 @@ "additionalProperties": false, "description": "A script snippet that will have '# ' prepended to every line\nfor insertion into the startup script", "properties": { - "type": { + "arg_type": { "const": "comment", "default": "comment", - "title": "Type" + "title": "Arg Type" }, "when": { "allOf": [ @@ -123,7 +123,21 @@ "default": [], "description": "The arguments IOC instance should supply", "items": { - "anyOf": [ + "description": "union of arg types", + "discriminator": { + "mapping": { + "bool": "#/$defs/BoolArg", + "enum": "#/$defs/EnumArg", + "float": "#/$defs/FloatArg", + "id": "#/$defs/IdArg", + "int": "#/$defs/IntArg", + "list": "#/$defs/ListArg", + "object": "#/$defs/ObjectArg", + "str": "#/$defs/StrArg" + }, + "propertyName": "arg_type" + }, + "oneOf": [ { "$ref": "#/$defs/ListArg" }, @@ -311,10 +325,10 @@ "additionalProperties": false, "description": "An argument with an enum value", "properties": { - "type": { + "arg_type": { "const": "enum", "default": "enum", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -376,10 +390,10 @@ "additionalProperties": false, "description": "An argument with a float value", "properties": { - "type": { + "arg_type": { "const": "float", "default": "float", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -415,10 +429,10 @@ "additionalProperties": false, "description": "Explicit ID argument that an object can refer to", "properties": { - "type": { + "arg_type": { "const": "id", "default": "id", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -454,10 +468,10 @@ "additionalProperties": false, "description": "An argument with an int value", "properties": { - "type": { + "arg_type": { "const": "int", "default": "int", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -493,10 +507,10 @@ "additionalProperties": false, "description": "An argument with a float value", "properties": { - "type": { + "arg_type": { "const": "list", "default": "list", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -533,10 +547,10 @@ "additionalProperties": false, "description": "A reference to another entity defined in this IOC", "properties": { - "type": { + "arg_type": { "const": "object", "default": "object", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -572,10 +586,10 @@ "additionalProperties": false, "description": "An argument with a str value", "properties": { - "type": { + "arg_type": { "const": "str", "default": "str", - "title": "Type" + "title": "Arg Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -633,10 +647,10 @@ "additionalProperties": false, "description": "A script snippet to insert into the startup script", "properties": { - "type": { + "arg_type": { "const": "text", "default": "text", - "title": "Type" + "title": "Arg Type" }, "when": { "default": "every", diff --git a/tests/samples/support/ADCore.ibek.support.yaml b/tests/samples/support/ADCore.ibek.support.yaml index 82a0baf71..e03983af6 100644 --- a/tests/samples/support/ADCore.ibek.support.yaml +++ b/tests/samples/support/ADCore.ibek.support.yaml @@ -7,51 +7,51 @@ defs: description: |- This plugin can compress NDArrays to Nexus and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileNexus plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -68,13 +68,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -102,56 +102,56 @@ defs: description: |- This plugin is used to calculate the FFT of a time series args: - - type: str + - arg_type: str name: P description: |- Device prefix - - type: str + - arg_type: str name: R description: |- Device suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFFT plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: str + - arg_type: str name: NCHANS description: |- Length of time series waveform - - type: int + - arg_type: int name: TIMEOUT description: |- Asyn port timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -168,43 +168,43 @@ defs: Event: I/O Intr: - - type: float + - arg_type: float name: TIME_LINK description: |- Time in seconds between points (Can point to a record - use CP) default: 0.1 - - type: int + - arg_type: int name: NAME description: |- Label for signal default: 0 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: PRIORITY description: |- Thread priority if ASYN_CANBLOCK is set default: 0 - - type: int + - arg_type: int name: STACKSIZE description: |- Stack size if ASYN_CANBLOCK is set default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -235,51 +235,51 @@ defs: description: |- This plugin attaches position information to NDArrays args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDPosPlugin plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -296,25 +296,25 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: PRIORITY description: |- Max buffers to allocate default: 0 - - type: int + - arg_type: int name: STACKSIZE description: |- Max buffers to allocate @@ -342,51 +342,51 @@ defs: description: |- This plugin writes overlays on the array, like cursors and boxes args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDOverlay plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -403,75 +403,75 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads default: 1 - - type: str + - arg_type: str name: O description: |- NDOverlay Device Suffix - - type: str + - arg_type: str name: NAME description: |- Name for the overlay - - type: str + - arg_type: str name: SHAPE description: |- Shape of the overlay - - type: str + - arg_type: str name: XPOS description: |- Link for the XPos of the overlay - - type: str + - arg_type: str name: YPOS description: |- Link for the YPos of the overlay - - type: str + - arg_type: str name: XCENT description: |- Link for the XCent of the overlay - - type: str + - arg_type: str name: YCENT description: |- Link for the YCent of the overlay - - type: str + - arg_type: str name: XSIZE description: |- Link for the XSize of the overlay - - type: str + - arg_type: str name: YSIZE description: |- Link for the YSize of the overlay - - type: str + - arg_type: str name: XWIDTH description: |- Link for the XWidth of the overlay - - type: str + - arg_type: str name: YWIDTH description: |- Link for the YWdith of the overlay @@ -517,51 +517,51 @@ defs: description: |- This plugin converts arrays from one colour type to another, e.g. Bayer -> RGB1 args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDColorConvert plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -578,19 +578,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -618,51 +618,51 @@ defs: description: |- This plugin can compress NDArrays to HDF5 and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileHDF5 plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Asyn Port timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -679,19 +679,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: XMLSIZE description: |- Number of elements of the XML layout waveform record default: 2048 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -728,39 +728,39 @@ defs: description: |- Null file plugin for deleting driver files args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileHDF5 plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -777,25 +777,25 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -824,32 +824,32 @@ defs: This plugin provides a waveform record that can display the NDArrays produced by its NDARRAY_PORT args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDStdArrays plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: str + - arg_type: str name: TYPE description: |- Asyn Type e.g. Int32 - - type: enum + - arg_type: enum name: FTVL description: |- Field Type of Value @@ -865,36 +865,36 @@ defs: FLOAT: CHAR: - - type: int + - arg_type: int name: NELEMENTS description: |- Number of elements - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -911,19 +911,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -957,51 +957,51 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: str + - arg_type: str name: PORT description: |- Asyn Port name - - type: str + - arg_type: str name: NDARRAY_PORT description: |- Input Array Port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1018,13 +1018,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: PRECOUNT description: |- Pre-trigger frame count default: 100 - - type: int + - arg_type: int name: POSTCOUNT description: |- Post-trigger frame count @@ -1050,51 +1050,51 @@ defs: This plugin can compress NDArrays to a range of formats supported by graphics magick and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileMagick plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1111,13 +1111,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -1145,51 +1145,51 @@ defs: description: |- This plugin provides a pre and post external trigger frame capture buffer args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the FFT_calc plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 1 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1206,31 +1206,31 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: PRECOUNT description: |- Pre-trigger frame count default: 100 - - type: int + - arg_type: int name: POSTCOUNT description: |- Post-trigger frame count default: 100 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 50 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_BUFFERS description: |- Max buffer size in number of frames @@ -1260,51 +1260,51 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: P description: |- Device prefix - - type: str + - arg_type: str name: R description: |- Device suffix - - type: id + - arg_type: id name: PORT description: |- Asyn port name - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Asyn port of the callback source - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Asyn address of the callback source default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1321,40 +1321,40 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 10000 - - type: int + - arg_type: int name: N_CACHE description: |- Number of NDArrays to store in cache default: 10000 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: str + - arg_type: str name: ATTR_IND description: |- Attribute index - - type: str + - arg_type: str name: AXIS description: |- Axis name - - type: str + - arg_type: str name: DATA_IND description: |- Data index - - type: str + - arg_type: str name: DATA_ADDR description: |- Asyn address for this data array @@ -1397,51 +1397,51 @@ defs: description: |- This plugin can compress or decompress NDArrays args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDCodec plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1458,19 +1458,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -1498,41 +1498,41 @@ defs: description: |- This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream args: - - type: str + - arg_type: str name: NDARRAY_PORT description: |- Input Array Port - - type: id + - arg_type: id name: PORT description: |- Port name for the NDGather plugin - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1549,30 +1549,30 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_PORTS description: |- Maximum number of ports that this plugin can connect to for callbacks default: 5 - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix @@ -1601,51 +1601,51 @@ defs: This plugin selects a region of interest and optionally scales it to fit in a particular data type args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDROI plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1662,19 +1662,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -1710,51 +1710,51 @@ defs: description: |- This plugin displays NDArray attributes args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDAttribute plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1771,31 +1771,31 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_ATTRIBUTES description: |- Maximum number of attributes in this plugin default: 8 - - type: int + - arg_type: int name: NCHANS description: |- Number of points in the arrays default: 4096 - - type: str + - arg_type: str name: TS_PORT description: |- Asyn Port of Time Series plugin @@ -1841,90 +1841,90 @@ defs: description: |- This plugin calculates statistics like X and Y profile, centroid, and plots a histogram of binned pixels args: - - type: id + - arg_type: id name: PORT description: |- Port name for the NDStats plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: HIST_SIZE description: |- Maximum size of Pixel binning histogram (e.g. 256 for Int8) - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: int + - arg_type: int name: XSIZE description: |- XSIZE, Maximum size of X histograms (e.g. 1024) - - type: int + - arg_type: int name: YSIZE description: |- Maximum size of Y histograms (e.g. 768) - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: int + - arg_type: int name: NCHANS description: |- Maximum length of time series (initialises waveform NELM, fixed on IOC boot) default: 2048 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads default: 1 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1941,7 +1941,7 @@ defs: Event: I/O Intr: - - type: str + - arg_type: str name: TS_PORT description: |- TS port @@ -1991,56 +1991,56 @@ defs: description: |- This plugin creates time series arrays from callback data args: - - type: str + - arg_type: str name: P description: |- Device prefix - - type: str + - arg_type: str name: R description: |- Device suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDTimeSeries plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: str + - arg_type: str name: NCHANS description: |- Length of time series waveform - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2057,43 +2057,43 @@ defs: Event: I/O Intr: - - type: float + - arg_type: float name: TIME_LINK description: |- Time between points (Can point to a record - use CP) default: 0.1 - - type: int + - arg_type: int name: NSIGNALS description: |- Maximum number of time series signals default: 1 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: PRIORITY description: |- Thread priority if ASYN_CANBLOCK is set default: 0 - - type: int + - arg_type: int name: STACKSIZE description: |- Stack size if ASYN_CANBLOCK is set default: 0 - - type: str + - arg_type: str name: NAME description: |- Name of the signal @@ -2135,27 +2135,27 @@ defs: Add an attribute to the NDAttributes file for a particular ADDriver or NDPlugin, and associate it with the NDAttributes file args: - - type: object + - arg_type: object name: port description: |- ADDriver or NDPlugin to attach xml file to - - type: str + - arg_type: str name: source description: |- The EPICS PV (if type=EPICS_PV) or attribute name (if type=PARAM) - - type: id + - arg_type: id name: name description: |- Object name. You do not need to specify this - - type: str + - arg_type: str name: attrname description: |- Name of the attribute. If you leave this blank it defaults to - - type: enum + - arg_type: enum name: type description: |- Where the data should be picked up from @@ -2164,7 +2164,7 @@ defs: EPICS_PV: PARAM: - - type: enum + - arg_type: enum name: dbrtype description: |- DBR type (only used if type=EPICS_PV) @@ -2179,7 +2179,7 @@ defs: DBR_LONG: DBR_FLOAT: - - type: enum + - arg_type: enum name: datatype description: |- Data type (only used if type=PARAM) @@ -2189,12 +2189,12 @@ defs: DOUBLE: STRING: - - type: str + - arg_type: str name: description description: |- Description of the attribute - - type: int + - arg_type: int name: addr description: |- Asyn address of the parameter (only used if type=PARAM) @@ -2209,51 +2209,51 @@ defs: This plugin does image processing like flat field correction, background subtraction, and recursive filtering args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDProcess plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2270,13 +2270,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -2312,51 +2312,51 @@ defs: description: |- This plugin can compress NDArrays to TIFF and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileTIFF plugin - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2373,13 +2373,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -2407,41 +2407,41 @@ defs: description: |- This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream args: - - type: str + - arg_type: str name: NDARRAY_PORT description: |- Input Array Port - - type: id + - arg_type: id name: PORT description: |- Port name for the NDGather plugin - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2458,34 +2458,34 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: str + - arg_type: str name: N description: |- Port number (1 - maxPorts) - - type: str + - arg_type: str name: MAX_PORTS description: |- Maximum number ports @@ -2519,51 +2519,51 @@ defs: description: |- This plugin calculates statistics of ROIs args: - - type: str + - arg_type: str name: P description: |- First part of base PV name - - type: str + - arg_type: str name: R description: |- Second part of base PV name - - type: id + - arg_type: id name: PORT description: |- Port name for the NDPluginROIStat plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- asyn address on port default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2580,31 +2580,31 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_ROIS description: |- Maximum number of ROIs in this plugin default: 8 - - type: int + - arg_type: int name: NCHANS description: |- Number of points in the arrays default: 4096 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -2642,51 +2642,51 @@ defs: description: |- This plugin can compress NDArrays to NetCDF and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileNetCDF plugin - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2703,13 +2703,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -2737,56 +2737,56 @@ defs: description: |- This plugin makes NDArrays available through PVAccess args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDPosPlugin plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: str + - arg_type: str name: PVNAME description: |- Name of the PV to post NDArray out on - - type: int + - arg_type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2803,25 +2803,25 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: PRIORITY description: |- Max buffers to allocate default: 0 - - type: int + - arg_type: int name: STACKSIZE description: |- Max buffers to allocate @@ -2858,51 +2858,51 @@ defs: description: |- This plugin selects a region of interest and optionally scales it to fit in a particular data type args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDTransform plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2919,19 +2919,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - type: int + - arg_type: int name: MAX_THREADS description: |- Maximum number threads @@ -2959,51 +2959,51 @@ defs: description: |- This plugin can compress NDArrays to JPEG and write them to file args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDFileJPEG plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -3020,13 +3020,13 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? @@ -3054,51 +3054,51 @@ defs: description: |- This plugin is used to distribute processing of NDArrays to multiple downstream plugins args: - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: R description: |- Device Suffix - - type: id + - arg_type: id name: PORT description: |- Port name for the NDTimeSeries plugin - - type: object + - arg_type: object name: NDARRAY_PORT description: |- Input array port - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 1 - - type: int + - arg_type: int name: ADDR description: |- Asyn Port address default: 0 - - type: int + - arg_type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - type: int + - arg_type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - type: enum + - arg_type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -3115,19 +3115,19 @@ defs: Event: I/O Intr: - - type: int + - arg_type: int name: NAME description: |- Label for signal default: 0 - - type: int + - arg_type: int name: QUEUE description: |- Input array queue size default: 2 - - type: int + - arg_type: int name: BLOCK description: |- Blocking callbacks? diff --git a/tests/samples/support/asyn.ibek.support.yaml b/tests/samples/support/asyn.ibek.support.yaml index ae52a2683..6d557cd28 100644 --- a/tests/samples/support/asyn.ibek.support.yaml +++ b/tests/samples/support/asyn.ibek.support.yaml @@ -7,54 +7,54 @@ defs: description: |- Asyn IP Port args: - - type: str + - arg_type: str name: port description: |- Serial port tty name / IP address optionally followed by protocol - - type: id + - arg_type: id name: name description: |- Override name - - type: str + - arg_type: str name: input_eos description: |- Input end of string (terminator) # test escaping of quotes default: '"\n"' - - type: str + - arg_type: str name: output_eos description: |- Output end of string (terminator) default: '"\n"' - - type: int + - arg_type: int name: priority description: |- Priority default: 100 - - type: bool + - arg_type: bool name: noAuto_connect description: |- Set to stop auto_connect default: false - - type: bool + - arg_type: bool name: noProcessEos description: |- Set to avoid processing end of string default: false - - type: int + - arg_type: int name: baud description: |- Baud Rate default: 9600 - - type: enum + - arg_type: enum name: parity description: |- Parity @@ -64,7 +64,7 @@ defs: odd: default: none - - type: enum + - arg_type: enum name: crtscts description: |- Set hardware flow control on @@ -73,7 +73,7 @@ defs: N: default: N - - type: enum + - arg_type: enum name: stop description: |- Stop Bits @@ -82,7 +82,7 @@ defs: "2": default: "1" - - type: enum + - arg_type: enum name: disconnectOnReadTimeout description: |- Disconnect when a read times out @@ -91,7 +91,7 @@ defs: N: default: Y - - type: enum + - arg_type: enum name: bits description: |- Bits diff --git a/tests/samples/support/bad_db.ibek.support.yaml b/tests/samples/support/bad_db.ibek.support.yaml index 75474c0b9..50fc00d23 100644 --- a/tests/samples/support/bad_db.ibek.support.yaml +++ b/tests/samples/support/bad_db.ibek.support.yaml @@ -10,7 +10,7 @@ defs: description: | Example object with a database containing a non-existant arg args: - - type: id + - arg_type: id name: name description: Port name diff --git a/tests/samples/support/dlsPLC.ibek.support.yaml b/tests/samples/support/dlsPLC.ibek.support.yaml index b3499dd10..f45ad795a 100644 --- a/tests/samples/support/dlsPLC.ibek.support.yaml +++ b/tests/samples/support/dlsPLC.ibek.support.yaml @@ -1,107 +1,107 @@ -# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/3.0.0b4/ibek.support.schema.json +# yaml-language-server: $schema=../schemas/ibek.support.schema.json module: dlsPLC defs: - shared: - - &ilk0 { type: str, name: ilk0, description: Interlock description 0, default: unused } - - &ilk1 { type: str, name: ilk1, description: Interlock description 1, default: unused } - - &ilk2 { type: str, name: ilk2, description: Interlock description 2, default: unused } - - &ilk3 { type: str, name: ilk3, description: Interlock description 3, default: unused } - - &ilk4 { type: str, name: ilk4, description: Interlock description 4, default: unused } - - &ilk5 { type: str, name: ilk5, description: Interlock description 5, default: unused } - - &ilk6 { type: str, name: ilk6, description: Interlock description 6, default: unused } - - &ilk7 { type: str, name: ilk7, description: Interlock description 7, default: unused } - - &ilk8 { type: str, name: ilk8, description: Interlock description 8, default: unused } - - &ilk9 { type: str, name: ilk9, description: Interlock description 9, default: unused } - - &ilk10 { type: str, name: ilk10, description: Interlock description 10, default: unused } - - &ilk11 { type: str, name: ilk11, description: Interlock description 11, default: unused } - - &ilk12 { type: str, name: ilk12, description: Interlock description 12, default: unused } - - &ilk13 { type: str, name: ilk13, description: Interlock description 13, default: unused } - - &ilk14 { type: str, name: ilk14, description: Interlock description 14, default: unused } - - &ilk15 { type: str, name: ilk15, description: Interlock description 15, default: unused } - - &cilk0 { type: str, name: cilk0, description: Gauge interlock description 0, default: unused } - - &cilk1 { type: str, name: cilk1, description: Gauge interlock description 1, default: unused } - - &cilk2 { type: str, name: cilk2, description: Gauge interlock description 2, default: unused } - - &cilk3 { type: str, name: cilk3, description: Gauge interlock description 3, default: unused } - - &cilk4 { type: str, name: cilk4, description: Gauge interlock description 4, default: unused } - - &cilk5 { type: str, name: cilk5, description: Gauge interlock description 5, default: unused } - - &cilk6 { type: str, name: cilk6, description: Gauge interlock description 6, default: unused } - - &cilk7 { type: str, name: cilk7, description: Gauge interlock description 7, default: unused } - - &cilk8 { type: str, name: cilk8, description: Gauge interlock description 8, default: unused } - - &cilk9 { type: str, name: cilk9, description: Gauge interlock description 9, default: unused } - - &cilk10 { type: str, name: cilk10, description: Gauge interlock description 10, default: unused } - - &cilk11 { type: str, name: cilk11, description: Gauge interlock description 11, default: unused } - - &cilk12 { type: str, name: cilk12, description: Gauge interlock description 12, default: unused } - - &cilk13 { type: str, name: cilk13, description: Gauge interlock description 13, default: unused } - - &cilk14 { type: str, name: cilk14, description: Gauge interlock description 14, default: unused } - - &cilk15 { type: str, name: cilk15, description: Gauge interlock description 15, default: unused } + - &ilk0 { arg_type: str, name: ilk0, description: Interlock description 0, default: unused } + - &ilk1 { arg_type: str, name: ilk1, description: Interlock description 1, default: unused } + - &ilk2 { arg_type: str, name: ilk2, description: Interlock description 2, default: unused } + - &ilk3 { arg_type: str, name: ilk3, description: Interlock description 3, default: unused } + - &ilk4 { arg_type: str, name: ilk4, description: Interlock description 4, default: unused } + - &ilk5 { arg_type: str, name: ilk5, description: Interlock description 5, default: unused } + - &ilk6 { arg_type: str, name: ilk6, description: Interlock description 6, default: unused } + - &ilk7 { arg_type: str, name: ilk7, description: Interlock description 7, default: unused } + - &ilk8 { arg_type: str, name: ilk8, description: Interlock description 8, default: unused } + - &ilk9 { arg_type: str, name: ilk9, description: Interlock description 9, default: unused } + - &ilk10 { arg_type: str, name: ilk10, description: Interlock description 10, default: unused } + - &ilk11 { arg_type: str, name: ilk11, description: Interlock description 11, default: unused } + - &ilk12 { arg_type: str, name: ilk12, description: Interlock description 12, default: unused } + - &ilk13 { arg_type: str, name: ilk13, description: Interlock description 13, default: unused } + - &ilk14 { arg_type: str, name: ilk14, description: Interlock description 14, default: unused } + - &ilk15 { arg_type: str, name: ilk15, description: Interlock description 15, default: unused } + - &cilk0 { arg_type: str, name: cilk0, description: Gauge interlock description 0, default: unused } + - &cilk1 { arg_type: str, name: cilk1, description: Gauge interlock description 1, default: unused } + - &cilk2 { arg_type: str, name: cilk2, description: Gauge interlock description 2, default: unused } + - &cilk3 { arg_type: str, name: cilk3, description: Gauge interlock description 3, default: unused } + - &cilk4 { arg_type: str, name: cilk4, description: Gauge interlock description 4, default: unused } + - &cilk5 { arg_type: str, name: cilk5, description: Gauge interlock description 5, default: unused } + - &cilk6 { arg_type: str, name: cilk6, description: Gauge interlock description 6, default: unused } + - &cilk7 { arg_type: str, name: cilk7, description: Gauge interlock description 7, default: unused } + - &cilk8 { arg_type: str, name: cilk8, description: Gauge interlock description 8, default: unused } + - &cilk9 { arg_type: str, name: cilk9, description: Gauge interlock description 9, default: unused } + - &cilk10 { arg_type: str, name: cilk10, description: Gauge interlock description 10, default: unused } + - &cilk11 { arg_type: str, name: cilk11, description: Gauge interlock description 11, default: unused } + - &cilk12 { arg_type: str, name: cilk12, description: Gauge interlock description 12, default: unused } + - &cilk13 { arg_type: str, name: cilk13, description: Gauge interlock description 13, default: unused } + - &cilk14 { arg_type: str, name: cilk14, description: Gauge interlock description 14, default: unused } + - &cilk15 { arg_type: str, name: cilk15, description: Gauge interlock description 15, default: unused } # theses would further reduce the duplication but cannot be used because they would require merging lists # which is not supported in the yaml spec - &ilk [*ilk0, *ilk1, *ilk2, *ilk3, *ilk4, *ilk5, *ilk6, *ilk7, *ilk8, *ilk9, *ilk10, *ilk11, *ilk12, *ilk13, *ilk14, *ilk15] - &cilk [*cilk0, *cilk1, *cilk2, *cilk3, *cilk4, *cilk5, *cilk6, *cilk7, *cilk8, *cilk9, *cilk10, *cilk11, *cilk12, *cilk13, *cilk14, *cilk15] - - &con_label0 { type: str, name: con_label0, description: Label string for control value 0 (Optional - defaults to Open), default: Open } - - &con_label1 { type: str, name: con_label1, description: Label string for control value 1 (Optional - defaults to Close), default: Close } - - &con_label2 { type: str, name: con_label2, description: Label string for control value 2 (Optional - defaults to Reset), default: Reset } - - &con_label3 { type: str, name: con_label3, description: Label string for control value 3 (Optional - defaults to ""), default: "" } - - &con_label4 { type: str, name: con_label4, description: Label string for control value 4 (Optional - defaults to ""), default: "" } - - &con_label5 { type: str, name: con_label5, description: Label string for control value 5 (Optional - defaults to ""), default: "" } - - &con_label6 { type: str, name: con_label6, description: Label string for control value 6 (Optional - defaults to ""), default: "" } - - &sta_label0 { type: str, name: sta_label0, description: Label string for status value 0 (Optional - defaults to Fault), default: Fault } - - &sta_label1 { type: str, name: sta_label1, description: Label string for status value 1 (Optional - defaults to Open), default: Open } - - &sta_label2 { type: str, name: sta_label2, description: Label string for status value 2 (Optional - defaults to Opening), default: Opening } - - &sta_label3 { type: str, name: sta_label3, description: Label string for status value 3 (Optional - defaults to Closed), default: Closed } - - &sta_label4 { type: str, name: sta_label4, description: Label string for status value 4 (Optional - defaults to Closing), default: Closing } - - &sta_label5 { type: str, name: sta_label5, description: Label string for status value 5 (Optional - defaults to ""), default: "" } - - &sta_label6 { type: str, name: sta_label6, description: Label string for status value 6 (Optional - defaults to ""), default: "" } - - &sta_sv0 { type: str, name: sta_sv0, description: Optional. Defaults to MAJOR. Alarm severity for status value 0., default: MAJOR } - - &sta_sv1 { type: str, name: sta_sv1, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1., default: NO_ALARM } - - &sta_sv2 { type: str, name: sta_sv2, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2., default: NO_ALARM } - - &sta_sv3 { type: str, name: sta_sv3, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3., default: NO_ALARM } - - &sta_sv4 { type: str, name: sta_sv4, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4., default: NO_ALARM } - - &sta_sv5 { type: str, name: sta_sv5, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5., default: NO_ALARM } - - &sta_sv6 { type: str, name: sta_sv6, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6., default: NO_ALARM } + - &con_label0 { arg_type: str, name: con_label0, description: Label string for control value 0 (Optional - defaults to Open), default: Open } + - &con_label1 { arg_type: str, name: con_label1, description: Label string for control value 1 (Optional - defaults to Close), default: Close } + - &con_label2 { arg_type: str, name: con_label2, description: Label string for control value 2 (Optional - defaults to Reset), default: Reset } + - &con_label3 { arg_type: str, name: con_label3, description: Label string for control value 3 (Optional - defaults to ""), default: "" } + - &con_label4 { arg_type: str, name: con_label4, description: Label string for control value 4 (Optional - defaults to ""), default: "" } + - &con_label5 { arg_type: str, name: con_label5, description: Label string for control value 5 (Optional - defaults to ""), default: "" } + - &con_label6 { arg_type: str, name: con_label6, description: Label string for control value 6 (Optional - defaults to ""), default: "" } + - &sta_label0 { arg_type: str, name: sta_label0, description: Label string for status value 0 (Optional - defaults to Fault), default: Fault } + - &sta_label1 { arg_type: str, name: sta_label1, description: Label string for status value 1 (Optional - defaults to Open), default: Open } + - &sta_label2 { arg_type: str, name: sta_label2, description: Label string for status value 2 (Optional - defaults to Opening), default: Opening } + - &sta_label3 { arg_type: str, name: sta_label3, description: Label string for status value 3 (Optional - defaults to Closed), default: Closed } + - &sta_label4 { arg_type: str, name: sta_label4, description: Label string for status value 4 (Optional - defaults to Closing), default: Closing } + - &sta_label5 { arg_type: str, name: sta_label5, description: Label string for status value 5 (Optional - defaults to ""), default: "" } + - &sta_label6 { arg_type: str, name: sta_label6, description: Label string for status value 6 (Optional - defaults to ""), default: "" } + - &sta_sv0 { arg_type: str, name: sta_sv0, description: Optional. Defaults to MAJOR. Alarm severity for status value 0., default: MAJOR } + - &sta_sv1 { arg_type: str, name: sta_sv1, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1., default: NO_ALARM } + - &sta_sv2 { arg_type: str, name: sta_sv2, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2., default: NO_ALARM } + - &sta_sv3 { arg_type: str, name: sta_sv3, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3., default: NO_ALARM } + - &sta_sv4 { arg_type: str, name: sta_sv4, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4., default: NO_ALARM } + - &sta_sv5 { arg_type: str, name: sta_sv5, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5., default: NO_ALARM } + - &sta_sv6 { arg_type: str, name: sta_sv6, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6., default: NO_ALARM } name: overrideRequestIndividual description: |- Template allowing override of individual interlock bits args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: DESC description: |- Description (e.g. DCM piezo override) - - type: str + - arg_type: str name: PRESSURE1 description: |- Pressure in mbar that needs to be over setpoint to allow override - - type: str + - arg_type: str name: PRESSURE2 description: |- Pressure in mbar that needs to be over setpoint to allow override - - type: str + - arg_type: str name: OVERRIDE description: |- P of overrideRequestMain instance - - type: str + - arg_type: str name: BIT description: |- Bit of overrideRequestMain instance to use (0-8) - - type: str + - arg_type: str name: SETPOINT description: |- Setpoint in mbar that both pressures need to be higher than to allow override - - type: id + - arg_type: id name: name description: |- This associates an edm screen with the template @@ -122,7 +122,7 @@ defs: description: |- Template that reads software version from a PLC. args: - - type: str + - arg_type: str name: device description: |- Device prefix @@ -136,39 +136,39 @@ defs: description: |- Template database for a vacuum valve with different interlocks for open and close operations args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM150..159 then addr=150 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol @@ -228,96 +228,96 @@ defs: - *sta_sv5 - *sta_sv6 - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: valvetype description: |- Template argument default: valve - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- Template argument default: Operational - - type: str + - arg_type: str name: mode2 description: |- Template argument @@ -378,7 +378,7 @@ defs: sta_sv5: sta_sv4: sta_sv6: - valvetype: + valvearg_type: ilk6: ilk2: ilk7: @@ -409,128 +409,128 @@ defs: description: |- Write the Enum value into a DM variable in a PLC args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: int + - arg_type: int name: timeout description: |- timeout on PV write attempts default: 0 - - type: int + - arg_type: int name: VAL0 description: |- Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: |- Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: |- Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: |- Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: |- Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: |- Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: |- Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: |- Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: |- String Value for state 0 default: "" - - type: str + - arg_type: str name: STR1 description: |- String Value for state 1 default: "" - - type: str + - arg_type: str name: STR2 description: |- String Value for state 2 default: "" - - type: str + - arg_type: str name: STR3 description: |- String Value for state 3 default: "" - - type: str + - arg_type: str name: STR4 description: |- String Value for state 4 default: "" - - type: str + - arg_type: str name: STR5 description: |- String Value for state 5 default: "" - - type: str + - arg_type: str name: STR6 description: |- String Value for state 6 default: "" - - type: str + - arg_type: str name: STR7 description: |- String Value for state 7 @@ -570,47 +570,47 @@ defs: bits. E.g. if interlock DM816..818 bit 4 is S1 water, use loloaddress=818,lolobit=4 for instantaneous lolo signal args: - - type: str + - arg_type: str name: P description: |- EPICS prefix - - type: str + - arg_type: str name: Q description: |- EPICS suffix - - type: str + - arg_type: str name: DESC description: |- Description - - type: str + - arg_type: str name: device description: |- EPICS name of the vacuum valve crate that connects to the RIO - - type: str + - arg_type: str name: loaddress description: |- Address of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - type: str + - arg_type: str name: lobit description: |- Bit of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - type: str + - arg_type: str name: loloaddress description: |- Address of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - type: str + - arg_type: str name: lolobit description: |- Bit of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - type: id + - arg_type: id name: name description: |- This associates an edm screen with the template @@ -632,122 +632,122 @@ defs: description: |- Read the Enum value stored in a DM variable in a PLC args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: vlvcc description: |- PLC control crate device prefix - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: int + - arg_type: int name: VAL0 description: |- Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: |- Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: |- Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: |- Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: |- Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: |- Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: |- Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: |- Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: |- String Value for state 0 default: "" - - type: str + - arg_type: str name: STR1 description: |- String Value for state 1 default: "" - - type: str + - arg_type: str name: STR2 description: |- String Value for state 2 default: "" - - type: str + - arg_type: str name: STR3 description: |- String Value for state 3 default: "" - - type: str + - arg_type: str name: STR4 description: |- String Value for state 4 default: "" - - type: str + - arg_type: str name: STR5 description: |- String Value for state 5 default: "" - - type: str + - arg_type: str name: STR6 description: |- String Value for state 6 default: "" - - type: str + - arg_type: str name: STR7 description: |- String Value for state 7 @@ -782,187 +782,187 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: |- Name - - type: str + - arg_type: str name: device description: |- Device Prefix - - type: object + - arg_type: object name: port description: |- Fins port - - type: int + - arg_type: int name: addr description: |- First interlock work - - type: str + - arg_type: str name: axis1Description description: |- Axis 1 Description default: unused - - type: str + - arg_type: str name: axis2Description description: |- Axis 2 Description default: unused - - type: str + - arg_type: str name: axis3Description description: |- Axis 3 Description default: unused - - type: str + - arg_type: str name: axis4Description description: |- Axis 4 Description default: unused - - type: str + - arg_type: str name: axis5Description description: |- Axis 5 Description default: unused - - type: str + - arg_type: str name: axis6Description description: |- Axis 6 Description default: unused - - type: str + - arg_type: str name: axis7Description description: |- Axis 7 Description default: unused - - type: str + - arg_type: str name: axis8Description description: |- Axis 8 Description default: unused - - type: str + - arg_type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: desc description: |- Permit description (e.g. Front end permit) - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: int + - arg_type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -1000,71 +1000,71 @@ defs: description: |- Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: variable description: |- PV suffix (its associated _RBV will be autogenerated). - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: |- tag name of ether_ip read value - - type: str + - arg_type: str name: tagwrite description: |- tag name of ether_ip write value - - type: str + - arg_type: str name: drvl description: |- Lowest accepted value - - type: str + - arg_type: str name: drvh description: |- This associates an edm screen with the template - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: desc description: |- Description default: "" - - type: str + - arg_type: str name: readscan description: |- value update time for readback value default: 1 second - - type: float + - arg_type: float name: writescan description: |- value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - type: str + - arg_type: str name: egu description: |- Engineering units default: "" - - type: int + - arg_type: int name: prec description: |- precision for reporting value back @@ -1091,12 +1091,12 @@ defs: description: |- Valve interface for a valve that lives in another IOC args: - - type: str + - arg_type: str name: device description: |- Device macro of valve that exists in another IOC - - type: enum + - arg_type: enum name: valvetype description: |- Type of Device @@ -1113,126 +1113,126 @@ defs: Peter Denison 30/9/2005, based on vacuum valve by Pete Owens - 26/4/04 args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: con_label0 description: |- con_label0 default: Open - - type: str + - arg_type: str name: con_label1 description: |- con_label1 default: Close - - type: str + - arg_type: str name: con_label2 description: |- con_label2 default: Reset - - type: str + - arg_type: str name: con_label3 description: |- con_label3 default: "" - - type: str + - arg_type: str name: con_label4 description: |- con_label4 default: "" - - type: str + - arg_type: str name: con_label5 description: |- con_label5 default: "" - - type: str + - arg_type: str name: con_label6 description: |- con_label6 default: "" - - type: str + - arg_type: str name: ilksta_label0 description: |- ilksta_label0 default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- ilksta_label1 default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- ilksta_label2 default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- ilksta_label3 default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- ilksta_label4 default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- ilksta_label5 default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- ilksta_sv0 default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- ilksta_sv1 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- ilksta_sv2 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- ilksta_sv3 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- ilksta_sv4 default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- ilksta_sv5 default: NO_ALARM - - type: str + - arg_type: str name: allowpv description: |- Template argument @@ -1267,458 +1267,458 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: Arm - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open Armed - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: Open Disarmed - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: desc description: |- Box label for gui default: $(device) - - type: int + - arg_type: int name: showilk description: |- 0 (default) => Gauge, 1 => Arm default: 0 - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- Template argument default: Operational - - type: str + - arg_type: str name: mode2 description: |- Template argument @@ -1811,27 +1811,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: |- Template argument - - type: str + - arg_type: str name: port description: |- Template argument - - type: str + - arg_type: str name: tag description: |- Template argument - - type: int + - arg_type: int name: tagidx description: |- Template argument - - type: str + - arg_type: str name: DIRILK1 description: |- Template argument @@ -1851,67 +1851,67 @@ defs: Creates beam records that the gui can connect to to see which valves and shutters are open args: - - type: str + - arg_type: str name: P description: |- Device prefix for summary PV, records will be $(P):STA$(N) for 1<=N<=#objects - - type: object + - arg_type: object name: object0 description: |- vacuumValve object - - type: object + - arg_type: object name: object1 description: |- vacuumValve object - - type: object + - arg_type: object name: object2 description: |- vacuumValve object - - type: object + - arg_type: object name: object3 description: |- vacuumValve object - - type: object + - arg_type: object name: object4 description: |- vacuumValve object - - type: object + - arg_type: object name: object5 description: |- vacuumValve object - - type: object + - arg_type: object name: object6 description: |- vacuumValve object - - type: object + - arg_type: object name: object7 description: |- vacuumValve object - - type: object + - arg_type: object name: object8 description: |- vacuumValve object - - type: object + - arg_type: object name: object9 description: |- vacuumValve object - - type: object + - arg_type: object name: object10 description: |- vacuumValve object - - type: object + - arg_type: object name: object11 description: |- vacuumValve object @@ -1920,38 +1920,38 @@ defs: description: |- Read the Float32 value stored in 2 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: SCAN description: |- Scan rate of read record @@ -1973,164 +1973,164 @@ defs: Initially created for use with I22's new (2021) DCM. Calc records are created in the dlsPLC_DCMHeater.template file so that they have the archiver tag applied. args: - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: Q description: |- Device Suffix - - type: str + - arg_type: str name: desc description: |- Description - - type: str + - arg_type: str name: vlvcc description: |- Parent PLC control crate device prefix - - type: object + - arg_type: object name: port description: |- asyn port name of FINS driver - - type: int + - arg_type: int name: C_addr description: |- Address of the demand register - - type: int + - arg_type: int name: UTSP_addr description: |- Address of the under temperature setpoint register - - type: int + - arg_type: int name: PID_offset description: |- 2 digit integer offset of DM variables. E.g. if Proportional gain constant setpoint is in DM150 and readback in DM250 offset=50 - - type: int + - arg_type: int name: PID_output_addr description: |- Address of the PID loop output - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: int + - arg_type: int name: VAL0 description: |- Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: |- Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: |- Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: |- Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: |- Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: |- Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: |- Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: |- Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: |- String Value for state 0 default: "" - - type: str + - arg_type: str name: STR1 description: |- String Value for state 1 default: "" - - type: str + - arg_type: str name: STR2 description: |- String Value for state 2 default: "" - - type: str + - arg_type: str name: STR3 description: |- String Value for state 3 default: "" - - type: str + - arg_type: str name: STR4 description: |- String Value for state 4 default: "" - - type: str + - arg_type: str name: STR5 description: |- String Value for state 5 default: "" - - type: str + - arg_type: str name: STR6 description: |- String Value for state 6 default: "" - - type: str + - arg_type: str name: STR7 description: |- String Value for state 7 default: "" - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: ftvl description: |- Type of data in subArray @@ -2215,313 +2215,313 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- EtherIP Port Name - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: |- Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - type: id + - arg_type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - type: str + - arg_type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) @@ -2588,27 +2588,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: |- Gui tag - - type: str + - arg_type: str name: dom description: |- Domain, eg, FE06I - - type: object + - arg_type: object name: fins_port description: |- FINS port - - type: str + - arg_type: str name: eip_port description: |- EtherIP port - - type: str + - arg_type: str name: device description: |- Device prefix @@ -2630,28 +2630,28 @@ defs: Template that reads 100 blocks of memory into records so that it can be used in various templates. args: - - type: str + - arg_type: str name: device description: |- Device prefix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: century description: |- Read DM$(century)00..DM$(century)99 - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: SCAN description: |- Scan rate of read record @@ -2671,123 +2671,123 @@ defs: Template database for an individual temperature on a temperature PLC. args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: temp description: |- PV suffix - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: lolo description: |- Lolo alarm limit - - type: str + - arg_type: str name: low description: |- Low alarm limit - - type: str + - arg_type: str name: high description: |- High alarm limit - - type: str + - arg_type: str name: hihi description: |- Hihi alarm limit - - type: str + - arg_type: str name: hopr description: |- High operating range - - type: str + - arg_type: str name: lopr description: |- Low operating range - - type: str + - arg_type: str name: tag description: |- Tag name on PLC -- default "Temp" for e.g. Temp.Value[tagindex] E default: '"' - - type: str + - arg_type: str name: llsv description: |- Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: |- Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: |- alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: |- archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: |- scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - type: int + - arg_type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: |- precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: |- Object and gui association name - - type: str + - arg_type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: str + - arg_type: str name: egu description: |- This associates an edm screen with the template default: C - - type: str + - arg_type: str name: desc description: |- Description @@ -2824,190 +2824,190 @@ defs: Calc records are created in the associated template file so that they have the archiver tag applied. Initially created for use with K11's proportional valve (2021). args: - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: P description: |- Device Prefix - - type: str + - arg_type: str name: Q description: |- Device Suffix - - type: str + - arg_type: str name: desc description: |- Description - - type: str + - arg_type: str name: vlvcc description: |- Parent PLC control crate device prefix - - type: object + - arg_type: object name: port description: |- asyn port name of FINS driver - - type: int + - arg_type: int name: SetValue_addr description: |- Address of the value register for value setting - - type: int + - arg_type: int name: PID_output_addr description: |- Address of the current PID output value read - - type: int + - arg_type: int name: Control_addr description: |- Address of the demand register for mode setting - - type: int + - arg_type: int name: PID_addr description: |- Address of the PID values group read block (starting by Proportional constant) - - type: int + - arg_type: int name: PIDwrite_addr description: |- Address of the PID values group write block (starting by Proportional constant) - - type: str + - arg_type: str name: units description: |- Value units - - type: int + - arg_type: int name: precision description: |- Decimal precision for setpoint (converted from integer) - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: int + - arg_type: int name: VAL0 description: |- Value for state 0 default: 0 - - type: int + - arg_type: int name: VAL1 description: |- Value for state 1 default: 1 - - type: int + - arg_type: int name: VAL2 description: |- Value for state 2 default: 2 - - type: int + - arg_type: int name: VAL3 description: |- Value for state 3 default: 3 - - type: int + - arg_type: int name: VAL4 description: |- Value for state 4 default: 4 - - type: int + - arg_type: int name: VAL5 description: |- Value for state 5 default: 5 - - type: int + - arg_type: int name: VAL6 description: |- Value for state 6 default: 6 - - type: int + - arg_type: int name: VAL7 description: |- Value for state 7 default: 7 - - type: str + - arg_type: str name: STR0 description: |- String Value for state 0 default: "" - - type: str + - arg_type: str name: STR1 description: |- String Value for state 1 default: "" - - type: str + - arg_type: str name: STR2 description: |- String Value for state 2 default: "" - - type: str + - arg_type: str name: STR3 description: |- String Value for state 3 default: "" - - type: str + - arg_type: str name: STR4 description: |- String Value for state 4 default: "" - - type: str + - arg_type: str name: STR5 description: |- String Value for state 5 default: "" - - type: str + - arg_type: str name: STR6 description: |- String Value for state 6 default: "" - - type: str + - arg_type: str name: STR7 description: |- String Value for state 7 default: "" - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: str + - arg_type: str name: ftvl description: |- Type of data in subArray default: USHORT - - type: str + - arg_type: str name: UNITS description: |- common units - - type: int + - arg_type: int name: PREC description: |- decimal precision for SetPoint and Proportional Constant @@ -3094,44 +3094,44 @@ defs: description: |- Write an float32 value into a PLC DM variable args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: int + - arg_type: int name: drvl description: |- Drive low limit default: 0 - - type: int + - arg_type: int name: drvh description: |- Drive high limit @@ -3153,139 +3153,139 @@ defs: description: |- Template database for reading the status of a DX200 controller through NX102 PLC args: - - type: str + - arg_type: str name: P description: |- PV prefix - - type: str + - arg_type: str name: Q description: |- PV suffix - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tag description: |- ether_ip tag name of robot status - - type: str + - arg_type: str name: numbits description: |- number of bits used - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: scan description: |- value update time default: 1 second - - type: str + - arg_type: str name: desc description: |- Description default: "" - - type: str + - arg_type: str name: label0 description: |- Label string for status bit 0 default: unused - - type: str + - arg_type: str name: label1 description: |- Label string for status bit 1 default: unused - - type: str + - arg_type: str name: label2 description: |- Label string for status bit 2 default: unused - - type: str + - arg_type: str name: label3 description: |- Label string for status bit 3 default: unused - - type: str + - arg_type: str name: label4 description: |- Label string for status bit 4 default: unused - - type: str + - arg_type: str name: label5 description: |- Label string for status bit 5 default: unused - - type: str + - arg_type: str name: label6 description: |- Label string for status bit 6 default: unused - - type: str + - arg_type: str name: label7 description: |- Label string for status bit 7 default: unused - - type: str + - arg_type: str name: label8 description: |- Label string for status bit 8 default: unused - - type: str + - arg_type: str name: label9 description: |- Label string for status bit 9 default: unused - - type: str + - arg_type: str name: labelA description: |- Label string for status bit 10 default: unused - - type: str + - arg_type: str name: labelB description: |- Label string for status bit 11 default: unused - - type: str + - arg_type: str name: labelC description: |- Label string for status bit 12 default: unused - - type: str + - arg_type: str name: labelD description: |- Label string for status bit 13 default: unused - - type: str + - arg_type: str name: labelE description: |- Label string for status bit 14 default: unused - - type: str + - arg_type: str name: labelF description: |- This associates a BOY screen with the template @@ -3323,92 +3323,92 @@ defs: description: |- Template allowing interlock names to be overriden. args: - - type: str + - arg_type: str name: device description: |- device prefix - - type: str + - arg_type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 @@ -3441,144 +3441,144 @@ defs: temperature PLC. Requires an instance of dlsPLC_read100 for century=1 and century=2 args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: temp description: |- PV suffix - - type: str + - arg_type: str name: desc description: |- Description - - type: str + - arg_type: str name: tmpcc description: |- Parent temperature control crate prefix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: offset description: |- 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - type: str + - arg_type: str name: lolo description: |- Lolo alarm limit - - type: str + - arg_type: str name: low description: |- Low alarm limit - - type: str + - arg_type: str name: high description: |- High alarm limit - - type: str + - arg_type: str name: hihi description: |- Hihi alarm limit - - type: str + - arg_type: str name: hopr description: |- High operating range - - type: str + - arg_type: str name: lopr description: |- Low operating range - - type: str + - arg_type: str name: llsv description: |- Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: |- Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: |- alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: |- archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: |- scale factor for temperature/setpoint default: 10 - - type: int + - arg_type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: |- precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: |- Object and gui association name - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: int + - arg_type: int name: incentury description: |- The Century digit(s) for the PLC D address to read temperature values default: 2 - - type: int + - arg_type: int name: outcentury description: |- The Century digit(s) for the PLC D address to write setpoints default: 1 - - type: str + - arg_type: str name: egu description: |- This associates an edm screen with the template @@ -3620,12 +3620,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: object + - arg_type: object name: PLC description: |- Instance of motionInterlockPLC to belong to - - type: enum + - arg_type: enum name: axisNo description: |- Axis Number @@ -3639,7 +3639,7 @@ defs: '"2"': '"3"': - - type: enum + - arg_type: enum name: pLim description: |- 1 for +lim, 0 for -lim @@ -3647,97 +3647,97 @@ defs: '"0"': '"1"': - - type: str + - arg_type: str name: ilk0 description: |- Interlock 0 description default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock 1 description default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock 2 description default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock 3 description default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock 4 description default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock 5 description default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock 6 description default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock 7 description default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock 8 description default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock 9 description default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock 10 description default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock 11 description default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock 12 description default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock 13 description default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock 14 description default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock 15 description @@ -3747,284 +3747,284 @@ defs: description: |- Template database for a vacuum Pump without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of Pump control crate - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to On) default: On - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Off) default: Off - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to On) default: On - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Turning On) default: Turning On - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Off) default: Off - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Turning Off) default: Turning Off - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - type: enum + - arg_type: enum name: pumptype description: |- Type of Pump @@ -4034,73 +4034,73 @@ defs: '"scroll"': '"turbo"': - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument @@ -4160,7 +4160,7 @@ defs: ilksta_label3: ilk5: name: - pumptype: + pumparg_type: con_label3: ilk9: ilk6: @@ -4176,68 +4176,68 @@ defs: description: |- Read the Int32 value stored in 2 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: str + - arg_type: str name: port description: |- Template argument - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: int + - arg_type: int name: scale description: |- Scaling of raw value into EGUs default: 1 - - type: int + - arg_type: int name: roffset description: |- Pre scaling offset in cts default: 0 - - type: int + - arg_type: int name: offset description: |- Offset of value in EGUs default: 0 - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: scan description: |- Template argument default: 1 second - - type: str + - arg_type: str name: egu description: |- Template argument default: mm - - type: int + - arg_type: int name: prec description: |- Template argument @@ -4264,63 +4264,63 @@ defs: Template database for a group of up to 8 vacuum valves Pete Owens - 3/5/05 args: - - type: str + - arg_type: str name: device description: |- device name - - type: float + - arg_type: float name: delay description: |- delay between opening valves - - type: str + - arg_type: str name: valve1 description: |- Valve 1 device name - - type: str + - arg_type: str name: valve2 description: |- Valve 2 device name - - type: str + - arg_type: str name: valve3 description: |- Valve 3 device name - - type: str + - arg_type: str name: valve4 description: |- Valve 4 device name - - type: str + - arg_type: str name: valve5 description: |- Valve 5 device name - - type: str + - arg_type: str name: valve6 description: |- Valve 6 device name - - type: str + - arg_type: str name: valve7 description: |- Valve 7 device name - - type: str + - arg_type: str name: valve8 description: |- Valve 8 device name - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) @@ -4346,308 +4346,308 @@ defs: description: |- Template database for a fast vacuum valve. args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name of the fast valve used as PV name prefix. - - type: str + - arg_type: str name: port description: |- Mandatory. EtherIP communication port name. - - type: str + - arg_type: str name: tag description: |- Mandatory. NX PLC protocol tag string. - - type: int + - arg_type: int name: tagidx description: |- Mandatory. NX PLC tag index number. - - type: int + - arg_type: int name: ILKNUM description: |- Mandatory. Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: |- Optional. Defaults to "". If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. default: "" - - type: str + - arg_type: str name: whylocked description: |- Optional. Defaults to "Open command not allowed". String for GUI screen as to precisely why the device is locked and by whom. default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Optional. Defaults to Open. Label string for control value 0. default: Open - - type: str + - arg_type: str name: con_label1 description: |- Optional. Defaults to Close. Label string for control value 1. default: Close - - type: str + - arg_type: str name: con_label2 description: |- Optional. Defaults to Reset. Label string for control value 2. default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Optional. Defaults to Arm. Label string for control value 3. default: Arm - - type: str + - arg_type: str name: con_label4 description: |- Optional. Defaults to "". Label string for control value 4. default: Partially Arm - - type: str + - arg_type: str name: con_label5 description: |- Optional. Defaults to "". Label string for control value 5. default: "" - - type: str + - arg_type: str name: con_label6 description: |- Optional. Defaults to "". Label string for control value 6. default: "" - - type: str + - arg_type: str name: con_label7 description: |- Optional. Defaults to "". Label string for control value 7. default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Optional. Defaults to Fault. Label string for status value 0. default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Optional. Defaults to Open Fully Armed. Label string for status value 1. default: Open Armed - - type: str + - arg_type: str name: sta_label2 description: |- Optional. Defaults to Opening. Label string for status value 2. default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Optional. Defaults to Closed. Label string for status value 3. default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Optional. Defaults to Closing. Label string for status value 4. default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Optional. Defaults to Open Disarmed. Label string for status value 5. default: Open Disarmed - - type: str + - arg_type: str name: sta_label6 description: |- Optional. Defaults to Open Partially Armed. Label string for status value 6. default: Partially Armed - - type: str + - arg_type: str name: sta_label7 description: |- Optional. Defaults to "". Label string for status value 7. default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 7. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Optional. Defaults to Failed. Label string for status value 0. default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Optional. Defaults to Run Ilks Ok. Label string for status value 1. default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Optional. Defaults to OK. Label string for status value 2. default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Optional. Defaults to Disarmed. Label string for status value 3. default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Optional. Defaults to "". Label string for status value 4. default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Optional. Defaults to "". Label string for status value 5. default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Optional. Defaults to "". Label string for status value 6. default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Optional. Defaults to "". Label string for status value 7. default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - type: str + - arg_type: str name: mode2 description: |- Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - type: str + - arg_type: str name: DIRILK1 description: |- Optional. Defaults to "". Component interlock PV names (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1. default: "" - - type: int + - arg_type: int name: showilk description: |- Optional. Defaults to 0. Which set of interlocks to display - 0: Gauge 1: Arm default: 0 - - type: id + - arg_type: id name: name description: |- Optional. Defaults to "". Object name and associated gui name. @@ -4713,17 +4713,17 @@ defs: Template database for a vacuum valve Ian Gillingham October 2012 args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- asyn port name - - type: str + - arg_type: str name: radmon_device description: |- full PV name of RAD MON :RESET:OK @@ -4739,434 +4739,434 @@ defs: description: |- Template database for a soft opening vacuum valve. args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - type: str + - arg_type: str name: fullilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: fullilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: fullilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: fullilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: fullilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: fullilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: fullilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: fullilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: fullilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: fullilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: fullilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: fullilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: fullilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: fullilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: fullilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: fullilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: softilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: softilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: softilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: softilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: softilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: softilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: softilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: softilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: softilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: softilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: softilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: softilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: softilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: softilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: softilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: softilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Soft Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to Full Open) default: Full Open - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Full Open) default: Full Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Soft Open) default: Soft Open - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for interlock status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for interlock status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for interlock status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for interlock status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for interlock status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for interlock status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: allowpv description: |- Template argument default: "" - - type: str + - arg_type: str name: whylocked description: |- Template argument default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Template argument @@ -5255,350 +5255,350 @@ defs: description: |- Template5B database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Off - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: "" - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Off - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: "" - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: |- This associates an edm screen with the template default: Service - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument @@ -5673,631 +5673,631 @@ defs: description: |- Template database for a control of PreVac Sample Manipulator. Two parameters for source and target chambers (where to transfer sample from and to respectively) have to be written. Further writes to NX PLC registers act commands to turn on motors and gas, and transfer commands for Prepare, Transfer, Abort, Reset. Each of these writes has to have associated pulsed trigger writes to cause the NX PLC to act on the latest value. The NX PLC processes the requested value and decides whether to pass it to the PreVac Modbus PLC. If the latter, the PreVac Modbus PLC also processes the requested value and decides whether to act on it or not. EPICS does not have any direct communication with the PreVac Modbus PLC. Intentions for macros as follows: (1) Strings for posportID_shortdesc macros should be provided only for ports which are present, but they should be left alone as empty strings for ports which are not present. (2) Alarm severities of MAJOR should be defined for posportID_SV macros for ports which are not present, but those which are present are left alone as NO_ALARM. (3) Setting the posportID_compass macros must result in a unique compass direction for all ports n=1-8 for the embedded diagram display on the Control screen to work properly. The default values conform to this. (4) Set targetparam_init to a posport ID number of a port which is present. (5) The value of posportIDs_allowedmask defaults to a safe value of 0, which causes no transfers to be allowed, so you must define it according to the ports present to allow transfers. (NOTE: In descriptions and macro names, "arm" is a noun referring to the sample manipulator arm and not a verb as used for a fast valve). args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name. - - type: str + - arg_type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: tag_sourceparam description: |- Mandatory. NX PLC tag string to write the source chamber parameter. - - type: str + - arg_type: str name: tag_targetparam description: |- Mandatory. NX PLC tag string to write the target chamber parameter. - - type: str + - arg_type: str name: tag_setcoil description: |- Mandatory. NX PLC tag string to set a Coil to TRUE. - - type: str + - arg_type: str name: tag_unsetcoil description: |- Mandatory. NX PLC tag string to set a Coil to FALSE. - - type: str + - arg_type: str name: tag_Tsourceparam description: |- Optional. Defaults to T$(tag_sourceparam). NX PLC tag string to set the trigger to set the source chamber parameter. default: T$(tag_sourceparam) - - type: str + - arg_type: str name: tag_Ttargetparam description: |- Optional. Defaults to T$(tag_targetparam). NX PLC tag string to set the trigger to set the target chamber parameter. default: T$(tag_targetparam) - - type: str + - arg_type: str name: tag_Tsetcoil description: |- Optional. Defaults to T$(tag_setcoil). NX PLC tag string to set the trigger to set a Coil to TRUE. default: T$(tag_setcoil) - - type: str + - arg_type: str name: tag_Tunsetcoil description: |- Optional. Defaults to T$(tag_unsetcoil). NX PLC tag string to set the trigger to set a Coil to FALSE. default: T$(tag_unsetcoil) - - type: float + - arg_type: float name: coilout_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the coil output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. (These are the records which run commands). default: 0.2 - - type: float + - arg_type: float name: paramout_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the parameter output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - type: float + - arg_type: float name: trigger_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - type: int + - arg_type: int name: posportIDs_allowedmask description: |- Optional. Defaults to 0. Mask of bits set for each posportID number which is allowed as source and target. (i.e. a chamber is present). Bit 0 represents the Arm - do NOT set that bit, it is not allowed as a target and has special functionality for error recovery as a source. Although the macro is optional, the default value doesnt allow any transfers, so you must set this. default: 0 - - type: str + - arg_type: str name: posportID0_shortdesc description: |- Optional. Defaults to Arm. Short (for menu) description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to get a readable menu button. default: Arm - - type: str + - arg_type: str name: posportID1_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 1. default: "" - - type: str + - arg_type: str name: posportID2_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 2. default: "" - - type: str + - arg_type: str name: posportID3_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 3. default: "" - - type: str + - arg_type: str name: posportID4_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 4. default: "" - - type: str + - arg_type: str name: posportID5_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 5. default: "" - - type: str + - arg_type: str name: posportID6_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 6. default: "" - - type: str + - arg_type: str name: posportID7_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 7. default: "" - - type: str + - arg_type: str name: posportID8_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 8. default: "" - - type: str + - arg_type: str name: posportID0_sourceSV description: |- Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - type: str + - arg_type: str name: posportID0_targetSV description: |- Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - type: str + - arg_type: str name: posportID1_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID2_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID3_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID4_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID5_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID6_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID7_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID8_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID1_compass description: |- Optional. Defaults to E. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen for posport ID1. default: E - - type: str + - arg_type: str name: posportID2_compass description: |- Optional. Defaults to NE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID2. default: NE - - type: str + - arg_type: str name: posportID3_compass description: |- Optional. Defaults to N. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID3. default: N - - type: str + - arg_type: str name: posportID4_compass description: |- Optional. Defaults to NW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID4. default: NW - - type: str + - arg_type: str name: posportID5_compass description: |- Optional. Defaults to W. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID5. default: W - - type: str + - arg_type: str name: posportID6_compass description: |- Optional. Defaults to SW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID6. default: SW - - type: str + - arg_type: str name: posportID7_compass description: |- Optional. Defaults to S. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID7. default: S - - type: str + - arg_type: str name: posportID8_compass description: |- Optional. Defaults to SE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID8. default: SE - - type: str + - arg_type: str name: ctrlprefix description: |- Optional. Defaults to :CTRL Prefix for SM control records. default: :CTRL - - type: str + - arg_type: str name: paramprefix description: |- Optional. Defaults to :PARAM Prefix for SM parameter records. default: :PARAM - - type: int + - arg_type: int name: paramprec description: |- Optional. Defaults to 0. Precision of the parameter value. default: 0 - - type: str + - arg_type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for SM status records for screens. Must match SM status template. default: :STA - - type: str + - arg_type: str name: posportprefix description: |- Optional. Defaults to :POSPORT Prefix for SM port status records for screens. Must match definitions for SM port status template. default: :POSPORT - - type: str + - arg_type: str name: sourceparam_shortdesc description: |- Optional. Defaults to Source. Short description or name of the Source parameter. default: Source - - type: str + - arg_type: str name: targetparam_shortdesc description: |- Optional. Defaults to Target. Short description or name of the Target parameter. default: Target - - type: str + - arg_type: str name: sourceparam_longdesc description: |- Optional. Defaults to $(sourceparam_shortdesc=Source) chamber to move from. Long description of the Source Parameter. default: $(sourceparam_shortdesc=Source) chamber to move from. - - type: str + - arg_type: str name: targetparam_longdesc description: |- Optional. Defaults to $(targetparam_shortdesc=Target) chamber to move to. Long description of the Target Parameter. default: " $(targetparam_shortdesc=Target) chamber to move to." - - type: int + - arg_type: int name: sourceparam_init description: |- Optional. Defaults to 0 (Arm). Initial value of the user demand for the Source parameter. Helps the display on reboot in the absence of autosave. default: 0 - - type: int + - arg_type: int name: targetparam_init description: |- Optional. Defaults to 1. Initial value of the user demand for the Target parameter. Helps the display on reboot in the absence of autosave. The default value could not be left at 0 because the Arm is never allowed as target. The value of 1 is arbitrary. Recommend set this to the ID of one of the ports which is present in the manipulator configuration. default: 1 - - type: int + - arg_type: int name: trigger_onval description: |- Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - type: int + - arg_type: int name: trigger_offval description: |- Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - type: str + - arg_type: str name: trigger_ONAM description: |- Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - type: str + - arg_type: str name: trigger_ZNAM description: |- Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - type: float + - arg_type: float name: trigger_pulseDLY description: |- Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - type: int + - arg_type: int name: ackprepare_bitno description: |- Optional. Defaults to 0. Number (0 to 15) of the bit in the status word which acknowledges response to the prepare transfer command. default: 0 - - type: int + - arg_type: int name: acktransfer_bitno description: |- Optional. Defaults to 1. Number (0 to 15) of the bit in the status word which acknowledges response to the transfer command. default: 1 - - type: int + - arg_type: int name: ackabort_bitno description: |- Optional. Defaults to 2. Number (0 to 15) of the bit in the status word which acknowledges response to the abort transfer command. default: 2 - - type: int + - arg_type: int name: ackclear_bitno description: |- Optional. Defaults to 3. Number (0 to 15) of the bit in the status word which acknowledges response to the clear error command. default: 3 - - type: str + - arg_type: str name: ackprepare_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the prepare transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: acktransfer_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackabort_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the abort transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackclear_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the clear error command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ackprepare_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of prepare for transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: acktransfer_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackabort_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of abort transfer command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackclear_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of clear error command acknowledgement. default: No Request - - type: str + - arg_type: str name: ackprepare_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of prepare for transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: acktransfer_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: ackabort_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of abort transfer command acknowledgement. default: Request - - type: str + - arg_type: str name: ackclear_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of clear error command acknowledgement. default: Request - - type: str + - arg_type: str name: acksource_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of source parameter acknowledgement. default: No Trigger - - type: str + - arg_type: str name: acktarget_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of target parameter acknowledgement. default: No Trigger - - type: str + - arg_type: str name: acksource_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of source parameter acknowledgement. default: Trigger - - type: str + - arg_type: str name: acktarget_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of target parameter acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackmotorcurrenton_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current on command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackmotorcurrentoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current off command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackmotorcurrenton_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current on command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackmotorcurrentoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current off command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackcompressedairon_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air on command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackcompressedairoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air off command acknowledgement. default: No Trigger - - type: str + - arg_type: str name: ackcompressedairon_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air on command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackcompressedairoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air off command acknowledgement. default: Trigger - - type: str + - arg_type: str name: ackholderonarmon_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to True. default: No Trigger - - type: str + - arg_type: str name: ackholderonarmoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to False. default: No Trigger - - type: str + - arg_type: str name: ackholderonarmon_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to True. default: Trigger - - type: str + - arg_type: str name: ackholderonarmoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to False. default: Trigger - - type: str + - arg_type: str name: ingprepare_ZNAM description: |- Optional. Defaults to Not Preparing. Label for off state (ZNAM field) of in progress for prepare command. default: Not Preparing - - type: str + - arg_type: str name: ingprepare_ONAM description: |- Optional. Defaults to Preparing. Label for on state (ONAM field) of in progress for prepare command. default: Preparing - - type: str + - arg_type: str name: ingtransfer_ZNAM description: |- Optional. Defaults to Not Transferring. Label for off state (ZNAM field) of in progress for transfer command. default: Not Transferring - - type: str + - arg_type: str name: ingtransfer_ONAM description: |- Optional. Defaults to Transferring. Label for on state (ONAM field) of in progress for transfer command. default: Transferring - - type: str + - arg_type: str name: ingabort_ZNAM description: |- Optional. Defaults to Not Aborting. Label for off state (ZNAM field) of in progress for abort command. default: Not Aborting - - type: str + - arg_type: str name: ingabort_ONAM description: |- Optional. Defaults to Aborting. Label for on state (ONAM field) of in progress for abort command. default: Aborting - - type: str + - arg_type: str name: ingclear_ZNAM description: |- Optional. Defaults to Not Clearing. Label for off state (ZNAM field) of in progress for clear command. default: Not Clearing - - type: str + - arg_type: str name: ingclear_ONAM description: |- Optional. Defaults to Clearing. Label for on state (ONAM field) of in progress for clear command. default: Clearing - - type: int + - arg_type: int name: ingprepare_bitno description: |- Optional. Defaults to 11. Number (0 to 15) of the bit in the status word for the in progress status for the prepare command. default: 11 - - type: int + - arg_type: int name: ingtransfer_bitno description: |- Optional. Defaults to 10. Number (0 to 15) of the bit in the status word for the in progress status for the transfer command. default: 10 - - type: int + - arg_type: int name: ingabort_bitno1 description: |- Optional. Defaults to 1. Number (0 to 15) of the bit in the status word for the in progress status for the abort command. default: 1 - - type: int + - arg_type: int name: ingabort_bitno2 description: |- Optional. Defaults to 15. Number (0 to 15) of the bit in the status word for the aborted status for the abort command. default: 15 - - type: str + - arg_type: str name: ingprepare_status description: |- Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the prepare command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ingtransfer_status description: |- Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - type: str + - arg_type: str name: ingabort_status1 description: |- Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERERRORS2). Record for status word to link to extract in progress status for the abort command from. default: $(device)$(staprefix=:STA):TRANSFERERRORS2 - - type: str + - arg_type: str name: ingabort_status2 description: |- Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERSTATUS). Record for status word to link to extract aborted status for the abort command from. This is required because of the behaviour during HiTES1 commissioning of the PreVac Modbus PLC failing to update some of its status including the aborting in progress bit which once set persists until the next command. default: $(device)$(staprefix=:STA):TRANSFERSTATUS - - type: id + - arg_type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -6416,452 +6416,452 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: desc description: |- Box label for gui default: $(device) - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument @@ -6953,675 +6953,675 @@ defs: description: |- Template database for control and interlock of a non-specific device. args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Start command not allowed - - type: int + - arg_type: int name: stastrSCAN description: |- Scan rate for :STASTR PV string read in seconds, may be 10,5,2 or 1. Use to reduce network traffic if comms problems (Optional - defaults to 1) default: 1 - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Start) default: Start - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Abort) default: Abort - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Not running) default: Not running - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Running) default: Running - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Aborted) default: Aborted - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to MINOR) default: MINOR - - type: str + - arg_type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: p1_desc description: |- Label string for parameter 1 (Optional - defaults to "Param1") default: Param1 - - type: int + - arg_type: int name: p1_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p1_prec description: |- Precision of p1 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p1_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p1_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p1_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_desc description: |- Label string for parameter 2 (Optional - defaults to "Param2") default: Param2 - - type: int + - arg_type: int name: p2_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p2_prec description: |- Precision of p2 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p2_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p2_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p2_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_desc description: |- Label string for parameter 3 (Optional - defaults to "Param3") default: Param3 - - type: int + - arg_type: int name: p3_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - type: int + - arg_type: int name: p3_prec description: |- Precision of p3 number (Optional - defaults to 0) default: 0 - - type: str + - arg_type: str name: p3_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - type: str + - arg_type: str name: p3_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: p3_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - type: id + - arg_type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") @@ -7747,198 +7747,198 @@ defs: description: |- Template database for status info regarding a Port on PreVac Sample Manipulator. args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name. - - type: str + - arg_type: str name: posportID description: |- Mandatory. ID of the vacuum port position for the sample manipulator. Must be integer 1 to 8 or 0 for special case of Arm in RDC/UFO and overall status. - - type: str + - arg_type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: tag description: |- Mandatory. NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: |- Mandatory. NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: str + - arg_type: str name: tagname description: |- Mandatory. NX PLC tag name. - - type: str + - arg_type: str name: tagprefix description: |- Mandatory. NX PLC prefix to tag name. - - type: str + - arg_type: str name: posportprefix description: |- Optional. Defaults to ":POSPORT". Prefix for the vacuum port position records. default: :POSPORT - - type: int + - arg_type: int name: smready_bitno description: |- Optional. Defaults to "1". Bit number in port position status for whether sample manipulator inside the chamber is in position ready to participate in the transfer, values 0-15. The Arm/RDC/UFO port is likely to have non-default value, as it needs to address the "Master Interlock Status" bit, whereas the other ports address the "ReadyForTransfer" bit. NOTE: The intended use is for signals derived from GPIO on GeoBricks with other sample manipulator motors on them. default: 1 - - type: int + - arg_type: int name: sampleholder_bitno description: |- Optional. Defaults to "2". Bit number in port position status for whether sample holder is present inside the chamber, values 0-15. The Arm/RDC/UFO port is likely to have non-default value, as it needs to address the "Holder On Arm" bit, whereas the other ports address the "Sample Inside" bit. NOTE: The sample holder might not have a sample in it! default: 2 - - type: str + - arg_type: str name: desc_label0 description: |- Optional. Defaults to "PrepareForTransfer". Descriptive label for bit0 of the Coil word. default: PrepareForTransfer - - type: str + - arg_type: str name: desc_label1 description: |- Optional. Defaults to "ReadyForTransfer". Descriptive label for bit1 of the Coil word. default: ReadyForTransfer - - type: str + - arg_type: str name: desc_label2 description: |- Optional. Defaults to "SampleInside". Descriptive label for bit2 of the Coil word. default: SampleInside - - type: str + - arg_type: str name: desc_label3 description: |- Optional. Defaults to "Error". Descriptive label for bit3 of the Coil word. default: Error - - type: str + - arg_type: str name: desc_label4 description: |- Optional. Defaults to "Busy". Descriptive label for bit4 of the Coil word. default: Busy - - type: str + - arg_type: str name: desc_label5 description: |- Optional. Defaults to "GateOpenRequest". Descriptive label for bit5 of the Coil word. default: GateOpenRequest - - type: str + - arg_type: str name: desc_label6 description: |- Optional. Defaults to "GateOpen". Descriptive label for bit6 of the Coil word. default: GateOpen - - type: str + - arg_type: str name: desc_label7 description: |- Optional. Defaults to "GateClosed". Descriptive label for bit7 of the Coil word. default: GateClosed - - type: str + - arg_type: str name: desc_label8 description: |- Optional. Defaults to "ArmOnPort". Descriptive label for bit8 of the Coil word. default: ArmOnPort - - type: str + - arg_type: str name: desc_label9 description: |- Optional. Defaults to "ReservedForFuture". Descriptive label for bit9 of the Coil word. default: ReservedForFuture - - type: str + - arg_type: str name: desc_label10 description: |- Optional. Defaults to "". Descriptive label for bit10 of the Coil word. default: "" - - type: str + - arg_type: str name: desc_label11 description: |- Optional. Defaults to "". Descriptive label for bit11 of the Coil word. default: "" - - type: str + - arg_type: str name: desc_label12 description: |- Optional. Defaults to "". Descriptive label for bit12 of the Coil word. default: "" - - type: str + - arg_type: str name: desc_label13 description: |- Optional. Defaults to "". Descriptive label for bit13 of the Coil word. default: "" - - type: str + - arg_type: str name: desc_label14 description: |- Optional. Defaults to "". Descriptive label for bit14 of the Coil word. default: "" - - type: str + - arg_type: str name: desc_label15 description: |- Optional. Defaults to "". Descriptive label for bit15 of the Coil word. default: "" - - type: str + - arg_type: str name: longdesc description: |- Optional. Defaults to "Manipulator Position Port $(posportID) status." Description of position port. default: Manipulator Position Port $(posportID) status. - - type: str + - arg_type: str name: shortdesc description: |- Optional. Defaults to "Posport$(posportID)" Short, abbreviated description of position port. default: Posport$(posportID) - - type: str + - arg_type: str name: chamber_name description: |- Optional. Defaults to "". Name of vacuum chamber associated with position port. default: "" - - type: str + - arg_type: str name: chamber_shortname description: |- Optional. Defaults to "". Short name of vacuum chamber associated with position port. default: "" - - type: str + - arg_type: str name: valve_device description: |- Optional. Defaults to "". Device name of vacuum valve associated with position port. So far it is a string for info only, no calcs. default: "" - - type: str + - arg_type: str name: valve_shortname description: |- Optional. Defaults to "". Short, abbreviated name of vacuum valve associated with the position port. default: "" - - type: str + - arg_type: str name: valve_desc description: |- Optional. Defaults to "". Description of vacuum valve associated with position port. default: "" - - type: id + - arg_type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -7985,40 +7985,40 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: |- Template argument - - type: str + - arg_type: str name: port description: |- Template argument - - type: str + - arg_type: str name: tag description: |- Template argument - - type: str + - arg_type: str name: desc description: |- Template argument default: "" - - type: str + - arg_type: str name: scan description: |- Template argument default: 1 second - - type: str + - arg_type: str name: egu description: |- Template argument default: "" - - type: int + - arg_type: int name: prec description: |- Template argument @@ -8039,291 +8039,291 @@ defs: description: |- Template database for control and interlock of a non-specific device. args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. S (from S.Interfc[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Off - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: On - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: "" - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Off - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: "" - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - type: id + - arg_type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") @@ -8385,28 +8385,28 @@ defs: description: |- Power cycle an RGA where the PLC code has been setup to power cycle when 1 is written to a particular DM variable args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: addr description: |- DM variable to write to to reboot rga - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: id + - arg_type: id name: name description: |- Object name and associated gui name @@ -8424,76 +8424,76 @@ defs: description: |- Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: variable description: |- PV suffix (its associated _RBV will be autogenerated). - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: |- tag name of ether_ip read value - - type: str + - arg_type: str name: tagwrite description: |- tag name of ether_ip write value - - type: str + - arg_type: str name: drvl description: |- Lowest accepted value - - type: str + - arg_type: str name: drvh description: |- Highest accepted value - - type: int + - arg_type: int name: tagidx description: |- Template argument - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: desc description: |- Description default: "" - - type: str + - arg_type: str name: readscan description: |- value update time for readback value default: 1 second - - type: float + - arg_type: float name: writescan description: |- value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - type: str + - arg_type: str name: egu description: |- Engineering units default: "" - - type: int + - arg_type: int name: prec description: |- precision for reporting value back @@ -8521,313 +8521,313 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- EtherIP Port Name - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: |- Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - type: id + - arg_type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - type: str + - arg_type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) @@ -8894,321 +8894,321 @@ defs: description: |- Template for a NX PLC to control and interlock vacuum pumps of various kinds, e.g. Scroll and Turbo pumps. NOTE: Covers basic commonly required control only and excludes pump make and model or application specific control and monitoring of the pump which might be available and also be required typically via serial control, for example settings configuration or service period information. args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name of the pump. - - type: str + - arg_type: str name: port description: |- Mandatory. Name of port for the ether_ip driver for the PLC controlling/interlocking the pump. - - type: str + - arg_type: str name: tag description: |- Mandatory. NX PLC tag string e.g. S for Scroll or T for Turbo. - - type: int + - arg_type: int name: tagidx description: |- Mandatory. NX PLC tag index number. Typically this is the same as the id number in the device name, but - - type: str + - arg_type: str name: allowpv description: |- Optional. Defaults to "". If specified, then only write an "open" i.e. on command when this is non-zero. MUST have CP at the end of it. The term "open" here and in PV names is because of heritage from valve control. Generally by default the "open" command for a pump actually signifies turn it on. default: "" - - type: str + - arg_type: str name: whylocked description: |- Optional. Defaults to "On command not allowed". String to output to EDM synoptic as to precisely why the device is locked and by whom. default: On command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Optional. Defaults to On. Label string for control value 0 default: On - - type: str + - arg_type: str name: con_label1 description: |- Optional. Defaults to Off. Label string for control value 1 default: Off - - type: str + - arg_type: str name: con_label2 description: |- Optional. Defaults to Reset. Label string for control value 2 default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Optional. Defaults to Standby. Label string for control value 3 default: "" - - type: str + - arg_type: str name: con_label4 description: |- Optional. Defaults to FullSpeed. Label string for control value 4 default: "" - - type: str + - arg_type: str name: con_label5 description: |- Optional. Defaults to "". Label string for control value 5 default: "" - - type: str + - arg_type: str name: con_label6 description: |- Optional. Defaults to "". Label string for control value 6 default: "" - - type: str + - arg_type: str name: con_label7 description: |- Optional. Defaults to "". Label string for control value 7 default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Optional. Defaults to Fault. Label string for status value 0 default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Optional. Defaults to On. Label string for status value 1 default: On - - type: str + - arg_type: str name: sta_label2 description: |- Optional. Defaults to Standby. Label string for status value 2 default: Standby - - type: str + - arg_type: str name: sta_label3 description: |- Optional. Defaults to Off. Label string for status value 3 default: Off - - type: str + - arg_type: str name: sta_label4 description: |- Optional. Defaults to "". Label string for status value 4 default: FullSpeed - - type: str + - arg_type: str name: sta_label5 description: |- Optional. Defaults to "". Label string for status value 5 default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Optional. Defaults to "". Label string for status value 6 default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Optional. Defaults to "". Label string for status value 7 default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 7. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Optional. Defaults to Failed. Label string for status value 0 default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Optional. Defaults to Run Ilks OK. Label string for status value 1 default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Optional. Defaults to OK. Label string for status value 2 default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Optional. Defaults to "". Label string for status value 3 default: "" - - type: str + - arg_type: str name: ilksta_label4 description: |- Optional. Defaults to "". Label string for status value 4 default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Optional. Defaults to "". Label string for status value 5 default: "" - - type: str + - arg_type: str name: ilksta_label6 description: |- Optional. Defaults to "". Label string for status value 6 default: "" - - type: str + - arg_type: str name: ilksta_label7 description: |- Optional. Defaults to "". Label string for status value 7 default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - type: str + - arg_type: str name: mode2 description: |- Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - type: str + - arg_type: str name: short_desc description: |- Optional. Defaults to Shorting Plug. Description field on the PLUG record DESC field for whether a shorting plug is present. default: Shorting Plug - - type: str + - arg_type: str name: short_label0 description: |- Optional. Defaults to Dummy. Label on the PLUG record ZNAM field for no shorting plug present. default: Dummy - - type: str + - arg_type: str name: short_label1 description: |- Optional. Defaults to Real. Label on the PLUG record ONAM field for shorting plug present. default: Real - - type: str + - arg_type: str name: short_sv0 description: |- Optional. Defaults to NO_ALARM. Severity on the PLUG record ZSV field for the status value 0. default: NO_ALARM - - type: str + - arg_type: str name: short_sv1 description: |- Optional. Defaults to NO_ALARM. Severity on the PLUG record OSV field for the status value 1. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Optional. Defaults to "". Object name and associated gui name. @@ -9275,28 +9275,28 @@ defs: description: |- Template showing the status of the power supply from the ether IP readings args: - - type: str + - arg_type: str name: device description: |- device prefix - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from PSU.Voltage[1]) - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. PSU (from PSU.Voltage[1]) default: PSU - - type: id + - arg_type: id name: name description: |- Object name and associated gui name @@ -9316,133 +9316,133 @@ defs: temperature PLC. Requires an instance of dlsPLC_read100 for century=1 and century=2 args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: temp description: |- PV suffix - - type: str + - arg_type: str name: desc description: |- Description - - type: str + - arg_type: str name: tmpcc description: |- Parent temperature control crate prefix - - type: str + - arg_type: str name: offset description: |- 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - type: str + - arg_type: str name: lolo description: |- Lolo alarm limit - - type: str + - arg_type: str name: low description: |- Low alarm limit - - type: str + - arg_type: str name: high description: |- High alarm limit - - type: str + - arg_type: str name: hihi description: |- Hihi alarm limit - - type: str + - arg_type: str name: hopr description: |- High operating range - - type: str + - arg_type: str name: lopr description: |- Low operating range - - type: str + - arg_type: str name: llsv description: |- Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: |- Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: |- alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: |- archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: |- scale factor for temperature/setpoint default: 10 - - type: int + - arg_type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: |- precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: |- Object and gui association name - - type: str + - arg_type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: int + - arg_type: int name: incentury description: |- The Century digit(s) for the PLC D address to read temperature values default: 2 - - type: int + - arg_type: int name: outcentury description: |- The Century digit(s) for the PLC D address to write setpoints default: 1 - - type: str + - arg_type: str name: egu description: |- This associates an edm screen with the template @@ -9483,42 +9483,42 @@ defs: Template showing the status of various MPS interlocks in an Omron NX102 PLC. args: - - type: str + - arg_type: str name: device description: |- device prefix - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. ILK (from ILK.Control[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from ILK.Control[1]) - - type: str + - arg_type: str name: desc description: |- Permit description (e.g. Front end permit) - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: int + - arg_type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -9540,27 +9540,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: |- Template argument - - type: str + - arg_type: str name: port description: |- Template argument - - type: int + - arg_type: int name: tagidx description: |- Template argument - - type: id + - arg_type: id name: name description: |- Template argument - - type: str + - arg_type: str name: tag description: |- Template argument @@ -9579,18 +9579,18 @@ defs: description: |- Template for Warning GUI banner for stale data from the PreVac Sample Manipulator controller. args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name of sample manipulator. - - type: str + - arg_type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - type: id + - arg_type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -9606,50 +9606,50 @@ defs: description: |- Template database for reading a real value for a DX200 controller variable through NX102 PLC args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: variable description: |- PV suffix for this robot variable - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: str + - arg_type: str name: tagread description: |- tag name of ether_ip read value - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: desc description: |- Description default: "" - - type: str + - arg_type: str name: scan description: |- value update time default: 1 second - - type: str + - arg_type: str name: egu description: |- Engineering units default: "" - - type: int + - arg_type: int name: prec description: |- This associates an edm screen with the template @@ -9672,150 +9672,150 @@ defs: description: |- Template database for a summary PV of up to 24 interlocks args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: ilk1 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk2 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk3 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk4 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk5 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk6 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk7 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk8 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk9 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk10 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk11 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk12 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk13 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk14 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk15 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk16 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk17 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk18 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk19 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk20 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk21 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk22 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk23 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - type: str + - arg_type: str name: ilk24 description: |- Interlock suffix (e.g. INT1) @@ -9854,143 +9854,143 @@ defs: description: |- Template database for status info on PreVac Sample Manipulator (in addition to that for individual SM Ports). args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name. - - type: str + - arg_type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - type: str + - arg_type: str name: posportprefix description: |- Optional. Defaults to :POSPORT Prefix for records for individual ports. Must match port template. default: :POSPORT - - type: str + - arg_type: str name: posportID0_shortdesc description: |- Optional. Defaults to Arm. Short description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to make things sensible. Leave the ones not present (i.e. no chamber connected as empty string.) default: Arm - - type: str + - arg_type: str name: posportID1_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 1, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID2_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 2, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID3_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 3, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID4_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 4, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID5_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 5, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID6_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 6, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID7_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 7, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID8_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 8, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - type: str + - arg_type: str name: posportID0_sourceSV description: |- Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - type: str + - arg_type: str name: posportID0_targetSV description: |- Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - type: str + - arg_type: str name: posportID1_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID2_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID3_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID4_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID5_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID6_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID7_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - type: str + - arg_type: str name: posportID8_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -10028,139 +10028,139 @@ defs: Template showing the status of various MPS interlocks in a PLC. Requires dlsPLC_read100 for any century used args: - - type: str + - arg_type: str name: device description: |- device prefix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - type: str + - arg_type: str name: desc description: |- Permit description (e.g. Front end permit) - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range. E.g. if interlock is in DM800..808 then addr=800 - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: int + - arg_type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -10198,22 +10198,22 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: name description: |- Gui tag - - type: object + - arg_type: object name: master description: |- Master - - type: str + - arg_type: str name: img description: |- Base IMG PV - - type: enum + - arg_type: enum name: id description: |- FV PLC gauge number @@ -10229,7 +10229,7 @@ defs: "06": "01": - - type: enum + - arg_type: enum name: em description: |- EM block to use @@ -10239,7 +10239,7 @@ defs: '"1"': '"2"': - - type: int + - arg_type: int name: timeout description: |- asyn fins_port timeout @@ -10269,45 +10269,45 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - type: enum + - arg_type: enum name: valvetype description: |- Type of Device @@ -10317,414 +10317,414 @@ defs: '"absorber"': '"shutter"': - - type: str + - arg_type: str name: ilk0 description: |- Interlock description 0 default: unused - - type: str + - arg_type: str name: ilk1 description: |- Interlock description 1 default: unused - - type: str + - arg_type: str name: ilk2 description: |- Interlock description 2 default: unused - - type: str + - arg_type: str name: ilk3 description: |- Interlock description 3 default: unused - - type: str + - arg_type: str name: ilk4 description: |- Interlock description 4 default: unused - - type: str + - arg_type: str name: ilk5 description: |- Interlock description 5 default: unused - - type: str + - arg_type: str name: ilk6 description: |- Interlock description 6 default: unused - - type: str + - arg_type: str name: ilk7 description: |- Interlock description 7 default: unused - - type: str + - arg_type: str name: ilk8 description: |- Interlock description 8 default: unused - - type: str + - arg_type: str name: ilk9 description: |- Interlock description 9 default: unused - - type: str + - arg_type: str name: ilk10 description: |- Interlock description 10 default: unused - - type: str + - arg_type: str name: ilk11 description: |- Interlock description 11 default: unused - - type: str + - arg_type: str name: ilk12 description: |- Interlock description 12 default: unused - - type: str + - arg_type: str name: ilk13 description: |- Interlock description 13 default: unused - - type: str + - arg_type: str name: ilk14 description: |- Interlock description 14 default: unused - - type: str + - arg_type: str name: ilk15 description: |- Interlock description 15 default: unused - - type: str + - arg_type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - type: str + - arg_type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - type: str + - arg_type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - type: str + - arg_type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - type: str + - arg_type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - type: str + - arg_type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - type: str + - arg_type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - type: str + - arg_type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - type: str + - arg_type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - type: str + - arg_type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - type: str + - arg_type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - type: str + - arg_type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - type: str + - arg_type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - type: str + - arg_type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - type: str + - arg_type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - type: str + - arg_type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - type: id + - arg_type: id name: name description: |- Object name and associated gui name - - type: str + - arg_type: str name: desc description: |- Box label for gui default: $(device) - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - type: str + - arg_type: str name: ilksta_label0 description: |- Template argument default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - type: str + - arg_type: str name: ilksta_label2 description: |- Template argument default: OK - - type: str + - arg_type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - type: str + - arg_type: str name: ilksta_label4 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_label5 description: |- Template argument default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Template argument @@ -10740,7 +10740,7 @@ defs: ilk10: ilk11: ilk12: - valvetype: + valvearg_type: gda_name: allowpv: ilk8: @@ -10817,32 +10817,32 @@ defs: description: |- Read the Int16 value stored in 1 DM variables in a PLC args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: vlvcc description: |- PLC control crate device prefix - - type: str + - arg_type: str name: addr description: |- DM variable of the int - - type: id + - arg_type: id name: name description: |- Object name and gui association name - - type: str + - arg_type: str name: ftvl description: |- Type of data in subArray @@ -10862,33 +10862,33 @@ defs: description: |- Write an int32 value into a PLC DM variable args: - - type: str + - arg_type: str name: P description: |- device prefix - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: port description: |- asyn port name of FINS driver - - type: str + - arg_type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - type: int + - arg_type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - type: id + - arg_type: id name: name description: |- Object name and gui association name @@ -10907,69 +10907,69 @@ defs: description: |- Template for read only vacuum valves - manual valves with limit switches read back by valve controller PLC so their state is known, but control is not available. args: - - type: str + - arg_type: str name: device description: |- device name of the valve. - - type: str + - arg_type: str name: vlvcc description: |- device name of valve control crate - - type: str + - arg_type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Partial) default: Partial - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: id + - arg_type: id name: name description: |- This associates an edm screen with the template - - type: str + - arg_type: str name: valvetype description: |- Template argument @@ -10980,7 +10980,7 @@ defs: args: vlvcc: addr: - valvetype: + valvearg_type: sta_label5: sta_label4: sta_label6: @@ -10995,286 +10995,286 @@ defs: description: |- Template database for an LVDT on PreVac Sample Manipulator. args: - - type: str + - arg_type: str name: device description: |- Mandatory. Device name. - - type: str + - arg_type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - type: str + - arg_type: str name: lvdtID description: |- Mandatory. ID of the LVDT. Defacto it is a number but it need not be. - - type: str + - arg_type: str name: tag description: |- Mandatory. NX PLC tag string. - - type: str + - arg_type: str name: lvdtprefix description: |- Optional. Defaults to ":LVDT". Prefix for SM LVDT records. default: :LVDT - - type: str + - arg_type: str name: lvdt_shortname description: |- Optional. Defaults to "LVDT{{lvdtID}}". Short name of the LVDT. default: LVDT{{lvdtID}} - - type: str + - arg_type: str name: lvdt_shortdesc description: |- Optional. Defaults to "LVDT {{lvdtID}}". Short description of the LVDT. default: LVDT {{lvdtID}} - - type: str + - arg_type: str name: lvdt_longdesc description: |- Optional. Defaults to "Manipulator LVDT {{lvdtID}}". Longer description of the LVDT. default: Manipulator LVDT {{lvdtID}} # TODO we need ibek to support int | str that looks like {{ xxxx | int }} - - type: str + - arg_type: str name: tagidx description: |- Optional. Defaults to "{{lvdtID}}". NX PLC tag string array index. default: "{{lvdtID}}" - - type: str + - arg_type: str name: pos_SCAN description: |- Optional. Defaults to ".5 second". EPICS .SCAN field. Scan rate for reading encoder. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here. default: .5 second - - type: int + - arg_type: int name: pos_PREC description: |- Optional. Defaults to 3. Precision on the encoder position value. default: 3 - - type: str + - arg_type: str name: pos_EGU description: |- Optional. Defaults to empty string. Engineering units on the encoder value. default: "" - - type: str + - arg_type: str name: pos_LINR description: |- Optional. Defaults to empty string. Values can be "NO CONVERSION", "SLOPE" (must define pos_ESLO and and pos_EOFF), "LINEAR" (must define pos_EGUL and pos_EGUF), (or name of special table) and it will default to "NO CONVERSION". Conversion method for encoder value. See EPICS record reference manual sections on the ai record and the convert menu and conversion. default: "" - - type: str + - arg_type: str name: pos_EGUL description: |- Optional. Defaults to empty string. Low end of LINEAR conversion scale for encoder value. default: "" - - type: str + - arg_type: str name: pos_EGUF description: |- Optional. Defaults to empty string. High end or full value on LINEAR conversion scale for encoder value. default: "" - - type: str + - arg_type: str name: pos_EOFF description: |- Optional. Defaults to empty string. The offset on the value for SLOPE conversion. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_ESLO description: |- Optional. Defaults to empty string. The slope on the value for SLOPE conversion. It will default to 1. default: "" - - type: str + - arg_type: str name: pos_AOFF description: |- Optional. Defaults to empty string. The raw adjustment offset on the value for conversion for all types of conversion. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_ASLO description: |- Optional. Defaults to empty string. The raw adjustment slope on the value for conversion for all types of conversion. It will default to 1. default: "" - - type: str + - arg_type: str name: pos_SMOO description: |- Optional. Defaults to empty string. The smoothing fraction parameter on the smoothing algorithm, value between 0 (no smoothing) and 1 (value never changes), it will default to 0. default: "" - - type: str + - arg_type: str name: pos_HOPR description: |- Optional. Defaults to empty string. The position high operator display value. Will default to 0. default: "" - - type: str + - arg_type: str name: pos_LOPR description: |- Optional. Defaults to empty string. The position low operator display value. Will default to 0. default: "" - - type: str + - arg_type: str name: pos_HIHI description: |- Optional. Defaults to empty string. The position high high limit. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_HIGH description: |- Optional. Defaults to empty string. The position high limit. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_LOW description: |- Optional. Defaults to empty string. The position low limit. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_LOLO description: |- Optional. Defaults to empty string. The position low low limit. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_HHSV description: |- Optional. Defaults to empty string. The alarm severity for the HIHI alarm. It will default to NO_ALARM. default: "" - - type: str + - arg_type: str name: pos_HSV description: |- Optional. Defaults to empty string. The alarm severity for the HIGH alarm. It will default to NO_ALARM. default: "" - - type: str + - arg_type: str name: pos_LSV description: |- Optional. Defaults to empty string. The alarm severity for the LOW alarm. It will default to NO_ALARM. default: "" - - type: str + - arg_type: str name: pos_LLSV description: |- Optional. Defaults to empty string. The alarm severity for the LOLO alarm. It will default to NO_ALARM. default: "" - - type: str + - arg_type: str name: pos_HYST description: |- Optional. Defaults to empty string. The alarm deadband or hysteresis for the scaled position. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_ADEL description: |- Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the scaled position. It will default to 0. default: "" - - type: str + - arg_type: str name: pos_MDEL description: |- Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the scaled position. It will default to 0. default: "" - - type: str + - arg_type: str name: raw_EGU description: |- Optional. Defaults to count. Engineering units on the encoder raw value. default: count - - type: str + - arg_type: str name: raw_HYST description: |- Optional. Defaults to empty string. The alarm deadband or hysteresis for the raw position. It will default to 0. default: "" - - type: str + - arg_type: str name: raw_ADEL description: |- Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the raw position. It will default to 0. default: "" - - type: str + - arg_type: str name: raw_MDEL description: |- Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the raw position. It will default to 0. default: "" - - type: int + - arg_type: int name: slope_PREC description: |- Optional. Defaults to 6. Precision on the derived encoder slope value. default: 6 - - type: str + - arg_type: str name: cal_SCAN description: |- Optional. Defaults to "1 second". EPICS .SCAN field. Scan rate for reading calibration parameters. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here. default: 1 second - - type: float + - arg_type: float name: calout_scanrate description: |- Optional. Defaults to .5 The value of scanrate which when writing to NX PLC the calibration output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - type: float + - arg_type: float name: trigger_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - type: int + - arg_type: int name: trigger_onval description: |- Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - type: int + - arg_type: int name: trigger_offval description: |- Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - type: str + - arg_type: str name: trigger_ONAM description: |- Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - type: str + - arg_type: str name: trigger_ZNAM description: |- Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - type: float + - arg_type: float name: trigger_pulsestartDLY description: |- Optional. Defaults to 1.0. Delay in seconds between last calibration parameter write and pulsing the trigger. default: 1.0 - - type: float + - arg_type: float name: trigger_pulsewidthDLY description: |- Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - type: id + - arg_type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name. @@ -11335,27 +11335,27 @@ defs: description: |- Template allowing overrideRequestIndividual instances to be created args: - - type: str + - arg_type: str name: P description: |- device prefix. This must match a dlsPLC_read100.template device macro - - type: str + - arg_type: str name: Q description: |- device suffix - - type: str + - arg_type: str name: outaddr description: |- Output address. Input address is $(outaddr)+1. E.g. if outaddr=80, read DM81 and write DM80. - - type: str + - arg_type: str name: port description: |- Asyn port for doing serial comms - - type: int + - arg_type: int name: timeout description: |- Template argument @@ -11375,128 +11375,128 @@ defs: Template database for an individual temperature on a front end temperature PLC. args: - - type: str + - arg_type: str name: device description: |- PV prefix - - type: str + - arg_type: str name: temp description: |- PV suffix - - type: str + - arg_type: str name: port description: |- port name of ether_ip driver - - type: int + - arg_type: int name: tagidx description: |- temperature index on PLC - - type: str + - arg_type: str name: lolo description: |- Lolo alarm limit - - type: str + - arg_type: str name: low description: |- Low alarm limit - - type: str + - arg_type: str name: high description: |- High alarm limit - - type: str + - arg_type: str name: hihi description: |- Hihi alarm limit - - type: str + - arg_type: str name: hopr description: |- High operating range - - type: str + - arg_type: str name: lopr description: |- Low operating range - - type: str + - arg_type: str name: tag description: |- etherip tag default: Temp - - type: str + - arg_type: str name: llsv description: |- Lolo severity default: NO_ALARM - - type: str + - arg_type: str name: lsv description: |- Low severity default: NO_ALARM - - type: int + - arg_type: int name: hyst description: |- alarm deadband default: 0 - - type: float + - arg_type: float name: adel description: |- archiver deadband default: 0.2 - - type: int + - arg_type: int name: scalefac description: |- scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - type: int + - arg_type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - type: int + - arg_type: int name: prec description: |- precision for reporting value back default: 1 - - type: id + - arg_type: id name: name description: |- Object and gui association name - - type: str + - arg_type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - type: str + - arg_type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - type: str + - arg_type: str name: egu description: |- This associates an edm screen with the template default: C - - type: str + - arg_type: str name: desc description: |- Description @@ -11532,27 +11532,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: str + - arg_type: str name: device description: |- Template argument - - type: str + - arg_type: str name: port description: |- Template argument - - type: int + - arg_type: int name: tagidx description: |- Template argument - - type: id + - arg_type: id name: name description: |- Template argument - - type: str + - arg_type: str name: tag description: |- Template argument @@ -11571,331 +11571,331 @@ defs: description: |- Template database for a bistable vacuum valve without debounce or raw air records. It has different interlocks for opening and closing it. args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- EtherIP Port Name - - type: str + - arg_type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - type: int + - arg_type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - type: int + - arg_type: int name: ILKNUM description: |- Part of Gauge PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - type: str + - arg_type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - type: str + - arg_type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - type: str + - arg_type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - type: str + - arg_type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to Close Enable) default: Close Enable - - type: str + - arg_type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - type: str + - arg_type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - type: str + - arg_type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - type: str + - arg_type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - type: str + - arg_type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Open Disabled) default: Open Disabled - - type: str + - arg_type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to Closed, Open Available) default: Closed, Open Available - - type: str + - arg_type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to Close Disabled) default: Close Disabled - - type: str + - arg_type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to Open, Close Available) default: Open, Close Available - - type: str + - arg_type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to Closed) default: Closed - - type: str + - arg_type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - type: str + - arg_type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - type: str + - arg_type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - type: str + - arg_type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults to Operational) default: Operational - - type: str + - arg_type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults to Service) default: Service - - type: str + - arg_type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve (Optional - defaults to OPEN) default: OPEN - - type: str + - arg_type: str name: DIRILK1_label description: |- Label string for the interlock 1 "direction". (Optional - defaults to Open) default: Open - - type: str + - arg_type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to CLOSE) default: CLOSE - - type: str + - arg_type: str name: DIRILK2_label description: |- Label string for the interlock 2 "direction". (Optional - defaults to Close) default: Close - - type: id + - arg_type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - type: str + - arg_type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) default: $(device) - - type: str + - arg_type: str name: valvetype description: |- Type of valve for the gui. (Optional - defaults to valve). @@ -11951,7 +11951,7 @@ defs: sta_sv4: sta_sv7: sta_sv6: - valvetype: + valvearg_type: sta_label6: DIRILK2_label: device: @@ -11965,87 +11965,87 @@ defs: description: |- Template database for a machine flow meter args: - - type: str + - arg_type: str name: device description: |- device name - - type: str + - arg_type: str name: port description: |- asyn port name of etherip driver - - type: int + - arg_type: int name: tagidx description: |- etherip tag index - - type: str + - arg_type: str name: desc description: |- Template argument - - type: str + - arg_type: str name: tag description: |- etherip tag default: FlowRate - - type: str + - arg_type: str name: egu description: |- EGU default: Litres / Hour - - type: int + - arg_type: int name: prec description: |- PREC default: 1 - - type: int + - arg_type: int name: hopr description: |- HOPR default: 300 - - type: float + - arg_type: float name: lopr description: |- LOPR default: 0.0 - - type: int + - arg_type: int name: hihi description: |- HIHI default: 295 - - type: int + - arg_type: int name: lolo description: |- LOLO default: 100 - - type: int + - arg_type: int name: high description: |- HIGH default: 275 - - type: int + - arg_type: int name: adel description: |- ADEL default: 50 - - type: int + - arg_type: int name: mdel description: |- MDEL default: 10 - - type: int + - arg_type: int name: low description: |- LOW diff --git a/tests/samples/support/epics.ibek.support.yaml b/tests/samples/support/epics.ibek.support.yaml index a958af503..ed898df7d 100644 --- a/tests/samples/support/epics.ibek.support.yaml +++ b/tests/samples/support/epics.ibek.support.yaml @@ -5,7 +5,7 @@ defs: - name: EpicsCaMaxArrayBytes description: Set the maximum size in bytes for sending arrays over channel access args: - - type: int + - arg_type: int name: max_bytes description: Max size in bytes for sending arrays over channel access default: 6000000 @@ -16,7 +16,7 @@ defs: - name: EpicsTsMinWest description: Set the relative time zone minutes West relative to GMT (+/-720) args: - - type: int + - arg_type: int name: minutes_west description: relative time zone minutes default: 0 @@ -27,10 +27,10 @@ defs: - name: dbpf description: Set a PV value after iocInit args: - - type: str + - arg_type: str name: pv description: Name of PV - - type: str + - arg_type: str name: value description: Value to set post_init: @@ -39,10 +39,10 @@ defs: - name: EpicsEnvSet description: Set an environment variable in the ioc Shell args: - - type: str + - arg_type: str name: name description: Name of environment variable - - type: str + - arg_type: str name: value description: Value of environment variable env_vars: @@ -52,33 +52,33 @@ defs: - name: StartupCommand description: Adds an arbitrary command in the startup script before iocInit args: - - type: str + - arg_type: str name: command description: command string default: "" pre_init: - - type: text + - arg_type: text value: "{{ command }}" - name: PostStartupCommand description: Adds an arbitrary command in the startup script after iocInit args: - - type: str + - arg_type: str name: command description: command string default: "" post_init: - - type: text + - arg_type: text value: "{{ command }}" - name: InterruptVectorVME description: Reserve a VME interrupt vector args: - - type: id + - arg_type: id name: name description: A name for an interrupt vector variable - - type: int + - arg_type: int name: count description: The number of interrupt vectors to reserve default: 1 diff --git a/tests/samples/support/gauges.ibek.support.yaml b/tests/samples/support/gauges.ibek.support.yaml index 53de9f46d..093c44679 100644 --- a/tests/samples/support/gauges.ibek.support.yaml +++ b/tests/samples/support/gauges.ibek.support.yaml @@ -9,15 +9,15 @@ defs: description: |- MKS 937b Gauge controller args: - - type: object + - arg_type: object name: port description: |- Asyn port that connects to the device - - type: id + - arg_type: id name: name description: |- name for the Device - - type: str + - arg_type: str name: P description: |- PV prefix @@ -26,28 +26,28 @@ defs: description: |- Group of gauges args: - - type: id + - arg_type: id name: name description: |- name for the - - type: object + - arg_type: object name: gauge1 description: |- First gauge - - type: object + - arg_type: object name: gauge2 description: |- Second gauge # default to the id of the gauge object we want as default default: |- {{gauge1.name}} - - type: object + - arg_type: object name: gauge3 description: |- Third gauge default: | {{gauge1.name}} - - type: object + - arg_type: object name: gauge4 description: |- Fourth gauge diff --git a/tests/samples/support/ipac.ibek.support.yaml b/tests/samples/support/ipac.ibek.support.yaml index 578ea3e2f..873ce8037 100644 --- a/tests/samples/support/ipac.ibek.support.yaml +++ b/tests/samples/support/ipac.ibek.support.yaml @@ -7,31 +7,31 @@ defs: description: |- Configure a Hytec 8002 Carrier card args: - - type: int + - arg_type: int name: slot description: |- VME Slot number - - type: id + - arg_type: id name: IPACid description: |- Identifier for this device default: IPAC{{ slot }} - - type: int + - arg_type: int name: intLevel description: |- VME Interrupt Level default: 2 - name: test - type: str + arg_type: str description: test default: | {{ slot }} - name: interrupt_vector - type: object + arg_type: object description: Interrupt Vector reserved with epics.InterruptVectorVME, count=1 values: @@ -49,12 +49,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: int + - arg_type: int name: slot description: |- VME Slot number - - type: enum + - arg_type: enum name: direction description: |- Direction of digital IO @@ -63,42 +63,42 @@ defs: Input: Output: - - type: int + - arg_type: int name: cardid description: |- cardid? - - type: int + - arg_type: int name: intLevel description: |- intLevel? default: 0 - - type: int + - arg_type: int name: clock description: |- clock? default: 0 - - type: int + - arg_type: int name: scan description: |- scan? default: 0 - - type: bool + - arg_type: bool name: invertin description: |- invertin? default: false - - type: bool + - arg_type: bool name: invertout description: |- invertout? default: false - - type: bool + - arg_type: bool name: ip_support description: |- ip_support? @@ -114,23 +114,23 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: int + - arg_type: int name: slot description: |- VME Slot number - - type: int + - arg_type: int name: cardnum description: |- Card number - - type: int + - arg_type: int name: int_level description: |- VME Interrupt Level default: 1 - - type: int + - arg_type: int name: hs_int description: |- Dunno actually @@ -144,12 +144,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: object + - arg_type: object name: parent description: |- Hy8005 card - - type: enum + - arg_type: enum name: ipslot description: |- IP slot @@ -159,12 +159,12 @@ defs: B: D: - - type: int + - arg_type: int name: cardnum description: |- EPICS card identification - - type: enum + - arg_type: enum name: debrate description: |- debrate @@ -175,7 +175,7 @@ defs: 100Hz: 500Hz: - - type: enum + - arg_type: enum name: pwidth description: |- pwidth @@ -192,7 +192,7 @@ defs: 50sec: 1msec: - - type: enum + - arg_type: enum name: scanrate description: |- scanrate @@ -203,7 +203,7 @@ defs: 10KHz: 1KHz: - - type: enum + - arg_type: enum name: direction description: |- direction @@ -214,7 +214,7 @@ defs: outputs: low out/high in: - - type: enum + - arg_type: enum name: clock description: |- clock @@ -223,13 +223,13 @@ defs: internal: external: - - type: bool + - arg_type: bool name: invertInputs description: |- invert inputs default: false - - type: bool + - arg_type: bool name: invertOutputs description: |- invert outputs diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index 8816da1e5..ab5507390 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -6,14 +6,14 @@ defs: description: |- The protagonist from Red Dwarf args: - - type: str + - arg_type: str name: quote description: |- most hated quote default: |- Smoke me a kipper, I'll be back for breakfast - - type: list + - arg_type: list name: friends description: |- List of friends diff --git a/tests/samples/support/motorSim.ibek.support.yaml b/tests/samples/support/motorSim.ibek.support.yaml index 3ea2df023..04e58ecff 100644 --- a/tests/samples/support/motorSim.ibek.support.yaml +++ b/tests/samples/support/motorSim.ibek.support.yaml @@ -11,27 +11,27 @@ defs: Creates a simulation motion controller args: - - type: id + - arg_type: id name: controllerName description: |- The name of the controller and its Asyn Port Name - - type: str + - arg_type: str name: P description: |- Device PV Prefix - - type: int + - arg_type: int name: numAxes description: |- The number of axes to create - - type: object + - arg_type: object name: port description: |- a reference to the asyn port for communication with the controller - - type: str + - arg_type: str name: DESC description: |- The description of the controller @@ -62,52 +62,52 @@ defs: Creates a simulation motor axis args: - - type: object + - arg_type: object name: controller description: |- a reference to the motion controller - - type: str + - arg_type: str name: M description: |- PV suffix for the motor record - - type: int + - arg_type: int name: ADDR description: |- The axis number (allowed to be from 0 to controller.numAxes-1) - - type: str + - arg_type: str name: DESC description: |- The description of the axis default: "Motor {{ADDR}}" - - type: int + - arg_type: int name: DLLM description: |- The low limit of the axis (in counts) default: -20000 - - type: int + - arg_type: int name: DHLM description: |- The high limit of the axis (in counts) default: 20000 - - type: int + - arg_type: int name: home description: |- The home position of the axis (in counts) default: 0 - - type: str # int or jinja string + - arg_type: str # int or jinja string name: start description: |- The starting position of the axis (in counts) default: "{{home}}" - - type: enum + - arg_type: enum name: DIR description: |- The direction of the axis @@ -116,25 +116,25 @@ defs: Pos: 0 Neg: 1 - - type: float + - arg_type: float name: VELO description: |- The velocity of the axis (in counts/sec) default: 10.0 - - type: str # float or jinja string + - arg_type: str # float or jinja string name: VMAX description: |- The maximum velocity of the axis (in counts/sec) default: "{{VELO}}" - - type: bool + - arg_type: bool name: is_cs description: |- Set to True if this axis a coordinate system axis default: false - - type: int + - arg_type: int name: CS_NUM description: |- The coordinate system number for this axis diff --git a/tests/samples/support/quadem.ibek.support.yaml b/tests/samples/support/quadem.ibek.support.yaml index e0336d23c..9ff4d37db 100644 --- a/tests/samples/support/quadem.ibek.support.yaml +++ b/tests/samples/support/quadem.ibek.support.yaml @@ -7,34 +7,34 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - type: id + - arg_type: id name: PORT description: |- Template argument - - type: str + - arg_type: str name: P description: |- Base name of PV. - - type: str + - arg_type: str name: R description: |- Second macro for name of PV. - - type: int + - arg_type: int name: QSIZE description: |- .. default: 20 - - type: int + - arg_type: int name: RING_SIZE description: |- .. default: 10000 - - type: str + - arg_type: str name: IP description: |- IP address of the TetrAMM device @@ -67,33 +67,33 @@ defs: 12 NDTimeSeries plugins 12 NDArray plugins args: - - type: object + - arg_type: object name: DEVICE description: |- Reference to the parent quadEM device - - type: id + - arg_type: id name: PORTPREFIX description: |- The prefix for plugin asyn port names - - type: int + - arg_type: int name: STAT_NCHAN description: |- Template argument - - type: int + - arg_type: int name: STAT_XSIZE description: |- Template argument - - type: int + - arg_type: int name: HIST_SIZE description: |- Template argument default: 256 - - type: int + - arg_type: int name: QUEUE description: |- length of NDArray queue diff --git a/tests/samples/support/technosoft.ibek.support.yaml b/tests/samples/support/technosoft.ibek.support.yaml index 731885ca8..3c5c54fb7 100644 --- a/tests/samples/support/technosoft.ibek.support.yaml +++ b/tests/samples/support/technosoft.ibek.support.yaml @@ -8,32 +8,32 @@ defs: Creates a Technosoft motion controller connected to a serial line args: - - type: id + - arg_type: id name: controllerName description: |- The name of the controller - - type: str + - arg_type: str name: P description: |- Device PV Prefix - - type: str + - arg_type: str name: TTY description: |- TTY - - type: int + - arg_type: int name: numAxes description: |- The number of axes to create default: 1 - - type: int + - arg_type: int name: hostid description: |- Host ID - - type: str + - arg_type: str name: CONFIG description: |- TML Configuration @@ -53,35 +53,35 @@ defs: Creates a motor axis args: - - type: object + - arg_type: object name: controller description: |- a reference to the motion controller - - type: str + - arg_type: str name: CHANNEL_PREFIX description: |- The axis prefix default: ax0 - - type: str + - arg_type: str name: CHANNEL_ID description: |- The axis ID default: MOT - - type: int + - arg_type: int name: axid description: |- The axis ID - - type: str + - arg_type: str name: axconf description: |- The axis configuration default: star_vat_phs.t.zip - - type: enum + - arg_type: enum name: homing description: |- Homing direction @@ -90,109 +90,109 @@ defs: LSN: LSP: - - type: int + - arg_type: int name: NSTEPS description: |- Number of steps default: 200 - - type: int + - arg_type: int name: NMICROSTEPS description: |- Number of microsteps default: 256 - - type: int + - arg_type: int name: VELO description: |- Velocity default: 20 - - type: float + - arg_type: float name: VELO_MIN description: |- Velocity min default: 0.1 - - type: float + - arg_type: float name: VELO_MAX description: |- Velocity Max default: 50 - - type: float + - arg_type: float name: ACCL description: |- Seconds to Velocity default: 0.5 - - type: float + - arg_type: float name: ACCL_MIN description: |- Seconds to Velocity default: 0.01 - - type: float + - arg_type: float name: ACCL_MAX description: |- Seconds to Velocity default: 1.5 - - type: float + - arg_type: float name: HAR description: |- Homing acceleration default: 0.5 - - type: float + - arg_type: float name: HVEL description: |- Homing Velocity default: 10 - - type: int + - arg_type: int name: JAR description: |- JAR default: 1 - - type: int + - arg_type: int name: JVEL description: |- JVEL default: 5 - - type: str + - arg_type: str name: EGU description: |- Engineering Units default: "ustep" - - type: float + - arg_type: float name: SLSP description: |- Limit default: 0.8 - - type: int + - arg_type: int name: ENABLED description: |- Enabled default: 1 - - type: int + - arg_type: int name: TIMEOUT description: |- Timeout default: 0 - - type: str + - arg_type: str name: ASYN_ADDR description: |- Asyn Addr? default: "0" - - type: str + - arg_type: str name: CONFIG description: |- Axis configuration string to add to the controller configuration diff --git a/tests/samples/support/utils.ibek.support.yaml b/tests/samples/support/utils.ibek.support.yaml index 187195157..4952dde51 100644 --- a/tests/samples/support/utils.ibek.support.yaml +++ b/tests/samples/support/utils.ibek.support.yaml @@ -10,7 +10,7 @@ defs: description: | Reserve an interrupt vector for use with VME hardware. args: - - type: id + - arg_type: id name: name description: A name for an interrupt vector variable @@ -27,17 +27,17 @@ defs: value: '{{ __utils__.counter("InterruptVector", start=192, stop=255) }}' pre_init: - - type: comment + - arg_type: comment value: global "magic" is {{ get_global }} - - type: comment + - arg_type: comment value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} - - type: comment + - arg_type: comment value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} - name: InterruptVectorVME2 description: naughty second use of same counter args: - - type: id + - arg_type: id name: name description: A name for an interrupt vector variable From ec460d8909c3ae4b818a66a2607e5bc9209f3bbb Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 18:23:48 +0000 Subject: [PATCH 07/24] add jinja capability to all arg types --- src/ibek/entity_factory.py | 21 +- tests/samples/iocs/listarg.ibek.ioc.yaml | 4 +- tests/samples/outputs/listarg/st.cmd | 18 + .../schemas/gauges.ibek.ioc.schema.json | 149 +- .../samples/schemas/listarg.ibek.schema.json | 18 +- .../schemas/motorSim.ibek.ioc.schema.json | 294 +- .../schemas/quadem.ibek.ioc.schema.json | 3823 ++++++++++++++--- .../schemas/single.ibek.ioc.schema.json | 145 +- .../schemas/technosoft.ibek.ioc.schema.json | 305 +- 9 files changed, 3894 insertions(+), 883 deletions(-) diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 1f2c1b47c..33904ce8e 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -63,7 +63,26 @@ def _make_entity_model( def add_arg(name, typ, description, default): if default is None: default = PydanticUndefined - args[name] = (Annotated[typ, Field(description=description)], default) + if typ in [str, object]: + args[name] = (Annotated[typ, Field(description=description)], default) + else: + args[name] = ( + Annotated[ + Annotated[ + str, + Field( + description=f"jinja that renders to {typ}", + pattern=r".*\{\{.*\}\}.*", + ), + ] + | Annotated[typ, Field(description=description)], + Field( + description=f"union of {typ} and jinja " + "representation of {typ}" + ), + ], + default, + ) args: Dict[str, Tuple[type, Any]] = {} validators: Dict[str, Any] = {} diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index aa1736d47..3efcff990 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -6,5 +6,5 @@ entities: - entity_type: listtest.lister friends: ["Rimmer", "Holly", "Cat", "Kryten"] - # - entity_entity_type: listtest.lister - # friends: '{{ ["Rimmer"] + ["tt"] | list }}' + - entity_type: listtest.lister + friends: '{{ ["Rimmer"] + ["tt"] | list }}' diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index 2701f037e..46f395569 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -10,6 +10,24 @@ Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has - Cat - Kryten First friend is Rimmer +Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: +- [ +- ' +- R +- i +- m +- m +- e +- r +- ' +- , +- +- ' +- t +- t +- ' +- ] +First friend is [ dbLoadRecords /epics/runtime/ioc.db iocInit diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json index 2eedcb5b6..26986e6e0 100644 --- a/tests/samples/schemas/gauges.ibek.ioc.schema.json +++ b/tests/samples/schemas/gauges.ibek.ioc.schema.json @@ -37,73 +37,168 @@ "type": "string" }, "priority": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Priority", + "type": "integer" + } + ], "default": 100, - "description": "Priority", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "noAuto_connect": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to stop auto_connect", + "type": "boolean" + } + ], "default": false, - "description": "Set to stop auto_connect", - "title": "Noauto Connect", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Noauto Connect" }, "noProcessEos": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to avoid processing end of string", + "type": "boolean" + } + ], "default": false, - "description": "Set to avoid processing end of string", - "title": "Noprocesseos", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Noprocesseos" }, "baud": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Baud Rate", + "type": "integer" + } + ], "default": 9600, - "description": "Baud Rate", - "title": "Baud", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Baud" }, "parity": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/parity" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/parity" + } + ], + "description": "Parity" } ], "default": "none", - "description": "Parity" + "description": "union of and jinja representation of {typ}", + "title": "Parity" }, "crtscts": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/crtscts" + "allOf": [ + { + "$ref": "#/$defs/crtscts" + } + ], + "description": "Set hardware flow control on" } ], "default": "N", - "description": "Set hardware flow control on" + "description": "union of and jinja representation of {typ}", + "title": "Crtscts" }, "stop": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/stop" + "allOf": [ + { + "$ref": "#/$defs/stop" + } + ], + "description": "Stop Bits" } ], "default": "1", - "description": "Stop Bits" + "description": "union of and jinja representation of {typ}", + "title": "Stop" }, "disconnectOnReadTimeout": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/disconnectOnReadTimeout" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/disconnectOnReadTimeout" + } + ], + "description": "Disconnect when a read times out" } ], "default": "Y", - "description": "Disconnect when a read times out" + "description": "union of and jinja representation of {typ}", + "title": "Disconnectonreadtimeout" }, "bits": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/bits" + "allOf": [ + { + "$ref": "#/$defs/bits" + } + ], + "description": "Bits" } ], "default": "8", - "description": "Bits" + "description": "union of and jinja representation of {typ}", + "title": "Bits" } }, "required": [ diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index e85afcf54..c0523a75b 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -21,10 +21,20 @@ "type": "string" }, "friends": { - "description": "List of friends", - "items": {}, - "title": "Friends", - "type": "array" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "List of friends", + "items": {}, + "type": "array" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Friends" } }, "required": [ diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json index 746616f7e..42fbb7b87 100644 --- a/tests/samples/schemas/motorSim.ibek.ioc.schema.json +++ b/tests/samples/schemas/motorSim.ibek.ioc.schema.json @@ -45,73 +45,168 @@ "type": "string" }, "priority": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Priority", + "type": "integer" + } + ], "default": 100, - "description": "Priority", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "noAuto_connect": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to stop auto_connect", + "type": "boolean" + } + ], "default": false, - "description": "Set to stop auto_connect", - "title": "Noauto Connect", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Noauto Connect" }, "noProcessEos": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to avoid processing end of string", + "type": "boolean" + } + ], "default": false, - "description": "Set to avoid processing end of string", - "title": "Noprocesseos", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Noprocesseos" }, "baud": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Baud Rate", + "type": "integer" + } + ], "default": 9600, - "description": "Baud Rate", - "title": "Baud", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Baud" }, "parity": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/parity" + "allOf": [ + { + "$ref": "#/$defs/parity" + } + ], + "description": "Parity" } ], "default": "none", - "description": "Parity" + "description": "union of and jinja representation of {typ}", + "title": "Parity" }, "crtscts": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/crtscts" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/crtscts" + } + ], + "description": "Set hardware flow control on" } ], "default": "N", - "description": "Set hardware flow control on" + "description": "union of and jinja representation of {typ}", + "title": "Crtscts" }, "stop": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/stop" + "allOf": [ + { + "$ref": "#/$defs/stop" + } + ], + "description": "Stop Bits" } ], "default": "1", - "description": "Stop Bits" + "description": "union of and jinja representation of {typ}", + "title": "Stop" }, "disconnectOnReadTimeout": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/disconnectOnReadTimeout" + "allOf": [ + { + "$ref": "#/$defs/disconnectOnReadTimeout" + } + ], + "description": "Disconnect when a read times out" } ], "default": "Y", - "description": "Disconnect when a read times out" + "description": "union of and jinja representation of {typ}", + "title": "Disconnectonreadtimeout" }, "bits": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/bits" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/bits" + } + ], + "description": "Bits" } ], "default": "8", - "description": "Bits" + "description": "union of and jinja representation of {typ}", + "title": "Bits" } }, "required": [ @@ -172,9 +267,19 @@ "type": "string" }, "ADDR": { - "description": "The axis number (allowed to be from 0 to controller.numAxes-1)", - "title": "Addr", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The axis number (allowed to be from 0 to controller.numAxes-1)", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "DESC": { "default": "Motor {{ADDR}}", @@ -183,22 +288,52 @@ "type": "string" }, "DLLM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The low limit of the axis (in counts)", + "type": "integer" + } + ], "default": -20000, - "description": "The low limit of the axis (in counts)", - "title": "Dllm", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Dllm" }, "DHLM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The high limit of the axis (in counts)", + "type": "integer" + } + ], "default": 20000, - "description": "The high limit of the axis (in counts)", - "title": "Dhlm", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Dhlm" }, "home": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The home position of the axis (in counts)", + "type": "integer" + } + ], "default": 0, - "description": "The home position of the axis (in counts)", - "title": "Home", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Home" }, "start": { "default": "{{home}}", @@ -207,19 +342,40 @@ "type": "string" }, "DIR": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/DIR" + "allOf": [ + { + "$ref": "#/$defs/DIR" + } + ], + "description": "The direction of the axis" } ], "default": 0, - "description": "The direction of the axis" + "description": "union of and jinja representation of {typ}", + "title": "Dir" }, "VELO": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The velocity of the axis (in counts/sec)", + "type": "number" + } + ], "default": 10.0, - "description": "The velocity of the axis (in counts/sec)", - "title": "Velo", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Velo" }, "VMAX": { "default": "{{VELO}}", @@ -228,16 +384,36 @@ "type": "string" }, "is_cs": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to True if this axis a coordinate system axis", + "type": "boolean" + } + ], "default": false, - "description": "Set to True if this axis a coordinate system axis", - "title": "Is Cs", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Is Cs" }, "CS_NUM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The coordinate system number for this axis", + "type": "integer" + } + ], "default": 0, - "description": "The coordinate system number for this axis", - "title": "Cs Num", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Cs Num" } }, "required": [ @@ -274,9 +450,19 @@ "type": "string" }, "numAxes": { - "description": "The number of axes to create", - "title": "Numaxes", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The number of axes to create", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Numaxes" }, "port": { "description": "a reference to the asyn port for communication with the controller", diff --git a/tests/samples/schemas/quadem.ibek.ioc.schema.json b/tests/samples/schemas/quadem.ibek.ioc.schema.json index d31a81cb4..005d163b3 100644 --- a/tests/samples/schemas/quadem.ibek.ioc.schema.json +++ b/tests/samples/schemas/quadem.ibek.ioc.schema.json @@ -34,55 +34,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn address of the callback source", + "type": "integer" + } + ], "default": 0, - "description": "Asyn address of the callback source", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 10000, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "N_CACHE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of NDArrays to store in cache", + "type": "integer" + } + ], "default": 10000, - "description": "Number of NDArrays to store in cache", - "title": "N Cache", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "N Cache" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "ATTR_IND": { "description": "Attribute index", @@ -153,61 +234,152 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_ATTRIBUTES": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number of attributes in this plugin", + "type": "integer" + } + ], "default": 8, - "description": "Maximum number of attributes in this plugin", - "title": "Max Attributes", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Attributes" }, "NCHANS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of points in the arrays", + "type": "integer" + } + ], "default": 4096, - "description": "Number of points in the arrays", - "title": "Nchans", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nchans" }, "TS_PORT": { "default": "$(PORT)_TS", @@ -260,31 +432,64 @@ "type": "string" }, "type": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/type" + "allOf": [ + { + "$ref": "#/$defs/type" + } + ], + "description": "Where the data should be picked up from" } ], "default": "EPICS_PV", - "description": "Where the data should be picked up from" + "description": "union of and jinja representation of {typ}", + "title": "Type" }, "dbrtype": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/dbrtype" + "allOf": [ + { + "$ref": "#/$defs/dbrtype" + } + ], + "description": "DBR type (only used if type=EPICS_PV)" } ], "default": "DBR_NATIVE", - "description": "DBR type (only used if type=EPICS_PV)" + "description": "union of and jinja representation of {typ}", + "title": "Dbrtype" }, "datatype": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/datatype" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/datatype" + } + ], + "description": "Data type (only used if type=PARAM)" } ], "default": "INT", - "description": "Data type (only used if type=PARAM)" + "description": "union of and jinja representation of {typ}", + "title": "Datatype" }, "description": { "description": "Description of the attribute", @@ -292,10 +497,20 @@ "type": "string" }, "addr": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn address of the parameter (only used if type=PARAM)", + "type": "integer" + } + ], "default": 0, - "description": "Asyn address of the parameter (only used if type=PARAM)", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" } }, "required": [ @@ -343,67 +558,168 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 1, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "PRECOUNT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Pre-trigger frame count", + "type": "integer" + } + ], "default": 100, - "description": "Pre-trigger frame count", - "title": "Precount", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Precount" }, "POSTCOUNT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Post-trigger frame count", + "type": "integer" + } + ], "default": 100, - "description": "Post-trigger frame count", - "title": "Postcount", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Postcount" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 50, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_BUFFERS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max buffer size in number of frames", + "type": "integer" + } + ], "default": 128, - "description": "Max buffer size in number of frames", - "title": "Max Buffers", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Buffers" } }, "required": [ @@ -450,55 +766,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn timeout", + "type": "integer" + } + ], "default": 1, - "description": "Asyn timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -545,55 +942,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -645,79 +1123,200 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn port timeout", + "type": "integer" + } + ], "default": 1, - "description": "Asyn port timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "TIME_LINK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Time in seconds between points (Can point to a record - use CP)", + "type": "number" + } + ], "default": 0.1, - "description": "Time in seconds between points (Can point to a record - use CP)", - "title": "Time Link", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Time Link" }, "NAME": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Label for signal", + "type": "integer" + } + ], "default": 0, - "description": "Label for signal", - "title": "Name", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Name" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "PRIORITY": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Thread priority if ASYN_CANBLOCK is set", + "type": "integer" + } + ], "default": 0, - "description": "Thread priority if ASYN_CANBLOCK is set", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "STACKSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Stack size if ASYN_CANBLOCK is set", + "type": "integer" + } + ], "default": 0, - "description": "Stack size if ASYN_CANBLOCK is set", - "title": "Stacksize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Stacksize" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -765,55 +1364,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port timeout", + "type": "integer" + } + ], "default": 1, - "description": "Asyn Port timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "XMLSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of elements of the XML layout waveform record", + "type": "integer" + } + ], "default": 2048, - "description": "Number of elements of the XML layout waveform record", - "title": "Xmlsize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Xmlsize" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -860,49 +1540,120 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -949,49 +1700,120 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1038,49 +1860,120 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1127,49 +2020,120 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1216,49 +2180,120 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1305,49 +2340,120 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1385,55 +2491,136 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input Array Address", + "type": "integer" + } + ], "default": 0, - "description": "Input Array Address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_PORTS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number of ports that this plugin can connect to for callbacks", + "type": "integer" + } + ], "default": 5, - "description": "Maximum number of ports that this plugin can connect to for callbacks", - "title": "Max Ports", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Ports" }, "P": { "description": "Device Prefix", @@ -1481,49 +2668,120 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input Array Address", + "type": "integer" + } + ], "default": 0, - "description": "Input Array Address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "P": { "description": "Device Prefix", @@ -1592,55 +2850,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" }, "O": { "description": "NDOverlay Device Suffix", @@ -1753,61 +3092,152 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn timeout", + "type": "integer" + } + ], "default": 1, - "description": "Asyn timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "PRIORITY": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max buffers to allocate", + "type": "integer" + } + ], "default": 0, - "description": "Max buffers to allocate", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "STACKSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max buffers to allocate", + "type": "integer" + } + ], "default": 0, - "description": "Max buffers to allocate", - "title": "Stacksize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Stacksize" } }, "required": [ @@ -1854,49 +3284,120 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -1948,61 +3449,152 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn timeout", + "type": "integer" + } + ], "default": 1, - "description": "Asyn timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "PRIORITY": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max buffers to allocate", + "type": "integer" + } + ], "default": 0, - "description": "Max buffers to allocate", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "STACKSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max buffers to allocate", + "type": "integer" + } + ], "default": 0, - "description": "Max buffers to allocate", - "title": "Stacksize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Stacksize" } }, "required": [ @@ -2050,55 +3642,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -2145,67 +3818,168 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "asyn address on port", + "type": "integer" + } + ], "default": 0, - "description": "asyn address on port", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_ROIS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number of ROIs in this plugin", + "type": "integer" + } + ], "default": 8, - "description": "Maximum number of ROIs in this plugin", - "title": "Max Rois", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Rois" }, "NCHANS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of points in the arrays", + "type": "integer" + } + ], "default": 4096, - "description": "Number of points in the arrays", - "title": "Nchans", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nchans" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -2252,55 +4026,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "NAME": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Label for signal", + "type": "integer" + } + ], "default": 0, - "description": "Label for signal", - "title": "Name", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Name" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" } }, "required": [ @@ -2337,9 +4192,19 @@ "title": "Ndarray Port" }, "HIST_SIZE": { - "description": "Maximum size of Pixel binning histogram (e.g. 256 for Int8)", - "title": "Hist Size", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum size of Pixel binning histogram (e.g. 256 for Int8)", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Hist Size" }, "P": { "description": "Device Prefix", @@ -2352,71 +4217,182 @@ "type": "string" }, "XSIZE": { - "description": "XSIZE, Maximum size of X histograms (e.g. 1024)", - "title": "Xsize", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "XSIZE, Maximum size of X histograms (e.g. 1024)", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Xsize" }, "YSIZE": { - "description": "Maximum size of Y histograms (e.g. 768)", - "title": "Ysize", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum size of Y histograms (e.g. 768)", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Ysize" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "NCHANS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum length of time series (initialises waveform NELM, fixed on IOC boot)", + "type": "integer" + } + ], "default": 2048, - "description": "Maximum length of time series (initialises waveform NELM, fixed on IOC boot)", - "title": "Nchans", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nchans" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "TS_PORT": { "default": "$(PORT)_TS", @@ -2477,68 +4453,170 @@ "type": "string" }, "FTVL": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/FTVL" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/FTVL" + } + ], + "description": "Field Type of Value" } ], - "description": "Field Type of Value" + "description": "union of and jinja representation of {typ}", + "title": "Ftvl" }, "NELEMENTS": { - "description": "Number of elements", - "title": "Nelements", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of elements", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Nelements" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -2593,73 +4671,184 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "TIME_LINK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Time between points (Can point to a record - use CP)", + "type": "number" + } + ], "default": 0.1, - "description": "Time between points (Can point to a record - use CP)", - "title": "Time Link", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Time Link" }, "NSIGNALS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number of time series signals", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number of time series signals", - "title": "Nsignals", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nsignals" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "PRIORITY": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Thread priority if ASYN_CANBLOCK is set", + "type": "integer" + } + ], "default": 0, - "description": "Thread priority if ASYN_CANBLOCK is set", - "title": "Priority", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Priority" }, "STACKSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Stack size if ASYN_CANBLOCK is set", + "type": "integer" + } + ], "default": 0, - "description": "Stack size if ASYN_CANBLOCK is set", - "title": "Stacksize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Stacksize" }, "NAME": { "description": "Name of the signal", @@ -2713,55 +4902,136 @@ "title": "Ndarray Port" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array port address", + "type": "integer" + } + ], "default": 0, - "description": "Input array port address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/SCANRATE" + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input array queue size", + "type": "integer" + } + ], "default": 2, - "description": "Input array queue size", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" }, "BLOCK": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Blocking callbacks?", + "type": "integer" + } + ], "default": 0, - "description": "Blocking callbacks?", - "title": "Block", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Block" }, "MAX_THREADS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Maximum number threads", + "type": "integer" + } + ], "default": 1, - "description": "Maximum number threads", - "title": "Max Threads", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Max Threads" } }, "required": [ @@ -2809,49 +5079,120 @@ "type": "string" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 1, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Asyn Port address", + "type": "integer" + } + ], "default": 0, - "description": "Asyn Port address", - "title": "Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "NDARRAY_ADDR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Input Array Address", + "type": "integer" + } + ], "default": 0, - "description": "Input Array Address", - "title": "Ndarray Addr", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ndarray Addr" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Plugin Enabled at startup?", + "type": "integer" + } + ], "default": 0, - "description": "Plugin Enabled at startup?", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "SCANRATE": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/SCANRATE" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/SCANRATE" + } + ], + "description": "Specified scan rate for cpu intensive PVs" } ], "default": "I/O Intr", - "description": "Specified scan rate for cpu intensive PVs" + "description": "union of and jinja representation of {typ}", + "title": "Scanrate" }, "PRECOUNT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Pre-trigger frame count", + "type": "integer" + } + ], "default": 100, - "description": "Pre-trigger frame count", - "title": "Precount", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Precount" }, "POSTCOUNT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Post-trigger frame count", + "type": "integer" + } + ], "default": 100, - "description": "Post-trigger frame count", - "title": "Postcount", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Postcount" } }, "required": [ @@ -2943,26 +5284,66 @@ "type": "string" }, "STAT_NCHAN": { - "description": "Template argument", - "title": "Stat Nchan", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Template argument", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Stat Nchan" }, "STAT_XSIZE": { - "description": "Template argument", - "title": "Stat Xsize", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Template argument", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Stat Xsize" }, "HIST_SIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Template argument", + "type": "integer" + } + ], "default": 256, - "description": "Template argument", - "title": "Hist Size", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Hist Size" }, "QUEUE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "length of NDArray queue", + "type": "integer" + } + ], "default": 16, - "description": "length of NDArray queue", - "title": "Queue", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Queue" } }, "required": [ @@ -3005,16 +5386,36 @@ "type": "string" }, "QSIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "..", + "type": "integer" + } + ], "default": 20, - "description": "..", - "title": "Qsize", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Qsize" }, "RING_SIZE": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "..", + "type": "integer" + } + ], "default": 10000, - "description": "..", - "title": "Ring Size", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Ring Size" }, "IP": { "description": "IP address of the TetrAMM device", diff --git a/tests/samples/schemas/single.ibek.ioc.schema.json b/tests/samples/schemas/single.ibek.ioc.schema.json index 941efa439..72af9f2bc 100644 --- a/tests/samples/schemas/single.ibek.ioc.schema.json +++ b/tests/samples/schemas/single.ibek.ioc.schema.json @@ -32,9 +32,19 @@ "type": "string" }, "ADDR": { - "description": "The axis number (allowed to be from 0 to controller.numAxes-1)", - "title": "Addr", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The axis number (allowed to be from 0 to controller.numAxes-1)", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Addr" }, "DESC": { "default": "Motor {{ADDR}}", @@ -43,22 +53,52 @@ "type": "string" }, "DLLM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The low limit of the axis (in counts)", + "type": "integer" + } + ], "default": -20000, - "description": "The low limit of the axis (in counts)", - "title": "Dllm", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Dllm" }, "DHLM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The high limit of the axis (in counts)", + "type": "integer" + } + ], "default": 20000, - "description": "The high limit of the axis (in counts)", - "title": "Dhlm", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Dhlm" }, "home": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The home position of the axis (in counts)", + "type": "integer" + } + ], "default": 0, - "description": "The home position of the axis (in counts)", - "title": "Home", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Home" }, "start": { "default": "{{home}}", @@ -67,19 +107,40 @@ "type": "string" }, "DIR": { - "allOf": [ + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { - "$ref": "#/$defs/DIR" + "allOf": [ + { + "$ref": "#/$defs/DIR" + } + ], + "description": "The direction of the axis" } ], "default": 0, - "description": "The direction of the axis" + "description": "union of and jinja representation of {typ}", + "title": "Dir" }, "VELO": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The velocity of the axis (in counts/sec)", + "type": "number" + } + ], "default": 10.0, - "description": "The velocity of the axis (in counts/sec)", - "title": "Velo", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Velo" }, "VMAX": { "default": "{{VELO}}", @@ -88,16 +149,36 @@ "type": "string" }, "is_cs": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Set to True if this axis a coordinate system axis", + "type": "boolean" + } + ], "default": false, - "description": "Set to True if this axis a coordinate system axis", - "title": "Is Cs", - "type": "boolean" + "description": "union of and jinja representation of {typ}", + "title": "Is Cs" }, "CS_NUM": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The coordinate system number for this axis", + "type": "integer" + } + ], "default": 0, - "description": "The coordinate system number for this axis", - "title": "Cs Num", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Cs Num" } }, "required": [ @@ -134,9 +215,19 @@ "type": "string" }, "numAxes": { - "description": "The number of axes to create", - "title": "Numaxes", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The number of axes to create", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Numaxes" }, "port": { "description": "a reference to the asyn port for communication with the controller", diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index c366e5552..32657675c 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -38,15 +38,35 @@ "type": "string" }, "numAxes": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The number of axes to create", + "type": "integer" + } + ], "default": 1, - "description": "The number of axes to create", - "title": "Numaxes", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Numaxes" }, "hostid": { - "description": "Host ID", - "title": "Hostid", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Host ID", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Hostid" }, "CONFIG": { "default": "FILE=/tmp/,NAXIS={{numAxes}},DEV_PATH={{TTY}},HOST_ID={{hostid}}", @@ -108,9 +128,19 @@ "type": "string" }, "axid": { - "description": "The axis ID", - "title": "Axid", - "type": "integer" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The axis ID", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Axid" }, "axconf": { "default": "star_vat_phs.t.zip", @@ -119,85 +149,216 @@ "type": "string" }, "homing": { - "allOf": [ + "anyOf": [ { - "$ref": "#/$defs/homing" + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "allOf": [ + { + "$ref": "#/$defs/homing" + } + ], + "description": "Homing direction" } ], "default": "LSN", - "description": "Homing direction" + "description": "union of and jinja representation of {typ}", + "title": "Homing" }, "NSTEPS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of steps", + "type": "integer" + } + ], "default": 200, - "description": "Number of steps", - "title": "Nsteps", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nsteps" }, "NMICROSTEPS": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Number of microsteps", + "type": "integer" + } + ], "default": 256, - "description": "Number of microsteps", - "title": "Nmicrosteps", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Nmicrosteps" }, "VELO": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Velocity", + "type": "integer" + } + ], "default": 20, - "description": "Velocity", - "title": "Velo", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Velo" }, "VELO_MIN": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Velocity min", + "type": "number" + } + ], "default": 0.1, - "description": "Velocity min", - "title": "Velo Min", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Velo Min" }, "VELO_MAX": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Velocity Max", + "type": "number" + } + ], "default": 50.0, - "description": "Velocity Max", - "title": "Velo Max", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Velo Max" }, "ACCL": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Seconds to Velocity", + "type": "number" + } + ], "default": 0.5, - "description": "Seconds to Velocity", - "title": "Accl", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Accl" }, "ACCL_MIN": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Seconds to Velocity", + "type": "number" + } + ], "default": 0.01, - "description": "Seconds to Velocity", - "title": "Accl Min", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Accl Min" }, "ACCL_MAX": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Seconds to Velocity", + "type": "number" + } + ], "default": 1.5, - "description": "Seconds to Velocity", - "title": "Accl Max", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Accl Max" }, "HAR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Homing acceleration", + "type": "number" + } + ], "default": 0.5, - "description": "Homing acceleration", - "title": "Har", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Har" }, "HVEL": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Homing Velocity", + "type": "number" + } + ], "default": 10.0, - "description": "Homing Velocity", - "title": "Hvel", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Hvel" }, "JAR": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "JAR", + "type": "integer" + } + ], "default": 1, - "description": "JAR", - "title": "Jar", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Jar" }, "JVEL": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "JVEL", + "type": "integer" + } + ], "default": 5, - "description": "JVEL", - "title": "Jvel", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Jvel" }, "EGU": { "default": "ustep", @@ -206,22 +367,52 @@ "type": "string" }, "SLSP": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Limit", + "type": "number" + } + ], "default": 0.8, - "description": "Limit", - "title": "Slsp", - "type": "number" + "description": "union of and jinja representation of {typ}", + "title": "Slsp" }, "ENABLED": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Enabled", + "type": "integer" + } + ], "default": 1, - "description": "Enabled", - "title": "Enabled", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Enabled" }, "TIMEOUT": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Timeout", + "type": "integer" + } + ], "default": 0, - "description": "Timeout", - "title": "Timeout", - "type": "integer" + "description": "union of and jinja representation of {typ}", + "title": "Timeout" }, "ASYN_ADDR": { "default": "0", From 93b5f597ddf263bb4eaf65bcd6adfec7a505af65 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 20:53:00 +0000 Subject: [PATCH 08/24] convert jinja non strings back to their type --- src/ibek/entity_factory.py | 3 +- src/ibek/ioc.py | 15 +- tests/samples/iocs/ipac-test.ibek.ioc.yaml | 2 +- tests/samples/iocs/listarg.ibek.ioc.yaml | 3 +- tests/samples/outputs/listarg/st.cmd | 20 +- .../schemas/gauges.ibek.ioc.schema.json | 85 +-- .../schemas/motorSim.ibek.ioc.schema.json | 102 +--- .../schemas/quadem.ibek.ioc.schema.json | 527 ++++-------------- .../schemas/single.ibek.ioc.schema.json | 17 +- .../schemas/technosoft.ibek.ioc.schema.json | 17 +- tests/samples/support/epics.ibek.support.yaml | 2 +- 11 files changed, 155 insertions(+), 638 deletions(-) diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 33904ce8e..02faa2a78 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -63,7 +63,8 @@ def _make_entity_model( def add_arg(name, typ, description, default): if default is None: default = PydanticUndefined - if typ in [str, object]: + # cheesy check for enum, can this be improved? + if typ in [str, object] or "enum" in str(typ): args[name] = (Annotated[typ, Field(description=description)], default) else: args[name] = ( diff --git a/src/ibek/ioc.py b/src/ibek/ioc.py index 719d92052..8344626d9 100644 --- a/src/ibek/ioc.py +++ b/src/ibek/ioc.py @@ -5,6 +5,7 @@ from __future__ import annotations +import json from enum import Enum from typing import Any, Dict, List, Sequence @@ -71,7 +72,19 @@ def add_ibek_attributes(self): if isinstance(value, str): # Jinja expansion of any of the Entity's string args/values value = UTILS.render(entity_dict, value) - setattr(self, arg, str(value)) + # this is a cheesy test - any better ideas please let me know + if "Union" in str(model_field.annotation): + # Args that were non strings and have been rendered by Jinja + # must be coerced back into their original type + try: + # shame I need the replace - why are jinja an json disagreeing? + value = json.loads(value.replace("'", '"')) + except: + print( + f"ERROR: fail to decode {value} as a {model_field.annotation}" + ) + raise + setattr(self, arg, value) # update the entity_dict with the rendered value entity_dict[arg] = value diff --git a/tests/samples/iocs/ipac-test.ibek.ioc.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml index bd7695a27..e31fdba6a 100644 --- a/tests/samples/iocs/ipac-test.ibek.ioc.yaml +++ b/tests/samples/iocs/ipac-test.ibek.ioc.yaml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=file:///tmp/schema.json +# yaml-language-server: $schema=../schemas/ipac-test.ibek.schema.json ioc_name: ipac-test diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index 3efcff990..e35bcabd9 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -7,4 +7,5 @@ entities: friends: ["Rimmer", "Holly", "Cat", "Kryten"] - entity_type: listtest.lister - friends: '{{ ["Rimmer"] + ["tt"] | list }}' + friends: |- + {{ ["Rimmer"] + ["tt"] | list }} diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index 46f395569..d569681bb 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -11,23 +11,9 @@ Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has - Kryten First friend is Rimmer Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: -- [ -- ' -- R -- i -- m -- m -- e -- r -- ' -- , -- -- ' -- t -- t -- ' -- ] -First friend is [ +- Rimmer +- tt +First friend is Rimmer dbLoadRecords /epics/runtime/ioc.db iocInit diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json index 26986e6e0..f17e3dde0 100644 --- a/tests/samples/schemas/gauges.ibek.ioc.schema.json +++ b/tests/samples/schemas/gauges.ibek.ioc.schema.json @@ -101,104 +101,49 @@ "title": "Baud" }, "parity": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/parity" - } - ], - "description": "Parity" + "$ref": "#/$defs/parity" } ], "default": "none", - "description": "union of and jinja representation of {typ}", - "title": "Parity" + "description": "Parity" }, "crtscts": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/crtscts" - } - ], - "description": "Set hardware flow control on" + "$ref": "#/$defs/crtscts" } ], "default": "N", - "description": "union of and jinja representation of {typ}", - "title": "Crtscts" + "description": "Set hardware flow control on" }, "stop": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/stop" - } - ], - "description": "Stop Bits" + "$ref": "#/$defs/stop" } ], "default": "1", - "description": "union of and jinja representation of {typ}", - "title": "Stop" + "description": "Stop Bits" }, "disconnectOnReadTimeout": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/disconnectOnReadTimeout" - } - ], - "description": "Disconnect when a read times out" + "$ref": "#/$defs/disconnectOnReadTimeout" } ], "default": "Y", - "description": "union of and jinja representation of {typ}", - "title": "Disconnectonreadtimeout" + "description": "Disconnect when a read times out" }, "bits": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/bits" - } - ], - "description": "Bits" + "$ref": "#/$defs/bits" } ], "default": "8", - "description": "union of and jinja representation of {typ}", - "title": "Bits" + "description": "Bits" } }, "required": [ diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json index 42fbb7b87..90ece21d3 100644 --- a/tests/samples/schemas/motorSim.ibek.ioc.schema.json +++ b/tests/samples/schemas/motorSim.ibek.ioc.schema.json @@ -109,104 +109,49 @@ "title": "Baud" }, "parity": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/parity" - } - ], - "description": "Parity" + "$ref": "#/$defs/parity" } ], "default": "none", - "description": "union of and jinja representation of {typ}", - "title": "Parity" + "description": "Parity" }, "crtscts": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/crtscts" - } - ], - "description": "Set hardware flow control on" + "$ref": "#/$defs/crtscts" } ], "default": "N", - "description": "union of and jinja representation of {typ}", - "title": "Crtscts" + "description": "Set hardware flow control on" }, "stop": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/stop" - } - ], - "description": "Stop Bits" + "$ref": "#/$defs/stop" } ], "default": "1", - "description": "union of and jinja representation of {typ}", - "title": "Stop" + "description": "Stop Bits" }, "disconnectOnReadTimeout": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/disconnectOnReadTimeout" - } - ], - "description": "Disconnect when a read times out" + "$ref": "#/$defs/disconnectOnReadTimeout" } ], "default": "Y", - "description": "union of and jinja representation of {typ}", - "title": "Disconnectonreadtimeout" + "description": "Disconnect when a read times out" }, "bits": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/bits" - } - ], - "description": "Bits" + "$ref": "#/$defs/bits" } ], "default": "8", - "description": "union of and jinja representation of {typ}", - "title": "Bits" + "description": "Bits" } }, "required": [ @@ -342,24 +287,13 @@ "type": "string" }, "DIR": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/DIR" - } - ], - "description": "The direction of the axis" + "$ref": "#/$defs/DIR" } ], "default": 0, - "description": "union of and jinja representation of {typ}", - "title": "Dir" + "description": "The direction of the axis" }, "VELO": { "anyOf": [ diff --git a/tests/samples/schemas/quadem.ibek.ioc.schema.json b/tests/samples/schemas/quadem.ibek.ioc.schema.json index 005d163b3..404a85e08 100644 --- a/tests/samples/schemas/quadem.ibek.ioc.schema.json +++ b/tests/samples/schemas/quadem.ibek.ioc.schema.json @@ -98,24 +98,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -298,24 +287,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -432,64 +410,31 @@ "type": "string" }, "type": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/type" - } - ], - "description": "Where the data should be picked up from" + "$ref": "#/$defs/type" } ], "default": "EPICS_PV", - "description": "union of and jinja representation of {typ}", - "title": "Type" + "description": "Where the data should be picked up from" }, "dbrtype": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/dbrtype" - } - ], - "description": "DBR type (only used if type=EPICS_PV)" + "$ref": "#/$defs/dbrtype" } ], "default": "DBR_NATIVE", - "description": "union of and jinja representation of {typ}", - "title": "Dbrtype" + "description": "DBR type (only used if type=EPICS_PV)" }, "datatype": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/datatype" - } - ], - "description": "Data type (only used if type=PARAM)" + "$ref": "#/$defs/datatype" } ], "default": "INT", - "description": "union of and jinja representation of {typ}", - "title": "Datatype" + "description": "Data type (only used if type=PARAM)" }, "description": { "description": "Description of the attribute", @@ -622,24 +567,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "PRECOUNT": { "anyOf": [ @@ -830,24 +764,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -1006,24 +929,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -1187,24 +1099,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "TIME_LINK": { "anyOf": [ @@ -1428,24 +1329,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "XMLSIZE": { "anyOf": [ @@ -1604,24 +1494,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -1764,24 +1643,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -1924,24 +1792,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -2084,24 +1941,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -2212,24 +2058,13 @@ "title": "Addr" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "NDARRAY_ADDR": { "anyOf": [ @@ -2404,24 +2239,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -2555,24 +2379,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -2732,24 +2545,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -2914,24 +2716,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -3156,24 +2947,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -3348,24 +3128,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -3513,24 +3282,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -3706,24 +3464,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -3882,24 +3629,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -4090,24 +3826,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "NAME": { "anyOf": [ @@ -4375,24 +4100,13 @@ "title": "Max Threads" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "TS_PORT": { "default": "$(PORT)_TS", @@ -4453,23 +4167,12 @@ "type": "string" }, "FTVL": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/FTVL" - } - ], - "description": "Field Type of Value" + "$ref": "#/$defs/FTVL" } ], - "description": "union of and jinja representation of {typ}", - "title": "Ftvl" + "description": "Field Type of Value" }, "NELEMENTS": { "anyOf": [ @@ -4551,24 +4254,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -4735,24 +4427,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "TIME_LINK": { "anyOf": [ @@ -4966,24 +4647,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ + "allOf": [ { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "QUEUE": { "anyOf": [ @@ -5143,24 +4813,13 @@ "title": "Enabled" }, "SCANRATE": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/SCANRATE" - } - ], - "description": "Specified scan rate for cpu intensive PVs" + "$ref": "#/$defs/SCANRATE" } ], "default": "I/O Intr", - "description": "union of and jinja representation of {typ}", - "title": "Scanrate" + "description": "Specified scan rate for cpu intensive PVs" }, "PRECOUNT": { "anyOf": [ diff --git a/tests/samples/schemas/single.ibek.ioc.schema.json b/tests/samples/schemas/single.ibek.ioc.schema.json index 72af9f2bc..05b18d4ba 100644 --- a/tests/samples/schemas/single.ibek.ioc.schema.json +++ b/tests/samples/schemas/single.ibek.ioc.schema.json @@ -107,24 +107,13 @@ "type": "string" }, "DIR": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/DIR" - } - ], - "description": "The direction of the axis" + "$ref": "#/$defs/DIR" } ], "default": 0, - "description": "union of and jinja representation of {typ}", - "title": "Dir" + "description": "The direction of the axis" }, "VELO": { "anyOf": [ diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index 32657675c..6fe7dafbd 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -149,24 +149,13 @@ "type": "string" }, "homing": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, + "allOf": [ { - "allOf": [ - { - "$ref": "#/$defs/homing" - } - ], - "description": "Homing direction" + "$ref": "#/$defs/homing" } ], "default": "LSN", - "description": "union of and jinja representation of {typ}", - "title": "Homing" + "description": "Homing direction" }, "NSTEPS": { "anyOf": [ diff --git a/tests/samples/support/epics.ibek.support.yaml b/tests/samples/support/epics.ibek.support.yaml index ed898df7d..d77d5c844 100644 --- a/tests/samples/support/epics.ibek.support.yaml +++ b/tests/samples/support/epics.ibek.support.yaml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/1.5.0/ibek.support.schema.json +# yaml-language-server: $schema=../schemas/bek.support.schema.json module: epics defs: From 4dbb7381783a455a3f625407a4139cba169ac7ab Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 21:11:10 +0000 Subject: [PATCH 09/24] tidy schemas and generate_samples.sh --- tests/generate_samples.sh | 53 +- tests/samples/iocs/ipac-test.ibek.ioc.yaml | 2 +- .../samples/schemas/ipac.ibek.ioc.schema.json | 853 ++++++++++++++++++ 3 files changed, 897 insertions(+), 11 deletions(-) create mode 100644 tests/samples/schemas/ipac.ibek.ioc.schema.json diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index 6c607649d..7de9d1fad 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -23,48 +23,78 @@ set -e mkdir -p epics/pvi-defs cp support/simple.pvi.device.yaml epics/pvi-defs/simple.pvi.device.yaml +# general schema for all support yaml ###################################### + echo making the support yaml schema ibek support generate-schema --output schemas/ibek.support.schema.json + +############################################################################ +# motorSim example +############################################################################ + echo making an ioc schema using just motorSim support yaml ibek ioc generate-schema --no-ibek-defs support/motorSim.ibek.support.yaml --output schemas/single.ibek.ioc.schema.json echo making an ioc schema using motorSim and Asyn support yaml ibek ioc generate-schema --no-ibek-defs support/asyn.ibek.support.yaml support/motorSim.ibek.support.yaml --output schemas/motorSim.ibek.ioc.schema.json -echo making an ioc schema using utils support yaml -ibek ioc generate-schema --no-ibek-defs support/utils.ibek.support.yaml --output schemas/utils.ibek.ioc.schema.json - -echo making an ioc schema using asyn and gauges support yaml -ibek ioc generate-schema --no-ibek-defs support/asyn.ibek.support.yaml support/gauges.ibek.support.yaml --output schemas/gauges.ibek.ioc.schema.json - -echo making an ioc schema using ADCore and quadem support yaml -ibek ioc generate-schema --no-ibek-defs support/ADCore.ibek.support.yaml support/quadem.ibek.support.yaml --output schemas/quadem.ibek.ioc.schema.json - echo making ioc based on ibek-mo-ioc-01.yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/motorSim.ibek.ioc.yaml support/asyn.ibek.support.yaml support/motorSim.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/motorSim + +############################################################################ +# utils example +############################################################################ + +echo making an ioc schema using utils support yaml +ibek ioc generate-schema --no-ibek-defs support/utils.ibek.support.yaml --output schemas/utils.ibek.ioc.schema.json + echo making ioc based on utils support yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/utils.ibek.ioc.yaml support/utils.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/utils + +############################################################################ +# ipac example +############################################################################ + +echo making an ioc schema using utils support yaml +ibek ioc generate-schema --no-ibek-defs support/ipac.ibek.support.yaml support/epics.ibek.support.yaml --output schemas/ipac.ibek.ioc.schema.json + echo making ioc based on ipac support yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/ipac-test.ibek.ioc.yaml support/ipac.ibek.support.yaml support/epics.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/ipac-test + +############################################################################ +# gauges example +############################################################################ + +echo making an ioc schema using asyn and gauges support yaml +ibek ioc generate-schema --no-ibek-defs support/asyn.ibek.support.yaml support/gauges.ibek.support.yaml --output schemas/gauges.ibek.ioc.schema.json + echo making ioc based on gauges support yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/gauges.ibek.ioc.yaml support/asyn.ibek.support.yaml support/gauges.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/gauges + +############################################################################ +# quadem example +############################################################################ + +echo making an ioc schema using ADCore and quadem support yaml +ibek ioc generate-schema --no-ibek-defs support/ADCore.ibek.support.yaml support/quadem.ibek.support.yaml --output schemas/quadem.ibek.ioc.schema.json + echo making ioc based on quadem support yaml EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/quadem.ibek.ioc.yaml support/ADCore.ibek.support.yaml support/quadem.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/quadem ############################################################################ - # technosoft motor example +############################################################################ echo making an ioc schema using technosoft support yaml ibek ioc generate-schema --no-ibek-defs support/technosoft.ibek.support.yaml --output schemas/technosoft.ibek.ioc.schema.json @@ -73,7 +103,10 @@ echo making techosoft ioc EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/technosoft.ibek.ioc.yaml support/technosoft.ibek.support.yaml mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/technosoft + +############################################################################ # list example +############################################################################ echo making an ioc schema using listarg support yaml ibek ioc generate-schema --no-ibek-defs support/listarg.ibek.support.yaml --output schemas/listarg.ibek.schema.json diff --git a/tests/samples/iocs/ipac-test.ibek.ioc.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml index e31fdba6a..47c83b62c 100644 --- a/tests/samples/iocs/ipac-test.ibek.ioc.yaml +++ b/tests/samples/iocs/ipac-test.ibek.ioc.yaml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=../schemas/ipac-test.ibek.schema.json +# yaml-language-server: $schema=../schemas/ipac.ibek.ioc.schema.json ioc_name: ipac-test diff --git a/tests/samples/schemas/ipac.ibek.ioc.schema.json b/tests/samples/schemas/ipac.ibek.ioc.schema.json new file mode 100644 index 000000000..f8fbf5029 --- /dev/null +++ b/tests/samples/schemas/ipac.ibek.ioc.schema.json @@ -0,0 +1,853 @@ +{ + "$defs": { + "clock": { + "enum": [ + "internal", + "external" + ], + "title": "clock", + "type": "string" + }, + "debrate": { + "enum": [ + "No_Debounce", + "1KHz", + "200Hz", + "100Hz", + "500Hz" + ], + "title": "debrate", + "type": "string" + }, + "epics_EpicsCaMaxArrayBytes": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.EpicsCaMaxArrayBytes", + "description": "Set the maximum size in bytes for sending arrays over channel access", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "max_bytes": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Max size in bytes for sending arrays over channel access", + "type": "integer" + } + ], + "default": 6000000, + "description": "union of and jinja representation of {typ}", + "title": "Max Bytes" + } + }, + "required": [ + "entity_type" + ], + "title": "epics_EpicsCaMaxArrayBytes", + "type": "object" + }, + "epics_EpicsEnvSet": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.EpicsEnvSet", + "description": "Set an environment variable in the ioc Shell", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "name": { + "description": "Name of environment variable", + "title": "Name", + "type": "string" + }, + "value": { + "description": "Value of environment variable", + "title": "Value", + "type": "string" + } + }, + "required": [ + "entity_type", + "name", + "value" + ], + "title": "epics_EpicsEnvSet", + "type": "object" + }, + "epics_EpicsTsMinWest": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.EpicsTsMinWest", + "description": "Set the relative time zone minutes West relative to GMT (+/-720)", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "minutes_west": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "relative time zone minutes", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Minutes West" + } + }, + "required": [ + "entity_type" + ], + "title": "epics_EpicsTsMinWest", + "type": "object" + }, + "epics_InterruptVectorVME": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.InterruptVectorVME", + "description": "Reserve a VME interrupt vector", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "name": { + "description": "A name for an interrupt vector variable", + "title": "Name", + "type": "string" + }, + "count": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "The number of interrupt vectors to reserve", + "type": "integer" + } + ], + "default": 1, + "description": "union of and jinja representation of {typ}", + "title": "Count" + }, + "number": { + "default": "{{ __utils__.counter(\"InterruptVector\", start=192, stop=255, inc=count) }}", + "description": "Interrupt Vector number", + "title": "Number", + "type": "string" + } + }, + "required": [ + "entity_type", + "name" + ], + "title": "epics_InterruptVectorVME", + "type": "object" + }, + "epics_PostStartupCommand": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.PostStartupCommand", + "description": "Adds an arbitrary command in the startup script after iocInit", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "command": { + "default": "", + "description": "command string", + "title": "Command", + "type": "string" + } + }, + "required": [ + "entity_type" + ], + "title": "epics_PostStartupCommand", + "type": "object" + }, + "epics_StartupCommand": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.StartupCommand", + "description": "Adds an arbitrary command in the startup script before iocInit", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "command": { + "default": "", + "description": "command string", + "title": "Command", + "type": "string" + } + }, + "required": [ + "entity_type" + ], + "title": "epics_StartupCommand", + "type": "object" + }, + "epics_dbpf": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "epics.dbpf", + "description": "Set a PV value after iocInit", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "pv": { + "description": "Name of PV", + "title": "Pv", + "type": "string" + }, + "value": { + "description": "Value to set", + "title": "Value", + "type": "string" + } + }, + "required": [ + "entity_type", + "pv", + "value" + ], + "title": "epics_dbpf", + "type": "object" + }, + "ibek__entity_factory__direction__1": { + "enum": [ + "Mixed", + "Input", + "Output" + ], + "title": "direction", + "type": "string" + }, + "ibek__entity_factory__direction__2": { + "enum": [ + "inputs", + "low in/high out", + "outputs", + "low out/high in" + ], + "title": "direction", + "type": "string" + }, + "ipac_Hy8001": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "ipac.Hy8001", + "description": "TODO:ADD DESCRIPTION", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "slot": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "VME Slot number", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Slot" + }, + "direction": { + "allOf": [ + { + "$ref": "#/$defs/ibek__entity_factory__direction__1" + } + ], + "description": "Direction of digital IO" + }, + "cardid": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "cardid?", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Cardid" + }, + "intLevel": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "intLevel?", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Intlevel" + }, + "clock": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "clock?", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Clock" + }, + "scan": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "scan?", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Scan" + }, + "invertin": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "invertin?", + "type": "boolean" + } + ], + "default": false, + "description": "union of and jinja representation of {typ}", + "title": "Invertin" + }, + "invertout": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "invertout?", + "type": "boolean" + } + ], + "default": false, + "description": "union of and jinja representation of {typ}", + "title": "Invertout" + }, + "ip_support": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "ip_support?", + "type": "boolean" + } + ], + "default": false, + "description": "union of and jinja representation of {typ}", + "title": "Ip Support" + } + }, + "required": [ + "entity_type", + "slot", + "direction", + "cardid" + ], + "title": "ipac_Hy8001", + "type": "object" + }, + "ipac_Hy8002": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "ipac.Hy8002", + "description": "Configure a Hytec 8002 Carrier card", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "slot": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "VME Slot number", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Slot" + }, + "IPACid": { + "default": "IPAC{{ slot }}", + "description": "Identifier for this device", + "title": "Ipacid", + "type": "string" + }, + "intLevel": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "VME Interrupt Level", + "type": "integer" + } + ], + "default": 2, + "description": "union of and jinja representation of {typ}", + "title": "Intlevel" + }, + "test": { + "default": "{{ slot }}\n", + "description": "test", + "title": "Test", + "type": "string" + }, + "interrupt_vector": { + "description": "Interrupt Vector reserved with epics.InterruptVectorVME, count=1", + "title": "Interrupt Vector" + }, + "card_id": { + "default": "{{ __utils__.counter(\"Carriers\", start=0) }}", + "description": "Carrier Card Identifier", + "title": "Card Id", + "type": "string" + } + }, + "required": [ + "entity_type", + "slot", + "interrupt_vector" + ], + "title": "ipac_Hy8002", + "type": "object" + }, + "ipac_Hy8005": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "ipac.Hy8005", + "description": "TODO:ADD DESCRIPTION", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "slot": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "VME Slot number", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Slot" + }, + "cardnum": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Card number", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Cardnum" + }, + "int_level": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "VME Interrupt Level", + "type": "integer" + } + ], + "default": 1, + "description": "union of and jinja representation of {typ}", + "title": "Int Level" + }, + "hs_int": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Dunno actually", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Hs Int" + } + }, + "required": [ + "entity_type", + "slot", + "cardnum" + ], + "title": "ipac_Hy8005", + "type": "object" + }, + "ipac_Hy8005_Channel": { + "additionalProperties": false, + "properties": { + "entity_type": { + "const": "ipac.Hy8005_Channel", + "description": "TODO:ADD DESCRIPTION", + "title": "Entity Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "parent": { + "description": "Hy8005 card", + "title": "Parent" + }, + "ipslot": { + "allOf": [ + { + "$ref": "#/$defs/ipslot" + } + ], + "description": "IP slot" + }, + "cardnum": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "EPICS card identification", + "type": "integer" + } + ], + "description": "union of and jinja representation of {typ}", + "title": "Cardnum" + }, + "debrate": { + "allOf": [ + { + "$ref": "#/$defs/debrate" + } + ], + "description": "debrate" + }, + "pwidth": { + "allOf": [ + { + "$ref": "#/$defs/pwidth" + } + ], + "default": 0, + "description": "pwidth" + }, + "scanrate": { + "allOf": [ + { + "$ref": "#/$defs/scanrate" + } + ], + "default": 0, + "description": "scanrate" + }, + "direction": { + "allOf": [ + { + "$ref": "#/$defs/ibek__entity_factory__direction__2" + } + ], + "default": 0, + "description": "direction" + }, + "clock": { + "allOf": [ + { + "$ref": "#/$defs/clock" + } + ], + "default": 0, + "description": "clock" + }, + "invertInputs": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "invert inputs", + "type": "boolean" + } + ], + "default": false, + "description": "union of and jinja representation of {typ}", + "title": "Invertinputs" + }, + "invertOutputs": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "invert outputs", + "type": "boolean" + } + ], + "default": false, + "description": "union of and jinja representation of {typ}", + "title": "Invertoutputs" + } + }, + "required": [ + "entity_type", + "parent", + "ipslot", + "cardnum", + "debrate" + ], + "title": "ipac_Hy8005_Channel", + "type": "object" + }, + "ipslot": { + "enum": [ + "A", + "C", + "B", + "D" + ], + "title": "ipslot", + "type": "string" + }, + "pwidth": { + "enum": [ + "100sec", + "5sec", + "10sec", + "1sec", + "10msec", + "20sec", + "100msec", + "2sec", + "50sec", + "1msec" + ], + "title": "pwidth", + "type": "string" + }, + "scanrate": { + "enum": [ + "1MHz", + "100KHz", + "10KHz", + "1KHz" + ], + "title": "scanrate", + "type": "string" + } + }, + "additionalProperties": false, + "properties": { + "ioc_name": { + "description": "Name of IOC instance", + "title": "Ioc Name", + "type": "string" + }, + "description": { + "description": "Description of what the IOC does", + "title": "Description", + "type": "string" + }, + "entities": { + "description": "List of entities this IOC instantiates", + "items": { + "discriminator": { + "mapping": { + "epics.EpicsCaMaxArrayBytes": "#/$defs/epics_EpicsCaMaxArrayBytes", + "epics.EpicsEnvSet": "#/$defs/epics_EpicsEnvSet", + "epics.EpicsTsMinWest": "#/$defs/epics_EpicsTsMinWest", + "epics.InterruptVectorVME": "#/$defs/epics_InterruptVectorVME", + "epics.PostStartupCommand": "#/$defs/epics_PostStartupCommand", + "epics.StartupCommand": "#/$defs/epics_StartupCommand", + "epics.dbpf": "#/$defs/epics_dbpf", + "ipac.Hy8001": "#/$defs/ipac_Hy8001", + "ipac.Hy8002": "#/$defs/ipac_Hy8002", + "ipac.Hy8005": "#/$defs/ipac_Hy8005", + "ipac.Hy8005_Channel": "#/$defs/ipac_Hy8005_Channel" + }, + "propertyName": "entity_type" + }, + "oneOf": [ + { + "$ref": "#/$defs/ipac_Hy8002" + }, + { + "$ref": "#/$defs/ipac_Hy8001" + }, + { + "$ref": "#/$defs/ipac_Hy8005" + }, + { + "$ref": "#/$defs/ipac_Hy8005_Channel" + }, + { + "$ref": "#/$defs/epics_EpicsCaMaxArrayBytes" + }, + { + "$ref": "#/$defs/epics_EpicsTsMinWest" + }, + { + "$ref": "#/$defs/epics_dbpf" + }, + { + "$ref": "#/$defs/epics_EpicsEnvSet" + }, + { + "$ref": "#/$defs/epics_StartupCommand" + }, + { + "$ref": "#/$defs/epics_PostStartupCommand" + }, + { + "$ref": "#/$defs/epics_InterruptVectorVME" + } + ] + }, + "title": "Entities", + "type": "array" + }, + "shared": { + "default": [], + "description": "A place to create any anchors required for repeating YAML", + "items": {}, + "title": "Shared", + "type": "array" + } + }, + "required": [ + "ioc_name", + "description", + "entities" + ], + "title": "NewIOC", + "type": "object" +} \ No newline at end of file From f89354dd94533e26773d23ca13480309d6d2c9f3 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 21:16:39 +0000 Subject: [PATCH 10/24] change "entity_type" back to "type" --- src/ibek/entity_factory.py | 4 +- src/ibek/ioc.py | 2 +- src/ibek/ioc_factory.py | 2 +- src/ibek/sub_entity.py | 2 +- tests/samples/iocs/bad_counter.ibek.ioc.yaml | 4 +- tests/samples/iocs/bad_counter2.ibek.ioc.yaml | 8 +- tests/samples/iocs/bad_db.ibek.ioc.yaml | 2 +- tests/samples/iocs/bad_default.ibek.ioc.yaml | 2 +- tests/samples/iocs/bad_ref.ibek.ioc.yaml | 4 +- tests/samples/iocs/gauges.ibek.ioc.yaml | 12 +- tests/samples/iocs/ipac-test.ibek.ioc.yaml | 8 +- tests/samples/iocs/listarg.ibek.ioc.yaml | 4 +- tests/samples/iocs/motorSim.ibek.ioc.yaml | 16 +- tests/samples/iocs/quadem.ibek.ioc.yaml | 4 +- tests/samples/iocs/technosoft.ibek.ioc.yaml | 4 +- tests/samples/iocs/utils.ibek.ioc.yaml | 2 +- .../schemas/gauges.ibek.ioc.schema.json | 20 +- .../samples/schemas/ibek.support.schema.json | 6 +- .../samples/schemas/ipac.ibek.ioc.schema.json | 68 +++--- .../samples/schemas/listarg.ibek.schema.json | 8 +- .../schemas/motorSim.ibek.ioc.schema.json | 20 +- .../schemas/quadem.ibek.ioc.schema.json | 199 ++++++++---------- .../schemas/single.ibek.ioc.schema.json | 14 +- .../schemas/technosoft.ibek.ioc.schema.json | 14 +- .../schemas/utils.ibek.ioc.schema.json | 14 +- .../samples/support/ADCore.ibek.support.yaml | 2 +- .../samples/support/quadem.ibek.support.yaml | 4 +- tests/test_render.py | 30 ++- tests/test_unit.py | 8 +- 29 files changed, 234 insertions(+), 253 deletions(-) diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 02faa2a78..5d95e4f4e 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -139,7 +139,7 @@ def lookup_instance(cls, id): # add the type literal which discriminates between the different Entity classes typ = Literal[full_name] # type: ignore - args["entity_type"] = (typ, Field(description=definition.description)) + args["type"] = (typ, Field(description=definition.description)) class_name = full_name.replace(".", "_") entity_cls = create_model( @@ -187,7 +187,7 @@ def resolve_sub_entities(self, entities: List[Entity]) -> List[Entity]: # add in SubEntities if any for sub_entity in definition.sub_entities: # find the Entity Class that the SubEntity represents - entity_cls = self._entity_models[sub_entity.entity_type] + entity_cls = self._entity_models[sub_entity.type] # get the SubEntity arguments sub_args_dict = sub_entity.model_dump() # jinja render any references to parent Args in the SubEntity Args diff --git a/src/ibek/ioc.py b/src/ibek/ioc.py index 8344626d9..81186c90d 100644 --- a/src/ibek/ioc.py +++ b/src/ibek/ioc.py @@ -50,7 +50,7 @@ class Entity(BaseSettings): A baseclass for all generated Entity classes. """ - entity_type: str = Field(description="The type of this entity") + type: str = Field(description="The type of this entity") entity_enabled: bool = Field( description="enable or disable this entity instance", default=True ) diff --git a/src/ibek/ioc_factory.py b/src/ibek/ioc_factory.py index df1b30b57..7ebff476d 100644 --- a/src/ibek/ioc_factory.py +++ b/src/ibek/ioc_factory.py @@ -59,7 +59,7 @@ def make_ioc_model(self, entity_models: List[Type[Entity]]) -> Type[IOC]: """ entity_union = Union[tuple(entity_models)] # type: ignore - discriminated = Annotated[entity_union, Field(discriminator="entity_type")] # type: ignore + discriminated = Annotated[entity_union, Field(discriminator="type")] # type: ignore class NewIOC(IOC): entities: Sequence[discriminated] = Field( # type: ignore diff --git a/src/ibek/sub_entity.py b/src/ibek/sub_entity.py index c6fd41599..9d8cf23d8 100644 --- a/src/ibek/sub_entity.py +++ b/src/ibek/sub_entity.py @@ -8,7 +8,7 @@ class SubEntity(BaseModel, extra="allow"): section """ - entity_type: str = Field(description="The type of this entity") + type: str = Field(description="The type of this entity") entity_enabled: bool = Field( description="enable or disable this entity instance", default=True diff --git a/tests/samples/iocs/bad_counter.ibek.ioc.yaml b/tests/samples/iocs/bad_counter.ibek.ioc.yaml index e7a2ab679..fb6289d78 100644 --- a/tests/samples/iocs/bad_counter.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_counter.ibek.ioc.yaml @@ -3,7 +3,7 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - entity_type: epics.InterruptVectorVME + - type: epics.InterruptVectorVME name: Vec0 - - entity_type: epics.InterruptVectorVME2 + - type: epics.InterruptVectorVME2 name: Vec1 diff --git a/tests/samples/iocs/bad_counter2.ibek.ioc.yaml b/tests/samples/iocs/bad_counter2.ibek.ioc.yaml index f6f6ae188..b3e4af463 100644 --- a/tests/samples/iocs/bad_counter2.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_counter2.ibek.ioc.yaml @@ -3,11 +3,11 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - entity_type: epics.InterruptVectorVME2 + - type: epics.InterruptVectorVME2 name: Vec1 - - entity_type: epics.InterruptVectorVME2 + - type: epics.InterruptVectorVME2 name: Vec2 - - entity_type: epics.InterruptVectorVME2 + - type: epics.InterruptVectorVME2 name: Vec3 - - entity_type: epics.InterruptVectorVME2 + - type: epics.InterruptVectorVME2 name: Vec4 diff --git a/tests/samples/iocs/bad_db.ibek.ioc.yaml b/tests/samples/iocs/bad_db.ibek.ioc.yaml index 315cd8a04..9c18bcdc7 100644 --- a/tests/samples/iocs/bad_db.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_db.ibek.ioc.yaml @@ -2,5 +2,5 @@ ioc_name: test-bad-db-ioc description: demo bad database definition entities: - - entity_type: object_module.RefObject + - type: object_module.RefObject name: Ref1 diff --git a/tests/samples/iocs/bad_default.ibek.ioc.yaml b/tests/samples/iocs/bad_default.ibek.ioc.yaml index c8a57187f..c1b5fc4e3 100644 --- a/tests/samples/iocs/bad_default.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_default.ibek.ioc.yaml @@ -5,5 +5,5 @@ description: an example for testing missing non-default values entities: # deliberately do not specify port to test failure case - - entity_type: asyn.AsynIP + - type: asyn.AsynIP name: controllerOnePort diff --git a/tests/samples/iocs/bad_ref.ibek.ioc.yaml b/tests/samples/iocs/bad_ref.ibek.ioc.yaml index b4a4bcaf5..0860d9174 100644 --- a/tests/samples/iocs/bad_ref.ibek.ioc.yaml +++ b/tests/samples/iocs/bad_ref.ibek.ioc.yaml @@ -4,11 +4,11 @@ ioc_name: test-multiple-ioc description: demo bad object reference entities: - - entity_type: asyn.AsynIP + - type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - entity_type: motorSim.simMotorController + - type: motorSim.simMotorController port: controllerOnePort_BAD_REF controllerName: controllerOne numAxes: 4 diff --git a/tests/samples/iocs/gauges.ibek.ioc.yaml b/tests/samples/iocs/gauges.ibek.ioc.yaml index b129ce6ee..a24c348db 100644 --- a/tests/samples/iocs/gauges.ibek.ioc.yaml +++ b/tests/samples/iocs/gauges.ibek.ioc.yaml @@ -4,31 +4,31 @@ ioc_name: "{{ ioc_yaml_file_name }}" description: Example of initialising a gauge group with defaults to gauge1 entities: - - entity_type: asyn.AsynIP + - type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - entity_type: asyn.AsynIP + - type: asyn.AsynIP name: controllerTwoPort port: 192.168.0.55:2002 - - entity_type: gauges.Mks937bGauge + - type: gauges.Mks937bGauge port: controllerOnePort name: MyGauge1 P: "IBEK-VA-GAUGE-01:" - - entity_type: gauges.Mks937bGauge + - type: gauges.Mks937bGauge port: controllerTwoPort name: MyGauge2 P: "IBEK-VA-GAUGE-02:" # an un-referenced Gauge - - entity_type: gauges.Mks937bGauge + - type: gauges.Mks937bGauge port: controllerTwoPort name: MyGauge3 P: "IBEK-VA-GAUGE-03:" - - entity_type: gauges.GaugeGroup + - type: gauges.GaugeGroup name: MyGaugeGroup gauge1: MyGauge1 gauge2: MyGauge2 diff --git a/tests/samples/iocs/ipac-test.ibek.ioc.yaml b/tests/samples/iocs/ipac-test.ibek.ioc.yaml index 47c83b62c..3392a812f 100644 --- a/tests/samples/iocs/ipac-test.ibek.ioc.yaml +++ b/tests/samples/iocs/ipac-test.ibek.ioc.yaml @@ -5,15 +5,15 @@ ioc_name: ipac-test description: example IOC with IPAC modules entities: - - entity_type: epics.InterruptVectorVME + - type: epics.InterruptVectorVME name: Vec1 - - entity_type: epics.InterruptVectorVME + - type: epics.InterruptVectorVME name: Vec2 - - entity_type: ipac.Hy8002 + - type: ipac.Hy8002 slot: 4 interrupt_vector: Vec1 - - entity_type: ipac.Hy8002 + - type: ipac.Hy8002 slot: 5 interrupt_vector: Vec2 diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index e35bcabd9..6a7c28b85 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -3,9 +3,9 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - entity_type: listtest.lister + - type: listtest.lister friends: ["Rimmer", "Holly", "Cat", "Kryten"] - - entity_type: listtest.lister + - type: listtest.lister friends: |- {{ ["Rimmer"] + ["tt"] | list }} diff --git a/tests/samples/iocs/motorSim.ibek.ioc.yaml b/tests/samples/iocs/motorSim.ibek.ioc.yaml index becd28d4d..7a833a03d 100644 --- a/tests/samples/iocs/motorSim.ibek.ioc.yaml +++ b/tests/samples/iocs/motorSim.ibek.ioc.yaml @@ -4,17 +4,17 @@ ioc_name: "{{ ioc_yaml_file_name }}" description: Example simulated motion IOC for Testing ibek entities: - - entity_type: asyn.AsynIP + - type: asyn.AsynIP name: controllerOnePort port: 192.168.0.55:2002 - - entity_type: motorSim.simMotorController + - type: motorSim.simMotorController port: controllerOnePort controllerName: controllerOne numAxes: 4 P: "IBEK-MO-TST-01:" - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne # Use ADDR in other fields to verify jinja templating between Args M: M{{ADDR}} @@ -23,7 +23,7 @@ entities: DESC: "Motor {{ADDR}} for ioc {{ioc_name}}" home: 500 - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 1 @@ -31,21 +31,21 @@ entities: DESC: "Motor {{ADDR}} {% raw %} {{enclosed in escaped curly braces}} {% endraw %}" home: 500 - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 2 # testing default DESC home: 1500 - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne M: M{{ADDR}} ADDR: 3 DESC: "Motor {{ADDR}}" home: 2500 - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne M: CS_M{{ADDR}} ADDR: 1 @@ -54,7 +54,7 @@ entities: CS_NUM: 3 is_cs: true - - entity_type: motorSim.simMotorAxis + - type: motorSim.simMotorAxis controller: controllerOne M: CS_M{{ADDR}} ADDR: 2 diff --git a/tests/samples/iocs/quadem.ibek.ioc.yaml b/tests/samples/iocs/quadem.ibek.ioc.yaml index b4b8bce02..d40034fe8 100644 --- a/tests/samples/iocs/quadem.ibek.ioc.yaml +++ b/tests/samples/iocs/quadem.ibek.ioc.yaml @@ -4,14 +4,14 @@ ioc_name: "{{ __utils__.get_env('IOC_NAME') }}" description: Example TetrAMM for BL03I entities: - - entity_type: quadEM.TetrAMM + - type: quadEM.TetrAMM PORT: XBPM1.DRV P: BL03I-EA-XBPM-01 R: ":DRV:" QSIZE: 20 IP: "172.23.103.85:10001" - - entity_type: quadEM.Plugins + - type: quadEM.Plugins DEVICE: XBPM1.DRV PORTPREFIX: XBPM1 STAT_NCHAN: 1000 diff --git a/tests/samples/iocs/technosoft.ibek.ioc.yaml b/tests/samples/iocs/technosoft.ibek.ioc.yaml index 650ba1697..651547f12 100644 --- a/tests/samples/iocs/technosoft.ibek.ioc.yaml +++ b/tests/samples/iocs/technosoft.ibek.ioc.yaml @@ -5,7 +5,7 @@ description: YAG motors shared: - &motor - entity_type: motorTML.motorAxis + type: motorTML.motorAxis controller: TML NSTEPS: 200 NMICROSTEPS: 256 @@ -25,7 +25,7 @@ shared: TIMEOUT: 0 entities: - - entity_type: motorTML.CreateController + - type: motorTML.CreateController controllerName: TML P: "SPARC:TML" TTY: /tmp # /var/tmp/ttyV0 diff --git a/tests/samples/iocs/utils.ibek.ioc.yaml b/tests/samples/iocs/utils.ibek.ioc.yaml index d52fbf014..d4eabe21c 100644 --- a/tests/samples/iocs/utils.ibek.ioc.yaml +++ b/tests/samples/iocs/utils.ibek.ioc.yaml @@ -3,5 +3,5 @@ ioc_name: counter description: an example motion ioc for ibek testing entities: - - entity_type: epics.InterruptVectorVME + - type: epics.InterruptVectorVME name: Vec0 diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json index f17e3dde0..e9fd9499c 100644 --- a/tests/samples/schemas/gauges.ibek.ioc.schema.json +++ b/tests/samples/schemas/gauges.ibek.ioc.schema.json @@ -3,10 +3,10 @@ "asyn_AsynIP": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -147,7 +147,7 @@ } }, "required": [ - "entity_type", + "type", "port", "name" ], @@ -183,10 +183,10 @@ "gauges_GaugeGroup": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "gauges.GaugeGroup", "description": "Group of gauges", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -220,7 +220,7 @@ } }, "required": [ - "entity_type", + "type", "name", "gauge1" ], @@ -230,10 +230,10 @@ "gauges_Mks937bGauge": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "gauges.Mks937bGauge", "description": "MKS 937b Gauge controller", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -257,7 +257,7 @@ } }, "required": [ - "entity_type", + "type", "port", "name", "P" @@ -304,7 +304,7 @@ "gauges.GaugeGroup": "#/$defs/gauges_GaugeGroup", "gauges.Mks937bGauge": "#/$defs/gauges_Mks937bGauge" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index c96c93515..b938d8b78 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -625,9 +625,9 @@ "additionalProperties": true, "description": "A loosely defined class to declare the Entities\nin an ibek.support.yaml file in the 'sub_entities' property of an Entity\nsection", "properties": { - "entity_type": { + "type": { "description": "The type of this entity", - "title": "Entity Type", + "title": "Type", "type": "string" }, "entity_enabled": { @@ -638,7 +638,7 @@ } }, "required": [ - "entity_type" + "type" ], "title": "SubEntity", "type": "object" diff --git a/tests/samples/schemas/ipac.ibek.ioc.schema.json b/tests/samples/schemas/ipac.ibek.ioc.schema.json index f8fbf5029..6ef34a0f9 100644 --- a/tests/samples/schemas/ipac.ibek.ioc.schema.json +++ b/tests/samples/schemas/ipac.ibek.ioc.schema.json @@ -22,10 +22,10 @@ "epics_EpicsCaMaxArrayBytes": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.EpicsCaMaxArrayBytes", "description": "Set the maximum size in bytes for sending arrays over channel access", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -51,7 +51,7 @@ } }, "required": [ - "entity_type" + "type" ], "title": "epics_EpicsCaMaxArrayBytes", "type": "object" @@ -59,10 +59,10 @@ "epics_EpicsEnvSet": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.EpicsEnvSet", "description": "Set an environment variable in the ioc Shell", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -82,7 +82,7 @@ } }, "required": [ - "entity_type", + "type", "name", "value" ], @@ -92,10 +92,10 @@ "epics_EpicsTsMinWest": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.EpicsTsMinWest", "description": "Set the relative time zone minutes West relative to GMT (+/-720)", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -121,7 +121,7 @@ } }, "required": [ - "entity_type" + "type" ], "title": "epics_EpicsTsMinWest", "type": "object" @@ -129,10 +129,10 @@ "epics_InterruptVectorVME": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.InterruptVectorVME", "description": "Reserve a VME interrupt vector", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -169,7 +169,7 @@ } }, "required": [ - "entity_type", + "type", "name" ], "title": "epics_InterruptVectorVME", @@ -178,10 +178,10 @@ "epics_PostStartupCommand": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.PostStartupCommand", "description": "Adds an arbitrary command in the startup script after iocInit", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -197,7 +197,7 @@ } }, "required": [ - "entity_type" + "type" ], "title": "epics_PostStartupCommand", "type": "object" @@ -205,10 +205,10 @@ "epics_StartupCommand": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.StartupCommand", "description": "Adds an arbitrary command in the startup script before iocInit", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -224,7 +224,7 @@ } }, "required": [ - "entity_type" + "type" ], "title": "epics_StartupCommand", "type": "object" @@ -232,10 +232,10 @@ "epics_dbpf": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.dbpf", "description": "Set a PV value after iocInit", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -255,7 +255,7 @@ } }, "required": [ - "entity_type", + "type", "pv", "value" ], @@ -284,10 +284,10 @@ "ipac_Hy8001": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ipac.Hy8001", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -431,7 +431,7 @@ } }, "required": [ - "entity_type", + "type", "slot", "direction", "cardid" @@ -442,10 +442,10 @@ "ipac_Hy8002": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ipac.Hy8002", "description": "Configure a Hytec 8002 Carrier card", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -508,7 +508,7 @@ } }, "required": [ - "entity_type", + "type", "slot", "interrupt_vector" ], @@ -518,10 +518,10 @@ "ipac_Hy8005": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ipac.Hy8005", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -593,7 +593,7 @@ } }, "required": [ - "entity_type", + "type", "slot", "cardnum" ], @@ -603,10 +603,10 @@ "ipac_Hy8005_Channel": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ipac.Hy8005_Channel", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -719,7 +719,7 @@ } }, "required": [ - "entity_type", + "type", "parent", "ipslot", "cardnum", @@ -794,7 +794,7 @@ "ipac.Hy8005": "#/$defs/ipac_Hy8005", "ipac.Hy8005_Channel": "#/$defs/ipac_Hy8005_Channel" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index c0523a75b..445f14a40 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -3,10 +3,10 @@ "listtest_lister": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "listtest.lister", "description": "The protagonist from Red Dwarf", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -38,7 +38,7 @@ } }, "required": [ - "entity_type", + "type", "friends" ], "title": "listtest_lister", @@ -64,7 +64,7 @@ "mapping": { "listtest.lister": "#/$defs/listtest_lister" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json index 90ece21d3..6b18b51bc 100644 --- a/tests/samples/schemas/motorSim.ibek.ioc.schema.json +++ b/tests/samples/schemas/motorSim.ibek.ioc.schema.json @@ -11,10 +11,10 @@ "asyn_AsynIP": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -155,7 +155,7 @@ } }, "required": [ - "entity_type", + "type", "port", "name" ], @@ -191,10 +191,10 @@ "motorSim_simMotorAxis": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -351,7 +351,7 @@ } }, "required": [ - "entity_type", + "type", "controller", "M", "ADDR" @@ -362,10 +362,10 @@ "motorSim_simMotorController": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -410,7 +410,7 @@ } }, "required": [ - "entity_type", + "type", "controllerName", "P", "numAxes", @@ -458,7 +458,7 @@ "motorSim.simMotorAxis": "#/$defs/motorSim_simMotorAxis", "motorSim.simMotorController": "#/$defs/motorSim_simMotorController" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/quadem.ibek.ioc.schema.json b/tests/samples/schemas/quadem.ibek.ioc.schema.json index 404a85e08..a2bc9520f 100644 --- a/tests/samples/schemas/quadem.ibek.ioc.schema.json +++ b/tests/samples/schemas/quadem.ibek.ioc.schema.json @@ -3,10 +3,10 @@ "ADCore_NDAttrPlot": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDAttrPlot", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -176,7 +176,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -192,10 +192,10 @@ "ADCore_NDAttribute": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDAttribute", "description": "This plugin displays NDArray attributes", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -367,7 +367,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -379,10 +379,10 @@ "ADCore_NDAttributes": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDAttributes", "description": "Add an attribute to the NDAttributes file for a particular ADDriver or\n NDPlugin, and associate it with the NDAttributes file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -409,15 +409,6 @@ "title": "Attrname", "type": "string" }, - "type": { - "allOf": [ - { - "$ref": "#/$defs/type" - } - ], - "default": "EPICS_PV", - "description": "Where the data should be picked up from" - }, "dbrtype": { "allOf": [ { @@ -459,7 +450,7 @@ } }, "required": [ - "entity_type", + "type", "port", "source", "name", @@ -472,10 +463,10 @@ "ADCore_NDCircularBuff": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDCircularBuff", "description": "This plugin provides a pre and post external trigger frame capture buffer", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -657,7 +648,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -669,10 +660,10 @@ "ADCore_NDCodec": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDCodec", "description": "This plugin can compress or decompress NDArrays", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -822,7 +813,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -834,10 +825,10 @@ "ADCore_NDColorConvert": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDColorConvert", "description": "This plugin converts arrays from one colour type to another, e.g. Bayer -> RGB1", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -987,7 +978,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -999,10 +990,10 @@ "ADCore_NDFFT": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFFT", "description": "This plugin is used to calculate the FFT of a time series", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1221,7 +1212,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -1234,10 +1225,10 @@ "ADCore_NDFileHDF5": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileHDF5", "description": "This plugin can compress NDArrays to HDF5 and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1387,7 +1378,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -1399,10 +1390,10 @@ "ADCore_NDFileJPEG": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileJPEG", "description": "This plugin can compress NDArrays to JPEG and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1536,7 +1527,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -1548,10 +1539,10 @@ "ADCore_NDFileMagick": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileMagick", "description": "This plugin can compress NDArrays to a range of formats supported by\n graphics magick and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1685,7 +1676,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -1697,10 +1688,10 @@ "ADCore_NDFileNetCDF": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileNetCDF", "description": "This plugin can compress NDArrays to NetCDF and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1834,7 +1825,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "NDARRAY_PORT", @@ -1846,10 +1837,10 @@ "ADCore_NDFileNexus": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileNexus", "description": "This plugin can compress NDArrays to Nexus and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -1983,7 +1974,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -1995,10 +1986,10 @@ "ADCore_NDFileNull": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileNull", "description": "Null file plugin for deleting driver files", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -2132,7 +2123,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -2144,10 +2135,10 @@ "ADCore_NDFileTIFF": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDFileTIFF", "description": "This plugin can compress NDArrays to TIFF and write them to file", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -2281,7 +2272,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "NDARRAY_PORT", @@ -2293,10 +2284,10 @@ "ADCore_NDGather": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDGather", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -2447,7 +2438,7 @@ } }, "required": [ - "entity_type", + "type", "NDARRAY_PORT", "PORT", "P", @@ -2459,10 +2450,10 @@ "ADCore_NDGather8": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDGather8", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -2607,7 +2598,7 @@ } }, "required": [ - "entity_type", + "type", "NDARRAY_PORT", "PORT", "P", @@ -2621,10 +2612,10 @@ "ADCore_NDOverlay": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDOverlay", "description": "This plugin writes overlays on the array, like cursors and boxes", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -2829,7 +2820,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -2852,10 +2843,10 @@ "ADCore_NDPosPlugin": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDPosPlugin", "description": "This plugin attaches position information to NDArrays", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3021,7 +3012,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3033,10 +3024,10 @@ "ADCore_NDProcess": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDProcess", "description": "This plugin does image processing like flat field correction, background\n subtraction, and recursive filtering", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3170,7 +3161,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3182,10 +3173,10 @@ "ADCore_NDPvaPlugin": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDPvaPlugin", "description": "This plugin makes NDArrays available through PVAccess", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3356,7 +3347,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3369,10 +3360,10 @@ "ADCore_NDROI": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDROI", "description": "This plugin selects a region of interest and optionally scales it to\n fit in a particular data type", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3522,7 +3513,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3534,10 +3525,10 @@ "ADCore_NDROIStat": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDROIStat", "description": "This plugin calculates statistics of ROIs", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3719,7 +3710,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3731,10 +3722,10 @@ "ADCore_NDScatter": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDScatter", "description": "This plugin is used to distribute processing of NDArrays to multiple downstream plugins", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -3884,7 +3875,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -3896,10 +3887,10 @@ "ADCore_NDStats": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDStats", "description": "This plugin calculates statistics like X and Y profile, centroid, and plots a histogram of binned pixels", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -4116,7 +4107,7 @@ } }, "required": [ - "entity_type", + "type", "PORT", "NDARRAY_PORT", "HIST_SIZE", @@ -4131,10 +4122,10 @@ "ADCore_NDStdArrays": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDStdArrays", "description": "This plugin provides a waveform record that can display the NDArrays\n produced by its NDARRAY_PORT", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -4312,7 +4303,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -4327,10 +4318,10 @@ "ADCore_NDTimeSeries": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDTimeSeries", "description": "This plugin creates time series arrays from callback data", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -4538,7 +4529,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -4552,10 +4543,10 @@ "ADCore_NDTransform": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore.NDTransform", "description": "This plugin selects a region of interest and optionally scales it to fit in a particular data type", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -4705,7 +4696,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -4717,10 +4708,10 @@ "ADCore__NDCircularBuff": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "ADCore._NDCircularBuff", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -4855,7 +4846,7 @@ } }, "required": [ - "entity_type", + "type", "P", "R", "PORT", @@ -4922,10 +4913,10 @@ "quadEM_Plugins": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "quadEM.Plugins", "description": "Instantiates\n 12 NDStats plugins for Current, Sum, Diff and Pos Channels\n 12 NDTimeSeries plugins\n 12 NDArray plugins", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -5006,7 +4997,7 @@ } }, "required": [ - "entity_type", + "type", "DEVICE", "PORTPREFIX", "STAT_NCHAN", @@ -5018,10 +5009,10 @@ "quadEM_TetrAMM": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "quadEM.TetrAMM", "description": "TODO:ADD DESCRIPTION", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -5083,7 +5074,7 @@ } }, "required": [ - "entity_type", + "type", "PORT", "P", "R", @@ -5091,14 +5082,6 @@ ], "title": "quadEM_TetrAMM", "type": "object" - }, - "type": { - "enum": [ - "EPICS_PV", - "PARAM" - ], - "title": "type", - "type": "string" } }, "additionalProperties": false, @@ -5149,7 +5132,7 @@ "quadEM.Plugins": "#/$defs/quadEM_Plugins", "quadEM.TetrAMM": "#/$defs/quadEM_TetrAMM" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/single.ibek.ioc.schema.json b/tests/samples/schemas/single.ibek.ioc.schema.json index 05b18d4ba..3ce11ba73 100644 --- a/tests/samples/schemas/single.ibek.ioc.schema.json +++ b/tests/samples/schemas/single.ibek.ioc.schema.json @@ -11,10 +11,10 @@ "motorSim_simMotorAxis": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -171,7 +171,7 @@ } }, "required": [ - "entity_type", + "type", "controller", "M", "ADDR" @@ -182,10 +182,10 @@ "motorSim_simMotorController": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -230,7 +230,7 @@ } }, "required": [ - "entity_type", + "type", "controllerName", "P", "numAxes", @@ -260,7 +260,7 @@ "motorSim.simMotorAxis": "#/$defs/motorSim_simMotorAxis", "motorSim.simMotorController": "#/$defs/motorSim_simMotorController" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index 6fe7dafbd..777d34a9a 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -11,10 +11,10 @@ "motorTML_CreateController": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorTML.CreateController", "description": "Creates a Technosoft motion controller connected to a serial line", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -82,7 +82,7 @@ } }, "required": [ - "entity_type", + "type", "controllerName", "P", "TTY", @@ -94,10 +94,10 @@ "motorTML_motorAxis": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "motorTML.motorAxis", "description": "Creates a motor axis", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -423,7 +423,7 @@ } }, "required": [ - "entity_type", + "type", "controller", "axid" ], @@ -451,7 +451,7 @@ "motorTML.CreateController": "#/$defs/motorTML_CreateController", "motorTML.motorAxis": "#/$defs/motorTML_motorAxis" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/schemas/utils.ibek.ioc.schema.json b/tests/samples/schemas/utils.ibek.ioc.schema.json index 3c1a26ea1..82eb9ecdd 100644 --- a/tests/samples/schemas/utils.ibek.ioc.schema.json +++ b/tests/samples/schemas/utils.ibek.ioc.schema.json @@ -3,10 +3,10 @@ "epics_InterruptVectorVME": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.InterruptVectorVME", "description": "Reserve an interrupt vector for use with VME hardware.\n", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -33,7 +33,7 @@ } }, "required": [ - "entity_type", + "type", "name" ], "title": "epics_InterruptVectorVME", @@ -42,10 +42,10 @@ "epics_InterruptVectorVME2": { "additionalProperties": false, "properties": { - "entity_type": { + "type": { "const": "epics.InterruptVectorVME2", "description": "naughty second use of same counter", - "title": "Entity Type" + "title": "Type" }, "entity_enabled": { "default": true, @@ -60,7 +60,7 @@ } }, "required": [ - "entity_type", + "type", "name" ], "title": "epics_InterruptVectorVME2", @@ -87,7 +87,7 @@ "epics.InterruptVectorVME": "#/$defs/epics_InterruptVectorVME", "epics.InterruptVectorVME2": "#/$defs/epics_InterruptVectorVME2" }, - "propertyName": "entity_type" + "propertyName": "type" }, "oneOf": [ { diff --git a/tests/samples/support/ADCore.ibek.support.yaml b/tests/samples/support/ADCore.ibek.support.yaml index e03983af6..feb1523be 100644 --- a/tests/samples/support/ADCore.ibek.support.yaml +++ b/tests/samples/support/ADCore.ibek.support.yaml @@ -1977,7 +1977,7 @@ defs: NDStatsConfigure("{{PORT}}", {{QUEUE}}, {{BLOCK}}, "{{NDARRAY_PORT}}", {{NDARRAY_ADDR}}, 0, 0, 0, 0, {{MAX_THREADS}}) sub_entities: - - { entity_type: ADCore.NDTimeSeries, P: "{{P}}", R: "{{R}}TS:", PORT: "{{PORT}}_TS", NDARRAY_PORT: "{{PORT}}", NAME: "{{PORT}}_TS", NCHANS: "{{NCHANS}}", TIMEOUT: "{{TIMEOUT}}", ADDR: 0, NDARRAY_ADDR: 1, ENABLED: "{{ENABLED}}", QUEUE: "{{QUEUE}}", BLOCK: "{{BLOCK}}", NSIGNALS: 23 } + - { type: ADCore.NDTimeSeries, P: "{{P}}", R: "{{R}}TS:", PORT: "{{PORT}}_TS", NDARRAY_PORT: "{{PORT}}", NAME: "{{PORT}}_TS", NCHANS: "{{NCHANS}}", TIMEOUT: "{{TIMEOUT}}", ADDR: 0, NDARRAY_ADDR: 1, ENABLED: "{{ENABLED}}", QUEUE: "{{QUEUE}}", BLOCK: "{{BLOCK}}", NSIGNALS: 23 } pvi: yaml_path: NDPluginStats.pvi.device.yaml diff --git a/tests/samples/support/quadem.ibek.support.yaml b/tests/samples/support/quadem.ibek.support.yaml index 9ff4d37db..a1dd3d120 100644 --- a/tests/samples/support/quadem.ibek.support.yaml +++ b/tests/samples/support/quadem.ibek.support.yaml @@ -110,8 +110,8 @@ defs: # shared: - - &stats { entity_type: ADCore.NDStats, P: "{{DEVICE.P}}", NCHANS: "{{STAT_NCHAN}}", XSIZE: "{{STAT_XSIZE}}", YSIZE: 0, HIST_SIZE: "{{HIST_SIZE}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1 } - - &arrays { entity_type: ADCore.NDStdArrays, P: "{{DEVICE.P}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1, TYPE: "Float64", FTVL: "DOUBLE", NELEMENTS: "{{STAT_XSIZE}}" } + - &stats { type: ADCore.NDStats, P: "{{DEVICE.P}}", NCHANS: "{{STAT_NCHAN}}", XSIZE: "{{STAT_XSIZE}}", YSIZE: 0, HIST_SIZE: "{{HIST_SIZE}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1 } + - &arrays { type: ADCore.NDStdArrays, P: "{{DEVICE.P}}", NDARRAY_PORT: "{{DEVICE}}", ENABLED: 1, TYPE: "Float64", FTVL: "DOUBLE", NELEMENTS: "{{STAT_XSIZE}}" } sub_entities: - { <<: *stats, PORT: "{{PORTPREFIX}}.STATS.I1", R: Cur1 } diff --git a/tests/test_render.py b/tests/test_render.py index 38c17ea6b..97c6ecd5b 100644 --- a/tests/test_render.py +++ b/tests/test_render.py @@ -9,23 +9,23 @@ from ibek.render_db import RenderDb -def find_entity_class(entity_classes, entity_type): +def find_entity_class(entity_classes, type): for entity_class in entity_classes: - literal = Literal[entity_type] # type: ignore - if entity_class.model_fields["entity_type"].annotation == literal: + literal = Literal[type] # type: ignore + if entity_class.model_fields["type"].annotation == literal: return entity_class else: - raise ValueError(f"{entity_type} not found in entity_classes") + raise ValueError(f"{type} not found in entity_classes") def test_pre_init_script(asyn_classes): definition = find_entity_class(asyn_classes, "asyn.AsynIP") - # NOTE: because we have switched from type to entity_type in the + # NOTE: because we have switched from type to type in the # we need to pass it to the constructor # Not ideal - but does not affect deserialization of these types - port1 = definition(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") - port2 = definition(name="asyn2", port="10.0.1.2", entity_type="asyn.AsynIP") + port1 = definition(name="asyn1", port="10.0.1.1", type="asyn.AsynIP") + port2 = definition(name="asyn2", port="10.0.1.2", type="asyn.AsynIP") render = Render() script_txt = render.render_script(port1, port1.__definition__.pre_init) @@ -49,13 +49,13 @@ def test_obj_ref_script(motor_classes): asyn_def = find_entity_class(motor_classes, "asyn.AsynIP") motor_def = find_entity_class(motor_classes, "motorSim.simMotorController") - asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") + asyn_def(name="asyn1", port="10.0.1.1", type="asyn.AsynIP") motor_obj = motor_def( port="asyn1", controllerName="ctrl1", P="IBEK-MO-01:", numAxes=4, - entity_type="motorSim.simMotorController", + type="motorSim.simMotorController", ) render = Render() @@ -73,7 +73,7 @@ def test_database_render(motor_classes): sim_def = find_entity_class(motor_classes, "motorSim.simMotorController") motor_def = find_entity_class(motor_classes, "motorSim.simMotorAxis") - asyn1 = asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") + asyn1 = asyn_def(name="asyn1", port="10.0.1.1", type="asyn.AsynIP") # TODO removing DESC below causes a failure in jinja templating # The default DESC field contains jinja escaping and this fails for some # reason. But it works fine in the test test_build_runtime_motorSim which @@ -84,17 +84,15 @@ def test_database_render(motor_classes): P="IBEK-MO-01:", numAxes=4, DESC="test", - entity_type="motorSim.simMotorController", - ) - motor1 = motor_def( - controller="ctrl1", M="M1", ADDR=1, entity_type="motorSim.simMotorAxis" + type="motorSim.simMotorController", ) + motor1 = motor_def(controller="ctrl1", M="M1", ADDR=1, type="motorSim.simMotorAxis") motor2 = motor_def( controller="ctrl1", M="M2", ADDR=2, is_cs=True, - entity_type="motorSim.simMotorAxis", + type="motorSim.simMotorAxis", ) # make a dummy IOC with two entities as database render works against @@ -123,7 +121,7 @@ def test_database_render(motor_classes): def test_environment_variables(motor_classes): asyn_def = find_entity_class(motor_classes, "asyn.AsynIP") - asyn_obj = asyn_def(name="asyn1", port="10.0.1.1", entity_type="asyn.AsynIP") + asyn_obj = asyn_def(name="asyn1", port="10.0.1.1", type="asyn.AsynIP") render = Render() env_text = render.render_environment_variables(asyn_obj) diff --git a/tests/test_unit.py b/tests/test_unit.py index c2559acb9..9575c2304 100644 --- a/tests/test_unit.py +++ b/tests/test_unit.py @@ -45,15 +45,15 @@ def test_object_references(entity_factory): ioc_name="", description="", entities=[ - dict(entity_type="mymodule.port", name="PORT"), - dict(entity_type="mymodule.device", port="PORT"), + dict(type="mymodule.port", name="PORT"), + dict(type="mymodule.device", port="PORT"), ], ) ioc = ioc_model(**d) port, device = ioc.entities # TODO try to get rid of the need for '' - assert port.entity_type == "mymodule.port" - assert device.entity_type == "mymodule.device" + assert port.type == "mymodule.port" + assert device.type == "mymodule.device" assert device.port is port assert id_to_entity == {"PORT": port} From 8e494e0a1ffea9ba97131c3348576d1b226b30de Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 21:21:38 +0000 Subject: [PATCH 11/24] change "arg_type" back to "type" --- src/ibek/args.py | 18 +- src/ibek/definition.py | 6 +- src/ibek/entity_factory.py | 14 +- .../samples/outputs/dlsPLC.ibek.support.yaml | 3446 ++++++++--------- .../samples/schemas/ibek.support.schema.json | 42 +- .../samples/support/ADCore.ibek.support.yaml | 736 ++-- tests/samples/support/asyn.ibek.support.yaml | 26 +- .../samples/support/bad_db.ibek.support.yaml | 2 +- .../samples/support/dlsPLC.ibek.support.yaml | 3446 ++++++++--------- tests/samples/support/epics.ibek.support.yaml | 24 +- .../samples/support/gauges.ibek.support.yaml | 16 +- tests/samples/support/ipac.ibek.support.yaml | 56 +- .../samples/support/listarg.ibek.support.yaml | 4 +- .../support/motorSim.ibek.support.yaml | 36 +- .../samples/support/quadem.ibek.support.yaml | 24 +- .../support/technosoft.ibek.support.yaml | 60 +- tests/samples/support/utils.ibek.support.yaml | 10 +- 17 files changed, 3983 insertions(+), 3983 deletions(-) diff --git a/src/ibek/args.py b/src/ibek/args.py index a8fe0e3a2..2154e73cd 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -25,7 +25,7 @@ class Value(BaseSettings): class Arg(BaseSettings): """Base class for all Argument Types""" - arg_type: str + type: str name: str = Field( description="Name of the argument that the IOC instance should pass" ) @@ -37,56 +37,56 @@ class Arg(BaseSettings): class ListArg(Arg): """An argument with a float value""" - arg_type: Literal["list"] = "list" + type: Literal["list"] = "list" default: Optional[list] = None class FloatArg(Arg): """An argument with a float value""" - arg_type: Literal["float"] = "float" + type: Literal["float"] = "float" default: Optional[float] = None class StrArg(Arg): """An argument with a str value""" - arg_type: Literal["str"] = "str" + type: Literal["str"] = "str" default: Optional[str] = None class IntArg(Arg): """An argument with an int value""" - arg_type: Literal["int"] = "int" + type: Literal["int"] = "int" default: Optional[int] = None class BoolArg(Arg): """An argument with an bool value""" - arg_type: Literal["bool"] = "bool" + type: Literal["bool"] = "bool" default: Optional[bool] = None class ObjectArg(Arg): """A reference to another entity defined in this IOC""" - arg_type: Literal["object"] = "object" + type: Literal["object"] = "object" default: Optional[str] = None class IdArg(Arg): """Explicit ID argument that an object can refer to""" - arg_type: Literal["id"] = "id" + type: Literal["id"] = "id" default: Optional[str] = None class EnumArg(Arg): """An argument with an enum value""" - arg_type: Literal["enum"] = "enum" + type: Literal["enum"] = "enum" default: Optional[Any] = None values: Dict[str, Any] = Field( diff --git a/src/ibek/definition.py b/src/ibek/definition.py index 95192cb41..8021eac27 100644 --- a/src/ibek/definition.py +++ b/src/ibek/definition.py @@ -68,7 +68,7 @@ class Comment(BaseSettings): for insertion into the startup script """ - arg_type: Literal["comment"] = "comment" + type: Literal["comment"] = "comment" when: When = Field(description="One of first / every / last", default="every") value: str = Field( description="A comment to add into the startup script", default="" @@ -80,7 +80,7 @@ class Text(BaseSettings): A script snippet to insert into the startup script """ - arg_type: Literal["text"] = "text" + type: Literal["text"] = "text" when: str = Field(description="One of first / every / last", default="every") value: str = Field(description="raw text to add to the startup script", default="") @@ -117,7 +117,7 @@ class EntityPVI(BaseSettings): discriminated = Annotated[ # type: ignore Union[tuple(Arg.__subclasses__())], - Field(discriminator="arg_type", description="union of arg types"), + Field(discriminator="type", description="union of arg types"), ] diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 5d95e4f4e..e217a25bb 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -102,7 +102,7 @@ def add_arg(name, typ, description, default): # TODO - don't understand why I need type ignore here # arg is 'discriminated' which is a Union of all the Arg subclasses full_arg_name = f"{full_name}.{arg.name}" # type: ignore - arg_type: Any + type: Any if isinstance(arg, ObjectArg): # TODO look into why arg.name requires type ignore @@ -111,10 +111,10 @@ def lookup_instance(cls, id): return get_entity_by_id(id) validators[full_arg_name] = lookup_instance - arg_type = object + type = object elif isinstance(arg, IdArg): - arg_type = str + type = str elif isinstance(arg, EnumArg): # Pydantic uses the values of the Enum as the options in the schema. @@ -125,13 +125,13 @@ def lookup_instance(cls, id): enum_swapped[str(v) if v else str(k)] = k # TODO review enums especially with respect to Pydantic 2.7.1 val_enum = EnumVal(arg.name, enum_swapped) # type: ignore - arg_type = val_enum + type = val_enum else: - # arg.arg_type is str, int, float, etc. - arg_type = getattr(builtins, arg.arg_type) + # arg.type is str, int, float, etc. + type = getattr(builtins, arg.type) # TODO look into why arg.name requires type ignore - add_arg(arg.name, arg_type, arg.description, getattr(arg, "default")) # type: ignore + add_arg(arg.name, type, arg.description, getattr(arg, "default")) # type: ignore # add in the calculated values Jinja Templates as Fields in the Entity for value in definition.values: diff --git a/tests/samples/outputs/dlsPLC.ibek.support.yaml b/tests/samples/outputs/dlsPLC.ibek.support.yaml index e89a408bd..08c418588 100644 --- a/tests/samples/outputs/dlsPLC.ibek.support.yaml +++ b/tests/samples/outputs/dlsPLC.ibek.support.yaml @@ -3,29 +3,29 @@ defs: - name: overrideRequestIndividual description: Template allowing override of individual interlock bits args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: DESC description: Description (e.g. DCM piezo override) - - arg_type: str + - type: str name: PRESSURE1 description: Pressure in mbar that needs to be over setpoint to allow override - - arg_type: str + - type: str name: PRESSURE2 description: Pressure in mbar that needs to be over setpoint to allow override - - arg_type: str + - type: str name: OVERRIDE description: P of overrideRequestMain instance - - arg_type: str + - type: str name: BIT description: Bit of overrideRequestMain instance to use (0-8) - - arg_type: str + - type: str name: SETPOINT description: Setpoint in mbar that both pressures need to be higher than to allow override - - arg_type: id + - type: id name: name description: This associates an edm screen with the template databases: @@ -42,7 +42,7 @@ defs: - name: softwareVersion description: Template that reads software version from a PLC. args: - - arg_type: str + - type: str name: device description: Device prefix databases: @@ -53,312 +53,312 @@ defs: description: Template database for a vacuum valve with different interlocks for open and close operations args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: device name of valve control crate - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM150..159 then addr=150 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: cilk0 description: Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: cilk1 description: Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: cilk2 description: Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: cilk3 description: Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: cilk4 description: Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: cilk5 description: Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: cilk6 description: Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: cilk7 description: Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: cilk8 description: Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: cilk9 description: Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: cilk10 description: Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: cilk11 description: Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: cilk12 description: Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: cilk13 description: Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: cilk14 description: Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: cilk15 description: Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: valvetype description: Template argument default: valve - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: Template argument default: Operational - - arg_type: str + - type: str name: mode2 description: Template argument default: Service @@ -417,7 +417,7 @@ defs: sta_sv5: sta_sv4: sta_sv6: - valvearg_type: + valvetype: ilk6: ilk2: ilk7: @@ -446,86 +446,86 @@ defs: - name: writeEnum description: Write the Enum value into a DM variable in a PLC args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: int + - type: int name: timeout description: timeout on PV write attempts default: 0 - - arg_type: int + - type: int name: VAL0 description: Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: String Value for state 0 default: '' - - arg_type: str + - type: str name: STR1 description: String Value for state 1 default: '' - - arg_type: str + - type: str name: STR2 description: String Value for state 2 default: '' - - arg_type: str + - type: str name: STR3 description: String Value for state 3 default: '' - - arg_type: str + - type: str name: STR4 description: String Value for state 4 default: '' - - arg_type: str + - type: str name: STR5 description: String Value for state 5 default: '' - - arg_type: str + - type: str name: STR6 description: String Value for state 6 default: '' - - arg_type: str + - type: str name: STR7 description: String Value for state 7 default: '' @@ -561,35 +561,35 @@ defs: bits. E.g. if interlock DM816..818 bit 4 is S1 water,\nuse loloaddress=818,lolobit=4 for instantaneous lolo signal" args: - - arg_type: str + - type: str name: P description: EPICS prefix - - arg_type: str + - type: str name: Q description: EPICS suffix - - arg_type: str + - type: str name: DESC description: Description - - arg_type: str + - type: str name: device description: EPICS name of the vacuum valve crate that connects to the RIO - - arg_type: str + - type: str name: loaddress description: Address of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - arg_type: str + - type: str name: lobit description: Bit of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - arg_type: str + - type: str name: loloaddress description: Address of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - arg_type: str + - type: str name: lolobit description: Bit of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - arg_type: id + - type: id name: name description: This associates an edm screen with the template databases: @@ -607,82 +607,82 @@ defs: - name: readEnum description: Read the Enum value stored in a DM variable in a PLC args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: vlvcc description: PLC control crate device prefix - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: int + - type: int name: VAL0 description: Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: String Value for state 0 default: '' - - arg_type: str + - type: str name: STR1 description: String Value for state 1 default: '' - - arg_type: str + - type: str name: STR2 description: String Value for state 2 default: '' - - arg_type: str + - type: str name: STR3 description: String Value for state 3 default: '' - - arg_type: str + - type: str name: STR4 description: String Value for state 4 default: '' - - arg_type: str + - type: str name: STR5 description: String Value for state 5 default: '' - - arg_type: str + - type: str name: STR6 description: String Value for state 6 default: '' - - arg_type: str + - type: str name: STR7 description: String Value for state 7 default: '' @@ -713,125 +713,125 @@ defs: - name: motionInterlockPLC description: TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: Name - - arg_type: str + - type: str name: device description: Device Prefix - - arg_type: object + - type: object name: port description: Fins port - - arg_type: int + - type: int name: addr description: First interlock work - - arg_type: str + - type: str name: axis1Description description: Axis 1 Description default: unused - - arg_type: str + - type: str name: axis2Description description: Axis 2 Description default: unused - - arg_type: str + - type: str name: axis3Description description: Axis 3 Description default: unused - - arg_type: str + - type: str name: axis4Description description: Axis 4 Description default: unused - - arg_type: str + - type: str name: axis5Description description: Axis 5 Description default: unused - - arg_type: str + - type: str name: axis6Description description: Axis 6 Description default: unused - - arg_type: str + - type: str name: axis7Description description: Axis 7 Description default: unused - - arg_type: str + - type: str name: axis8Description description: Axis 8 Description default: unused - - arg_type: str + - type: str name: interlock description: Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: desc description: Permit description (e.g. Front end permit) - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: int + - type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -867,48 +867,48 @@ defs: description: Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: variable description: PV suffix (its associated _RBV will be autogenerated). - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: tag name of ether_ip read value - - arg_type: str + - type: str name: tagwrite description: tag name of ether_ip write value - - arg_type: str + - type: str name: drvl description: Lowest accepted value - - arg_type: str + - type: str name: drvh description: This associates an edm screen with the template - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: desc description: Description default: '' - - arg_type: str + - type: str name: readscan description: value update time for readback value default: 1 second - - arg_type: float + - type: float name: writescan description: value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - arg_type: str + - type: str name: egu description: Engineering units default: '' - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 2 @@ -931,10 +931,10 @@ defs: - name: externalValve description: Valve interface for a valve that lives in another IOC args: - - arg_type: str + - type: str name: device description: Device macro of valve that exists in another IOC - - arg_type: enum + - type: enum name: valvetype description: Type of Device default: valve @@ -946,86 +946,86 @@ defs: description: "Template database for a dummy vacuum valve, enough to keep\nvacuum space happy\nPeter Denison 30/9/2005, based on vacuum valve by\nPete Owens - 26/4/04" args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: con_label0 description: con_label0 default: Open - - arg_type: str + - type: str name: con_label1 description: con_label1 default: Close - - arg_type: str + - type: str name: con_label2 description: con_label2 default: Reset - - arg_type: str + - type: str name: con_label3 description: con_label3 default: '' - - arg_type: str + - type: str name: con_label4 description: con_label4 default: '' - - arg_type: str + - type: str name: con_label5 description: con_label5 default: '' - - arg_type: str + - type: str name: con_label6 description: con_label6 default: '' - - arg_type: str + - type: str name: ilksta_label0 description: ilksta_label0 default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: ilksta_label1 default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: ilksta_label2 default: OK - - arg_type: str + - type: str name: ilksta_label3 description: ilksta_label3 default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: ilksta_label4 default: '' - - arg_type: str + - type: str name: ilksta_label5 description: ilksta_label5 default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: ilksta_sv0 default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: ilksta_sv1 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: ilksta_sv2 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: ilksta_sv3 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: ilksta_sv4 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: ilksta_sv5 default: NO_ALARM - - arg_type: str + - type: str name: allowpv description: Template argument default: '' @@ -1056,316 +1056,316 @@ defs: - name: fastValve description: Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: device name of valve control crate - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: Arm - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open Armed - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: Open Disarmed - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: desc description: Box label for gui default: $(device) - - arg_type: int + - type: int name: showilk description: 0 (default) => Gauge, 1 => Arm default: 0 - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: Template argument default: Operational - - arg_type: str + - type: str name: mode2 description: Template argument default: Service @@ -1454,19 +1454,19 @@ defs: - name: NX102_mpsPermit description: TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: Template argument - - arg_type: str + - type: str name: port description: Template argument - - arg_type: str + - type: str name: tag description: Template argument - - arg_type: int + - type: int name: tagidx description: Template argument - - arg_type: str + - type: str name: DIRILK1 description: Template argument default: '' @@ -1482,68 +1482,68 @@ defs: description: "Creates beam records that the gui can connect to to see which valves and\n shutters are open" args: - - arg_type: str + - type: str name: P description: Device prefix for summary PV, records will be $(P):STA$(N) for 1<=N<=#objects - - arg_type: object + - type: object name: object0 description: vacuumValve object - - arg_type: object + - type: object name: object1 description: vacuumValve object - - arg_type: object + - type: object name: object2 description: vacuumValve object - - arg_type: object + - type: object name: object3 description: vacuumValve object - - arg_type: object + - type: object name: object4 description: vacuumValve object - - arg_type: object + - type: object name: object5 description: vacuumValve object - - arg_type: object + - type: object name: object6 description: vacuumValve object - - arg_type: object + - type: object name: object7 description: vacuumValve object - - arg_type: object + - type: object name: object8 description: vacuumValve object - - arg_type: object + - type: object name: object9 description: vacuumValve object - - arg_type: object + - type: object name: object10 description: vacuumValve object - - arg_type: object + - type: object name: object11 description: vacuumValve object - name: readFloat32 description: Read the Float32 value stored in 2 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: SCAN description: Scan rate of read record default: 1 second @@ -1562,109 +1562,109 @@ defs: are created in the dlsPLC_DCMHeater.template file so that they have the archiver tag applied." args: - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: P description: Device Prefix - - arg_type: str + - type: str name: Q description: Device Suffix - - arg_type: str + - type: str name: desc description: Description - - arg_type: str + - type: str name: vlvcc description: Parent PLC control crate device prefix - - arg_type: object + - type: object name: port description: asyn port name of FINS driver - - arg_type: int + - type: int name: C_addr description: Address of the demand register - - arg_type: int + - type: int name: UTSP_addr description: Address of the under temperature setpoint register - - arg_type: int + - type: int name: PID_offset description: 2 digit integer offset of DM variables. E.g. if Proportional gain constant setpoint is in DM150 and readback in DM250 offset=50 - - arg_type: int + - type: int name: PID_output_addr description: Address of the PID loop output - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: int + - type: int name: VAL0 description: Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: String Value for state 0 default: '' - - arg_type: str + - type: str name: STR1 description: String Value for state 1 default: '' - - arg_type: str + - type: str name: STR2 description: String Value for state 2 default: '' - - arg_type: str + - type: str name: STR3 description: String Value for state 3 default: '' - - arg_type: str + - type: str name: STR4 description: String Value for state 4 default: '' - - arg_type: str + - type: str name: STR5 description: String Value for state 5 default: '' - - arg_type: str + - type: str name: STR6 description: String Value for state 6 default: '' - - arg_type: str + - type: str name: STR7 description: String Value for state 7 default: '' - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: ftvl description: Type of data in subArray default: USHORT @@ -1741,227 +1741,227 @@ defs: - name: NX102_vacValve description: Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: EtherIP Port Name - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - arg_type: id + - type: id name: name description: Object name and associated gui name (Optional - defaults to "") - - arg_type: str + - type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) @@ -2025,19 +2025,19 @@ defs: - name: fastVacuumMaster description: TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: Gui tag - - arg_type: str + - type: str name: dom description: Domain, eg, FE06I - - arg_type: object + - type: object name: fins_port description: FINS port - - arg_type: str + - type: str name: eip_port description: EtherIP port - - arg_type: str + - type: str name: device description: Device prefix values: @@ -2053,20 +2053,20 @@ defs: description: "Template that reads 100 blocks of memory into records so\nthat it can be used in various templates." args: - - arg_type: str + - type: str name: device description: Device prefix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: century description: Read DM$(century)00..DM$(century)99 - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: SCAN description: Scan rate of read record default: 1 second @@ -2082,83 +2082,83 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC." args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: temp description: PV suffix - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: lolo description: Lolo alarm limit - - arg_type: str + - type: str name: low description: Low alarm limit - - arg_type: str + - type: str name: high description: High alarm limit - - arg_type: str + - type: str name: hihi description: Hihi alarm limit - - arg_type: str + - type: str name: hopr description: High operating range - - arg_type: str + - type: str name: lopr description: Low operating range - - arg_type: str + - type: str name: tag description: Tag name on PLC -- default "Temp" for e.g. Temp.Value[tagindex] E default: '"' - - arg_type: str + - type: str name: llsv description: Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - arg_type: int + - type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: Object and gui association name - - arg_type: str + - type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: str + - type: str name: egu description: This associates an edm screen with the template default: C - - arg_type: str + - type: str name: desc description: Description databases: @@ -2191,126 +2191,126 @@ defs: created in the associated template file so that they have the archiver tag applied.\n\ \ Initially created for use with K11's proportional valve (2021)." args: - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: P description: Device Prefix - - arg_type: str + - type: str name: Q description: Device Suffix - - arg_type: str + - type: str name: desc description: Description - - arg_type: str + - type: str name: vlvcc description: Parent PLC control crate device prefix - - arg_type: object + - type: object name: port description: asyn port name of FINS driver - - arg_type: int + - type: int name: SetValue_addr description: Address of the value register for value setting - - arg_type: int + - type: int name: PID_output_addr description: Address of the current PID output value read - - arg_type: int + - type: int name: Control_addr description: Address of the demand register for mode setting - - arg_type: int + - type: int name: PID_addr description: Address of the PID values group read block (starting by Proportional constant) - - arg_type: int + - type: int name: PIDwrite_addr description: Address of the PID values group write block (starting by Proportional constant) - - arg_type: str + - type: str name: units description: Value units - - arg_type: int + - type: int name: precision description: Decimal precision for setpoint (converted from integer) - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: int + - type: int name: VAL0 description: Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: String Value for state 0 default: '' - - arg_type: str + - type: str name: STR1 description: String Value for state 1 default: '' - - arg_type: str + - type: str name: STR2 description: String Value for state 2 default: '' - - arg_type: str + - type: str name: STR3 description: String Value for state 3 default: '' - - arg_type: str + - type: str name: STR4 description: String Value for state 4 default: '' - - arg_type: str + - type: str name: STR5 description: String Value for state 5 default: '' - - arg_type: str + - type: str name: STR6 description: String Value for state 6 default: '' - - arg_type: str + - type: str name: STR7 description: String Value for state 7 default: '' - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: ftvl description: Type of data in subArray default: USHORT - - arg_type: str + - type: str name: UNITS description: common units - - arg_type: int + - type: int name: PREC description: decimal precision for SetPoint and Proportional Constant default: 0 @@ -2389,30 +2389,30 @@ defs: - name: writeFloat32 description: Write an float32 value into a PLC DM variable args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: int + - type: int name: drvl description: Drive low limit default: 0 - - arg_type: int + - type: int name: drvh description: Drive high limit default: 0 @@ -2431,93 +2431,93 @@ defs: description: Template database for reading the status of a DX200 controller through NX102 PLC args: - - arg_type: str + - type: str name: P description: PV prefix - - arg_type: str + - type: str name: Q description: PV suffix - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tag description: ether_ip tag name of robot status - - arg_type: str + - type: str name: numbits description: number of bits used - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: scan description: value update time default: 1 second - - arg_type: str + - type: str name: desc description: Description default: '' - - arg_type: str + - type: str name: label0 description: Label string for status bit 0 default: unused - - arg_type: str + - type: str name: label1 description: Label string for status bit 1 default: unused - - arg_type: str + - type: str name: label2 description: Label string for status bit 2 default: unused - - arg_type: str + - type: str name: label3 description: Label string for status bit 3 default: unused - - arg_type: str + - type: str name: label4 description: Label string for status bit 4 default: unused - - arg_type: str + - type: str name: label5 description: Label string for status bit 5 default: unused - - arg_type: str + - type: str name: label6 description: Label string for status bit 6 default: unused - - arg_type: str + - type: str name: label7 description: Label string for status bit 7 default: unused - - arg_type: str + - type: str name: label8 description: Label string for status bit 8 default: unused - - arg_type: str + - type: str name: label9 description: Label string for status bit 9 default: unused - - arg_type: str + - type: str name: labelA description: Label string for status bit 10 default: unused - - arg_type: str + - type: str name: labelB description: Label string for status bit 11 default: unused - - arg_type: str + - type: str name: labelC description: Label string for status bit 12 default: unused - - arg_type: str + - type: str name: labelD description: Label string for status bit 13 default: unused - - arg_type: str + - type: str name: labelE description: Label string for status bit 14 default: unused - - arg_type: str + - type: str name: labelF description: This associates a BOY screen with the template default: unused @@ -2551,58 +2551,58 @@ defs: - name: interlockNameOverride description: Template allowing interlock names to be overriden. args: - - arg_type: str + - type: str name: device description: device prefix - - arg_type: str + - type: str name: interlock description: Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 databases: @@ -2630,96 +2630,96 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: temp description: PV suffix - - arg_type: str + - type: str name: desc description: Description - - arg_type: str + - type: str name: tmpcc description: Parent temperature control crate prefix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: offset description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - arg_type: str + - type: str name: lolo description: Lolo alarm limit - - arg_type: str + - type: str name: low description: Low alarm limit - - arg_type: str + - type: str name: high description: High alarm limit - - arg_type: str + - type: str name: hihi description: Hihi alarm limit - - arg_type: str + - type: str name: hopr description: High operating range - - arg_type: str + - type: str name: lopr description: Low operating range - - arg_type: str + - type: str name: llsv description: Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: scale factor for temperature/setpoint default: 10 - - arg_type: int + - type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: Object and gui association name - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: int + - type: int name: incentury description: The Century digit(s) for the PLC D address to read temperature values default: 2 - - arg_type: int + - type: int name: outcentury description: The Century digit(s) for the PLC D address to write setpoints default: 1 - - arg_type: str + - type: str name: egu description: This associates an edm screen with the template default: C @@ -2757,10 +2757,10 @@ defs: - name: motionLimitInterlock description: TODO:ADD DESCRIPTION args: - - arg_type: object + - type: object name: PLC description: Instance of motionInterlockPLC to belong to - - arg_type: enum + - type: enum name: axisNo description: Axis Number values: @@ -2772,273 +2772,273 @@ defs: '"8"': '"2"': '"3"': - - arg_type: enum + - type: enum name: pLim description: 1 for +lim, 0 for -lim values: '"0"': '"1"': - - arg_type: str + - type: str name: ilk0 description: Interlock 0 description default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock 1 description default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock 2 description default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock 3 description default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock 4 description default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock 5 description default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock 6 description default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock 7 description default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock 8 description default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock 9 description default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock 10 description default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock 11 description default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock 12 description default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock 13 description default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock 14 description default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock 15 description default: unused - name: vacPump description: Template database for a vacuum Pump without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: device name of Pump control crate - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to On) default: On - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Off) default: Off - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to On) default: On - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Turning On) default: Turning On - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Off) default: Off - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Turning Off) default: Turning Off - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - arg_type: enum + - type: enum name: pumptype description: Type of Pump default: turbo @@ -3046,51 +3046,51 @@ defs: '"cryo"': '"scroll"': '"turbo"': - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -3148,7 +3148,7 @@ defs: ilksta_label3: ilk5: name: - pumparg_type: + pumptype: con_label3: ilk9: ilk6: @@ -3162,46 +3162,46 @@ defs: - name: readInt32 description: Read the Int32 value stored in 2 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: str + - type: str name: port description: Template argument - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: int + - type: int name: scale description: Scaling of raw value into EGUs default: 1 - - arg_type: int + - type: int name: roffset description: Pre scaling offset in cts default: 0 - - arg_type: int + - type: int name: offset description: Offset of value in EGUs default: 0 - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: scan description: Template argument default: 1 second - - arg_type: str + - type: str name: egu description: Template argument default: mm - - arg_type: int + - type: int name: prec description: Template argument default: 3 @@ -3224,41 +3224,41 @@ defs: description: "Template database for a group of up to 8 vacuum valves\nPete Owens - 3/5/05" args: - - arg_type: str + - type: str name: device description: device name - - arg_type: float + - type: float name: delay description: delay between opening valves - - arg_type: str + - type: str name: valve1 description: Valve 1 device name - - arg_type: str + - type: str name: valve2 description: Valve 2 device name - - arg_type: str + - type: str name: valve3 description: Valve 3 device name - - arg_type: str + - type: str name: valve4 description: Valve 4 device name - - arg_type: str + - type: str name: valve5 description: Valve 5 device name - - arg_type: str + - type: str name: valve6 description: Valve 6 device name - - arg_type: str + - type: str name: valve7 description: Valve 7 device name - - arg_type: str + - type: str name: valve8 description: Valve 8 device name - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) default: Service @@ -3280,246 +3280,246 @@ defs: - name: NX102_fastValve description: Template database for a fast vacuum valve. args: - - arg_type: str + - type: str name: device description: Mandatory. Device name of the fast valve used as PV name prefix. - - arg_type: str + - type: str name: port description: Mandatory. EtherIP communication port name. - - arg_type: str + - type: str name: tag description: Mandatory. NX PLC protocol tag string. - - arg_type: int + - type: int name: tagidx description: Mandatory. NX PLC tag index number. - - arg_type: int + - type: int name: ILKNUM description: Mandatory. Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: Optional. Defaults to "". If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. default: '' - - arg_type: str + - type: str name: whylocked description: Optional. Defaults to "Open command not allowed". String for GUI screen as to precisely why the device is locked and by whom. default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: Optional. Defaults to Open. Label string for control value 0. default: Open - - arg_type: str + - type: str name: con_label1 description: Optional. Defaults to Close. Label string for control value 1. default: Close - - arg_type: str + - type: str name: con_label2 description: Optional. Defaults to Reset. Label string for control value 2. default: Reset - - arg_type: str + - type: str name: con_label3 description: Optional. Defaults to Arm. Label string for control value 3. default: Arm - - arg_type: str + - type: str name: con_label4 description: Optional. Defaults to "". Label string for control value 4. default: Partially Arm - - arg_type: str + - type: str name: con_label5 description: Optional. Defaults to "". Label string for control value 5. default: '' - - arg_type: str + - type: str name: con_label6 description: Optional. Defaults to "". Label string for control value 6. default: '' - - arg_type: str + - type: str name: con_label7 description: Optional. Defaults to "". Label string for control value 7. default: '' - - arg_type: str + - type: str name: sta_label0 description: "Optional. Defaults to Fault.\t\t Label string for status value 0." default: Fault - - arg_type: str + - type: str name: sta_label1 description: "Optional. Defaults to Open Fully Armed.\t Label string for status value 1." default: Open Armed - - arg_type: str + - type: str name: sta_label2 description: "Optional. Defaults to Opening.\t\t Label string for status value 2." default: Opening - - arg_type: str + - type: str name: sta_label3 description: "Optional. Defaults to Closed.\t\t Label string for status value 3." default: Closed - - arg_type: str + - type: str name: sta_label4 description: "Optional. Defaults to Closing.\t\t Label string for status value 4." default: Closing - - arg_type: str + - type: str name: sta_label5 description: "Optional. Defaults to Open Disarmed.\t Label string for status value 5." default: Open Disarmed - - arg_type: str + - type: str name: sta_label6 description: Optional. Defaults to Open Partially Armed. Label string for status value 6. default: Partially Armed - - arg_type: str + - type: str name: sta_label7 description: "Optional. Defaults to \"\". \t \t Label string for status value 7." default: '' - - arg_type: str + - type: str name: sta_sv0 description: "Optional. Defaults to MAJOR. \t Alarm severity for status value 0." default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 1." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 2." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 3." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 4." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 5." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 6." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 7." default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Optional. Defaults to Failed. Label string for status value 0. default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Optional. Defaults to Run Ilks Ok. Label string for status value 1. default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: "Optional. Defaults to OK. \t Label string for status value 2." default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Optional. Defaults to Disarmed. Label string for status value 3. default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: "Optional. Defaults to \"\".\t Label string for status value 4." default: '' - - arg_type: str + - type: str name: ilksta_label5 description: "Optional. Defaults to \"\".\t Label string for status value 5." default: '' - - arg_type: str + - type: str name: ilksta_label6 description: "Optional. Defaults to \"\".\t Label string for status value 6." default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Optional. Defaults to "". Label string for status value 7. default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - arg_type: str + - type: str name: mode2 description: Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - arg_type: str + - type: str name: DIRILK1 description: Optional. Defaults to "". Component interlock PV names (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1. default: '' - - arg_type: int + - type: int name: showilk description: 'Optional. Defaults to 0. Which set of interlocks to display - 0: Gauge 1: Arm' default: 0 - - arg_type: id + - type: id name: name description: Optional. Defaults to "". Object name and associated gui name. @@ -3581,13 +3581,13 @@ defs: - name: NX102_radmonreset description: "Template database for a vacuum valve\nIan Gillingham October 2012" args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: asyn port name - - arg_type: str + - type: str name: radmon_device description: full PV name of RAD MON :RESET:OK databases: @@ -3599,312 +3599,312 @@ defs: - name: vacValveSoftOpening description: Template database for a soft opening vacuum valve. args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: 'device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address' - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - arg_type: str + - type: str name: fullilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: fullilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: fullilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: fullilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: fullilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: fullilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: fullilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: fullilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: fullilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: fullilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: fullilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: fullilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: fullilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: fullilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: fullilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: fullilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: softilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: softilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: softilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: softilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: softilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: softilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: softilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: softilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: softilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: softilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: softilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: softilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: softilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: softilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: softilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: softilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Soft Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to Full Open) default: Full Open - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Full Open) default: Full Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Soft Open) default: Soft Open - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for interlock status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for interlock status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Label string for interlock status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Label string for interlock status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Label string for interlock status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Label string for interlock status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: allowpv description: Template argument default: '' - - arg_type: str + - type: str name: whylocked description: Template argument default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Template argument default: 0 @@ -3990,244 +3990,244 @@ defs: description: Template5B database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: device name of valve control crate - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Off - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: '' - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Off - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: '' - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: This associates an edm screen with the template default: Service - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -4318,64 +4318,64 @@ defs: to allow transfers. (NOTE: In descriptions and macro names, "arm" is a noun referring to the sample manipulator arm and not a verb as used for a fast valve).' args: - - arg_type: str + - type: str name: device description: Mandatory. Device name. - - arg_type: str + - type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: tag_sourceparam description: Mandatory. NX PLC tag string to write the source chamber parameter. - - arg_type: str + - type: str name: tag_targetparam description: Mandatory. NX PLC tag string to write the target chamber parameter. - - arg_type: str + - type: str name: tag_setcoil description: Mandatory. NX PLC tag string to set a Coil to TRUE. - - arg_type: str + - type: str name: tag_unsetcoil description: Mandatory. NX PLC tag string to set a Coil to FALSE. - - arg_type: str + - type: str name: tag_Tsourceparam description: Optional. Defaults to T$(tag_sourceparam). NX PLC tag string to set the trigger to set the source chamber parameter. default: T$(tag_sourceparam) - - arg_type: str + - type: str name: tag_Ttargetparam description: Optional. Defaults to T$(tag_targetparam). NX PLC tag string to set the trigger to set the target chamber parameter. default: T$(tag_targetparam) - - arg_type: str + - type: str name: tag_Tsetcoil description: Optional. Defaults to T$(tag_setcoil). NX PLC tag string to set the trigger to set a Coil to TRUE. default: T$(tag_setcoil) - - arg_type: str + - type: str name: tag_Tunsetcoil description: Optional. Defaults to T$(tag_unsetcoil). NX PLC tag string to set the trigger to set a Coil to FALSE. default: T$(tag_unsetcoil) - - arg_type: float + - type: float name: coilout_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the coil output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. (These are the records which run commands). default: 0.2 - - arg_type: float + - type: float name: paramout_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the parameter output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - arg_type: float + - type: float name: trigger_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - arg_type: int + - type: int name: posportIDs_allowedmask description: Optional. Defaults to 0. Mask of bits set for each posportID number which is allowed as source and target. (i.e. a chamber is present). Bit 0 @@ -4383,200 +4383,200 @@ defs: has special functionality for error recovery as a source. Although the macro is optional, the default value doesnt allow any transfers, so you must set this. default: 0 - - arg_type: str + - type: str name: posportID0_shortdesc description: Optional. Defaults to Arm. Short (for menu) description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to get a readable menu button. default: Arm - - arg_type: str + - type: str name: posportID1_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 1. default: '' - - arg_type: str + - type: str name: posportID2_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 2. default: '' - - arg_type: str + - type: str name: posportID3_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 3. default: '' - - arg_type: str + - type: str name: posportID4_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 4. default: '' - - arg_type: str + - type: str name: posportID5_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 5. default: '' - - arg_type: str + - type: str name: posportID6_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 6. default: '' - - arg_type: str + - type: str name: posportID7_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 7. default: '' - - arg_type: str + - type: str name: posportID8_shortdesc description: Optional. Defaults to empty string. Short (for menu) description of posport 8. default: '' - - arg_type: str + - type: str name: posportID0_sourceSV description: Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - arg_type: str + - type: str name: posportID0_targetSV description: Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - arg_type: str + - type: str name: posportID1_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID2_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID3_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID4_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID5_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID6_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID7_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID8_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID1_compass description: Optional. Defaults to E. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen for posport ID1. default: E - - arg_type: str + - type: str name: posportID2_compass description: Optional. Defaults to NE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID2. default: NE - - arg_type: str + - type: str name: posportID3_compass description: Optional. Defaults to N. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID3. default: N - - arg_type: str + - type: str name: posportID4_compass description: Optional. Defaults to NW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID4. default: NW - - arg_type: str + - type: str name: posportID5_compass description: Optional. Defaults to W. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID5. default: W - - arg_type: str + - type: str name: posportID6_compass description: Optional. Defaults to SW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID6. default: SW - - arg_type: str + - type: str name: posportID7_compass description: Optional. Defaults to S. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID7. default: S - - arg_type: str + - type: str name: posportID8_compass description: Optional. Defaults to SE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID8. default: SE - - arg_type: str + - type: str name: ctrlprefix description: Optional. Defaults to :CTRL Prefix for SM control records. default: :CTRL - - arg_type: str + - type: str name: paramprefix description: Optional. Defaults to :PARAM Prefix for SM parameter records. default: :PARAM - - arg_type: int + - type: int name: paramprec description: Optional. Defaults to 0. Precision of the parameter value. default: 0 - - arg_type: str + - type: str name: staprefix description: Optional. Defaults to :STA Prefix for SM status records for screens. Must match SM status template. default: :STA - - arg_type: str + - type: str name: posportprefix description: Optional. Defaults to :POSPORT Prefix for SM port status records for screens. Must match definitions for SM port status template. default: :POSPORT - - arg_type: str + - type: str name: sourceparam_shortdesc description: Optional. Defaults to Source. Short description or name of the Source parameter. default: Source - - arg_type: str + - type: str name: targetparam_shortdesc description: Optional. Defaults to Target. Short description or name of the Target parameter. default: Target - - arg_type: str + - type: str name: sourceparam_longdesc description: Optional. Defaults to $(sourceparam_shortdesc=Source) chamber to move from. Long description of the Source Parameter. default: $(sourceparam_shortdesc=Source) chamber to move from. - - arg_type: str + - type: str name: targetparam_longdesc description: Optional. Defaults to $(targetparam_shortdesc=Target) chamber to move to. Long description of the Target Parameter. default: ' $(targetparam_shortdesc=Target) chamber to move to.' - - arg_type: int + - type: int name: sourceparam_init description: Optional. Defaults to 0 (Arm). Initial value of the user demand for the Source parameter. Helps the display on reboot in the absence of autosave. default: 0 - - arg_type: int + - type: int name: targetparam_init description: Optional. Defaults to 1. Initial value of the user demand for the Target parameter. Helps the display on reboot in the absence of autosave. The @@ -4584,278 +4584,278 @@ defs: value of 1 is arbitrary. Recommend set this to the ID of one of the ports which is present in the manipulator configuration. default: 1 - - arg_type: int + - type: int name: trigger_onval description: Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - arg_type: int + - type: int name: trigger_offval description: Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - arg_type: str + - type: str name: trigger_ONAM description: Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - arg_type: str + - type: str name: trigger_ZNAM description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - arg_type: float + - type: float name: trigger_pulseDLY description: Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - arg_type: int + - type: int name: ackprepare_bitno description: Optional. Defaults to 0. Number (0 to 15) of the bit in the status word which acknowledges response to the prepare transfer command. default: 0 - - arg_type: int + - type: int name: acktransfer_bitno description: Optional. Defaults to 1. Number (0 to 15) of the bit in the status word which acknowledges response to the transfer command. default: 1 - - arg_type: int + - type: int name: ackabort_bitno description: Optional. Defaults to 2. Number (0 to 15) of the bit in the status word which acknowledges response to the abort transfer command. default: 2 - - arg_type: int + - type: int name: ackclear_bitno description: Optional. Defaults to 3. Number (0 to 15) of the bit in the status word which acknowledges response to the clear error command. default: 3 - - arg_type: str + - type: str name: ackprepare_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the prepare transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: acktransfer_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackabort_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the abort transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackclear_status description: Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the clear error command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackprepare_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of prepare for transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: acktransfer_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackabort_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of abort transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackclear_ZNAM description: Optional. Defaults to No Request. Label for off state (ZNAM field) of clear error command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackprepare_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of prepare for transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: acktransfer_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: ackabort_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of abort transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: ackclear_ONAM description: Optional. Defaults to Request. Label for on state (ONAM field) of clear error command acknowledgement. default: Request - - arg_type: str + - type: str name: acksource_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of source parameter acknowledgement. default: No Trigger - - arg_type: str + - type: str name: acktarget_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of target parameter acknowledgement. default: No Trigger - - arg_type: str + - type: str name: acksource_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of source parameter acknowledgement. default: Trigger - - arg_type: str + - type: str name: acktarget_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of target parameter acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackmotorcurrenton_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current on command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackmotorcurrentoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current off command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackmotorcurrenton_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current on command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackmotorcurrentoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current off command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackcompressedairon_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air on command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackcompressedairoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air off command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackcompressedairon_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air on command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackcompressedairoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air off command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackholderonarmon_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to True. default: No Trigger - - arg_type: str + - type: str name: ackholderonarmoff_ZNAM description: Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to False. default: No Trigger - - arg_type: str + - type: str name: ackholderonarmon_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to True. default: Trigger - - arg_type: str + - type: str name: ackholderonarmoff_ONAM description: Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to False. default: Trigger - - arg_type: str + - type: str name: ingprepare_ZNAM description: Optional. Defaults to Not Preparing. Label for off state (ZNAM field) of in progress for prepare command. default: Not Preparing - - arg_type: str + - type: str name: ingprepare_ONAM description: Optional. Defaults to Preparing. Label for on state (ONAM field) of in progress for prepare command. default: Preparing - - arg_type: str + - type: str name: ingtransfer_ZNAM description: Optional. Defaults to Not Transferring. Label for off state (ZNAM field) of in progress for transfer command. default: Not Transferring - - arg_type: str + - type: str name: ingtransfer_ONAM description: Optional. Defaults to Transferring. Label for on state (ONAM field) of in progress for transfer command. default: Transferring - - arg_type: str + - type: str name: ingabort_ZNAM description: Optional. Defaults to Not Aborting. Label for off state (ZNAM field) of in progress for abort command. default: Not Aborting - - arg_type: str + - type: str name: ingabort_ONAM description: Optional. Defaults to Aborting. Label for on state (ONAM field) of in progress for abort command. default: Aborting - - arg_type: str + - type: str name: ingclear_ZNAM description: Optional. Defaults to Not Clearing. Label for off state (ZNAM field) of in progress for clear command. default: Not Clearing - - arg_type: str + - type: str name: ingclear_ONAM description: Optional. Defaults to Clearing. Label for on state (ONAM field) of in progress for clear command. default: Clearing - - arg_type: int + - type: int name: ingprepare_bitno description: Optional. Defaults to 11. Number (0 to 15) of the bit in the status word for the in progress status for the prepare command. default: 11 - - arg_type: int + - type: int name: ingtransfer_bitno description: Optional. Defaults to 10. Number (0 to 15) of the bit in the status word for the in progress status for the transfer command. default: 10 - - arg_type: int + - type: int name: ingabort_bitno1 description: Optional. Defaults to 1. Number (0 to 15) of the bit in the status word for the in progress status for the abort command. default: 1 - - arg_type: int + - type: int name: ingabort_bitno2 description: Optional. Defaults to 15. Number (0 to 15) of the bit in the status word for the aborted status for the abort command. default: 15 - - arg_type: str + - type: str name: ingprepare_status description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the prepare command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ingtransfer_status description: Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ingabort_status1 description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERERRORS2). Record for status word to link to extract in progress status for the abort command from. default: $(device)$(staprefix=:STA):TRANSFERERRORS2 - - arg_type: str + - type: str name: ingabort_status2 description: Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERSTATUS). Record for status word to link to extract aborted status for the abort command from. This @@ -4863,7 +4863,7 @@ defs: Modbus PLC failing to update some of its status including the aborting in progress bit which once set persists until the next command. default: $(device)$(staprefix=:STA):TRANSFERSTATUS - - arg_type: id + - type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -4979,314 +4979,314 @@ defs: - name: vacValve description: Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: 'device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address' - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: desc description: Box label for gui default: $(device) - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -5374,469 +5374,469 @@ defs: - name: NX102_sequence description: Template database for control and interlock of a non-specific device. args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. S (from S.Interfc[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Start command not allowed - - arg_type: int + - type: int name: stastrSCAN description: Scan rate for :STASTR PV string read in seconds, may be 10,5,2 or 1. Use to reduce network traffic if comms problems (Optional - defaults to 1) default: 1 - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Start) default: Start - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Abort) default: Abort - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Not running) default: Not running - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Running) default: Running - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Aborted) default: Aborted - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to MINOR) default: MINOR - - arg_type: str + - type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: p1_desc description: Label string for parameter 1 (Optional - defaults to "Param1") default: Param1 - - arg_type: int + - type: int name: p1_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p1_prec description: Precision of p1 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p1_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p1_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p1_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_desc description: Label string for parameter 2 (Optional - defaults to "Param2") default: Param2 - - arg_type: int + - type: int name: p2_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p2_prec description: Precision of p2 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p2_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p2_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p2_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_desc description: Label string for parameter 3 (Optional - defaults to "Param3") default: Param3 - - arg_type: int + - type: int name: p3_isEnum description: Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p3_prec description: Precision of p3 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p3_LOPR description: LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_HOPR description: HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label0 description: Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p3_label1 description: Label string for enum value 1 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label2 description: Label string for enum value 2 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label3 description: Label string for enum value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label4 description: Label string for enum value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label5 description: Label string for enum value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label6 description: Label string for enum value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label7 description: Label string for enum value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label8 description: Label string for enum value 8 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label9 description: Label string for enum value 9 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label10 description: Label string for enum value 10 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label11 description: Label string for enum value 11 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label12 description: Label string for enum value 12 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label13 description: Label string for enum value 13 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label14 description: Label string for enum value 14 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: p3_label15 description: Label string for enum value 15 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - arg_type: id + - type: id name: name description: Object name and associated gui name (Optional - defaults to "") @@ -5960,34 +5960,34 @@ defs: description: Template database for status info regarding a Port on PreVac Sample Manipulator. args: - - arg_type: str + - type: str name: device description: Mandatory. Device name. - - arg_type: str + - type: str name: posportID description: Mandatory. ID of the vacuum port position for the sample manipulator. Must be integer 1 to 8 or 0 for special case of Arm in RDC/UFO and overall status. - - arg_type: str + - type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: tag description: Mandatory. NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: Mandatory. NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: str + - type: str name: tagname description: Mandatory. NX PLC tag name. - - arg_type: str + - type: str name: tagprefix description: Mandatory. NX PLC prefix to tag name. - - arg_type: str + - type: str name: posportprefix description: Optional. Defaults to ":POSPORT". Prefix for the vacuum port position records. default: :POSPORT - - arg_type: int + - type: int name: smready_bitno description: 'Optional. Defaults to "1". Bit number in port position status for whether sample manipulator inside the chamber is in position @@ -5997,7 +5997,7 @@ defs: The intended use is for signals derived from GPIO on GeoBricks with other sample manipulator motors on them.' default: 1 - - arg_type: int + - type: int name: sampleholder_bitno description: 'Optional. Defaults to "2". Bit number in port position status for whether sample holder is present inside the chamber, values 0-15. The @@ -6005,122 +6005,122 @@ defs: the "Holder On Arm" bit, whereas the other ports address the "Sample Inside" bit. NOTE: The sample holder might not have a sample in it!' default: 2 - - arg_type: str + - type: str name: desc_label0 description: Optional. Defaults to "PrepareForTransfer". Descriptive label for bit0 of the Coil word. default: PrepareForTransfer - - arg_type: str + - type: str name: desc_label1 description: Optional. Defaults to "ReadyForTransfer". Descriptive label for bit1 of the Coil word. default: ReadyForTransfer - - arg_type: str + - type: str name: desc_label2 description: Optional. Defaults to "SampleInside". Descriptive label for bit2 of the Coil word. default: SampleInside - - arg_type: str + - type: str name: desc_label3 description: Optional. Defaults to "Error". Descriptive label for bit3 of the Coil word. default: Error - - arg_type: str + - type: str name: desc_label4 description: Optional. Defaults to "Busy". Descriptive label for bit4 of the Coil word. default: Busy - - arg_type: str + - type: str name: desc_label5 description: Optional. Defaults to "GateOpenRequest". Descriptive label for bit5 of the Coil word. default: GateOpenRequest - - arg_type: str + - type: str name: desc_label6 description: Optional. Defaults to "GateOpen". Descriptive label for bit6 of the Coil word. default: GateOpen - - arg_type: str + - type: str name: desc_label7 description: Optional. Defaults to "GateClosed". Descriptive label for bit7 of the Coil word. default: GateClosed - - arg_type: str + - type: str name: desc_label8 description: Optional. Defaults to "ArmOnPort". Descriptive label for bit8 of the Coil word. default: ArmOnPort - - arg_type: str + - type: str name: desc_label9 description: Optional. Defaults to "ReservedForFuture". Descriptive label for bit9 of the Coil word. default: ReservedForFuture - - arg_type: str + - type: str name: desc_label10 description: Optional. Defaults to "". Descriptive label for bit10 of the Coil word. default: '' - - arg_type: str + - type: str name: desc_label11 description: Optional. Defaults to "". Descriptive label for bit11 of the Coil word. default: '' - - arg_type: str + - type: str name: desc_label12 description: Optional. Defaults to "". Descriptive label for bit12 of the Coil word. default: '' - - arg_type: str + - type: str name: desc_label13 description: Optional. Defaults to "". Descriptive label for bit13 of the Coil word. default: '' - - arg_type: str + - type: str name: desc_label14 description: Optional. Defaults to "". Descriptive label for bit14 of the Coil word. default: '' - - arg_type: str + - type: str name: desc_label15 description: Optional. Defaults to "". Descriptive label for bit15 of the Coil word. default: '' - - arg_type: str + - type: str name: longdesc description: Optional. Defaults to "Manipulator Position Port $(posportID) status." Description of position port. default: Manipulator Position Port $(posportID) status. - - arg_type: str + - type: str name: shortdesc description: Optional. Defaults to "Posport$(posportID)" Short, abbreviated description of position port. default: Posport$(posportID) - - arg_type: str + - type: str name: chamber_name description: Optional. Defaults to "". Name of vacuum chamber associated with position port. default: '' - - arg_type: str + - type: str name: chamber_shortname description: Optional. Defaults to "". Short name of vacuum chamber associated with position port. default: '' - - arg_type: str + - type: str name: valve_device description: Optional. Defaults to "". Device name of vacuum valve associated with position port. So far it is a string for info only, no calcs. default: '' - - arg_type: str + - type: str name: valve_shortname description: Optional. Defaults to "". Short, abbreviated name of vacuum valve associated with the position port. default: '' - - arg_type: str + - type: str name: valve_desc description: Optional. Defaults to "". Description of vacuum valve associated with position port. default: '' - - arg_type: id + - type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -6164,28 +6164,28 @@ defs: - name: NX102_readReal description: TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: Template argument - - arg_type: str + - type: str name: port description: Template argument - - arg_type: str + - type: str name: tag description: Template argument - - arg_type: str + - type: str name: desc description: Template argument default: '' - - arg_type: str + - type: str name: scan description: Template argument default: 1 second - - arg_type: str + - type: str name: egu description: Template argument default: '' - - arg_type: int + - type: int name: prec description: Template argument default: 2 @@ -6202,206 +6202,206 @@ defs: - name: NX102_genericDevice description: Template database for control and interlock of a non-specific device. args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. S (from S.Interfc[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Off - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: '' - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Off - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: '' - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - arg_type: id + - type: id name: name description: Object name and associated gui name (Optional - defaults to "") @@ -6461,20 +6461,20 @@ defs: description: Power cycle an RGA where the PLC code has been setup to power cycle when 1 is written to a particular DM variable args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: addr description: DM variable to write to to reboot rga - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: id + - type: id name: name description: Object name and associated gui name databases: @@ -6489,51 +6489,51 @@ defs: description: Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: variable description: PV suffix (its associated _RBV will be autogenerated). - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: tag name of ether_ip read value - - arg_type: str + - type: str name: tagwrite description: tag name of ether_ip write value - - arg_type: str + - type: str name: drvl description: Lowest accepted value - - arg_type: str + - type: str name: drvh description: Highest accepted value - - arg_type: int + - type: int name: tagidx description: Template argument - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: desc description: Description default: '' - - arg_type: str + - type: str name: readscan description: value update time for readback value default: 1 second - - arg_type: float + - type: float name: writescan description: value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - arg_type: str + - type: str name: egu description: Engineering units default: '' - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 2 @@ -6557,227 +6557,227 @@ defs: - name: NX102_vacValveDebounce description: Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: EtherIP Port Name - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - arg_type: id + - type: id name: name description: Object name and associated gui name (Optional - defaults to "") - - arg_type: str + - type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) @@ -6845,260 +6845,260 @@ defs: of the pump which might be available and also be required typically via serial control, for example settings configuration or service period information.' args: - - arg_type: str + - type: str name: device description: Mandatory. Device name of the pump. - - arg_type: str + - type: str name: port description: Mandatory. Name of port for the ether_ip driver for the PLC controlling/interlocking the pump. - - arg_type: str + - type: str name: tag description: Mandatory. NX PLC tag string e.g. S for Scroll or T for Turbo. - - arg_type: int + - type: int name: tagidx description: Mandatory. NX PLC tag index number. Typically this is the same as the id number in the device name, but - - arg_type: str + - type: str name: allowpv description: Optional. Defaults to "". If specified, then only write an "open" i.e. on command when this is non-zero. MUST have CP at the end of it. The term "open" here and in PV names is because of heritage from valve control. Generally by default the "open" command for a pump actually signifies turn it on. default: '' - - arg_type: str + - type: str name: whylocked description: Optional. Defaults to "On command not allowed". String to output to EDM synoptic as to precisely why the device is locked and by whom. default: On command not allowed - - arg_type: str + - type: str name: con_label0 description: Optional. Defaults to On. Label string for control value 0 default: On - - arg_type: str + - type: str name: con_label1 description: Optional. Defaults to Off. Label string for control value 1 default: Off - - arg_type: str + - type: str name: con_label2 description: Optional. Defaults to Reset. Label string for control value 2 default: Reset - - arg_type: str + - type: str name: con_label3 description: Optional. Defaults to Standby. Label string for control value 3 default: '' - - arg_type: str + - type: str name: con_label4 description: Optional. Defaults to FullSpeed. Label string for control value 4 default: '' - - arg_type: str + - type: str name: con_label5 description: Optional. Defaults to "". Label string for control value 5 default: '' - - arg_type: str + - type: str name: con_label6 description: Optional. Defaults to "". Label string for control value 6 default: '' - - arg_type: str + - type: str name: con_label7 description: Optional. Defaults to "". Label string for control value 7 default: '' - - arg_type: str + - type: str name: sta_label0 description: Optional. Defaults to Fault. Label string for status value 0 default: Fault - - arg_type: str + - type: str name: sta_label1 description: Optional. Defaults to On. Label string for status value 1 default: On - - arg_type: str + - type: str name: sta_label2 description: Optional. Defaults to Standby. Label string for status value 2 default: Standby - - arg_type: str + - type: str name: sta_label3 description: Optional. Defaults to Off. Label string for status value 3 default: Off - - arg_type: str + - type: str name: sta_label4 description: Optional. Defaults to "". Label string for status value 4 default: FullSpeed - - arg_type: str + - type: str name: sta_label5 description: Optional. Defaults to "". Label string for status value 5 default: '' - - arg_type: str + - type: str name: sta_label6 description: Optional. Defaults to "". Label string for status value 6 default: '' - - arg_type: str + - type: str name: sta_label7 description: Optional. Defaults to "". Label string for status value 7 default: '' - - arg_type: str + - type: str name: sta_sv0 description: "Optional. Defaults to MAJOR. \t Alarm severity for status value 0." default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 1." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 2." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 3." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 4." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 5." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 6." default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: "Optional. Defaults to NO_ALARM. \t Alarm severity for status value 7." default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Optional. Defaults to Failed. Label string for status value 0 default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Optional. Defaults to Run Ilks OK. Label string for status value 1 default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Optional. Defaults to OK. Label string for status value 2 default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Optional. Defaults to "". Label string for status value 3 default: '' - - arg_type: str + - type: str name: ilksta_label4 description: Optional. Defaults to "". Label string for status value 4 default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Optional. Defaults to "". Label string for status value 5 default: '' - - arg_type: str + - type: str name: ilksta_label6 description: Optional. Defaults to "". Label string for status value 6 default: '' - - arg_type: str + - type: str name: ilksta_label7 description: Optional. Defaults to "". Label string for status value 7 default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - arg_type: str + - type: str name: mode2 description: Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - arg_type: str + - type: str name: short_desc description: Optional. Defaults to Shorting Plug. Description field on the PLUG record DESC field for whether a shorting plug is present. default: Shorting Plug - - arg_type: str + - type: str name: short_label0 description: Optional. Defaults to Dummy. Label on the PLUG record ZNAM field for no shorting plug present. default: Dummy - - arg_type: str + - type: str name: short_label1 description: Optional. Defaults to Real. Label on the PLUG record ONAM field for shorting plug present. default: Real - - arg_type: str + - type: str name: short_sv0 description: Optional. Defaults to NO_ALARM. Severity on the PLUG record ZSV field for the status value 0. default: NO_ALARM - - arg_type: str + - type: str name: short_sv1 description: Optional. Defaults to NO_ALARM. Severity on the PLUG record OSV field for the status value 1. default: NO_ALARM - - arg_type: id + - type: id name: name description: Optional. Defaults to "". Object name and associated gui name. @@ -7162,20 +7162,20 @@ defs: - name: NX102_powerSupply description: Template showing the status of the power supply from the ether IP readings args: - - arg_type: str + - type: str name: device description: device prefix - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from PSU.Voltage[1]) - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. PSU (from PSU.Voltage[1]) default: PSU - - arg_type: id + - type: id name: name description: Object name and associated gui name databases: @@ -7190,89 +7190,89 @@ defs: description: "Template database for an individual temperature on a\ntemperature PLC. Requires an instance of dlsPLC_read100 for century=1 and\ncentury=2" args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: temp description: PV suffix - - arg_type: str + - type: str name: desc description: Description - - arg_type: str + - type: str name: tmpcc description: Parent temperature control crate prefix - - arg_type: str + - type: str name: offset description: 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - arg_type: str + - type: str name: lolo description: Lolo alarm limit - - arg_type: str + - type: str name: low description: Low alarm limit - - arg_type: str + - type: str name: high description: High alarm limit - - arg_type: str + - type: str name: hihi description: Hihi alarm limit - - arg_type: str + - type: str name: hopr description: High operating range - - arg_type: str + - type: str name: lopr description: Low operating range - - arg_type: str + - type: str name: llsv description: Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: scale factor for temperature/setpoint default: 10 - - arg_type: int + - type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: Object and gui association name - - arg_type: str + - type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: int + - type: int name: incentury description: The Century digit(s) for the PLC D address to read temperature values default: 2 - - arg_type: int + - type: int name: outcentury description: The Century digit(s) for the PLC D address to write setpoints default: 1 - - arg_type: str + - type: str name: egu description: This associates an edm screen with the template default: C @@ -7309,28 +7309,28 @@ defs: description: "Template showing the status of various MPS interlocks in\nan Omron NX102 PLC." args: - - arg_type: str + - type: str name: device description: device prefix - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: interlock description: Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. ILK (from ILK.Control[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from ILK.Control[1]) - - arg_type: str + - type: str name: desc description: Permit description (e.g. Front end permit) - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: int + - type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -7349,19 +7349,19 @@ defs: - name: NX102_digitalIn_Debounced description: TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: Template argument - - arg_type: str + - type: str name: port description: Template argument - - arg_type: int + - type: int name: tagidx description: Template argument - - arg_type: id + - type: id name: name description: Template argument - - arg_type: str + - type: str name: tag description: Template argument default: Digital_In @@ -7377,14 +7377,14 @@ defs: description: Template for Warning GUI banner for stale data from the PreVac Sample Manipulator controller. args: - - arg_type: str + - type: str name: device description: Mandatory. Device name of sample manipulator. - - arg_type: str + - type: str name: staprefix description: Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - arg_type: id + - type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -7398,34 +7398,34 @@ defs: description: Template database for reading a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: variable description: PV suffix for this robot variable - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: tag name of ether_ip read value - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: desc description: Description default: '' - - arg_type: str + - type: str name: scan description: value update time default: 1 second - - arg_type: str + - type: str name: egu description: Engineering units default: '' - - arg_type: int + - type: int name: prec description: This associates an edm screen with the template default: 2 @@ -7444,102 +7444,102 @@ defs: - name: interlockSummary description: Template database for a summary PV of up to 24 interlocks args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: ilk1 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk2 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk3 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk4 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk5 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk6 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk7 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk8 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk9 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk10 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk11 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk12 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk13 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk14 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk15 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk16 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk17 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk18 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk19 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk20 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk21 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk22 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk23 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk24 description: Interlock suffix (e.g. INT1) default: NO-INTERLOCK @@ -7575,127 +7575,127 @@ defs: description: Template database for status info on PreVac Sample Manipulator (in addition to that for individual SM Ports). args: - - arg_type: str + - type: str name: device description: Mandatory. Device name. - - arg_type: str + - type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: staprefix description: Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - arg_type: str + - type: str name: posportprefix description: Optional. Defaults to :POSPORT Prefix for records for individual ports. Must match port template. default: :POSPORT - - arg_type: str + - type: str name: posportID0_shortdesc description: Optional. Defaults to Arm. Short description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to make things sensible. Leave the ones not present (i.e. no chamber connected as empty string.) default: Arm - - arg_type: str + - type: str name: posportID1_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 1, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID2_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 2, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID3_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 3, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID4_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 4, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID5_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 5, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID6_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 6, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID7_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 7, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID8_shortdesc description: Optional. Defaults to empty string. Short description of posport with ID 8, recommend use an abbreviated chamber name but only if a chamber is present. default: '' - - arg_type: str + - type: str name: posportID0_sourceSV description: Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - arg_type: str + - type: str name: posportID0_targetSV description: Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - arg_type: str + - type: str name: posportID1_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID2_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID3_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID4_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID5_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID6_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID7_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID8_SV description: Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - arg_type: id + - type: id name: name description: Optional. Defaults to empty. Object name and associated gui name @@ -7730,94 +7730,94 @@ defs: description: "Template showing the status of various MPS interlocks in\na PLC. Requires dlsPLC_read100 for any century used" args: - - arg_type: str + - type: str name: device description: device prefix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: interlock description: Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: desc description: Permit description (e.g. Front end permit) - - arg_type: str + - type: str name: addr description: First address in the DM variable range. E.g. if interlock is in DM800..808 then addr=800 - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: int + - type: int name: auto_reset description: Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -7852,16 +7852,16 @@ defs: - name: fastVacuumChannel description: TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: Gui tag - - arg_type: object + - type: object name: master description: Master - - arg_type: str + - type: str name: img description: Base IMG PV - - arg_type: enum + - type: enum name: id description: FV PLC gauge number values: @@ -7875,7 +7875,7 @@ defs: '07': '06': '01': - - arg_type: enum + - type: enum name: em description: EM block to use default: 0 @@ -7883,7 +7883,7 @@ defs: '"0"': '"1"': '"2"': - - arg_type: int + - type: int name: timeout description: asyn fins_port timeout default: 0 @@ -7909,34 +7909,34 @@ defs: - name: vacValveDebounce description: Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: vlvcc description: device name of valve control crate - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol default: 0 - - arg_type: enum + - type: enum name: valvetype description: Type of Device default: valve @@ -7944,285 +7944,285 @@ defs: '"valve"': '"absorber"': '"shutter"': - - arg_type: str + - type: str name: ilk0 description: Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: Object name and associated gui name - - arg_type: str + - type: str name: desc description: Box label for gui default: $(device) - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE) default: Service - - arg_type: str + - type: str name: ilksta_label0 description: Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_label5 description: Template argument default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Template argument default: NO_ALARM @@ -8236,7 +8236,7 @@ defs: ilk10: ilk11: ilk12: - valvearg_type: + valvetype: gda_name: allowpv: ilk8: @@ -8311,22 +8311,22 @@ defs: - name: readInt16 description: Read the Int16 value stored in 1 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: vlvcc description: PLC control crate device prefix - - arg_type: str + - type: str name: addr description: DM variable of the int - - arg_type: id + - type: id name: name description: Object name and gui association name - - arg_type: str + - type: str name: ftvl description: Type of data in subArray default: USHORT @@ -8342,23 +8342,23 @@ defs: - name: writeInt16 description: Write an int32 value into a PLC DM variable args: - - arg_type: str + - type: str name: P description: device prefix - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: port description: asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: Object name and gui association name databases: @@ -8375,48 +8375,48 @@ defs: read back by valve controller PLC so their state is known, but control is not available. args: - - arg_type: str + - type: str name: device description: device name of the valve. - - arg_type: str + - type: str name: vlvcc description: device name of valve control crate - - arg_type: str + - type: str name: addr description: First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Partial) default: Partial - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: id + - type: id name: name description: This associates an edm screen with the template - - arg_type: str + - type: str name: valvetype description: Template argument default: manualValve @@ -8425,7 +8425,7 @@ defs: args: vlvcc: addr: - valvearg_type: + valvetype: sta_label5: sta_label4: sta_label6: @@ -8438,61 +8438,61 @@ defs: - name: NX102_PreVacCoils_SMLVDT description: Template database for an LVDT on PreVac Sample Manipulator. args: - - arg_type: str + - type: str name: device description: Mandatory. Device name. - - arg_type: str + - type: str name: port description: Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: lvdtID description: Mandatory. ID of the LVDT. Defacto it is a number but it need not be. - - arg_type: str + - type: str name: tag description: Mandatory. NX PLC tag string. - - arg_type: str + - type: str name: lvdtprefix description: Optional. Defaults to ":LVDT". Prefix for SM LVDT records. default: :LVDT - - arg_type: str + - type: str name: lvdt_shortname description: Optional. Defaults to "LVDT{{lvdtID}}". Short name of the LVDT. default: LVDT{{lvdtID}} - - arg_type: str + - type: str name: lvdt_shortdesc description: Optional. Defaults to "LVDT {{lvdtID}}". Short description of the LVDT. default: LVDT {{lvdtID}} - - arg_type: str + - type: str name: lvdt_longdesc description: Optional. Defaults to "Manipulator LVDT {{lvdtID}}". Longer description of the LVDT. default: Manipulator LVDT {{lvdtID}} - - arg_type: str + - type: str name: tagidx description: Optional. Defaults to "{{lvdtID}}". NX PLC tag string array index. default: '{{lvdtID}}' - - arg_type: str + - type: str name: pos_SCAN description: 'Optional. Defaults to ".5 second". EPICS .SCAN field. Scan rate for reading encoder. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here.' default: .5 second - - arg_type: int + - type: int name: pos_PREC description: Optional. Defaults to 3. Precision on the encoder position value. default: 3 - - arg_type: str + - type: str name: pos_EGU description: Optional. Defaults to empty string. Engineering units on the encoder value. default: '' - - arg_type: str + - type: str name: pos_LINR description: Optional. Defaults to empty string. Values can be "NO CONVERSION", "SLOPE" (must define pos_ESLO and and pos_EOFF), "LINEAR" (must define pos_EGUL @@ -8500,186 +8500,186 @@ defs: method for encoder value. See EPICS record reference manual sections on the ai record and the convert menu and conversion. default: '' - - arg_type: str + - type: str name: pos_EGUL description: Optional. Defaults to empty string. Low end of LINEAR conversion scale for encoder value. default: '' - - arg_type: str + - type: str name: pos_EGUF description: Optional. Defaults to empty string. High end or full value on LINEAR conversion scale for encoder value. default: '' - - arg_type: str + - type: str name: pos_EOFF description: Optional. Defaults to empty string. The offset on the value for SLOPE conversion. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_ESLO description: Optional. Defaults to empty string. The slope on the value for SLOPE conversion. It will default to 1. default: '' - - arg_type: str + - type: str name: pos_AOFF description: Optional. Defaults to empty string. The raw adjustment offset on the value for conversion for all types of conversion. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_ASLO description: Optional. Defaults to empty string. The raw adjustment slope on the value for conversion for all types of conversion. It will default to 1. default: '' - - arg_type: str + - type: str name: pos_SMOO description: Optional. Defaults to empty string. The smoothing fraction parameter on the smoothing algorithm, value between 0 (no smoothing) and 1 (value never changes), it will default to 0. default: '' - - arg_type: str + - type: str name: pos_HOPR description: Optional. Defaults to empty string. The position high operator display value. Will default to 0. default: '' - - arg_type: str + - type: str name: pos_LOPR description: Optional. Defaults to empty string. The position low operator display value. Will default to 0. default: '' - - arg_type: str + - type: str name: pos_HIHI description: Optional. Defaults to empty string. The position high high limit. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_HIGH description: Optional. Defaults to empty string. The position high limit. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_LOW description: Optional. Defaults to empty string. The position low limit. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_LOLO description: Optional. Defaults to empty string. The position low low limit. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_HHSV description: Optional. Defaults to empty string. The alarm severity for the HIHI alarm. It will default to NO_ALARM. default: '' - - arg_type: str + - type: str name: pos_HSV description: Optional. Defaults to empty string. The alarm severity for the HIGH alarm. It will default to NO_ALARM. default: '' - - arg_type: str + - type: str name: pos_LSV description: Optional. Defaults to empty string. The alarm severity for the LOW alarm. It will default to NO_ALARM. default: '' - - arg_type: str + - type: str name: pos_LLSV description: Optional. Defaults to empty string. The alarm severity for the LOLO alarm. It will default to NO_ALARM. default: '' - - arg_type: str + - type: str name: pos_HYST description: Optional. Defaults to empty string. The alarm deadband or hysteresis for the scaled position. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_ADEL description: Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the scaled position. It will default to 0. default: '' - - arg_type: str + - type: str name: pos_MDEL description: Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the scaled position. It will default to 0. default: '' - - arg_type: str + - type: str name: raw_EGU description: Optional. Defaults to count. Engineering units on the encoder raw value. default: count - - arg_type: str + - type: str name: raw_HYST description: Optional. Defaults to empty string. The alarm deadband or hysteresis for the raw position. It will default to 0. default: '' - - arg_type: str + - type: str name: raw_ADEL description: Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the raw position. It will default to 0. default: '' - - arg_type: str + - type: str name: raw_MDEL description: Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the raw position. It will default to 0. default: '' - - arg_type: int + - type: int name: slope_PREC description: Optional. Defaults to 6. Precision on the derived encoder slope value. default: 6 - - arg_type: str + - type: str name: cal_SCAN description: 'Optional. Defaults to "1 second". EPICS .SCAN field. Scan rate for reading calibration parameters. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here.' default: 1 second - - arg_type: float + - type: float name: calout_scanrate description: Optional. Defaults to .5 The value of scanrate which when writing to NX PLC the calibration output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - arg_type: float + - type: float name: trigger_scanrate description: Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - arg_type: int + - type: int name: trigger_onval description: Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - arg_type: int + - type: int name: trigger_offval description: Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - arg_type: str + - type: str name: trigger_ONAM description: Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - arg_type: str + - type: str name: trigger_ZNAM description: Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - arg_type: float + - type: float name: trigger_pulsestartDLY description: Optional. Defaults to 1.0. Delay in seconds between last calibration parameter write and pulsing the trigger. default: 1.0 - - arg_type: float + - type: float name: trigger_pulsewidthDLY description: Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - arg_type: id + - type: id name: name description: Optional. Defaults to empty. Object name and associated gui name. @@ -8737,20 +8737,20 @@ defs: - name: overrideRequestMain description: Template allowing overrideRequestIndividual instances to be created args: - - arg_type: str + - type: str name: P description: device prefix. This must match a dlsPLC_read100.template device macro - - arg_type: str + - type: str name: Q description: device suffix - - arg_type: str + - type: str name: outaddr description: Output address. Input address is $(outaddr)+1. E.g. if outaddr=80, read DM81 and write DM80. - - arg_type: str + - type: str name: port description: Asyn port for doing serial comms - - arg_type: int + - type: int name: timeout description: Template argument default: 0 @@ -8766,86 +8766,86 @@ defs: description: "Template database for an individual temperature on a front end\ntemperature PLC." args: - - arg_type: str + - type: str name: device description: PV prefix - - arg_type: str + - type: str name: temp description: PV suffix - - arg_type: str + - type: str name: port description: port name of ether_ip driver - - arg_type: int + - type: int name: tagidx description: temperature index on PLC - - arg_type: str + - type: str name: lolo description: Lolo alarm limit - - arg_type: str + - type: str name: low description: Low alarm limit - - arg_type: str + - type: str name: high description: High alarm limit - - arg_type: str + - type: str name: hihi description: Hihi alarm limit - - arg_type: str + - type: str name: hopr description: High operating range - - arg_type: str + - type: str name: lopr description: Low operating range - - arg_type: str + - type: str name: tag description: etherip tag default: Temp - - arg_type: str + - type: str name: llsv description: Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - arg_type: int + - type: int name: tempcal description: temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: Object and gui association name - - arg_type: str + - type: str name: disable_pv description: If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: str + - type: str name: egu description: This associates an edm screen with the template default: C - - arg_type: str + - type: str name: desc description: Description databases: @@ -8877,19 +8877,19 @@ defs: - name: NX102_digitalIn description: TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: Template argument - - arg_type: str + - type: str name: port description: Template argument - - arg_type: int + - type: int name: tagidx description: Template argument - - arg_type: id + - type: id name: name description: Template argument - - arg_type: str + - type: str name: tag description: Template argument default: Digital_In @@ -8905,243 +8905,243 @@ defs: description: Template database for a bistable vacuum valve without debounce or raw air records. It has different interlocks for opening and closing it. args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: EtherIP Port Name - - arg_type: str + - type: str name: tag description: NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: Part of Gauge PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: whylocked description: String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: Label string for control value 3 (Optional - defaults to Close Enable) default: Close Enable - - arg_type: str + - type: str name: con_label4 description: Label string for control value 4 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label5 description: Label string for control value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label6 description: Label string for control value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: con_label7 description: Label string for control value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label0 description: Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: Label string for status value 5 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label6 description: Label string for status value 6 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: sta_sv0 description: Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: Label string for status value 1 (Optional - defaults to Open Disabled) default: Open Disabled - - arg_type: str + - type: str name: ilksta_label2 description: Label string for status value 2 (Optional - defaults to Closed, Open Available) default: Closed, Open Available - - arg_type: str + - type: str name: ilksta_label3 description: Label string for status value 3 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: ilksta_label4 description: Label string for status value 4 (Optional - defaults to Close Disabled) default: Close Disabled - - arg_type: str + - type: str name: ilksta_label5 description: Label string for status value 5 (Optional - defaults to Open, Close Available) default: Open, Close Available - - arg_type: str + - type: str name: ilksta_label6 description: Label string for status value 6 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: ilksta_label7 description: Label string for status value 7 (Optional - defaults to "") default: '' - - arg_type: str + - type: str name: ilksta_sv0 description: Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: name of remote operational mode (:MODE.ZNAM) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: name of local operational mode (:MODE.ONAM) (Optional - defaults to Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve (Optional - defaults to OPEN) default: OPEN - - arg_type: str + - type: str name: DIRILK1_label description: Label string for the interlock 1 "direction". (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: DIRILK2 description: Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to CLOSE) default: CLOSE - - arg_type: str + - type: str name: DIRILK2_label description: Label string for the interlock 2 "direction". (Optional - defaults to Close) default: Close - - arg_type: id + - type: id name: name description: "Object name and associated gui name \t (Optional - defaults to \"\")" - - arg_type: str + - type: str name: desc description: Box label for gui (Optional - defaults to value of device macro) default: $(device) - - arg_type: str + - type: str name: valvetype description: Type of valve for the gui. (Optional - defaults to valve). default: valve @@ -9195,7 +9195,7 @@ defs: sta_sv4: sta_sv7: sta_sv6: - valvearg_type: + valvetype: sta_label6: DIRILK2_label: device: @@ -9207,59 +9207,59 @@ defs: - name: NX102_flowMeter description: Template database for a machine flow meter args: - - arg_type: str + - type: str name: device description: device name - - arg_type: str + - type: str name: port description: asyn port name of etherip driver - - arg_type: int + - type: int name: tagidx description: etherip tag index - - arg_type: str + - type: str name: desc description: Template argument - - arg_type: str + - type: str name: tag description: etherip tag default: FlowRate - - arg_type: str + - type: str name: egu description: EGU default: Litres / Hour - - arg_type: int + - type: int name: prec description: PREC default: 1 - - arg_type: int + - type: int name: hopr description: HOPR default: 300 - - arg_type: float + - type: float name: lopr description: LOPR default: 0.0 - - arg_type: int + - type: int name: hihi description: HIHI default: 295 - - arg_type: int + - type: int name: lolo description: LOLO default: 100 - - arg_type: int + - type: int name: high description: HIGH default: 275 - - arg_type: int + - type: int name: adel description: ADEL default: 50 - - arg_type: int + - type: int name: mdel description: MDEL default: 10 - - arg_type: int + - type: int name: low description: LOW default: 120 diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index b938d8b78..de9aef247 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -4,10 +4,10 @@ "additionalProperties": false, "description": "An argument with an bool value", "properties": { - "arg_type": { + "type": { "const": "bool", "default": "bool", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -43,10 +43,10 @@ "additionalProperties": false, "description": "A script snippet that will have '# ' prepended to every line\nfor insertion into the startup script", "properties": { - "arg_type": { + "type": { "const": "comment", "default": "comment", - "title": "Arg Type" + "title": "Type" }, "when": { "allOf": [ @@ -135,7 +135,7 @@ "object": "#/$defs/ObjectArg", "str": "#/$defs/StrArg" }, - "propertyName": "arg_type" + "propertyName": "type" }, "oneOf": [ { @@ -325,10 +325,10 @@ "additionalProperties": false, "description": "An argument with an enum value", "properties": { - "arg_type": { + "type": { "const": "enum", "default": "enum", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -390,10 +390,10 @@ "additionalProperties": false, "description": "An argument with a float value", "properties": { - "arg_type": { + "type": { "const": "float", "default": "float", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -429,10 +429,10 @@ "additionalProperties": false, "description": "Explicit ID argument that an object can refer to", "properties": { - "arg_type": { + "type": { "const": "id", "default": "id", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -468,10 +468,10 @@ "additionalProperties": false, "description": "An argument with an int value", "properties": { - "arg_type": { + "type": { "const": "int", "default": "int", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -507,10 +507,10 @@ "additionalProperties": false, "description": "An argument with a float value", "properties": { - "arg_type": { + "type": { "const": "list", "default": "list", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -547,10 +547,10 @@ "additionalProperties": false, "description": "A reference to another entity defined in this IOC", "properties": { - "arg_type": { + "type": { "const": "object", "default": "object", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -586,10 +586,10 @@ "additionalProperties": false, "description": "An argument with a str value", "properties": { - "arg_type": { + "type": { "const": "str", "default": "str", - "title": "Arg Type" + "title": "Type" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -647,10 +647,10 @@ "additionalProperties": false, "description": "A script snippet to insert into the startup script", "properties": { - "arg_type": { + "type": { "const": "text", "default": "text", - "title": "Arg Type" + "title": "Type" }, "when": { "default": "every", diff --git a/tests/samples/support/ADCore.ibek.support.yaml b/tests/samples/support/ADCore.ibek.support.yaml index feb1523be..fd1ed3a46 100644 --- a/tests/samples/support/ADCore.ibek.support.yaml +++ b/tests/samples/support/ADCore.ibek.support.yaml @@ -7,51 +7,51 @@ defs: description: |- This plugin can compress NDArrays to Nexus and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileNexus plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -68,13 +68,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -102,56 +102,56 @@ defs: description: |- This plugin is used to calculate the FFT of a time series args: - - arg_type: str + - type: str name: P description: |- Device prefix - - arg_type: str + - type: str name: R description: |- Device suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFFT plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: str + - type: str name: NCHANS description: |- Length of time series waveform - - arg_type: int + - type: int name: TIMEOUT description: |- Asyn port timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -168,43 +168,43 @@ defs: Event: I/O Intr: - - arg_type: float + - type: float name: TIME_LINK description: |- Time in seconds between points (Can point to a record - use CP) default: 0.1 - - arg_type: int + - type: int name: NAME description: |- Label for signal default: 0 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: PRIORITY description: |- Thread priority if ASYN_CANBLOCK is set default: 0 - - arg_type: int + - type: int name: STACKSIZE description: |- Stack size if ASYN_CANBLOCK is set default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -235,51 +235,51 @@ defs: description: |- This plugin attaches position information to NDArrays args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDPosPlugin plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -296,25 +296,25 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: PRIORITY description: |- Max buffers to allocate default: 0 - - arg_type: int + - type: int name: STACKSIZE description: |- Max buffers to allocate @@ -342,51 +342,51 @@ defs: description: |- This plugin writes overlays on the array, like cursors and boxes args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDOverlay plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -403,75 +403,75 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads default: 1 - - arg_type: str + - type: str name: O description: |- NDOverlay Device Suffix - - arg_type: str + - type: str name: NAME description: |- Name for the overlay - - arg_type: str + - type: str name: SHAPE description: |- Shape of the overlay - - arg_type: str + - type: str name: XPOS description: |- Link for the XPos of the overlay - - arg_type: str + - type: str name: YPOS description: |- Link for the YPos of the overlay - - arg_type: str + - type: str name: XCENT description: |- Link for the XCent of the overlay - - arg_type: str + - type: str name: YCENT description: |- Link for the YCent of the overlay - - arg_type: str + - type: str name: XSIZE description: |- Link for the XSize of the overlay - - arg_type: str + - type: str name: YSIZE description: |- Link for the YSize of the overlay - - arg_type: str + - type: str name: XWIDTH description: |- Link for the XWidth of the overlay - - arg_type: str + - type: str name: YWIDTH description: |- Link for the YWdith of the overlay @@ -517,51 +517,51 @@ defs: description: |- This plugin converts arrays from one colour type to another, e.g. Bayer -> RGB1 args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDColorConvert plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -578,19 +578,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -618,51 +618,51 @@ defs: description: |- This plugin can compress NDArrays to HDF5 and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileHDF5 plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Asyn Port timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -679,19 +679,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: XMLSIZE description: |- Number of elements of the XML layout waveform record default: 2048 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -728,39 +728,39 @@ defs: description: |- Null file plugin for deleting driver files args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileHDF5 plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -777,25 +777,25 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -824,32 +824,32 @@ defs: This plugin provides a waveform record that can display the NDArrays produced by its NDARRAY_PORT args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDStdArrays plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: str + - type: str name: TYPE description: |- Asyn Type e.g. Int32 - - arg_type: enum + - type: enum name: FTVL description: |- Field Type of Value @@ -865,36 +865,36 @@ defs: FLOAT: CHAR: - - arg_type: int + - type: int name: NELEMENTS description: |- Number of elements - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -911,19 +911,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -957,51 +957,51 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: str + - type: str name: PORT description: |- Asyn Port name - - arg_type: str + - type: str name: NDARRAY_PORT description: |- Input Array Port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1018,13 +1018,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: PRECOUNT description: |- Pre-trigger frame count default: 100 - - arg_type: int + - type: int name: POSTCOUNT description: |- Post-trigger frame count @@ -1050,51 +1050,51 @@ defs: This plugin can compress NDArrays to a range of formats supported by graphics magick and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileMagick plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1111,13 +1111,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -1145,51 +1145,51 @@ defs: description: |- This plugin provides a pre and post external trigger frame capture buffer args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the FFT_calc plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 1 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1206,31 +1206,31 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: PRECOUNT description: |- Pre-trigger frame count default: 100 - - arg_type: int + - type: int name: POSTCOUNT description: |- Post-trigger frame count default: 100 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 50 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_BUFFERS description: |- Max buffer size in number of frames @@ -1260,51 +1260,51 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: P description: |- Device prefix - - arg_type: str + - type: str name: R description: |- Device suffix - - arg_type: id + - type: id name: PORT description: |- Asyn port name - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Asyn port of the callback source - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Asyn address of the callback source default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1321,40 +1321,40 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 10000 - - arg_type: int + - type: int name: N_CACHE description: |- Number of NDArrays to store in cache default: 10000 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: str + - type: str name: ATTR_IND description: |- Attribute index - - arg_type: str + - type: str name: AXIS description: |- Axis name - - arg_type: str + - type: str name: DATA_IND description: |- Data index - - arg_type: str + - type: str name: DATA_ADDR description: |- Asyn address for this data array @@ -1397,51 +1397,51 @@ defs: description: |- This plugin can compress or decompress NDArrays args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDCodec plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1458,19 +1458,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -1498,41 +1498,41 @@ defs: description: |- This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream args: - - arg_type: str + - type: str name: NDARRAY_PORT description: |- Input Array Port - - arg_type: id + - type: id name: PORT description: |- Port name for the NDGather plugin - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1549,30 +1549,30 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_PORTS description: |- Maximum number of ports that this plugin can connect to for callbacks default: 5 - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix @@ -1601,51 +1601,51 @@ defs: This plugin selects a region of interest and optionally scales it to fit in a particular data type args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDROI plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1662,19 +1662,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -1710,51 +1710,51 @@ defs: description: |- This plugin displays NDArray attributes args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDAttribute plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1771,31 +1771,31 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_ATTRIBUTES description: |- Maximum number of attributes in this plugin default: 8 - - arg_type: int + - type: int name: NCHANS description: |- Number of points in the arrays default: 4096 - - arg_type: str + - type: str name: TS_PORT description: |- Asyn Port of Time Series plugin @@ -1841,90 +1841,90 @@ defs: description: |- This plugin calculates statistics like X and Y profile, centroid, and plots a histogram of binned pixels args: - - arg_type: id + - type: id name: PORT description: |- Port name for the NDStats plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: HIST_SIZE description: |- Maximum size of Pixel binning histogram (e.g. 256 for Int8) - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: int + - type: int name: XSIZE description: |- XSIZE, Maximum size of X histograms (e.g. 1024) - - arg_type: int + - type: int name: YSIZE description: |- Maximum size of Y histograms (e.g. 768) - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: int + - type: int name: NCHANS description: |- Maximum length of time series (initialises waveform NELM, fixed on IOC boot) default: 2048 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads default: 1 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -1941,7 +1941,7 @@ defs: Event: I/O Intr: - - arg_type: str + - type: str name: TS_PORT description: |- TS port @@ -1991,56 +1991,56 @@ defs: description: |- This plugin creates time series arrays from callback data args: - - arg_type: str + - type: str name: P description: |- Device prefix - - arg_type: str + - type: str name: R description: |- Device suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDTimeSeries plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: str + - type: str name: NCHANS description: |- Length of time series waveform - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2057,43 +2057,43 @@ defs: Event: I/O Intr: - - arg_type: float + - type: float name: TIME_LINK description: |- Time between points (Can point to a record - use CP) default: 0.1 - - arg_type: int + - type: int name: NSIGNALS description: |- Maximum number of time series signals default: 1 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: PRIORITY description: |- Thread priority if ASYN_CANBLOCK is set default: 0 - - arg_type: int + - type: int name: STACKSIZE description: |- Stack size if ASYN_CANBLOCK is set default: 0 - - arg_type: str + - type: str name: NAME description: |- Name of the signal @@ -2135,27 +2135,27 @@ defs: Add an attribute to the NDAttributes file for a particular ADDriver or NDPlugin, and associate it with the NDAttributes file args: - - arg_type: object + - type: object name: port description: |- ADDriver or NDPlugin to attach xml file to - - arg_type: str + - type: str name: source description: |- The EPICS PV (if type=EPICS_PV) or attribute name (if type=PARAM) - - arg_type: id + - type: id name: name description: |- Object name. You do not need to specify this - - arg_type: str + - type: str name: attrname description: |- Name of the attribute. If you leave this blank it defaults to - - arg_type: enum + - type: enum name: type description: |- Where the data should be picked up from @@ -2164,7 +2164,7 @@ defs: EPICS_PV: PARAM: - - arg_type: enum + - type: enum name: dbrtype description: |- DBR type (only used if type=EPICS_PV) @@ -2179,7 +2179,7 @@ defs: DBR_LONG: DBR_FLOAT: - - arg_type: enum + - type: enum name: datatype description: |- Data type (only used if type=PARAM) @@ -2189,12 +2189,12 @@ defs: DOUBLE: STRING: - - arg_type: str + - type: str name: description description: |- Description of the attribute - - arg_type: int + - type: int name: addr description: |- Asyn address of the parameter (only used if type=PARAM) @@ -2209,51 +2209,51 @@ defs: This plugin does image processing like flat field correction, background subtraction, and recursive filtering args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDProcess plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2270,13 +2270,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -2312,51 +2312,51 @@ defs: description: |- This plugin can compress NDArrays to TIFF and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileTIFF plugin - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2373,13 +2373,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -2407,41 +2407,41 @@ defs: description: |- This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream args: - - arg_type: str + - type: str name: NDARRAY_PORT description: |- Input Array Port - - arg_type: id + - type: id name: PORT description: |- Port name for the NDGather plugin - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input Array Address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2458,34 +2458,34 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: str + - type: str name: N description: |- Port number (1 - maxPorts) - - arg_type: str + - type: str name: MAX_PORTS description: |- Maximum number ports @@ -2519,51 +2519,51 @@ defs: description: |- This plugin calculates statistics of ROIs args: - - arg_type: str + - type: str name: P description: |- First part of base PV name - - arg_type: str + - type: str name: R description: |- Second part of base PV name - - arg_type: id + - type: id name: PORT description: |- Port name for the NDPluginROIStat plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- asyn address on port default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2580,31 +2580,31 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_ROIS description: |- Maximum number of ROIs in this plugin default: 8 - - arg_type: int + - type: int name: NCHANS description: |- Number of points in the arrays default: 4096 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -2642,51 +2642,51 @@ defs: description: |- This plugin can compress NDArrays to NetCDF and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileNetCDF plugin - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2703,13 +2703,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -2737,56 +2737,56 @@ defs: description: |- This plugin makes NDArrays available through PVAccess args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDPosPlugin plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: str + - type: str name: PVNAME description: |- Name of the PV to post NDArray out on - - arg_type: int + - type: int name: TIMEOUT description: |- Asyn timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2803,25 +2803,25 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: PRIORITY description: |- Max buffers to allocate default: 0 - - arg_type: int + - type: int name: STACKSIZE description: |- Max buffers to allocate @@ -2858,51 +2858,51 @@ defs: description: |- This plugin selects a region of interest and optionally scales it to fit in a particular data type args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDTransform plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -2919,19 +2919,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? default: 0 - - arg_type: int + - type: int name: MAX_THREADS description: |- Maximum number threads @@ -2959,51 +2959,51 @@ defs: description: |- This plugin can compress NDArrays to JPEG and write them to file args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDFileJPEG plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -3020,13 +3020,13 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? @@ -3054,51 +3054,51 @@ defs: description: |- This plugin is used to distribute processing of NDArrays to multiple downstream plugins args: - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: R description: |- Device Suffix - - arg_type: id + - type: id name: PORT description: |- Port name for the NDTimeSeries plugin - - arg_type: object + - type: object name: NDARRAY_PORT description: |- Input array port - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 1 - - arg_type: int + - type: int name: ADDR description: |- Asyn Port address default: 0 - - arg_type: int + - type: int name: NDARRAY_ADDR description: |- Input array port address default: 0 - - arg_type: int + - type: int name: ENABLED description: |- Plugin Enabled at startup? default: 0 - - arg_type: enum + - type: enum name: SCANRATE description: |- Specified scan rate for cpu intensive PVs @@ -3115,19 +3115,19 @@ defs: Event: I/O Intr: - - arg_type: int + - type: int name: NAME description: |- Label for signal default: 0 - - arg_type: int + - type: int name: QUEUE description: |- Input array queue size default: 2 - - arg_type: int + - type: int name: BLOCK description: |- Blocking callbacks? diff --git a/tests/samples/support/asyn.ibek.support.yaml b/tests/samples/support/asyn.ibek.support.yaml index 6d557cd28..ae52a2683 100644 --- a/tests/samples/support/asyn.ibek.support.yaml +++ b/tests/samples/support/asyn.ibek.support.yaml @@ -7,54 +7,54 @@ defs: description: |- Asyn IP Port args: - - arg_type: str + - type: str name: port description: |- Serial port tty name / IP address optionally followed by protocol - - arg_type: id + - type: id name: name description: |- Override name - - arg_type: str + - type: str name: input_eos description: |- Input end of string (terminator) # test escaping of quotes default: '"\n"' - - arg_type: str + - type: str name: output_eos description: |- Output end of string (terminator) default: '"\n"' - - arg_type: int + - type: int name: priority description: |- Priority default: 100 - - arg_type: bool + - type: bool name: noAuto_connect description: |- Set to stop auto_connect default: false - - arg_type: bool + - type: bool name: noProcessEos description: |- Set to avoid processing end of string default: false - - arg_type: int + - type: int name: baud description: |- Baud Rate default: 9600 - - arg_type: enum + - type: enum name: parity description: |- Parity @@ -64,7 +64,7 @@ defs: odd: default: none - - arg_type: enum + - type: enum name: crtscts description: |- Set hardware flow control on @@ -73,7 +73,7 @@ defs: N: default: N - - arg_type: enum + - type: enum name: stop description: |- Stop Bits @@ -82,7 +82,7 @@ defs: "2": default: "1" - - arg_type: enum + - type: enum name: disconnectOnReadTimeout description: |- Disconnect when a read times out @@ -91,7 +91,7 @@ defs: N: default: Y - - arg_type: enum + - type: enum name: bits description: |- Bits diff --git a/tests/samples/support/bad_db.ibek.support.yaml b/tests/samples/support/bad_db.ibek.support.yaml index 50fc00d23..75474c0b9 100644 --- a/tests/samples/support/bad_db.ibek.support.yaml +++ b/tests/samples/support/bad_db.ibek.support.yaml @@ -10,7 +10,7 @@ defs: description: | Example object with a database containing a non-existant arg args: - - arg_type: id + - type: id name: name description: Port name diff --git a/tests/samples/support/dlsPLC.ibek.support.yaml b/tests/samples/support/dlsPLC.ibek.support.yaml index f45ad795a..297612822 100644 --- a/tests/samples/support/dlsPLC.ibek.support.yaml +++ b/tests/samples/support/dlsPLC.ibek.support.yaml @@ -4,104 +4,104 @@ module: dlsPLC defs: - shared: - - &ilk0 { arg_type: str, name: ilk0, description: Interlock description 0, default: unused } - - &ilk1 { arg_type: str, name: ilk1, description: Interlock description 1, default: unused } - - &ilk2 { arg_type: str, name: ilk2, description: Interlock description 2, default: unused } - - &ilk3 { arg_type: str, name: ilk3, description: Interlock description 3, default: unused } - - &ilk4 { arg_type: str, name: ilk4, description: Interlock description 4, default: unused } - - &ilk5 { arg_type: str, name: ilk5, description: Interlock description 5, default: unused } - - &ilk6 { arg_type: str, name: ilk6, description: Interlock description 6, default: unused } - - &ilk7 { arg_type: str, name: ilk7, description: Interlock description 7, default: unused } - - &ilk8 { arg_type: str, name: ilk8, description: Interlock description 8, default: unused } - - &ilk9 { arg_type: str, name: ilk9, description: Interlock description 9, default: unused } - - &ilk10 { arg_type: str, name: ilk10, description: Interlock description 10, default: unused } - - &ilk11 { arg_type: str, name: ilk11, description: Interlock description 11, default: unused } - - &ilk12 { arg_type: str, name: ilk12, description: Interlock description 12, default: unused } - - &ilk13 { arg_type: str, name: ilk13, description: Interlock description 13, default: unused } - - &ilk14 { arg_type: str, name: ilk14, description: Interlock description 14, default: unused } - - &ilk15 { arg_type: str, name: ilk15, description: Interlock description 15, default: unused } - - &cilk0 { arg_type: str, name: cilk0, description: Gauge interlock description 0, default: unused } - - &cilk1 { arg_type: str, name: cilk1, description: Gauge interlock description 1, default: unused } - - &cilk2 { arg_type: str, name: cilk2, description: Gauge interlock description 2, default: unused } - - &cilk3 { arg_type: str, name: cilk3, description: Gauge interlock description 3, default: unused } - - &cilk4 { arg_type: str, name: cilk4, description: Gauge interlock description 4, default: unused } - - &cilk5 { arg_type: str, name: cilk5, description: Gauge interlock description 5, default: unused } - - &cilk6 { arg_type: str, name: cilk6, description: Gauge interlock description 6, default: unused } - - &cilk7 { arg_type: str, name: cilk7, description: Gauge interlock description 7, default: unused } - - &cilk8 { arg_type: str, name: cilk8, description: Gauge interlock description 8, default: unused } - - &cilk9 { arg_type: str, name: cilk9, description: Gauge interlock description 9, default: unused } - - &cilk10 { arg_type: str, name: cilk10, description: Gauge interlock description 10, default: unused } - - &cilk11 { arg_type: str, name: cilk11, description: Gauge interlock description 11, default: unused } - - &cilk12 { arg_type: str, name: cilk12, description: Gauge interlock description 12, default: unused } - - &cilk13 { arg_type: str, name: cilk13, description: Gauge interlock description 13, default: unused } - - &cilk14 { arg_type: str, name: cilk14, description: Gauge interlock description 14, default: unused } - - &cilk15 { arg_type: str, name: cilk15, description: Gauge interlock description 15, default: unused } + - &ilk0 { type: str, name: ilk0, description: Interlock description 0, default: unused } + - &ilk1 { type: str, name: ilk1, description: Interlock description 1, default: unused } + - &ilk2 { type: str, name: ilk2, description: Interlock description 2, default: unused } + - &ilk3 { type: str, name: ilk3, description: Interlock description 3, default: unused } + - &ilk4 { type: str, name: ilk4, description: Interlock description 4, default: unused } + - &ilk5 { type: str, name: ilk5, description: Interlock description 5, default: unused } + - &ilk6 { type: str, name: ilk6, description: Interlock description 6, default: unused } + - &ilk7 { type: str, name: ilk7, description: Interlock description 7, default: unused } + - &ilk8 { type: str, name: ilk8, description: Interlock description 8, default: unused } + - &ilk9 { type: str, name: ilk9, description: Interlock description 9, default: unused } + - &ilk10 { type: str, name: ilk10, description: Interlock description 10, default: unused } + - &ilk11 { type: str, name: ilk11, description: Interlock description 11, default: unused } + - &ilk12 { type: str, name: ilk12, description: Interlock description 12, default: unused } + - &ilk13 { type: str, name: ilk13, description: Interlock description 13, default: unused } + - &ilk14 { type: str, name: ilk14, description: Interlock description 14, default: unused } + - &ilk15 { type: str, name: ilk15, description: Interlock description 15, default: unused } + - &cilk0 { type: str, name: cilk0, description: Gauge interlock description 0, default: unused } + - &cilk1 { type: str, name: cilk1, description: Gauge interlock description 1, default: unused } + - &cilk2 { type: str, name: cilk2, description: Gauge interlock description 2, default: unused } + - &cilk3 { type: str, name: cilk3, description: Gauge interlock description 3, default: unused } + - &cilk4 { type: str, name: cilk4, description: Gauge interlock description 4, default: unused } + - &cilk5 { type: str, name: cilk5, description: Gauge interlock description 5, default: unused } + - &cilk6 { type: str, name: cilk6, description: Gauge interlock description 6, default: unused } + - &cilk7 { type: str, name: cilk7, description: Gauge interlock description 7, default: unused } + - &cilk8 { type: str, name: cilk8, description: Gauge interlock description 8, default: unused } + - &cilk9 { type: str, name: cilk9, description: Gauge interlock description 9, default: unused } + - &cilk10 { type: str, name: cilk10, description: Gauge interlock description 10, default: unused } + - &cilk11 { type: str, name: cilk11, description: Gauge interlock description 11, default: unused } + - &cilk12 { type: str, name: cilk12, description: Gauge interlock description 12, default: unused } + - &cilk13 { type: str, name: cilk13, description: Gauge interlock description 13, default: unused } + - &cilk14 { type: str, name: cilk14, description: Gauge interlock description 14, default: unused } + - &cilk15 { type: str, name: cilk15, description: Gauge interlock description 15, default: unused } # theses would further reduce the duplication but cannot be used because they would require merging lists # which is not supported in the yaml spec - &ilk [*ilk0, *ilk1, *ilk2, *ilk3, *ilk4, *ilk5, *ilk6, *ilk7, *ilk8, *ilk9, *ilk10, *ilk11, *ilk12, *ilk13, *ilk14, *ilk15] - &cilk [*cilk0, *cilk1, *cilk2, *cilk3, *cilk4, *cilk5, *cilk6, *cilk7, *cilk8, *cilk9, *cilk10, *cilk11, *cilk12, *cilk13, *cilk14, *cilk15] - - &con_label0 { arg_type: str, name: con_label0, description: Label string for control value 0 (Optional - defaults to Open), default: Open } - - &con_label1 { arg_type: str, name: con_label1, description: Label string for control value 1 (Optional - defaults to Close), default: Close } - - &con_label2 { arg_type: str, name: con_label2, description: Label string for control value 2 (Optional - defaults to Reset), default: Reset } - - &con_label3 { arg_type: str, name: con_label3, description: Label string for control value 3 (Optional - defaults to ""), default: "" } - - &con_label4 { arg_type: str, name: con_label4, description: Label string for control value 4 (Optional - defaults to ""), default: "" } - - &con_label5 { arg_type: str, name: con_label5, description: Label string for control value 5 (Optional - defaults to ""), default: "" } - - &con_label6 { arg_type: str, name: con_label6, description: Label string for control value 6 (Optional - defaults to ""), default: "" } - - &sta_label0 { arg_type: str, name: sta_label0, description: Label string for status value 0 (Optional - defaults to Fault), default: Fault } - - &sta_label1 { arg_type: str, name: sta_label1, description: Label string for status value 1 (Optional - defaults to Open), default: Open } - - &sta_label2 { arg_type: str, name: sta_label2, description: Label string for status value 2 (Optional - defaults to Opening), default: Opening } - - &sta_label3 { arg_type: str, name: sta_label3, description: Label string for status value 3 (Optional - defaults to Closed), default: Closed } - - &sta_label4 { arg_type: str, name: sta_label4, description: Label string for status value 4 (Optional - defaults to Closing), default: Closing } - - &sta_label5 { arg_type: str, name: sta_label5, description: Label string for status value 5 (Optional - defaults to ""), default: "" } - - &sta_label6 { arg_type: str, name: sta_label6, description: Label string for status value 6 (Optional - defaults to ""), default: "" } - - &sta_sv0 { arg_type: str, name: sta_sv0, description: Optional. Defaults to MAJOR. Alarm severity for status value 0., default: MAJOR } - - &sta_sv1 { arg_type: str, name: sta_sv1, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1., default: NO_ALARM } - - &sta_sv2 { arg_type: str, name: sta_sv2, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2., default: NO_ALARM } - - &sta_sv3 { arg_type: str, name: sta_sv3, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3., default: NO_ALARM } - - &sta_sv4 { arg_type: str, name: sta_sv4, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4., default: NO_ALARM } - - &sta_sv5 { arg_type: str, name: sta_sv5, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5., default: NO_ALARM } - - &sta_sv6 { arg_type: str, name: sta_sv6, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6., default: NO_ALARM } + - &con_label0 { type: str, name: con_label0, description: Label string for control value 0 (Optional - defaults to Open), default: Open } + - &con_label1 { type: str, name: con_label1, description: Label string for control value 1 (Optional - defaults to Close), default: Close } + - &con_label2 { type: str, name: con_label2, description: Label string for control value 2 (Optional - defaults to Reset), default: Reset } + - &con_label3 { type: str, name: con_label3, description: Label string for control value 3 (Optional - defaults to ""), default: "" } + - &con_label4 { type: str, name: con_label4, description: Label string for control value 4 (Optional - defaults to ""), default: "" } + - &con_label5 { type: str, name: con_label5, description: Label string for control value 5 (Optional - defaults to ""), default: "" } + - &con_label6 { type: str, name: con_label6, description: Label string for control value 6 (Optional - defaults to ""), default: "" } + - &sta_label0 { type: str, name: sta_label0, description: Label string for status value 0 (Optional - defaults to Fault), default: Fault } + - &sta_label1 { type: str, name: sta_label1, description: Label string for status value 1 (Optional - defaults to Open), default: Open } + - &sta_label2 { type: str, name: sta_label2, description: Label string for status value 2 (Optional - defaults to Opening), default: Opening } + - &sta_label3 { type: str, name: sta_label3, description: Label string for status value 3 (Optional - defaults to Closed), default: Closed } + - &sta_label4 { type: str, name: sta_label4, description: Label string for status value 4 (Optional - defaults to Closing), default: Closing } + - &sta_label5 { type: str, name: sta_label5, description: Label string for status value 5 (Optional - defaults to ""), default: "" } + - &sta_label6 { type: str, name: sta_label6, description: Label string for status value 6 (Optional - defaults to ""), default: "" } + - &sta_sv0 { type: str, name: sta_sv0, description: Optional. Defaults to MAJOR. Alarm severity for status value 0., default: MAJOR } + - &sta_sv1 { type: str, name: sta_sv1, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 1., default: NO_ALARM } + - &sta_sv2 { type: str, name: sta_sv2, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 2., default: NO_ALARM } + - &sta_sv3 { type: str, name: sta_sv3, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 3., default: NO_ALARM } + - &sta_sv4 { type: str, name: sta_sv4, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 4., default: NO_ALARM } + - &sta_sv5 { type: str, name: sta_sv5, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 5., default: NO_ALARM } + - &sta_sv6 { type: str, name: sta_sv6, description: Optional. Defaults to NO_ALARM. Alarm severity for status value 6., default: NO_ALARM } name: overrideRequestIndividual description: |- Template allowing override of individual interlock bits args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: DESC description: |- Description (e.g. DCM piezo override) - - arg_type: str + - type: str name: PRESSURE1 description: |- Pressure in mbar that needs to be over setpoint to allow override - - arg_type: str + - type: str name: PRESSURE2 description: |- Pressure in mbar that needs to be over setpoint to allow override - - arg_type: str + - type: str name: OVERRIDE description: |- P of overrideRequestMain instance - - arg_type: str + - type: str name: BIT description: |- Bit of overrideRequestMain instance to use (0-8) - - arg_type: str + - type: str name: SETPOINT description: |- Setpoint in mbar that both pressures need to be higher than to allow override - - arg_type: id + - type: id name: name description: |- This associates an edm screen with the template @@ -122,7 +122,7 @@ defs: description: |- Template that reads software version from a PLC. args: - - arg_type: str + - type: str name: device description: |- Device prefix @@ -136,39 +136,39 @@ defs: description: |- Template database for a vacuum valve with different interlocks for open and close operations args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM150..159 then addr=150 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol @@ -228,96 +228,96 @@ defs: - *sta_sv5 - *sta_sv6 - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: valvetype description: |- Template argument default: valve - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- Template argument default: Operational - - arg_type: str + - type: str name: mode2 description: |- Template argument @@ -378,7 +378,7 @@ defs: sta_sv5: sta_sv4: sta_sv6: - valvearg_type: + valvetype: ilk6: ilk2: ilk7: @@ -409,128 +409,128 @@ defs: description: |- Write the Enum value into a DM variable in a PLC args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: int + - type: int name: timeout description: |- timeout on PV write attempts default: 0 - - arg_type: int + - type: int name: VAL0 description: |- Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: |- Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: |- Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: |- Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: |- Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: |- Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: |- Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: |- Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: |- String Value for state 0 default: "" - - arg_type: str + - type: str name: STR1 description: |- String Value for state 1 default: "" - - arg_type: str + - type: str name: STR2 description: |- String Value for state 2 default: "" - - arg_type: str + - type: str name: STR3 description: |- String Value for state 3 default: "" - - arg_type: str + - type: str name: STR4 description: |- String Value for state 4 default: "" - - arg_type: str + - type: str name: STR5 description: |- String Value for state 5 default: "" - - arg_type: str + - type: str name: STR6 description: |- String Value for state 6 default: "" - - arg_type: str + - type: str name: STR7 description: |- String Value for state 7 @@ -570,47 +570,47 @@ defs: bits. E.g. if interlock DM816..818 bit 4 is S1 water, use loloaddress=818,lolobit=4 for instantaneous lolo signal args: - - arg_type: str + - type: str name: P description: |- EPICS prefix - - arg_type: str + - type: str name: Q description: |- EPICS suffix - - arg_type: str + - type: str name: DESC description: |- Description - - arg_type: str + - type: str name: device description: |- EPICS name of the vacuum valve crate that connects to the RIO - - arg_type: str + - type: str name: loaddress description: |- Address of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - arg_type: str + - type: str name: lobit description: |- Bit of lo DM variable. E.g. if lo signal is in DM4 bit1 then loaddress=4 lobit=1 - - arg_type: str + - type: str name: loloaddress description: |- Address of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - arg_type: str + - type: str name: lolobit description: |- Bit of lolo DM variable. E.g. if lolo signal is in DM818 bit4 then loloaddress=818 lolobit=4 - - arg_type: id + - type: id name: name description: |- This associates an edm screen with the template @@ -632,122 +632,122 @@ defs: description: |- Read the Enum value stored in a DM variable in a PLC args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: vlvcc description: |- PLC control crate device prefix - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: int + - type: int name: VAL0 description: |- Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: |- Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: |- Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: |- Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: |- Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: |- Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: |- Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: |- Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: |- String Value for state 0 default: "" - - arg_type: str + - type: str name: STR1 description: |- String Value for state 1 default: "" - - arg_type: str + - type: str name: STR2 description: |- String Value for state 2 default: "" - - arg_type: str + - type: str name: STR3 description: |- String Value for state 3 default: "" - - arg_type: str + - type: str name: STR4 description: |- String Value for state 4 default: "" - - arg_type: str + - type: str name: STR5 description: |- String Value for state 5 default: "" - - arg_type: str + - type: str name: STR6 description: |- String Value for state 6 default: "" - - arg_type: str + - type: str name: STR7 description: |- String Value for state 7 @@ -782,187 +782,187 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: |- Name - - arg_type: str + - type: str name: device description: |- Device Prefix - - arg_type: object + - type: object name: port description: |- Fins port - - arg_type: int + - type: int name: addr description: |- First interlock work - - arg_type: str + - type: str name: axis1Description description: |- Axis 1 Description default: unused - - arg_type: str + - type: str name: axis2Description description: |- Axis 2 Description default: unused - - arg_type: str + - type: str name: axis3Description description: |- Axis 3 Description default: unused - - arg_type: str + - type: str name: axis4Description description: |- Axis 4 Description default: unused - - arg_type: str + - type: str name: axis5Description description: |- Axis 5 Description default: unused - - arg_type: str + - type: str name: axis6Description description: |- Axis 6 Description default: unused - - arg_type: str + - type: str name: axis7Description description: |- Axis 7 Description default: unused - - arg_type: str + - type: str name: axis8Description description: |- Axis 8 Description default: unused - - arg_type: str + - type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: desc description: |- Permit description (e.g. Front end permit) - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: int + - type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -1000,71 +1000,71 @@ defs: description: |- Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: variable description: |- PV suffix (its associated _RBV will be autogenerated). - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: |- tag name of ether_ip read value - - arg_type: str + - type: str name: tagwrite description: |- tag name of ether_ip write value - - arg_type: str + - type: str name: drvl description: |- Lowest accepted value - - arg_type: str + - type: str name: drvh description: |- This associates an edm screen with the template - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: desc description: |- Description default: "" - - arg_type: str + - type: str name: readscan description: |- value update time for readback value default: 1 second - - arg_type: float + - type: float name: writescan description: |- value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - arg_type: str + - type: str name: egu description: |- Engineering units default: "" - - arg_type: int + - type: int name: prec description: |- precision for reporting value back @@ -1091,12 +1091,12 @@ defs: description: |- Valve interface for a valve that lives in another IOC args: - - arg_type: str + - type: str name: device description: |- Device macro of valve that exists in another IOC - - arg_type: enum + - type: enum name: valvetype description: |- Type of Device @@ -1113,126 +1113,126 @@ defs: Peter Denison 30/9/2005, based on vacuum valve by Pete Owens - 26/4/04 args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: con_label0 description: |- con_label0 default: Open - - arg_type: str + - type: str name: con_label1 description: |- con_label1 default: Close - - arg_type: str + - type: str name: con_label2 description: |- con_label2 default: Reset - - arg_type: str + - type: str name: con_label3 description: |- con_label3 default: "" - - arg_type: str + - type: str name: con_label4 description: |- con_label4 default: "" - - arg_type: str + - type: str name: con_label5 description: |- con_label5 default: "" - - arg_type: str + - type: str name: con_label6 description: |- con_label6 default: "" - - arg_type: str + - type: str name: ilksta_label0 description: |- ilksta_label0 default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- ilksta_label1 default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- ilksta_label2 default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- ilksta_label3 default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- ilksta_label4 default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- ilksta_label5 default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- ilksta_sv0 default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- ilksta_sv1 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- ilksta_sv2 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- ilksta_sv3 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- ilksta_sv4 default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- ilksta_sv5 default: NO_ALARM - - arg_type: str + - type: str name: allowpv description: |- Template argument @@ -1267,458 +1267,458 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: Arm - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open Armed - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: Open Disarmed - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: desc description: |- Box label for gui default: $(device) - - arg_type: int + - type: int name: showilk description: |- 0 (default) => Gauge, 1 => Arm default: 0 - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- Template argument default: Operational - - arg_type: str + - type: str name: mode2 description: |- Template argument @@ -1811,27 +1811,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: |- Template argument - - arg_type: str + - type: str name: port description: |- Template argument - - arg_type: str + - type: str name: tag description: |- Template argument - - arg_type: int + - type: int name: tagidx description: |- Template argument - - arg_type: str + - type: str name: DIRILK1 description: |- Template argument @@ -1851,67 +1851,67 @@ defs: Creates beam records that the gui can connect to to see which valves and shutters are open args: - - arg_type: str + - type: str name: P description: |- Device prefix for summary PV, records will be $(P):STA$(N) for 1<=N<=#objects - - arg_type: object + - type: object name: object0 description: |- vacuumValve object - - arg_type: object + - type: object name: object1 description: |- vacuumValve object - - arg_type: object + - type: object name: object2 description: |- vacuumValve object - - arg_type: object + - type: object name: object3 description: |- vacuumValve object - - arg_type: object + - type: object name: object4 description: |- vacuumValve object - - arg_type: object + - type: object name: object5 description: |- vacuumValve object - - arg_type: object + - type: object name: object6 description: |- vacuumValve object - - arg_type: object + - type: object name: object7 description: |- vacuumValve object - - arg_type: object + - type: object name: object8 description: |- vacuumValve object - - arg_type: object + - type: object name: object9 description: |- vacuumValve object - - arg_type: object + - type: object name: object10 description: |- vacuumValve object - - arg_type: object + - type: object name: object11 description: |- vacuumValve object @@ -1920,38 +1920,38 @@ defs: description: |- Read the Float32 value stored in 2 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: SCAN description: |- Scan rate of read record @@ -1973,164 +1973,164 @@ defs: Initially created for use with I22's new (2021) DCM. Calc records are created in the dlsPLC_DCMHeater.template file so that they have the archiver tag applied. args: - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: Q description: |- Device Suffix - - arg_type: str + - type: str name: desc description: |- Description - - arg_type: str + - type: str name: vlvcc description: |- Parent PLC control crate device prefix - - arg_type: object + - type: object name: port description: |- asyn port name of FINS driver - - arg_type: int + - type: int name: C_addr description: |- Address of the demand register - - arg_type: int + - type: int name: UTSP_addr description: |- Address of the under temperature setpoint register - - arg_type: int + - type: int name: PID_offset description: |- 2 digit integer offset of DM variables. E.g. if Proportional gain constant setpoint is in DM150 and readback in DM250 offset=50 - - arg_type: int + - type: int name: PID_output_addr description: |- Address of the PID loop output - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: int + - type: int name: VAL0 description: |- Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: |- Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: |- Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: |- Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: |- Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: |- Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: |- Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: |- Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: |- String Value for state 0 default: "" - - arg_type: str + - type: str name: STR1 description: |- String Value for state 1 default: "" - - arg_type: str + - type: str name: STR2 description: |- String Value for state 2 default: "" - - arg_type: str + - type: str name: STR3 description: |- String Value for state 3 default: "" - - arg_type: str + - type: str name: STR4 description: |- String Value for state 4 default: "" - - arg_type: str + - type: str name: STR5 description: |- String Value for state 5 default: "" - - arg_type: str + - type: str name: STR6 description: |- String Value for state 6 default: "" - - arg_type: str + - type: str name: STR7 description: |- String Value for state 7 default: "" - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: ftvl description: |- Type of data in subArray @@ -2215,313 +2215,313 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- EtherIP Port Name - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: |- Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - arg_type: id + - type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - arg_type: str + - type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) @@ -2588,27 +2588,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: |- Gui tag - - arg_type: str + - type: str name: dom description: |- Domain, eg, FE06I - - arg_type: object + - type: object name: fins_port description: |- FINS port - - arg_type: str + - type: str name: eip_port description: |- EtherIP port - - arg_type: str + - type: str name: device description: |- Device prefix @@ -2630,28 +2630,28 @@ defs: Template that reads 100 blocks of memory into records so that it can be used in various templates. args: - - arg_type: str + - type: str name: device description: |- Device prefix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: century description: |- Read DM$(century)00..DM$(century)99 - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: SCAN description: |- Scan rate of read record @@ -2671,123 +2671,123 @@ defs: Template database for an individual temperature on a temperature PLC. args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: temp description: |- PV suffix - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: lolo description: |- Lolo alarm limit - - arg_type: str + - type: str name: low description: |- Low alarm limit - - arg_type: str + - type: str name: high description: |- High alarm limit - - arg_type: str + - type: str name: hihi description: |- Hihi alarm limit - - arg_type: str + - type: str name: hopr description: |- High operating range - - arg_type: str + - type: str name: lopr description: |- Low operating range - - arg_type: str + - type: str name: tag description: |- Tag name on PLC -- default "Temp" for e.g. Temp.Value[tagindex] E default: '"' - - arg_type: str + - type: str name: llsv description: |- Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: |- Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: |- alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: |- archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: |- scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - arg_type: int + - type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: |- precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: |- Object and gui association name - - arg_type: str + - type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: str + - type: str name: egu description: |- This associates an edm screen with the template default: C - - arg_type: str + - type: str name: desc description: |- Description @@ -2824,190 +2824,190 @@ defs: Calc records are created in the associated template file so that they have the archiver tag applied. Initially created for use with K11's proportional valve (2021). args: - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: P description: |- Device Prefix - - arg_type: str + - type: str name: Q description: |- Device Suffix - - arg_type: str + - type: str name: desc description: |- Description - - arg_type: str + - type: str name: vlvcc description: |- Parent PLC control crate device prefix - - arg_type: object + - type: object name: port description: |- asyn port name of FINS driver - - arg_type: int + - type: int name: SetValue_addr description: |- Address of the value register for value setting - - arg_type: int + - type: int name: PID_output_addr description: |- Address of the current PID output value read - - arg_type: int + - type: int name: Control_addr description: |- Address of the demand register for mode setting - - arg_type: int + - type: int name: PID_addr description: |- Address of the PID values group read block (starting by Proportional constant) - - arg_type: int + - type: int name: PIDwrite_addr description: |- Address of the PID values group write block (starting by Proportional constant) - - arg_type: str + - type: str name: units description: |- Value units - - arg_type: int + - type: int name: precision description: |- Decimal precision for setpoint (converted from integer) - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: int + - type: int name: VAL0 description: |- Value for state 0 default: 0 - - arg_type: int + - type: int name: VAL1 description: |- Value for state 1 default: 1 - - arg_type: int + - type: int name: VAL2 description: |- Value for state 2 default: 2 - - arg_type: int + - type: int name: VAL3 description: |- Value for state 3 default: 3 - - arg_type: int + - type: int name: VAL4 description: |- Value for state 4 default: 4 - - arg_type: int + - type: int name: VAL5 description: |- Value for state 5 default: 5 - - arg_type: int + - type: int name: VAL6 description: |- Value for state 6 default: 6 - - arg_type: int + - type: int name: VAL7 description: |- Value for state 7 default: 7 - - arg_type: str + - type: str name: STR0 description: |- String Value for state 0 default: "" - - arg_type: str + - type: str name: STR1 description: |- String Value for state 1 default: "" - - arg_type: str + - type: str name: STR2 description: |- String Value for state 2 default: "" - - arg_type: str + - type: str name: STR3 description: |- String Value for state 3 default: "" - - arg_type: str + - type: str name: STR4 description: |- String Value for state 4 default: "" - - arg_type: str + - type: str name: STR5 description: |- String Value for state 5 default: "" - - arg_type: str + - type: str name: STR6 description: |- String Value for state 6 default: "" - - arg_type: str + - type: str name: STR7 description: |- String Value for state 7 default: "" - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: str + - type: str name: ftvl description: |- Type of data in subArray default: USHORT - - arg_type: str + - type: str name: UNITS description: |- common units - - arg_type: int + - type: int name: PREC description: |- decimal precision for SetPoint and Proportional Constant @@ -3094,44 +3094,44 @@ defs: description: |- Write an float32 value into a PLC DM variable args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: int + - type: int name: drvl description: |- Drive low limit default: 0 - - arg_type: int + - type: int name: drvh description: |- Drive high limit @@ -3153,139 +3153,139 @@ defs: description: |- Template database for reading the status of a DX200 controller through NX102 PLC args: - - arg_type: str + - type: str name: P description: |- PV prefix - - arg_type: str + - type: str name: Q description: |- PV suffix - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tag description: |- ether_ip tag name of robot status - - arg_type: str + - type: str name: numbits description: |- number of bits used - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: scan description: |- value update time default: 1 second - - arg_type: str + - type: str name: desc description: |- Description default: "" - - arg_type: str + - type: str name: label0 description: |- Label string for status bit 0 default: unused - - arg_type: str + - type: str name: label1 description: |- Label string for status bit 1 default: unused - - arg_type: str + - type: str name: label2 description: |- Label string for status bit 2 default: unused - - arg_type: str + - type: str name: label3 description: |- Label string for status bit 3 default: unused - - arg_type: str + - type: str name: label4 description: |- Label string for status bit 4 default: unused - - arg_type: str + - type: str name: label5 description: |- Label string for status bit 5 default: unused - - arg_type: str + - type: str name: label6 description: |- Label string for status bit 6 default: unused - - arg_type: str + - type: str name: label7 description: |- Label string for status bit 7 default: unused - - arg_type: str + - type: str name: label8 description: |- Label string for status bit 8 default: unused - - arg_type: str + - type: str name: label9 description: |- Label string for status bit 9 default: unused - - arg_type: str + - type: str name: labelA description: |- Label string for status bit 10 default: unused - - arg_type: str + - type: str name: labelB description: |- Label string for status bit 11 default: unused - - arg_type: str + - type: str name: labelC description: |- Label string for status bit 12 default: unused - - arg_type: str + - type: str name: labelD description: |- Label string for status bit 13 default: unused - - arg_type: str + - type: str name: labelE description: |- Label string for status bit 14 default: unused - - arg_type: str + - type: str name: labelF description: |- This associates a BOY screen with the template @@ -3323,92 +3323,92 @@ defs: description: |- Template allowing interlock names to be overriden. args: - - arg_type: str + - type: str name: device description: |- device prefix - - arg_type: str + - type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 @@ -3441,144 +3441,144 @@ defs: temperature PLC. Requires an instance of dlsPLC_read100 for century=1 and century=2 args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: temp description: |- PV suffix - - arg_type: str + - type: str name: desc description: |- Description - - arg_type: str + - type: str name: tmpcc description: |- Parent temperature control crate prefix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: offset description: |- 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - arg_type: str + - type: str name: lolo description: |- Lolo alarm limit - - arg_type: str + - type: str name: low description: |- Low alarm limit - - arg_type: str + - type: str name: high description: |- High alarm limit - - arg_type: str + - type: str name: hihi description: |- Hihi alarm limit - - arg_type: str + - type: str name: hopr description: |- High operating range - - arg_type: str + - type: str name: lopr description: |- Low operating range - - arg_type: str + - type: str name: llsv description: |- Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: |- Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: |- alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: |- archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: |- scale factor for temperature/setpoint default: 10 - - arg_type: int + - type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: |- precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: |- Object and gui association name - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: int + - type: int name: incentury description: |- The Century digit(s) for the PLC D address to read temperature values default: 2 - - arg_type: int + - type: int name: outcentury description: |- The Century digit(s) for the PLC D address to write setpoints default: 1 - - arg_type: str + - type: str name: egu description: |- This associates an edm screen with the template @@ -3620,12 +3620,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: object + - type: object name: PLC description: |- Instance of motionInterlockPLC to belong to - - arg_type: enum + - type: enum name: axisNo description: |- Axis Number @@ -3639,7 +3639,7 @@ defs: '"2"': '"3"': - - arg_type: enum + - type: enum name: pLim description: |- 1 for +lim, 0 for -lim @@ -3647,97 +3647,97 @@ defs: '"0"': '"1"': - - arg_type: str + - type: str name: ilk0 description: |- Interlock 0 description default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock 1 description default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock 2 description default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock 3 description default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock 4 description default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock 5 description default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock 6 description default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock 7 description default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock 8 description default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock 9 description default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock 10 description default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock 11 description default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock 12 description default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock 13 description default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock 14 description default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock 15 description @@ -3747,284 +3747,284 @@ defs: description: |- Template database for a vacuum Pump without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of Pump control crate - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to On) default: On - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Off) default: Off - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to On) default: On - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Turning On) default: Turning On - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Off) default: Off - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Turning Off) default: Turning Off - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - arg_type: enum + - type: enum name: pumptype description: |- Type of Pump @@ -4034,73 +4034,73 @@ defs: '"scroll"': '"turbo"': - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument @@ -4160,7 +4160,7 @@ defs: ilksta_label3: ilk5: name: - pumparg_type: + pumptype: con_label3: ilk9: ilk6: @@ -4176,68 +4176,68 @@ defs: description: |- Read the Int32 value stored in 2 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: str + - type: str name: port description: |- Template argument - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: int + - type: int name: scale description: |- Scaling of raw value into EGUs default: 1 - - arg_type: int + - type: int name: roffset description: |- Pre scaling offset in cts default: 0 - - arg_type: int + - type: int name: offset description: |- Offset of value in EGUs default: 0 - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: scan description: |- Template argument default: 1 second - - arg_type: str + - type: str name: egu description: |- Template argument default: mm - - arg_type: int + - type: int name: prec description: |- Template argument @@ -4264,63 +4264,63 @@ defs: Template database for a group of up to 8 vacuum valves Pete Owens - 3/5/05 args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: float + - type: float name: delay description: |- delay between opening valves - - arg_type: str + - type: str name: valve1 description: |- Valve 1 device name - - arg_type: str + - type: str name: valve2 description: |- Valve 2 device name - - arg_type: str + - type: str name: valve3 description: |- Valve 3 device name - - arg_type: str + - type: str name: valve4 description: |- Valve 4 device name - - arg_type: str + - type: str name: valve5 description: |- Valve 5 device name - - arg_type: str + - type: str name: valve6 description: |- Valve 6 device name - - arg_type: str + - type: str name: valve7 description: |- Valve 7 device name - - arg_type: str + - type: str name: valve8 description: |- Valve 8 device name - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) @@ -4346,308 +4346,308 @@ defs: description: |- Template database for a fast vacuum valve. args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name of the fast valve used as PV name prefix. - - arg_type: str + - type: str name: port description: |- Mandatory. EtherIP communication port name. - - arg_type: str + - type: str name: tag description: |- Mandatory. NX PLC protocol tag string. - - arg_type: int + - type: int name: tagidx description: |- Mandatory. NX PLC tag index number. - - arg_type: int + - type: int name: ILKNUM description: |- Mandatory. Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: |- Optional. Defaults to "". If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. default: "" - - arg_type: str + - type: str name: whylocked description: |- Optional. Defaults to "Open command not allowed". String for GUI screen as to precisely why the device is locked and by whom. default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Optional. Defaults to Open. Label string for control value 0. default: Open - - arg_type: str + - type: str name: con_label1 description: |- Optional. Defaults to Close. Label string for control value 1. default: Close - - arg_type: str + - type: str name: con_label2 description: |- Optional. Defaults to Reset. Label string for control value 2. default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Optional. Defaults to Arm. Label string for control value 3. default: Arm - - arg_type: str + - type: str name: con_label4 description: |- Optional. Defaults to "". Label string for control value 4. default: Partially Arm - - arg_type: str + - type: str name: con_label5 description: |- Optional. Defaults to "". Label string for control value 5. default: "" - - arg_type: str + - type: str name: con_label6 description: |- Optional. Defaults to "". Label string for control value 6. default: "" - - arg_type: str + - type: str name: con_label7 description: |- Optional. Defaults to "". Label string for control value 7. default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Optional. Defaults to Fault. Label string for status value 0. default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Optional. Defaults to Open Fully Armed. Label string for status value 1. default: Open Armed - - arg_type: str + - type: str name: sta_label2 description: |- Optional. Defaults to Opening. Label string for status value 2. default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Optional. Defaults to Closed. Label string for status value 3. default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Optional. Defaults to Closing. Label string for status value 4. default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Optional. Defaults to Open Disarmed. Label string for status value 5. default: Open Disarmed - - arg_type: str + - type: str name: sta_label6 description: |- Optional. Defaults to Open Partially Armed. Label string for status value 6. default: Partially Armed - - arg_type: str + - type: str name: sta_label7 description: |- Optional. Defaults to "". Label string for status value 7. default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 7. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Optional. Defaults to Failed. Label string for status value 0. default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Optional. Defaults to Run Ilks Ok. Label string for status value 1. default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Optional. Defaults to OK. Label string for status value 2. default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Optional. Defaults to Disarmed. Label string for status value 3. default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Optional. Defaults to "". Label string for status value 4. default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Optional. Defaults to "". Label string for status value 5. default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Optional. Defaults to "". Label string for status value 6. default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Optional. Defaults to "". Label string for status value 7. default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - arg_type: str + - type: str name: mode2 description: |- Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - arg_type: str + - type: str name: DIRILK1 description: |- Optional. Defaults to "". Component interlock PV names (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1. default: "" - - arg_type: int + - type: int name: showilk description: |- Optional. Defaults to 0. Which set of interlocks to display - 0: Gauge 1: Arm default: 0 - - arg_type: id + - type: id name: name description: |- Optional. Defaults to "". Object name and associated gui name. @@ -4713,17 +4713,17 @@ defs: Template database for a vacuum valve Ian Gillingham October 2012 args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- asyn port name - - arg_type: str + - type: str name: radmon_device description: |- full PV name of RAD MON :RESET:OK @@ -4739,434 +4739,434 @@ defs: description: |- Template database for a soft opening vacuum valve. args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - arg_type: str + - type: str name: fullilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: fullilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: fullilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: fullilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: fullilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: fullilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: fullilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: fullilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: fullilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: fullilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: fullilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: fullilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: fullilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: fullilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: fullilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: fullilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: softilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: softilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: softilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: softilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: softilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: softilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: softilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: softilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: softilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: softilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: softilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: softilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: softilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: softilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: softilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: softilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Soft Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to Full Open) default: Full Open - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Full Open) default: Full Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Soft Open) default: Soft Open - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for interlock status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for interlock status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for interlock status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for interlock status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for interlock status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for interlock status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: allowpv description: |- Template argument default: "" - - arg_type: str + - type: str name: whylocked description: |- Template argument default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Template argument @@ -5255,350 +5255,350 @@ defs: description: |- Template5B database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Off - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: "" - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Off - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: "" - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: |- This associates an edm screen with the template default: Service - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument @@ -5673,631 +5673,631 @@ defs: description: |- Template database for a control of PreVac Sample Manipulator. Two parameters for source and target chambers (where to transfer sample from and to respectively) have to be written. Further writes to NX PLC registers act commands to turn on motors and gas, and transfer commands for Prepare, Transfer, Abort, Reset. Each of these writes has to have associated pulsed trigger writes to cause the NX PLC to act on the latest value. The NX PLC processes the requested value and decides whether to pass it to the PreVac Modbus PLC. If the latter, the PreVac Modbus PLC also processes the requested value and decides whether to act on it or not. EPICS does not have any direct communication with the PreVac Modbus PLC. Intentions for macros as follows: (1) Strings for posportID_shortdesc macros should be provided only for ports which are present, but they should be left alone as empty strings for ports which are not present. (2) Alarm severities of MAJOR should be defined for posportID_SV macros for ports which are not present, but those which are present are left alone as NO_ALARM. (3) Setting the posportID_compass macros must result in a unique compass direction for all ports n=1-8 for the embedded diagram display on the Control screen to work properly. The default values conform to this. (4) Set targetparam_init to a posport ID number of a port which is present. (5) The value of posportIDs_allowedmask defaults to a safe value of 0, which causes no transfers to be allowed, so you must define it according to the ports present to allow transfers. (NOTE: In descriptions and macro names, "arm" is a noun referring to the sample manipulator arm and not a verb as used for a fast valve). args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name. - - arg_type: str + - type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: tag_sourceparam description: |- Mandatory. NX PLC tag string to write the source chamber parameter. - - arg_type: str + - type: str name: tag_targetparam description: |- Mandatory. NX PLC tag string to write the target chamber parameter. - - arg_type: str + - type: str name: tag_setcoil description: |- Mandatory. NX PLC tag string to set a Coil to TRUE. - - arg_type: str + - type: str name: tag_unsetcoil description: |- Mandatory. NX PLC tag string to set a Coil to FALSE. - - arg_type: str + - type: str name: tag_Tsourceparam description: |- Optional. Defaults to T$(tag_sourceparam). NX PLC tag string to set the trigger to set the source chamber parameter. default: T$(tag_sourceparam) - - arg_type: str + - type: str name: tag_Ttargetparam description: |- Optional. Defaults to T$(tag_targetparam). NX PLC tag string to set the trigger to set the target chamber parameter. default: T$(tag_targetparam) - - arg_type: str + - type: str name: tag_Tsetcoil description: |- Optional. Defaults to T$(tag_setcoil). NX PLC tag string to set the trigger to set a Coil to TRUE. default: T$(tag_setcoil) - - arg_type: str + - type: str name: tag_Tunsetcoil description: |- Optional. Defaults to T$(tag_unsetcoil). NX PLC tag string to set the trigger to set a Coil to FALSE. default: T$(tag_unsetcoil) - - arg_type: float + - type: float name: coilout_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the coil output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. (These are the records which run commands). default: 0.2 - - arg_type: float + - type: float name: paramout_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC the parameter output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - arg_type: float + - type: float name: trigger_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - arg_type: int + - type: int name: posportIDs_allowedmask description: |- Optional. Defaults to 0. Mask of bits set for each posportID number which is allowed as source and target. (i.e. a chamber is present). Bit 0 represents the Arm - do NOT set that bit, it is not allowed as a target and has special functionality for error recovery as a source. Although the macro is optional, the default value doesnt allow any transfers, so you must set this. default: 0 - - arg_type: str + - type: str name: posportID0_shortdesc description: |- Optional. Defaults to Arm. Short (for menu) description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to get a readable menu button. default: Arm - - arg_type: str + - type: str name: posportID1_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 1. default: "" - - arg_type: str + - type: str name: posportID2_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 2. default: "" - - arg_type: str + - type: str name: posportID3_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 3. default: "" - - arg_type: str + - type: str name: posportID4_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 4. default: "" - - arg_type: str + - type: str name: posportID5_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 5. default: "" - - arg_type: str + - type: str name: posportID6_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 6. default: "" - - arg_type: str + - type: str name: posportID7_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 7. default: "" - - arg_type: str + - type: str name: posportID8_shortdesc description: |- Optional. Defaults to empty string. Short (for menu) description of posport 8. default: "" - - arg_type: str + - type: str name: posportID0_sourceSV description: |- Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - arg_type: str + - type: str name: posportID0_targetSV description: |- Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - arg_type: str + - type: str name: posportID1_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID2_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID3_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID4_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID5_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID6_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID7_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID8_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID1_compass description: |- Optional. Defaults to E. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen for posport ID1. default: E - - arg_type: str + - type: str name: posportID2_compass description: |- Optional. Defaults to NE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID2. default: NE - - arg_type: str + - type: str name: posportID3_compass description: |- Optional. Defaults to N. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID3. default: N - - arg_type: str + - type: str name: posportID4_compass description: |- Optional. Defaults to NW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID4. default: NW - - arg_type: str + - type: str name: posportID5_compass description: |- Optional. Defaults to W. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID5. default: W - - arg_type: str + - type: str name: posportID6_compass description: |- Optional. Defaults to SW. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID6. default: SW - - arg_type: str + - type: str name: posportID7_compass description: |- Optional. Defaults to S. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID7. default: S - - arg_type: str + - type: str name: posportID8_compass description: |- Optional. Defaults to SE. Allowed values N,NW,W,SW,S,SE,E,NE. Position in the layout of the sample manipulator diagram on the control screen brought up from the Control button on the generated screen, posport ID8. default: SE - - arg_type: str + - type: str name: ctrlprefix description: |- Optional. Defaults to :CTRL Prefix for SM control records. default: :CTRL - - arg_type: str + - type: str name: paramprefix description: |- Optional. Defaults to :PARAM Prefix for SM parameter records. default: :PARAM - - arg_type: int + - type: int name: paramprec description: |- Optional. Defaults to 0. Precision of the parameter value. default: 0 - - arg_type: str + - type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for SM status records for screens. Must match SM status template. default: :STA - - arg_type: str + - type: str name: posportprefix description: |- Optional. Defaults to :POSPORT Prefix for SM port status records for screens. Must match definitions for SM port status template. default: :POSPORT - - arg_type: str + - type: str name: sourceparam_shortdesc description: |- Optional. Defaults to Source. Short description or name of the Source parameter. default: Source - - arg_type: str + - type: str name: targetparam_shortdesc description: |- Optional. Defaults to Target. Short description or name of the Target parameter. default: Target - - arg_type: str + - type: str name: sourceparam_longdesc description: |- Optional. Defaults to $(sourceparam_shortdesc=Source) chamber to move from. Long description of the Source Parameter. default: $(sourceparam_shortdesc=Source) chamber to move from. - - arg_type: str + - type: str name: targetparam_longdesc description: |- Optional. Defaults to $(targetparam_shortdesc=Target) chamber to move to. Long description of the Target Parameter. default: " $(targetparam_shortdesc=Target) chamber to move to." - - arg_type: int + - type: int name: sourceparam_init description: |- Optional. Defaults to 0 (Arm). Initial value of the user demand for the Source parameter. Helps the display on reboot in the absence of autosave. default: 0 - - arg_type: int + - type: int name: targetparam_init description: |- Optional. Defaults to 1. Initial value of the user demand for the Target parameter. Helps the display on reboot in the absence of autosave. The default value could not be left at 0 because the Arm is never allowed as target. The value of 1 is arbitrary. Recommend set this to the ID of one of the ports which is present in the manipulator configuration. default: 1 - - arg_type: int + - type: int name: trigger_onval description: |- Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - arg_type: int + - type: int name: trigger_offval description: |- Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - arg_type: str + - type: str name: trigger_ONAM description: |- Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - arg_type: str + - type: str name: trigger_ZNAM description: |- Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - arg_type: float + - type: float name: trigger_pulseDLY description: |- Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - arg_type: int + - type: int name: ackprepare_bitno description: |- Optional. Defaults to 0. Number (0 to 15) of the bit in the status word which acknowledges response to the prepare transfer command. default: 0 - - arg_type: int + - type: int name: acktransfer_bitno description: |- Optional. Defaults to 1. Number (0 to 15) of the bit in the status word which acknowledges response to the transfer command. default: 1 - - arg_type: int + - type: int name: ackabort_bitno description: |- Optional. Defaults to 2. Number (0 to 15) of the bit in the status word which acknowledges response to the abort transfer command. default: 2 - - arg_type: int + - type: int name: ackclear_bitno description: |- Optional. Defaults to 3. Number (0 to 15) of the bit in the status word which acknowledges response to the clear error command. default: 3 - - arg_type: str + - type: str name: ackprepare_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the prepare transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: acktransfer_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackabort_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the abort transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackclear_status description: |- Optional. Defaults $(device)$(posportprefix=:POSPORT)0:POSSTA. Record for status word to link to extract the acknowledgement to the clear error command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ackprepare_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of prepare for transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: acktransfer_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackabort_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of abort transfer command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackclear_ZNAM description: |- Optional. Defaults to No Request. Label for off state (ZNAM field) of clear error command acknowledgement. default: No Request - - arg_type: str + - type: str name: ackprepare_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of prepare for transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: acktransfer_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: ackabort_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of abort transfer command acknowledgement. default: Request - - arg_type: str + - type: str name: ackclear_ONAM description: |- Optional. Defaults to Request. Label for on state (ONAM field) of clear error command acknowledgement. default: Request - - arg_type: str + - type: str name: acksource_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of source parameter acknowledgement. default: No Trigger - - arg_type: str + - type: str name: acktarget_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of target parameter acknowledgement. default: No Trigger - - arg_type: str + - type: str name: acksource_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of source parameter acknowledgement. default: Trigger - - arg_type: str + - type: str name: acktarget_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of target parameter acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackmotorcurrenton_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current on command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackmotorcurrentoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of motor current off command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackmotorcurrenton_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current on command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackmotorcurrentoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of motor current off command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackcompressedairon_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air on command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackcompressedairoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of compressed air off command acknowledgement. default: No Trigger - - arg_type: str + - type: str name: ackcompressedairon_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air on command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackcompressedairoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of compressed air off command acknowledgement. default: Trigger - - arg_type: str + - type: str name: ackholderonarmon_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to True. default: No Trigger - - arg_type: str + - type: str name: ackholderonarmoff_ZNAM description: |- Optional. Defaults to No Trigger. Label for off state (ZNAM field) of acknowledgement for command to set the Holder On Arm status to False. default: No Trigger - - arg_type: str + - type: str name: ackholderonarmon_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to True. default: Trigger - - arg_type: str + - type: str name: ackholderonarmoff_ONAM description: |- Optional. Defaults to Trigger. Label for on state (ONAM field) of acknowledgement for command to set the Holder On Arm status to False. default: Trigger - - arg_type: str + - type: str name: ingprepare_ZNAM description: |- Optional. Defaults to Not Preparing. Label for off state (ZNAM field) of in progress for prepare command. default: Not Preparing - - arg_type: str + - type: str name: ingprepare_ONAM description: |- Optional. Defaults to Preparing. Label for on state (ONAM field) of in progress for prepare command. default: Preparing - - arg_type: str + - type: str name: ingtransfer_ZNAM description: |- Optional. Defaults to Not Transferring. Label for off state (ZNAM field) of in progress for transfer command. default: Not Transferring - - arg_type: str + - type: str name: ingtransfer_ONAM description: |- Optional. Defaults to Transferring. Label for on state (ONAM field) of in progress for transfer command. default: Transferring - - arg_type: str + - type: str name: ingabort_ZNAM description: |- Optional. Defaults to Not Aborting. Label for off state (ZNAM field) of in progress for abort command. default: Not Aborting - - arg_type: str + - type: str name: ingabort_ONAM description: |- Optional. Defaults to Aborting. Label for on state (ONAM field) of in progress for abort command. default: Aborting - - arg_type: str + - type: str name: ingclear_ZNAM description: |- Optional. Defaults to Not Clearing. Label for off state (ZNAM field) of in progress for clear command. default: Not Clearing - - arg_type: str + - type: str name: ingclear_ONAM description: |- Optional. Defaults to Clearing. Label for on state (ONAM field) of in progress for clear command. default: Clearing - - arg_type: int + - type: int name: ingprepare_bitno description: |- Optional. Defaults to 11. Number (0 to 15) of the bit in the status word for the in progress status for the prepare command. default: 11 - - arg_type: int + - type: int name: ingtransfer_bitno description: |- Optional. Defaults to 10. Number (0 to 15) of the bit in the status word for the in progress status for the transfer command. default: 10 - - arg_type: int + - type: int name: ingabort_bitno1 description: |- Optional. Defaults to 1. Number (0 to 15) of the bit in the status word for the in progress status for the abort command. default: 1 - - arg_type: int + - type: int name: ingabort_bitno2 description: |- Optional. Defaults to 15. Number (0 to 15) of the bit in the status word for the aborted status for the abort command. default: 15 - - arg_type: str + - type: str name: ingprepare_status description: |- Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the prepare command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ingtransfer_status description: |- Optional. Defaults to $(device)$(posportprefix=:POSPORT)0:POSSTA). Record for status word to link to extract in progress status for the transfer command from. default: $(device)$(posportprefix=:POSPORT)0:POSSTA - - arg_type: str + - type: str name: ingabort_status1 description: |- Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERERRORS2). Record for status word to link to extract in progress status for the abort command from. default: $(device)$(staprefix=:STA):TRANSFERERRORS2 - - arg_type: str + - type: str name: ingabort_status2 description: |- Optional. Defaults to $(device)$(staprefix=:STA):TRANSFERSTATUS). Record for status word to link to extract aborted status for the abort command from. This is required because of the behaviour during HiTES1 commissioning of the PreVac Modbus PLC failing to update some of its status including the aborting in progress bit which once set persists until the next command. default: $(device)$(staprefix=:STA):TRANSFERSTATUS - - arg_type: id + - type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -6416,452 +6416,452 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate (prefix of device name), NOTE: make sure there is a read100 component whose century (0 means 0-99) includes the object address - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..119 then addr=110 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: desc description: |- Box label for gui default: $(device) - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument @@ -6953,675 +6953,675 @@ defs: description: |- Template database for control and interlock of a non-specific device. args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. S (from S.Interfc[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Start command not allowed - - arg_type: int + - type: int name: stastrSCAN description: |- Scan rate for :STASTR PV string read in seconds, may be 10,5,2 or 1. Use to reduce network traffic if comms problems (Optional - defaults to 1) default: 1 - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Start) default: Start - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Abort) default: Abort - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Not running) default: Not running - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Running) default: Running - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Aborted) default: Aborted - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to MINOR) default: MINOR - - arg_type: str + - type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: p1_desc description: |- Label string for parameter 1 (Optional - defaults to "Param1") default: Param1 - - arg_type: int + - type: int name: p1_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p1_prec description: |- Precision of p1 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p1_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p1_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p1_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_desc description: |- Label string for parameter 2 (Optional - defaults to "Param2") default: Param2 - - arg_type: int + - type: int name: p2_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p2_prec description: |- Precision of p2 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p2_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p2_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p2_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_desc description: |- Label string for parameter 3 (Optional - defaults to "Param3") default: Param3 - - arg_type: int + - type: int name: p3_isEnum description: |- Display as enum(1) or number(0) (Optional - defaults to 1) default: 1 - - arg_type: int + - type: int name: p3_prec description: |- Precision of p3 number (Optional - defaults to 0) default: 0 - - arg_type: str + - type: str name: p3_LOPR description: |- LOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_HOPR description: |- HOPR for p1 number, optionally set if not using enums (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label0 description: |- Label string for enum value 0 (Optional - defaults to "unused") default: unused - - arg_type: str + - type: str name: p3_label1 description: |- Label string for enum value 1 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label2 description: |- Label string for enum value 2 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label3 description: |- Label string for enum value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label4 description: |- Label string for enum value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label5 description: |- Label string for enum value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label6 description: |- Label string for enum value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label7 description: |- Label string for enum value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label8 description: |- Label string for enum value 8 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label9 description: |- Label string for enum value 9 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label10 description: |- Label string for enum value 10 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label11 description: |- Label string for enum value 11 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label12 description: |- Label string for enum value 12 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label13 description: |- Label string for enum value 13 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label14 description: |- Label string for enum value 14 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: p3_label15 description: |- Label string for enum value 15 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - arg_type: id + - type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") @@ -7747,198 +7747,198 @@ defs: description: |- Template database for status info regarding a Port on PreVac Sample Manipulator. args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name. - - arg_type: str + - type: str name: posportID description: |- Mandatory. ID of the vacuum port position for the sample manipulator. Must be integer 1 to 8 or 0 for special case of Arm in RDC/UFO and overall status. - - arg_type: str + - type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: tag description: |- Mandatory. NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: |- Mandatory. NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: str + - type: str name: tagname description: |- Mandatory. NX PLC tag name. - - arg_type: str + - type: str name: tagprefix description: |- Mandatory. NX PLC prefix to tag name. - - arg_type: str + - type: str name: posportprefix description: |- Optional. Defaults to ":POSPORT". Prefix for the vacuum port position records. default: :POSPORT - - arg_type: int + - type: int name: smready_bitno description: |- Optional. Defaults to "1". Bit number in port position status for whether sample manipulator inside the chamber is in position ready to participate in the transfer, values 0-15. The Arm/RDC/UFO port is likely to have non-default value, as it needs to address the "Master Interlock Status" bit, whereas the other ports address the "ReadyForTransfer" bit. NOTE: The intended use is for signals derived from GPIO on GeoBricks with other sample manipulator motors on them. default: 1 - - arg_type: int + - type: int name: sampleholder_bitno description: |- Optional. Defaults to "2". Bit number in port position status for whether sample holder is present inside the chamber, values 0-15. The Arm/RDC/UFO port is likely to have non-default value, as it needs to address the "Holder On Arm" bit, whereas the other ports address the "Sample Inside" bit. NOTE: The sample holder might not have a sample in it! default: 2 - - arg_type: str + - type: str name: desc_label0 description: |- Optional. Defaults to "PrepareForTransfer". Descriptive label for bit0 of the Coil word. default: PrepareForTransfer - - arg_type: str + - type: str name: desc_label1 description: |- Optional. Defaults to "ReadyForTransfer". Descriptive label for bit1 of the Coil word. default: ReadyForTransfer - - arg_type: str + - type: str name: desc_label2 description: |- Optional. Defaults to "SampleInside". Descriptive label for bit2 of the Coil word. default: SampleInside - - arg_type: str + - type: str name: desc_label3 description: |- Optional. Defaults to "Error". Descriptive label for bit3 of the Coil word. default: Error - - arg_type: str + - type: str name: desc_label4 description: |- Optional. Defaults to "Busy". Descriptive label for bit4 of the Coil word. default: Busy - - arg_type: str + - type: str name: desc_label5 description: |- Optional. Defaults to "GateOpenRequest". Descriptive label for bit5 of the Coil word. default: GateOpenRequest - - arg_type: str + - type: str name: desc_label6 description: |- Optional. Defaults to "GateOpen". Descriptive label for bit6 of the Coil word. default: GateOpen - - arg_type: str + - type: str name: desc_label7 description: |- Optional. Defaults to "GateClosed". Descriptive label for bit7 of the Coil word. default: GateClosed - - arg_type: str + - type: str name: desc_label8 description: |- Optional. Defaults to "ArmOnPort". Descriptive label for bit8 of the Coil word. default: ArmOnPort - - arg_type: str + - type: str name: desc_label9 description: |- Optional. Defaults to "ReservedForFuture". Descriptive label for bit9 of the Coil word. default: ReservedForFuture - - arg_type: str + - type: str name: desc_label10 description: |- Optional. Defaults to "". Descriptive label for bit10 of the Coil word. default: "" - - arg_type: str + - type: str name: desc_label11 description: |- Optional. Defaults to "". Descriptive label for bit11 of the Coil word. default: "" - - arg_type: str + - type: str name: desc_label12 description: |- Optional. Defaults to "". Descriptive label for bit12 of the Coil word. default: "" - - arg_type: str + - type: str name: desc_label13 description: |- Optional. Defaults to "". Descriptive label for bit13 of the Coil word. default: "" - - arg_type: str + - type: str name: desc_label14 description: |- Optional. Defaults to "". Descriptive label for bit14 of the Coil word. default: "" - - arg_type: str + - type: str name: desc_label15 description: |- Optional. Defaults to "". Descriptive label for bit15 of the Coil word. default: "" - - arg_type: str + - type: str name: longdesc description: |- Optional. Defaults to "Manipulator Position Port $(posportID) status." Description of position port. default: Manipulator Position Port $(posportID) status. - - arg_type: str + - type: str name: shortdesc description: |- Optional. Defaults to "Posport$(posportID)" Short, abbreviated description of position port. default: Posport$(posportID) - - arg_type: str + - type: str name: chamber_name description: |- Optional. Defaults to "". Name of vacuum chamber associated with position port. default: "" - - arg_type: str + - type: str name: chamber_shortname description: |- Optional. Defaults to "". Short name of vacuum chamber associated with position port. default: "" - - arg_type: str + - type: str name: valve_device description: |- Optional. Defaults to "". Device name of vacuum valve associated with position port. So far it is a string for info only, no calcs. default: "" - - arg_type: str + - type: str name: valve_shortname description: |- Optional. Defaults to "". Short, abbreviated name of vacuum valve associated with the position port. default: "" - - arg_type: str + - type: str name: valve_desc description: |- Optional. Defaults to "". Description of vacuum valve associated with position port. default: "" - - arg_type: id + - type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -7985,40 +7985,40 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: |- Template argument - - arg_type: str + - type: str name: port description: |- Template argument - - arg_type: str + - type: str name: tag description: |- Template argument - - arg_type: str + - type: str name: desc description: |- Template argument default: "" - - arg_type: str + - type: str name: scan description: |- Template argument default: 1 second - - arg_type: str + - type: str name: egu description: |- Template argument default: "" - - arg_type: int + - type: int name: prec description: |- Template argument @@ -8039,291 +8039,291 @@ defs: description: |- Template database for control and interlock of a non-specific device. args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. S (from S.Interfc[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from S.Interfc[1]) - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Off - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: On - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: "" - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Off - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: "" - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) (Optional - defaults to Service) default: Service - - arg_type: id + - type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") @@ -8385,28 +8385,28 @@ defs: description: |- Power cycle an RGA where the PLC code has been setup to power cycle when 1 is written to a particular DM variable args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: addr description: |- DM variable to write to to reboot rga - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: id + - type: id name: name description: |- Object name and associated gui name @@ -8424,76 +8424,76 @@ defs: description: |- Template database for reading and writing a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: variable description: |- PV suffix (its associated _RBV will be autogenerated). - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: |- tag name of ether_ip read value - - arg_type: str + - type: str name: tagwrite description: |- tag name of ether_ip write value - - arg_type: str + - type: str name: drvl description: |- Lowest accepted value - - arg_type: str + - type: str name: drvh description: |- Highest accepted value - - arg_type: int + - type: int name: tagidx description: |- Template argument - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: desc description: |- Description default: "" - - arg_type: str + - type: str name: readscan description: |- value update time for readback value default: 1 second - - arg_type: float + - type: float name: writescan description: |- value for Ethernet/IP update time - use value without "seconds", e.g. 0.5 default: 0.5 - - arg_type: str + - type: str name: egu description: |- Engineering units default: "" - - arg_type: int + - type: int name: prec description: |- precision for reporting value back @@ -8521,313 +8521,313 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- EtherIP Port Name - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: |- Part of definition of gauge interlocks, Gauge NX PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom. (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Run Ilks Ok) default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to OK) default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Disarmed) default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve or leave blank for ordinary valve. (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to "ILK2") default: ILK2 - - arg_type: id + - type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - arg_type: str + - type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) @@ -8894,321 +8894,321 @@ defs: description: |- Template for a NX PLC to control and interlock vacuum pumps of various kinds, e.g. Scroll and Turbo pumps. NOTE: Covers basic commonly required control only and excludes pump make and model or application specific control and monitoring of the pump which might be available and also be required typically via serial control, for example settings configuration or service period information. args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name of the pump. - - arg_type: str + - type: str name: port description: |- Mandatory. Name of port for the ether_ip driver for the PLC controlling/interlocking the pump. - - arg_type: str + - type: str name: tag description: |- Mandatory. NX PLC tag string e.g. S for Scroll or T for Turbo. - - arg_type: int + - type: int name: tagidx description: |- Mandatory. NX PLC tag index number. Typically this is the same as the id number in the device name, but - - arg_type: str + - type: str name: allowpv description: |- Optional. Defaults to "". If specified, then only write an "open" i.e. on command when this is non-zero. MUST have CP at the end of it. The term "open" here and in PV names is because of heritage from valve control. Generally by default the "open" command for a pump actually signifies turn it on. default: "" - - arg_type: str + - type: str name: whylocked description: |- Optional. Defaults to "On command not allowed". String to output to EDM synoptic as to precisely why the device is locked and by whom. default: On command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Optional. Defaults to On. Label string for control value 0 default: On - - arg_type: str + - type: str name: con_label1 description: |- Optional. Defaults to Off. Label string for control value 1 default: Off - - arg_type: str + - type: str name: con_label2 description: |- Optional. Defaults to Reset. Label string for control value 2 default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Optional. Defaults to Standby. Label string for control value 3 default: "" - - arg_type: str + - type: str name: con_label4 description: |- Optional. Defaults to FullSpeed. Label string for control value 4 default: "" - - arg_type: str + - type: str name: con_label5 description: |- Optional. Defaults to "". Label string for control value 5 default: "" - - arg_type: str + - type: str name: con_label6 description: |- Optional. Defaults to "". Label string for control value 6 default: "" - - arg_type: str + - type: str name: con_label7 description: |- Optional. Defaults to "". Label string for control value 7 default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Optional. Defaults to Fault. Label string for status value 0 default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Optional. Defaults to On. Label string for status value 1 default: On - - arg_type: str + - type: str name: sta_label2 description: |- Optional. Defaults to Standby. Label string for status value 2 default: Standby - - arg_type: str + - type: str name: sta_label3 description: |- Optional. Defaults to Off. Label string for status value 3 default: Off - - arg_type: str + - type: str name: sta_label4 description: |- Optional. Defaults to "". Label string for status value 4 default: FullSpeed - - arg_type: str + - type: str name: sta_label5 description: |- Optional. Defaults to "". Label string for status value 5 default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Optional. Defaults to "". Label string for status value 6 default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Optional. Defaults to "". Label string for status value 7 default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 7. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Optional. Defaults to Failed. Label string for status value 0 default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Optional. Defaults to Run Ilks OK. Label string for status value 1 default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Optional. Defaults to OK. Label string for status value 2 default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Optional. Defaults to "". Label string for status value 3 default: "" - - arg_type: str + - type: str name: ilksta_label4 description: |- Optional. Defaults to "". Label string for status value 4 default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Optional. Defaults to "". Label string for status value 5 default: "" - - arg_type: str + - type: str name: ilksta_label6 description: |- Optional. Defaults to "". Label string for status value 6 default: "" - - arg_type: str + - type: str name: ilksta_label7 description: |- Optional. Defaults to "". Label string for status value 7 default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for interlock status value 0. default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 1. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 2. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 3. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 4. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 5. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 6. default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Optional. Defaults to NO_ALARM. Alarm severity for interlock status value 7. default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- Optional. Defaults to Operational. Name of first mode of operation, remote commands allowed. (Name is mode1 but value is 0. i.e. :MODE.ZNAM) default: Operational - - arg_type: str + - type: str name: mode2 description: |- Optional. Defaults to Service. Name of second mode of operation, local control only. (Name is mode2 but value is 1. i.e. :MODE.ONAM) default: Service - - arg_type: str + - type: str name: short_desc description: |- Optional. Defaults to Shorting Plug. Description field on the PLUG record DESC field for whether a shorting plug is present. default: Shorting Plug - - arg_type: str + - type: str name: short_label0 description: |- Optional. Defaults to Dummy. Label on the PLUG record ZNAM field for no shorting plug present. default: Dummy - - arg_type: str + - type: str name: short_label1 description: |- Optional. Defaults to Real. Label on the PLUG record ONAM field for shorting plug present. default: Real - - arg_type: str + - type: str name: short_sv0 description: |- Optional. Defaults to NO_ALARM. Severity on the PLUG record ZSV field for the status value 0. default: NO_ALARM - - arg_type: str + - type: str name: short_sv1 description: |- Optional. Defaults to NO_ALARM. Severity on the PLUG record OSV field for the status value 1. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Optional. Defaults to "". Object name and associated gui name. @@ -9275,28 +9275,28 @@ defs: description: |- Template showing the status of the power supply from the ether IP readings args: - - arg_type: str + - type: str name: device description: |- device prefix - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from PSU.Voltage[1]) - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. PSU (from PSU.Voltage[1]) default: PSU - - arg_type: id + - type: id name: name description: |- Object name and associated gui name @@ -9316,133 +9316,133 @@ defs: temperature PLC. Requires an instance of dlsPLC_read100 for century=1 and century=2 args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: temp description: |- PV suffix - - arg_type: str + - type: str name: desc description: |- Description - - arg_type: str + - type: str name: tmpcc description: |- Parent temperature control crate prefix - - arg_type: str + - type: str name: offset description: |- 2 digit integer offset of DM variables. E.g. if setpoint is in DM136 and readback in DM236 offset=36 - - arg_type: str + - type: str name: lolo description: |- Lolo alarm limit - - arg_type: str + - type: str name: low description: |- Low alarm limit - - arg_type: str + - type: str name: high description: |- High alarm limit - - arg_type: str + - type: str name: hihi description: |- Hihi alarm limit - - arg_type: str + - type: str name: hopr description: |- High operating range - - arg_type: str + - type: str name: lopr description: |- Low operating range - - arg_type: str + - type: str name: llsv description: |- Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: |- Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: |- alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: |- archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: |- scale factor for temperature/setpoint default: 10 - - arg_type: int + - type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: |- precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: |- Object and gui association name - - arg_type: str + - type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: int + - type: int name: incentury description: |- The Century digit(s) for the PLC D address to read temperature values default: 2 - - arg_type: int + - type: int name: outcentury description: |- The Century digit(s) for the PLC D address to write setpoints default: 1 - - arg_type: str + - type: str name: egu description: |- This associates an edm screen with the template @@ -9483,42 +9483,42 @@ defs: Template showing the status of various MPS interlocks in an Omron NX102 PLC. args: - - arg_type: str + - type: str name: device description: |- device prefix - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. ILK (from ILK.Control[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from ILK.Control[1]) - - arg_type: str + - type: str name: desc description: |- Permit description (e.g. Front end permit) - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: int + - type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -9540,27 +9540,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: |- Template argument - - arg_type: str + - type: str name: port description: |- Template argument - - arg_type: int + - type: int name: tagidx description: |- Template argument - - arg_type: id + - type: id name: name description: |- Template argument - - arg_type: str + - type: str name: tag description: |- Template argument @@ -9579,18 +9579,18 @@ defs: description: |- Template for Warning GUI banner for stale data from the PreVac Sample Manipulator controller. args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name of sample manipulator. - - arg_type: str + - type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - arg_type: id + - type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -9606,50 +9606,50 @@ defs: description: |- Template database for reading a real value for a DX200 controller variable through NX102 PLC args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: variable description: |- PV suffix for this robot variable - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: str + - type: str name: tagread description: |- tag name of ether_ip read value - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: desc description: |- Description default: "" - - arg_type: str + - type: str name: scan description: |- value update time default: 1 second - - arg_type: str + - type: str name: egu description: |- Engineering units default: "" - - arg_type: int + - type: int name: prec description: |- This associates an edm screen with the template @@ -9672,150 +9672,150 @@ defs: description: |- Template database for a summary PV of up to 24 interlocks args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: ilk1 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk2 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk3 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk4 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk5 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk6 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk7 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk8 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk9 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk10 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk11 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk12 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk13 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk14 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk15 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk16 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk17 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk18 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk19 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk20 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk21 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk22 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk23 description: |- Interlock suffix (e.g. INT1) default: NO-INTERLOCK - - arg_type: str + - type: str name: ilk24 description: |- Interlock suffix (e.g. INT1) @@ -9854,143 +9854,143 @@ defs: description: |- Template database for status info on PreVac Sample Manipulator (in addition to that for individual SM Ports). args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name. - - arg_type: str + - type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: staprefix description: |- Optional. Defaults to :STA Prefix for the SM status records. default: :STA - - arg_type: str + - type: str name: posportprefix description: |- Optional. Defaults to :POSPORT Prefix for records for individual ports. Must match port template. default: :POSPORT - - arg_type: str + - type: str name: posportID0_shortdesc description: |- Optional. Defaults to Arm. Short description of zeroth port (for error recovery only). The posportID1...7_shortdesc macros are not populated by default, so you must set some of them to make things sensible. Leave the ones not present (i.e. no chamber connected as empty string.) default: Arm - - arg_type: str + - type: str name: posportID1_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 1, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID2_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 2, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID3_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 3, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID4_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 4, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID5_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 5, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID6_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 6, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID7_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 7, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID8_shortdesc description: |- Optional. Defaults to empty string. Short description of posport with ID 8, recommend use an abbreviated chamber name but only if a chamber is present. default: "" - - arg_type: str + - type: str name: posportID0_sourceSV description: |- Optional. Defaults to MINOR. Alarm severity for posport ID 0 for the Arm as source. It is allowed as part of error recovery. default: MINOR - - arg_type: str + - type: str name: posportID0_targetSV description: |- Optional. Defaults to MAJOR. Alarm severity for posport ID 0 for the Arm as target. default: MAJOR - - arg_type: str + - type: str name: posportID1_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 1, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID2_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 2, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID3_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 3, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID4_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 4, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID5_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 5, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID6_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 6, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID7_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 7, same for source and target. default: NO_ALARM - - arg_type: str + - type: str name: posportID8_SV description: |- Optional. Defaults to NO_ALARM. Alarm severity for posport ID 8, same for source and target. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name @@ -10028,139 +10028,139 @@ defs: Template showing the status of various MPS interlocks in a PLC. Requires dlsPLC_read100 for any century used args: - - arg_type: str + - type: str name: device description: |- device prefix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: interlock description: |- Interlock suffix (e.g. :INT1) - - arg_type: str + - type: str name: desc description: |- Permit description (e.g. Front end permit) - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range. E.g. if interlock is in DM800..808 then addr=800 - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: int + - type: int name: auto_reset description: |- Set to 1 to push the reset button whenever the raw interlocks are all ok @@ -10198,22 +10198,22 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: name description: |- Gui tag - - arg_type: object + - type: object name: master description: |- Master - - arg_type: str + - type: str name: img description: |- Base IMG PV - - arg_type: enum + - type: enum name: id description: |- FV PLC gauge number @@ -10229,7 +10229,7 @@ defs: "06": "01": - - arg_type: enum + - type: enum name: em description: |- EM block to use @@ -10239,7 +10239,7 @@ defs: '"1"': '"2"': - - arg_type: int + - type: int name: timeout description: |- asyn fins_port timeout @@ -10269,45 +10269,45 @@ defs: description: |- Template database for a vacuum valve without debounce or raw air records args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if pump is in DM110..118 then addr=110 - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom default: Open command not allowed - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol default: 0 - - arg_type: enum + - type: enum name: valvetype description: |- Type of Device @@ -10317,414 +10317,414 @@ defs: '"absorber"': '"shutter"': - - arg_type: str + - type: str name: ilk0 description: |- Interlock description 0 default: unused - - arg_type: str + - type: str name: ilk1 description: |- Interlock description 1 default: unused - - arg_type: str + - type: str name: ilk2 description: |- Interlock description 2 default: unused - - arg_type: str + - type: str name: ilk3 description: |- Interlock description 3 default: unused - - arg_type: str + - type: str name: ilk4 description: |- Interlock description 4 default: unused - - arg_type: str + - type: str name: ilk5 description: |- Interlock description 5 default: unused - - arg_type: str + - type: str name: ilk6 description: |- Interlock description 6 default: unused - - arg_type: str + - type: str name: ilk7 description: |- Interlock description 7 default: unused - - arg_type: str + - type: str name: ilk8 description: |- Interlock description 8 default: unused - - arg_type: str + - type: str name: ilk9 description: |- Interlock description 9 default: unused - - arg_type: str + - type: str name: ilk10 description: |- Interlock description 10 default: unused - - arg_type: str + - type: str name: ilk11 description: |- Interlock description 11 default: unused - - arg_type: str + - type: str name: ilk12 description: |- Interlock description 12 default: unused - - arg_type: str + - type: str name: ilk13 description: |- Interlock description 13 default: unused - - arg_type: str + - type: str name: ilk14 description: |- Interlock description 14 default: unused - - arg_type: str + - type: str name: ilk15 description: |- Interlock description 15 default: unused - - arg_type: str + - type: str name: gilk0 description: |- Gauge interlock description 0 default: unused - - arg_type: str + - type: str name: gilk1 description: |- Gauge interlock description 1 default: unused - - arg_type: str + - type: str name: gilk2 description: |- Gauge interlock description 2 default: unused - - arg_type: str + - type: str name: gilk3 description: |- Gauge interlock description 3 default: unused - - arg_type: str + - type: str name: gilk4 description: |- Gauge interlock description 4 default: unused - - arg_type: str + - type: str name: gilk5 description: |- Gauge interlock description 5 default: unused - - arg_type: str + - type: str name: gilk6 description: |- Gauge interlock description 6 default: unused - - arg_type: str + - type: str name: gilk7 description: |- Gauge interlock description 7 default: unused - - arg_type: str + - type: str name: gilk8 description: |- Gauge interlock description 8 default: unused - - arg_type: str + - type: str name: gilk9 description: |- Gauge interlock description 9 default: unused - - arg_type: str + - type: str name: gilk10 description: |- Gauge interlock description 10 default: unused - - arg_type: str + - type: str name: gilk11 description: |- Gauge interlock description 11 default: unused - - arg_type: str + - type: str name: gilk12 description: |- Gauge interlock description 12 default: unused - - arg_type: str + - type: str name: gilk13 description: |- Gauge interlock description 13 default: unused - - arg_type: str + - type: str name: gilk14 description: |- Gauge interlock description 14 default: unused - - arg_type: str + - type: str name: gilk15 description: |- Gauge interlock description 15 default: unused - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Optional. Defaults to MAJOR. Alarm severity for status value 0. default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 1. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 2. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 3. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 4. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 5. default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Optional. Defaults to NO_ALARM. Alarm severity for status value 6. default: NO_ALARM - - arg_type: id + - type: id name: name description: |- Object name and associated gui name - - arg_type: str + - type: str name: desc description: |- Box label for gui default: $(device) - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE) default: Service - - arg_type: str + - type: str name: ilksta_label0 description: |- Template argument default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Template argument default: Run Ilks Ok - - arg_type: str + - type: str name: ilksta_label2 description: |- Template argument default: OK - - arg_type: str + - type: str name: ilksta_label3 description: |- Template argument default: Disarmed - - arg_type: str + - type: str name: ilksta_label4 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_label5 description: |- Template argument default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Template argument default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Template argument default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Template argument @@ -10740,7 +10740,7 @@ defs: ilk10: ilk11: ilk12: - valvearg_type: + valvetype: gda_name: allowpv: ilk8: @@ -10817,32 +10817,32 @@ defs: description: |- Read the Int16 value stored in 1 DM variables in a PLC args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: vlvcc description: |- PLC control crate device prefix - - arg_type: str + - type: str name: addr description: |- DM variable of the int - - arg_type: id + - type: id name: name description: |- Object name and gui association name - - arg_type: str + - type: str name: ftvl description: |- Type of data in subArray @@ -10862,33 +10862,33 @@ defs: description: |- Write an int32 value into a PLC DM variable args: - - arg_type: str + - type: str name: P description: |- device prefix - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: port description: |- asyn port name of FINS driver - - arg_type: str + - type: str name: addr description: |- DM variable of the LOWERer address of the float32 - - arg_type: int + - type: int name: timeout description: |- Timeout in seconds for the FINS protocol reads/writes default: 0 - - arg_type: id + - type: id name: name description: |- Object name and gui association name @@ -10907,69 +10907,69 @@ defs: description: |- Template for read only vacuum valves - manual valves with limit switches read back by valve controller PLC so their state is known, but control is not available. args: - - arg_type: str + - type: str name: device description: |- device name of the valve. - - arg_type: str + - type: str name: vlvcc description: |- device name of valve control crate - - arg_type: str + - type: str name: addr description: |- First address in the DM variable range decade. E.g. if valve is in DM110..118 then addr=110 - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Partial) default: Partial - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: id + - type: id name: name description: |- This associates an edm screen with the template - - arg_type: str + - type: str name: valvetype description: |- Template argument @@ -10980,7 +10980,7 @@ defs: args: vlvcc: addr: - valvearg_type: + valvetype: sta_label5: sta_label4: sta_label6: @@ -10995,286 +10995,286 @@ defs: description: |- Template database for an LVDT on PreVac Sample Manipulator. args: - - arg_type: str + - type: str name: device description: |- Mandatory. Device name. - - arg_type: str + - type: str name: port description: |- Mandatory. Comms port (DLS NX102) PLC controller is on. - - arg_type: str + - type: str name: lvdtID description: |- Mandatory. ID of the LVDT. Defacto it is a number but it need not be. - - arg_type: str + - type: str name: tag description: |- Mandatory. NX PLC tag string. - - arg_type: str + - type: str name: lvdtprefix description: |- Optional. Defaults to ":LVDT". Prefix for SM LVDT records. default: :LVDT - - arg_type: str + - type: str name: lvdt_shortname description: |- Optional. Defaults to "LVDT{{lvdtID}}". Short name of the LVDT. default: LVDT{{lvdtID}} - - arg_type: str + - type: str name: lvdt_shortdesc description: |- Optional. Defaults to "LVDT {{lvdtID}}". Short description of the LVDT. default: LVDT {{lvdtID}} - - arg_type: str + - type: str name: lvdt_longdesc description: |- Optional. Defaults to "Manipulator LVDT {{lvdtID}}". Longer description of the LVDT. default: Manipulator LVDT {{lvdtID}} # TODO we need ibek to support int | str that looks like {{ xxxx | int }} - - arg_type: str + - type: str name: tagidx description: |- Optional. Defaults to "{{lvdtID}}". NX PLC tag string array index. default: "{{lvdtID}}" - - arg_type: str + - type: str name: pos_SCAN description: |- Optional. Defaults to ".5 second". EPICS .SCAN field. Scan rate for reading encoder. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here. default: .5 second - - arg_type: int + - type: int name: pos_PREC description: |- Optional. Defaults to 3. Precision on the encoder position value. default: 3 - - arg_type: str + - type: str name: pos_EGU description: |- Optional. Defaults to empty string. Engineering units on the encoder value. default: "" - - arg_type: str + - type: str name: pos_LINR description: |- Optional. Defaults to empty string. Values can be "NO CONVERSION", "SLOPE" (must define pos_ESLO and and pos_EOFF), "LINEAR" (must define pos_EGUL and pos_EGUF), (or name of special table) and it will default to "NO CONVERSION". Conversion method for encoder value. See EPICS record reference manual sections on the ai record and the convert menu and conversion. default: "" - - arg_type: str + - type: str name: pos_EGUL description: |- Optional. Defaults to empty string. Low end of LINEAR conversion scale for encoder value. default: "" - - arg_type: str + - type: str name: pos_EGUF description: |- Optional. Defaults to empty string. High end or full value on LINEAR conversion scale for encoder value. default: "" - - arg_type: str + - type: str name: pos_EOFF description: |- Optional. Defaults to empty string. The offset on the value for SLOPE conversion. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_ESLO description: |- Optional. Defaults to empty string. The slope on the value for SLOPE conversion. It will default to 1. default: "" - - arg_type: str + - type: str name: pos_AOFF description: |- Optional. Defaults to empty string. The raw adjustment offset on the value for conversion for all types of conversion. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_ASLO description: |- Optional. Defaults to empty string. The raw adjustment slope on the value for conversion for all types of conversion. It will default to 1. default: "" - - arg_type: str + - type: str name: pos_SMOO description: |- Optional. Defaults to empty string. The smoothing fraction parameter on the smoothing algorithm, value between 0 (no smoothing) and 1 (value never changes), it will default to 0. default: "" - - arg_type: str + - type: str name: pos_HOPR description: |- Optional. Defaults to empty string. The position high operator display value. Will default to 0. default: "" - - arg_type: str + - type: str name: pos_LOPR description: |- Optional. Defaults to empty string. The position low operator display value. Will default to 0. default: "" - - arg_type: str + - type: str name: pos_HIHI description: |- Optional. Defaults to empty string. The position high high limit. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_HIGH description: |- Optional. Defaults to empty string. The position high limit. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_LOW description: |- Optional. Defaults to empty string. The position low limit. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_LOLO description: |- Optional. Defaults to empty string. The position low low limit. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_HHSV description: |- Optional. Defaults to empty string. The alarm severity for the HIHI alarm. It will default to NO_ALARM. default: "" - - arg_type: str + - type: str name: pos_HSV description: |- Optional. Defaults to empty string. The alarm severity for the HIGH alarm. It will default to NO_ALARM. default: "" - - arg_type: str + - type: str name: pos_LSV description: |- Optional. Defaults to empty string. The alarm severity for the LOW alarm. It will default to NO_ALARM. default: "" - - arg_type: str + - type: str name: pos_LLSV description: |- Optional. Defaults to empty string. The alarm severity for the LOLO alarm. It will default to NO_ALARM. default: "" - - arg_type: str + - type: str name: pos_HYST description: |- Optional. Defaults to empty string. The alarm deadband or hysteresis for the scaled position. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_ADEL description: |- Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the scaled position. It will default to 0. default: "" - - arg_type: str + - type: str name: pos_MDEL description: |- Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the scaled position. It will default to 0. default: "" - - arg_type: str + - type: str name: raw_EGU description: |- Optional. Defaults to count. Engineering units on the encoder raw value. default: count - - arg_type: str + - type: str name: raw_HYST description: |- Optional. Defaults to empty string. The alarm deadband or hysteresis for the raw position. It will default to 0. default: "" - - arg_type: str + - type: str name: raw_ADEL description: |- Optional. Defaults to empty string. The archiver deadband, to stop archiving noise, for the raw position. It will default to 0. default: "" - - arg_type: str + - type: str name: raw_MDEL description: |- Optional. Defaults to empty string. The monitor deadband, to stop reacting noise, for the raw position. It will default to 0. default: "" - - arg_type: int + - type: int name: slope_PREC description: |- Optional. Defaults to 6. Precision on the derived encoder slope value. default: 6 - - arg_type: str + - type: str name: cal_SCAN description: |- Optional. Defaults to "1 second". EPICS .SCAN field. Scan rate for reading calibration parameters. NOTE: This is the normal EPICS .SCAN field scanrate and the EtherIP S Flag for scanrate is not in use here. default: 1 second - - arg_type: float + - type: float name: calout_scanrate description: |- Optional. Defaults to .5 The value of scanrate which when writing to NX PLC the calibration output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.5 - - arg_type: float + - type: float name: trigger_scanrate description: |- Optional. Defaults to .2 The value of scanrate which when writing to NX PLC triggers the trigger output records set the EtherIP scanrate S flag to in their OUT field syntax to add the readback to one of the EtherIP scanlists. default: 0.2 - - arg_type: int + - type: int name: trigger_onval description: |- Optional. Defaults to 1. Value to write to a trigger tag to pulse the trigger on. Must be consistent with trigger_offval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 1 - - arg_type: int + - type: int name: trigger_offval description: |- Optional. Defaults to 0. Value to write to a trigger tag to pulse the trigger off. Must be consistent with trigger_onval. Together they allow the defininition of the trigger pulse as a blip or a dip with blip as the default. default: 0 - - arg_type: str + - type: str name: trigger_ONAM description: |- Optional. Defaults to Trigger On. Label for 1 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger On - - arg_type: str + - type: str name: trigger_ZNAM description: |- Optional. Defaults to Trigger Off. Label for 0 state on a trigger record. Must be consistent with trigger_onval and trigger_offval. default: Trigger Off - - arg_type: float + - type: float name: trigger_pulsestartDLY description: |- Optional. Defaults to 1.0. Delay in seconds between last calibration parameter write and pulsing the trigger. default: 1.0 - - arg_type: float + - type: float name: trigger_pulsewidthDLY description: |- Optional. Defaults to 1.0. Delay in seconds between sending Trigger On and Trigger Off writes when pulsing a trigger. default: 1.0 - - arg_type: id + - type: id name: name description: |- Optional. Defaults to empty. Object name and associated gui name. @@ -11335,27 +11335,27 @@ defs: description: |- Template allowing overrideRequestIndividual instances to be created args: - - arg_type: str + - type: str name: P description: |- device prefix. This must match a dlsPLC_read100.template device macro - - arg_type: str + - type: str name: Q description: |- device suffix - - arg_type: str + - type: str name: outaddr description: |- Output address. Input address is $(outaddr)+1. E.g. if outaddr=80, read DM81 and write DM80. - - arg_type: str + - type: str name: port description: |- Asyn port for doing serial comms - - arg_type: int + - type: int name: timeout description: |- Template argument @@ -11375,128 +11375,128 @@ defs: Template database for an individual temperature on a front end temperature PLC. args: - - arg_type: str + - type: str name: device description: |- PV prefix - - arg_type: str + - type: str name: temp description: |- PV suffix - - arg_type: str + - type: str name: port description: |- port name of ether_ip driver - - arg_type: int + - type: int name: tagidx description: |- temperature index on PLC - - arg_type: str + - type: str name: lolo description: |- Lolo alarm limit - - arg_type: str + - type: str name: low description: |- Low alarm limit - - arg_type: str + - type: str name: high description: |- High alarm limit - - arg_type: str + - type: str name: hihi description: |- Hihi alarm limit - - arg_type: str + - type: str name: hopr description: |- High operating range - - arg_type: str + - type: str name: lopr description: |- Low operating range - - arg_type: str + - type: str name: tag description: |- etherip tag default: Temp - - arg_type: str + - type: str name: llsv description: |- Lolo severity default: NO_ALARM - - arg_type: str + - type: str name: lsv description: |- Low severity default: NO_ALARM - - arg_type: int + - type: int name: hyst description: |- alarm deadband default: 0 - - arg_type: float + - type: float name: adel description: |- archiver deadband default: 0.2 - - arg_type: int + - type: int name: scalefac description: |- scale factor for temperature/setpoint (1 for new PLC templates, 10 for old where PLC reports in 10ths of a degree) default: 1 - - arg_type: int + - type: int name: tempcal description: |- temperature calibration offset in egu (default=0) default: 0 - - arg_type: int + - type: int name: prec description: |- precision for reporting value back default: 1 - - arg_type: id + - type: id name: name description: |- Object and gui association name - - arg_type: str + - type: str name: disable_pv description: |- If set, then this is the value of A in disable_calc default: $(device)$(temp):ZERO - - arg_type: str + - type: str name: disable_calc description: |- If this condition is met then save the current limit and set the limit to 3276.7, disabling the interlock for this PV default: A=1 - - arg_type: str + - type: str name: egu description: |- This associates an edm screen with the template default: C - - arg_type: str + - type: str name: desc description: |- Description @@ -11532,27 +11532,27 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: str + - type: str name: device description: |- Template argument - - arg_type: str + - type: str name: port description: |- Template argument - - arg_type: int + - type: int name: tagidx description: |- Template argument - - arg_type: id + - type: id name: name description: |- Template argument - - arg_type: str + - type: str name: tag description: |- Template argument @@ -11571,331 +11571,331 @@ defs: description: |- Template database for a bistable vacuum valve without debounce or raw air records. It has different interlocks for opening and closing it. args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- EtherIP Port Name - - arg_type: str + - type: str name: tag description: |- NX PLC tag string e.g. V (from V.Control[1]) - - arg_type: int + - type: int name: tagidx description: |- NX PLC tag index number e.g. 1 (from V.Control[1]) - - arg_type: int + - type: int name: ILKNUM description: |- Part of Gauge PLC tag (Gauge.PIRG[dollar(ILKNUM)]) - - arg_type: str + - type: str name: allowpv description: |- If specified, then only write an open command when this is non-zero. MUST have CP at the end of it. (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: whylocked description: |- String to output to EDM synoptic as to precisely why the device is locked and by whom (Optional. Defaults to "Open command not allowed") default: Open command not allowed - - arg_type: str + - type: str name: con_label0 description: |- Label string for control value 0 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: con_label1 description: |- Label string for control value 1 (Optional - defaults to Close) default: Close - - arg_type: str + - type: str name: con_label2 description: |- Label string for control value 2 (Optional - defaults to Reset) default: Reset - - arg_type: str + - type: str name: con_label3 description: |- Label string for control value 3 (Optional - defaults to Close Enable) default: Close Enable - - arg_type: str + - type: str name: con_label4 description: |- Label string for control value 4 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label5 description: |- Label string for control value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label6 description: |- Label string for control value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: con_label7 description: |- Label string for control value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label0 description: |- Label string for status value 0 (Optional - defaults to Fault) default: Fault - - arg_type: str + - type: str name: sta_label1 description: |- Label string for status value 1 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: sta_label2 description: |- Label string for status value 2 (Optional - defaults to Opening) default: Opening - - arg_type: str + - type: str name: sta_label3 description: |- Label string for status value 3 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: sta_label4 description: |- Label string for status value 4 (Optional - defaults to Closing) default: Closing - - arg_type: str + - type: str name: sta_label5 description: |- Label string for status value 5 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label6 description: |- Label string for status value 6 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: sta_sv0 description: |- Alarm severity for status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: sta_sv1 description: |- Alarm severity for status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv2 description: |- Alarm severity for status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv3 description: |- Alarm severity for status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv4 description: |- Alarm severity for status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv5 description: |- Alarm severity for status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv6 description: |- Alarm severity for status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: sta_sv7 description: |- Alarm severity for status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_label0 description: |- Label string for status value 0 (Optional - defaults to Failed) default: Failed - - arg_type: str + - type: str name: ilksta_label1 description: |- Label string for status value 1 (Optional - defaults to Open Disabled) default: Open Disabled - - arg_type: str + - type: str name: ilksta_label2 description: |- Label string for status value 2 (Optional - defaults to Closed, Open Available) default: Closed, Open Available - - arg_type: str + - type: str name: ilksta_label3 description: |- Label string for status value 3 (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: ilksta_label4 description: |- Label string for status value 4 (Optional - defaults to Close Disabled) default: Close Disabled - - arg_type: str + - type: str name: ilksta_label5 description: |- Label string for status value 5 (Optional - defaults to Open, Close Available) default: Open, Close Available - - arg_type: str + - type: str name: ilksta_label6 description: |- Label string for status value 6 (Optional - defaults to Closed) default: Closed - - arg_type: str + - type: str name: ilksta_label7 description: |- Label string for status value 7 (Optional - defaults to "") default: "" - - arg_type: str + - type: str name: ilksta_sv0 description: |- Alarm severity for interlock status value 0 (Optional - defaults to MAJOR) default: MAJOR - - arg_type: str + - type: str name: ilksta_sv1 description: |- Alarm severity for interlock status value 1 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv2 description: |- Alarm severity for interlock status value 2 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv3 description: |- Alarm severity for interlock status value 3 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv4 description: |- Alarm severity for interlock status value 4 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv5 description: |- Alarm severity for interlock status value 5 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv6 description: |- Alarm severity for interlock status value 6 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: ilksta_sv7 description: |- Alarm severity for interlock status value 7 (Optional - defaults to NO_ALARM) default: NO_ALARM - - arg_type: str + - type: str name: mode1 description: |- name of remote operational mode (:MODE.ZNAM) (Optional - defaults to Operational) default: Operational - - arg_type: str + - type: str name: mode2 description: |- name of local operational mode (:MODE.ONAM) (Optional - defaults to Service) default: Service - - arg_type: str + - type: str name: DIRILK1 description: |- Part of ILK1 PV name (dollar(device):dollar(DIRILK1)ILK), named for "direction" of operation controlled by ILK1, e.g. set to OPEN for Bistable valve (Optional - defaults to OPEN) default: OPEN - - arg_type: str + - type: str name: DIRILK1_label description: |- Label string for the interlock 1 "direction". (Optional - defaults to Open) default: Open - - arg_type: str + - type: str name: DIRILK2 description: |- Part of ILK2 PV name (dollar(device):dollar(DIRILK2)ILK), named for "direction" of operation controlled by ILK2, e.g. set to CLOSE for Bistable valves (Optional - defaults to CLOSE) default: CLOSE - - arg_type: str + - type: str name: DIRILK2_label description: |- Label string for the interlock 2 "direction". (Optional - defaults to Close) default: Close - - arg_type: id + - type: id name: name description: |- Object name and associated gui name (Optional - defaults to "") - - arg_type: str + - type: str name: desc description: |- Box label for gui (Optional - defaults to value of device macro) default: $(device) - - arg_type: str + - type: str name: valvetype description: |- Type of valve for the gui. (Optional - defaults to valve). @@ -11951,7 +11951,7 @@ defs: sta_sv4: sta_sv7: sta_sv6: - valvearg_type: + valvetype: sta_label6: DIRILK2_label: device: @@ -11965,87 +11965,87 @@ defs: description: |- Template database for a machine flow meter args: - - arg_type: str + - type: str name: device description: |- device name - - arg_type: str + - type: str name: port description: |- asyn port name of etherip driver - - arg_type: int + - type: int name: tagidx description: |- etherip tag index - - arg_type: str + - type: str name: desc description: |- Template argument - - arg_type: str + - type: str name: tag description: |- etherip tag default: FlowRate - - arg_type: str + - type: str name: egu description: |- EGU default: Litres / Hour - - arg_type: int + - type: int name: prec description: |- PREC default: 1 - - arg_type: int + - type: int name: hopr description: |- HOPR default: 300 - - arg_type: float + - type: float name: lopr description: |- LOPR default: 0.0 - - arg_type: int + - type: int name: hihi description: |- HIHI default: 295 - - arg_type: int + - type: int name: lolo description: |- LOLO default: 100 - - arg_type: int + - type: int name: high description: |- HIGH default: 275 - - arg_type: int + - type: int name: adel description: |- ADEL default: 50 - - arg_type: int + - type: int name: mdel description: |- MDEL default: 10 - - arg_type: int + - type: int name: low description: |- LOW diff --git a/tests/samples/support/epics.ibek.support.yaml b/tests/samples/support/epics.ibek.support.yaml index d77d5c844..785e61027 100644 --- a/tests/samples/support/epics.ibek.support.yaml +++ b/tests/samples/support/epics.ibek.support.yaml @@ -5,7 +5,7 @@ defs: - name: EpicsCaMaxArrayBytes description: Set the maximum size in bytes for sending arrays over channel access args: - - arg_type: int + - type: int name: max_bytes description: Max size in bytes for sending arrays over channel access default: 6000000 @@ -16,7 +16,7 @@ defs: - name: EpicsTsMinWest description: Set the relative time zone minutes West relative to GMT (+/-720) args: - - arg_type: int + - type: int name: minutes_west description: relative time zone minutes default: 0 @@ -27,10 +27,10 @@ defs: - name: dbpf description: Set a PV value after iocInit args: - - arg_type: str + - type: str name: pv description: Name of PV - - arg_type: str + - type: str name: value description: Value to set post_init: @@ -39,10 +39,10 @@ defs: - name: EpicsEnvSet description: Set an environment variable in the ioc Shell args: - - arg_type: str + - type: str name: name description: Name of environment variable - - arg_type: str + - type: str name: value description: Value of environment variable env_vars: @@ -52,33 +52,33 @@ defs: - name: StartupCommand description: Adds an arbitrary command in the startup script before iocInit args: - - arg_type: str + - type: str name: command description: command string default: "" pre_init: - - arg_type: text + - type: text value: "{{ command }}" - name: PostStartupCommand description: Adds an arbitrary command in the startup script after iocInit args: - - arg_type: str + - type: str name: command description: command string default: "" post_init: - - arg_type: text + - type: text value: "{{ command }}" - name: InterruptVectorVME description: Reserve a VME interrupt vector args: - - arg_type: id + - type: id name: name description: A name for an interrupt vector variable - - arg_type: int + - type: int name: count description: The number of interrupt vectors to reserve default: 1 diff --git a/tests/samples/support/gauges.ibek.support.yaml b/tests/samples/support/gauges.ibek.support.yaml index 093c44679..53de9f46d 100644 --- a/tests/samples/support/gauges.ibek.support.yaml +++ b/tests/samples/support/gauges.ibek.support.yaml @@ -9,15 +9,15 @@ defs: description: |- MKS 937b Gauge controller args: - - arg_type: object + - type: object name: port description: |- Asyn port that connects to the device - - arg_type: id + - type: id name: name description: |- name for the Device - - arg_type: str + - type: str name: P description: |- PV prefix @@ -26,28 +26,28 @@ defs: description: |- Group of gauges args: - - arg_type: id + - type: id name: name description: |- name for the - - arg_type: object + - type: object name: gauge1 description: |- First gauge - - arg_type: object + - type: object name: gauge2 description: |- Second gauge # default to the id of the gauge object we want as default default: |- {{gauge1.name}} - - arg_type: object + - type: object name: gauge3 description: |- Third gauge default: | {{gauge1.name}} - - arg_type: object + - type: object name: gauge4 description: |- Fourth gauge diff --git a/tests/samples/support/ipac.ibek.support.yaml b/tests/samples/support/ipac.ibek.support.yaml index 873ce8037..578ea3e2f 100644 --- a/tests/samples/support/ipac.ibek.support.yaml +++ b/tests/samples/support/ipac.ibek.support.yaml @@ -7,31 +7,31 @@ defs: description: |- Configure a Hytec 8002 Carrier card args: - - arg_type: int + - type: int name: slot description: |- VME Slot number - - arg_type: id + - type: id name: IPACid description: |- Identifier for this device default: IPAC{{ slot }} - - arg_type: int + - type: int name: intLevel description: |- VME Interrupt Level default: 2 - name: test - arg_type: str + type: str description: test default: | {{ slot }} - name: interrupt_vector - arg_type: object + type: object description: Interrupt Vector reserved with epics.InterruptVectorVME, count=1 values: @@ -49,12 +49,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: int + - type: int name: slot description: |- VME Slot number - - arg_type: enum + - type: enum name: direction description: |- Direction of digital IO @@ -63,42 +63,42 @@ defs: Input: Output: - - arg_type: int + - type: int name: cardid description: |- cardid? - - arg_type: int + - type: int name: intLevel description: |- intLevel? default: 0 - - arg_type: int + - type: int name: clock description: |- clock? default: 0 - - arg_type: int + - type: int name: scan description: |- scan? default: 0 - - arg_type: bool + - type: bool name: invertin description: |- invertin? default: false - - arg_type: bool + - type: bool name: invertout description: |- invertout? default: false - - arg_type: bool + - type: bool name: ip_support description: |- ip_support? @@ -114,23 +114,23 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: int + - type: int name: slot description: |- VME Slot number - - arg_type: int + - type: int name: cardnum description: |- Card number - - arg_type: int + - type: int name: int_level description: |- VME Interrupt Level default: 1 - - arg_type: int + - type: int name: hs_int description: |- Dunno actually @@ -144,12 +144,12 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: object + - type: object name: parent description: |- Hy8005 card - - arg_type: enum + - type: enum name: ipslot description: |- IP slot @@ -159,12 +159,12 @@ defs: B: D: - - arg_type: int + - type: int name: cardnum description: |- EPICS card identification - - arg_type: enum + - type: enum name: debrate description: |- debrate @@ -175,7 +175,7 @@ defs: 100Hz: 500Hz: - - arg_type: enum + - type: enum name: pwidth description: |- pwidth @@ -192,7 +192,7 @@ defs: 50sec: 1msec: - - arg_type: enum + - type: enum name: scanrate description: |- scanrate @@ -203,7 +203,7 @@ defs: 10KHz: 1KHz: - - arg_type: enum + - type: enum name: direction description: |- direction @@ -214,7 +214,7 @@ defs: outputs: low out/high in: - - arg_type: enum + - type: enum name: clock description: |- clock @@ -223,13 +223,13 @@ defs: internal: external: - - arg_type: bool + - type: bool name: invertInputs description: |- invert inputs default: false - - arg_type: bool + - type: bool name: invertOutputs description: |- invert outputs diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index ab5507390..8816da1e5 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -6,14 +6,14 @@ defs: description: |- The protagonist from Red Dwarf args: - - arg_type: str + - type: str name: quote description: |- most hated quote default: |- Smoke me a kipper, I'll be back for breakfast - - arg_type: list + - type: list name: friends description: |- List of friends diff --git a/tests/samples/support/motorSim.ibek.support.yaml b/tests/samples/support/motorSim.ibek.support.yaml index 04e58ecff..3ea2df023 100644 --- a/tests/samples/support/motorSim.ibek.support.yaml +++ b/tests/samples/support/motorSim.ibek.support.yaml @@ -11,27 +11,27 @@ defs: Creates a simulation motion controller args: - - arg_type: id + - type: id name: controllerName description: |- The name of the controller and its Asyn Port Name - - arg_type: str + - type: str name: P description: |- Device PV Prefix - - arg_type: int + - type: int name: numAxes description: |- The number of axes to create - - arg_type: object + - type: object name: port description: |- a reference to the asyn port for communication with the controller - - arg_type: str + - type: str name: DESC description: |- The description of the controller @@ -62,52 +62,52 @@ defs: Creates a simulation motor axis args: - - arg_type: object + - type: object name: controller description: |- a reference to the motion controller - - arg_type: str + - type: str name: M description: |- PV suffix for the motor record - - arg_type: int + - type: int name: ADDR description: |- The axis number (allowed to be from 0 to controller.numAxes-1) - - arg_type: str + - type: str name: DESC description: |- The description of the axis default: "Motor {{ADDR}}" - - arg_type: int + - type: int name: DLLM description: |- The low limit of the axis (in counts) default: -20000 - - arg_type: int + - type: int name: DHLM description: |- The high limit of the axis (in counts) default: 20000 - - arg_type: int + - type: int name: home description: |- The home position of the axis (in counts) default: 0 - - arg_type: str # int or jinja string + - type: str # int or jinja string name: start description: |- The starting position of the axis (in counts) default: "{{home}}" - - arg_type: enum + - type: enum name: DIR description: |- The direction of the axis @@ -116,25 +116,25 @@ defs: Pos: 0 Neg: 1 - - arg_type: float + - type: float name: VELO description: |- The velocity of the axis (in counts/sec) default: 10.0 - - arg_type: str # float or jinja string + - type: str # float or jinja string name: VMAX description: |- The maximum velocity of the axis (in counts/sec) default: "{{VELO}}" - - arg_type: bool + - type: bool name: is_cs description: |- Set to True if this axis a coordinate system axis default: false - - arg_type: int + - type: int name: CS_NUM description: |- The coordinate system number for this axis diff --git a/tests/samples/support/quadem.ibek.support.yaml b/tests/samples/support/quadem.ibek.support.yaml index a1dd3d120..d7f682be4 100644 --- a/tests/samples/support/quadem.ibek.support.yaml +++ b/tests/samples/support/quadem.ibek.support.yaml @@ -7,34 +7,34 @@ defs: description: |- TODO:ADD DESCRIPTION args: - - arg_type: id + - type: id name: PORT description: |- Template argument - - arg_type: str + - type: str name: P description: |- Base name of PV. - - arg_type: str + - type: str name: R description: |- Second macro for name of PV. - - arg_type: int + - type: int name: QSIZE description: |- .. default: 20 - - arg_type: int + - type: int name: RING_SIZE description: |- .. default: 10000 - - arg_type: str + - type: str name: IP description: |- IP address of the TetrAMM device @@ -67,33 +67,33 @@ defs: 12 NDTimeSeries plugins 12 NDArray plugins args: - - arg_type: object + - type: object name: DEVICE description: |- Reference to the parent quadEM device - - arg_type: id + - type: id name: PORTPREFIX description: |- The prefix for plugin asyn port names - - arg_type: int + - type: int name: STAT_NCHAN description: |- Template argument - - arg_type: int + - type: int name: STAT_XSIZE description: |- Template argument - - arg_type: int + - type: int name: HIST_SIZE description: |- Template argument default: 256 - - arg_type: int + - type: int name: QUEUE description: |- length of NDArray queue diff --git a/tests/samples/support/technosoft.ibek.support.yaml b/tests/samples/support/technosoft.ibek.support.yaml index 3c5c54fb7..731885ca8 100644 --- a/tests/samples/support/technosoft.ibek.support.yaml +++ b/tests/samples/support/technosoft.ibek.support.yaml @@ -8,32 +8,32 @@ defs: Creates a Technosoft motion controller connected to a serial line args: - - arg_type: id + - type: id name: controllerName description: |- The name of the controller - - arg_type: str + - type: str name: P description: |- Device PV Prefix - - arg_type: str + - type: str name: TTY description: |- TTY - - arg_type: int + - type: int name: numAxes description: |- The number of axes to create default: 1 - - arg_type: int + - type: int name: hostid description: |- Host ID - - arg_type: str + - type: str name: CONFIG description: |- TML Configuration @@ -53,35 +53,35 @@ defs: Creates a motor axis args: - - arg_type: object + - type: object name: controller description: |- a reference to the motion controller - - arg_type: str + - type: str name: CHANNEL_PREFIX description: |- The axis prefix default: ax0 - - arg_type: str + - type: str name: CHANNEL_ID description: |- The axis ID default: MOT - - arg_type: int + - type: int name: axid description: |- The axis ID - - arg_type: str + - type: str name: axconf description: |- The axis configuration default: star_vat_phs.t.zip - - arg_type: enum + - type: enum name: homing description: |- Homing direction @@ -90,109 +90,109 @@ defs: LSN: LSP: - - arg_type: int + - type: int name: NSTEPS description: |- Number of steps default: 200 - - arg_type: int + - type: int name: NMICROSTEPS description: |- Number of microsteps default: 256 - - arg_type: int + - type: int name: VELO description: |- Velocity default: 20 - - arg_type: float + - type: float name: VELO_MIN description: |- Velocity min default: 0.1 - - arg_type: float + - type: float name: VELO_MAX description: |- Velocity Max default: 50 - - arg_type: float + - type: float name: ACCL description: |- Seconds to Velocity default: 0.5 - - arg_type: float + - type: float name: ACCL_MIN description: |- Seconds to Velocity default: 0.01 - - arg_type: float + - type: float name: ACCL_MAX description: |- Seconds to Velocity default: 1.5 - - arg_type: float + - type: float name: HAR description: |- Homing acceleration default: 0.5 - - arg_type: float + - type: float name: HVEL description: |- Homing Velocity default: 10 - - arg_type: int + - type: int name: JAR description: |- JAR default: 1 - - arg_type: int + - type: int name: JVEL description: |- JVEL default: 5 - - arg_type: str + - type: str name: EGU description: |- Engineering Units default: "ustep" - - arg_type: float + - type: float name: SLSP description: |- Limit default: 0.8 - - arg_type: int + - type: int name: ENABLED description: |- Enabled default: 1 - - arg_type: int + - type: int name: TIMEOUT description: |- Timeout default: 0 - - arg_type: str + - type: str name: ASYN_ADDR description: |- Asyn Addr? default: "0" - - arg_type: str + - type: str name: CONFIG description: |- Axis configuration string to add to the controller configuration diff --git a/tests/samples/support/utils.ibek.support.yaml b/tests/samples/support/utils.ibek.support.yaml index 4952dde51..187195157 100644 --- a/tests/samples/support/utils.ibek.support.yaml +++ b/tests/samples/support/utils.ibek.support.yaml @@ -10,7 +10,7 @@ defs: description: | Reserve an interrupt vector for use with VME hardware. args: - - arg_type: id + - type: id name: name description: A name for an interrupt vector variable @@ -27,17 +27,17 @@ defs: value: '{{ __utils__.counter("InterruptVector", start=192, stop=255) }}' pre_init: - - arg_type: comment + - type: comment value: global "magic" is {{ get_global }} - - arg_type: comment + - type: comment value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} - - arg_type: comment + - type: comment value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} - name: InterruptVectorVME2 description: naughty second use of same counter args: - - arg_type: id + - type: id name: name description: A name for an interrupt vector variable From ec70825594ea0c036911ff14596edb111852f643 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sat, 1 Jun 2024 21:53:58 +0000 Subject: [PATCH 12/24] better listarg test --- tests/samples/iocs/listarg.ibek.ioc.yaml | 2 +- tests/samples/outputs/listarg/st.cmd | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index 6a7c28b85..7638b87cd 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -8,4 +8,4 @@ entities: - type: listtest.lister friends: |- - {{ ["Rimmer"] + ["tt"] | list }} + {{ ["Rimmer"] + ["Parallel Holly"] * 3 }} diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index d569681bb..0c9e82de8 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -12,7 +12,9 @@ Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has First friend is Rimmer Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: - Rimmer -- tt +- Parallel Holly +- Parallel Holly +- Parallel Holly First friend is Rimmer dbLoadRecords /epics/runtime/ioc.db From 84a3c35165c72c31a6ff561cb9738a53d4d70740 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sun, 2 Jun 2024 07:28:36 +0000 Subject: [PATCH 13/24] add fastVacuum test --- tests/generate_samples.sh | 11 + tests/samples/iocs/fastVacuum.ibek.ioc.yaml | 66 ++++ tests/samples/outputs/fastVacuum/index.bob | 28 ++ tests/samples/outputs/fastVacuum/ioc.subst | 35 ++ tests/samples/outputs/fastVacuum/st.cmd | 10 + .../schemas/fastVacuum.ibek.schema.json | 315 ++++++++++++++++++ .../samples/schemas/ibek.support.schema.json | 21 ++ .../support/fastVacuum.ibek.support.yaml | 194 +++++++++++ tests/test_cli.py | 12 + tests/test_support.py | 1 + 10 files changed, 693 insertions(+) create mode 100644 tests/samples/iocs/fastVacuum.ibek.ioc.yaml create mode 100644 tests/samples/outputs/fastVacuum/index.bob create mode 100644 tests/samples/outputs/fastVacuum/ioc.subst create mode 100644 tests/samples/outputs/fastVacuum/st.cmd create mode 100644 tests/samples/schemas/fastVacuum.ibek.schema.json create mode 100644 tests/samples/support/fastVacuum.ibek.support.yaml diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index 7de9d1fad..d659c8d53 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -116,3 +116,14 @@ EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/listarg.ibek.ioc.yaml support/ mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/listarg + +############################################################################ +# fast vacuum (dlsPLC) example +############################################################################ + +echo making an ioc schema using fastVacuum support yaml +ibek ioc generate-schema --no-ibek-defs support/fastVacuum.ibek.support.yaml --output schemas/fastVacuum.ibek.schema.json + +echo making fastVacuum ioc +EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/fastVacuum.ibek.ioc.yaml support/fastVacuum.ibek.support.yaml +mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/fastVacuum diff --git a/tests/samples/iocs/fastVacuum.ibek.ioc.yaml b/tests/samples/iocs/fastVacuum.ibek.ioc.yaml new file mode 100644 index 000000000..50c6ae976 --- /dev/null +++ b/tests/samples/iocs/fastVacuum.ibek.ioc.yaml @@ -0,0 +1,66 @@ +# yaml-language-server: $schema=../schemas/fastVacuum.ibek.ioc.schema.json + +ioc_name: "sr03-va-ioc-01" + +description: auto-generated by https://github.com/epics-containers/builder2ibek + +entities: + - type: dlsPLC.dummy + device: VLVCC_01_EIP + + - type: dlsPLC.dummy + device: VLVCC_01_FINS + + - type: dlsPLC.fastVacuumMaster + dom: SR03C + eip_port: VLVCC_01_EIP + fins_port: VLVCC_01_FINS + name: FV.MASTER + + - type: dlsPLC.fastVacuumChannel + id: "01" + img: SR03S-VA-IMG-01 + master: FV.MASTER + name: FV.G1 + + - type: dlsPLC.fastVacuumChannel + id: "02" + img: SR03S-VA-IMG-02 + master: FV.MASTER + name: FV.G2 + + - type: dlsPLC.fastVacuumChannel + id: "03" + img: SR03A-VA-IMG-01 + master: FV.MASTER + name: FV.G3 + + - type: dlsPLC.fastVacuumChannel + id: "04" + img: SR03A-VA-IMG-02 + master: FV.MASTER + name: FV.G4 + + - type: dlsPLC.fastVacuumChannel + id: "05" + img: SR03A-VA-IMG-03 + master: FV.MASTER + name: FV.G5 + + - type: dlsPLC.fastVacuumChannel + id: "06" + img: SR03A-VA-IMG-04 + master: FV.MASTER + name: FV.G6 + + - type: dlsPLC.fastVacuumChannel + id: "07" + img: SR03I-VA-IMG-02 + master: FV.MASTER + name: FV.G7 + + - type: dlsPLC.fastVacuumChannel + id: "08" + img: SR03I-VA-IMG-03 + master: FV.MASTER + name: FV.G8 diff --git a/tests/samples/outputs/fastVacuum/index.bob b/tests/samples/outputs/fastVacuum/index.bob new file mode 100644 index 000000000..4ec1f35dd --- /dev/null +++ b/tests/samples/outputs/fastVacuum/index.bob @@ -0,0 +1,28 @@ + + sr03-va-ioc-01 + 0 + 0 + 10 + 35 + 4 + 4 + + Title + TITLE + sr03-va-ioc-01 + 0 + 0 + 10 + 25 + + + + + + + + + true + 1 + + diff --git a/tests/samples/outputs/fastVacuum/ioc.subst b/tests/samples/outputs/fastVacuum/ioc.subst new file mode 100644 index 000000000..c4aca9e98 --- /dev/null +++ b/tests/samples/outputs/fastVacuum/ioc.subst @@ -0,0 +1,35 @@ +############################################################################# +# DB substitution file generated by http://github.com/epics-containers/ibek # +############################################################################# + +file "$(DLSPLC)/db/dlsPLC_fastVacuumMaster.template" { +pattern + { "device", "eip_port" } + { "SR03C-VA-FAST-01", "VLVCC_01_EIP" } +} + +file "$(DLSPLC)/db/dlsPLC_fastVacuumLink.template" { +pattern + { "device", "lnk_no", "lnk", "fan", "mask" } + { "SR03C-VA-FAST-01", "1", "SR03C-VA-FAST-01:GAUGE:01_0", "01", "2" } + { "SR03C-VA-FAST-01", "2", "SR03C-VA-FAST-01:GAUGE:02_0", "01", "6" } + { "SR03C-VA-FAST-01", "3", "SR03C-VA-FAST-01:GAUGE:03_0", "01", "14" } + { "SR03C-VA-FAST-01", "4", "SR03C-VA-FAST-01:GAUGE:04_0", "01", "30" } + { "SR03C-VA-FAST-01", "5", "SR03C-VA-FAST-01:GAUGE:05_0", "01", "62" } + { "SR03C-VA-FAST-01", "6", "SR03C-VA-FAST-01:GAUGE:06_0", "01", "126" } + { "SR03C-VA-FAST-01", "1", "SR03C-VA-FAST-01:GAUGE:07_0", "02", "254" } + { "SR03C-VA-FAST-01", "2", "SR03C-VA-FAST-01:GAUGE:08_0", "02", "510" } +} + +file "$(DLSPLC)/db/dlsPLC_fastVacuumChannel.template" { +pattern + { "device", "img", "fins_port", "eip_port", "tagidx", "id", "em", "waveform_nelm", "wave0_addr", "wave1_addr", "wave2_addr", "wave3_addr", "wave4_addr", "wave5_addr", "combined_nelm", "timeout" } + { "SR03C-VA-FAST-01", "SR03S-VA-IMG-01", "VLVCC_01_FINS", "VLVCC_01_EIP", "1", "01", "0", "500", "0", "500", "1000", "1500", "2000", "2500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03S-VA-IMG-02", "VLVCC_01_FINS", "VLVCC_01_EIP", "2", "02", "0", "500", "3000", "3500", "4000", "4500", "5000", "5500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03A-VA-IMG-01", "VLVCC_01_FINS", "VLVCC_01_EIP", "3", "03", "0", "500", "6000", "6500", "7000", "7500", "8000", "8500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03A-VA-IMG-02", "VLVCC_01_FINS", "VLVCC_01_EIP", "4", "04", "0", "500", "9000", "9500", "10000", "10500", "11000", "11500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03A-VA-IMG-03", "VLVCC_01_FINS", "VLVCC_01_EIP", "5", "05", "0", "500", "12000", "12500", "13000", "13500", "14000", "14500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03A-VA-IMG-04", "VLVCC_01_FINS", "VLVCC_01_EIP", "6", "06", "0", "500", "15000", "15500", "16000", "16500", "17000", "17500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03I-VA-IMG-02", "VLVCC_01_FINS", "VLVCC_01_EIP", "7", "07", "0", "500", "18000", "18500", "19000", "19500", "20000", "20500", "3000", "0" } + { "SR03C-VA-FAST-01", "SR03I-VA-IMG-03", "VLVCC_01_FINS", "VLVCC_01_EIP", "8", "08", "0", "500", "21000", "21500", "22000", "22500", "23000", "23500", "3000", "0" } +} diff --git a/tests/samples/outputs/fastVacuum/st.cmd b/tests/samples/outputs/fastVacuum/st.cmd new file mode 100644 index 000000000..0d92e17c3 --- /dev/null +++ b/tests/samples/outputs/fastVacuum/st.cmd @@ -0,0 +1,10 @@ +# EPICS IOC Startup Script generated by https://github.com/epics-containers/ibek + +cd "/epics/ioc" +dbLoadDatabase dbd/ioc.dbd +ioc_registerRecordDeviceDriver pdbbase + + +dbLoadRecords /epics/runtime/ioc.db +iocInit + diff --git a/tests/samples/schemas/fastVacuum.ibek.schema.json b/tests/samples/schemas/fastVacuum.ibek.schema.json new file mode 100644 index 000000000..aa1fd43e8 --- /dev/null +++ b/tests/samples/schemas/fastVacuum.ibek.schema.json @@ -0,0 +1,315 @@ +{ + "$defs": { + "dlsPLC_dummy": { + "additionalProperties": false, + "properties": { + "type": { + "const": "dlsPLC.dummy", + "description": "dummy record", + "title": "Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "device": { + "description": "name for dummy object", + "title": "Device", + "type": "string" + } + }, + "required": [ + "type", + "device" + ], + "title": "dlsPLC_dummy", + "type": "object" + }, + "dlsPLC_fastVacuumChannel": { + "additionalProperties": false, + "properties": { + "type": { + "const": "dlsPLC.fastVacuumChannel", + "description": "Adds a fast vacuum channel to the fast vacuum master", + "title": "Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "gaugeNum": { + "default": "{{ _ctx_.counter(\"fvGaugeNum\", start=1) }}", + "description": "auto gauge count", + "title": "Gaugenum", + "type": "string" + }, + "fan": { + "default": "{{ \"%02d\" % (gaugeNum | int / 7 + 1) }}", + "description": "fan number", + "title": "Fan", + "type": "string" + }, + "mask": { + "default": "{{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**(gaugeNum | int)) }}", + "description": "mask for the channel", + "title": "Mask", + "type": "string" + }, + "name": { + "description": "Gui tag", + "title": "Name", + "type": "string" + }, + "master": { + "description": "Master", + "title": "Master" + }, + "img": { + "description": "Base IMG PV", + "title": "Img", + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/$defs/id" + } + ], + "description": "FV PLC gauge number" + }, + "em": { + "allOf": [ + { + "$ref": "#/$defs/em" + } + ], + "default": 0, + "description": "EM block to use" + }, + "timeout": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "asyn fins_port timeout", + "type": "integer" + } + ], + "default": 0, + "description": "union of and jinja representation of {typ}", + "title": "Timeout" + }, + "lnk_no": { + "default": "{{ ((gaugeNum | int - 1) % 6) + 1 }}", + "description": "link number", + "title": "Lnk No", + "type": "string" + }, + "gaugePV": { + "default": "{{ master.device }}:GAUGE:{{id}}_0", + "description": "Gauge PV", + "title": "Gaugepv", + "type": "string" + }, + "addr_offset": { + "default": "{{ (gaugeNum | int - 1) * (master.combined_nelm | int) }}", + "description": "waveform address offset for the first waveform for this channel", + "title": "Addr Offset", + "type": "string" + }, + "wave0_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 0 }}", + "description": "waveform address", + "title": "Wave0 Addr", + "type": "string" + }, + "wave1_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 1 }}", + "description": "waveform address", + "title": "Wave1 Addr", + "type": "string" + }, + "wave2_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 2 }}", + "description": "waveform address", + "title": "Wave2 Addr", + "type": "string" + }, + "wave3_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 3 }}", + "description": "waveform address", + "title": "Wave3 Addr", + "type": "string" + }, + "wave4_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 4 }}", + "description": "waveform address", + "title": "Wave4 Addr", + "type": "string" + }, + "wave5_addr": { + "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 5 }}", + "description": "waveform address", + "title": "Wave5 Addr", + "type": "string" + } + }, + "required": [ + "type", + "name", + "master", + "img", + "id" + ], + "title": "dlsPLC_fastVacuumChannel", + "type": "object" + }, + "dlsPLC_fastVacuumMaster": { + "additionalProperties": false, + "properties": { + "type": { + "const": "dlsPLC.fastVacuumMaster", + "description": "master records for fast vacuum", + "title": "Type" + }, + "entity_enabled": { + "default": true, + "description": "enable or disable this entity instance", + "title": "Entity Enabled", + "type": "boolean" + }, + "name": { + "description": "Gui tag", + "title": "Name", + "type": "string" + }, + "dom": { + "description": "Domain, eg, FE06I", + "title": "Dom", + "type": "string" + }, + "fins_port": { + "description": "FINS port", + "title": "Fins Port" + }, + "eip_port": { + "description": "EtherIP port", + "title": "Eip Port", + "type": "string" + }, + "device": { + "default": "{{dom}}-VA-FAST-01", + "description": "device name", + "title": "Device", + "type": "string" + }, + "waveform_nelm": { + "default": "500", + "description": "waveform element count", + "title": "Waveform Nelm", + "type": "string" + }, + "combined_nelm": { + "default": "{{ (6 * waveform_nelm|int) }}", + "description": "total waveform element count", + "title": "Combined Nelm", + "type": "string" + } + }, + "required": [ + "type", + "name", + "dom", + "fins_port", + "eip_port" + ], + "title": "dlsPLC_fastVacuumMaster", + "type": "object" + }, + "em": { + "enum": [ + "0", + "1", + "2" + ], + "title": "em", + "type": "string" + }, + "id": { + "enum": [ + "01", + "02", + "03", + "04", + "05", + "06", + "07", + "08", + "09", + "10" + ], + "title": "id", + "type": "string" + } + }, + "additionalProperties": false, + "properties": { + "ioc_name": { + "description": "Name of IOC instance", + "title": "Ioc Name", + "type": "string" + }, + "description": { + "description": "Description of what the IOC does", + "title": "Description", + "type": "string" + }, + "entities": { + "description": "List of entities this IOC instantiates", + "items": { + "discriminator": { + "mapping": { + "dlsPLC.dummy": "#/$defs/dlsPLC_dummy", + "dlsPLC.fastVacuumChannel": "#/$defs/dlsPLC_fastVacuumChannel", + "dlsPLC.fastVacuumMaster": "#/$defs/dlsPLC_fastVacuumMaster" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/$defs/dlsPLC_dummy" + }, + { + "$ref": "#/$defs/dlsPLC_fastVacuumMaster" + }, + { + "$ref": "#/$defs/dlsPLC_fastVacuumChannel" + } + ] + }, + "title": "Entities", + "type": "array" + }, + "shared": { + "default": [], + "description": "A place to create any anchors required for repeating YAML", + "items": {}, + "title": "Shared", + "type": "array" + } + }, + "required": [ + "ioc_name", + "description", + "entities" + ], + "title": "NewIOC", + "type": "object" +} \ No newline at end of file diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index de9aef247..0a2dc12eb 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -686,6 +686,15 @@ "description": "The contents of the value", "title": "Value", "type": "string" + }, + "type": { + "allOf": [ + { + "$ref": "#/$defs/ValueTypes" + } + ], + "default": "str", + "description": "The type of the value" } }, "required": [ @@ -696,6 +705,18 @@ "title": "Value", "type": "object" }, + "ValueTypes": { + "description": "The type of a value", + "enum": [ + "str", + "float", + "int", + "bool", + "list" + ], + "title": "ValueTypes", + "type": "string" + }, "When": { "enum": [ "first", diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml new file mode 100644 index 000000000..68db37471 --- /dev/null +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -0,0 +1,194 @@ +module: dlsPLC + +defs: + - name: dummy + description: |- + dummy record + args: + - type: id + name: device + description: |- + name for dummy object + + - name: fastVacuumMaster + description: |- + master records for fast vacuum + args: + - type: id + name: name + description: |- + Gui tag + + - type: str + name: dom + description: |- + Domain, eg, FE06I + + - type: object + name: fins_port + description: |- + FINS port + + - type: str + name: eip_port + description: |- + EtherIP port + + - type: str + name: device + description: |- + Device prefix + + values: + - description: device name + name: device + value: |- + {{dom}}-VA-FAST-01 + + - description: waveform element count + name: waveform_nelm + value: "500" + + - description: total waveform element count + name: combined_nelm + value: |- + {{ (6 * waveform_nelm|int) }} + + databases: + - file: $(DLSPLC)/db/dlsPLC_fastVacuumMaster.template + args: { device, eip_port } + - name: fastVacuumChannel + description: |- + Adds a fast vacuum channel to the fast vacuum master + args: + - type: id + name: name + description: |- + Gui tag + + - type: object + name: master + description: |- + Master + + - type: str + name: img + description: |- + Base IMG PV + + - type: enum + name: id + description: |- + FV PLC gauge number + values: + "01": + "02": + "03": + "04": + "05": + "06": + "07": + "08": + "09": + "10": + + - type: enum + name: em + description: |- + EM block to use + default: 0 + values: + "0": + "1": + "2": + + - type: int + name: timeout + description: |- + asyn fins_port timeout + default: 0 + + pre_values: + - description: auto gauge count + name: gaugeNum + value: |- + {{ _ctx_.counter("fvGaugeNum", start=1) }} + + - description: fan number + name: fan + value: |- + {{ "%02d" % (gaugeNum | int / 7 + 1) }} + + - description: mask for the channel + name: mask + value: |- + {{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**(gaugeNum | int)) }} + + values: + - description: link number + name: lnk_no + value: |- + {{ ((gaugeNum | int - 1) % 6) + 1 }} + + - description: Gauge PV + name: gaugePV + value: |- + {{ master.device }}:GAUGE:{{id}}_0 + + - description: waveform address offset for the first waveform for this channel + name: addr_offset + value: |- + {{ (gaugeNum | int - 1) * (master.combined_nelm | int) }} + + - description: waveform address + name: wave0_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 0 }} + + - description: waveform address + name: wave1_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 1 }} + + - description: waveform address + name: wave2_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 2 }} + + - description: waveform address + name: wave3_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 3 }} + + - description: waveform address + name: wave4_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 4 }} + + - description: waveform address + name: wave5_addr + value: |- + {{ (addr_offset | int) + (master.waveform_nelm | int) * 5 }} + + databases: + - file: $(DLSPLC)/db/dlsPLC_fastVacuumLink.template + args: { device: "{{master.device}}", lnk_no, lnk: "{{gaugePV}}", fan, mask } + + - file: $(DLSPLC)/db/dlsPLC_fastVacuumChannel.template + args: + device: "{{master.device}}" + img: + fins_port: "{{master.fins_port}}" + eip_port: "{{master.eip_port}}" + tagidx: "{{ (id | string).strip('0') }}" + id: "{{id}}" + em: + waveform_nelm: "{{master.waveform_nelm}}" + wave0_addr: + wave1_addr: + wave2_addr: + wave3_addr: + wave4_addr: + wave5_addr: + combined_nelm: "{{master.combined_nelm}}" + timeout: diff --git a/tests/test_cli.py b/tests/test_cli.py index 37f9df86a..638149ee4 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -205,3 +205,15 @@ def test_list(tmp_epics_root: Path, samples: Path): "listarg", ["listarg"], ) + + +def test_fast_vacuum(tmp_epics_root: Path, samples: Path): + """ + Cut down copy of dlsPLC containing fast vacuum master and channel + """ + generic_generate( + tmp_epics_root, + samples, + "fastVacuum", + ["fastVacuum"], + ) diff --git a/tests/test_support.py b/tests/test_support.py index 287ced9ab..5c357f2af 100644 --- a/tests/test_support.py +++ b/tests/test_support.py @@ -17,6 +17,7 @@ def test_symlink_ibek(tmp_path: Path, samples: Path): "bad_db.ibek.support.yaml", "dlsPLC.ibek.support.yaml", "epics.ibek.support.yaml", + "fastVacuum.ibek.support.yaml", "gauges.ibek.support.yaml", "ipac.ibek.support.yaml", "listarg.ibek.support.yaml", From f61b2ced9a93f0995ab06472caf60eda0f7b6d8d Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sun, 2 Jun 2024 08:19:57 +0000 Subject: [PATCH 14/24] add types to values/pre_values --- pyproject.toml | 1 + src/ibek/args.py | 30 ++++- src/ibek/entity_factory.py | 6 +- src/ibek/globals.py | 2 + tests/samples/iocs/listarg.ibek.ioc.yaml | 6 +- tests/samples/outputs/listarg/st.cmd | 21 ++-- .../samples/schemas/ibek.support.schema.json | 5 + .../samples/schemas/listarg.ibek.schema.json | 21 +++- tests/samples/support/fastVaccum.builder.py | 118 ++++++++++++++++++ .../samples/support/listarg.ibek.support.yaml | 18 ++- 10 files changed, 208 insertions(+), 20 deletions(-) create mode 100644 tests/samples/support/fastVaccum.builder.py diff --git a/pyproject.toml b/pyproject.toml index 6c36bfc90..437e9cec9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,6 +66,7 @@ ignore_missing_imports = true # Ignore missing stubs in imported modules addopts = """ --tb=native -vv --doctest-modules --doctest-glob="*.rst" --cov=ibek --cov-report term --cov-report xml:cov.xml + --ignore tests/samples """ # https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings filterwarnings = [ diff --git a/src/ibek/args.py b/src/ibek/args.py index 2154e73cd..1868addf3 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -4,12 +4,33 @@ from __future__ import annotations +from enum import Enum from typing import Any, Dict, Optional from pydantic import Field -from typing_extensions import Literal +from typing_extensions import Annotated, Literal -from .globals import BaseSettings +from .globals import JINJA, BaseSettings + +JinjaString = Annotated[ + str, Field(description="A Jinja2 template string", pattern=JINJA) +] + + +class ValueTypes(Enum): + """The type of a value""" + + string = "str" + float = "float" + int = "int" + bool = "bool" + list = "list" + + def __str__(self): + return str(self.value) + + def __repr__(self): + return str(self.value) class Value(BaseSettings): @@ -20,6 +41,9 @@ class Value(BaseSettings): description="Description of what the value will be used for" ) value: str = Field(description="The contents of the value") + type: ValueTypes = Field( + description="The type of the value", default=ValueTypes.string + ) class Arg(BaseSettings): @@ -38,7 +62,7 @@ class ListArg(Arg): """An argument with a float value""" type: Literal["list"] = "list" - default: Optional[list] = None + default: Optional[list | JinjaString] = None class FloatArg(Arg): diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index e217a25bb..1edce2093 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -95,7 +95,8 @@ def add_arg(name, typ, description, default): # these are the pre_values that should be Jinja rendered before any # Args (or post values) for value in definition.pre_values: - add_arg(value.name, str, value.description, value.value) + typ = getattr(builtins, value.type.value) + add_arg(value.name, typ, value.description, value.value) # add in each of the arguments as a Field in the Entity for arg in definition.args: @@ -135,7 +136,8 @@ def lookup_instance(cls, id): # add in the calculated values Jinja Templates as Fields in the Entity for value in definition.values: - add_arg(value.name, str, value.description, value.value) + typ = getattr(builtins, value.type.value) + add_arg(value.name, typ, value.description, value.value) # add the type literal which discriminates between the different Entity classes typ = Literal[full_name] # type: ignore diff --git a/src/ibek/globals.py b/src/ibek/globals.py index 2624cf27e..4e9bb8b6a 100644 --- a/src/ibek/globals.py +++ b/src/ibek/globals.py @@ -138,6 +138,8 @@ def RUNTIME_DEBS(self): GLOBALS = _Globals() +JINJA = r".*\{\{.*\}\}.*" + class BaseSettings(BaseModel): """A Base class for setting consistent Pydantic model configuration""" diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index 7638b87cd..f26771be7 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -4,8 +4,10 @@ description: an example motion ioc for ibek testing entities: - type: listtest.lister - friends: ["Rimmer", "Holly", "Cat", "Kryten"] + # test an actual list of strings + friends: ["Psiren", "Vindaloovian", "Polymorph"] - type: listtest.lister + # test a jinja template that renders to a list friends: |- - {{ ["Rimmer"] + ["Parallel Holly"] * 3 }} + {{ (["Rimmer"] + ["Parallel Holly"]) * 2 }} diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index 0c9e82de8..3a9fdf974 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -4,18 +4,23 @@ cd "/epics/ioc" dbLoadDatabase dbd/ioc.dbd ioc_registerRecordDeviceDriver pdbbase -Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: -- Rimmer -- Holly -- Cat -- Kryten -First friend is Rimmer -Lister does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: +Lister, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: +- Psiren +- Vindaloovian +- Polymorph + +First friend is Psiren +Time vortex friends are ['Polymorph', 'Polymorph', 'Polymorph', 'Psiren', 'Psiren', 'Psiren', 'Vindaloovian', 'Vindaloovian', 'Vindaloovian'] +Fist time vortex friend is Polymorph +Lister, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: - Rimmer - Parallel Holly +- Rimmer - Parallel Holly -- Parallel Holly + First friend is Rimmer +Time vortex friends are ['Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer'] +Fist time vortex friend is Parallel Holly dbLoadRecords /epics/runtime/ioc.db iocInit diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index 0a2dc12eb..d9e62e631 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -528,6 +528,11 @@ "items": {}, "type": "array" }, + { + "description": "A Jinja2 template string", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { "type": "null" } diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index 445f14a40..43e391c71 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -33,13 +33,30 @@ "type": "array" } ], + "default": "{{ [\"Rimmer\"] + [ \"Cat\", \"Kryten\", \"Holly\"] }}", "description": "union of and jinja representation of {typ}", "title": "Friends" + }, + "time_vortex": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "friends after the Time Hole episode", + "items": {}, + "type": "array" + } + ], + "default": "{{ (friends * 3) | sort }}", + "description": "union of and jinja representation of {typ}", + "title": "Time Vortex" } }, "required": [ - "type", - "friends" + "type" ], "title": "listtest_lister", "type": "object" diff --git a/tests/samples/support/fastVaccum.builder.py b/tests/samples/support/fastVaccum.builder.py new file mode 100644 index 000000000..685e4687c --- /dev/null +++ b/tests/samples/support/fastVaccum.builder.py @@ -0,0 +1,118 @@ +# type: ignore + +""" +This is the builder code that was used to generate the same ioc.subst as +the fastVacuum.ioc.ibek.yaml does. The snippet is included here for easy +comparison with the equivalent in fastVacuum.support.ibek.yaml. +""" + + +class _dlsPLC_fastVacuumChannel(AutoSubstitution): + TemplateFile = "dlsPLC_fastVacuumChannel.template" + + +class _dlsPLC_fastVacuumMaster(AutoSubstitution): + TemplateFile = "dlsPLC_fastVacuumMaster.template" + + +class _dlsPLC_fastVacuumLink(AutoSubstitution): + TemplateFile = "dlsPLC_fastVacuumLink.template" + + +class fastVacuumMaster(Device): + Dependencies = (dlsPLCLib,) + + def __init__(self, name, dom, fins_port, eip_port): + self.__super.__init__() + self.name = name + self.device = dom + "-VA-VFAST-01" + self.fins_port = fins_port + self.eip_port = eip_port + self.waveform_nelm = 500 + self.combined_nelm = self.waveform_nelm * 6 + self.noOfGauges = 0 + self.gauges = list() + + _dlsPLC_fastVacuumMaster(device=self.device, eip_port=self.eip_port) + + # Method called be each gauge to add them to the processing chain + def registerGauge(self, id): + self.noOfGauges += 1 + self.gauges.append(id) + mask = 0 + # Determine the paramters for the FAN records + gaugePV = self.device + ":GAUGE" + id + "_0" + fanNo = int(self.noOfGauges / 7) + 1 + lnk_no = ((self.noOfGauges - 1) % 6) + 1 + + # Determine the mask + for gauge in self.gauges: + mask += pow(2, int(gauge)) + + _dlsPLC_fastVacuumLink( + device=self.device, + fan="%02d" % (fanNo), + lnk_no=lnk_no, + lnk=gaugePV, + mask=mask, + ) + + ArgInfo = makeArgInfo( + __init__, + name=Simple("Gui tag", str), + dom=Simple("Domain, eg, FE06I", str), + fins_port=Ident("FINS port", AsynIP), + eip_port=Simple("EtherIP port", str), + ) + + +class fastVacuumChannel( + Device, +): + def __init__(self, name, master, img, id, em=0): + self.__super.__init__() + self.name = name + self.device = master.device + self.fins_port = master.fins_port + self.eip_port = master.eip_port + self.id = id + self.img = img + self.em = em + self.waveform_nelm = master.waveform_nelm + self.combined_nelm = master.combined_nelm + self.addr_offset = (int(id) - 1) * 3000 + self.tagidx = int(self.id) + self.rwList = list() + self.rList = list() + + master.registerGauge(id) + + # List of addresses for the 6 waveform records based on the ID and chunk size + wave_addr = [self.addr_offset + (self.waveform_nelm * a) for a in range(6)] + + _dlsPLC_fastVacuumChannel( + device=self.device, + img=self.img, + fins_port=self.fins_port, + eip_port=self.eip_port, + tagidx=str(int(self.id)), + id=self.id, + em=self.em, + waveform_nelm=self.waveform_nelm, + combined_nelm=self.combined_nelm, + wave0_addr=wave_addr[0], + wave1_addr=wave_addr[1], + wave2_addr=wave_addr[2], + wave3_addr=wave_addr[3], + wave4_addr=wave_addr[4], + wave5_addr=wave_addr[5], + ) + + ArgInfo = makeArgInfo( + __init__, + name=Simple("Gui tag", str), + master=Ident("Master", fastVacuumMaster), + img=Simple("Base IMG PV", str), + id=Choice("FV PLC gauge number", ["%02d" % (a) for a in range(1, 11)]), + em=Choice("EM block to use", range(3)), + ) diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index 8816da1e5..b66826ace 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -17,12 +17,24 @@ defs: name: friends description: |- List of friends + default: '{{ ["Rimmer"] + [ "Cat", "Kryten", "Holly"] }}' + + values: + - name: time_vortex + description: |- + friends after the Time Hole episode + type: list + value: |- + {{ (friends * 3) | sort }} pre_init: - value: | - Lister does not like to hear "{{quote}}" has friends: - {% for friend in friends -%} + Lister, who does not like to hear "{{quote}}" has friends: + {#- example Jinja loop which is discouraged, but demos we have a list -#} + {%- for friend in friends %} - {{friend}} - {% endfor -%} + {%- endfor%} First friend is {{friends[0]}} + Time vortex friends are {{time_vortex}} + Fist time vortex friend is {{time_vortex[0]}} From 5edfaca247f9d3a828f993b561731000912d30bc Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Sun, 2 Jun 2024 09:06:42 +0000 Subject: [PATCH 15/24] add value typing to the fastVacuum example --- src/ibek/args.py | 2 +- tests/generate_samples.sh | 2 +- ...a.json => fastVacuum.ibek.ioc.schema.json} | 127 ++++++++++-------- .../samples/schemas/ibek.support.schema.json | 3 +- tests/samples/support/fastVaccum.builder.py | 118 ---------------- .../support/fastVacuum.ibek.support.yaml | 65 ++++----- 6 files changed, 102 insertions(+), 215 deletions(-) rename tests/samples/schemas/{fastVacuum.ibek.schema.json => fastVacuum.ibek.ioc.schema.json} (69%) delete mode 100644 tests/samples/support/fastVaccum.builder.py diff --git a/src/ibek/args.py b/src/ibek/args.py index 1868addf3..62b403f22 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -40,7 +40,7 @@ class Value(BaseSettings): description: str = Field( description="Description of what the value will be used for" ) - value: str = Field(description="The contents of the value") + value: Any = Field(description="The contents of the value") type: ValueTypes = Field( description="The type of the value", default=ValueTypes.string ) diff --git a/tests/generate_samples.sh b/tests/generate_samples.sh index d659c8d53..05f07d84b 100755 --- a/tests/generate_samples.sh +++ b/tests/generate_samples.sh @@ -122,7 +122,7 @@ mv `pwd`/epics/{runtime,opi}/* `pwd`/outputs/listarg ############################################################################ echo making an ioc schema using fastVacuum support yaml -ibek ioc generate-schema --no-ibek-defs support/fastVacuum.ibek.support.yaml --output schemas/fastVacuum.ibek.schema.json +ibek ioc generate-schema --no-ibek-defs support/fastVacuum.ibek.support.yaml --output schemas/fastVacuum.ibek.ioc.schema.json echo making fastVacuum ioc EPICS_ROOT=`pwd`/epics ibek runtime generate iocs/fastVacuum.ibek.ioc.yaml support/fastVacuum.ibek.support.yaml diff --git a/tests/samples/schemas/fastVacuum.ibek.schema.json b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json similarity index 69% rename from tests/samples/schemas/fastVacuum.ibek.schema.json rename to tests/samples/schemas/fastVacuum.ibek.ioc.schema.json index aa1fd43e8..8e78bd39c 100644 --- a/tests/samples/schemas/fastVacuum.ibek.schema.json +++ b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json @@ -42,19 +42,29 @@ "type": "boolean" }, "gaugeNum": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "auto gauge count", + "type": "integer" + } + ], "default": "{{ _ctx_.counter(\"fvGaugeNum\", start=1) }}", - "description": "auto gauge count", - "title": "Gaugenum", - "type": "string" + "description": "union of and jinja representation of {typ}", + "title": "Gaugenum" }, "fan": { - "default": "{{ \"%02d\" % (gaugeNum | int / 7 + 1) }}", + "default": "{{ \"%02d\" % (gaugeNum / 7 + 1) }}", "description": "fan number", "title": "Fan", "type": "string" }, "mask": { - "default": "{{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**(gaugeNum | int)) }}", + "default": "{{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**gaugeNum) }}", "description": "mask for the channel", "title": "Mask", "type": "string" @@ -107,7 +117,7 @@ "title": "Timeout" }, "lnk_no": { - "default": "{{ ((gaugeNum | int - 1) % 6) + 1 }}", + "default": "{{ ((gaugeNum - 1) % 6) + 1 }}", "description": "link number", "title": "Lnk No", "type": "string" @@ -119,46 +129,37 @@ "type": "string" }, "addr_offset": { - "default": "{{ (gaugeNum | int - 1) * (master.combined_nelm | int) }}", - "description": "waveform address offset for the first waveform for this channel", - "title": "Addr Offset", - "type": "string" - }, - "wave0_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 0 }}", - "description": "waveform address", - "title": "Wave0 Addr", - "type": "string" - }, - "wave1_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 1 }}", - "description": "waveform address", - "title": "Wave1 Addr", - "type": "string" - }, - "wave2_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 2 }}", - "description": "waveform address", - "title": "Wave2 Addr", - "type": "string" - }, - "wave3_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 3 }}", - "description": "waveform address", - "title": "Wave3 Addr", - "type": "string" - }, - "wave4_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 4 }}", - "description": "waveform address", - "title": "Wave4 Addr", - "type": "string" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "waveform address offset for the first waveform for this channel", + "type": "integer" + } + ], + "default": "{{ (gaugeNum - 1) * master.combined_nelm }}", + "description": "union of and jinja representation of {typ}", + "title": "Addr Offset" }, - "wave5_addr": { - "default": "{{ (addr_offset | int) + (master.waveform_nelm | int) * 5 }}", - "description": "waveform address", - "title": "Wave5 Addr", - "type": "string" + "wave_addr": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "waveform addresses", + "items": {}, + "type": "array" + } + ], + "default": "{%- set addr = [] -%}\n{%- for i in range(6) -%}\n{%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%}\n{%- endfor -%}\n{{ addr }}", + "description": "union of and jinja representation of {typ}", + "title": "Wave Addr" } }, "required": [ @@ -211,16 +212,36 @@ "type": "string" }, "waveform_nelm": { - "default": "500", - "description": "waveform element count", - "title": "Waveform Nelm", - "type": "string" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "waveform element count", + "type": "integer" + } + ], + "default": 500, + "description": "union of and jinja representation of {typ}", + "title": "Waveform Nelm" }, "combined_nelm": { - "default": "{{ (6 * waveform_nelm|int) }}", - "description": "total waveform element count", - "title": "Combined Nelm", - "type": "string" + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "total waveform element count", + "type": "integer" + } + ], + "default": "{{ 6 * waveform_nelm }}", + "description": "union of and jinja representation of {typ}", + "title": "Combined Nelm" } }, "required": [ diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index d9e62e631..e55ac4d3a 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -689,8 +689,7 @@ }, "value": { "description": "The contents of the value", - "title": "Value", - "type": "string" + "title": "Value" }, "type": { "allOf": [ diff --git a/tests/samples/support/fastVaccum.builder.py b/tests/samples/support/fastVaccum.builder.py deleted file mode 100644 index 685e4687c..000000000 --- a/tests/samples/support/fastVaccum.builder.py +++ /dev/null @@ -1,118 +0,0 @@ -# type: ignore - -""" -This is the builder code that was used to generate the same ioc.subst as -the fastVacuum.ioc.ibek.yaml does. The snippet is included here for easy -comparison with the equivalent in fastVacuum.support.ibek.yaml. -""" - - -class _dlsPLC_fastVacuumChannel(AutoSubstitution): - TemplateFile = "dlsPLC_fastVacuumChannel.template" - - -class _dlsPLC_fastVacuumMaster(AutoSubstitution): - TemplateFile = "dlsPLC_fastVacuumMaster.template" - - -class _dlsPLC_fastVacuumLink(AutoSubstitution): - TemplateFile = "dlsPLC_fastVacuumLink.template" - - -class fastVacuumMaster(Device): - Dependencies = (dlsPLCLib,) - - def __init__(self, name, dom, fins_port, eip_port): - self.__super.__init__() - self.name = name - self.device = dom + "-VA-VFAST-01" - self.fins_port = fins_port - self.eip_port = eip_port - self.waveform_nelm = 500 - self.combined_nelm = self.waveform_nelm * 6 - self.noOfGauges = 0 - self.gauges = list() - - _dlsPLC_fastVacuumMaster(device=self.device, eip_port=self.eip_port) - - # Method called be each gauge to add them to the processing chain - def registerGauge(self, id): - self.noOfGauges += 1 - self.gauges.append(id) - mask = 0 - # Determine the paramters for the FAN records - gaugePV = self.device + ":GAUGE" + id + "_0" - fanNo = int(self.noOfGauges / 7) + 1 - lnk_no = ((self.noOfGauges - 1) % 6) + 1 - - # Determine the mask - for gauge in self.gauges: - mask += pow(2, int(gauge)) - - _dlsPLC_fastVacuumLink( - device=self.device, - fan="%02d" % (fanNo), - lnk_no=lnk_no, - lnk=gaugePV, - mask=mask, - ) - - ArgInfo = makeArgInfo( - __init__, - name=Simple("Gui tag", str), - dom=Simple("Domain, eg, FE06I", str), - fins_port=Ident("FINS port", AsynIP), - eip_port=Simple("EtherIP port", str), - ) - - -class fastVacuumChannel( - Device, -): - def __init__(self, name, master, img, id, em=0): - self.__super.__init__() - self.name = name - self.device = master.device - self.fins_port = master.fins_port - self.eip_port = master.eip_port - self.id = id - self.img = img - self.em = em - self.waveform_nelm = master.waveform_nelm - self.combined_nelm = master.combined_nelm - self.addr_offset = (int(id) - 1) * 3000 - self.tagidx = int(self.id) - self.rwList = list() - self.rList = list() - - master.registerGauge(id) - - # List of addresses for the 6 waveform records based on the ID and chunk size - wave_addr = [self.addr_offset + (self.waveform_nelm * a) for a in range(6)] - - _dlsPLC_fastVacuumChannel( - device=self.device, - img=self.img, - fins_port=self.fins_port, - eip_port=self.eip_port, - tagidx=str(int(self.id)), - id=self.id, - em=self.em, - waveform_nelm=self.waveform_nelm, - combined_nelm=self.combined_nelm, - wave0_addr=wave_addr[0], - wave1_addr=wave_addr[1], - wave2_addr=wave_addr[2], - wave3_addr=wave_addr[3], - wave4_addr=wave_addr[4], - wave5_addr=wave_addr[5], - ) - - ArgInfo = makeArgInfo( - __init__, - name=Simple("Gui tag", str), - master=Ident("Master", fastVacuumMaster), - img=Simple("Base IMG PV", str), - id=Choice("FV PLC gauge number", ["%02d" % (a) for a in range(1, 11)]), - em=Choice("EM block to use", range(3)), - ) diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index 68db37471..c6c18c235 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -47,12 +47,14 @@ defs: - description: waveform element count name: waveform_nelm - value: "500" + type: int + value: 500 - description: total waveform element count name: combined_nelm + type: int value: |- - {{ (6 * waveform_nelm|int) }} + {{ 6 * waveform_nelm }} databases: - file: $(DLSPLC)/db/dlsPLC_fastVacuumMaster.template @@ -111,24 +113,25 @@ defs: pre_values: - description: auto gauge count name: gaugeNum + type: int value: |- {{ _ctx_.counter("fvGaugeNum", start=1) }} - description: fan number name: fan value: |- - {{ "%02d" % (gaugeNum | int / 7 + 1) }} + {{ "%02d" % (gaugeNum / 7 + 1) }} - description: mask for the channel name: mask value: |- - {{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**(gaugeNum | int)) }} + {{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**gaugeNum) }} values: - description: link number name: lnk_no value: |- - {{ ((gaugeNum | int - 1) % 6) + 1 }} + {{ ((gaugeNum - 1) % 6) + 1 }} - description: Gauge PV name: gaugePV @@ -137,38 +140,20 @@ defs: - description: waveform address offset for the first waveform for this channel name: addr_offset + type: int value: |- - {{ (gaugeNum | int - 1) * (master.combined_nelm | int) }} + {{ (gaugeNum - 1) * master.combined_nelm }} - - description: waveform address - name: wave0_addr + - description: waveform addresses + name: wave_addr + type: list + # this is still not pretty enough :-( value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 0 }} - - - description: waveform address - name: wave1_addr - value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 1 }} - - - description: waveform address - name: wave2_addr - value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 2 }} - - - description: waveform address - name: wave3_addr - value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 3 }} - - - description: waveform address - name: wave4_addr - value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 4 }} - - - description: waveform address - name: wave5_addr - value: |- - {{ (addr_offset | int) + (master.waveform_nelm | int) * 5 }} + {%- set addr = [] -%} + {%- for i in range(6) -%} + {%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%} + {%- endfor -%} + {{ addr }} databases: - file: $(DLSPLC)/db/dlsPLC_fastVacuumLink.template @@ -184,11 +169,11 @@ defs: id: "{{id}}" em: waveform_nelm: "{{master.waveform_nelm}}" - wave0_addr: - wave1_addr: - wave2_addr: - wave3_addr: - wave4_addr: - wave5_addr: + wave0_addr: "{{wave_addr[0]}}" + wave1_addr: "{{wave_addr[1]}}" + wave2_addr: "{{wave_addr[2]}}" + wave3_addr: "{{wave_addr[3]}}" + wave4_addr: "{{wave_addr[4]}}" + wave5_addr: "{{wave_addr[5]}}" combined_nelm: "{{master.combined_nelm}}" timeout: From a067c6f24664ff2e4e6bdcc2c4e6fbaa6a6e6ae9 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Mon, 3 Jun 2024 13:11:21 +0000 Subject: [PATCH 16/24] add tidier list creation in fastVacuum --- tests/samples/support/fastVacuum.ibek.support.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index c6c18c235..977bfc6f1 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -147,7 +147,14 @@ defs: - description: waveform addresses name: wave_addr type: list - # this is still not pretty enough :-( + value: |- + {%- set addr_list = range(addr_offset,addr_offset + master.waveform_nelm * 6, master.waveform_nelm) -%} + {{ addr_list | list }} + + - description: waveform addresses + name: wave_addr_alternative + type: list + # explicit loop is uglier but more versatile value: |- {%- set addr = [] -%} {%- for i in range(6) -%} From 1a06217a4a085552bd6deb5323981bb9139ddea0 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Mon, 3 Jun 2024 13:38:18 +0000 Subject: [PATCH 17/24] add schema to fastVacuum.ibek.support.yaml --- tests/samples/support/fastVacuum.ibek.support.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index 977bfc6f1..92bf64e67 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -1,3 +1,5 @@ +# yaml-language-server: $schema=../schemas/ibek.support.schema.json + module: dlsPLC defs: From 928c6cd0871c00ae3d1de792ecb30d8acddb2c3c Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 06:48:16 +0000 Subject: [PATCH 18/24] add use_enum_values=True to models for pydantic 2.7.3 --- src/ibek/entity_factory.py | 18 +- src/ibek/globals.py | 1 + .../schemas/fastVacuum.ibek.ioc.schema.json | 37 +++- .../schemas/gauges.ibek.ioc.schema.json | 18 +- .../samples/schemas/ibek.support.schema.json | 60 +++++- .../samples/schemas/ipac.ibek.ioc.schema.json | 66 +++++-- .../samples/schemas/listarg.ibek.schema.json | 6 +- .../schemas/motorSim.ibek.ioc.schema.json | 18 +- .../schemas/quadem.ibek.ioc.schema.json | 180 +++++++++++++++--- .../schemas/single.ibek.ioc.schema.json | 12 +- .../schemas/technosoft.ibek.ioc.schema.json | 12 +- .../schemas/utils.ibek.ioc.schema.json | 12 +- 12 files changed, 364 insertions(+), 76 deletions(-) diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 1edce2093..ae5cf75fb 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -6,13 +6,13 @@ import builtins from pathlib import Path -from typing import Annotated, Any, Dict, List, Literal, Tuple, Type +from typing import Annotated, Any, Dict, List, Literal, Sequence, Tuple, Type from pydantic import Field, create_model, field_validator from pydantic_core import PydanticUndefined, ValidationError from ruamel.yaml.main import YAML -from .args import EnumArg, IdArg, ObjectArg +from .args import EnumArg, IdArg, ObjectArg, Value from .ioc import Entity, EnumVal, clear_entity_model_ids, get_entity_by_id from .support import EntityDefinition, Support from .utils import UTILS @@ -60,6 +60,12 @@ def _make_entity_model( Create an Entity Model from a Definition instance and a Support instance. """ + def add_defines(s: Sequence[Value]) -> None: + # add in the pre_defines or post_defines as Args in the Entity + for value in s: + typ = getattr(builtins, str(value.type)) + add_arg(value.name, typ, value.description, value.value) + def add_arg(name, typ, description, default): if default is None: default = PydanticUndefined @@ -94,9 +100,7 @@ def add_arg(name, typ, description, default): # add in the calculated values Jinja Templates as Fields in the Entity # these are the pre_values that should be Jinja rendered before any # Args (or post values) - for value in definition.pre_values: - typ = getattr(builtins, value.type.value) - add_arg(value.name, typ, value.description, value.value) + add_defines(definition.pre_values) # add in each of the arguments as a Field in the Entity for arg in definition.args: @@ -135,9 +139,7 @@ def lookup_instance(cls, id): add_arg(arg.name, type, arg.description, getattr(arg, "default")) # type: ignore # add in the calculated values Jinja Templates as Fields in the Entity - for value in definition.values: - typ = getattr(builtins, value.type.value) - add_arg(value.name, typ, value.description, value.value) + add_defines(definition.values) # add the type literal which discriminates between the different Entity classes typ = Literal[full_name] # type: ignore diff --git a/src/ibek/globals.py b/src/ibek/globals.py index 4e9bb8b6a..ced388f85 100644 --- a/src/ibek/globals.py +++ b/src/ibek/globals.py @@ -146,6 +146,7 @@ class BaseSettings(BaseModel): model_config = ConfigDict( extra="forbid", + use_enum_values=True, ) diff --git a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json index 8e78bd39c..2733406c3 100644 --- a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json +++ b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json @@ -6,7 +6,11 @@ "type": { "const": "dlsPLC.dummy", "description": "dummy record", - "title": "Type" + "enum": [ + "dlsPLC.dummy" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -33,7 +37,11 @@ "type": { "const": "dlsPLC.fastVacuumChannel", "description": "Adds a fast vacuum channel to the fast vacuum master", - "title": "Type" + "enum": [ + "dlsPLC.fastVacuumChannel" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -157,9 +165,26 @@ "type": "array" } ], - "default": "{%- set addr = [] -%}\n{%- for i in range(6) -%}\n{%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%}\n{%- endfor -%}\n{{ addr }}", + "default": "{%- set addr_list = range(addr_offset,addr_offset + master.waveform_nelm * 6, master.waveform_nelm) -%}\n{{ addr_list | list }}", "description": "union of and jinja representation of {typ}", "title": "Wave Addr" + }, + "wave_addr_alternative": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "waveform addresses", + "items": {}, + "type": "array" + } + ], + "default": "{%- set addr = [] -%}\n{%- for i in range(6) -%}\n{%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%}\n{%- endfor -%}\n{{ addr }}", + "description": "union of and jinja representation of {typ}", + "title": "Wave Addr Alternative" } }, "required": [ @@ -178,7 +203,11 @@ "type": { "const": "dlsPLC.fastVacuumMaster", "description": "master records for fast vacuum", - "title": "Type" + "enum": [ + "dlsPLC.fastVacuumMaster" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/gauges.ibek.ioc.schema.json b/tests/samples/schemas/gauges.ibek.ioc.schema.json index e9fd9499c..6230cda5a 100644 --- a/tests/samples/schemas/gauges.ibek.ioc.schema.json +++ b/tests/samples/schemas/gauges.ibek.ioc.schema.json @@ -6,7 +6,11 @@ "type": { "const": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Type" + "enum": [ + "asyn.AsynIP" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -186,7 +190,11 @@ "type": { "const": "gauges.GaugeGroup", "description": "Group of gauges", - "title": "Type" + "enum": [ + "gauges.GaugeGroup" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -233,7 +241,11 @@ "type": { "const": "gauges.Mks937bGauge", "description": "MKS 937b Gauge controller", - "title": "Type" + "enum": [ + "gauges.Mks937bGauge" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index e55ac4d3a..98b3c3e08 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -7,7 +7,11 @@ "type": { "const": "bool", "default": "bool", - "title": "Type" + "enum": [ + "bool" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -46,7 +50,11 @@ "type": { "const": "comment", "default": "comment", - "title": "Type" + "enum": [ + "comment" + ], + "title": "Type", + "type": "string" }, "when": { "allOf": [ @@ -328,7 +336,11 @@ "type": { "const": "enum", "default": "enum", - "title": "Type" + "enum": [ + "enum" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -393,7 +405,11 @@ "type": { "const": "float", "default": "float", - "title": "Type" + "enum": [ + "float" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -432,7 +448,11 @@ "type": { "const": "id", "default": "id", - "title": "Type" + "enum": [ + "id" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -471,7 +491,11 @@ "type": { "const": "int", "default": "int", - "title": "Type" + "enum": [ + "int" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -510,7 +534,11 @@ "type": { "const": "list", "default": "list", - "title": "Type" + "enum": [ + "list" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -555,7 +583,11 @@ "type": { "const": "object", "default": "object", - "title": "Type" + "enum": [ + "object" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -594,7 +626,11 @@ "type": { "const": "str", "default": "str", - "title": "Type" + "enum": [ + "str" + ], + "title": "Type", + "type": "string" }, "name": { "description": "Name of the argument that the IOC instance should pass", @@ -655,7 +691,11 @@ "type": { "const": "text", "default": "text", - "title": "Type" + "enum": [ + "text" + ], + "title": "Type", + "type": "string" }, "when": { "default": "every", diff --git a/tests/samples/schemas/ipac.ibek.ioc.schema.json b/tests/samples/schemas/ipac.ibek.ioc.schema.json index 6ef34a0f9..548dd98f3 100644 --- a/tests/samples/schemas/ipac.ibek.ioc.schema.json +++ b/tests/samples/schemas/ipac.ibek.ioc.schema.json @@ -25,7 +25,11 @@ "type": { "const": "epics.EpicsCaMaxArrayBytes", "description": "Set the maximum size in bytes for sending arrays over channel access", - "title": "Type" + "enum": [ + "epics.EpicsCaMaxArrayBytes" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -62,7 +66,11 @@ "type": { "const": "epics.EpicsEnvSet", "description": "Set an environment variable in the ioc Shell", - "title": "Type" + "enum": [ + "epics.EpicsEnvSet" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -95,7 +103,11 @@ "type": { "const": "epics.EpicsTsMinWest", "description": "Set the relative time zone minutes West relative to GMT (+/-720)", - "title": "Type" + "enum": [ + "epics.EpicsTsMinWest" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -132,7 +144,11 @@ "type": { "const": "epics.InterruptVectorVME", "description": "Reserve a VME interrupt vector", - "title": "Type" + "enum": [ + "epics.InterruptVectorVME" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -181,7 +197,11 @@ "type": { "const": "epics.PostStartupCommand", "description": "Adds an arbitrary command in the startup script after iocInit", - "title": "Type" + "enum": [ + "epics.PostStartupCommand" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -208,7 +228,11 @@ "type": { "const": "epics.StartupCommand", "description": "Adds an arbitrary command in the startup script before iocInit", - "title": "Type" + "enum": [ + "epics.StartupCommand" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -235,7 +259,11 @@ "type": { "const": "epics.dbpf", "description": "Set a PV value after iocInit", - "title": "Type" + "enum": [ + "epics.dbpf" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -287,7 +315,11 @@ "type": { "const": "ipac.Hy8001", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "ipac.Hy8001" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -445,7 +477,11 @@ "type": { "const": "ipac.Hy8002", "description": "Configure a Hytec 8002 Carrier card", - "title": "Type" + "enum": [ + "ipac.Hy8002" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -521,7 +557,11 @@ "type": { "const": "ipac.Hy8005", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "ipac.Hy8005" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -606,7 +646,11 @@ "type": { "const": "ipac.Hy8005_Channel", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "ipac.Hy8005_Channel" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index 43e391c71..57f031917 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -6,7 +6,11 @@ "type": { "const": "listtest.lister", "description": "The protagonist from Red Dwarf", - "title": "Type" + "enum": [ + "listtest.lister" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/motorSim.ibek.ioc.schema.json b/tests/samples/schemas/motorSim.ibek.ioc.schema.json index 6b18b51bc..9d213726f 100644 --- a/tests/samples/schemas/motorSim.ibek.ioc.schema.json +++ b/tests/samples/schemas/motorSim.ibek.ioc.schema.json @@ -14,7 +14,11 @@ "type": { "const": "asyn.AsynIP", "description": "Asyn IP Port", - "title": "Type" + "enum": [ + "asyn.AsynIP" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -194,7 +198,11 @@ "type": { "const": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Type" + "enum": [ + "motorSim.simMotorAxis" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -365,7 +373,11 @@ "type": { "const": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Type" + "enum": [ + "motorSim.simMotorController" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/quadem.ibek.ioc.schema.json b/tests/samples/schemas/quadem.ibek.ioc.schema.json index a2bc9520f..ab61d19e8 100644 --- a/tests/samples/schemas/quadem.ibek.ioc.schema.json +++ b/tests/samples/schemas/quadem.ibek.ioc.schema.json @@ -6,7 +6,11 @@ "type": { "const": "ADCore.NDAttrPlot", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "ADCore.NDAttrPlot" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -195,7 +199,11 @@ "type": { "const": "ADCore.NDAttribute", "description": "This plugin displays NDArray attributes", - "title": "Type" + "enum": [ + "ADCore.NDAttribute" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -382,7 +390,11 @@ "type": { "const": "ADCore.NDAttributes", "description": "Add an attribute to the NDAttributes file for a particular ADDriver or\n NDPlugin, and associate it with the NDAttributes file", - "title": "Type" + "enum": [ + "ADCore.NDAttributes" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -466,7 +478,11 @@ "type": { "const": "ADCore.NDCircularBuff", "description": "This plugin provides a pre and post external trigger frame capture buffer", - "title": "Type" + "enum": [ + "ADCore.NDCircularBuff" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -663,7 +679,11 @@ "type": { "const": "ADCore.NDCodec", "description": "This plugin can compress or decompress NDArrays", - "title": "Type" + "enum": [ + "ADCore.NDCodec" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -828,7 +848,11 @@ "type": { "const": "ADCore.NDColorConvert", "description": "This plugin converts arrays from one colour type to another, e.g. Bayer -> RGB1", - "title": "Type" + "enum": [ + "ADCore.NDColorConvert" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -993,7 +1017,11 @@ "type": { "const": "ADCore.NDFFT", "description": "This plugin is used to calculate the FFT of a time series", - "title": "Type" + "enum": [ + "ADCore.NDFFT" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1228,7 +1256,11 @@ "type": { "const": "ADCore.NDFileHDF5", "description": "This plugin can compress NDArrays to HDF5 and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileHDF5" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1393,7 +1425,11 @@ "type": { "const": "ADCore.NDFileJPEG", "description": "This plugin can compress NDArrays to JPEG and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileJPEG" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1542,7 +1578,11 @@ "type": { "const": "ADCore.NDFileMagick", "description": "This plugin can compress NDArrays to a range of formats supported by\n graphics magick and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileMagick" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1691,7 +1731,11 @@ "type": { "const": "ADCore.NDFileNetCDF", "description": "This plugin can compress NDArrays to NetCDF and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileNetCDF" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1840,7 +1884,11 @@ "type": { "const": "ADCore.NDFileNexus", "description": "This plugin can compress NDArrays to Nexus and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileNexus" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -1989,7 +2037,11 @@ "type": { "const": "ADCore.NDFileNull", "description": "Null file plugin for deleting driver files", - "title": "Type" + "enum": [ + "ADCore.NDFileNull" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -2138,7 +2190,11 @@ "type": { "const": "ADCore.NDFileTIFF", "description": "This plugin can compress NDArrays to TIFF and write them to file", - "title": "Type" + "enum": [ + "ADCore.NDFileTIFF" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -2287,7 +2343,11 @@ "type": { "const": "ADCore.NDGather", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Type" + "enum": [ + "ADCore.NDGather" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -2453,7 +2513,11 @@ "type": { "const": "ADCore.NDGather8", "description": "This plugin is used to gather NDArrays from multiple upstream plugins and merge them into a single stream", - "title": "Type" + "enum": [ + "ADCore.NDGather8" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -2615,7 +2679,11 @@ "type": { "const": "ADCore.NDOverlay", "description": "This plugin writes overlays on the array, like cursors and boxes", - "title": "Type" + "enum": [ + "ADCore.NDOverlay" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -2846,7 +2914,11 @@ "type": { "const": "ADCore.NDPosPlugin", "description": "This plugin attaches position information to NDArrays", - "title": "Type" + "enum": [ + "ADCore.NDPosPlugin" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3027,7 +3099,11 @@ "type": { "const": "ADCore.NDProcess", "description": "This plugin does image processing like flat field correction, background\n subtraction, and recursive filtering", - "title": "Type" + "enum": [ + "ADCore.NDProcess" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3176,7 +3252,11 @@ "type": { "const": "ADCore.NDPvaPlugin", "description": "This plugin makes NDArrays available through PVAccess", - "title": "Type" + "enum": [ + "ADCore.NDPvaPlugin" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3363,7 +3443,11 @@ "type": { "const": "ADCore.NDROI", "description": "This plugin selects a region of interest and optionally scales it to\n fit in a particular data type", - "title": "Type" + "enum": [ + "ADCore.NDROI" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3528,7 +3612,11 @@ "type": { "const": "ADCore.NDROIStat", "description": "This plugin calculates statistics of ROIs", - "title": "Type" + "enum": [ + "ADCore.NDROIStat" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3725,7 +3813,11 @@ "type": { "const": "ADCore.NDScatter", "description": "This plugin is used to distribute processing of NDArrays to multiple downstream plugins", - "title": "Type" + "enum": [ + "ADCore.NDScatter" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -3890,7 +3982,11 @@ "type": { "const": "ADCore.NDStats", "description": "This plugin calculates statistics like X and Y profile, centroid, and plots a histogram of binned pixels", - "title": "Type" + "enum": [ + "ADCore.NDStats" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -4125,7 +4221,11 @@ "type": { "const": "ADCore.NDStdArrays", "description": "This plugin provides a waveform record that can display the NDArrays\n produced by its NDARRAY_PORT", - "title": "Type" + "enum": [ + "ADCore.NDStdArrays" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -4321,7 +4421,11 @@ "type": { "const": "ADCore.NDTimeSeries", "description": "This plugin creates time series arrays from callback data", - "title": "Type" + "enum": [ + "ADCore.NDTimeSeries" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -4546,7 +4650,11 @@ "type": { "const": "ADCore.NDTransform", "description": "This plugin selects a region of interest and optionally scales it to fit in a particular data type", - "title": "Type" + "enum": [ + "ADCore.NDTransform" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -4711,7 +4819,11 @@ "type": { "const": "ADCore._NDCircularBuff", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "ADCore._NDCircularBuff" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -4916,7 +5028,11 @@ "type": { "const": "quadEM.Plugins", "description": "Instantiates\n 12 NDStats plugins for Current, Sum, Diff and Pos Channels\n 12 NDTimeSeries plugins\n 12 NDArray plugins", - "title": "Type" + "enum": [ + "quadEM.Plugins" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -5012,7 +5128,11 @@ "type": { "const": "quadEM.TetrAMM", "description": "TODO:ADD DESCRIPTION", - "title": "Type" + "enum": [ + "quadEM.TetrAMM" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/single.ibek.ioc.schema.json b/tests/samples/schemas/single.ibek.ioc.schema.json index 3ce11ba73..a833c1222 100644 --- a/tests/samples/schemas/single.ibek.ioc.schema.json +++ b/tests/samples/schemas/single.ibek.ioc.schema.json @@ -14,7 +14,11 @@ "type": { "const": "motorSim.simMotorAxis", "description": "Creates a simulation motor axis", - "title": "Type" + "enum": [ + "motorSim.simMotorAxis" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -185,7 +189,11 @@ "type": { "const": "motorSim.simMotorController", "description": "Creates a simulation motion controller", - "title": "Type" + "enum": [ + "motorSim.simMotorController" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index 777d34a9a..d65a75e15 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -14,7 +14,11 @@ "type": { "const": "motorTML.CreateController", "description": "Creates a Technosoft motion controller connected to a serial line", - "title": "Type" + "enum": [ + "motorTML.CreateController" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -97,7 +101,11 @@ "type": { "const": "motorTML.motorAxis", "description": "Creates a motor axis", - "title": "Type" + "enum": [ + "motorTML.motorAxis" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, diff --git a/tests/samples/schemas/utils.ibek.ioc.schema.json b/tests/samples/schemas/utils.ibek.ioc.schema.json index 82eb9ecdd..0099cf151 100644 --- a/tests/samples/schemas/utils.ibek.ioc.schema.json +++ b/tests/samples/schemas/utils.ibek.ioc.schema.json @@ -6,7 +6,11 @@ "type": { "const": "epics.InterruptVectorVME", "description": "Reserve an interrupt vector for use with VME hardware.\n", - "title": "Type" + "enum": [ + "epics.InterruptVectorVME" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, @@ -45,7 +49,11 @@ "type": { "const": "epics.InterruptVectorVME2", "description": "naughty second use of same counter", - "title": "Type" + "enum": [ + "epics.InterruptVectorVME2" + ], + "title": "Type", + "type": "string" }, "entity_enabled": { "default": true, From 205d0ff53b21344d4b5e09cde14c6adae6cedbd3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Jun 2024 19:25:17 +0000 Subject: [PATCH 19/24] Bump pydantic from 2.6.4 to 2.7.3 Bumps [pydantic](https://github.com/pydantic/pydantic) from 2.6.4 to 2.7.3. - [Release notes](https://github.com/pydantic/pydantic/releases) - [Changelog](https://github.com/pydantic/pydantic/blob/main/HISTORY.md) - [Commits](https://github.com/pydantic/pydantic/compare/v2.6.4...v2.7.3) --- updated-dependencies: - dependency-name: pydantic dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 437e9cec9..6b0759c1f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ classifiers = [ ] description = "IOC Builder for EPICS and Kubernetes" dependencies = [ - "pydantic==2.6.4", + "pydantic==2.7.3", "typer", "ruamel.yaml", "jinja2", From e89d29151f51db1f0e70e12e41d18ef71a7def77 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 08:29:03 +0000 Subject: [PATCH 20/24] remove ListArg, support Jinja in remaining Args --- src/ibek/args.py | 13 +--- src/ibek/entity_factory.py | 4 +- tests/samples/iocs/listarg.ibek.ioc.yaml | 8 +-- tests/samples/outputs/listarg/st.cmd | 27 ++++---- .../samples/schemas/ibek.support.schema.json | 60 ++++-------------- .../samples/schemas/listarg.ibek.schema.json | 63 ++++++++++++++++++- .../samples/support/listarg.ibek.support.yaml | 53 ++++++++++++++-- 7 files changed, 142 insertions(+), 86 deletions(-) diff --git a/src/ibek/args.py b/src/ibek/args.py index 62b403f22..f977c58df 100644 --- a/src/ibek/args.py +++ b/src/ibek/args.py @@ -58,18 +58,11 @@ class Arg(BaseSettings): ) -class ListArg(Arg): - """An argument with a float value""" - - type: Literal["list"] = "list" - default: Optional[list | JinjaString] = None - - class FloatArg(Arg): """An argument with a float value""" type: Literal["float"] = "float" - default: Optional[float] = None + default: Optional[float | JinjaString] = None class StrArg(Arg): @@ -83,14 +76,14 @@ class IntArg(Arg): """An argument with an int value""" type: Literal["int"] = "int" - default: Optional[int] = None + default: Optional[int | JinjaString] = None class BoolArg(Arg): """An argument with an bool value""" type: Literal["bool"] = "bool" - default: Optional[bool] = None + default: Optional[bool | JinjaString] = None class ObjectArg(Arg): diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index ae5cf75fb..9694f973a 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -12,6 +12,8 @@ from pydantic_core import PydanticUndefined, ValidationError from ruamel.yaml.main import YAML +from ibek.globals import JINJA + from .args import EnumArg, IdArg, ObjectArg, Value from .ioc import Entity, EnumVal, clear_entity_model_ids, get_entity_by_id from .support import EntityDefinition, Support @@ -79,7 +81,7 @@ def add_arg(name, typ, description, default): str, Field( description=f"jinja that renders to {typ}", - pattern=r".*\{\{.*\}\}.*", + pattern=JINJA, ), ] | Annotated[typ, Field(description=description)], diff --git a/tests/samples/iocs/listarg.ibek.ioc.yaml b/tests/samples/iocs/listarg.ibek.ioc.yaml index f26771be7..7da5845c7 100644 --- a/tests/samples/iocs/listarg.ibek.ioc.yaml +++ b/tests/samples/iocs/listarg.ibek.ioc.yaml @@ -1,13 +1,9 @@ # yaml-language-server: $schema=../schemas/listarg.ibek.schema.json ioc_name: counter -description: an example motion ioc for ibek testing +description: an example for list values testing entities: - type: listtest.lister - # test an actual list of strings - friends: ["Psiren", "Vindaloovian", "Polymorph"] - type: listtest.lister - # test a jinja template that renders to a list - friends: |- - {{ (["Rimmer"] + ["Parallel Holly"]) * 2 }} + age: 42 diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index 3a9fdf974..e693fcb44 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -4,23 +4,24 @@ cd "/epics/ioc" dbLoadDatabase dbd/ioc.dbd ioc_registerRecordDeviceDriver pdbbase -Lister, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: -- Psiren -- Vindaloovian -- Polymorph - -First friend is Psiren -Time vortex friends are ['Polymorph', 'Polymorph', 'Polymorph', 'Psiren', 'Psiren', 'Psiren', 'Vindaloovian', 'Vindaloovian', 'Vindaloovian'] -Fist time vortex friend is Polymorph -Lister, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: +Lister, age 3000029, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: - Rimmer -- Parallel Holly +- Cat +- Kryten +- Holly + +First friend is Rimmer +Time vortex friends are ['Cat', 'Cat', 'Cat', 'Holly', 'Holly', 'Holly', 'Kryten', 'Kryten', 'Kryten', 'Rimmer', 'Rimmer', 'Rimmer'] +Fist time vortex friend is Cat +Lister, age 42, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: - Rimmer -- Parallel Holly +- Cat +- Kryten +- Holly First friend is Rimmer -Time vortex friends are ['Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Parallel Holly', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer', 'Rimmer'] -Fist time vortex friend is Parallel Holly +Time vortex friends are ['Cat', 'Cat', 'Cat', 'Holly', 'Holly', 'Holly', 'Kryten', 'Kryten', 'Kryten', 'Rimmer', 'Rimmer', 'Rimmer'] +Fist time vortex friend is Cat dbLoadRecords /epics/runtime/ioc.db iocInit diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index 98b3c3e08..ce3adad04 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -28,6 +28,11 @@ { "type": "boolean" }, + { + "description": "A Jinja2 template string", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { "type": "null" } @@ -139,16 +144,12 @@ "float": "#/$defs/FloatArg", "id": "#/$defs/IdArg", "int": "#/$defs/IntArg", - "list": "#/$defs/ListArg", "object": "#/$defs/ObjectArg", "str": "#/$defs/StrArg" }, "propertyName": "type" }, "oneOf": [ - { - "$ref": "#/$defs/ListArg" - }, { "$ref": "#/$defs/FloatArg" }, @@ -426,6 +427,11 @@ { "type": "number" }, + { + "description": "A Jinja2 template string", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, { "type": "null" } @@ -512,50 +518,6 @@ { "type": "integer" }, - { - "type": "null" - } - ], - "default": null, - "title": "Default" - } - }, - "required": [ - "name", - "description" - ], - "title": "IntArg", - "type": "object" - }, - "ListArg": { - "additionalProperties": false, - "description": "An argument with a float value", - "properties": { - "type": { - "const": "list", - "default": "list", - "enum": [ - "list" - ], - "title": "Type", - "type": "string" - }, - "name": { - "description": "Name of the argument that the IOC instance should pass", - "title": "Name", - "type": "string" - }, - "description": { - "description": "Description of what the argument will be used for", - "title": "Description", - "type": "string" - }, - "default": { - "anyOf": [ - { - "items": {}, - "type": "array" - }, { "description": "A Jinja2 template string", "pattern": ".*\\{\\{.*\\}\\}.*", @@ -573,7 +535,7 @@ "name", "description" ], - "title": "ListArg", + "title": "IntArg", "type": "object" }, "ObjectArg": { diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index 57f031917..030feba70 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -18,12 +18,66 @@ "title": "Entity Enabled", "type": "boolean" }, + "name": { + "default": "Dave Lister", + "description": "name of the character", + "title": "Name", + "type": "string" + }, "quote": { "default": "Smoke me a kipper, I'll be back for breakfast", "description": "most hated quote", "title": "Quote", "type": "string" }, + "is_human": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "is the character human", + "type": "boolean" + } + ], + "default": "{{ (name == 'Dave Lister') | lower }}", + "description": "union of and jinja representation of {typ}", + "title": "Is Human" + }, + "age": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "Age of the character including cryogenic sleep", + "type": "integer" + } + ], + "default": "{{ 29 + cryo_years }}", + "description": "union of and jinja representation of {typ}", + "title": "Age" + }, + "cryo_years": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "years in cryogenic sleep", + "type": "integer" + } + ], + "default": 3000000, + "description": "union of and jinja representation of {typ}", + "title": "Cryo Years" + }, "friends": { "anyOf": [ { @@ -32,12 +86,17 @@ "type": "string" }, { - "description": "List of friends", + "description": "friends of Lister", "items": {}, "type": "array" } ], - "default": "{{ [\"Rimmer\"] + [ \"Cat\", \"Kryten\", \"Holly\"] }}", + "default": [ + "Rimmer", + "Cat", + "Kryten", + "Holly" + ], "description": "union of and jinja representation of {typ}", "title": "Friends" }, diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index b66826ace..8e66b895e 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -1,10 +1,21 @@ # yaml-language-server: $schema=../schemas/ibek.support.schema.json + +# A support module yaml that tests lists in values and also tests +# 'jinja str/type' capability in Arg default values module: listtest defs: - name: lister description: |- The protagonist from Red Dwarf + + pre_values: + - name: name + description: |- + name of the character + value: |- + Dave Lister + args: - type: str name: quote @@ -13,13 +24,45 @@ defs: default: |- Smoke me a kipper, I'll be back for breakfast - - type: list - name: friends + - type: bool + name: is_human + description: |- + is the character human + # example bool using Jinja note '| lower' because Python result is 'True' + # but we want 'true' for YAML (not sure I like that!!) + # TODO note that this only fails when rendering an instance - how to + # test this earlier? + default: |- + {{ (name == 'Dave Lister') | lower }} + + - type: int + name: age description: |- - List of friends - default: '{{ ["Rimmer"] + [ "Cat", "Kryten", "Holly"] }}' + Age of the character including cryogenic sleep + # example int using Jinja + default: |- + {{ 29 + cryo_years }} values: + - name: cryo_years + description: |- + years in cryogenic sleep + type: int + value: 3000000 + # https://en.wikipedia.org/wiki/Dave_Lister#:~:text=As%20a%20result%2C%20Holly%20keeps,radiation%20levels%20return%20to%20normal. + + # example type list value not using Jinja + - name: friends + description: |- + friends of Lister + type: list + value: + - Rimmer + - Cat + - Kryten + - Holly + + # example type list value using Jinja - name: time_vortex description: |- friends after the Time Hole episode @@ -29,7 +72,7 @@ defs: pre_init: - value: | - Lister, who does not like to hear "{{quote}}" has friends: + Lister, age {{age}}, who does not like to hear "{{quote}}" has friends: {#- example Jinja loop which is discouraged, but demos we have a list -#} {%- for friend in friends %} - {{friend}} From 86da7110950d84d4a40933bfd8fa6c8ddbff6540 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 08:41:57 +0000 Subject: [PATCH 21/24] fix bool json/python issue --- src/ibek/ioc.py | 9 +++++++-- tests/samples/outputs/listarg/st.cmd | 20 +++++++++++-------- .../samples/schemas/listarg.ibek.schema.json | 2 +- .../samples/support/listarg.ibek.support.yaml | 11 +++++----- 4 files changed, 25 insertions(+), 17 deletions(-) diff --git a/src/ibek/ioc.py b/src/ibek/ioc.py index 81186c90d..e9d179c76 100644 --- a/src/ibek/ioc.py +++ b/src/ibek/ioc.py @@ -77,8 +77,13 @@ def add_ibek_attributes(self): # Args that were non strings and have been rendered by Jinja # must be coerced back into their original type try: - # shame I need the replace - why are jinja an json disagreeing? - value = json.loads(value.replace("'", '"')) + # The following replace are to make the string json compatible + # (maybe we should python decode instead of json.loads?) + value = value.replace("'", '"') + value = value.replace("True", "true") + value = value.replace("False", "false") + value = json.loads(value) + # likewise for bools except: print( f"ERROR: fail to decode {value} as a {model_field.annotation}" diff --git a/tests/samples/outputs/listarg/st.cmd b/tests/samples/outputs/listarg/st.cmd index e693fcb44..47609c763 100644 --- a/tests/samples/outputs/listarg/st.cmd +++ b/tests/samples/outputs/listarg/st.cmd @@ -4,20 +4,24 @@ cd "/epics/ioc" dbLoadDatabase dbd/ioc.dbd ioc_registerRecordDeviceDriver pdbbase + + Lister, age 3000029, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: -- Rimmer -- Cat -- Kryten -- Holly +o Rimmer +o Cat +o Kryten +o Holly First friend is Rimmer Time vortex friends are ['Cat', 'Cat', 'Cat', 'Holly', 'Holly', 'Holly', 'Kryten', 'Kryten', 'Kryten', 'Rimmer', 'Rimmer', 'Rimmer'] Fist time vortex friend is Cat + + Lister, age 42, who does not like to hear "Smoke me a kipper, I'll be back for breakfast" has friends: -- Rimmer -- Cat -- Kryten -- Holly +o Rimmer +o Cat +o Kryten +o Holly First friend is Rimmer Time vortex friends are ['Cat', 'Cat', 'Cat', 'Holly', 'Holly', 'Holly', 'Kryten', 'Kryten', 'Kryten', 'Rimmer', 'Rimmer', 'Rimmer'] diff --git a/tests/samples/schemas/listarg.ibek.schema.json b/tests/samples/schemas/listarg.ibek.schema.json index 030feba70..f712f9d72 100644 --- a/tests/samples/schemas/listarg.ibek.schema.json +++ b/tests/samples/schemas/listarg.ibek.schema.json @@ -42,7 +42,7 @@ "type": "boolean" } ], - "default": "{{ (name == 'Dave Lister') | lower }}", + "default": "{{ name == 'Dave Lister' }}", "description": "union of and jinja representation of {typ}", "title": "Is Human" }, diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index 8e66b895e..82345f079 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -28,12 +28,9 @@ defs: name: is_human description: |- is the character human - # example bool using Jinja note '| lower' because Python result is 'True' - # but we want 'true' for YAML (not sure I like that!!) - # TODO note that this only fails when rendering an instance - how to - # test this earlier? + # example bool using Jinja default: |- - {{ (name == 'Dave Lister') | lower }} + {{ name == 'Dave Lister' }} - type: int name: age @@ -72,10 +69,12 @@ defs: pre_init: - value: | + + Lister, age {{age}}, who does not like to hear "{{quote}}" has friends: {#- example Jinja loop which is discouraged, but demos we have a list -#} {%- for friend in friends %} - - {{friend}} + o {{friend}} {%- endfor%} First friend is {{friends[0]}} From adefcefad5275bad70e50ec51d9681e302a0288e Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 10:37:53 +0000 Subject: [PATCH 22/24] change jinja global context name to _global --- src/ibek/gen_scripts.py | 6 ++---- src/ibek/templates/st.cmd.jinja | 4 ++-- src/ibek/utils.py | 10 ++++------ tests/samples/iocs/quadem.ibek.ioc.yaml | 2 +- .../schemas/fastVacuum.ibek.ioc.schema.json | 4 ++-- tests/samples/schemas/ipac.ibek.ioc.schema.json | 4 ++-- .../schemas/technosoft.ibek.ioc.schema.json | 6 +++--- tests/samples/schemas/utils.ibek.ioc.schema.json | 4 ++-- tests/samples/support/epics.ibek.support.yaml | 2 +- tests/samples/support/fastVacuum.ibek.support.yaml | 4 ++-- tests/samples/support/ipac.ibek.support.yaml | 2 +- tests/samples/support/technosoft.ibek.support.yaml | 8 ++++---- tests/samples/support/utils.ibek.support.yaml | 14 +++++++------- 13 files changed, 33 insertions(+), 37 deletions(-) diff --git a/src/ibek/gen_scripts.py b/src/ibek/gen_scripts.py index 583a5385a..c69115c79 100644 --- a/src/ibek/gen_scripts.py +++ b/src/ibek/gen_scripts.py @@ -50,10 +50,8 @@ def create_boot_script(entities: Sequence[Entity]) -> str: renderer = Render() return template.render( - # old name for global context for backward compatibility - __utils__=UTILS, - # new short name for global context - _ctx_=UTILS, + # global context for all jinja renders + _global=UTILS, # put variables created with set/get directly in the context **UTILS.variables, env_var_elements=renderer.render_environment_variable_elements(entities), diff --git a/src/ibek/templates/st.cmd.jinja b/src/ibek/templates/st.cmd.jinja index ac4f480d2..865fef240 100644 --- a/src/ibek/templates/st.cmd.jinja +++ b/src/ibek/templates/st.cmd.jinja @@ -1,6 +1,6 @@ # EPICS IOC Startup Script generated by https://github.com/epics-containers/ibek -cd "{{ __utils__.get_env('IOC') }}" +cd "{{ _global.get_env('IOC') }}" {% if env_var_elements %} {{ env_var_elements}} {% endif -%} @@ -9,7 +9,7 @@ dbLoadDatabase dbd/ioc.dbd ioc_registerRecordDeviceDriver pdbbase {{ script_elements }} -dbLoadRecords {{ __utils__.get_env('RUNTIME_DIR') }}/ioc.db +dbLoadRecords {{ _global.get_env('RUNTIME_DIR') }}/ioc.db iocInit {% if post_ioc_init_elements %} diff --git a/src/ibek/utils.py b/src/ibek/utils.py index 79041d577..a4808c868 100644 --- a/src/ibek/utils.py +++ b/src/ibek/utils.py @@ -2,7 +2,7 @@ A class containing utility functions for passing into the Jinja context. This allows us to provide simple functions that can be called inside -Jinja templates with {{ __utils__.function_name() }}. It also allows +Jinja templates with {{ _global.function_name() }}. It also allows us to maintain state between calls to the Jinja templates because we pass a single instance of this class into all Jinja contexts. """ @@ -114,7 +114,7 @@ def counter( def render(self, context: Any, template_text: Any) -> str: """ - Render a Jinja template with the global __utils__ object in the context + Render a Jinja template with the global _global object in the context """ if not isinstance(template_text, str): # because this function is used to template arguments, it may @@ -125,10 +125,8 @@ def render(self, context: Any, template_text: Any) -> str: jinja_template = Template(template_text, undefined=StrictUndefined) return jinja_template.render( context, - # old name for global context for backward compatibility - __utils__=self, - # new short name for global context - _ctx_=self, + # global context for all jinja renders + _global=self, # put variables created with set/get directly in the context **self.variables, ioc_yaml_file_name=self.file_name, diff --git a/tests/samples/iocs/quadem.ibek.ioc.yaml b/tests/samples/iocs/quadem.ibek.ioc.yaml index d40034fe8..8b5fd01e8 100644 --- a/tests/samples/iocs/quadem.ibek.ioc.yaml +++ b/tests/samples/iocs/quadem.ibek.ioc.yaml @@ -1,6 +1,6 @@ # yaml-language-server: $schema=../schemas/quadem.ibek.ioc.schema.json -ioc_name: "{{ __utils__.get_env('IOC_NAME') }}" +ioc_name: "{{ _global.get_env('IOC_NAME') }}" description: Example TetrAMM for BL03I entities: diff --git a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json index 2733406c3..ee23d29a4 100644 --- a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json +++ b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json @@ -61,7 +61,7 @@ "type": "integer" } ], - "default": "{{ _ctx_.counter(\"fvGaugeNum\", start=1) }}", + "default": "{{ _global.counter(\"fvGaugeNum\", start=1) }}", "description": "union of and jinja representation of {typ}", "title": "Gaugenum" }, @@ -72,7 +72,7 @@ "type": "string" }, "mask": { - "default": "{{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**gaugeNum) }}", + "default": "{{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }}", "description": "mask for the channel", "title": "Mask", "type": "string" diff --git a/tests/samples/schemas/ipac.ibek.ioc.schema.json b/tests/samples/schemas/ipac.ibek.ioc.schema.json index 548dd98f3..b9f2c7333 100644 --- a/tests/samples/schemas/ipac.ibek.ioc.schema.json +++ b/tests/samples/schemas/ipac.ibek.ioc.schema.json @@ -178,7 +178,7 @@ "title": "Count" }, "number": { - "default": "{{ __utils__.counter(\"InterruptVector\", start=192, stop=255, inc=count) }}", + "default": "{{ _global.counter(\"InterruptVector\", start=192, stop=255, inc=count) }}", "description": "Interrupt Vector number", "title": "Number", "type": "string" @@ -537,7 +537,7 @@ "title": "Interrupt Vector" }, "card_id": { - "default": "{{ __utils__.counter(\"Carriers\", start=0) }}", + "default": "{{ _global.counter(\"Carriers\", start=0) }}", "description": "Carrier Card Identifier", "title": "Card Id", "type": "string" diff --git a/tests/samples/schemas/technosoft.ibek.ioc.schema.json b/tests/samples/schemas/technosoft.ibek.ioc.schema.json index d65a75e15..0b694cea9 100644 --- a/tests/samples/schemas/technosoft.ibek.ioc.schema.json +++ b/tests/samples/schemas/technosoft.ibek.ioc.schema.json @@ -79,7 +79,7 @@ "type": "string" }, "axisConfiguration": { - "default": "{{ __utils__.set_var('motorTML.axisConfiguration',[]) }}", + "default": "{{ _global.set_var('motorTML.axisConfiguration',[]) }}", "description": "collects the axis configuration from axis entities", "title": "Axisconfiguration", "type": "string" @@ -114,7 +114,7 @@ "type": "boolean" }, "num": { - "default": "{{ __utils__.counter(\"motorTML.axisCount\", start=0) }}", + "default": "{{ _global.counter(\"motorTML.axisCount\", start=0) }}", "description": "The auto incrementing axis number", "title": "Num", "type": "string" @@ -424,7 +424,7 @@ "type": "string" }, "axisConfiguration": { - "default": "{{ __utils__.get_var('motorTML.axisConfiguration').append(CONFIG) }}", + "default": "{{ _global.get_var('motorTML.axisConfiguration').append(CONFIG) }}", "description": "Adds an axis configuration entry to the controller's list", "title": "Axisconfiguration", "type": "string" diff --git a/tests/samples/schemas/utils.ibek.ioc.schema.json b/tests/samples/schemas/utils.ibek.ioc.schema.json index 0099cf151..72d3dfc27 100644 --- a/tests/samples/schemas/utils.ibek.ioc.schema.json +++ b/tests/samples/schemas/utils.ibek.ioc.schema.json @@ -24,13 +24,13 @@ "type": "string" }, "test_global_var": { - "default": "{{ __utils__.set_var(\"magic_global\", 42) }}", + "default": "{{ _global.set_var(\"magic_global\", 42) }}", "description": "test global variable setter", "title": "Test Global Var", "type": "string" }, "get_global": { - "default": "{{ __utils__.get_var(\"magic_global\") }}", + "default": "{{ _global.get_var(\"magic_global\") }}", "description": "test global variable getter", "title": "Get Global", "type": "string" diff --git a/tests/samples/support/epics.ibek.support.yaml b/tests/samples/support/epics.ibek.support.yaml index 785e61027..447ee1c6b 100644 --- a/tests/samples/support/epics.ibek.support.yaml +++ b/tests/samples/support/epics.ibek.support.yaml @@ -85,7 +85,7 @@ defs: values: - name: number - value: '{{ __utils__.counter("InterruptVector", start=192, stop=255, inc=count) }}' + value: '{{ _global.counter("InterruptVector", start=192, stop=255, inc=count) }}' description: Interrupt Vector number env_vars: diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index 92bf64e67..e60747087 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -117,7 +117,7 @@ defs: name: gaugeNum type: int value: |- - {{ _ctx_.counter("fvGaugeNum", start=1) }} + {{ _global.counter("fvGaugeNum", start=1) }} - description: fan number name: fan @@ -127,7 +127,7 @@ defs: - description: mask for the channel name: mask value: |- - {{ _ctx_.set('fvMask', _ctx_.get('fvMask', 0) + 2**gaugeNum) }} + {{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }} values: - description: link number diff --git a/tests/samples/support/ipac.ibek.support.yaml b/tests/samples/support/ipac.ibek.support.yaml index 578ea3e2f..478ab0d11 100644 --- a/tests/samples/support/ipac.ibek.support.yaml +++ b/tests/samples/support/ipac.ibek.support.yaml @@ -36,7 +36,7 @@ defs: values: - name: card_id - value: '{{ __utils__.counter("Carriers", start=0) }}' + value: '{{ _global.counter("Carriers", start=0) }}' description: Carrier Card Identifier pre_init: diff --git a/tests/samples/support/technosoft.ibek.support.yaml b/tests/samples/support/technosoft.ibek.support.yaml index 731885ca8..0ed50d3e7 100644 --- a/tests/samples/support/technosoft.ibek.support.yaml +++ b/tests/samples/support/technosoft.ibek.support.yaml @@ -43,10 +43,10 @@ defs: - name: axisConfiguration description: collects the axis configuration from axis entities value: |- - {{ __utils__.set_var('motorTML.axisConfiguration',[]) }} + {{ _global.set_var('motorTML.axisConfiguration',[]) }} pre_init: - value: | - ndsCreateDevice "TechnosoftTML", "{{controllerName}}", "{{CONFIG}}{{"".join(__utils__.get_var('motorTML.axisConfiguration')) }}" + ndsCreateDevice "TechnosoftTML", "{{controllerName}}", "{{CONFIG}}{{"".join(_global.get_var('motorTML.axisConfiguration')) }}" - name: motorAxis description: |- @@ -203,13 +203,13 @@ defs: - name: num description: The auto incrementing axis number value: |- - {{ __utils__.counter("motorTML.axisCount", start=0) }} + {{ _global.counter("motorTML.axisCount", start=0) }} values: - name: axisConfiguration description: Adds an axis configuration entry to the controller's list value: |- - {{ __utils__.get_var('motorTML.axisConfiguration').append(CONFIG) }} + {{ _global.get_var('motorTML.axisConfiguration').append(CONFIG) }} pre_init: - value: | diff --git a/tests/samples/support/utils.ibek.support.yaml b/tests/samples/support/utils.ibek.support.yaml index 187195157..02582f14d 100644 --- a/tests/samples/support/utils.ibek.support.yaml +++ b/tests/samples/support/utils.ibek.support.yaml @@ -1,7 +1,7 @@ # yaml-language-server: $schema=../schemas/ibek.support.schema.json ################################################################################ -### ibek support YAML to demonstrate use of __utils__ global context +### ibek support YAML to demonstrate use of _global global context ################################################################################ module: epics @@ -17,22 +17,22 @@ defs: values: - name: test_global_var description: test global variable setter - value: '{{ __utils__.set_var("magic_global", 42) }}' + value: '{{ _global.set_var("magic_global", 42) }}' - name: get_global description: test global variable getter - value: '{{ __utils__.get_var("magic_global") }}' + value: '{{ _global.get_var("magic_global") }}' env_vars: - name: "{{ name }}" - value: '{{ __utils__.counter("InterruptVector", start=192, stop=255) }}' + value: '{{ _global.counter("InterruptVector", start=192, stop=255) }}' pre_init: - type: comment value: global "magic" is {{ get_global }} - type: comment - value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} + value: counter "InterruptVector" is now {{ _global.counter("InterruptVector", start=192, stop=255) }} - type: comment - value: counter "InterruptVector" is now {{ __utils__.counter("InterruptVector", start=192, stop=255) }} + value: counter "InterruptVector" is now {{ _global.counter("InterruptVector", start=192, stop=255) }} - name: InterruptVectorVME2 description: naughty second use of same counter @@ -43,4 +43,4 @@ defs: env_vars: - name: "second_{{ name }}" - value: '{{ __utils__.counter("InterruptVector", start=193, stop=194) }}' + value: '{{ _global.counter("InterruptVector", start=193, stop=194) }}' From 873c52c9828057c72e8a66902d2c4630298cb8ef Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 10:55:48 +0000 Subject: [PATCH 23/24] change values to defines --- src/ibek/definition.py | 4 ++-- src/ibek/entity_factory.py | 4 ++-- tests/samples/outputs/dlsPLC.ibek.support.yaml | 2 +- tests/samples/schemas/ibek.support.schema.json | 8 ++++---- tests/samples/support/dlsPLC.ibek.support.yaml | 2 +- tests/samples/support/epics.ibek.support.yaml | 2 +- tests/samples/support/fastVacuum.ibek.support.yaml | 6 +++--- tests/samples/support/ipac.ibek.support.yaml | 2 +- tests/samples/support/listarg.ibek.support.yaml | 4 ++-- tests/samples/support/technosoft.ibek.support.yaml | 6 +++--- tests/samples/support/utils.ibek.support.yaml | 2 +- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/ibek/definition.py b/src/ibek/definition.py index 8021eac27..6206f7d6d 100644 --- a/src/ibek/definition.py +++ b/src/ibek/definition.py @@ -138,12 +138,12 @@ class EntityDefinition(BaseSettings): description="The arguments IOC instance should supply", default=(), ) - values: Sequence[Value] = Field( + post_defines: Sequence[Value] = Field( description="Calculated values to use as additional arguments " "With Jinja evaluation after all Args", default=(), ) - pre_values: Sequence[Value] = Field( + pre_defines: Sequence[Value] = Field( description="Calculated values to use as additional arguments " "With Jinja evaluation before all Args", default=(), diff --git a/src/ibek/entity_factory.py b/src/ibek/entity_factory.py index 9694f973a..82bb52d2a 100644 --- a/src/ibek/entity_factory.py +++ b/src/ibek/entity_factory.py @@ -102,7 +102,7 @@ def add_arg(name, typ, description, default): # add in the calculated values Jinja Templates as Fields in the Entity # these are the pre_values that should be Jinja rendered before any # Args (or post values) - add_defines(definition.pre_values) + add_defines(definition.pre_defines) # add in each of the arguments as a Field in the Entity for arg in definition.args: @@ -141,7 +141,7 @@ def lookup_instance(cls, id): add_arg(arg.name, type, arg.description, getattr(arg, "default")) # type: ignore # add in the calculated values Jinja Templates as Fields in the Entity - add_defines(definition.values) + add_defines(definition.post_defines) # add the type literal which discriminates between the different Entity classes typ = Literal[full_name] # type: ignore diff --git a/tests/samples/outputs/dlsPLC.ibek.support.yaml b/tests/samples/outputs/dlsPLC.ibek.support.yaml index 08c418588..632f5e7d4 100644 --- a/tests/samples/outputs/dlsPLC.ibek.support.yaml +++ b/tests/samples/outputs/dlsPLC.ibek.support.yaml @@ -2040,7 +2040,7 @@ defs: - type: str name: device description: Device prefix - values: + post_defines: - description: device name name: device value: :- {{dom}}-VA-FAST-01 diff --git a/tests/samples/schemas/ibek.support.schema.json b/tests/samples/schemas/ibek.support.schema.json index ce3adad04..b1940bdd7 100644 --- a/tests/samples/schemas/ibek.support.schema.json +++ b/tests/samples/schemas/ibek.support.schema.json @@ -176,22 +176,22 @@ "title": "Args", "type": "array" }, - "values": { + "post_defines": { "default": [], "description": "Calculated values to use as additional arguments With Jinja evaluation after all Args", "items": { "$ref": "#/$defs/Value" }, - "title": "Values", + "title": "Post Defines", "type": "array" }, - "pre_values": { + "pre_defines": { "default": [], "description": "Calculated values to use as additional arguments With Jinja evaluation before all Args", "items": { "$ref": "#/$defs/Value" }, - "title": "Pre Values", + "title": "Pre Defines", "type": "array" }, "databases": { diff --git a/tests/samples/support/dlsPLC.ibek.support.yaml b/tests/samples/support/dlsPLC.ibek.support.yaml index 297612822..9ea259f99 100644 --- a/tests/samples/support/dlsPLC.ibek.support.yaml +++ b/tests/samples/support/dlsPLC.ibek.support.yaml @@ -2613,7 +2613,7 @@ defs: description: |- Device prefix - values: + post_defines: - description: device name name: device value: :- diff --git a/tests/samples/support/epics.ibek.support.yaml b/tests/samples/support/epics.ibek.support.yaml index 447ee1c6b..fd4437bff 100644 --- a/tests/samples/support/epics.ibek.support.yaml +++ b/tests/samples/support/epics.ibek.support.yaml @@ -83,7 +83,7 @@ defs: description: The number of interrupt vectors to reserve default: 1 - values: + post_defines: - name: number value: '{{ _global.counter("InterruptVector", start=192, stop=255, inc=count) }}' description: Interrupt Vector number diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index e60747087..5822a5047 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -41,7 +41,7 @@ defs: description: |- Device prefix - values: + post_defines: - description: device name name: device value: |- @@ -112,7 +112,7 @@ defs: asyn fins_port timeout default: 0 - pre_values: + pre_defines: - description: auto gauge count name: gaugeNum type: int @@ -129,7 +129,7 @@ defs: value: |- {{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }} - values: + post_defines: - description: link number name: lnk_no value: |- diff --git a/tests/samples/support/ipac.ibek.support.yaml b/tests/samples/support/ipac.ibek.support.yaml index 478ab0d11..6bf5d9b12 100644 --- a/tests/samples/support/ipac.ibek.support.yaml +++ b/tests/samples/support/ipac.ibek.support.yaml @@ -34,7 +34,7 @@ defs: type: object description: Interrupt Vector reserved with epics.InterruptVectorVME, count=1 - values: + post_defines: - name: card_id value: '{{ _global.counter("Carriers", start=0) }}' description: Carrier Card Identifier diff --git a/tests/samples/support/listarg.ibek.support.yaml b/tests/samples/support/listarg.ibek.support.yaml index 82345f079..b53fe6123 100644 --- a/tests/samples/support/listarg.ibek.support.yaml +++ b/tests/samples/support/listarg.ibek.support.yaml @@ -9,7 +9,7 @@ defs: description: |- The protagonist from Red Dwarf - pre_values: + pre_defines: - name: name description: |- name of the character @@ -40,7 +40,7 @@ defs: default: |- {{ 29 + cryo_years }} - values: + post_defines: - name: cryo_years description: |- years in cryogenic sleep diff --git a/tests/samples/support/technosoft.ibek.support.yaml b/tests/samples/support/technosoft.ibek.support.yaml index 0ed50d3e7..353f1fdb7 100644 --- a/tests/samples/support/technosoft.ibek.support.yaml +++ b/tests/samples/support/technosoft.ibek.support.yaml @@ -39,7 +39,7 @@ defs: TML Configuration default: |- FILE=/tmp/,NAXIS={{numAxes}},DEV_PATH={{TTY}},HOST_ID={{hostid}} - values: + post_defines: - name: axisConfiguration description: collects the axis configuration from axis entities value: |- @@ -199,13 +199,13 @@ defs: default: |- ,AXIS_SETUP_{{num}}=$(SUPPORT)/motorTechnosoft/tml_lib/config/{{axconf}},AXIS_ID_{{num}}={{axid}},AXIS_HOMING_SW_{{num}}={{homing}} - pre_values: + pre_defines: - name: num description: The auto incrementing axis number value: |- {{ _global.counter("motorTML.axisCount", start=0) }} - values: + post_defines: - name: axisConfiguration description: Adds an axis configuration entry to the controller's list value: |- diff --git a/tests/samples/support/utils.ibek.support.yaml b/tests/samples/support/utils.ibek.support.yaml index 02582f14d..1d00a3945 100644 --- a/tests/samples/support/utils.ibek.support.yaml +++ b/tests/samples/support/utils.ibek.support.yaml @@ -14,7 +14,7 @@ defs: name: name description: A name for an interrupt vector variable - values: + post_defines: - name: test_global_var description: test global variable setter value: '{{ _global.set_var("magic_global", 42) }}' From edc4b19398654a161504cc971f25fbf76a77f6d6 Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Tue, 11 Jun 2024 12:18:29 +0000 Subject: [PATCH 24/24] remove list use from fastVacuum --- .../schemas/fastVacuum.ibek.ioc.schema.json | 90 ++++++------------- .../support/fastVacuum.ibek.support.yaml | 34 ++----- 2 files changed, 36 insertions(+), 88 deletions(-) diff --git a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json index ee23d29a4..2816af126 100644 --- a/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json +++ b/tests/samples/schemas/fastVacuum.ibek.ioc.schema.json @@ -49,34 +49,6 @@ "title": "Entity Enabled", "type": "boolean" }, - "gaugeNum": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "description": "auto gauge count", - "type": "integer" - } - ], - "default": "{{ _global.counter(\"fvGaugeNum\", start=1) }}", - "description": "union of and jinja representation of {typ}", - "title": "Gaugenum" - }, - "fan": { - "default": "{{ \"%02d\" % (gaugeNum / 7 + 1) }}", - "description": "fan number", - "title": "Fan", - "type": "string" - }, - "mask": { - "default": "{{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }}", - "description": "mask for the channel", - "title": "Mask", - "type": "string" - }, "name": { "description": "Gui tag", "title": "Name", @@ -124,6 +96,34 @@ "description": "union of and jinja representation of {typ}", "title": "Timeout" }, + "gaugeNum": { + "anyOf": [ + { + "description": "jinja that renders to ", + "pattern": ".*\\{\\{.*\\}\\}.*", + "type": "string" + }, + { + "description": "auto gauge count", + "type": "integer" + } + ], + "default": "{{ _global.counter(\"fvGaugeNum\", start=1) }}", + "description": "union of and jinja representation of {typ}", + "title": "Gaugenum" + }, + "fan": { + "default": "{{ \"%02d\" % (gaugeNum / 7 + 1) }}", + "description": "fan number", + "title": "Fan", + "type": "string" + }, + "mask": { + "default": "{{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }}", + "description": "mask for the channel", + "title": "Mask", + "type": "string" + }, "lnk_no": { "default": "{{ ((gaugeNum - 1) % 6) + 1 }}", "description": "link number", @@ -151,40 +151,6 @@ "default": "{{ (gaugeNum - 1) * master.combined_nelm }}", "description": "union of and jinja representation of {typ}", "title": "Addr Offset" - }, - "wave_addr": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "description": "waveform addresses", - "items": {}, - "type": "array" - } - ], - "default": "{%- set addr_list = range(addr_offset,addr_offset + master.waveform_nelm * 6, master.waveform_nelm) -%}\n{{ addr_list | list }}", - "description": "union of and jinja representation of {typ}", - "title": "Wave Addr" - }, - "wave_addr_alternative": { - "anyOf": [ - { - "description": "jinja that renders to ", - "pattern": ".*\\{\\{.*\\}\\}.*", - "type": "string" - }, - { - "description": "waveform addresses", - "items": {}, - "type": "array" - } - ], - "default": "{%- set addr = [] -%}\n{%- for i in range(6) -%}\n{%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%}\n{%- endfor -%}\n{{ addr }}", - "description": "union of and jinja representation of {typ}", - "title": "Wave Addr Alternative" } }, "required": [ diff --git a/tests/samples/support/fastVacuum.ibek.support.yaml b/tests/samples/support/fastVacuum.ibek.support.yaml index 5822a5047..6b328e745 100644 --- a/tests/samples/support/fastVacuum.ibek.support.yaml +++ b/tests/samples/support/fastVacuum.ibek.support.yaml @@ -61,6 +61,7 @@ defs: databases: - file: $(DLSPLC)/db/dlsPLC_fastVacuumMaster.template args: { device, eip_port } + - name: fastVacuumChannel description: |- Adds a fast vacuum channel to the fast vacuum master @@ -112,7 +113,7 @@ defs: asyn fins_port timeout default: 0 - pre_defines: + post_defines: - description: auto gauge count name: gaugeNum type: int @@ -129,7 +130,6 @@ defs: value: |- {{ _global.set('fvMask', _global.get('fvMask', 0) + 2**gaugeNum) }} - post_defines: - description: link number name: lnk_no value: |- @@ -146,24 +146,6 @@ defs: value: |- {{ (gaugeNum - 1) * master.combined_nelm }} - - description: waveform addresses - name: wave_addr - type: list - value: |- - {%- set addr_list = range(addr_offset,addr_offset + master.waveform_nelm * 6, master.waveform_nelm) -%} - {{ addr_list | list }} - - - description: waveform addresses - name: wave_addr_alternative - type: list - # explicit loop is uglier but more versatile - value: |- - {%- set addr = [] -%} - {%- for i in range(6) -%} - {%- set addr = addr.append(addr_offset + master.waveform_nelm * i) -%} - {%- endfor -%} - {{ addr }} - databases: - file: $(DLSPLC)/db/dlsPLC_fastVacuumLink.template args: { device: "{{master.device}}", lnk_no, lnk: "{{gaugePV}}", fan, mask } @@ -178,11 +160,11 @@ defs: id: "{{id}}" em: waveform_nelm: "{{master.waveform_nelm}}" - wave0_addr: "{{wave_addr[0]}}" - wave1_addr: "{{wave_addr[1]}}" - wave2_addr: "{{wave_addr[2]}}" - wave3_addr: "{{wave_addr[3]}}" - wave4_addr: "{{wave_addr[4]}}" - wave5_addr: "{{wave_addr[5]}}" + wave0_addr: "{{ addr_offset }}" + wave1_addr: "{{ addr_offset + master.waveform_nelm }}" + wave2_addr: "{{ addr_offset + master.waveform_nelm * 2 }}" + wave3_addr: "{{ addr_offset + master.waveform_nelm * 3 }}" + wave4_addr: "{{ addr_offset + master.waveform_nelm * 4 }}" + wave5_addr: "{{ addr_offset + master.waveform_nelm * 5 }}" combined_nelm: "{{master.combined_nelm}}" timeout: