Ptburn sdk

3.2RobotName.txt Status Files

Besides the SystemStatus.txt file, PTBurn will also create a more detailed status file for each robot; the name of the file(s) will be RobotName.txt (e.g. Disc Publisher SE.txt).

The structure of this status file will be similar to an .INI file with three fixed Sections of [JobList], [CompletedJobs], and [System]. Also, each job will have its own Section (section name is the name of the Job Request File without an extension) with detailed information of the job.

3.2.1Example of RobotName.txt (e.g. Disc Publisher XRP.txt)

[System]

SystemStatus=System OK

RoboFWVer=4.07 03/24/2008

SerialNum=2091200229

DateManf=3/27/2010

SystemDesc=Disc Publisher XRP

SystemDrives=2

GoodDiscsLaunch=1

BadDiscsLaunch=0

GoodDiscsLife=5

BadDiscsLife=0

SysErrorString=No Errors

SysErrorNumber=0

DriveDesc0=PLEXTOR DVDR PX-716A 1.09

DriveLetter0=H

DriveLocation0=Bottom Recorder

DriveDesc1=PLEXTOR DVDR PX-716A 1.09

DriveLetter1=F

DriveLocation1=Top Recorder

DriveState0=0

DrivePercent0=0

DriveJob0=None

DriveDisc0=None

DriveState1=0

DrivePercent1=0

DriveJob1=None

DriveDisc1=None

DiscsInLeftBin=6

DiscsInRightBin=4

CartridgeType0=2

CartridgeFill0=96

CartridgeType1=1

CartridgeFill1=95

[Top Recorder]

BadDiscs=3

GoodDiscs=4

ReadingErrors=0

ReadingErrorsMedia=0

RecordingErrors=0

RecordingErrorsMedia=0

VerifyingErrors=0

VerifyingErrorsMedia=0

DriveNotReady=0

[Bottom Recorder]

GoodDiscs=0

BadDiscs=0

ReadingErrors=0

ReadingErrorsMedia=0

RecordingErrors=0

RecordingErrorsMedia=0

VerifyingErrors=0

VerifyingErrorsMedia=0

DriveNotReady=0

[JobList]

Job0=DataJob_Test1

[DataJob_Test1]

JobsAhead=0

DiscsAhead=0

CurrentStatus=Loading Disc 0

CurrentStatusState=4

TimeStarted=06/06/2008 14:06:12

GoodDiscs=0

BadDiscs=0

DiscsRemaining=1

JobState=1

LoadDiscState0=0

LoadDiscDrive0=F

[CompletedJobs]

Job0=DataJob_ClosedDisc

[DataJob_ClosedDisc]

JobsAhead=0

DiscsAhead=0

CurrentStatus=The job is complete...

CurrentStatusState=10

TimeStarted=06/05/2008 17:14:49

GoodDiscs=1

BadDiscs=0

DiscsRemaining=0

JobState=2

TimeCompleted=06/05/2008 17:16:13

Below is a description of each section and key available in RobotName.txt.

3.2.2JobList Section

The first fixed section in RobotName.txt is [JobList]

Within this section are keys that can provide the list of the current jobs being processed by PTBurn. The Key value of the current job is always Job0, the next job is Job1, etc.

So, an example might be:
[JobList]

Job0=MyJob1

Job1=YourJob1

Job2=MyJob2

The client can display the list of jobs by sequentially trying to get the string values for Keys: Job0, Job1, Job2,… The end of the list of jobs can be determined by the client when the string value for the next key is not found. This section may not exist if no jobs are currently running.

3.2.3CompletedJobs Section

The second fixed section in RobotName.txt is [CompletedJobs]

Within this section are keys that can provide a client the list of the recently completed jobs (including successful jobs, jobs with errors, and jobs that have been aborted). The Key value of the current job is always Job0, the next job is Job1, etc.

So, an example might be:
[CompletedJobs]

Job0=MyJob3

Job1=YourJob4

Job2=MyJob5

The client can display the list of jobs by sequentially trying to get the string values for Keys: Job0, Job1, Job2,… The end of the list of jobs can be determined by the client when the string value for the next key is not found.

3.2.4Job Details Section

More detailed information about each job in [JobList] and [CompletedJobs] can be accessed in the job’s own Section.

For example, if a submitted job is called MyJob1.jrq, then the section in the status file would be given as [MyJob1].

The keys under each job’s details section are:

3.2.4.1JobID

String that the describes this job

3.2.4.2ClientID

String that describes the client of this job

3.2.4.3JobsAhead

Integer value that tells how many jobs are in the PTBurn queue before this job.

3.2.4.4DiscsAhead

This integer value tells how many discs remain to be completed (in other jobs) before this job can begin.

3.2.4.5DiscsRemaining

Integer value that tells how many discs are remaining to be completed in this job.

3.2.4.6GoodDiscs

Integer value that tells how many discs have been successfully completed in this job

3.2.4.7BadDiscs

Integer value that tells how many discs that have failed to be completed successfully in this job (rejects)

3.2.4.8CurrentStatus

String that describes what is currently going on with this job.

3.2.4.9TimeCreated

String that gives the time and date of when the Job Request File was created
Format is:

MM/DD/YYYY hh:mm:ss XX

where XX is either AM or PM.

3.2.4.10TimeStarted

String that gives the time and date of when the job was started.
Format is:

MM/DD/YYYY hh:mm:ss XX

where XX is either AM or PM.
If not started yet the value is blank space

3.2.4.11TimeCompleted

String that gives the time and date of when the job was completed.
Format is:

MM/DD/YYYY hh:mm:ss XX

where XX is either AM or PM.
If not completed yet the value is blank space

3.2.4.12JobState

Integer values that give the state of the job:
0 = Job not started

1 = Job running

2 = Job completed successfully

3 = Job failed

4 = Job moved

3.2.4.13JobErrorNumber

Integer value that details what job error has occurred. Please see Appendix C for details on job errors.

3.2.4.14JobErrorString

String corresponding to the JobErrorNumber. Please see Appendix C for details on job errors.

3.2.4.15DiscErrorIndexX

Integer value that details which disc in the job had the error. In other words, the disc number within the job that the software is attempting to record (e.g. the first disc of the job = 1, second disc of the job = 2, etc.).
X is a value from 0 to 9 that provides a sequential unique key.

So, the first disc error that is encountered in the job will be given the key value of DiscErrorIndex0, the second disc error (within the same job) will be given the key value of DiscErrorIndex1, and so on. The number of disc errors reported is limited to 10 so the values for this key can range from DiscErrorIndex0 up to DiscErrorIndex9.

A disc may have more than 1 error reported if the disc was retried. Example:

A job is set to record 3 copies of a disc:

Disc 1 is recorded successfully.

Disc 2 is recorded successfully.

Disc 3 fails to record two times before successfully burning on

its third attempt.

In this example, the entries for this job will be:

DiscErrorIndex0 = 3

DiscErrorIndex1 = 3

3.2.4.16DiscErrorNumberX

Integer value that details what disc error has occurred. Please see Appendix C for details on disc errors and the potential values.
X is a value from 0 to 9 that provides a sequential unique key.

So, the first disc error that is encountered in the job will be given the key value of DiscErrorNumber0, the second disc error (within the same job) will be given the key value of DiscErrorNumber1, and so on. The number of disc errors reported is limited to 10 so the values for this key can range from DiscErrorNumber0 up to DiscErrorNumber9.

3.2.4.17DiscErrorStringX

String corresponding to the DiscErrorNumber. Please see Appendix C for details on disc errors and the possible strings.
X is a value from 0 to 9 that provides a sequential unique key.

So, the first disc error that is encountered in the job will be given the key value of DiscErrorString0, the second disc error (within the same job) will be given the key value of DiscErrorString1, and so on. The number of disc errors reported is limited to 10 so the values for this key can range from DiscErrorString0 up to DiscErrorString9.

3.2.4.18LoadDiscStateX

If the LoadUnloadOverride key is set in the jrq file then PTBurn will report the current state of this disc with this key. X is a value from 0 to the number of drives in the robot (ie. 0 for the first drive, 1 for the second drive).

See Appendix D for an example of use. The possible values for this key are:

-1 = Not In Use

0 = Disc Loading

1 = Disc Loaded (hold state)

2 = Disc Processing

3 = Disc Processed (hold state)

4 = Disc Unloading/Unloaded

3.2.4.19LoadDiscDriveX

If the LoadUnloadOverride key is set in the jrq file then PTBurn will report the drive letter that is processing the disc. X is a value from 0 to the number of drives in the robot (ie. 0 for the first drive, 1 for the second drive).

See Appendix D for an example of use.

3.2.4.20CurrentStatusState

This is a numerical value to describe what is going on with this job. This value can be used instead of CurrentStatus (section 3.2.4.8) if you would rather display your own status string based on this value. The possible numerical values for this key are:
0 = Recording Disc

1 = Reading Disc

2 = Verifying Disc

3 = Printing Disc

4 = Loading Disc

5 = Unloading Disc

6 = Waiting for Printer

7 = Waiting for Recorder

8 = Finishing Disc

9 = Rejecting Disc

10 = Job Complete

11 = Job Paused

12 = Job Resumed

13 = Job Aborted

14 = Job Initializing

15 = Job Failed

16 = Pre-Mastering

17 = System OK

3.2.5System Section

The final fixed section in RobotName.txt is [System]

Within this section are keys that can provide more detailed system information for the robot in question. Some of these keys are duplicated from SystemStatus.txt.

3.2.5.1SystemDesc

String that describes the system (e.g. Disc Publisher DVDR)

3.2.5.2SystemStatus

String that gives general system status of the robotics (e.g. Offline, System OK, Out of Discs, Ink Low, …).
If the software is running but the printer is offline (user pressed the power button) then the SystemStatus will be “Printer Offline”. For this error, and other system errors, the SysErrorNumber key can be queried. See more information for SysErrorNumber below.

3.2.5.3SystemDrives

Integer value that tells how many drives are managed by the robotics. (for the Disc Publisher this will be 1).

3.2.5.4GoodDiscsLife

Integer value that tells how many discs have been successfully completed in the life of this system (value is stored on the computer – not within the robotics).

3.2.5.5BadDiscsLife

Integer value that tells how many discs have been rejected because of failure during the life of this system (value is stored on the computer – not within the robotics).

3.2.5.6GoodDiscsLaunch

Integer value that tells how many discs have been successfully completed since the PTBurn application was launched.

3.2.5.7BadDiscsLaunch

Integer value that tells how many discs have been rejected because of failure since the PTBurn application was launched.

3.2.5.8SysErrorString

String corresponding to the SysErrorNumber. Please see Appendix C for details on system errors.

3.2.5.9SysErrorNumber

Integer value that details what error has occurred on the system. Please see Appendix C for more details on system errors.

3.2.5.10RoboFWVer

String that contains the version of the firmware on the duplicator.

3.2.5.11DriveDescX

String that contains the description of robotically controlled drives on the system. The X represents an index if multiple robotically controlled drives are present. Below is an example of the drive description key :
DriveDesc0 = PIONEER DVD-RW DVR-105 1.30

3.2.5.12DriveLetterX

String that contains the system drive letter of the robotically controlled drive(s). The X represents an index if multiple robotically controlled drives are present. Below is an example of the drive letter key :
DriveLetter0 = F

DriveLetter1 = G

3.2.5.13DriveLocationX

String that contains the location of robotically controlled drives on the system. The X represents an index if multiple robotically controlled drives are present. Below is an example of the drive location key :
DriveLocation0 = Top Recorder

DriveLocation1 = Bottom Recorder

3.2.5.14DriveStateX

Number that contains the state of the robotically controlled drive(s) on the system. The X represents an index if multiple robotically controlled drives are present. The available values are:
0 = Idle

1= Recording

2= Reading

3= Verifying

4= Disc Loaded

5= Verify Failed

6= Verify Complete

7= Record Failed

8= Record Complete

3.2.5.15DrivePercentX

Number that contains the percent complete (0-100) of the drive state that the recorder is currently processing. The X represents an index if multiple robotically controlled drives are present.

3.2.5.16DriveJobX

String that contains the name of the job that the recorder is currently assigned to. The X represents an index if multiple robotically controlled drives are present.

3.2.5.17DriveDiscX

Number that contains the disc number in the job that the recorder is currently assigned to. The X represents an index if multiple robotically controlled drives are present.

3.2.5.18DiscsInRightBin

Number that contains the number of discs in the Right Bin. If this value is -1 then the number is unknown. This value is updated each time a disc is picked from a bin. The user can also send the “Check Bins” command to force an update of this value.

3.2.5.19DiscsInLeftBin

Number that contains the number of discs in the Left Bin. If this value is -1 then the number is unknown. This value is updated each time a disc is picked from a bin. The user can also send the “Check Bins” command to force an update of this value.

3.2.5.20CartridgeTypeX

Contains the type of CartridgeX. The X will be replaced with a value. CartridgeType0 represents the leftmost cartridge. If the robot contains a second cartridge, CartridgeType1 represents the right cartridge.
The potential values for this key are listed below.

CARTRIDGE_NONE 0

CARTRIDGE_COLOR 1

CARTRIDGE_BLACK 2

CARTRIDGE_YELLOW 3

CARTRIDGE_CYAN 4

CARTRIDGE_MAGENTA 5

CARTRIDGE_COLORLOTUS 6

NOTES:

Values 3, 4, & 5 are for robots that have individual color ink cartridges (ie. Robots with 4 separate ink tanks). For better backward compatibility, robots with four ink cartridges will actually record five CartridgeType values like this:

CartridgeType0 = 2  Black

CartridgeType1 = 1  Color

CartridgeType2 = 3  Yellow

CartridgeType3 = 4  Cyan

CartridgeType4 = 5  Magenta

CartridgeType0 = 6  Color

3.2.5.21CartridgeFillX

Number that contains the percent fill of the cartridge. The X will be replaced with a value. CartridgeFill0 represents the leftmost cartridge. If the robot contains a second cartridge, CartridgeFill1 represents the right cartridge fill percent.
This value is a percent with values from 0-100%
NOTE: For better backward compatibility, robots with four ink cartridges will actually record five CartridgeFill values like this example:

CartridgeFill0 = 91  Black

CartridgeFill1 = 37  Color (this will be the lowest value of Yellow, Magenta, & Cyan)

CartridgeFill2 = 59  Yellow

CartridgeFill3 = 37  Cyan

CartridgeFill4 = 100  Magenta

CartridgeFill0 = 37  Color (this will be the lowest value of Yellow, Magenta, & Cyan)

3.2.5.22SerialNum

Serial number of the unit. This key is only valid on Disc Publisher se, Disc Publisher PRO and Disc Publisher XRP

3.2.5.23DateManf

Date the unit was manufacturered. This key is only valid on Disc Publisher SE, Disc Publisher PRO and Disc Publisher XRP

3.2.6Drive Statistics Section

There is a drive statistics section for each robotic drive. The name of the section can be obtained from the DriveLocationX key (where X = 0 or 1).

e.g.

DriveLocation0 = Top Recorder

DriveLocation1 = Bottom Recorder

In this example, the RobotName.txt file would contain two sections for drive statistics:

[Top Recorder]

[Bottom Recorder]
The contents of each drive statistics section is described here:

3.2.6.1GoodDiscs

The number of good discs produced by this drive.

3.2.6.2BadDiscs

The number of bad discs produced by this drive.

3.2.6.3ReadingErrors

The number of bad discs (produced by this drive) that were a result of reading errors that weren’t media related (ie. not Sense 03)

3.2.6.4ReadingErrorsMedia

The number of bad discs (produced by this drive) that were a result of reading errors that were media related (ie. Sense 03)

3.2.6.5RecordingErrors

The number of bad discs (produced by this drive) that were a result of recording errors that were not media related (ie. not Sense 03)

3.2.6.6RecordingErrorsMedia

The number of bad discs (produced by this drive) that were a result of recording errors that were media related (ie. Sense 03)

3.2.6.7VerifyingErrors

The number of bad discs (produced by this drive) that were a result of verifying errors that were not media related (ie. not Sense 03).

3.2.6.8VerifyingErrorsMedia

The number of bad discs (produced by this drive) that were a result of verifying errors that were media related (ie. Sense 03)

3.2.6.9DriveNotReady

The number of bad discs (produced by this drive) that were a result of the drive not becoming ready.