ConneX_Help.pdf - 第75页

F i el d s Name D escription Role ( enum ) T he u ser' s UserRole Username ( string )Use rna me of t he new l y cre a ted user. U ser De le ted Topic: xh700/use rs/delete/{hos tname}/{xhsess ionid} Eve nt fi re d wh…

100%1 / 86
Special Properties
Retained
System Statistics
Topic:
xh700/systemstatistics/{hostname}/{xhsessionid}
Event fired periodically providing the current system statistics.
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
DevicesFailedOn3DSystem
(
int
)The number of devices that failed as a result of the 3D system.
DevicesFailedOnLaser
(
int
) The number of devices that failed as a result of the laser.
DevicesFailedOnProgrammer
(
int
)
The number of devices that failed as a result of programming.
DevicesFailedREST
(
int
) The number of devices that failed recurrent empty socket test (REST).
DevicesFailedVision
(
int
) The number of devices that failed vision inspection.
DevicesPickedInput
(
int
) The number of devices picked from the input media.
HandlerYield
(
string
)
The percentage of devices that were picked from the input media and are placed in the output and reject
media.
JobAssistanceTime
(
string
) The job assistance time.
JobCompletionEstimate
(
string
)
The estimated job completion time.
JobProcessingTime
(
string
)
The job processing time.
ProgrammerYield
(
string
) The percentage of devices that passed programming.
SystemYield
(
string
) The percentage of devices that were picked from the input media and are placed in the output media.
TotalFail
(
int
) The number of devices that failed in the job session.
TotalPass
(
int
) The number of devices that passed in the job session.
UPH
(
int
) The job throughput (including operator intervention time) of the job session.
System Status
Topic:
xh700/systemstatus/{hostname}/{xhsessionid}
Event fired when the status of xH700 changes.
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
ErrorMessage
(
ErrorMessage
)The
ErrorMessage
) of the handler.
RunState
(
enum
) The
RunState
of the handler.
User Created
Topic:
xh700/users/create/{hostname}/{xhsessionid}
Event fired when an xH700 user is created.
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
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.