MePOS Connect iOS SDK v1.1.0

The MePOS connect iOS SDK is designed to allow communication from any iOS 8 or later capable device. This document is a reference on how to integrate the MePOS unit into your own tablet application. This document does not include information on how to set up the MePOS unit, for this please refer to the documentation that came with your MePOS unit.

The current documentation is a reference of the methods provided to use in Swift language.

Contents

• Supported tablet devices
• Supported MePOS firmware
• Version
• Requirements
• Use of the MePOS connect SDK on iOS
  • Libraries
  • How to import the framework
• Creating a new MePOS object
• MePOS SDK Methods
  • public func setDiagnosticLed(position:Int, colour:Int)
  • public func setCosmeticLedCol(colour:Int)
  • public func printerBusy() -> Bool
  • public func print(receipt: MePOSReceipt, callback: MePOSPrinterCallback?)
  • public func print(receipt: MePOSReceipt)
  • public func printRaw(rawData:String) throws -> Bool
  • public func serialRaw(rawData:String) throws -> Bool
  • public func cashDrawerStatus() -> Int
  • public func openCashDrawer() throws -> Bool
  • public func openCashDrawer(validateCashDrawerStatus:Bool) throws -> Bool
  • public func enableUSB() throws
  • public func disableUSB() throws
  • public func enableCosmeticLEDButton() throws
  • public func disableCosmeticLEDButton() throws
  • public func getFWVersion() -> String
  • public func getSerialNumber() -> String
• MePOSConnectionManager
  • public func setConnectionIPAddress(IPAddress:String)
  • public func setConnectionPort(port:Int32)
• MePOSReceipt
  • public func setCutType(cutType:Int)
  • public func setHeaderFeed(headerFeed:Int)
  • public func setFooterFeed(footerFeed:Int)
  • public func setFeedAfterCut(feedLines:Int)
  • MePOSReceiptBarcodeLine(type:Int, data:String)
  • MePOSReceiptFeedLine(lines:Int)
  • MePOSReceiptImageLine(image:CIImage)
  • MePOSReceiptPriceLine(leftText:String, leftStyle:Int, rightText:String, rightStyle:Int)
  • MePOSReceiptSingleCharLine(chr:Character)
  • MePOSReceiptTextLine(text:String, style:Int, size:Int, position:Int)
  • Text style constants
  • Text size constants
  • Text position constants
• Sample Codes
• MePOS PRO Emulator
• Contact

Supported tablet devices

The MePOS connect library supports Android tablets and Windows PC’s via a USB and Wi-Fi connection. Due to the restrictions of the iOS platform it is not possible to connect to the MePOS unit via USB from an Apple device.

Supported MePOS firmware

The MePOS connect SDK has been tested with the latest MePOS 3.1 firmware.

Version

The current version of the MePOS SDK for iOS is 1.1.0

Requirements

• iOS 8 or later
• XCode 8.3.1
• Works in Swift 3.2 and Objective-C

Use of the MePOS connect SDK on iOS

Libraries

The MePOS connect SDK for iOS is provided as a folder (.framework) for use in XCode. This is a Universal library and should work under the following architectures:

• i386
• x86_64
• arm_v7
• arm64

How to import the framework

Either if you use the framework in a device or a simulator this must be done in two places:

1. Add the framework to your project (Build Phases -> Link Binary -> + -> Other).

2. Add the path to the framework to the library search paths (Build Settings->Search Paths->Library Search Paths).

Creating a new MePOS object

To create a new MePOS object in your application you can use the following code:

Swift

    var mePOS:MePOS = MePOS()

To communicate with a generic ESC/POS thermal printer you can use:

	var mePOS:MePOS = MePOS(withMePOSType:MePOSConnectionType.GENERIC_WIFI)

Objective-C

    MePOS mepos = [[MePOS alloc] init];

##MePOS SDK Methods

Once a MePOS object has been created there are several methods that can be executed that perform actions on the MePOS unit.

public func setDiagnosticLed(position:Int, colour:Int)

sets the diagnostic leds to the position and color indicated. The color codes are shown in the MePOSColorCodes class:

	public static let LED_OFF:Int = 0;
	public static let LED_GREEN:Int = 1;
	public static let LED_RED:Int = 2;
	public static let LED_AMBER:Int = 3;

Also the positions are referenced in the MePOSDiagnosticLEDS class:

	public static let LED_POWER:Int = 0;
	public static let LED_NETWORK:Int = 1;
	public static let LED_TABLET:Int = 2;
	public static let LED_PED:Int = 3;
	public static let LED_PRINTER:Int = 8;
	public static let LED_USB1:Int = 9;
	public static let LED_USB2:Int = 10;

public func setCosmeticLedCol(colour:Int)

Sets the cosmetic led to the color indicated shown in the MePOSColorCodes class:

    public static let COSMETIC_OFF:Int = 0;
    public static let COSMETIC_BLUE:Int = 1;
    public static let COSMETIC_GREEN:Int = 2;
    public static let COSMETIC_CYAN:Int = 3;
    public static let COSMETIC_RED:Int = 4;
    public static let COSMETIC_MAGENTA:Int = 5;
    public static let COSMETIC_YELLOW:Int = 6;
    public static let COSMETIC_WHITE:Int = 7;

public func printerBusy() -> Bool

Asks to the MePOS if the device is printing.

public func print(receipt: MePOSReceipt, callback: MePOSPrinterCallback?)

Prints a predefined MePOS receipt using the built-in receipt printer API. To print a receipt, you must first create a MePOS receipt and add lines to it using the add command.

The example below prints a single line receipt:

	let receipt:MePOSReceipt = MePOSReceipt();
	let textLine:MePOSReceiptTextLine = MePOSReceiptTextLine();
	textLine.setText(text: "RECEIPT", style: MePOS.TEXT_STYLE_BOLD, size: MePOS.TEXT_SIZE_NORMAL, position: MePOS.TEXT_POSITION_CENTER);
	receipt.addLine(line: textLine);
	mepos.print(receipt: receipt, callback:self);

Note that you are asked to supply a MePOSPrinterCallback. We recommend that you implement those methods to get notified when the MePOS starts printing a receipt, finished a receipt or there is an error during the printing process.

public func print(receipt: MePOSReceipt)

Same as print(receipt: receipt, callback: StubPrinterCallback());

public func printRaw(rawData:String) throws -> Bool

Prints raw data through the MePOS. Use this method if you want to send a custom POS message.

public func sendRaw(rawData:String) throws -> Bool

Sends data to the DE9 port

public func cashDrawerStatus() -> Int

Asks the status of the cash drawer if it's opened or closed.

public func openCashDrawer() throws -> Bool

Opens the cash drawer. Same as openCashDrawer(validateCashDrawerStatus:true)

public func openCashDrawer(validateCashDrawerStatus:Bool) throws -> Bool

Opens the cash drawer. If the validateCashDrawerStatus flag is True the SDK will validate if the cash drawer is already opened. If not, the relay signal will be sent. Returns true if the relay signal was sent, false if was prevented due of the validation.

public func enableUSB() throws

Enables the USB ports on the MePOS device.

public func disableUSB() throws

Disables the USB ports on the MePOS device.

public func enableCosmeticLEDButton() throws

Enables the cosmetic LED button to thange the cosmetic colors

public func disableCosmeticLEDButton() throws

Disables the cosmetic LED button to prevent color changes

public func getFWVersion() -> String

Gets the firmware version of the MePOS instance

public func getSerialNumber() -> String

Gets the serial number of the MePOS instance

MePOSConnectionManager

The MePOSConnectionManager can be used to configure the connection settings for the MePOS unit.

public func setConnectionIPAddress(IPAddress:String)

Sets the IP address on which the connection manager will look for a MePOS unit. The default IP address of the MePOS from the factory is 192.168.16.254, if the tablet is connecting to the MePOS as a client then you will not need to change this parameter unless the network settings on the MePOS unit have been changed.

public func setConnectionPort(port:Int32)

Sets the tcp port on which the connection manager will look for a MePOS unit. The default port is 8080, but if you are controlling a generic esc/pos device you might want to change it to 9100.

MePOSReceipt

The MePOS library also contains the classes to define and print a receipt using the receipt printer.

To create a new receipt, use the following code:

	let receipt:MePOSReceipt = MePOSReceipt();

After the receipt has been initialised you can add lines to the receipt for printing.

###public func setCutType(cutType:Int)###

Specifies whether to perform a full or partial cut at the end of the receipt where the cut type is:

• MePOS.CUT_TYPE_FULL
• MePOS.CUT_TYPE_PARTIAL

Once the receipt has been created you can modify how the printer will cut the receipt after it has finished printing. As a default the printer is set to perform a full receipt cut.

By configuring this value as MePOS.CUT_TYPE_PARTIAL the feedAfterCut will override internally to 4 lines. if you need to specify the number of lines after the paper cut you'll need to call setFeedAfterCut(int feedLines) after the cut type configuration.

public func setHeaderFeed(headerFeed:Int)

Specifies the number of feed lines before starting to print the receipt content. As a default is configured to 0 lines.

public func setFooterFeed(footerFeed:Int)

Specifies the number of feed lines after printing the receipt, but before the paper cut. As a default is configured to 12 lines.

public func setFeedAfterCut(feedLines:Int)

Specifies the number of feed lines after cutting the receipt. As a default is configured to 0 lines.

###MePOSReceiptBarcodeLine(type:Int, data:String)### The barcode line can be used to add a barcode to a receipt. There are currently three supported barcode types, UPC-A, Code 39 and PDF417. They are specified using the following constants:

• MePOS.BARCODE_TYPE_UPCA
• MePOS.BARCODE_TYPE_CODE39
• MePOS.BARCODE_TYPE_PDF417

The following example shows how to add a barcode to a receipt:

	receipt.addLine(line: MePOSReceiptBarcodeLine(type:MePOS.BARCODE_TYPE_PDF417, data:"Hello World!"));

By default, the Barcode prints a human-interface readable string below, and a defined height of around 0.35 inches. If you want to customise the height or the hri, please use this constructor instead:

	receipt.addLine(line: MePOSReceiptBarcodeLine(type: MePOS.BARCODE_TYPE_CODE39, hri:MePOS.BARCODE_HRI_NONE, height:0.50, data:"Hello World!"));

Please note that the height is not customisable on PDF 417 barcodes.

###MePOSReceiptFeedLine(lines:Int)###

The feed line can be used to add whitespace to a receipt. The parameter supplied is the number of lines to feed.

The following example shows how to feed 10 lines on a receipt:

	receipt.addLine(line:MePOSReceiptFeedLine(lines:10));

###MePOSReceiptImageLine(image:CIImage)###

The image line can be used to print black and white raster graphics to the printer. The bitmap provided must be a valid Bitmap. The image size should be not less than 288 pixels wide.

The following example shows how to add an image to a receipt:

	let fileUrl:URL = Bundle.main.url(forResource: "my_logo", withExtension: "bmp")!;
	let image:CIImage = CIImage(contentsOf: fileUrl)!;
	receipt.addLine(line: MePOSReceiptImageLine(image: image));

###MePOSReceiptPriceLine(leftText:String, leftStyle:Int, rightText:String, rightStyle:Int)###

The price line can be used to add a line to a receipt with text on the left and right simulating the common price item layout of many receipts. The price line takes parameters defining the text on the left and right and also the style of the text. Text styles are discussed later in this document.

The following example shows how to add a price line to a receipt:

	receipt.addLine(MePOSReceiptPriceLine(leftText:"Some item", leftStyle:MePOS.TEXT_STYLE_NONE, rightText:"Some price", rightStyle:MePOS.TEXT_STYLE_NONE))

###MePOSReceiptSingleCharLine(chr:Character)###

The single character line can be used to fill a single line with the same character. The parameter is the character to repeat across the whole line.

The following example shows how to add a single character line to a receipt:

	receipt.addLine(line:MePOSSingleCharLine(chr:"."))

###MePOSReceiptTextLine(text:String, style:Int, size:Int, position:Int)###

The text line can be used to put text on a receipt on the left centre or right in different sizes or styles. The first parameter is the text to print, the size and position constants are discussed later in this document.

The following example shows how to add a text line to a receipt:

	receipt.addLine(line:MePOSReceiptTextLine(text:"Hello World!", style:MePOS.TEXT_STYLE_NONE, size:MePOS.TEXT_SIZE_NORMAL, position:MePOS.TEXT_POSITION_CENTER));

###Text style constants###

Some of the printer line commands accept a style parameter. This parameter can be any one of the following constants:

• MePOS.TEXT_STYLE_NONE
• MePOS.TEXT_STYLE_BOLD
• MePOS.TEXT_STYLE_ITALIC
• MePOS.TEXT_STYLE_UNDERLINED
• MePOS.TEXT_STYLE_INVERSE

Text styles can also be combined using the "or" operator to achieve a mix of styles, for example to print bold italic text you would use the following:

MePOS.TEXT_STYLE_BOLD | MePOS.TEXT_STYLE_ITALIC

Text size constants

Some of the printer line commands accept a size constant. This can be one of the following but not both:

• MePOS. TEXT_SIZE_NORMAL
• MePOS. TEXT_SIZE_WIDE

###Text position constants###

Some of the printer line commands accept a position constant. This can be any of the following:

• MePOS.TEXT_POSITION_LEFT
• MePOS.TEXT_POSITION_CENTER
• MePOS.TEXT_POSITION_RIGHT

##Sample Codes##

• MePOS Test iOS (Swift)
• MePOS Test iOS (Objective-C)

MePOS PRO Emulator

If you don't have a MePOS PRO unit you can download the MePOS PRO Emulator here

Contact

Please rise a ticket on MePOS Support