User Reference:Operator Module Scripting - Revision history

Mellinger: /* START WEBSOCKET , STOP WEBSOCKET */

2026-08-09T16:04:41Z

START WEBSOCKET , STOP WEBSOCKET

← Older revision		Revision as of 16:04, 9 August 2026
Line 539:		Line 539:
	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

	=====START WEBSOCKET <address>, STOP WEBSOCKET <address>=====		=====START WEBSOCKET [<address>], STOP WEBSOCKET [<address>]=====
	Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format. The default address is 127.0.0.1:3998.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

Mellinger: /* START TELNET , STOP TELNET */

2026-08-09T16:03:33Z

START TELNET , STOP TELNET

← Older revision		Revision as of 16:03, 9 August 2026
Line 534:		Line 534:
	[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].		[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].

	=====START TELNET <address>, STOP TELNET <address>=====		=====START TELNET [<address>], STOP TELNET [<address>]=====
	Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format. The default address is 127.0.0.1:3999.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

Mellinger: /* DO; ; UNTIL */

2026-02-20T14:48:06Z

DO; ; UNTIL

← Older revision		Revision as of 14:48, 20 February 2026
Line 42:		Line 42:
	Executes ''loop commands'' while ''condition'' evaluates to ''true''.		Executes ''loop commands'' while ''condition'' evaluates to ''true''.
	=====DO; <loop commands>; UNTIL <condition>=====		=====DO; <loop commands>; UNTIL <condition>=====
	Executes ''loop commands'' until "condition" evaluates to ''true''.		Executes ''loop commands'' until ''condition'' evaluates to ''true''.

	=====FOR <name> IN <item1> <item2> ... ; <loop commands>; END=====		=====FOR <name> IN <item1> <item2> ... ; <loop commands>; END=====
	Creates a local variable with the specified name. Then, sequentially assigns each ''item'' to that variable, and executes ''loop commands''. If an ''item'' contains newline characters, it is split up into multiple items, corresponding to the lines contained in the ''item''. E.g.,		Creates a local variable with the specified name. Then, sequentially assigns each ''item'' to that variable, and executes ''loop commands''. If an ''item'' contains newline characters, it is split up into multiple items, corresponding to the lines contained in the ''item''. E.g.,

Mellinger: /* Syntax */

2026-02-20T14:45:09Z

Syntax

← Older revision		Revision as of 14:45, 20 February 2026
Line 20:		Line 20:
	Note that the last example uses the short form of the GET command, which will return the value of a PATH parameter or a PATH state if such exists. To make sure that only environment variables are matched, use the long form of the GET command:		Note that the last example uses the short form of the GET command, which will return the value of a PATH parameter or a PATH state if such exists. To make sure that only environment variables are matched, use the long form of the GET command:
	LOG MESSAGE "The path environment variable is: ${GET VARIABLE PATH}"		LOG MESSAGE "The path environment variable is: ${GET VARIABLE PATH}"
	<--!		<!--
	Substitutions may be nested, i.e. the following will work as expected:		Substitutions may be nested, i.e. the following will work as expected:
	SET MyVar "LIST STATES"; LOG "States are: ${$MyVar}"		SET MyVar "LIST STATES"; LOG "States are: ${$MyVar}"

Mellinger: /* Syntax */

2026-02-20T14:44:53Z

Syntax

← Older revision		Revision as of 14:44, 20 February 2026
Line 20:		Line 20:
	Note that the last example uses the short form of the GET command, which will return the value of a PATH parameter or a PATH state if such exists. To make sure that only environment variables are matched, use the long form of the GET command:		Note that the last example uses the short form of the GET command, which will return the value of a PATH parameter or a PATH state if such exists. To make sure that only environment variables are matched, use the long form of the GET command:
	LOG MESSAGE "The path environment variable is: ${GET VARIABLE PATH}"		LOG MESSAGE "The path environment variable is: ${GET VARIABLE PATH}"
			<--!
	Substitutions may be nested, i.e. the following will work as expected:		Substitutions may be nested, i.e. the following will work as expected:
	SET MyVar "LIST STATES"; LOG "States are: ${$MyVar}"		SET MyVar "LIST STATES"; LOG "States are: ${$MyVar}"
	SET MyVar "LIST STATES"; LOG "States are: ${${GET VARIABLE MyVar}}"		SET MyVar "LIST STATES"; LOG "States are: ${${GET VARIABLE MyVar}}"
			-->

	'''Mathematical Expressions.''' A command may consist of a single [[User Reference:Expression Syntax\|mathematical expression]]. This expression is then evaluated, and its result is returned as the command's result. As a special case, this allows the use of expression variables in ${...} substitutions. Consider for example		'''Mathematical Expressions.''' A command may consist of a single [[User Reference:Expression Syntax\|mathematical expression]]. This expression is then evaluated, and its result is returned as the command's result. As a special case, this allows the use of expression variables in ${...} substitutions. Consider for example

Jhill: /* Commands operating on Environment Variables */

2025-10-04T00:35:06Z

Commands operating on Environment Variables

← Older revision		Revision as of 00:35, 4 October 2025
Line 79:		Line 79:
	=====GET ENVIRONMENT <name>=====		=====GET ENVIRONMENT <name>=====
	Returns the variable's current value. When the variable does not exist, an empty value is returned rather than an error message.		Returns the variable's current value. When the variable does not exist, an empty value is returned rather than an error message.
			=====WRITE ENVIRONMENT <fileName> <variableName1> <variableName2> ...=====
			Writes a series of SET ENVIRONMENT statements to the specified file, overwriting any previous file contents. This saves the values of the named variables in such a way that you can later load them back by calling EXECUTE SCRIPT <filename>. The variable names may refer to either local or environment variables at the time of writing, but when you execute the script they will all be loaded as environment variables.
			=====APPEND ENVIRONMENT <fileName> <variableName1> <variableName2> ...=====
			This is the same as WRITE ENVIRONMENT, except that the SET ENVIRONMENT statements are appended to the named file without overwriting its previous contents.

	====Commands operating on Scripts====		====Commands operating on Scripts====

Mellinger: /* START WEBSOCKET , STOP WEBSOCKET */

2025-10-02T03:42:42Z

START WEBSOCKET , STOP WEBSOCKET

← Older revision		Revision as of 03:42, 2 October 2025
Line 535:		Line 535:
	Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

	====Operator-module Commands for Soliciting Input from the User====		====Operator-module Commands for Soliciting Input from the User====

Mellinger: /* START TELNET , STOP TELNET */

2025-10-02T03:42:19Z

START TELNET , STOP TELNET

← Older revision		Revision as of 03:42, 2 October 2025
Line 530:		Line 530:
	Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

	=====START WEBSOCKET <address>, STOP WEBSOCKET <address>=====		=====START WEBSOCKET <address>, STOP WEBSOCKET <address>=====

Mellinger: /* GET SYSTEM STATE */

2025-10-02T03:33:44Z

GET SYSTEM STATE

← Older revision		Revision as of 03:33, 2 October 2025
Line 393:		Line 393:

	=====GET SYSTEM STATE=====		=====GET SYSTEM STATE=====
	Prints the current system state. This will be one of Unavailable, Idle, Startup, Initialization, Resting, Suspended, ParamsModified, Running, Termination, Busy.		Prints the current system state. This will be one of Unavailable, Idle, Startup, Initialization, Resting, Suspended, ParamsModified, Running, Termination, Busy (for details, see the WAIT FOR command below).

	=====GET CURRENT RUN FILE=====		=====GET CURRENT RUN FILE=====

Mellinger: /* CHANGE DIRECTORY */

2025-10-02T03:20:43Z

CHANGE DIRECTORY

← Older revision		Revision as of 03:20, 2 October 2025
Line 286:		Line 286:

	=====CHANGE DIRECTORY <path>=====		=====CHANGE DIRECTORY <path>=====
	Changes the working directory.		Changes the script's working directory. Note that working directories are per-script, i.e. multiple scripts running in parallel may have different working directories. Also, this command will only affect the default directory of scripting commands, not the application-global working directory as seen by the OS.

	=====MAKE DIRECTORY <path>=====		=====MAKE DIRECTORY <path>=====
	Creates a new directory with the given path. The directory's parent must exist for the command to succeed.		Creates a new directory with the given path. The directory's parent must exist for the command to succeed.