1. Manuals
  2. Brands
  3. Primera Manuals
  4. Software
  5. PTRobot API
  6. User manual

Primera PTRobot API User Manual

Dll based application programming interface
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
PTRobot API
DLL Based Application Programming Interface
Primera Technology Inc.
May 16, 2006 / Revision 2.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the PTRobot API and is the answer not in the manual?

Questions and answers

Related Manuals for Primera PTRobot API

Summary of Contents for Primera PTRobot API

  • Page 1 PTRobot API DLL Based Application Programming Interface Primera Technology Inc. May 16, 2006 / Revision 2.0...

  • Page 2: Table Of Contents

    PTMediaInfo Structure ......................... 26 Definitions..............................28 API Return Values ..........................28 System Errors............................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.
  • Page 3 SYSERR_CMY_IN_K ......................... 37 5.32 SYSERR_SWAPPED........................... 37 5.33 SYSERR_PIGONPRO ......................... 38 5.34 SYSERR_ALIGNFAILED........................38 © 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.
  • Page 4 SYSERR_BOTH_EMPTY_FINAL ..................... 39 5.41 SYSERR_WAITING_FOR_PRINTER ....................39 Revision History ............................40 © 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.

  • Page 5: Ptrobot Description

    …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.
  • Page 6 PTRobot_UnloadDrive(Robot, Drive, 100) PTRobot_GetRobotStatus(..) called in a loop Before program exit: PTRobot_Destroy() © 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.

  • Page 7: Api Functions

    PTROBOT_INTERNAL if an internal error occurred /////////////////////////// DWORD WINAPI PTRobot_Destroy(); 2.1.3 PTRobot_SetupDebugging /////////////////////////// PTRobot_SetupDebugging Description: © 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.

  • Page 8: Ptrobot_Enumrobots

    PTROBOT_OVERFLOW if the number of robots found is > 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.

  • Page 9: Ptrobot_Enumdrives

    PTROBOT_OVERFLOW if the number of drives found is > the value in pdwNumDrives PTROBOT_MULTDRIVES if the module cannot determine which drives are © 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.

  • Page 10: Ptrobot_Enumdriveswithlist

    PTROBOT_SEQUENCE if this command is called out of sequence or after PTRobot_EnumDrives © 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.

  • Page 11: Ptrobot_Setroboticdrive

    Function to set a calling application provided drive open/close function. Params: © 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.

  • Page 12: Ptrobot_Setrobotoptions

    /////////////////////////// DWORD WINAPI PTRobot_SetRobotOptions(HANDLE hRobot, DWORD dwRobotOptions); 2.1.10 PTRobot_GetRobotOptions /////////////////////////// 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.

  • Page 13: Ptrobot_Geterrorstring

    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.

  • Page 14: Ptrobot_Setapplicationid

    /////////////////////////// DWORD WINAPI PTRobot_GetDriveInfo(HANDLE hDrive, PTDriveInfo* pDrvInfo); 2.2.2 PTRobot_GetRobotInfo /////////////////////////// PTRobot_GetRobotInfo © 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.

  • Page 15: Ptrobot_Getrobotstatus

    PTROBOT_OK if successful and media is found 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.
  • Page 16 PTROBOT_BUSY if no response from robot /////////////////////////// DWORD WINAPI PTRobot_GetRobotStatus2(HANDLE hRobot, PTRobotStatus2 *pRobotStatus2); © 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.

  • Page 17: Ptrobot Robotic Functions

    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.

  • Page 18: Ptrobot_Loadprinterfromdrive

    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.

  • Page 19: Ptrobot_Unloadprinter

    /////////////////////////// DWORD WINAPI PTRobot_UnLoadPrinter(HANDLE hRobot, DWORD dwToLocation); 2.3.6 PTRobot_MoveDiscBetweenLocations /////////////////////////// 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.

  • Page 20: Ptrobot_Printfile

    PTROBOT_PRINTFILE_NOT_FOUND if the file doesn't exist PTROBOT_PRINTAPP_NOT_INSTALLED if the required print application is not installed. /////////////////////////// © 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.

  • Page 21: Ptrobot_Printfilewithmerge

    Handle to the robot (from EnumRobots) pPrinterSettings points to a PTPrinterSettings structure. © 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.

  • Page 22: Ptrobot_Getprintersettings

    Handle to the robot (from EnumRobots) dwResetPrinter DWORD to notify if the printer should be reset. © 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.

  • Page 23: Ptrobot_Systemaction

    This action will clear the drive serial numbers stored which will force the user to re-identify the robotically © 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.

  • Page 24: Ptrobot_Openclosedrive

    PTROBOT_INVALID_DRIVE if the drive handle is invalid /////////////////////////// DWORD WINAPI PTRobot_OpenCloseDrive(HANDLE hDrive, DWORD dwOpen ); © 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.

  • Page 25: Type Definitions

    //See "System Error" section 4.2 DWORD dwCurrColorSpits; DWORD dwCurrBlackSpits; DWORD dwFullColorSpits; DWORD dwFullBlackSpits; }PTRobotStatus, *pPTRobotStatus; © 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.

  • Page 26: Ptprintersettings Structure

    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 respective companies.
  • Page 27 // set to 1 if cover has been opened DWORD dwReserved[30]; // reserved for future data }PTRobotStatus2, *pPTRobotStatus2; © 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.

  • Page 28: Definitions

    SYSERR_PTR_COMM #define SYSERR_CLR_EMPTY #define SYSERR_BLK_EMPTY #define SYSERR_BOTH_EMPTY #define SYSERR_PICK #define SYSERR_ARM_MOVE © 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.

  • Page 29: System State

    // Disc Publisher XRP 4.5 Bin Auto Use #define BIN_INPUT #define BIN_OUTPUT © 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.

  • Page 30: Robot Options

    #define BUSTYPE_USB #define BUSTYPE_1394 4.12 Clear Drive #define CLEARDRIVE_NO #define CLEARDRIVE_YES © 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.

  • Page 31: Languages

    4.16 Cartridge Types #define CARTRIDGE_NONE #define CARTRIDGE_COLOR #define CARTRIDGE_BLACK #define CARTRIDGE_BOTH © 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.

  • Page 32: Recommended System Error Strings

    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 trademarks are the property of their respective companies.

  • Page 33: Syserr_Blk_Empty

    “There was an arm movement error. Press the left button on the unit to try again.” © 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...

  • Page 34: Syserr_Cart_Move

    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...

  • Page 35: Syserr_Multiplediscs_In_Printer

    “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.

  • Page 36: Syserr_Dropped_Disc_Printer

    Or, you can use the PTRobot_SystemAction call to help the user perform an alignment. © 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.

  • Page 37: Syserr_Color_Invalid

    “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 registered trademark and Bravo is a trademark of Primera Technology, Inc. All other trademarks are the property of their respective companies.

  • Page 38: Syserr_Pigonpro

    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.

  • Page 39: Syserr_Blk_Empty_Final

    “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...

  • Page 40: Revision History

    • Added PTMediaInfo structure (Section 3.5) • Added Language definitions (Section 4.13) © 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.
  • Page 41 • 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.

Table of Contents