|
1 | 1 | # Working with Support Modules
|
2 | 2 |
|
3 | 3 | :::{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. |
5 | 5 | :::
|
6 | 6 |
|
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 |
| - |
13 | 7 | This is a type 3. change from the list at {any}`ioc-change-types`.
|
14 | 8 |
|
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`. |
24 | 10 |
|
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. |
26 | 12 |
|
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: |
30 | 14 |
|
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. |
0 commit comments