ConneX_Help.pdf - 第79页

D MS Be l o w, you wi ll fi nd the MQTT eve nts t hat are pub l i she d / sub sc ri b e d r e l ati ng t o DMS : M ess ag e D escrip t ion Be g i n Dow nl o ad Eve nt fi re d whe n DMS be gi ns a jo b do wn lo a d. End D…

100%1 / 86
Type:
enum
Represents the possible return values for the job run state of xH700.
State Description
JobIdle
The job has not been started.
JobPaused
The job is paused.
JobRunning
The job is running.
JobStopped
The handler encountered an error and cannot continue the job.
DMS
Below, you will find the MQTT events that are published/subscribed relating to DMS:
Message Description
Begin DownloadEvent fired when DMS begins a job download.
End Download Event fired when DMS completes a job download.
Begin Download
Topic:
dms/jobs/begindownload/{hostname}/{jobname}
Event fired when DMS begins a job download.
Level Description
hostnameThe hostname of the PC that DMS is running on.
jobname The name of the job.
Fields
Name Description
DownloadSize (
ulong
)The size of the job in bytes.
End Download
Topic:
dms/jobs/enddownload/{hostname}/{jobname}
Event fired when DMS begins a job download.
Level Description
hostnameThe hostname of the PC that DMS is running on.
jobname The name of the job.
Fields
Name Description
Success (
bool
)Whether or not the download was sucessful.
Programmer
Below, you will find the MQTT events that are published/subscribed relating to a programmer:
Message Description
Adapter Inserted Event fired when an adapter is inserted into a programmer.
Adapter Removed Event fired when an adapter is removed from a programmer.
Programmer ConnectedEvent fired when a programmer connects to the system.
Programmer Offline Event fired when a programmer goes offline.
Programmer Online Event fired when a programmer comes online.
Programmer Removed Event fired when a programmer disconnects from the system.
Programming CompleteEvent fired when a programmer completes a programming cycle.
Adapter Inserted
Topic:
programmers/adapter/inserted/{programmerserialnumber}/{adapterserialnumber}
Event fired when an adapter is inserted into a programmer.
Level Description
programmerserialnumberThe programmer's unique serial number.
adapterserialnumber The adapter's unique serial number.
Fields
Name Description
AdapterId (
string
) The adapter's identifier (e.g. 110008).
AdapterIndex (
int
) The adapter's index position.
SocketInformation (
[SocketInfo]
])The socket information for the adapter.
Adapter Removed
Topic:
programmers/adapter/removed/{programmerserialnumber}/{adapterserialnumber}
Event fired when an adapter is inserted into a programmer.
Level Description
programmerserialnumberThe programmer's unique serial number.
adapterserialnumber The adapter's unique serial number.
Fields
Name Description
AdapterId (
string
)The adapter's identifier (e.g. 110008).
AdapterIndex (
int
)The adapter's index position.
Programmer Connected
Topic:
connex/programmer/{programmertype}/legacy/connected
Event fired when a programmer establishes a connection to the system.
Level Description
programmertypeThe type of programmer that connected to the system: LumenX or FlashCore.
Fields
Name Description
Adapters (
[AdapterInformation]
])The adapters that are inserted in the programmer.
HandlerIdentifier (
string
) The Unique ID of the system handler that the programmer connected to.
IpAddress (
string
) The programmer's IP address.