From 8e957b1028cc7d278f64a56bcb5e86697f24834c Mon Sep 17 00:00:00 2001 From: Tom Kane Date: Mon, 12 Jan 2026 13:00:34 +0000 Subject: [PATCH 1/3] Updated README setup section with techui.yaml -url and techui-support.yaml --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 877473e..dcb7add 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ The process to use this module goes as follows (WIP): short_dom: {e.g. b23, b01-1} long_dom: {e.g. bl23b} desc: {beamline description} + url: {e.g. b23-opis.diamond.ac.uk} components: {component name}: @@ -48,6 +49,7 @@ The process to use this module goes as follows (WIP): ``` > [!NOTE] > `extras` is optional, but allows any embedded screen to be added to make a summary screen e.g. combining all imgs, pirgs and ionps associated with a vacuum space. +4. Create a `techui_support.yaml` file inside `ixx-services/synoptic/techui_support`. To get started this file can be left empty. 1. Run this command to locally generate a schema, which can be used for validation testing ```$ techui-builder --schema``` From 1170b24a67219249d8c861a8b2f02e7dade3fd97 Mon Sep 17 00:00:00 2001 From: Tom Kane Date: Mon, 12 Jan 2026 13:43:26 +0000 Subject: [PATCH 2/3] changed underscore to hyphen for techui-support --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dcb7add..4e824f7 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ The process to use this module goes as follows (WIP): ``` > [!NOTE] > `extras` is optional, but allows any embedded screen to be added to make a summary screen e.g. combining all imgs, pirgs and ionps associated with a vacuum space. -4. Create a `techui_support.yaml` file inside `ixx-services/synoptic/techui_support`. To get started this file can be left empty. +4. Create a `techui-support.yaml` file inside `ixx-services/synoptic/techui-support`. To get started this file can be left empty. 1. Run this command to locally generate a schema, which can be used for validation testing ```$ techui-builder --schema``` From 4e3e974ce65619c57717724e05fda5741dde0c8e Mon Sep 17 00:00:00 2001 From: Tom Kane Date: Wed, 14 Jan 2026 16:30:27 +0000 Subject: [PATCH 3/3] Removed manual techui-support setup, added instructions to clone ixx-services recursively --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4e824f7..41b40c4 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,9 @@ The process to use this module goes as follows (WIP): ## Setting Up 1. Clone the beamline `ixx-services` repo to the root of this project, ensuring each IOC service has been converted to the [ibek](git@github.com:epics-containers/ibek.git) format. -1. Create your handmade synoptic overview screen in Phoebus and place inside `ixx-services/synoptic/index.bob`. + + `git clone --recursive git@gitlab.diamond.ac.uk:controls/containers/beamline/ixx-services.git` +1. Create your handmade synoptic overview screen in Phoebus and place at `ixx-services/synoptic/index.bob`. 1. Construct a `techui.yaml` file inside `ixx-services/synoptic` containing all the components from the services: ``` @@ -49,7 +51,6 @@ The process to use this module goes as follows (WIP): ``` > [!NOTE] > `extras` is optional, but allows any embedded screen to be added to make a summary screen e.g. combining all imgs, pirgs and ionps associated with a vacuum space. -4. Create a `techui-support.yaml` file inside `ixx-services/synoptic/techui-support`. To get started this file can be left empty. 1. Run this command to locally generate a schema, which can be used for validation testing ```$ techui-builder --schema```