Exceptions¶
Module escpos.exceptions
ESC/POS Exceptions classes
Result/Exit codes:
0 = success
10 = No Barcode type defined
BarcodeTypeError
20 = Barcode size values are out of range
BarcodeSizeError
30 = Barcode text not supplied
BarcodeCodeError
40 = Image height is too large
ImageSizeError
41 = Image width is too large
ImageWidthError
50 = No string supplied to be printed
TextError
60 = Invalid pin to send Cash Drawer pulse
CashDrawerError
70 = Invalid number of tab positions
TabPosError
80 = Invalid char code
CharCodeError
90 = USB device not found
USBNotFoundError
100 = Set variable out of range
SetVariableError
200 = Configuration not found
ConfigNotFoundError
210 = Configuration syntax error
ConfigSyntaxError
220 = Configuration section not found
ConfigSectionMissingError
- author
Manuel F Martinez and others
- organization
Bashlinux and python-escpos
- copyright
Copyright (c) 2012-2017 Bashlinux and python-escpos
- license
MIT
- exception escpos.exceptions.Error(msg, status=None)[source]¶
Bases:
Exception
Base class for ESC/POS errors
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.BarcodeTypeError(msg='')[source]¶
Bases:
escpos.exceptions.Error
No Barcode type defined.
This exception indicates that no known barcode-type has been entered. The barcode-type has to be one of those specified in
escpos.escpos.Escpos.barcode()
. The returned error code is 10.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.BarcodeSizeError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Barcode size is out of range.
This exception indicates that the values for the barcode size are out of range. The size of the barcode has to be in the range that is specified in
escpos.escpos.Escpos.barcode()
. The resulting returncode is 20.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.BarcodeCodeError(msg='')[source]¶
Bases:
escpos.exceptions.Error
No Barcode code was supplied, or it is incorrect.
No data for the barcode has been supplied in
escpos.escpos.Escpos.barcode()
or the the check parameter was True and the check failed. The returncode for this exception is 30.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.ImageSizeError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Image height is longer than 255px and can’t be printed.
The returncode for this exception is 40.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.ImageWidthError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Image width is too large.
The return code for this exception is 41.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.TextError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Text string must be supplied to the text() method.
This exception is raised when an empty string is passed to
escpos.escpos.Escpos.text()
. The returncode for this exception is 50.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.CashDrawerError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Valid pin must be set in order to send pulse.
A valid pin number has to be passed onto the method
escpos.escpos.Escpos.cashdraw()
. The returncode for this exception is 60.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.TabPosError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Valid tab positions must be set by using from 1 to 32 tabs, and between 1 and 255 tab size values. Both values multiplied must not exceed 255, since it is the maximum tab value.
This exception is raised by
escpos.escpos.Escpos.control()
. The returncode for this exception is 70.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.CharCodeError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Valid char code must be set.
The supplied charcode-name in
escpos.escpos.Escpos.charcode()
is unknown. Ths returncode for this exception is 80.- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.USBNotFoundError(msg='')[source]¶
Bases:
escpos.exceptions.Error
Device wasn’t found (probably not plugged in)
The USB device seems to be not plugged in. Ths returncode for this exception is 90.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.SetVariableError(msg='')[source]¶
Bases:
escpos.exceptions.Error
A set method variable was out of range
Check set variables against minimum and maximum values Ths returncode for this exception is 100.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.ConfigNotFoundError(msg='')[source]¶
Bases:
escpos.exceptions.Error
The configuration file was not found
The default or passed configuration file could not be read Ths returncode for this exception is 200.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.ConfigSyntaxError(msg='')[source]¶
Bases:
escpos.exceptions.Error
The configuration file is invalid
The syntax is incorrect Ths returncode for this exception is 210.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception escpos.exceptions.ConfigSectionMissingError(msg='')[source]¶
Bases:
escpos.exceptions.Error
The configuration file is missing a section
The part of the config asked for doesn’t exist in the loaded configuration Ths returncode for this exception is 220.
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.