A class for sending ESC/POS-like code to an Aures customer display. More...
Inheritance diagram for Mike42\Escpos\Devices\AuresCustomerDisplay:
Collaboration diagram for Mike42\Escpos\Devices\AuresCustomerDisplay:
Public Member Functions | |
| initialize () | |
| {} More... | |
| selectTextScrollMode (int $mode=AuresCustomerDisplay::TEXT_VERTICAL_SCROLL) | |
| clear () | |
| Clear the display. | |
| showFirmwareVersion () | |
| Instruct the display to show the firmware version. | |
| selfTest () | |
| Instruct the display to begin a self-test/demo sequence. | |
| showLogo () | |
| Instruct the display to show a pre-loaded logo. More... | |
| text (string $str) | |
| {} More... | |
| feed (int $lines=1) | |
| {} More... | |
 Public Member Functions inherited from Mike42\Escpos\Printer | |
| __construct (PrintConnector $connector, CapabilityProfile $profile=null) | |
| Construct a new print object. More... | |
| barcode (string $content, int $type=Printer::BARCODE_CODE39) | |
| Print a barcode. More... | |
| bitImage (EscposImage $img, int $size=Printer::IMG_DEFAULT) | |
| Print an image, using the older "bit image" command. More... | |
| bitImageColumnFormat (EscposImage $img, int $size=Printer::IMG_DEFAULT) | |
| Print an image, using the older "bit image" command in column format. More... | |
| close () | |
| Close the underlying buffer. More... | |
| cut (int $mode=Printer::CUT_FULL, int $lines=3) | |
| Cut the paper. More... | |
| feed (int $lines=1) | |
| Print and feed line / Print and feed n lines. More... | |
| feedForm () | |
| Some printers require a form feed to release the paper. More... | |
| release () | |
Some slip printers require ESC q sequence to release the paper. | |
| feedReverse (int $lines=1) | |
| Print and reverse feed n lines. More... | |
| getCharacterTable () | |
| getPrintBuffer () | |
| getPrintConnector () | |
| getPrinterCapabilityProfile () | |
| graphics (EscposImage $img, int $size=Printer::IMG_DEFAULT) | |
| Print an image to the printer. More... | |
| initialize () | |
| Initialize printer. More... | |
| pdf417Code (string $content, int $width=3, int $heightMultiplier=3, int $dataColumnCount=0, float $ec=0.10, int $options=Printer::PDF417_STANDARD) | |
| Print a two-dimensional data code using the PDF417 standard. More... | |
| pulse (int $pin=0, int $on_ms=120, int $off_ms=240) | |
| Generate a pulse, for opening a cash drawer if one is connected. More... | |
| qrCode (string $content, int $ec=Printer::QR_ECLEVEL_L, int $size=3, int $model=Printer::QR_MODEL_2) | |
| Print the given data as a QR code on the printer. More... | |
| selectCharacterTable (int $table=0) | |
| Switch character table (code page) manually. More... | |
| selectPrintMode (int $mode=Printer::MODE_FONT_A) | |
| Select print mode(s). More... | |
| selectUserDefinedCharacterSet ($on=true) | |
| Select user-defined character set. More... | |
| setBarcodeHeight (int $height=8) | |
| Set barcode height. More... | |
| setBarcodeWidth (int $width=3) | |
| Set barcode bar width. More... | |
| setBarcodeTextPosition (int $position=Printer::BARCODE_TEXT_NONE) | |
| Set the position for the Human Readable Interpretation (HRI) of barcode characters. More... | |
| setDoubleStrike (bool $on=true) | |
| Turn double-strike mode on/off. More... | |
| setColor (int $color=Printer::COLOR_1) | |
| Select print color on printers that support multiple colors. More... | |
| setEmphasis (bool $on=true) | |
| Turn emphasized mode on/off. More... | |
| setFont (int $font=Printer::FONT_A) | |
| Select font. More... | |
| setJustification (int $justification=Printer::JUSTIFY_LEFT) | |
| Select justification. More... | |
| setLineSpacing (int $height=null) | |
| Set the height of the line. More... | |
| setPrintLeftMargin (int $margin=0) | |
| Set print area left margin. More... | |
| setPrintWidth (int $width=512) | |
| Set print area width. More... | |
| setPrintBuffer (PrintBuffer $buffer) | |
| Attach a different print buffer to the printer. More... | |
| setReverseColors (bool $on=true) | |
| Set black/white reverse mode on or off. More... | |
| setTextSize (int $widthMultiplier, int $heightMultiplier) | |
| Set the size of text, as a multiple of the normal size. More... | |
| setUnderline (int $underline=Printer::UNDERLINE_SINGLE) | |
| Set underline for printed text. More... | |
| setUpsideDown (bool $on=true) | |
| Print each line upside-down (180 degrees rotated). More... | |
| text (string $str) | |
| Add text to the buffer. More... | |
| textChinese (string $str="") | |
| Add Chinese text to the buffer. More... | |
| textRaw (string $str="") | |
| Add text to the buffer without attempting to interpret chararacter codes. More... | |
Public Attributes | |
| const | TEXT_OVERWRITE = 1 |
| Indicates that the text should wrap and type over existing text on the screen, rather than scroll. | |
| const | TEXT_VERTICAL_SCROLL = 2 |
| Indicates that overflowing text should cause the display to scroll vertically, like a computer terminal. | |
| const | TEXT_HORIZONTAL_SCROLL = 3 |
| Indicates that overflowing text should cause the display to scroll horizontally, like a news ticker. | |
| Public Attributes inherited from Mike42\Escpos\Printer | |
| const | NUL = "\x00" |
| ASCII null control character. | |
| const | LF = "\x0a" |
| ASCII linefeed control character. | |
| const | ESC = "\x1b" |
| ASCII escape control character. | |
| const | FS = "\x1c" |
| ASCII form separator control character. | |
| const | FF = "\x0c" |
| ASCII form feed control character. | |
| const | GS = "\x1d" |
| ASCII group separator control character. | |
| const | DLE = "\x10" |
| ASCII data link escape control character. | |
| const | EOT = "\x04" |
| ASCII end of transmission control character. | |
| const | BARCODE_UPCA = 65 |
| Indicates UPC-A barcode when used with Printer::barcode. | |
| const | BARCODE_UPCE = 66 |
| Indicates UPC-E barcode when used with Printer::barcode. | |
| const | BARCODE_JAN13 = 67 |
| Indicates JAN13 barcode when used with Printer::barcode. | |
| const | BARCODE_JAN8 = 68 |
| Indicates JAN8 barcode when used with Printer::barcode. | |
| const | BARCODE_CODE39 = 69 |
| Indicates CODE39 barcode when used with Printer::barcode. | |
| const | BARCODE_ITF = 70 |
| Indicates ITF barcode when used with Printer::barcode. | |
| const | BARCODE_CODABAR = 71 |
| Indicates CODABAR barcode when used with Printer::barcode. | |
| const | BARCODE_CODE93 = 72 |
| Indicates CODE93 barcode when used with Printer::barcode. | |
| const | BARCODE_CODE128 = 73 |
| Indicates CODE128 barcode when used with Printer::barcode. | |
| const | BARCODE_TEXT_NONE = 0 |
| Indicates that HRI (human-readable interpretation) text should not be printed, when used with Printer::setBarcodeTextPosition. | |
| const | BARCODE_TEXT_ABOVE = 1 |
| Indicates that HRI (human-readable interpretation) text should be printed above a barcode, when used with Printer::setBarcodeTextPosition. | |
| const | BARCODE_TEXT_BELOW = 2 |
| Indicates that HRI (human-readable interpretation) text should be printed below a barcode, when used with Printer::setBarcodeTextPosition. | |
| const | COLOR_1 = 0 |
| Use the first color (usually black), when used with Printer::setColor. | |
| const | COLOR_2 = 1 |
| Use the second color (usually red or blue), when used with Printer::setColor. | |
| const | CUT_FULL = 65 |
| Make a full cut, when used with Printer::cut. | |
| const | CUT_PARTIAL = 66 |
| Make a partial cut, when used with Printer::cut. | |
| const | FONT_A = 0 |
| Use Font A, when used with Printer::setFont. | |
| const | FONT_B = 1 |
| Use Font B, when used with Printer::setFont. | |
| const | FONT_C = 2 |
| Use Font C, when used with Printer::setFont. | |
| const | IMG_DEFAULT = 0 |
| Use default (high density) image size, when used with Printer::graphics, Printer::bitImage or Printer::bitImageColumnFormat. | |
| const | IMG_DOUBLE_WIDTH = 1 |
| Use lower horizontal density for image printing, when used with Printer::graphics, Printer::bitImage or Printer::bitImageColumnFormat. | |
| const | IMG_DOUBLE_HEIGHT = 2 |
| Use lower vertical density for image printing, when used with Printer::graphics, Printer::bitImage or Printer::bitImageColumnFormat. | |
| const | JUSTIFY_LEFT = 0 |
| Align text to the left, when used with Printer::setJustification. | |
| const | JUSTIFY_CENTER = 1 |
| Center text, when used with Printer::setJustification. | |
| const | JUSTIFY_RIGHT = 2 |
| Align text to the right, when used with Printer::setJustification. | |
| const | MODE_FONT_A = 0 |
| Use Font A, when used with Printer::selectPrintMode. | |
| const | MODE_FONT_B = 1 |
| Use Font B, when used with Printer::selectPrintMode. | |
| const | MODE_EMPHASIZED = 8 |
| Use text emphasis, when used with Printer::selectPrintMode. | |
| const | MODE_DOUBLE_HEIGHT = 16 |
| Use double height text, when used with Printer::selectPrintMode. | |
| const | MODE_DOUBLE_WIDTH = 32 |
| Use double width text, when used with Printer::selectPrintMode. | |
| const | MODE_UNDERLINE = 128 |
| Underline text, when used with Printer::selectPrintMode. | |
| const | PDF417_STANDARD = 0 |
| Indicates standard PDF417 code. | |
| const | PDF417_TRUNCATED = 1 |
| Indicates truncated PDF417 code. | |
| const | QR_ECLEVEL_L = 0 |
| Indicates error correction level L when used with Printer::qrCode. | |
| const | QR_ECLEVEL_M = 1 |
| Indicates error correction level M when used with Printer::qrCode. | |
| const | QR_ECLEVEL_Q = 2 |
| Indicates error correction level Q when used with Printer::qrCode. | |
| const | QR_ECLEVEL_H = 3 |
| Indicates error correction level H when used with Printer::qrCode. | |
| const | QR_MODEL_1 = 1 |
| Indicates QR model 1 when used with Printer::qrCode. | |
| const | QR_MODEL_2 = 2 |
| Indicates QR model 2 when used with Printer::qrCode. | |
| const | QR_MICRO = 3 |
| Indicates micro QR code when used with Printer::qrCode. | |
| const | STATUS_PRINTER = 1 |
| Indicates a request for printer status when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_OFFLINE_CAUSE = 2 |
| Indicates a request for printer offline cause when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_ERROR_CAUSE = 3 |
| Indicates a request for error cause when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_PAPER_ROLL = 4 |
| Indicates a request for error cause when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_INK_A = 7 |
| Indicates a request for ink A status when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_INK_B = 6 |
| Indicates a request for ink B status when used with Printer::getPrinterStatus (experimental) | |
| const | STATUS_PEELER = 8 |
| Indicates a request for peeler status when used with Printer::getPrinterStatus (experimental) | |
| const | UNDERLINE_NONE = 0 |
| Indicates no underline when used with Printer::setUnderline. | |
| const | UNDERLINE_SINGLE = 1 |
| Indicates single underline when used with Printer::setUnderline. | |
| const | UNDERLINE_DOUBLE = 2 |
| Indicates double underline when used with Printer::setUnderline. | |
Protected Member Functions | |
| selectEscposMode () | |
| Selects ESC/POS mode. More... | |
| Protected Member Functions inherited from Mike42\Escpos\Printer | |
| wrapperSend2dCodeData (string $fn, string $cn, string $data='', string $m='') | |
| Wrapper for GS ( k, to calculate and send correct data length. More... | |
| wrapperSendGraphicsData (string $m, string $fn, string $data='') | |
| Wrapper for GS ( L, to calculate and send correct data length. More... | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from Mike42\Escpos\Printer | |
| static | dataHeader (array $inputs, bool $long=true) |
| Convert widths and heights to characters. More... | |
| static | intLowHigh (int $input, int $length) |
| Generate two characters for a number: In lower and higher parts, or more parts as needed. More... | |
| static | validateBoolean (bool $test, string $source) |
| Throw an exception if the argument given is not a boolean. More... | |
| static | validateFloat (float $test, float $min, float $max, string $source, string $argument="Argument") |
| Throw an exception if the argument given is not a float within the specified range. More... | |
| static | validateInteger (int $test, int $min, int $max, string $source, string $argument="Argument") |
| Throw an exception if the argument given is not an integer within the specified range. More... | |
| static | validateIntegerMulti (int $test, array $ranges, string $source, string $argument="Argument") |
| Throw an exception if the argument given is not an integer within one of the specified ranges. More... | |
| static | validateStringRegex (string $test, string $source, string $regex, string $argument="Argument") |
| Throw an exception if the argument doesn't match the given regex. More... | |
| Protected Attributes inherited from Mike42\Escpos\Printer | |
| $buffer | |
| The printer's output buffer. | |
| $connector | |
| Connector showing how to print to this printer. | |
| $profile | |
| Profile showing supported features for this printer. | |
| $characterTable | |
| Current character code table. | |
Detailed Description
A class for sending ESC/POS-like code to an Aures customer display.
The display has some features that printers do not, such as an ability to "clear" the screen.
Member Function Documentation
◆ feed()
| Mike42\Escpos\Devices\AuresCustomerDisplay::feed | ( | int | $lines = 1 | ) |
{}
- See also
- ::feed()
◆ initialize()
| Mike42\Escpos\Devices\AuresCustomerDisplay::initialize | ( | ) |
{}
- See also
- ::initialize()
◆ selectEscposMode()
|
protected |
Selects ESC/POS mode.
This device supports other modes, which are not used.
◆ selectTextScrollMode()
| Mike42\Escpos\Devices\AuresCustomerDisplay::selectTextScrollMode | ( | int | $mode = AuresCustomerDisplay::TEXT_VERTICAL_SCROLL | ) |
- Parameters
-
int $mode The text scroll mode to use. One of AuresCustomerDisplay::TEXT_OVERWRITE, AuresCustomerDisplay::TEXT_VERTICAL_SCROLL or AuresCustomerDisplay::TEXT_HORIZONTAL_SCROLL
◆ showLogo()
| Mike42\Escpos\Devices\AuresCustomerDisplay::showLogo | ( | ) |
Instruct the display to show a pre-loaded logo.
Note that this driver is not capable of uploading a logo, but that the vendor supplies software which has this function.
◆ text()
| Mike42\Escpos\Devices\AuresCustomerDisplay::text | ( | string | $str | ) |
{}
- See also
- ::text()
The documentation for this class was generated from the following file:
- src/Mike42/Escpos/Devices/AuresCustomerDisplay.php
