Skip to content

Commit 599f4a8

Browse files
committed
update generic_ioc, support_module
1 parent 93d448f commit 599f4a8

File tree

3 files changed

+17
-183
lines changed

3 files changed

+17
-183
lines changed

docs/tutorials/generic_ioc.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -713,5 +713,8 @@ You can follow along with the CI build by clicking the actions tab in your repos
713713
714714
https://github.com/orgs/YOUR_GITHUB_ACCOUNT/packages?repo_name=ioc-lakeshore340
715715
716-
EXERCISE: Now that you have a published container for ioc-lakeshore340. See if you can add an IOC instance that uses this into your `bl01t` beamline. You should then be able to run up your IOC instance with `ec deploy-local`. You could also run a local version of the simulator and see if you can get the IOC to talk to it.
716+
## EXERCISE
717+
718+
Now you have a published Generic IOC container image for ioc-lakeshore340. See if you can add an IOC instance that uses this into your `bl01t` beamline. You should then be able to run up your IOC instance with `ec deploy-local`. You could also run a local version of the simulator and see if you can get the IOC to talk to it.
719+
717720

docs/tutorials/support_module.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,23 @@
11
# Working with Support Modules
22

33
:::{Warning}
4-
This tutorial is out of date and will be updated soon.
4+
This tutorial is an early draft and is not yet complete.
55
:::
66

7-
TODO: this is currently a stub with some pointers.
8-
9-
TODO: suggest that we will make a new Stream Device that will be a
10-
simple echo server. Use this to step through the process of creating a
11-
new support module.
12-
137
This is a type 3. change from the list at {any}`ioc-change-types`.
148

15-
If you are starting a new support module then the preceding tutorials
16-
have covered all of the skills you will need.
17-
18-
To work on a new support module you will need a Generic IOC project to
19-
work inside. You could choose to create two new projects:
20-
21-
```{eval-rst}
22-
23-
:ioc-MyNewDeviceSupport:
9+
In the tutorial on {doc}`/tutorials/generic_ioc`, we created a new Generic IOC container image that wrapped the existing support module `lakeshore340`.
2410

25-
a Generic IOC container definition based on ioc-template
11+
If you wanted to create a completely new support module then you would use a very similar workflow to the above.
2612

27-
Once you have created the project(s), working on the support module will
28-
look very similar to the procedures set out here `debug_generic_ioc`
29-
```
13+
In brief, the steps are:
3014

31-
Once you have created the project(s), working on the support module will
32-
look very similar to the procedures set out here {any}`debug_generic_ioc`
15+
- Create a new Generic IOC project using the <https://github.com/epics-containers/ioc-template>
16+
- Create a new folder in /workspaces/YOUR_SUPPORT_MODULE_NAME
17+
- Link the new folder to the epics support folders:
18+
- ln -s /workspaces/YOUR_SUPPORT_MODULE_NAME /epics/support/YOUR_SUPPORT_MODULE_NAME
19+
- TODO the ibek command `ibek dev support YOUR_SUPPORT_MODULE_NAME` will do this in future
20+
- Now work on your support module and get it compiling
21+
- Then add `ibek-support` for the new module as per {doc}`/tutorials/generic_ioc`
22+
- create an example instance in the Generic IOC project to test your work
23+
- When ready, push your new support and new ioc-support projects.

docs/tutorials/test_generic_ioc.md

Lines changed: 0 additions & 160 deletions
This file was deleted.

0 commit comments

Comments
 (0)