RobotMove method

Event

A robot is about to move away from its current location and to a new location.

Description

VWorks software calls the RobotMove method when a robot is about to move away from its current location and to a new location.

Syntax

 

HRESULT RobotMove( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] A RobotMove XML element containing information about the robot that is about to move away from its current location and to a new location.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

RobotMove method input

VWorks software passes a RobotMove XML element into the sXML parameter of the RobotMove method. This XML element provides information about the robot that is about to move away from its current location and to a new location.

RobotMove element

The RobotMove element has the following attributes:

 

Name	Value
RobotName	The robot name.
InstanceNumber	The labware instance number.
ProcessName	The labware name.
FromDeviceName	The name of the device that the robot moved away from.
FromLocationName	The name of the location from which the robot moved away.
FromTeachpointName	The name of the teachpoint from which the robot moved away.
ToDeviceName	The name of the device to which the robot moved.
ToLocationName	The name of the location to which the robot moved.
ToTeachpointName	The name of the teachpoint to which the robot moved.

Example of RobotMove method input

The following sample code is a RobotMove XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the RobotMove method. VWorks software tells the plugin that the robot named Phantom Robot ‑ 1 moved from the location named Stage on the device named PlatePad ‑ 1 to the location named Hole on the device named WasteBin ‑ 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='6efb2bf07f7229a5bf9a47007cbf76b8' version='1.0' > <RobotMove FromDeviceName='PlatePad - 1' FromLocationName='Stage' FromTeachpointName='robot teachpoint' InstanceNumber='1' ProcessName='process - 1' RobotName='Phantom Robot - 1' ToDeviceName='WasteBin - 1' ToLocationName='Hole' ToTeachpointName='robot teachpoint' /> </Velocity11>

RobotMove method output

The plugin returns a HookResults XML block in the sResultXML parameter of the RobotMove method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of RobotMove method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the RobotMove method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

Phantom Robot ‑ 1 is about to move from Stage on PlatePad ‑ 1 to Hole on WasteBin ‑ 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='Phantom Robot - 1 is about to move from Stage on PlatePad - 1 to Hole →on WasteBin - 1.' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”