RelianceCore  1.4.0
Reliance Thermal Printer API
Data Structures | Public Types | Public Member Functions
RelianceHID Class Reference

Primary interface for interacting with Reliance Thermal Printer. More...

Data Structures

struct  RelianceStatus
 Status response from Reliance printer. More...
 
struct  Result
 Describes response from all RelianceHID printer commands. More...
 
struct  Revision
 Describes a firmware revision levels using semver syntax. More...
 

Public Types

using ArgList = std::vector< std::string >
 List of string arguments. More...
 

Public Member Functions

RELIANCECORE_EXPORT RelianceHID (const std::string &sn="")
 Create instance of Reliance printer and bind to specified serial number. More...
 
RELIANCECORE_EXPORT ~RelianceHID ()
 Destructor. More...
 
RELIANCECORE_EXPORT Result initialize ()
 Attempt to connect to device. More...
 
RELIANCECORE_EXPORT Result getRevision (Revision *rev)
 Read firmware revision from target. More...
 
RELIANCECORE_EXPORT Result ping ()
 Side effect free command to test for presence of printer. More...
 
RELIANCECORE_EXPORT Result reboot ()
 Immediately perform a hard reboot of the printer. More...
 
RELIANCECORE_EXPORT Result getStatus (RelianceStatus *status)
 Get the current status of Reliance printer. More...
 
RELIANCECORE_EXPORT Result getVirtualCommsEnabled ()
 Gets the state of the USB virtual comm port feature. More...
 
RELIANCECORE_EXPORT Result setVirtualCommsEnabled (bool enabled)
 Enable or disable the USB virtual comm port feature. More...
 
RELIANCECORE_EXPORT Result getStartupTicketEnabled ()
 Gets the state of the startup ticket feature. More...
 
RELIANCECORE_EXPORT Result setStartupTicketEnabled (bool enabled)
 Sets the state of the startup ticket feature. More...
 
RELIANCECORE_EXPORT Result getUnknownCommands (std::vector< int > &dst)
 Returns a list of ESC/POS commands the Reliance does not understand. More...
 
RELIANCECORE_EXPORT Result getPaperWidth ()
 Returns the current configured paper roll width. More...
 
RELIANCECORE_EXPORT Result setPaperWidth (int width)
 Change the paper roll width configuration. More...
 
RELIANCECORE_EXPORT Result getMotorGen ()
 Returns the current motor configuration. More...
 
RELIANCECORE_EXPORT Result setMotorGen (int gen)
 Change the motor configuration to another gen. More...
 
RELIANCECORE_EXPORT Result getMotorCurrent ()
 Returns the current motor current in milliamps. More...
 
RELIANCECORE_EXPORT Result setMotorCurrent (int current)
 Change the motor current. More...
 

Detailed Description

Primary interface for interacting with Reliance Thermal Printer.

Constructor & Destructor Documentation

RELIANCECORE_EXPORT RelianceHID::RelianceHID ( const std::string &  sn = "")
explicit

Create instance of Reliance printer and bind to specified serial number.

Parameters
snserial number to attach to. If not provided, this connects to first available reliance.
RELIANCECORE_EXPORT RelianceHID::~RelianceHID ( )

Destructor.


The documentation for this class was generated from the following file: