IOC 101 - Revision history

Jemian at 20:33, 27 February 2025

2025-02-27T20:33:36Z

← Older revision		Revision as of 20:33, 27 February 2025
Line 85:		Line 85:
	'''<span style="color: red">Red folders:</span>'''<br>		'''<span style="color: red">Red folders:</span>'''<br>
	The EPICS build system creates top level bin, db, dbd, and lib directories:		The EPICS build system creates top level bin, db, dbd, and lib directories:
	* '''<code>xxx/bin/~~rehl8~~-x86_64</code>''':		* '''<code>xxx/bin/rhel8-x86_64</code>''':
	:contains the architecture-specific IOC binary (or munch file for VxWorks IOCs).		:contains the architecture-specific IOC binary (or munch file for VxWorks IOCs).
	* '''<code>xxx/db</code>''':		* '''<code>xxx/db</code>''':
Line 91:		Line 91:
	* '''<code>xxx/dbd</code>''':		* '''<code>xxx/dbd</code>''':
	:contains a single database definition file to be loaded by the IOC.		:contains a single database definition file to be loaded by the IOC.
	* '''<code>xxx/lib/~~rehl8~~-x86_64</code>''':		* '''<code>xxx/lib/rhel8-x86_64</code>''':
	:contains architecture-specific files for EPICS modules, but should be empty for the IOC.<br>		:contains architecture-specific files for EPICS modules, but should be empty for the IOC.<br>
	The build system creates an '''<code>envPaths</code>''' file in the startup directory '''<code>iocBoot/iocxxx</code>''', which contains the locations of the modules defined in the '''<code>RELEASE</code>''' file.		The build system creates an '''<code>envPaths</code>''' file in the startup directory '''<code>iocBoot/iocxxx</code>''', which contains the locations of the modules defined in the '''<code>RELEASE</code>''' file.

Rodolakis: /* What's next? */

2023-12-08T22:54:34Z

What's next?

← Older revision		Revision as of 22:54, 8 December 2023
Line 305:		Line 305:

	== What's next? ==		== What's next? ==
	For step by step instructions to create your own IOC, go to [https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions) IOC Deployment & Troubleshooting].		For step by step instructions to create your own IOC, go to [https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions IOC Deployment & Troubleshooting].

Rodolakis: /* What's next? */

2023-05-11T17:58:48Z

What's next?

← Older revision		Revision as of 17:58, 11 May 2023
Line 305:		Line 305:

	== What's next? ==		== What's next? ==
	For step by step instructions to create your own IOC, go to [~~IOC Deployment & Troubleshooting](~~https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions).		For step by step instructions to create your own IOC, go to [https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions) IOC Deployment & Troubleshooting].

Rodolakis: /* What's next? */

2023-05-11T17:58:14Z

What's next?

← Older revision		Revision as of 17:58, 11 May 2023
Line 305:		Line 305:

	== What's next? ==		== What's next? ==
	For step by step instructions to create your own IOC, go to (IOC Deployment & Troubleshooting)[https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions].		For step by step instructions to create your own IOC, go to [IOC Deployment & Troubleshooting](https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions).

Rodolakis: /* Where does EPICS support reside at the APS */

2023-05-11T17:57:57Z

Where does EPICS support reside at the APS

← Older revision		Revision as of 17:57, 11 May 2023
Line 301:		Line 301:
	<br><br>		<br><br>
	[[File:IOC_Support.jpg\|center\|thumb\|500px]]<br><br>		[[File:IOC_Support.jpg\|center\|thumb\|500px]]<br><br>



			== What's next? ==
			For step by step instructions to create your own IOC, go to (IOC Deployment & Troubleshooting)[https://git.aps.anl.gov/practical_beamline_controls_training/session_2/instructions].

Rodolakis: /* IOC Layout */

2023-03-22T21:31:34Z

IOC Layout

← Older revision		Revision as of 21:31, 22 March 2023
Line 52:		Line 52:

	The IOC layout can be overwhelming and confusing to those who aren’t yet familiar with it. The EPICS build system creates many directories, making it harder to find the important directories.		The IOC layout can be overwhelming and confusing to those who aren’t yet familiar with it. The EPICS build system creates many directories, making it harder to find the important directories.
	Important files are often buried multiple directories down from the top-level. It is helpful to look at subsets of the IOC directory. <br>		Important files are often buried multiple directories down from the top-level. It is helpful to look at subsets of the IOC directory.

			<br>
	<u>Note</u>:		<u>Note</u>:
	* '''build''': building an IOC is the action of compiling i.e. generating the binary <code>bin/rhel#-x86_64/xxxApp</code> (plus other build products as described below) by using the command '''<code>make</code>'''.		* '''build''': building an IOC is the action of compiling i.e. generating the binary <code>bin/rhel#-x86_64/xxxApp</code> (plus other build products as described below) by using the command '''<code>make</code>'''.
	* '''run''': running an IOC is the action of running the binary along with a startup script of iocsh commands (usually called '''<code>st.cmd</code>''')		* '''run''': running an IOC is the action of running the binary along with a startup script of iocsh commands (usually called '''<code>st.cmd</code>''')

			<br>
			<u>Note</u>:
			* Any change in the build configuration ('''<span style="color: orange">Orange folders</span>''') requires to recompile the IOC by issuing a '''<code>make</code>'''.
			* Any change in the runtime configuration ('''<span style="color: green">Green folders</span>''') requires to reboot the IOC.


Line 93:		Line 100:
	The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).		The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).
	The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.		The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.

	~~<u>Note</u>:~~
	* Any change in the build configuration ('''<span style="color: orange">Orange folders</span>''') requires a '''<code>make</code>'''.
	* Any change in the runtime configuration ('''<span style="color: green">Green folders</span>''') requires an IOC reboot.

	=== Startup scripts ===		=== Startup scripts ===

Rodolakis: /* IOC Layout */

2023-03-21T14:20:19Z

IOC Layout

← Older revision		Revision as of 14:20, 21 March 2023
Line 93:		Line 93:
	The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).		The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).
	The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.		The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.

			<u>Note</u>:
			* Any change in the build configuration ('''<span style="color: orange">Orange folders</span>''') requires a '''<code>make</code>'''.
			* Any change in the runtime configuration ('''<span style="color: green">Green folders</span>''') requires an IOC reboot.

	=== Startup scripts ===		=== Startup scripts ===
Line 102:		Line 106:

	<u>Note</u>: The startup directory can reside elsewhere.		<u>Note</u>: The startup directory can reside elsewhere.


	<br>		<br>

Rodolakis: /* Startup directory */

2023-03-21T14:17:30Z

Startup directory

← Older revision		Revision as of 14:17, 21 March 2023
Line 91:		Line 91:

	'''<span style="color: green">Green folders:</span>''' <br>		'''<span style="color: green">Green folders:</span>''' <br>
	The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the runtime configuration for the IOC (i.e. all the files the IOC needs to load to run/start).		The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the '''runtime configuration''' for the IOC (i.e. all the files the IOC needs to load to run/start).
	The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.		The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.

Rodolakis: /* Startup directory */

2023-03-21T14:17:13Z

Startup directory

← Older revision		Revision as of 14:17, 21 March 2023
Line 91:		Line 91:

	'''<span style="color: green">Green folders:</span>''' <br>		'''<span style="color: green">Green folders:</span>''' <br>
	The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the runtime configuration for the IOC (i.e. ~~what~~ the IOC needs to ~~know~~ to start).		The '''<code>iocxxx</code>''' directory is referred to as the '''startup''' directory. It contains the '''<code>st.cmd</code>''' file, which is the runtime configuration for the IOC (i.e. all the files the IOC needs to load to run/start).
	The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.		The IOC’s config is often broken into separate '''<code>.iocsh</code>''' (or '''<code>.cmd</code>''') files so that support can be more easily commented out and to improve readability; '''<code>substitutions</code>''' and '''<code>iocsh</code>''' files usually reside in subdirectories to reduce clutter in the startup directory.

Rodolakis: /* Overview */

2023-03-21T14:10:36Z

Overview

← Older revision		Revision as of 14:10, 21 March 2023
Line 54:		Line 54:
	Important files are often buried multiple directories down from the top-level. It is helpful to look at subsets of the IOC directory. <br>		Important files are often buried multiple directories down from the top-level. It is helpful to look at subsets of the IOC directory. <br>
	<u>Note</u>:		<u>Note</u>:
	* '''build''': building an IOC is the action generating the binary <code>bin/rhel#-x86_64/xxxApp</code> (plus other build products as described below) by using the command '''<code>make</code>'''.		* '''build''': building an IOC is the action of compiling i.e. generating the binary <code>bin/rhel#-x86_64/xxxApp</code> (plus other build products as described below) by using the command '''<code>make</code>'''.
	* '''run''': running an IOC is the action of running the binary along with a startup script of iocsh commands (usually called '''<code>st.cmd</code>''')		* '''run''': running an IOC is the action of running the binary along with a startup script of iocsh commands (usually called '''<code>st.cmd</code>''')