Skip to end of metadata
Go to start of metadata
OOIN provides a set of common commands that you can issue to a decvice from inside of the OOIN interface.
The operator must have the proper permissions to command a device. See Establish User Role & Access Permissions for instructions on how to acquire the appropriate role and request permission to command a specific device.

Steps below begin from device's page, click on either navigating or searching for details on locating the device to be commanded.


Image depicting Agent States and Commands

Descriptions of Common Commands

Note: Not all common commands will be available to every device.

UI Command Proposed Command
Description
Applicable Resource
Accessible to following Roles
START ... AGENT Start ... Agent Either Instrument or Port Agent will power up
(State goes from Powered Down to Uninitialized).
All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access
GET CAPABILITIES Get
Capabilities
Refreshes available commands list (available in all states).
  Facility Participant
RESOURCE_AGENT
_EVENT_INITIALIZE
Initialize Setup sequence that ensures resource is loaded and driver process is loaded, may include optional driver configuration
(State goes from Uninitialized to Inactive).
All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_GO_ACTIVE Go Active or Activate? Invokes sequence of events that connects the driver to the device, allowing the driver to talk to the hardware
(State goes from Inactive to Idle).
All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT
_EVENT_RUN
Run or Go Command? Communication channel is open and verified, available commands will be listed once running.
(State goes from Idle to Command Mode).
All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access
DRIVER_EVENT _ACQUIRE_SAMPLE Acquire
Sample
A Driver Command - acquires a sample immediately, an individual sample not repeated
(State is in Command Mode).
  Facility Administrator, Manager, Operator w/ Access
DRIVER_EVENT_
START_AUTOSAMPLE
Start Auto Sampling
A Driver Command - starts auto-sampling, will use default sampling rate parameters unless alternates entered
(State goes from Command Mode to Streaming).
  Facility Administrator, Manager, Operator w/ Access
DRIVER_EVENT _STOP_AUTOSAMPLE Stop Auto Sampling A Driver Command - stops auto-sampling
(State goes from Streaming to Command Mode).
  Facility Administrator, Manager, Operator w/ Access
DRIVER_EVENT_TEST Run Tests?
A Driver Command - runs driver specified resource tests* (State - Command Mode to Test back to Command Mode).   Facility Administrator, Manager, Operator w/ Access
..._CALIBRATE Calibrate A Driver Command - calibrates the resource if available* (State - Command Mode to Calibrate back to Command Mode).   Facility Administrator, Manager, Operator w/ Access
DRIVER_EVENT
_ACQUIRE_STATUS
Get
Status?
A Driver Command - acquires status, may be through specific status or get commands depending on resource*
(Available in Command Mode, possibly while Streaming depending on resource*).
  Facility Administrator, Manager, Operator w/ Access
  <Additional Commands>
Additional resource* specific commands may be available (State is in Command Mode to Busy back to Command Mode). Applicable Devices Facility Administrator, Manager, Operator w/ Access
RESOURCE_AGENT _EVENT_GO
_DIRECT_ACCESS
Start Direct Access
Initiates direct access as connection to resource, control is via telnet or vendor software, not through driver
(State from Command Mode to Direct Access Mode).
  Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_GO_COMMAND Stop Direct Access Exits direct access, returned to available OOIN commands
(State from Direct Access Mode to Command Mode).
  Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT
_EVENT_CLEAR
Clear
Clears all context** of current command mode,
(State from Command Mode to Idle).
  Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_PAUSE
Pause
Commanding stopped but context** retained
(State from Command Mode to Stopped).
  Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_RESUME
Resume
Resumes commanding with context** intact after a pause (State from Stopped to Command Mode).   Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_RESET Reset Resets to initial state, all user adjusted parameters are reset as the command sends all start up configuration parameters by default (From current state to Uninitialized).   Facility Administrator, Manager, Operator w/ Exclusive Access
RESOURCE_AGENT _EVENT_GO_INACTIVE
Go Inactive or Deactivate?
Invokes sequence of events that disconnects the driver from the device, communication is stopped but driver is still running (From current state to Inactive). All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access
STOP ... AGENT Stop ... Agent Disconnects or powers down, resource agent is stopped (From current state to Powered Down). All Taskable Devices Facility Administrator, Manager, Operator w/ Exclusive Access

* See the individual device operational specifications (IOSs) on Confluence for device specific commands and details.
** The idle and stopped states are currently identical and the use of returning or not to a particular context is not activated in the current version. The functionality has been implemented in anticipation of future needs.


Labels

ci_user_doc ci_user_doc Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.