SATO PV3 Manual

SATO PV3 Manual

Xamarin sdk
Hide thumbs Also See for PV3:

Advertisement

Quick Links

Xamarin SDK
PV3/PV4
BARCODE PRINTER
Ver. 1.01

Advertisement

Table of Contents
loading

Summary of Contents for SATO PV3

  • Page 1 Xamarin SDK PV3/PV4 BARCODE PRINTER Ver. 1.01...
  • Page 2: Table Of Contents

    Xamarin SDK Table of Contents 1. Manual Guide ........................4 2. Supported Devices ......................4 3. Xamarin SDK Installation ....................5 3-1 Supported Platforms ......................5 3-1-1 iOS ......................... 5 3-1-2 Android ........................5 3-1-3 Windows ........................ 5 3-2 Supported Communications....................6 3-2-1 Bluetooth ........................
  • Page 3 Xamarin SDK 7-2-11 checkPrinterStatus ..................... 19 7-2-12 getModelName ....................20 7-2-13 getFirmwareVersion ................... 20 7-2-14 printBuffer ......................20 7-2-15 printRawData ..................... 21 7-2-16 drawTextDeviceFont ..................21 7-2-17 drawTextVectorFont ................... 23 7-2-18 drawBarcode1D ....................24 7-2-19 drawBarcodeMaxiCode ..................25 7-2-20 drawBarcodePDF417 ..................26 7-2-21 drawBarcodeQRCode ..................
  • Page 4: Manual Guide

    Xamarin SDK 1. Manual Guide This SDK manual provides descriptions of contents necessary for developing Xamarin.Forms (Portable Class Library, NET Standard) applications. Xamarin library and Demo application were built using Visual Studio 2015 on Windows, and all the contents in this manual are explained based on Visual Studio 2015 on Windows.
  • Page 5: Xamarin Sdk Installation

    Xamarin SDK 3. Xamarin SDK Installation 3-1 Supported Platforms 3-1-1 iOS iOS 9.0 or later In your Xamarin project for iOS, set Deployment Target version to 9.0. Note 3-1-2 Android Android 4.0.3(API Level 15: ice cream sandwich) or later In your Xamarin project for android, set minimum android version to API Level 15.
  • Page 6: Supported Communications

    1. Update the Info.plist file by opening it in XML editor or text editor. Add the following to the file. This is to allow your app to access the Bluetooth port. <key>UISupportedExternalAccessoryProtocols</key> <array><string>com.sato.protocol</string></array> <key>NSBluetoothAlwaysUsageDescription</key> <string>Communication with the printer</string> 2. Put a checkmark on “External Accessory communication” checkbox as a below.
  • Page 7: Installation Instruction

    Xamarin SDK When using Bluetooth and Wi-Fi, there are a few things to modify your project’s settings and configuration information related to permissions for each platform. Note Demo application provided helps you modifying the necessary settings of your own Xamarin application. 3-3 Installation Instruction •...
  • Page 8 Xamarin SDK 4) On the top of the right side, click “Setting” button in red. 5) Click “Package Sources”, and then click “+” button. 6) Browse to the directory where “Xam.Plugin.SatoMpXamarinSDK.x.x.x.nupkg” file exists, and then enter any name you want. “x.x.x”...
  • Page 9 Xamarin SDK 8) Click “OK”. 9) “Xam.Plugin.SatoMpXamarinSDK” package can be found when you select the name you entered in step 6 in the “Package source” list. 10) Click “Project” checkbox to install the entire package. 11) Click “Install” to start installing all the appropriate references to the libraries for each platform project.
  • Page 10: Ispvprinterdevicefactory Reference

    Xamarin SDK 4. ISPVPrinterDeviceFactory Reference 4-1 Overview • "ISPVPrinterDeviceFactory" interface can be used to create an instance implementing "IPrinterDevice" interface for communication with a specific device. All instances for device (printer) control are created using the "createDevice" method. 4-2 Methods Use the “current”...
  • Page 11: Iprinterdevice Reference

    Xamarin SDK 5. IPrinterDevice Reference 5-1 Overview • “IPrinterDevice” interface provides common member methods with regards to the device, and the properties and methods can be used in all the classes implementing this interface. 5-2 Properties 5-2-1 IsOpen The device in the usable status or not. 5-2-2 InterfaceType Communication Interfacetype (Bluetooth, Wi-Fi).
  • Page 12: Openservice

    Xamarin SDK 5-3-2 openService Establishes a communication connection with the device. [Syntax] Task<int> openService(uint timeout = 3 ); [Parameters] uint timeout: Timeout value for connecting a device. [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 5-3-3 closeService Disconnects the communication with the device.
  • Page 13: Iprinterlookup Reference

    Xamarin SDK 6. IPrinterLookup Reference 6-1 Overview • The "IPrinterLookup" interface provides useful methods for searching and retrieving the information needed to connect devices (printers). 6-2 Methods Use the “current” property in “SPVPrinterLookupUtil” class to call the methods defined in this interface. Note refreshDevicesList SPVPrinterLookupUtil.Current.
  • Page 14: Getdeviceslist

    Xamarin SDK 6-2-2 getDevicesList Gets the data collctions containing the connection information discovered by “refreshDeviceList” method. [Parameters] int interface type: communication type for getting device list InterfaceType Enumeration Value Description WI-FI Wi-Fi (wireless LAN) BLUETOOTH Bluetooth [Syntax] ObservableCollection<PrinterConnectionInformation> getDevicesList (int interfaceType) [Returns] ObservableCollection<PrinterConnectionInformation>: data collctions containing the connection information.
  • Page 15: Ilabelprinterdevice Reference

    Xamarin SDK 7. ILabelPrinterDevice Reference 7-1 Overview • The ILabelPrinterDevice interface provides methods for controlling a Label printer. 7-2 Methods 7-2-1 setTextEncoding Sets the codepage used for encoding characters. [Syntax] int setTextEncoding(int textEncoding); [Parameters] • int textEncoding: Code page to use when encoding a character string. LabelCodePage Enumeration Value Description...
  • Page 16: Setcharacterset

    Xamarin SDK 7-2-2 setCharacterset Sets the codepage and international characterset used for encoding characters. [Syntax] Task<int> setCharacterset(int characterset, int internationalCharset); [Parameters] • int characterset: Code page to use when encoding a character string LabelCodePage Enumeration Value Description CP437 USA, Standard Europe CP850 Western European CP852...
  • Page 17: Setlength

    Xamarin SDK KOREA KOREA Code SLOVENIA_CROATIA SLOVENIA Code CHINA CHINA Code [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 7-2-3 setLength Sets the label length, gap, media type, and offset. [Syntax] Task<int> setLength(int labelLength, int gapLength, char mediaType, int offsetLength) [Parameters] •...
  • Page 18: Setwidth

    Xamarin SDK 7-2-5 setWidth Sets the print width. [Syntax] Task<int> setWidth(int labelWidth) [Parameters] • int labelWidth: print width [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 7-2-6 setDensity Sets the print density. [Syntax] Task<int> setDensity(int density) [Parameters] •...
  • Page 19: Setorientation

    Xamarin SDK 7-2-9 setOrientation Sets the printing orientation of the label. [Syntax] Task<int> setOrientation(char orientation) [Parameters] • char orientation: Printing orientation LabelOrientation Enumeration Value Description TOP_TO_BOTTOM ‘T’ Print from top to bottom BOTTOM_TO_TOP ‘B’ Print from bottom to top [Returns] If the method succeeds, the return value is zero(0).
  • Page 20: Getmodelname

    Xamarin SDK 7-2-12 getModelName Gets the printer’s model name. [Syntax] Task<int> getModelName (Action<string> modelDelegate) [Parameters] Action<string> modelDelegate: A delegate with a parameter used for getting a model name. [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 7-2-13 getFirmwareVersion Gets the printer’s firmware version.
  • Page 21: Printrawdata

    Xamarin SDK 7-2-15 printRawData Sends user-defined data to the printer. [Syntax] Task<int> printRawData(byte[] data); [Parameters] • byte[] data: Data to be sent [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 7-2-16 drawTextDeviceFont Saves data of the character strings to the printer buffer using the bitmap font. [Syntax] Task<int>...
  • Page 22 Xamarin SDK • int rightSpace: The space on the right of a character (default value: 0) • int rotation: The printing direction of characters LabelRotation Enumeration Value Description DEGREES_0 No rotated DEGREES_90 Rotated 90 degree (clockwise ) DEGREES_180 Rotated 180 degree DEGREES_270 Rotated 270 degree (clockwise ) •...
  • Page 23: Drawtextvectorfont

    Xamarin SDK 7-2-17 drawTextVectorFont Saves data of the character strings to the printer buffer using the vector font. [Syntax] Task<int> drawTextVectorFont (string data, int xPos, int yPos, char fontSelection, int fontWidth, int fontHeight, int rightSpace, int rotation, bool reverse, bool bold, bool italic, bool rightToLeft, int alignment) [Parameters] •...
  • Page 24: Drawbarcode1D

    Xamarin SDK 7-2-18 drawBarcode1D Saves data of the 1d barcode to the printer buffer. [Syntax] Task<int> drawBarcode1D(string data, int xPos, int yPos, int barcodeType, int widthNarrow, int widthWide, int height, int hri, int quietZoneWidth, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 25: Drawbarcodemaxicode

    Xamarin SDK 7-2-19 drawBarcodeMaxiCode Saves data of the Maxicode barcode to the printer buffer. [Syntax] Task<int> drawBarcodeMaxiCode(string data, int xPos, int yPos, int mode) [Parameters] • string data: data of the barcode • int xPos: x axis coordinates of barcode •...
  • Page 26: Drawbarcodepdf417

    Xamarin SDK 7-2-20 drawBarcodePDF417 Saves data of the PDF417 barcode to the printer buffer. [Syntax] Task<int> drawBarcodePDF417(string data, int xPos, int yPos, int maximumRowCount, int maximumColumnCount, int errorCorrectionLevel, int dataCompressionMethod, bool hri, int barcodeOriginPoint, int moduleWidth, int barHeight, int rotation) [Parameters] •...
  • Page 27: Drawbarcodeqrcode

    Xamarin SDK DEGREES_270 Rotated 270 degree (clockwise ) [Returns] If the method succeeds, the return value is zero(0). Other cases, returns non-zero. 7-2-21 drawBarcodeQRCode Saves data of the QRCode barcode to the printer buffer. [Syntax] Task<int> drawBarcodeQRCode(string data, int xPos, int yPos, int size, int model, int errorCorrectionLevel, int rotation) [Parameters] •...
  • Page 28: Drawbarcodedatamatrix

    Xamarin SDK 7-2-22 drawBarcodeDataMatrix Saves data of the DataMatrix barcode to the printer buffer. [Syntax] Task<int> drawBarcodeDataMatrix(string data, int xPos, int yPos, int size, bool reverse, int rotation); [Parameters] • string data: data of the barcode • int xPos: x axis coordinates of barcode •...
  • Page 29: Drawbarcodeaztec

    Xamarin SDK 7-2-23 drawBarcodeAztec Saves data of the Aztec barcode to the printer buffer. [Syntax] Task<int> drawBarcodeAztec(string data, int xPos, int yPos, int size, bool extendedChannel, int errorCorrectionLevel, bool menuSymbol, int numberOfSymbols, string optionalID, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 30: Drawbarcodecode49

    Xamarin SDK 7-2-24 drawBarcodeCode49 Saves data of the Code49 barcode to the printer buffer. [Syntax] Task<int> drawBarcodeCode49(string data, int xPos, int yPos, int widthNarrow, int widthWide, int height, int hri, int startingMode, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 31: Drawbarcodecodablock

    Xamarin SDK 7-2-25 drawBarcodeCodaBlock Saves data of the CodaBlock barcode to the printer buffer. [Syntax] Task<int> drawBarcodeCodaBlock(string data, int xPos, int yPos, int widthNarrow, int widthWide, int height, bool securityLevel, int numberOfCharactersPerRow, char mode, int numberOfRowToEncode) [Parameters] • string data: data of the barcode •...
  • Page 32: Drawbarcodemicropdf

    Xamarin SDK 7-2-26 drawBarcodeMicroPDF Saves data of the MicroPDF barcode to the printer buffer. [Syntax] Task<int> drawBarcodeMicroPDF(string data, int xPos, int yPos, int moduleWidth, int moduleHeight, int mode, int rotation) [Parameters] • string data: data of the barcode • int xPos: x axis coordinates of barcode •...
  • Page 33: Drawbarcodemsi

    Xamarin SDK 7-2-28 drawBarcodeMSI Saves data of the MSI barcode to the printer buffer. [Syntax] Task<int> drawBarcodeMSI(string data, int xPos, int yPos, int narrowWidth, int widthWide, int height, int checkDigitSelection, bool printCheckDigit, int hri, int rotation); [Parameters] • string data: data of the barcode •...
  • Page 34: Drawbarcodeplessey

    Xamarin SDK 7-2-29 drawBarcodePlessey Saves data of the Plessey barcode to the printer buffer. [Syntax] Task<int> drawBarcodePlessey(string data, int xPos, int yPos, int narrowWidth, int widthWide, int height, bool printCheckDigit, int hri, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 35: Drawbarcodetlc39

    Xamarin SDK 7-2-30 drawBarcodeTLC39 Saves data of the TLC39 barcode to the printer buffer. [Syntax] Task<int> drawBarcodeTLC39(string data, int xPos, int yPos, int narrowWidth, int widthWide, int height, int rowHeightOfMicroPDF417, int narrowWidthOfMicroPDF417, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 36: Drawbarcoderss

    Xamarin SDK 7-2-31 drawBarcodeRSS Saves data of the RSS barcode to the printer buffer. [Syntax] Task<int> drawBarcodeRSS(string data, int xPos, int yPos, int barcodeType, int magnification, .int separatorHeight, int barcodeHeight, int segmentWidth, int rotation) [Parameters] • string data: data of the barcode •...
  • Page 37: Drawblock

    Xamarin SDK 7-2-32 drawBlock Saves data of a quadrangle or line to the printer buffer. [Syntax] Task<int> drawBlock(int startPosX, int startPosY, int endPosX, int endPosY, string option, int thickness) [Parameters] • int startPosX: x axis coordinates of top left • int startPosY: y axis coordinates of top left •...
  • Page 38: Drawcircle

    Xamarin SDK 7-2-33 drawCircle • Saves data of a circle to the printer buffer. [Syntax] Task<int> drawCircle(int startPosX, int startPosY, int sizeSelection, int multiplier) [Parameters] • int startPosX: x axis coordinates of starting point* of circle region Add starting point (intersection point of tangent of left and top) description •...
  • Page 39: Drawimage

    Xamarin SDK 7-2-34 drawImage Saves data of an image to the printer buffer. [Syntax] Task<int> drawImage(object bitmapSrc, int startPosX, int startPosY, int width, int brightness, bool isDithering, bool isCompress) [Parameters] • object bitmapSrc: A platform dependent image object. UIKit.UIImage Android Android.Graphics.Bitmap Note Windows...
  • Page 40: Drawimagefile

    Xamarin SDK 7-2-35 drawImageFile Saves data of the image file specified by the path to the printer buffer. [Syntax] Task<int> drawImageFile(string filePath, int startPosX, int startPosY, int width, int brightness, bool isDithering, bool isCompress) [Parameters] • string filePath: The path of the image file Note In Android, the image file should be in the SD card.
  • Page 41 Xamarin SDK FAIL_NO_DEVICE_FOUND 5000 No device found FAIL_NOT_PERMISSION_ALLOWD 5001 Failed to get permission required FAIL_NOT_SUPPORTED_IMAGE 5002 Not supported file extention _TYPE FAIL_IMAGE_DECODE 5003 Failed to decode image in BASE64 Ver. 1.01 - 41 -...
  • Page 42 SATO CORPORATION. The information contained herein is designed only for use with this SATO product. SATO is not responsible for any direct or indirect damages, arising from or related to use of this information.
  • Page 43 Xamarin SDK Revision History Rev. Date Page Description 1.00 19.10.17 1.01 20.04.17 Added PV4 Modify Supported Platforms for UWP Modify max speed Ver. 1.01 - 43 -...

This manual is also suitable for:

Pv4

Table of Contents