Mover ID Get Scan Location

This command is used to get the location to manually scan the XBot’s XID when using Absolute ID. The PMC has to be activated in manual mode and its state should be DISCOVERY.

Fieldbus Interface

PMC_MoverID_GetScanLocation

Inputs

Name	Data Type	Description
Execute	BOOL	Execution of the function block begins on a rising edge of this input.
XbotID	USINT	ID of the XBot. Real XBot IDs [1,78].
Orientation	USINT	0: East, 1: North, 2: West, 3: South
PM_Controller	PMControllerType	Data structure that specifies which PMC to connect to. There should be only 1 instance of this variable for each connected PMC.

Outputs

Name	Data Type	Description
Done	BOOL	Execution successful. Function block is finished. (Note: Done will not become TRUE if Execute is already FALSE)
Busy	BOOL	Function block is active and must continue to be called.
Aborted	BOOL	Command aborted by another command.
Error	BOOL	If there is an error in processing the command, then Error = TRUE, otherwise, FALSE.
ErrorID	UINT	0x0: All OK. Otherwise, please see Fieldbus Reply Codes.
ScanLocationX	REAL	X coordinate for the manual ID scan
ScanLocationY	REAL	Y coordinate for the manual ID scan

Ethernet Interface

GetXIDScanLocationRtn GetXIDScanLocation(int xbotID, XBOTORIENTATION orientation)

Parameters

Name	Type	Description
xbotID	int	ID of the XBot. Real XBot IDs [1,78].
orientation	enum	Deg_0 (0); Deg_90 (1); Deg_180 (2); Deg_270 (3)

Returns

Name	Type	Description
GetXIDScanLocationRtn.PmcRtn	PMCRTN enum	ALLOK (0): Command Accepted. Otherwise, please see Ethernet Reply Codes.
GetXIDScanLocationRtn.XPos	double	X coordinate for the manual ID scan
GetXIDScanLocationRtn.YPos	double	Y coordinate for the manual ID scan

Conditions

Operating Conditions
Preconditions	PMC state is DISCOVERY.
Postconditions	XBot’s XID scan location is provided in the output.

Description

This command is used to get the location to manually scan the XBot’s XID when using Absolute ID. The PMC has to be activated in manual mode and its state should be DISCOVERY. The orientation of the XBot needs to be specified in order to get the correct scanning location.

Changelog

PMC v117.22.55 (Ethernet v117.12.02) - Command released in .NET library