Namespace: RAPID

The API.RWS.RAPID namespace provides RAPID-related interfaces that are not supported by the OmniCore SDK.

Source: ecosystem-rws.js, line 973

Methods

getCycleMode() → {Promise.<string>}

Gets the current cycle mode of the program execution.

Source: ecosystem-rws.js, line 1363

Returns:

The current cycle mode.

Type:: Promise.<string>

Example

const cycleMode = await API.RWS.RAPID.getCycleMode();

getDataTypeProperty(typeUrl) → {Promise.<any>}

Gets the properties of the specified RAPID data type

Parameters:

Name	Type	Description
`typeUrl`	string	The URL of the data type.

Source: ecosystem-rws.js, line 1250

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.getDataTypeProperty('robtarget');

getDataTypeStructure(typeUrl) → {Promise.<any>}

Get the data structure of the specified RAPID data type

Parameters:

Name	Type	Description
`typeUrl`	string	The URL of the data type.

Source: ecosystem-rws.js, line 1289

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.getDataTypeStructure();

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

Gets the RAPID module text.

Parameters:

Name	Type	Description
`moduleName`	*	The module name.
`taskName`	*	The task name.

Source: ecosystem-rws.js, line 1059

Returns:

An object containing the structure { change-count, module-length, module-text?, file-path?, _title, _type, }

Type:: Promise.<any>

Example

const moduleText = await API.RWS.RAPID.getModuleText('MyModule', 'T_ROB1');

getPointersInfo(taskNameopt) → {Promise.<any>}

Gets the information of program pointers

Parameters:

Name	Type	Attributes	Description
`taskName`	string	<optional>	The task name.

Source: ecosystem-rws.js, line 1201

Returns:

Type:: Promise.<any>

Example

const pointersInfo = await API.RWS.RAPID.getPointersInfo('T_ROB1');

getRecordTypes(task) → {Promise.<any>}

Gets the RECORD data list.

Parameters:

Name	Type	Description
`task`	string	The task name.

Source: ecosystem-rws.js, line 1271

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.getRecordTypes()

getServiceRoutines(exturl, allread) → {Promise.<any>}

Gets the service routines.

Parameters:

Name	Type	Description
`exturl`	string	External URL for the service routines.
`allread`	boolean	Indicates whether to include all the readable routines.

Source: ecosystem-rws.js, line 1329

Returns:

Type:: Promise.<any>

getTaskChangeMonitor(taskName) → {Promise.<object>}

Gets an instance of a API.RAPID.TaskChangeMonitor class

Parameters:

Name	Type	Description
`taskName`	string	Task name

Source: ecosystem-rws.js, line 1458

Returns:

API.RAPID.TaskChangeMonitor

Type:: Promise.<object>

Example

let taskChangeMonitor = await API.RWS.getTaskChangeMonitor();
const taskchangeCb = function (data) {
   console.log('RAPID is changed');
 };
taskChangeMonitor.addCallbackOnChanged(taskchangeCb);
taskChangeMonitor.subscribe()

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

Gets the raw value of a RAPID variable.

Parameters:

Name	Type	Description
`moduleName`	string	The module name.
`variableName`	string	The variable name.
`taskName`	string	The task name.

Source: ecosystem-rws.js, line 1307

Returns:

Type:: Promise.<string>

Example

await API.RWS.RAPID.getVariableRawValue('TestModule', 'TestVariable', 'T_ROB1');

loadModule(path, replaceopt, taskNameopt, requestMshopt) → {Promise.<any>}

Loads a module from the HOME directory of the controller into the specified task.

Parameters:

Name	Type	Attributes	Description
`path`	string		Path to the module file in the HOME directory (including the file extension).
`replace`	boolean	<optional>	If the value is 'true', existing module in RAPID with the same name will be replaced.
`taskName`	string	<optional>	The task name.
`requestMsh`	boolean	<optional>	Edit mastership needs to be requested before loading the module.

Source: ecosystem-rws.js, line 994

Returns:

Type:: Promise.<any>

Example

let url = `${this.path}/${this.name}${this.extension}`;
await API.RWS.RAPID.loadModule(url, true, 'T_ROB1');

movePPToCursor(moduleName, taskName, line, column) → {Promise.<any>}

Moves the program pointer to a specified cursor position.

Parameters:

Name	Type	Description
`moduleName`	string	The module name.
`taskName`	string	The task name.
`line`	string	Number of the line to which the pointer is desired.
`column`	string	Number of the column to which the pointer is desired.

Source: ecosystem-rws.js, line 1149

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.movePPToCursor('MyModule', 'T_ROB1', '10', '5');

setCycleMode(mode) → {Promise.<any>}

Sets the cycle mode for the program execution.

Parameters:

Name	Type	Description
`mode`	string	Cycle mode, e.g., 'once' or 'forever'.

Source: ecosystem-rws.js, line 1349

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.setCycleMode('forever');

setModuleText(moduleName, text, taskNameopt) → {Promise.<any>}

Sets the content of a RAPID module.

Parameters:

Name	Type	Attributes	Description
`moduleName`	string		The module name.
`text`	string		The new content of the module.
`taskName`	string	<optional>	The task name.

Source: ecosystem-rws.js, line 1089

Returns:

Type:: Promise.<any>

Example

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

setModuleTextInRange(moduleName, text, startRow, startCol, endRow, endCol, taskNameopt, replaceModeopt) → {Promise.<any>}

Sets the content of a RAPID module within a specified range.

Parameters:

Name	Type	Attributes	Description
`moduleName`	string		The module name.
`text`	string		The new content to insert.
`startRow`	number		Start row of the range.
`startCol`	number		Start column of the range.
`endRow`	number		End row of the range.
`endCol`	number		End column of the range.
`taskName`	string	<optional>	The task name.
`replaceMode`	string	<optional>	Replace mode, e.g., 'Replace'.

Source: ecosystem-rws.js, line 1120

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.setModuleTextInRange(
  'MyModule',
  'TPErase;',
  5,
  1,
  10,
  1,
  'T_ROB1',
  'Replace'
);

setPPToRoutine(moduleName, routineName, taskNameopt) → {Promise.<any>}

Sets the program pointer to a specified routine.

Parameters:

Name	Type	Attributes	Description
`moduleName`	string		The module name.
`routineName`	string		Routine's name.
`taskName`	string	<optional>	The task name.

Source: ecosystem-rws.js, line 1176

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.setPPToRoutine('MyModule', 'MainRoutine', 'T_ROB1');

syncPers(moduleName, taskNameopt) → {Promise.<any>}

Synchronizes the value of persistent variables in a specified module.

Parameters:

Name	Type	Attributes	Description
`moduleName`	string		The module name.
`taskName`	string	<optional>	The task name.

Source: ecosystem-rws.js, line 1225

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.syncPers('MyModule', 'T_ROB1');

unloadModule(moduleName, taskNameopt, requestMshopt) → {Promise.<any>}

Unloads a RAPID module.

Parameters:

Name	Type	Attributes	Description
`moduleName`	string		The module name.
`taskName`	string	<optional>	The task name.
`requestMsh`	boolean	<optional>	Edit mastership needs to be requested before unloading the module.

Source: ecosystem-rws.js, line 1024

Returns:

Type:: Promise.<any>

Example

await API.RWS.RAPID.unloadModule('MyModule', 'T_ROB1');