Home

PTRobot API

1. PTRobot API Page 29 of 41 define SYSERR_CART_MOVE 10 define SYSERR_INTERNAL_SW 1 define SYSERR_NO_ROBODRIVES 13 define SYSERR_OFFLINE 14 define SYSERR_COVER_OPEN 15 define SYSERR_PRINTER_PICK 16 define SYSERR_MULTIPLE_PICK 17 define SYSERR_MULTIPLEDISCS_IN_PRINTER 18 define SYSERR_MULTIPLEDISCS_IN_RECORDER 19 define SYSERR_DROPPED_DISC_RECORDER 20 define SYSERR_DROPPED_DISC_BIN1 28 define SYSERR_DROPPED_DISC_BIN2 29 define SYSERR_DROPPED_DISC_PRINTER 33 define SYSERR_DROPPED_DISC_REJECT 34 define SYSERR_DROPPED_DISC_UNKNOWN 35 define SYSERR_ALIGNNEEDED 36 define SYSERR_COLOR_INVALID 37 define SYSERR_BLACK_INVALID 38 define SYSERR_BOTH_INVALID 39 define SYSERR_NOCARTS 40 define SYSERR_K_IN_CMY 41 define SYSERR_CMY_IN_K 42 define SYSERR_SWAPPED 43 define SYSERR_PIGONPRO 44 define SYSERR_ALIGNFAILED 45 define SYSERR_DROPPED_DISC_PRINTER_FATAL 46 define SYSERR_MULTIPLEDISCS_IN_RIGHTBIN 47 define SYSERR_MULTIPLEDISCS_IN_LEFTBIN 48 define SYSERR_CLR_EMPTY_FINAL 49 define SYSERR_BLK_EMPTY_FINAL 50 define SYSERR_BOTH_EMPTY_FINAL 51 define SYSERR_WAITING_FOR_PRINTER 52 4 3 System State define SYSSTAT define SYSSTAT define SYSSTAT E_IDLE 0 E_BUSY 1 E_ERROR 2 4 4 Robot Type define define define define define define 4 5 Bin Auto ROBOT_DISCPUBLISHE ROBOT_DISCPUBLISHERII ROBOT_DISCPUBLISHE ROBOT_COMPOSERMAX
2. Li be Params A dwAppID Application ID specified by Primera Notes Via Return fd PTROBOT_OK if Successful ee PTROBOT_INTERNAL if an internal error occurred VLAAAAAAA AAA LAELIA IA LAL SDE DWORD WINAPI PTRobot_SetApplicationID DWORD dwAppID 2 2 PTRobot Info Status Functions 2 2 1 PTRobot_GetDrivelnfo IIDLLL LALA ALA AA ALA ALS Le PTRobot_GetDriveInfo of ce Description Function to get the drive info for a particular drive handle ff Params AR hDrive Handle to the drive from EnumDrives pDrvInfo points to a PTDrivelnfo structure Notes Return tf PTROBOT_OK if Successful re PTROBOT_SEQUENCE if this command is called out of sequence ES PTROBOT_INTERNAL if an internal error occurred dif PTROBOT_INVALID_DRIVE if the drive handle is invalid BILD AD ALTA ALAT HELA ALA ALAA ALAS DWORD WINAPI PTRobot_GetDriveInfo HANDLE hDrive PTDrivelnfo pDrvInfo 2 2 2 PTRobot_GetRobotinfo LULAT AUAA AIARA IAAI IITTI TAS be PTRobot_GetRobotInfo O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 15 of 41 e Le Fi eh Le d dd LE FZ 14 Li Description Function to get the robot info for a particular robot handle Params hRobot Handle to the robot from EnumRobots pRobotInfo po
3. ROBOT_RACKMOUNT_DP 11 ROBOT_DISCPUBLISHER_XRP Use define BIN_INPUT define BIN_OUTPUT ap WNE Oo Disc Publisher Disc Publisher Disc Publisher ComposerMAX Disc Publisher Disc Publisher II PRO XR XRP 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 30 of 41 4 6 Robot Options define PTOPT_KIOSKMOD CJ 4 7 Robot Actions define PTACT_ALIGNPRINTER define PTACT_IGNOREINKLOW define PTACT_DISABLEPWRBUTTON define PTACT_REINIT_DRIVES define PTACT_IDENTIFY define PTACT_CANCELCMD define PTACT_ENABLEPWRBUTTON define PTACT_RESETSYSTEM 4 8 Print Quality define PQ_LOW 0 define PQ MED 1 define PQ BETTER 2 define PQ HIGH 3 define PQ BEST 4 4 9 Drive Open Close define DRIVE_OPEN 0 define DRIVE_CLOSE T p 4 10 Locations define LOCATION_AUTO 0 define LOCATION_PRINTER 100 define LOCATION_REJECT 200 4 11 Bus Type define BUSTYPE_USB 0 define BUSTYPE_1394 I A 11 4 12 Clear Drive define CLEARDRIVE_NO 0 define CLEARDRIVE_YES I 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc
4. phDrives DWORD pdwNumDrives 2 1 6 PTRobot_EnumDrivesWithList e a IIA DIET DAT Ea Pie Je Lh Ll CE PE Le ve ea TE ou Jd Je we Le d UE Jb ta ou Ge oe Fi ee Le Ud Jd E oe ie i ae PTRobot_EnumDriveswithList Description Function to pass down drives enumerated by the calling app for PTRobot to use in determining which drives are robotically controlled This is an alternative function to PTRobot_EnumDrives Params Notes hRobot Handle to the robot phDrives points to an array of HANDLEs that contains the drive handles of the drives in the system pdwNumDrives points to a DWORD containing the number of HANDLEs in the phDrives array phRobotDrives points to an array of HANDLEs that contains the drive handles of the drives contained in this robot pdwNumRobotDrives points to a DWORD containing the number of drives in the phRobotDrives array phRobotDrives and pdwNumRobotDrives will be updated upon successful completion of this command phRobotDrives will contain handles to drives contained in the robot pdwNumRobotDrives will be updated with the number of drives found The format of the drive handle is the following The least significant byte should contain the drive letter the other three bytes should contain the SCSI triple The drive can be identified by either of these methods For Example 0x01030044 would identi
5. Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 37 of 41 5 26 SYSERR_COLOR_INVALID DiscPublisherPRO The color cartridge is invalid Open the cover and press the left button Change the cartridge and close the cover 5 27 SYSERR_BLACK_INVALID DiscPublisherPRO The black cartridge is invalid Open the cover and press the left button Change the cartridge and close the cover 5 28 SYSERR_BOTH_INVALID DiscPublisherPRO Both cartridges are invalid Open the cover and press the left button Change the cartridges and close the cover 5 29 SYSERR_NOCARTS DiscPublisherPRO No cartridges are installed Open the cover and press the left button Install the cartridges and close the cover 5 30 SYSERR_K_IN_CMY DiscPublisherPRO The black cartridge is installed in the color position Open the cover and press the left button Change the cartridge and close the cover 5 31 SYSERR_CMY_IN_K DiscPublisherPRO The color cartridge is installed in the black position Open the cover and press the left button Change the cartridge and close the cover 5 32 SYSERR_SWAPPED DiscPublisherPRO The black and color cartridges are swapped Open the cover and press the left button Swap the cartridges and close the cover 2005 Primera Technology Inc Primera is a regi
6. discs were placed in the right bin Please open the cover and manually move any extra discs to the left bin keeping a single disc in place Then close the cover to continue 5 37 SYSERR_MULTIPLEDISCS_IN_LEFTBIN DiscPublisherII PRO Multiple discs were placed in the left bin Please manually move any extra discs to the right bin keeping a single disc in place Then close the cover and press the left button DiscPublisher XR XRP Multiple discs were placed in the left bin Please open the cover and manually move any extra discs to the right bin keeping a single disc in place Then close the cover to continue 5 38 SYSERR_CLR_EMPTY_FINAL DiscPublisherPRO 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 39 of 41 WARNING The color cartridge is Empty To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning press the left button 5 39 SYSERR_BLK_EMPTY_FINAL DiscPublisherPRO WARNING The black cartridge is Empty To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning press the left button 5 40 SYSERR_BOTH_EMPTY_FINAL DiscPublisherPRO WARNING Bo
7. dwErrorNum System Error Number pwszErrorString Error string returned Note wide characters Calling application must allocate this memory dwMaxLength Length of buffer pointed to by pwszErrorString number of wide characters dwLanguage Language of string to return See Languages definitions above Notes dwErrorNum can be either dwSystemError from PTRobotStatus structure which is returned by PTRobot_GetRobotStatus or dwErrorNum can be an error returned from a PTRobot_xxxxx call e g PTROBOT_INVALID_ROBOT Return PTROBOT_OK if Successful PTROBOT_INVALID_LANG if language is invalid PTROBOT_INVALID_ERROR if error is invalid PTROBOT_INTERNAL if buffer is undersized etc ILLIA AAA AA AAA AAA AAA IAS SSS DWORD WINAPI PTRobot_GetErrorString HANDLE hRobot DWORD dwErrorNum WCHAR pwszErrorString DWORD dwMaxLength DWORD dwLanguage 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 14 of 41 2 1 12 PTRobot_SetApplicationiD VEPAEEPELEA LEP AV EPA TTT EF vad PTRobot_SetApplicationID El Description EL Function to set the Application ID AR The ID value is assigned for each application by Primera as needed Only applications that require special functionality will require this note most applications will not need this
8. is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 22 of 41 oe Notes Le If this function is not called the default print settings will be used This tf function will change the system default print settings th Starting with Version 1 2 0 the system default print settings will be ES restored after calling PTRobot_PrintFile or PTRobot_PrintFilewithMerge LL Return LL PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PL PTROBOT_INTERNAL if an internal error occurred LE PTROBOT_INVALID_ROBOT if the robot handle is invalid IZ PTROBOT_NO_PRINTER if the robot doesn t have a printer AS PTROBOT_INVALID_PRINTER_SETTINGS if the printer settings are invalid PEUELLEEITIECLI EIT EECA ISLE DWORD WINAPI PTRobot_SetPrinterSettings HANDLE hRobot PTPrinterSettings pPrinterSettings T 2 3 10 PTRobot_GetPrinterSettings A A rae ee PTRobot_GetPrinterSettings aa Description LE Function to get some printer driver settings te Params be hRobot Handle to the robot from EnumRobots A pPrinterSettings points to a PTPrinterSettings structure Za Notes PER If this function is not called the default print settings will be used Le Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence GL PTROBOT
9. list of drives passed in PTRobot_EnumDrivesWithlist PTRobot_GetDriveInfo for all drives returned This will allow the calling app to know which drive is which Example a typical job PTRobot_LoadDrive Robot Drive TRUE This will load a disc into the drive from the input bin should set parameter 3 to TRUE if first round of the job PTRobot_GetRobotStatus This would be called in a loop until a system error occurred or the system is idle Client application will now perform operations on the disc in the drive e g record on the disc if the operations are successful 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 6 of 41 PTRobot_LoadPrinterFromDrive Robo Drive PTRobot_GetRobotStatus called in a loop PTRobot_PrintFile szPrintFile or PTRobot_PrintFileWithMerge PTRobot_GetRobotStatus called in a loop PTRobot_UnloadPrinter Robot 0 PTRobot_GetRobotStatus called in a loop else PTRobot_UnloadDrive Robot Drive 100 PTRobot_GetRobotStatus called in a loop Before program exit PTRobot_Destroy O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 7 of 4
10. picked Press the left button on the unit to try again DiscPublisher XR XRP The disc was not picked Open and close the cover to try again 5 9 SYSERR_ARM_MOVE DiscPublisher I There was an arm movement error Press the left button on the unit to try again O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 34 of 41 5 10 SYSERR_CART_MOVE DiscPublisherI II PRO Arm picker error Press the left button on the unit to try again DiscPublisher XR XRP Arm picker error Open and close the cover to try again 5 11 SYSERR_INTERNAL_SW There was an internal software error Please re start the software 5 12 SYSERR_NO_ROBODRIVES No external recorder drives were found Re power the computer and unit and then re start the software 5 13SYSERR_OFFLINE The unit is offline Please ensure the unit is connected and powered on You may need to shut down and restart the software 5 14SYSERR_COVER_OPEN The unit s cover is open Please close the cover 5 15 SYSERR_PRINTER_PICK DiscPublisherI II PRO The disc was not picked from the printer Press the left button to retry DiscPublisher XR XRP The disc was not picked from the printer Open and close the cover to try again 5 16 SYSERR_MULTIPLE_PICK DiscP
11. the types 5 1 SYSERR_PTR_TRAY DiscPublisherI I Tray movement error Press the left button on the unit to try again DiscPublisher XR XRP Tray movement error Open and close the cover to try again 5 2 SYSERR_CART_CODE DiscPublisherI II DiscPublisher XR XRP There was a problem finding the ink cartridges Open the cover and press the left button Make sure the color cartridge is installed on the left and the black is on the right Then close the cover 5 3 SYSERR_INPUT_EMPTY DiscPublisherI II PRO The input bin is empty Open the cover and add more discs Then close the cover and push the left button on the unit DiscPublisher XR XRP The input bin is empty Open the cover add more discs and close the cover to continue 5 4 SYSERR_PTR_COMM DiscPublisherI II PRO There was an internal printer communications error Press the left button on the unit to try again DiscPublisher XR XRP There was an internal printer communications error Open and close the cover to try again 5 5 SYSERR_CLR_EMPTY DiscPublisherI II PRO WARNING The color cartridge is LOW on ink To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning press the left button 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trade
12. were left in the drive from a previous job Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_INVALID_DRIVE if the drive handle is invalid PTROBOT_INVALID_LOCATION if the location is invalid ELPARAR AAA ALEA IAEA IAS DWORD WINAPI PTRobot_LoadDrive HANDLE hRobot HANDLE hDrive DWORD dwFromLocation DWORD dwClearDrive 2 3 2 PTRobot_LoadPrinter VPAPISPPTIPPIOAT TEATS OPT TES Pe ie Fi Fh ve LE LE Z PTRobot_LoadPrinter Description Function to load the printer from an input bin location Params hRobot Handle to the robot from EnumRobots dwFromLocation DWORD containing the from location 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 18 of 41 ox Le ee LE Z Ed LE A Bue ie ie Notes LOCATION_AUTO Automatically choose the bin 1 Binl right most bin 2 Bin2 Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_NO_PRINTER if the robot doesn t have a printer PTROBOT_INVALID_LOCATION if the location is
13. 1 2 API Functions 2 1 PTRobot Setup Functions 2 1 1 PTRobot_Initialize SILISIIISILLLAL AAAS AALS El AR PTRobot_Initialize a Description Function to initialize internal data structures of ES the PTRobot module Params None PL Notes Pf Return Lh PTROBOT_OK if Successful te PTROBOT_INTERNAL if an internal error occurred a LLULLU ALLU LULLA DWORD WINAPI PTRobot_Initialize 2 1 2 PTRobot_Destroy e a A oe El PTRobot_Destroy aa Description Function to destroy internal data structures of ie the PTRobot module tif Params Le None d Notes Return ff PTROBOT_OK if Successful AR PTROBOT_SEQUENCE if this command is called out of sequence IA PTROBOT_INTERNAL if an internal error occurred LLLA LALALALA LLULLU ULLE DWORD WINAPI PTRobot_Destroy 2 1 3 PTRobot_SetupDebugging IISA AAA LAA AAA AAA AAA NAAA A EL EL PTRobot_SetupDebugging EL ER Description O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 8 of 41 PL ed Ed eS Ad LE Z d LE te ze Ll a Fi ve LE AA Function to setup logging in the PTRobot module We advise that your application has a back door method of turning debugging on All debugging is off by default Params szDbgFile full path to a debug fi
14. All other trademarks are the property of their respective companies 0x00000001 0x00000001 0x00000002 0x00000004 0x00000008 0x00000010 0x00000020 0x00000040 0x00000080 PTRobot API Page 31 of 41 4 13 Languages define ENGLISH PANESE RMAN define J define G F S D W m define ENCH define PANISH define ITALIAN Ow WNEe oo 4 14 Printer Tray Status define PRINT_TRAY_IN_WITH_DISC De define PRIN RAY_IN_NO_DISC ras define PRINT_TRAY_OUT OF 4 15 Disc Pick Switch Status define DISC_PICKER_NO_DISC Cx define DISC_PICKER_HAS DISC sol 4 16 Cartridge Types define CARTRIDGE_NONE 0 define CARTRIDGE_COLOR 1 define CARTRIDGE_BLACK 2 define CARTRIDGE_BOTH 3 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 32 of 41 5 Recommended System Error Strings Most applications will use PTRobot_GetErrorString to display system error messages However if you want to use your own error strings instead below are some suggested error strings for various system errors Some errors strings will vary depending on the robot type and not all errors are reported from all robot types You can determine what robot is connected from dwRobot Type in PTRobotInfo structure section 4 4 defines
15. EE EE E R EA REE S AE E 28 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 3 of 41 4 3 4 4 4 5 4 6 4 7 4 8 4 9 4 10 4 11 4 12 4 13 System States sa e ts lo lt ds FRINGE SEY A II vacancies uct citua nah de vente E TE AE a twuaeten aes BSI Auto USE lies A O RODOCACHODS oane a a a E E O R Print QuallY iia ie dada E AEE e Diye Open Close seei seeen ea e E EEA A a E a a ai ES oar iii A O O aanttrg BIS VIP a Clear DIE as Language ad ie 5 Recommended System Error Strings A E 5 1 5 2 5 3 5 4 5 5 5 6 5 7 5 8 5 9 5 10 5 11 5 12 5 13 5 14 5 15 5 16 5 17 5 18 5 19 5 20 5 21 5 22 5 23 5 24 5 25 5 26 5 27 5 28 5 29 5 30 5 31 5 32 5 33 5 34 SSE RR PIR TRA Votar aid a hans E N ia SYSERR CART CODE imna ea e aE A E eT A N E ATEA et SYSERR INPUF EMP TY td a i as SYSERR PTR COMME i A A A a E SYSERR CER EMPTA A aus aR sore ada ees R AR SY ETB BEE A ares eases da a A lea aa esemeeeoays SYSERR BOTE EMPT Yao R SY SERR TER cio ta SYSERR ARM_MOVE viniendo SA SERR CARTE MOVE iu li SABERES INTERNAS West a SYSERR NO_ROBODRIVES ctoiocionnaa crac nation E Ad a a ii SY SE RR COREL a A oa SY SERE COVERSOREN ssp SCS ERR PRINTER PICK id A a A a SYSERR MULTIPLE PER uni AA ass SYSERR MULTIPLEDISES IN PRINTER gt daran v rita cad ra gia SYSERR M
16. G tRobotStdtlsi cnica lio 15 2 2 4 PTRObOt GetMedialatO iia A A A EA 15 2 3 PTRobot Robotic FUNCUONS curtido 17 2 3 1 PTRObOtAEGA DEVE AEEA se Ree ee Eee ER EI TREES ME BOE IS PSL 17 2 3 2 PERob t LoadPrinter oia a iio iii 17 2 3 3 PTRobot_LoadPrinterFromDrive ccccccccccsessessecececececeesensesecececeesesensnseceeeecesesesessaaeeeeeceeseneneas 18 2 3 4 PT Robot Un Gad Drive siciliana iii P AUN a tad OS 18 2 3 5 PT Robot UnloadPrimtere sarita cidcid ce bese Bias avn ook oeea N a aa a a iaa aa irae TAAS TAE 19 2 3 6 PTRobot_MoveDiscBetweenLocations ia nnana as N a RE RE ESNS 19 2 3 7 PLRObOE Puntilla o A EA aaah Se 20 2 3 8 SU ic AAA A A he ee adeeb Sue 21 2 3 9 PTRobot SetPrinterSettihgs icacs casceceavss cave sen ici se E A E aa OEE EE a a 21 234101 LRERGDOL GetPrinters tunas a EEA OE E RS E eai 22 Zoe PTRObOt KIIS yet milion siii 22 A E O tay aes adeice slgnuic ipsa bas a esc cena cases seaweed cesen ate 23 23319 PT TRobot Open Closer v6 id 24 A A eeepedais E vd catvngseanandes E agp RE aasedaata ERRE 25 3 1 PPD riVelntO SUCE ti asa ee 25 3 2 PTRobotltfo StU Ctuir es uu oie a Ss ETNA BS GE iv RE 25 3 3 PERobotStat s S rUCtUre sesh Sosa tte dde a a a tee tei beau Se wees Rs 25 SA PTPri terSettings Ur ii od 26 3 5 PT Medialnto SUCIA vie eee sob Suv Sede eb ave Sse ese sds Hebei Nis a va eased 26 AY DST TU ONS a E Satan cade Sota hota EE EE as 28 4 1 AP Re Val tE A a a E AE a 28 4 2 System ETTOL Soner o e a E E A
17. PTACT_CANCELCMD Section 4 7 e Added members to PTRobotStatus structure Section 3 3 6 18 05 document version 1 6 e Updated PTRobot API return values Section 4 1 e Updated PTRobot_GetErrorString to also return PTRobot API errors Section 2 1 11 6 17 05_ document version 1 5 e Added tszMediaType to the PTMedialnfo structure Section 3 5 e Updated recommended system error strings Section 5 6 14 05_ document version 1 4 e Added new PTRobot return values Section 4 1 Added PTRobot_SetApplicationID Section 2 1 12 Added PTRobot_GetMedialnfo Section 2 2 4 Added PTRobot_GetErrorString Section 2 1 11 Removed Cmd Completion Flags Previously Section 4 8 Removed dwCommandComplete member of PTRobotStatus Section 3 3 Added PTMedialnfo structure Section 3 5 Added Language definitions Section 4 13 O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 41 of 41 6 3 05 document version 1 3 Updated notes in PTRobot_EnumRobots 5 23 05 document version 1 2 Added links within the document 5 20 05 document version 1 1 Added PrintFileWithMerge section 2 3 8 Added sections 5 Recommended System Error Strings Changed BYTE bDriveBusType to DWORD dwDriveBusType in PTRobotInfo structure section 3 2 Added ROBOT_RACKMOUNT_DPII Ro
18. PTRobot API DLL Based Application Programming Interface Primera Technology Inc May 16 2006 Revision 2 0 PTRobot API Page 2 of 41 1 PTRObOt Description ANA AN 5 1 1 DESC 5 O EES a ose acas cc yaa cna E I A A nae coe EEE eas ea agus eau ons te sacs na ge aus ac ae say oe pas ERTE 5 2 APU FUG U ONS AN es E AE A A a LS A ALE Sb AA Lo ed aed kati ie ebb T 2 1 PTRobot Setup FUNCIONS isso ease decade E ai EE EE a A A ER L aa tien at 7 2 1 1 od BELOIO OIE Darinke kVA a ti AEE EA EE E AA T eee ee 7 pa PROD OR DESTA dates a enc eciSa saute ua Mandan ae er Mating let ae tos cals te 7 2 1 3 PERODOE Set pDebugging ui 7 2 1 4 P PRobot EnumRobotS mimica tits davvoontinedoneToesbensdeieesst 8 2 1 5 PTRobot ERUMDTIVES iia isa ii 9 2 1 6 PTRobot_EnumDrivesWithList oooooooooncnccnnonononannnonocnonononnnnonononnonononnn no nonnnnononcnnnnn nn nnncncononannnnnos 10 2 1 7 PTRobot SetRoboticODVE cocina a A E ON 11 2 1 8 PTRobot_SetOpenCloseFunction sia roused venduaesaneavalsaieguacdvausdaedesecgensansconeeesns 11 2 1 9 PTRobof SetRobotOPptioiS is sene erei di ii 12 2 1107 PE RODOE GetROb tOPHODS goo esas ve iin E TE E ska ua nce wasn cage Saag nee 12 ZELL PE RODOE Cie Heron stn oia ds 13 ZETA PITRObOt SetApplicationID A E 14 2 2 PERobotInto Status PU CHONS roo R AS 14 2 2 1 PTRobot GetDrivelntos o Ae EE ROR EGE RI ae 14 2 2 2 PT Robot GetRobotlnte init Neves aves A EAS A avian Ake Bie A eB dd Bins os SN ved 14 2 2 3 PTR bot
19. PTRobot_SystemAction TAIMAAS ALAA AAAS AAA AAAS AAA be PE LE ees Le Ll LA Ed LE we L4 Le e Ie tet ou Ge ae Fi ve Le id Jd E fe i wee PTRobot_SystemAction Description Function to instruct the system to perform a specifc action Params hRobot Handle to the robot from EnumRobots dwAction Action to perform Notes This function is used to perform a specific function on a robot The defined actions and their descriptions are detailed below Action PTACT_ALIGNPRINTER gt Align the Printer Disc Publisher PRO only Description This will cause an alignment print to occur on the printer and this function will return when the alignment is complete Action PTACT_IGNOREINKLOW gt Ignore Ink Low Disc Publisher PRO only Description This will cause an ink low system error to be ignored Action PTACT_DISABLEPWRBUTTON gt Disable Power Button Description This will disable the power button on Disc Publisher II and PRO Action PTACT_REINIT_ DRIVES gt Re initialize drives Description PTRobot maintains Registry values for persistent settings including drive serial numbers This action will clear the drive serial numbers stored which will force the user to re identify the robotically O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of
20. R dwPrintIndex Print index for multiple print jobs Notes El The dwPrintIndex is used when printing an STD file with merge fields This Le value represents which merge record to use for this print aa Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence LR PTROBOT_INTERNAL if an internal error occurred Le PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_NO_PRINTER if the robot doesn t have a printer PTROBOT_PRN_INVALID if the prn file is not valid for the printer PTROBOT_PRINTFILE_NOT_FOUND if the file doesn t exist E PTROBOT_PRINTAPP_NOT_INSTALLED if the required print application is not AL installed EAAAAAMAAAAAAAAAAAA AAA AAA O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 21 of 41 DWORD WINAPI PTRobot_PrintFile HANDLE hRobot TCHAR tszFile DWORD dwPrintIndex T 2 3 8 PTRobot_PrintFileWithMerge FEIT PAT TA ETI T TEI TV EP LE Ld LA A oe LR Ll e Le td d ve Z4 id dd AA oe d e we LL A PTRobot_PrintFileWithMerge Description Function to print a Surething STD file that has Merge Text Photos The Merge Text and or Photos can be specified in a variable number of arguments passed into this function The Surething fi
21. Robot API Page 5 of 41 1 PTRobot Description 1 1 Description PTRobot is an API that allows developers to add robotic support for Primera duplicators to their own Windows applications PTRobot consists of several Dynamic Link Libraries DLLs that application developers can utilize to move discs automatically e g move a disc from an input bin into the recorder etc and also provides the capability to print on the CD DVD through the Surething CD Labeler application PTRobot provides an easy method to create automated CD DVD printing and or recording applications recording capability is not provided in PTRobot for recording capability developers should use the PTBurn SDK from Primera Currently PTRobot provides support for the Disc Publisher II Disc Publisher PRO Disc Publisher XR and Disc Publisher XRP 1 2 Usage Below is PSUEDO CODE example for how a calling application should use PTRobot to implement robotics into its application At program startup PTRobot_Initialize PTRobot_EnumRobots if the number of robots is greater than 1 then the calling application will need to provide some logic ui to determine which robot to use The app can use PTRobot_GetRobotInfo to get details about each robot PTRobot_EnumDrives or PTRobot_EnumDriveswWithList This will cause PTRobot to determine which drives are robotically controlled by enumerating the drives themselves PTRobot_EnumDrives or based off a
22. ULTIPEEDISES IN RECORDER viral SYSERR_ DROPPED DISC RECORDER osas iono acaso a a a da cin a did SYSERR DROPPED DISC BIN L soso init A A A AA IA AAA 57 SERR DROPPED DISC BIN vessntasd dandoles SY SERK DROPPED DISC PRINTER enni id SYSERR DROPPED DISC REJECT iii ai SYSERRK DROPPED DISC UNKNOWN ostia it an anana e n SERRA ETIENNE EDED tddi SISERR COLOR AN VA Dania a ios SYSERK BEACK IN VALID 0d Ad SYSERR BOTH INVALID ui A iii SY SERR NOCAR Tarda aos SRK K IN CMY dais SIS ERR OMV IN Kai A E ii E A A e R RORE A ia SY SERR SWAPPED reon na a a ER a AO R arsenite SY SER Re PIG INE RC IN A AA SYSERR ALIGNEAILED tii 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 4 of 41 5 35 SY SERR DROPPED DISC PRINTER PATA Ls e 38 5 36 SYSERR MULTIPLEDISCS IN RIGHT BIN 6 3 siisevaisscuessatenasdoacssuedsatbenedusegquenaceunadvaden ues dae 38 5 37 SYSERR_MULTIPLEDISCS IN_LEFTBIN ips 38 528 SYSERR CER EMPTY NA Ocio 38 5 39 SSYSERR BEK EMPTY FINA Be eee en o e ae 39 340 SYSERR BOTH EMPTY FINAL civiles ti 39 541 SYSERR WAITING FOR PRINTER ii e i 39 Os Revision SO dad 40 O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PT
23. _INTERNAL if an internal error occurred Le PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_NO_PRINTER if the robot doesn t have a printer LIA VAL IAAT A AIA AAT ALAA IAEA DWORD WINAPI PTRobot_GetPrinterSettings HANDLE hRobot PTPrinterSettings pPrinterSettings T 2 3 11 PTRobot_KillSystemError LEGTETIAAAIAATTAAAAA LIA ALS Le EE PTRobot_KillSystemError eb as Description td Function to kill a system error PE Params AL hRobot Handle to the robot from EnumRobots EZ dwResetPrinter DWORD to notify if the printer should be reset O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 23 of 41 ox ue Notes ta Reset the printer 0 do not reset the printer If there is no system error and dwResetPrinter is set to 1 the printer will be reset Otherwise if there is a system error that error will be cleared if possible and the printer will be reset if the dwResetPrinter is set to 1 Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid ISAASAAAAA AA AAA AAA ANITA ALIAS DWORD WINAPI PTRobot_KillSystemError HANDLE hRobot DWORD dwResetPrinter 2 3 12 T
24. _INVALID_BIN 504 tdefine PTROBOT_NODRIVES 505 tdefine PTROBOT_OPENCLOSE_FAILED 506 define PTROBOT_OVERFLOW 507 tdefine PTROBOT_NO_PRINTER 508 define PTROBOT_PRINTFILE_INVALID 509 tdefine PTROBOT_PRINTAPP_NOT_INSTALLED 510 tdefine PTROBOT_PRINTFILE_NOT_FOUND 511 define PTROBOT_PRN_INVALID 512 tdefine PTROBOT_UNSUPPORTED_OPTION 513 define PTROBOT_DIRNOTFOUND 514 tdefine PTROBOT_INVALID LOCATION 515 tdefine PTROBOT_MULTDRIVES 516 define PTROBOT_INVALID_PRINTER_SETTINGS 517 tdefine PTROBOT_INVALID_DRIVE_POSITION 518 define PTROBOT_INVALID_ACTION 519 define PTROBOT_FEATURE_NOT_IMPLEMENTED 520 tdefine PTROBOT_PRINTAPP_OPEN 521 define PTROBOT_MISSING_DL 522 tdefine PTROBOT_DRIVE_NOT_READY 523 tdefine PTROBOT_INVALID_MEDIA 524 define PTROBOT_NO_MEDIA 525 tdefine PTROBOT_INVALID_LANG 526 define PTROBOT_INVALID_ERROR 527 tdefine PTROBOT_BUSY 528 4 2 System Errors define SYSERR_NONE 0 tdefine SYSERR_PTR_TRAY a define SYSERR_CART_CODE 2 tdefine SYSERR_INPUT_EMPTY 3 tdefine SYSERR_PTR_COMM 4 define SYSERR_CLR_EMPTY 5 define SYSERR_BLK_EMPTY 6 define SYSERR_BOTH_EMPTY 7 tdefine SYSERR_PICK 8 tdefine SYSERR_ARM_MOVE 9 O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies
25. and the media is valid 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 16 of 41 ox dd Ai ve PTROBOT_INVALID_MEDIA if the media is not valid PTROBOT_NO_MEDIA if no media is found PTROBOT_INVALID_DRIVE if the drive is not valid PTROBOT_INTERNAL some other error FUT EOTAAASALAAAALIAT ALAA 7S DWORD WINAPI PTRobot_GetMediaInfo HANDLE hDrive PTMedialnfo pDiscInfo T 2 2 5 PTRobot_GetRobotInfo2 PRIANIA IILI Pf pf ed PTRobot_GetRobotInfo2 Description Function to get ADDITIONAL robot info for a particular robot handle Params hRobot Handle to the robot from EnumRobots pRobotInfo2 points to a PTRobotInfo structure Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid EETIAAAAAII NI SIA TIA NIA SAA DWORD WINAPI PTRobot_GetRobotInfo2 HANDLE hRobot PTRobotInfo2 pRobotInfo2 2 2 6 PTRobot_GetRobotStatus2 CARIAAAIA RRA RER IRE R IVA RITA if Pf if if fa ES E id PTRobot_GetRobotStatus2 Description Function to get the Additional current status for a particular robot Params hRobot Handle to
26. bot Type for the RackMount Disc Publisher II section 4 4 Changed all char to TCHAR Added PTROBOT_PRINTAPP_OPEN return value 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies
27. ction to set a drive s position within the duplicator when the PTROBOT_MULTDRIVES error is returned from either of the EnumDrives functions Params hRobots Handle to the Robot hDrive Handle to the Drive dwColIndex Index identifying the column that the drive is in 0 based where 0 is the left most column dwRowIndex Index identifying the row that the drive is in 0 based where 0 is the top row Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_INVALID_DRIVE if the drive handle is invalid PTROBOT_INVALID_DRIVE_POSITION if column row ids are invalid LIA LAAT ALAS LIAS APTA CAAA LESS DWORD WINAPI PTRobot_SetRoboticDrive HANDLE hRobot HANDLE hDrive DWORD dwColIndex T DWORD dwRowIndex 2 1 8 PTRobot_SetOpenCloseFunction 1111111111111111111111111 Le LE PE Le PTRobot_SetOpenCloseFunction Description Function to set a calling application provided drive open close Function Params O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 12 of 41 Ph pvOpenClose pointer to a function to open and close the drive JE setting to NULL will cause non callback open close rae t
28. fy a drive with Host 1 ID 3 LUN 0 and a drive letter of D To identify the same drive the client could pass down 0x01030000 0x00000044 or 0x01030044 This function should be called instead of PTRobot_EnumDrives if the calling application wants to enumerate the drives and have PTRobot select the Robotically controlled drives from the list the calling application provides Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence or after PTRobot_EnumDrives O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 11 of 41 ox dd El we Le a PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_OVERFLOW if the number of robotic drives found is gt the value in pdwDrives PTROBOT_MULTDRIVES if the module cannot determine which drives are robotically controlled VID VALSTA OLED LS AAAS AALS IAFF DWORD WINAPI PTRobot_EnumDrivesWithList HANDLI hRobot HANDLE phDrives phRobotDrives DWORD DWORD pdwNumDrives HANDL pdwNumRobotDrives 2 1 7 PTRobot_SetRoboticDrive FILPIITTTATP ACA TS APPT ET AAAS Le Le e ie PE Le ee ea Ll Od a ee Lf ea od PTRobot_SetRoboticDrive Description Fun
29. heir respective companies PTRobot API Page 25 of 41 3 Type Definitions 3 1 PTDrivelnfo Structure typedef struct HAN DLE hDrive TCHAR tszDriveName 132 TCHAR tszFirmwareVer 40 TCHAR tszSerialNum 40 HAN DLE hRobot DWORD dwDriveColumn DWORD dwDriveRow PTDrivelnfo pPTDrivelnfo 3 2 PTRobotinfo Structure typedef struct HANDLE hRobot TCHAR tszRobotDesc 100 DWORD dwRobotType DWORD dwNumDrives DWORD dwNumPrinters DWORD dwNumBins DWORD dwDriveColumns DWORD dwDriveRows TCHAR tszRobotFirmware 20 DWORD dwOptions DWORD dwAction HANDLE hDrives 10 DWORD dwDriveBusType jPTRobotInfo pPTRobotInfo 3 3 PTRobotStatus Structure typedef struct DWO DWO DWO DWO DWO DWO PTRobots RD RD RD RD RD RD tatus dwSystemState dwSystemError dwCurrColorSpits dwCurrBlackSpits dwFullColorSpits dwFullBlackSpits pPTRobotStatus J DPIve Drive Drive Drive Drive Drive Handle String reported from drive FW version Serial Number Column 0 based 0 is leftmost column Row 0 based 0 is the top row Robot Handle Robot Description See Number Number Number Number Number string See See Robot Type section 4 4 of Recorders on this robot of Printers on this robot 0 or 1 of Bins on this robot of Drive Columns of Dr
30. ints to a PTRobotInfo structure Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid VIP IPAS O AAA PELE AA LA TD ALT DWORD WINAPI PTRobot_GetRobotInfo HANDLE hRobot PTRobotInfo pRobotInfo 2 2 3 PTRobot_GetRobotStatus PETIT TITLE TTT ES ERA LA PE Le aa Z4 Jd Vi ae Pf ir PTRobot_GetRobotStatus Description Function to get the current status for a particular robot Params hRobot Handle to the robot from EnumRobots pRobotStatus points to a PTRobotStatus structure Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid LALALALA UL ALAS LL AE IAIA DWORD WINAPI PTRobot_GetRobotStatus HANDLE hRobot PTRobotStatus pRobotStatus 2 2 4 PTRobot_GetMedialnfo PIPTEPIEITI E TTI TEES oe LE Le td LE Pl LE PTRobot_GetMediaInfo Description This function will get information on the media that is loaded in the drive Params hDrive Handle to the drive from EnumDrives PTMediaInfo points to Media info structure see section 3 5 the structure will be filled in if successful Notes Return PTROBOT_OK if successful and media is found
31. invalid ISAASAAAAA AA AAA AAAAA LDA TTA DWORD WINAPI PTRobot_LoadPrinter HANDLE hRobot DWORD dwFromLocation 2 3 3 PTRobot_LoadPrinterFromDrive e A ERRE ou Ad El Ll ae Z4 Ed e oe a ae Le Le eS PTRobot_LoadPrinterFromDrive Description Function to load the printer from a drive Params hRobot Handle to the robot from EnumRobots hDrive Handle to the drive from EnumDrives Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_INVALID_DRIVE if the drive handle is invalid PTROBOT_NO_PRINTER if the robot doesn t have a printer LIA MALT AALS AAT ED SAAT ELA DWORD WINAPI PTRobot_LoadPrinterFromDrive HANDLE hRobot HANDLE hDrive 2 3 4 PTRobot_UnLoadDrive IE EIS SAE ERE AEAZ A EPR RENA LE Le Ll Le Pl LE PTRobot_UnLoadDrive Description Function to unload the drive to an output position Params hRobot Handle to the robot from EnumRobots hDrive Handle to the drive from EnumDrives dwToLocation DWORD containing the to location 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 19 of 41 ff LOCATION_AUTO Automatically choose
32. ive Rows Containing the FW Version of the Robot Robot Options section 4 6 Robot Actions section 4 7 BusType of the Drives See See System State section 4 3 System Error section 4 2 O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 26 of 41 3 4 PTPrinterSettings Structure typedef struct DWORD dwPrintQuality See Print Quality section 4 9 DWORD dwInnerDiam units in Imm increments 150 500 DWORD dwOuterMargin units in 1mm increments 0 20 PTPrinterSettings pPTPrinterSettings 3 5 PTMedialnfo Structure typedef struct TCHAR tszMediaID 20 TCHAR tszMediaType 20 PTMediaInfo pPTMedialnfo 3 6 PTRobotinfo2 Structure typedef struct DWORD dwNumCartridges Max Number of cartridges robot can hold DWORD dwCartridgeType 8 First element is left most cartridge and last element is right most cartridge from the user s viewpoint see Cartridge Types section 4 16 DWORD dwFirmware2Code DWORD dwPGA DWORD dwModel DWORD dwUSBSerialNum DWORD dwReserved 10 reserved for future data PTRobotInfo2 pPTRobotInfo2 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respec
33. l PTRobot_EnumDrives is called Return PTROBOT_OK if Successful PTROBOT_INVALID_ROBOT if no robots found PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_OVERFLOW if the number of robots found is gt the value in 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 9 of 41 Pe Je pdwNumRobots CALALARAS ASAS ASADA SAD AAAS DWORD WINAPI PTRobot_EnumRobots HANDLE phRobots DWORD pdwNumRobots 2 1 5 PTRobot_EnumDrives e L a E E Ad Je Lh Ll LA PE Le ees ea LE Ll LA EL d ee Le Ud UE Lh tt gue Le Ll Fi ve Le i Jo E oe aed we PTRobot_EnumDrives Description Function to enumerate the drives on the system and determine which drives are under the control of this Params Notes robot hRobot Handle to the robot to enumerate the drives of phDrives points to an array of DWORDS to store the Drives found pdwNumDrives points to a DWORD containing the number of HANDLEs in the phDrives array This value is an input and an output The user should specify the size number of HANDLEs of the phDrives array on input The value of the pdwNumDrives on output will be the number of drives found Bo
34. le dwDbgLvl debug Level 0 5 0 off 1 errors 2 warnings 3 Info 4 and 5 more info szTraceFile full path to a trace file Notes If szDbgFile is NULL then debugging will be turned off If szTraceFile is NULL then function tracing will be off Function tracing just logs the API function calls including the parameters Return PTROBOT_OK if Successful PTROBOT_INTERNAL if an internal error occurred BEISAITALALAS ALTA AEP AA LA ATT DWORD WINAPI PTRobot_SetupDebugging TCHAR szDbgFile DWORD dwDbgLvl TCHAR szTraceFile 2 1 4 PTRobot_EnumRobots DISIAAA AAA AAA AA SANA AAA ALAS Jd Ll bd dl ee Li LE e Ie hed Ae a fd if 4 dd oe ie i ae PTRobot_EnumRobots Description Function to enumerate the Robots on the system Params phRobots points to an array of HANDLEs to store the Robots found pdwNumRobots points to a DWORD containing the number of HANDLEs in the phRobots array This value is an input and an output The user should specify the size number of HANDLEs of the phRobots array on input The value of the pdwNumRobots on output will be the number of robots found Notes Both params will be updated upon successful completion of this command phRobots will contain handles to robots connected to this system pdwNumRobots will will be updated with the number of robots found Also note that the hDrives array in the PTRobotInfo will not be valid unti
35. le should be designed with the same number of merge strings passed in here Params hRobot Handle to the robot from EnumRobots tszFile Surething STD File to print dwNumMergeStrings Number of merge strings to follow Variable number of pointers to TCHAR strings These are the merge strings or photo names including path to be printed NOTE For the strings that follow dwMergeStrings to be used the user must have Set Merge File within the STD file Limit each string to 256 characters or less Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_NO_PRINTER if the robot doesn t have a printer PTROBOT_PRINTFILE_NOT_FOUND if the file doesn t exist PTROBOT_PRINTAPP_NOT_INSTALLED if the required print application is not installed PTROBOT_PRINTFILE_INVALID if the filename is not STD CLLAAAAAALDISAAAA LEA UITA DWORD WINAPI PTRobot_PrintFileWithMerge HANDLE hRobot TCHAR tszFile DWORD dwNumMergeStrings 2 3 9 PTRobot_SetPrinterSettings IIA AAA AAA AAA AAA AAA AAA AA LAS LL ed A A PE Le PTRobot_SetPrinterSettings Description Function to set some printer driver settings Params hRobot Handle to the robot from EnumRobots pPrinterSettings points to a PTPrinterSettings structure 2005 Primera Technology Inc Primera
36. left bin Then close the cover to continue 5 22 SYSERR_DROPPED_DISC_PRINTER DiscPublisherII PRO The disc was dropped while moving into the printer Please manually place the disc into the printer tray Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving into the printer Please open the cover and manually place the disc into the printer tray Then close the cover to continue 5 23 SYSERR_DROPPED_DISC_REJECT DiscPublisherII PRO The disc was dropped while moving to the reject area Please remove the dropped disc Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving to the reject area Please open the cover and remove the dropped disc Then close the cover to continue 5 24 SYSERR_DROPPED_DISC_UNKNOWN DiscPublisherII PRO The disc was dropped Please remove the dropped disc Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped Please open the cover and remove the dropped disc Then close the cover to continue 5 25 SYSERR_ALIGNNEEDED DiscPublisherPRO The printer cartridges need to be aligned NOTE Your application can require the user to go to the Printing Preferences in the Printers and Faxes folder to perform this function Or you can use the PTRobot_SystemAction call to help the user perform an alignment 2005 Primera Technology
37. marks are the property of their respective companies PTRobot API Page 33 of 41 DiscPublisher XR XRP WARNING The color cartridge is LOW on ink To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning open and close the cover 5 6 SYSERR_BLK_EMPTY DiscPublisherI II PRO WARNING The black cartridge is LOW on ink To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning press the left button DiscPublisher XR XRP WARNING The black cartridge is LOW on ink To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning open and close the cover 5 7 SYSERR_BOTH_EMPTY DiscPublisherI II PRO WARNING Both ink cartridges are LOW on ink To replace the cartridges open the cover on the unit and press the left button Then install the new cartridges and close the cover To ignore the warning press the left button DiscPublisher XR XRP WARNING Both ink cartridges are LOW on ink To replace the cartridge open the cover on the unit and press the left button Then install the new cartridges and close the cover To ignore the warning open and close the cover 5 8 SYSERR_PICK DiscPublisher M PRO The disc was not
38. o be used Notes IL This function allows the calling application to provide the drive Ll open closing functionality through their recording engine If this Le function is not called then the drive will be opened closed via OS LE calls The function pointed to by the pvOpenClose param should be Via defined as follows Li Lh void OpenCloseDrive DWORD hDrive DWORD dwOpen PL Le Please see the Drive Open Close definitions above for the dwOpen ea param aa Li Return A PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence Th PTROBOT_INTERNAL if an internal error occurred LELEEELIPELEILL ALT PEEL IL EL DWORD WINAPI PTRobot_SetOpenCloseFunction void pvOpenClose 2 1 9 PTRobot_SetRobotOptions PETEITT PPT TEL EDT ELS ELST IAT Le PTRobot_SetRobotOptions te Description Function to set the current robot options th Params te hRobot Handle to the robot aa dwRobotOptions DWORD containing the options to set ea See Robot Options defines above LE Notes Ue You should call PTRobot_GetRobotOptions to get the current Options and then set the options you want to change prior to calling this function oe Return Le PTROBOT_OK if Successful ER PTROBOT_SEQUENCE if this command is called out of sequence ZA PTROBOT_INTERNAL if an internal error occurred Veh PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_UNSUPPORTED_OPTION if the o
39. ocations CLAAIALA BOAL EIA A LEP ALAS ALAS it PTRobot_MoveDiscBetweenLocations 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 20 of 41 Pf JE Description Leh Function to move disc from one bin to another bin Params Vi hRobot Handle to the robot from EnumRobots or dwFromLocation DWORD containing the from location EL 1 Bini right most bin LE 2 Bin2 Le Hau dwToLocation DWORD containing the to location of 1 Binl right most bin Id 2 Bin2 aa bing EL LOCATION_REJECT Reject ER Notes oe Return td PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence tL PTROBOT_INTERNAL if an internal error occurred Vid PTROBOT_INVALID_ROBOT if the robot handle is invalid Ld PTROBOT_INVALID_LOCATION if the location is invalid aa LAIAR AUAA DITAS AIS TILA LAA DWORD WINAPI PTRobot_MoveDiscBetweenLocations HANDLE hRobot DWORD dwFromLocation DWORD dwToLocation 2 3 7 PTRobot_PrintFile 1111111111111111111111111 ff PTRobot_PrintFile te Description IK Function to print a Surething image STD raster image JPG BMP TIF ff etc or PRN file to the printer Ae Params EL hRobot Handle to the robot from EnumRobots tszFile File to print STD PRN JPG BMP A
40. ption is unsupported on that robot LE LAAU VUUS LAAI AAAS IA DAA TIL DWORD WINAPI PTRobot_SetRobotOptions HANDLE hRobot DWORD dwRobotOptions 2 1 10 PTRobot_GetRobotOptions CESLEAAA LAS IERA AEA AA TIAA ALG IR PTRobot_GetRobotOptions 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 13 of 41 Pe ed Ed Fi ee Le iE v7 ee PR ae na Description Function to get the current robot options Params hRobot Handle to the robot pdwRobotOptions points to a DWORD See Robot Options defines above Notes Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid ALLALEEALARELIOCLER LLO ALLER DWORD WINAPI PTRobot_GetRobotOptions HANDLE hRobot DWORD pdwRobotOptions 2 1 11 T PTRobot_GetErrorString CABANA RARE AA AAA IAB AS AA RIA LL ve Le Le id AA tte Pee Le Ad ee LE Le bd AA Ha ve L Le Ae Ji ae Ze Ed PTRobot_GetErrorString Description Function to get the error string for a specific system error or PTRobot API Return error Params hRobot Handle to the robot from EnumRobots Use NULL only if no handle has been obtained yet
41. rom the printer keeping a single disc in place Then close the cover to continue 5 19 SYSERR_DROPPED_DISC_RECORDER DiscPublisherII PRO The disc was dropped while moving into the recorder Please manually place the disc into the recorder tray Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving into the recorder Please open the cover and manually place the disc into the recorder tray Then close the cover to continue 5 20 SYSERR_DROPPED_DISC_BIN1 DiscPublisherII PRO The disc was dropped while moving into the right bin Please manually place the disc into the right bin Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving into the right bin Please open the cover and manually place the disc into the right bin Then close the cover to continue 5 21 SYSERR_DROPPED_DISC_BIN2 DiscPublisherII PRO The disc was dropped while moving into the left bin Please manually place 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 36 of 41 the disc into the left bin Then close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving into the left bin Please open the cover and manually place the disc into the
42. stered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 38 of 41 5 33 SYSERR_PIGONPRO DiscPublisherPRO This printer is not compatible with a pigment based black cartridge Open the cover and press the left button Install a dye based black cartridge and close the cover 5 34 SYSERR_ALIGNFAILED DiscPublisherPRO The alignment print failed NOTE Your application can either require the user to go to the Printing Preferences in the Printers and Faxes folder to re do this function Or you can use the PTRobot_SystemAction call to help the user perform another alignment 5 35 SYSERR_DROPPED_DISC_PRINTER_FATAL DiscPublisherII PRO The disc was dropped while moving to from the printer Please open the cover and manually remove and discard the disc Then place a new disc in the recorder close the cover and press the left button DiscPublisher XR XRP The disc was dropped while moving to from the printer Please open the cover and manually remove and discard the disc Then place a new disc in the recorder and close the cover to continue 5 36 SYSERR_MULTIPLEDISCS_IN_RIGHTBIN DiscPublisherII PRO Multiple discs were placed in the right bin Please manually move any extra discs to the left bin keeping a single disc in place Then close the cover and press the left button DiscPublisher XR XRP Multiple
43. th cartridges are Empty To replace the cartridge open the cover on the unit and press the left button Then install the new cartridge and close the cover To ignore the warning press the left button 5 41 SYSERR_WAITING_FOR_PRINTER The system timed out waiting for the printer to finish The disc may not have been printed on 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 40 of 41 6 Revision History 5 16 06 document version 2 0 e Document the fact that PTRobot now supports Disc Publisher XRP e Added new API calls PTRobot_GetRobotInfo2 and PTRobot_GetRobotStatus2 Sections 2 25 and 2 26 e Added new structures PTRobotInfo2 and PTRobotStatus2 Sections 3 6 and 3 7 e Added new defines Section 4 14 to 4 16 10 14 05 document version 1 9 e Document the fact that PTRobot now supports Disc Publisher XR Note ROBOT_RACKMOUNT_DPII is for the Disc Publisher XR 9 14 05 document version 1 8 e Added new System Errors 46 52 Section 4 2 e Added new string descriptions for the newly added system errors Section 5 35 to 5 41 7 13 05 document version 1 7 e Added hRobot parameter to PTRobot_GetErrorString Section 2 1 11 e Fixed documentation error for robotic functions Section 2 3 where the reject position was given as 100 instead of 200 e Added
44. th params will be updated upon successful completion of this command phDrives will contain handles to drives connected to this system pdwNumDrives will will be updated with the number of drives found The format of the drive handles is the following The least significant byte should contain the drive letter the other three bytes should contain the SCSI triple The drive can be identified by either of these methods For Example 0x01030044 would identify a drive with Host 1 ID 3 LUN 0 and a drive letter of D To identify the same drive the client could pass down 0x01030000 0x00000044 or 0x01030044 Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence or after PTRobot_EnumDrivesWithList PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_OVERFLOW if the number of drives found is gt the value in pdwNumDrives PTROBOT_MULTDRIVES if the module cannot determine which drives are O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 10 of 41 GL dd Fi robotically controlled The calling application needs to use PTRobot_SetRoboticDrive to resolve this error LIULL ALAUN L LALLA EVIL LE DWORD WINAPI PTRobot_EnumDrives HANDLE hRobot HANDLE
45. the bin 1 Bini right most bin Le 2 Bin2 eg LE LOCATION_REJECT Reject Li oe Notes EL Return PTROBOT_OK if Successful PL PTROBOT_SEQUENCE if this command is called out of sequence Lh PTROBOT_INTERNAL if an internal error occurred rad PTROBOT_INVALID_ROBOT if the robot handle is invalid ae PTROBOT_INVALID_DRIVE if the drive handle is invalid if PTROBOT_INVALID_LOCATION if the location is invalid LLL SCUL LALIT EOI TA PITAL DWORD WINAPI PTRobot_UnLoadDrive HANDLE hRobot HANDLE hDrive DWORD dwToLocation 2 3 5 PTRobot_UnLoadPrinter IILLLA LALA ALA AAA AI ILL El PTRobot_UnLoadPrinter ti Description LS Function to unload the printer to an output position LR Params oF hRobot Handle to the robot from EnumRobots ih dwToLocation DWORD containing the to location LOCATION_AUTO Automatically choose the bin Ef 1 Binl right most bin Le 2 Bind aa iss A LOCATION_REJECT Reject EL Le Notes oe Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PL PTROBOT_INTERNAL if an internal error occurred Pe PTROBOT_INVALID_ROBOT if the robot handle is invalid AL PTROBOT_NO_PRINTER if the robot doesn t have a printer PTROBOT_INVALID_LOCATION if the location is invalid Ai EL ILLIA AAA AAA AAA AI ASAS ASS SSS DWORD WINAPI PTRobot_UnLoadPrinter HANDLE hRobot DWORD dwToLocation 2 3 6 PTRobot_MoveDiscBetweenL
46. the robot from EnumRobots pRobotStatus2 points to a PTRobotStatus2 structure Notes Returns PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid PTROBOT_BUSY if no response from robot FIAELLT AAA ATAT ETAT AL ET ETS DWORD WINAPI PTRobot_GetRobotStatus2 HANDLE hRobot PTRobotStatus2 pRobotStatus2 T 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 17 of 41 2 3 PTRobot Robotic Functions 2 3 1 PTRobot_LoadDrive PEELED IES SELES ISIE LESSEE ee LE Le LE te PR qe vee LE LL Le od Ka ll Le Le e fd PE ie PTRobot_LoadDrive Description Function to load a drive from an input location Params hRobot Handle to the robot from EnumRobots hDrive Handle to the drive from EnumDrives dwFromLocation DWORD containing the from location LOCATION_AUTO Automatically choose the bin 1 Binl right most bin 2 Bin2 LOCATION_PRINTER Printer dwClearDrive Clear drive before loading See Clear Drive section Notes Clear drive before loading should be done the first loading This will cause the picker to attempt to pick discs out of the drive to determine if any discs
47. their respective companies PTRobot API Page 24 of 41 oe controlled drives ae Action if PTACT_IDENTIFY gt Identify a robot Vi Description oT This will cause the robot to do something to visually identify itself oe For example the Bravo units will move their printer tray LL Return PTROBOT_OK if Successful PL PTROBOT_SEQUENCE if this command is called out of sequence Lh PTROBOT_INTERNAL if an internal error occurred PTROBOT_INVALID_ROBOT if the robot handle is invalid ff PTROBOT_INVALID_ACTION if the robot action is invalid ILAASAAAAA AAA AAAAAAA SLA TAA DWORD WINAPI PTRobot_SystemAction HANDLE hRobot DWORD dwAction T 2 3 13 PTRobot_OpenCloseDrive E a A LE Edo PTRobot_OpenCloseDrive tf Description Function to open or close a drive te Params Lh hDrive Handle to the drive from EnumDrives tf dwOpen See Drive Open Close section above DRIVE_OPEN 0 DRIVE_CLOSE 1 Notes Le Return PTROBOT_OK if Successful PTROBOT_SEQUENCE if this command is called out of sequence FR PTROBOT_INTERNAL if an internal error occurred Le PTROBOT_INVALID_DRIVE if the drive handle is invalid LE LIEALIAAAATA LT ATA AAA LAA AA PAD DWORD WINAPI PTRobot_OpenCloseDrive HANDLE hDrive DWORD dwOpen O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of t
48. tive companies PTRobot API Page 27 of 41 3 7 PTRoboStatus2 Structure define UNKNOWN_NUM_DISCS 255 typedef struct DWORD dwCartridgeTypes see Cartridge Types section 4 16 DWORD dwNumDiscsInBins 5 Oth element is left most bin values are 255 if unknown DWORD dwTotalPrints Total of prints DWORD dwTotalPicks Total of picks from input bin DWORD dwVerticalOffset Vertical print offset 300dpi units DWORD dwHorizontalOffset Horizontal print offset 300dpi units DWORD dwPrinterTrayStatus See Printer Tray Status section 4 14 DWORD dwDiscPickSwitchStatus See Disc Pick Switch Status section 4 15 DWORD dwCoverBeenOpenedF lag set to 1 if cover has been opened DWORD dwReserved 30 reserved for future data PTRobotStatus2 pPTRobotStatus2 O 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 28 of 41 4 Definitions 4 1 API Return Values define PTROBOT_OK 0 tdefine PTROBOT_INTERNAL 500 tdefine PTROBOT_SEQUENCE 501 define PTROBOT_INVALID_ROBOT 502 tdefine PTROBOT_INVALID_DRIVE 503 define PTROBOT
49. ublisherII PRO Multiple discs were picked up and moved Please manually remove any extra discs that were moved keeping a single disc in place Then close the cover and press the left button DiscPublisher XR XRP Multiple discs were picked up and moved Please open the cover and manually remove any extra discs that were moved keeping a single disc in place Then close the cover to continue 2005 Primera Technology Inc Primera is a registered trademark and Bravo is a trademark of Primera Technology Inc All other trademarks are the property of their respective companies PTRobot API Page 35 of 41 5 17SYSERR_MULTIPLEDISCS_IN_PRINTER DiscPublisherII PRO Multiple discs were placed in the printer Please manually remove any extra discs from the printer keeping a single disc in place Then close the cover and press the left button DiscPublisher XR XRP Multiple discs were placed in the printer Please open the cover and manually remove any extra discs from the printer keeping a single disc in place Then close the cover to continue 5 18 SYSERR_MUL TIPLEDISCS_IN_RECORDER DiscPublisherII PRO Multiple discs were placed in the recorder Please manually remove any extra discs from the recorder keeping a single disc in place Then close the cover and press the left button DiscPublisher XR XRP Multiple discs were placed in the recorder Please open the cover and manually remove any extra discs f

PTRobot API

Contents

Download Pdf Manuals

Related Search

Related Contents