ConneX_Help.pdf - 第76页

Ab or t J ob Se ssion Topic: command/x h700/abortjob/ {hostname}/{xh sessionid} Instruct x H70 0 to e nd a j o b se ssi o n. x H700 do e s not pi c k anymo re d e vic es fro m inp ut, fi ni she s the curre nt de vi c e s…

100%1 / 86
Fields
Name Description
Role
(
enum
) The user's
UserRole
Username
(
string
)Username of the newly created user.
User Deleted
Topic:
xh700/users/delete/{hostname}/{xhsessionid}
Event fired when an xH700 user is deleted.
Level Description
hostname
The hostname of the PC that xH700 is running on.
xhsessionid
The session ID for the current instance of xH700.
Fields
Name Description
Username
(
string
)Username of the deleted user.
User Login
Topic:
xh700/users/login/{hostname}/{xhsessionid}
Event fired when a user attempts to log in to xH700.
Level Description
hostname
The hostname of the PC that xH700 is running on.
UserSessionID
The session ID for the current user of xH700.
xhsessionid
The session ID for the current instance of xH700.
Fields
Name Description
Success
(
bool
) Indicates whether or not the login was successful.
Username
(
string
)Username of the user who attempted to log in.
User Logout
Topic:
xh700/users/logout/{hostname}/{xhsessionid}
Event fired when a user logs out of xH700.
Level Description
hostname
The hostname of the PC that xH700 is running on.
xhsessionid
The session ID for the current instance of xH700.
Fields
Name Description
Username
(
string
)Username of the user who logged out.
Commands
References to "x" (in "xh700" and "xhsessionid") below, should be replaced with "a" or "c" when sending commands to AH700 or CH700.
Below are the commands that can be used to control xH700:
Command Description
Abort Job SessionInstruct xH700 to end a job session.
Pause Job Session
Instruct xH700 to pause a job session.
Abort Job Session
Topic:
command/xh700/abortjob/{hostname}/{xhsessionid}
Instruct xH700 to end a job session. xH700 does not pick anymore devices from input, finishes the current devices in the work-envelope,
then stops.
Level Description
hostname
The hostname of the PC that should be paused.
xhsessionid
The session ID that should be paused.
Pause Job Session
Topic:
command/xh700/pausejob/{hostname}/{xhsessionid}
Instruct xH700 to pause a job session.
Level Description
hostname
The hostname of the PC that should be paused.
xhsessionid
The session ID that should be paused.
Types
Types that different fields can return.
HandlerErrorCode
Type:
enum
Represents the possible handler error codes assigned to rejected devices.
StateDescription
3
Device programming error.
12
Recurrent Empty Socket Test (REST) error; The device is not programmed.
15
Device laser marking error.
17
Device continuity error.
200
Device position inspection error.
201
Device 3D inspection error.
InspectionResult
Type:
string
Represents the possible return values of a device inspection operation:
Fail CodeDescription
201
3D inspection failure.
901
2D inspection failure, unexpected device in pocket.
902
2D inspection failure, device not detected.
903
2D inspection failure, device detected but failed inspection.
904
2D inspection timeout failure.
PASS 2D
Device passed 2D inspection
PASS 3D
Device passed 3D inspection
Location
Type:
string
Represents a physical location inside a PSV system.
Location Description
Laser
The laser marking device.
Programmer
A programmer (e.g. FlashCORE or LumenX).
Tape
An input/output tape.
Tray
An input/output tray.
Tube
An input/output tube.
MachineType
Type:
enum
Represents the type of PSV system.
Location Description
Desktop Mode
System is running in desktop mode.
PSV3000
System is a PSV3000 machine.
PSV5000
System is a PSV5000 machine.
PSV7000
System is a PSV7000 machine.
OperationStatus
Type:
string
Represents the possible return values for a pass/fail operation
PositionDescription
Fail
Operation was unsuccessful.
Pass
Operation was successful.
TowerState
Type:
string
Represents the possible return values for tower statuses.
State Description
Alternating Green-Yellow
Light tower is alternating between green and yellow lamps illuminated.
Alternating Yellow-Red
Light tower is alternating between yellow and red lamps illuminated.
Alternating Yellow-Red with alarm
Light tower is alternating the yellow and red lamp and emitting an audible alarm.
Flashing Red
Light tower is flashing the red lamp exclusively.
Flashing red with alarm
Light tower is flashing the red lamp exclusively and emitting an audible alarm.
Flashing Yellow
Light tower is flashing the yellow lamp exclusively.
Flashing Yellow with alarm
Light tower is flashing the yellow lamp exclusively and emitting an audible alarm.
Green
Light tower has only the green lamp illuminated.
Off
Light tower is off.
Red
Light tower has only the Red lamp illuminated.
Yellow
Light tower has only the yellow lamp illuminated.
UserRole
Type:
enum
Represents the possible return values for a user's role.
Position Description
Operator
User has operator level permissions.
Service
User has service level permissions.
Supervisor
User has supervisor level permissions.
RunState