Explore the Powerful Printing API in RhoMobile Suite 4.1

Table of Contents

1. Introduction
2. Printing with the New API
3. The Structure of the API
4. Finding a Printer
5. Establishing a Printer Instance
6. Connecting to the Printer
7. Printing Commands
8. Printing Raw Strings
9. Printing from a File
10. Printing Stored Commands
11. Printing Images
12. Storing Images
13. Printing Labels with Barcode
14. Platform Specific Notes
    • Windows Mobile
    • iOS
    • Android
15. Additional Resources

Introduction

Today's webinar will focus on the new printing capabilities offered in the latest release of the mobile suite. The API provides a common interface for printing from JavaScript and Ruby, with support for a variety of printer types. In this session, we will cover the basics of using the API, from finding and establishing a printer to issuing printing commands. We will also demonstrate practical examples of printing raw strings, files, images, and labels with barcodes. Additionally, we will provide platform-specific notes for Windows Mobile, iOS, and Android. So let's dive in and explore the exciting world of printing with the new API.

Printing with the New API

The latest release of the mobile suite introduces a new and improved printing API. With this API, developers can seamlessly integrate printing capabilities into their applications, allowing users to print documents, labels, and more. The API provides a common interface for JavaScript and Ruby, enabling developers to write printer-agnostic code that works across multiple platforms.

The Structure of the API

The printing API is structured into two main classes: RowPrinter and RowPrinterZebra. The RowPrinter class serves as the parent class, containing all the common printer functionalities that are shared across different printer types and manufacturers. On the other HAND, the RowPrinterZebra class is a subclass specifically designed for Zebra printers, providing access to zebra-specific APIs.

When using the API, it is important to include the necessary extensions in your application's build. The RowPrinter extension is required for all printer types, while the RowPrinterZebra extension should be included when working with Zebra printers. These extensions can be included as part of the build process, ensuring that the required functionality is available in your application.

Finding a Printer

The first step in using the printing API is to find an available printer. The API supports both Wi-Fi and Bluetooth printers, and there is a dedicated method called searchPrinters for this purpose. When searching for printers, You can pass parameters such as the IP address for Wi-Fi printers or the Bluetooth MAC address for Bluetooth printers.

It is recommended to fine-tune your search parameters to filter the results and speed up the pairing process. Once a printer is found, it is assigned a temporary printer ID, which can be used to Create a printer instance.

Establishing a Printer Instance

To establish a printer instance, you need to use the getPrinterByID method and pass in the printer ID obtained from the search callback. This will create an instance object of the printer, allowing you to perform various operations such as checking the status of the printer and issuing printing commands.

Connecting to the Printer

Before issuing printing commands, you need to establish a connection to the printer. This can be done using the connect method on the printer instance. It is important to verify the connection status to ensure that the connection was successful before proceeding with any printing operations.

Printing Commands

Once connected to the printer, you can start issuing printing commands. The API provides different methods for printing various types of content, including raw strings, files, images, and labels with barcodes. The choice of method depends on the specific requirements of your application.

Printing Raw Strings

To print a raw STRING, you can use the printRawString method. This method takes a single parameter, which is the string to be printed. If you need to include multiple lines, make sure to include carriage return characters to ensure proper formatting.

Printing from a File

If you have a file containing the printing commands, you can use the sendFileContents method to print its Contents. This method requires the path to the file as a parameter. You can include the file in your application's public folder and provide the qualified path to the method.

Printing Stored Commands

The API also supports printing from stored commands. If the printer has commands stored on it, you can pass the data required for printing without having to send the full set of commands. This can be done using the printStoredFormat method. This method requires parameters such as the barcode data, text, and formatting options.

Printing Images

The printing API allows you to print images as well. You can use the printImageFromFile method to print an image from a file. This method requires the path to the image file as a parameter. Be mindful of the image size and format to ensure compatibility with the printer's capabilities.

Storing Images

If you have images that need to be printed frequently, you can store them on the printer. The storeImage method allows you to store an image on the printer, making it easily accessible for future printing. You can store images in various formats, such as JPEG or PNG.

Printing Labels with Barcode

A common use case for printing is generating labels with barcodes. The API provides the necessary functionality to print barcode labels. By utilizing the appropriate commands, such as drawRectangle and printText, you can create labels with encoded text and barcode data.

Platform Specific Notes

Here are some additional notes specific to Windows Mobile, iOS, and Android:

Windows Mobile

When working with Windows Mobile, it is important to note that an additional printing service application needs to be installed. This application provides the necessary support for printing on Windows Mobile devices. Additionally, it is recommended to disconnect from the printer before navigating away from the page to avoid any potential resource allocation issues.

iOS

For iOS, the API officially supports Zebra printers that are designated as "Made for iPhone/iPod" devices. It is important to pair the printer outside of the Row application before attempting to connect to it. Be sure to consult the documentation for any additional configuration requirements.

Android

On Android, the API requires pairing with the printer before establishing a connection. The pairing process is typically handled by the Android platform and may involve additional dialogues for user interaction. Be mindful of this when working with Bluetooth printers on Android devices.

Additional Resources

To further explore the printing capabilities of the API, here are some additional resources you may find useful:

• Zebra Printing API
• Zebra Printing Programming Guide
• RMMS Testing Repository on GitHub

Feel free to refer to these resources for more in-depth documentation and examples. With the new printing API, you can easily add printing functionality to your applications and provide users with a seamless printing experience.