Skip to content

Commit b32b4ac

Browse files
committed
update generic_ioc to 3.4.0
1 parent fbf2c9b commit b32b4ac

File tree

3 files changed

+19
-13
lines changed

3 files changed

+19
-13
lines changed

docs/how-to/builder2ibek.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ builder beamline to epics-containers. i.e. those whose beamlines
66
have a BLxxY-BUILDER project.
77
:::
88

9-
TODO: this page is WIP and will be updated by Feb 2024.
9+
TODO: this page is WIP and will be updated by May 2024.
1010

1111
`builder2ibek` is a tool to convert DLS builder XML to ibek instance YAML.
1212
It is for working with converting IOC instances to epics-containers.

docs/how-to/builder2ibek.support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ a DLS support module with builder support into an epics-containers
66
Generic IOC. i.e. support modules that have an `etc/builder.py` file.
77
:::
88

9-
TODO: this page is WIP and will be updated by Feb 2024.
9+
TODO: this page is WIP and will be updated by May 2024.
1010

1111
`builder2ibek.support` is a tool to convert DLS builder support modules
1212
into ibek support YAML for the `ibek-support` repository.

docs/tutorials/generic_ioc.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,16 @@ your personal GitHub user space.
7171
<b>ioc-adsimdetector</b>
7272
<b> </b><font color="#FFAF00"><b>ioc-lakeshore340</b></font>
7373
<font color="#5F87AF">🎤</font><b> A One line description of the module</b>
74-
<b> </b><font color="#FFAF00"><b>Generic IOC for the lakeshore 340 temperature controller</b></font>
74+
<b> </b><font color="#FFAF00"><b>ttttt</b></font>
7575
<font color="#5F87AF">🎤</font><b> Git platform hosting the repository.</b>
7676
<b> </b><font color="#FFAF00"><b>github.com</b></font>
7777
<font color="#5F87AF">🎤</font><b> The GitHub organisation that will contain this repo.</b>
78-
<b> </b><font color="#FFAF00"><b>YOUR_GITHUB_ACCOUNT</b></font>
78+
<b> </b><font color="#FFAF00"><b>gilesknap</b></font>
7979
<font color="#5F87AF">🎤</font><b> Remote URI of the repository.</b>
80-
<b> </b><font color="#FFAF00"><b>[email protected]:YOUR_GITHUB_ACCOUNT/ioc-lakeshore340.git</b></font>
80+
<b> </b><font color="#FFAF00"><b>[email protected]:gilesknap/ioc-lakeshore340.git</b></font>
81+
<font color="#5F87AF">🎤</font><b> Does this IOC require RTEMS support? At present RTEMS cross-compilation</b>
82+
<b>is restricted to PowerPC beatnik boards (those used at DLS).</b>
83+
<b> </b><font color="#FFAF00"><b>No</b></font>
8184
</pre>
8285

8386
1. Make the first commit and push the repository to GitHub.
@@ -95,7 +98,7 @@ your personal GitHub user space.
9598
./build
9699
# DLS users make sure you have done: module load vscode
97100
code .
98-
# reopen in container
101+
# reopen in container (ctrl-shift-p reopen in container)
99102
```
100103

101104
As soon as you pushed the project, GitHub Actions CI will start building the project. This will make a container image of the template project, but not publish it because there is no release tag as yet. You can watch this by clicking on the `Actions` tab in your new repository.
@@ -310,7 +313,7 @@ FOLDER=$(dirname $(readlink -f $0))
310313
set -xe
311314
312315
# doxygen is used in documentation build for the developer stage
313-
ibek support apt-install --only=dev doxygen
316+
ibek support apt-install doxygen
314317
315318
# get the source and fix up the configure/RELEASE files
316319
ibek support git-clone ${NAME} ${VERSION} --org https://github.com/DiamondLightSource/
@@ -322,6 +325,9 @@ ibek support register ${NAME}
322325
#ibek support add-libs
323326
#ibek support add-dbds
324327
328+
# global config settings
329+
${FOLDER}/../_global/install.sh
330+
325331
# compile the support module
326332
ibek support compile ${NAME}
327333
# prepare *.bob, *.pvi, *.ibek.support.yaml for access outside the container.
@@ -409,7 +415,7 @@ and create a file called `lakeshore340.ibek.support.yaml`. Add the following
409415
contents:
410416
411417
```yaml
412-
# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/1.6.2/ibek.support.schema.json
418+
# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/2.0.1/ibek.support.schema.json
413419
414420
module: lakeshore340
415421
@@ -561,11 +567,11 @@ https://github.com/<YOUR GITHUB ACCOUNT>/ioc-lakeshore340/releases/download/<VER
561567
This would then be the URL you would put at the top of any IOC instances using
562568
your released Generic IOC.
563569

564-
To create the instance we create a folder in `ioc-examples` and create a IOC Instance definition there as follows:
570+
To create the instance we create a folder in `bl00t-ea-test-01` and create a IOC Instance definition there as follows:
565571

566572
```bash
567-
mkdir -p /workspaces/ioc-lakeshore340/ioc-examples/bl16i-ea-ioc-07/config/
568-
cd /workspaces/ioc-lakeshore340/ioc-examples/bl16i-ea-ioc-07/config/
573+
mkdir -p /workspaces/ioc-lakeshore340/services/bl00t-ea-test-01/config/
574+
cd /workspaces/ioc-lakeshore340/services/bl00t-ea-test-01/config/
569575
code ioc.yaml
570576
```
571577

@@ -574,7 +580,7 @@ Add the following contents to the new yaml file:
574580
```yaml
575581
# yaml-language-server: $schema=/tmp/ibek.ioc.schema.json
576582
577-
ioc_name: "{{ ioc_yaml_file_name }}"
583+
ioc_name: "{{ __utils__.get_env('IOC_NAME') }}"
578584
579585
description: auto-generated by https://github.com/epics-containers/builder2ibek
580586
@@ -614,7 +620,7 @@ cd /epics/support/lakeshore340/etc/simulations/
614620
Now create a new terminal in VSCode (Terminal -> New Terminal) and run:
615621

616622
```bash
617-
ibek dev instance /workspaces/ioc-lakeshore340/ioc-examples/bl16i-ea-ioc-07
623+
ibek dev instance /workspaces/ioc-lakeshore340/services/bl00t-ea-test-01
618624
cd /epics/ioc
619625
make
620626
./start.sh

0 commit comments

Comments
 (0)