EPICS for Dummies - Revision history

Rodolakis: /* What is a record? */

2023-03-15T20:10:05Z

What is a record?

← Older revision		Revision as of 20:10, 15 March 2023
Line 111:		Line 111:
	* The '''SCAN''' field is common to ''all'' record types and the options can be selected by index instead of by string.		* The '''SCAN''' field is common to ''all'' record types and the options can be selected by index instead of by string.
	* <code>I/O Intr</code> processes a record when the driver gets a new value, but is device/driver dependent and isn’t guaranteed to work		* <code>I/O Intr</code> processes a record when the driver gets a new value, but is device/driver dependent and isn’t guaranteed to work


	=== Record link types ===		=== Record link types ===

Rodolakis: /* What is a record field? */

2023-03-15T20:09:36Z

What is a record field?

← Older revision		Revision as of 20:09, 15 March 2023
Line 81:		Line 81:

	Record fields are controllable or informative properties of a record. For a list of noteworthy fields, see [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_Cheat_Sheet here].		Record fields are controllable or informative properties of a record. For a list of noteworthy fields, see [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_Cheat_Sheet here].



	==== SCAN, PROC & FLNK fields ====		==== SCAN, PROC & FLNK fields ====

Rodolakis: /* What is a record field? */

2023-03-15T20:09:25Z

What is a record field?

← Older revision		Revision as of 20:09, 15 March 2023
Line 80:		Line 80:
	=== What is a record field? ===		=== What is a record field? ===

	Record fields are controllable or informative properties of a record.		Record fields are controllable or informative properties of a record. For a list of noteworthy fields, see [https://wiki-ext.aps.anl.gov/blc/index.php?title=EPICS_Cheat_Sheet here].

Rodolakis: /* What is a record field? */

2023-03-15T20:08:50Z

What is a record field?

← Older revision		Revision as of 20:08, 15 March 2023
Line 82:		Line 82:
	Record fields are controllable or informative properties of a record.		Record fields are controllable or informative properties of a record.


	~~====Noteworthy fields====~~

	*'''VAL''' - the default field (used if no field is specified in the vast majority of cases)
	*'''SCAN''' - determines when a record processes
	*'''NAME''' - the record name (helpful if records are aliased)
	*'''DESC''' - record description
	*'''RTYP''' - the record type
	*'''DTYP''' - the device support type (not meaningful for all record types)
	*'''DISP''' - disable puts (ca = channel access & pva = pv access) from outside the IOC (when non-zero); e.g. disable a motor from the motorx_all screen
	*'''DISV/DISA/SDIS''' - disable record processing internally
	**Record processing is disabled when '''DISA''' equals '''DISV''' (e.g. uses SDIS field to read in a value/mode, which will disable some control if a certain mode is active)
	**'''DISA''' is set to the value of the PV in the '''SDIS''' field, if it isn't empty
	*'''TPRO''' - trace processing: when set to 1 prints out all the records that get processed after the record is processed; used only for troubleshooting

	<u>Note</u>: some of the fields of a record are actually record attributes (they return the same value for all instances of the record type; see [https://epics.anl.gov/base/R3-16/2-docs/AppDevGuide/DatabaseDefinition.html#x7-2630006.6 https://epics.anl.gov/])


Line 129:		Line 113:
	* The '''SCAN''' field is common to ''all'' record types and the options can be selected by index instead of by string.		* The '''SCAN''' field is common to ''all'' record types and the options can be selected by index instead of by string.
	* <code>I/O Intr</code> processes a record when the driver gets a new value, but is device/driver dependent and isn’t guaranteed to work		* <code>I/O Intr</code> processes a record when the driver gets a new value, but is device/driver dependent and isn’t guaranteed to work


	=== Record link types ===		=== Record link types ===

Rodolakis: /* What is a record? */

2023-03-15T20:08:28Z

What is a record?

← Older revision		Revision as of 20:08, 15 March 2023
Line 212:		Line 212:
	**** [https://github.com/epics-modules https://github.com/epics-modules]		**** [https://github.com/epics-modules https://github.com/epics-modules]
	**** <code>/APSshare/epics/synApps_X_Y/support</code>		**** <code>/APSshare/epics/synApps_X_Y/support</code>


	== What is a databases? ==		== What is a databases? ==

Rodolakis at 19:50, 15 March 2023

2023-03-15T19:50:35Z

← Older revision		Revision as of 19:50, 15 March 2023
Line 1:		Line 1:
	~~== EPICS cheat sheet ==~~

	~~=== Channel Access (CA) command-lines ===~~

	* <code>'''caget'''</code> - get the value of one of more PVs
	* <code>'''caput'''</code> - change the value of a PV
	* <code>'''camonitor'''</code> - monitor the value of one or more PVs
	* <code>'''cainfo'''</code> - print info about a PV, including which host is running the IOC

	~~Example:~~

	~~$ caget kmp3:m1.{DESC,RTYP,DTYP,VAL}~~
	~~kmp3:m1.DESC theta motor~~
	~~kmp3:m1.RTYP motor~~
	~~kmp3:m1.DTYP asynMotor~~
	~~kmp3:m1.VAL 60~~


	~~=== IOC shell commands ===~~

	~~:'''<code>help [command]</code>''' - shows available commands or syntax of specified command~~
	~~:'''<code>dbpr record_name [0-9]</code>''' - displays fields and values for a given record~~
	~~:'''<code>dbl</code>''' - lists all records in an IOC~~
	~~:'''<code>dbl record_type</code>''' - lists all records of a specific type in an IOC~~
	~~:'''<code>dbl record_type "field_list"</code>''' - lists specified fields (space-separated list) of records of a specific type in an IOC~~
	~~:'''<code>dbpf pv_name value</code>''' - change a PV’s value – analogous to caput~~
	~~:'''<code>dbgf pv_name</code>''' - read a PV’s value – analogous to caget~~
	~~:'''<code>epicsEnvShow</code>''' - prints environment variables~~
	~~:'''<code>seqShow</code>''' - shows running sequence programs~~
	~~:'''<code>seqStop</code>''' - stops a running sequence program~~

	== What is EPICS? ==		== What is EPICS? ==

Rodolakis: /* IOC shell commands */

2023-03-15T19:49:41Z

IOC shell commands

← Older revision		Revision as of 19:49, 15 March 2023
Line 19:		Line 19:
	=== IOC shell commands ===		=== IOC shell commands ===

	* <code>~~'''~~help [command]~~'''~~</code> - shows available commands or syntax of specified command		:'''<code>help [command]</code>''' - shows available commands or syntax of specified command
	* <code>~~'''~~dbpr record_name [0-9]~~'''~~</code> - displays fields and values for a given record		:'''<code>dbpr record_name [0-9]</code>''' - displays fields and values for a given record
	* <code>~~'''~~dbl~~'''~~</code> - lists all records in an IOC		:'''<code>dbl</code>''' - lists all records in an IOC
	* <code>~~'''~~dbl record_type~~'''~~</code> - lists all records of a specific type in an IOC		:'''<code>dbl record_type</code>''' - lists all records of a specific type in an IOC
	* <code>~~'''~~dbl record_type "field_list"~~'''~~</code> - lists specified fields (space-separated list) of records of a specific type in an IOC		:'''<code>dbl record_type "field_list"</code>''' - lists specified fields (space-separated list) of records of a specific type in an IOC
	* <code>~~'''~~dbpf pv_name value~~'''~~</code> - change a PV’s value – analogous to caput		:'''<code>dbpf pv_name value</code>''' - change a PV’s value – analogous to caput
	* <code>~~'''~~dbgf pv_name~~'''~~</code> - read a PV’s value – analogous to caget		:'''<code>dbgf pv_name</code>''' - read a PV’s value – analogous to caget
	* <code>~~'''~~epicsEnvShow~~'''~~</code> - prints environment variables		:'''<code>epicsEnvShow</code>''' - prints environment variables
	* <code>~~'''~~seqShow~~'''~~</code> - shows running sequence programs		:'''<code>seqShow</code>''' - shows running sequence programs
	* <code>~~'''~~seqStop~~'''~~</code> - stops a running sequence program		:'''<code>seqStop</code>''' - stops a running sequence program

	== What is EPICS? ==		== What is EPICS? ==

Rodolakis: /* Basic Channel Access (CA) commands */

2023-03-15T19:48:53Z

Basic Channel Access (CA) commands

← Older revision		Revision as of 19:48, 15 March 2023
Line 1:		Line 1:
	== ~~Basic~~ Channel Access (CA) ~~commands~~ ==		== EPICS cheat sheet ==

			=== Channel Access (CA) command-lines ===

	* <code>'''caget'''</code> - get the value of one of more PVs		* <code>'''caget'''</code> - get the value of one of more PVs
Line 13:		Line 15:
	kmp3:m1.DTYP asynMotor		kmp3:m1.DTYP asynMotor
	kmp3:m1.VAL 60		kmp3:m1.VAL 60


			=== IOC shell commands ===

			* <code>'''help [command]'''</code> - shows available commands or syntax of specified command
			* <code>'''dbpr record_name [0-9]'''</code> - displays fields and values for a given record
			* <code>'''dbl'''</code> - lists all records in an IOC
			* <code>'''dbl record_type'''</code> - lists all records of a specific type in an IOC
			* <code>'''dbl record_type "field_list"'''</code> - lists specified fields (space-separated list) of records of a specific type in an IOC
			* <code>'''dbpf pv_name value'''</code> - change a PV’s value – analogous to caput
			* <code>'''dbgf pv_name'''</code> - read a PV’s value – analogous to caget
			* <code>'''epicsEnvShow'''</code> - prints environment variables
			* <code>'''seqShow'''</code> - shows running sequence programs
			* <code>'''seqStop'''</code> - stops a running sequence program

	== What is EPICS? ==		== What is EPICS? ==

Rodolakis: /* Basic Channel Access (CA) commands */

2023-03-15T19:46:32Z

Basic Channel Access (CA) commands

← Older revision		Revision as of 19:46, 15 March 2023
Line 1:		Line 1:
	== Basic Channel Access (CA) commands ==		== Basic Channel Access (CA) commands ==

	* caget - get the value of one of more PVs		* <code>'''caget'''</code> - get the value of one of more PVs
	* caput - change the value of a PV		* <code>'''caput'''</code> - change the value of a PV
	* camonitor - monitor the value of one or more PVs		* <code>'''camonitor'''</code> - monitor the value of one or more PVs
	* cainfo - print info about a PV, including which host is running the IOC		* <code>'''cainfo'''</code> - print info about a PV, including which host is running the IOC

	Example:		Example:
Line 13:		Line 13:
	kmp3:m1.DTYP asynMotor		kmp3:m1.DTYP asynMotor
	kmp3:m1.VAL 60		kmp3:m1.VAL 60


	== What is EPICS? ==		== What is EPICS? ==

Rodolakis at 19:45, 15 March 2023

2023-03-15T19:45:39Z

← Older revision		Revision as of 19:45, 15 March 2023
Line 1:		Line 1:
	== Basic commands ==		== Basic Channel Access (CA) commands ==

	* caget - get the value of one of more PVs		* caget - get the value of one of more PVs
Line 6:		Line 6:
	* cainfo - print info about a PV, including which host is running the IOC		* cainfo - print info about a PV, including which host is running the IOC

			Example:

	~~Example:~~
	$ caget kmp3:m1.{DESC,RTYP,DTYP,VAL}		$ caget kmp3:m1.{DESC,RTYP,DTYP,VAL}
	kmp3:m1.DESC theta motor		kmp3:m1.DESC theta motor
	kmp3:m1.RTYP motor		kmp3:m1.RTYP motor
	kmp3:m1.DTYP asynMotor		kmp3:m1.DTYP asynMotor
	kmp3:m1.VAL 60		kmp3:m1.VAL 60


	== What is EPICS? ==		== What is EPICS? ==