API User Guide
The StarXpand SDK provides you with useful APIs to control the printer and POS peripheral devices.
Embed the StarIO10 library to your application and call it in combination with a necessary API according to the description page of each function.
For how to embed the StarIO10 library to an application, refer to the following URL.
https://github.com/star-micronics/star-io10-web/blob/master/README.md#installation
Search for Printer
Use StarDeviceDiscoveryManager to search for the printer and obtain permission to connect.
For the description using the sample code, see here.
Create printing data in Step 1 and send it to the printer in Step 2.
Select the necessary function in each step and refer to the description using the sample code on the link destination.
Step 1 Generate Printing Data
Standard function
Combine basic functions
to generate printing data.
Page mode function
Specify the page orientation and use borders
to generate printing data.
Template printing function
Generate printing data by separating a template,
which defines a layout, and field data, which defines printing content.
Step 2 Send Printing Data
Use Cash Drawer
Open and close the cash drawer connected to the printer.
For the description using the sample code, see here.
Acquire Printer Status
Acquire the printer status (example: paper present / not present).
To acquire the status, use the getStatus method of the StarPrinter class.
Refer to the sample contained in the SDK as well.
Use Customer Display
Generate the control data of the customer display, and then send it to the printer.
To generate the control data, use the DisplayBuilder class.
For how to send the control data, refer to Print Step 2.
Use Buzzer
Generate the control data of the buzzer, and then send it to the printer.
To generate the control data, use the BuzzerBuilder class.
For how to send the control data, refer to Print Step 2.
Use Melody Speaker
Generate the control data of the melody speaker, and then send it to the printer.
To generate the control data, use the MelodySpeakerBuilder class.
For how to send the control data, refer to Print Step 2.
Obtain Logs
Obtain the logs of StarIO10 library API call information and transmission data.
To obtain the logs, use the StarIO10Logger class.
API Reference by Function
Communication APIs
- StarPrinter
- A class that controls the printer
- StarPrinterFactory
- A class that generates a StarPrinter object
- StarConnectionSettings
- A class that defines the settings for connecting to a device
- InterfaceType
- Interface type
- OpenOptions
- A class that defines the options for the StarPrinter.open method
- PrintOptions
- A class that defines the options for the StarPrinter.print and StarPrinter.printRawData methods
- GetStatusOptions
- A class that defines the options for the StarPrinter.getStatus method
- GetInformationOptions
- A class that defines the options for the StarPrinter.getInformation method
- StarPrinterInformation
- A class that defines the printer information
- StarPrinterInformationDetail
- A class that defines the printer details information
- StarPrinterInformationUsb
- A class that defines the information for printer USB communication
- StarPrinterEmulation
- Printer emulation
- StarPrinterModel
- Printer model
- StarPrinterStatus
- A class that defines the printer status
- StarPrinterStatusDetail
- A class that defines the printer details status
- DrawerOpenedMethod
- Cash drawer open/close method
Search APIs
- StarDeviceDiscoveryManager
- A class for detecting devices
Log APIs
- StarIO10Logger
- A class that controls logs
Error APIs
- StarIO10Error
- An error class that is thrown by the API for this library
- StarIO10ArgumentError
- An error class that is thrown when an invalid parameter is given
- StarIO10BadResponseError
- An error class that is thrown when the response from a device is invalid
- StarIO10CommunicationError
- An error class that is thrown when a communication error occurs
- StarIO10IllegalDeviceStateError
- An error class that is thrown when the status of a host device is invalid
- StarIO10InUseError
- An error class that is thrown when the target device is being used
- StarIO10InvalidOperationError
- An error class that is thrown when an invalid operation is performed
- StarIO10NotFoundError
- An error class that is thrown when the target device is not found
- StarIO10UnknownError
- An error class that is thrown when an unknown error occurs
- StarIO10UnprintableError
- An error class that is thrown when a printer cannot print
- StarIO10UnsupportedModelError
- An error class that is thrown when the target device is not supported
- StarIO10AuthenticationError
- An error class for authentication failures
- StarIO10ServerCommunicationError
- An error class for communication failures with the Star Micronics server
- StarIO10ErrorCode
- StarIO10Error error code
Printing Data/Control Data Generation APIs
- StarXpandCommandBuilder
- A class that generates StarXpandCommand
- DocumentBuilder
- A class that generates StarXpandCommand for a document
- PreSettingBuilder
- A class that generates StarXpandCommand for a preset
- MagnificationParameter
- Magnification setting parameters
- TemplateExtensionParameter
- Template printing enhancement parameters on the template side
- StarXpandCommand
- Provides a function to generate human-readable commands for controlling the printer and peripheral devices
Printer
- PrinterBuilder
- A class that generates StarXpandCommand for a printer
- PageModeBuilder
- A class that generates StarXpandCommand for a page mode
- Printer
- A list of printer control parameters used in PrinterBuilder
- Alignment
- A value indicating alignment
- AmbiguousCharacterWidthType
- 1-byte/2-byte setting for Unicode fuzzy characters
- BarcodeBarRatioLevel
- Ratio level of the barcode bar
- BarcodeSymbology
- Barcode symbol
- BlackMarkPosition
- Black mark position
- CharacterEncodingType
- Character encoding
- CjkCharacterType
- CJK unified ideographs
- CutType
- Paper cutting method
- FontType
- Font
- InternationalCharacterType
- International characters
- Pdf417Level
- PDF417 ECC (security level)
- QRCodeLevel
- Error correction level for QR code
- QRCodeModel
- QR code model
- TextAlignment
- A value indicating alignment for the function specifying the number of characters
- TextEllipsizeType
- Omission method for the function specifying the number of characters
- TextPrintType
- Print method for the function specifying the number of characters
- TextWidthType
- 1-byte/2-byte setting for the function specifying the number of characters
- BarcodeParameter
- Barcode setting parameters
- BlackMarkParameter
- Black mark setting parameters
- HoldPrintParameter
- Hold print control setting parameters
- ImageParameter
- Image setting parameters
- LabelParameter
- Label setting parameters
- LogoParameter
- Logo setting parameters
- Pdf417Parameter
- PDF417 setting parameters
- QRCodeParameter
- QR code setting parameters
- RuledLineParameter
- Horizontal line setting parameters
- LineStyle
- Line style
- PageModeAreaParameter
- Page area setting parameters
- PageModeImageParameter
- Page mode image setting parameters
- PageModePrintDirection
- Page mode printing direction
- PageModeRectangleParameter
- Page mode square frame setting parameters
- PageModeRuledLineParameter
- Page mode border setting parameters
- PrinterParameter
- General PrinterBuilder setting parameters
- PageModeParameter
- General PageModeBuilder setting parameters
- TextParameter
- Text setting parameters
- TextWidthParameter
- Setting parameters for the function specifying the number of characters
- BaseMagnification
- Basic text magnification settings
- BaseMagnificationParameter
- Basic text magnification setting parameters
Cash drawer
- DrawerBuilder
- A class that generates StarXpandCommand for a cash drawer
- Drawer
- A list of cash drawer control parameters used in DrawerBuilder
- Channel
- Cash drawer channel
- OpenParameter
- Cash drawer open setting parameters
Buzzer
- BuzzerBuilder
- A class that generates StarXpandCommand for a buzzer
- Buzzer
- A list of buzzer control parameters used in BuzzerBuilder
- Channel
- Buzzer channel
- DriveParameter
- Buzzer drive setting parameters
Melody speaker
- MelodySpeakerBuilder
- A class that generates StarXpandCommand for a melody speaker (mC-Sound)
- MelodySpeaker
- A list of melody speaker control parameters used in MelodySpeakerBuilder
- SoundStorageArea
- Sound storage area
- DriveRegisteredSoundParameter
- Registered sound playback setting parameters
- DriveOneTimeSoundParameter
- Received data playback setting parameters
Display
- DisplayBuilder
- A class that generates StarXpandCommand for a customer display
- Display
- A list of customer display control parameters used in DisplayBuilder
- CharacterEncodingType
- Character encoding
- Contrast
- Contrast value
- CursorState
- Cursor state
- InternationalCharacterType
- International characters
- ImageParameter
- Image setting parameters
- PositionParameter
- Position parameters
Presenter
- PresenterSettingBuilder
- A class that generates StarXpandCommand for a presenter setting
- Presenter
- A list of presenter control parameters used in PresenterSettingBuilder
- LedType
- LED operating conditions
- LedAutomaticBlinkParameter
- LED auto-blink setting parameters
- ModeParameter
- Presenter operation setting parameters
Bezel
- BezelSettingBuilder
- A class that generates StarXpandCommand for a bezel setting
- Bezel
- A list of bezel control parameters used in BezelSettingBuilder
- LedType
- LED operating conditions
- LedAutomaticBlinkParameter
- LED auto-blink setting parameters