Namespace: timer

Type Definitions

---

_sleep

Sleep for a given duration using a specific timer.

Handler should return effects that the timer is not running.

Properties:

Name	Type	Description
command	string	"timer._sleep"
agent	string	Agent identifier
equipment	string	Equipment identifier
duration	number	Number of seconds to sleep

Source:

• commands/timer.js, line 82

---

_start

Start the given timer.

Handler should return effects that the timer is running.

Properties:

Name	Type	Description
command	string	"timer._start"
agent	string	Agent identifier
equipment	string	Equipment identifier

Source:

• commands/timer.js, line 102

---

_stop

Stop the given timer.

Handler should return effects that the timer is not running.

Properties:

Name	Type	Description
command	string	"timer._stop"
agent	string	Agent identifier
equipment	string	Equipment identifier

Source:

• commands/timer.js, line 120

---

_wait

Wait until the given timer has reacher the given elapsed time.

Handler should:

• expect that the timer (identified by the equipment parameter) is running
• return effects that the timer is not running

Properties:

Name	Type	Description
command	string	"timer._wait"
agent	string	Agent identifier
equipment	string	Equipment identifier
till	number	Number of seconds to wait till from the time the timer was started
stop	boolean	Whether to stop the timer after waiting, or let it continue

Source:

• commands/timer.js, line 138

---

doAndWait

A control construct to perform the given sub-steps and then wait until a certain amount of time has elapsed since the beginning of this command.

Properties:

Name	Type	Argument	Description
command	string		"timer.doAndWait"
agent	string	<optional>	Agent identifier
equipment	string	<optional>	Equipment identifier
duration	number		Number of seconds this command should last
steps	Array | Object		Sub-steps to perform

Source:

• commands/timer.js, line 162

---

sleep

Sleep for a given duration.

Properties:

Name	Type	Argument	Description
command	string		"timer.sleep"
agent	string	<optional>	Agent identifier
equipment	string	<optional>	Equipment identifier
duration	number		Number of seconds to sleep

Source:

• commands/timer.js, line 202

---

start

Start a timer.

Properties:

Name	Type	Argument	Description
command	string		"timer.start"
agent	string	<optional>	Agent identifier
equipment	string	<optional>	Equipment identifier

Source:

• commands/timer.js, line 238

---

stop

Stop a running timer.

Properties:

Name	Type	Argument	Description
command	string		"timer.stop"
agent	string	<optional>	Agent identifier
equipment	string	<optional>	Equipment identifier

Source:

• commands/timer.js, line 273