Members

MonitorResources

Enum for monitor resources

Source

MonitorResources

Enum for monitor resources

Source

Methods

disposeUasMonitoring() → {Promise.<void>}

Optional full cleanup helper.

Source
Returns:
Type: 
Promise.<void>

getModuleText(moduleName, taskName) → {Promise.<string>}

Gets the RAPID module text.

Parameters:
NameTypeDescription
moduleNamestring

The module name.

taskNamestring

The task name.

Source
Returns:

Returns the module text.

Type: 
Promise.<string>
Example
await API.RAPID.getModuleText("MainModule");

monitorUserGrant(key, callback) → {Promise.<function()>}

Monitor one specific grant.

Behavior:

  1. Ensure Store is initialized silently
  2. Register watcher
  3. Invoke ONLY this callback once with current cached value

It does NOT trigger other callbacks.

Parameters:
NameTypeDescription
keystring

Grant name

callbackfunction

Receives boolean

Source
Returns:

disposer

Type: 
Promise.<function()>

setModuleText(moduleName, text, taskName)

Set RAPID module text

Parameters:
NameTypeDescription
moduleNamestring

The module name

textstring

The text to write

taskNamestring

The task name

Source
Example
await API.RAPID.setModuleText("Module1",`MODULE Module1\r\nPROC proc1()\r\nTPWrite "123";\r\nENDPROC\r\nENDMODULE`);

subscribeRes() → {Promise.<void>}

Start UAS subscription only. Does not initialize Store by itself.

Source
Returns:
Type: 
Promise.<void>

unmonitorUserGrant(key, callbackopt)

Remove one watcher callback for a grant.

Parameters:
NameTypeAttributesDescription
keystring
callbackfunction<optional>
Source

unsubscribeAll()

Unsubscribes from the variable state

Source

unsubscribeRes() → {Promise.<void>}

Stop UAS subscription.

Source
Returns:
Type: 
Promise.<void>

Type Definitions

JointsSolutionProps

Properties
NameTypeAttributesDescription
mechUnitstring<optional>
robTargetAPI.MOTION.RobTarget
toolDataAPI.MOTION.ToolData<optional>
Source

JontsFromCartesianProps

Properties
NameTypeAttributesDescription
mechUnitstring<optional>
robTargetAPI.MOTION.RobTarget
toolDataAPI.MOTION.ToolData<optional>
jointTargetAPI.MOTION.JointTarget
Source