├── CHANGELOG ├── COPYING ├── INSTALL.md ├── LICENSE ├── MANIFEST.in ├── README.rst ├── escpos ├── __init__.py ├── constants.py ├── escpos.py ├── exceptions.py └── printer.py └── setup.py /CHANGELOG: -------------------------------------------------------------------------------- 1 | CHANGELOG 2 | 3 | * 2014-03-28 - Version 1.0.3 4 | - Add codepage settings 5 | - Add close method 6 | - Register to PYPI as python-escpos 7 | - Change PIL to Pillow 8 | 9 | * 2012-11-15 - Version 1.0 10 | - Issue #2: Added ethernet support 11 | - Issue #3: Added compatibility with libusb-1.0.1 12 | - Issue #4: Fixed typo in escpos.py 13 | 14 | * 2013-03-14 - Version 1.0.1 15 | - Issue #8: Fixed set font 16 | - Added QR support 17 | 18 | * 2013-12-30 - Version 1.0.2 19 | - Issue #5: Fixed vertical tab 20 | - Issue #9: Fixed identation inconsistence 21 | 22 | * 2013-02-23 - Version 1.0.3 23 | - Issue #18: Added quad-area characters (Sent by syncman1x@gmail.com) 24 | - Added exception for PIL import 25 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /INSTALL.md: -------------------------------------------------------------------------------- 1 | python-escpos 2 | ============= 3 | 4 | Ensure the library is installed on ${lib_arch}/${python_ver}/site-packages/escpos 5 | 6 | On CLi you must run: 7 | # python setup.py build 8 | # sudo python setup.py install 9 | 10 | or from PYPI: 11 | 12 | # pip install python-escpos 13 | 14 | On Linux, ensure you belongs to the proper group so you can have access to the printer. 15 | This can be done, by adding yourself to 'dialout' group, this might require to re-login 16 | so the changes make effect. 17 | 18 | Then, add the following rule to /etc/udev/rules.d/99-escpos.rules 19 | SUBSYSTEM=="usb", ATTRS{idVendor}=="04b8", ATTRS{idProduct}=="0202", MODE="0664", GROUP="dialout" 20 | 21 | and restar udev rules. 22 | # sudo service udev restart 23 | 24 | Enjoy !!! 25 | And please, don't forget to ALWAYS add Epson.cut() at the end of your printing :) 26 | 27 | Manuel F Martinez 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ESCPOS 2 | ====== 3 | 4 | Python library to manipulate ESC/POS Printers. 5 | 6 | 1. Dependencies 7 | --------------- 8 | 9 | In order to start getting access to your printer, you must ensure 10 | you have previously installed the following python modules: 11 | 12 | * pyusb (python-usb) 13 | * Pillow 14 | 15 | 2. Description 16 | -------------- 17 | 18 | Python ESC/POS is a library which lets the user have access to all 19 | those printers handled by ESC/POS commands, as defined by Epson, 20 | from a Python application. 21 | 22 | The standard usage is send raw text to the printer, but in also 23 | helps the user to enhance the experience with those printers by 24 | facilitating the bar code printing in many different standards, 25 | as well as manipulating images so they can be printed as brand 26 | logo or any other usage images migh have. 27 | 28 | Text can be aligned/justified and fonts can be changed by size, 29 | type and weight. 30 | 31 | Also, this module handles some hardware functionalities like, cut 32 | paper, carrier return, printer reset and others concerned to the 33 | carriage alignment. 34 | 35 | 3. Define your printer 36 | ---------------------- 37 | 38 | Before start create your Python ESC/POS printer instance, you must 39 | see at your system for the printer parameters. This is done with 40 | the 'lsusb' command. 41 | 42 | First run the command to look for the "Vendor ID" and "Product ID", 43 | then write down the values, these values are displayed just before 44 | the name of the device with the following format: 45 | 46 | xxxx:xxxx 47 | 48 | Example: 49 | 50 | Bus 002 Device 001: ID 1a2b:1a2b Device name 51 | 52 | Write down the the values in question, then issue the following 53 | command so you can get the "Interface" number and "End Point" 54 | 55 | lsusb -vvv -d xxxx:xxxx | grep iInterface 56 | lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT 57 | 58 | The first command will yields the "Interface" number that must 59 | be handy to have and the second yields the "Output Endpoint" 60 | address. 61 | 62 | By default the "Interface" number is "0" and the "Output Endpoint" 63 | address is "0x82", if you have other values then you can define 64 | with your instance. 65 | 66 | 67 | 4. Define your instance 68 | ----------------------- 69 | 70 | The following example shows how to initialize the Epson TM-TI88IV 71 | 72 | **NOTE**: Always finish the sequence with Epson.cut() otherwise you will endup with weird chars being printed. 73 | 74 | 75 | .. code:: python 76 | 77 | from escpos import * 78 | 79 | """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ 80 | Epson = escpos.Escpos(0x04b8,0x0202,0) 81 | Epson.text("Hello World") 82 | Epson.image("logo.gif") 83 | Epson.barcode 84 | Epson.barcode('1324354657687','EAN13',64,2,'','') 85 | Epson.cut() 86 | 87 | 88 | or use with statement: 89 | 90 | .. code:: python 91 | 92 | with EscposIO(printer.Network('192.168.1.87', port=9100)) as p: 93 | p.set(font='a', codepage='cp1251', size='normal', align='center', bold=True) 94 | p.printer.set(align='center') 95 | p.printer.image('logo.gif') 96 | p.writelines('Big line\n', font='b') 97 | p.writelines(u'Привет', color=2) 98 | p.writelines(u'BIG TEXT', size='2x') 99 | 100 | # After exit of with, printer will cut the paper 101 | 102 | 5. API 103 | ------ 104 | 105 | * Escpos() - main class 106 | * Escpos.image(path_img) - Open image file 107 | * Escpos.qr(text, \*args, \*\*kwargs) - Print QR Code for the provided string 108 | * Escpos.barcode(code, bc, width, height, pos, font) - Print Barcode 109 | * Escpos.text(text) - Print any text 110 | * Escpos.set(codepage=None, \*\*kwargs) - kwargs should be: 111 | * bold: set bold font 112 | * underline: underline text 113 | * size: Text size 114 | * font: Font type 115 | * align: Text position 116 | * inverted: White on black text 117 | * color: Text color 118 | 119 | * Escpos.cut() - Cut the paper 120 | * Escpos.cashdraw(pin) - Send open cashdraw signal to printer pin. 121 | * Escpos.control() and Escpos.hw() - Should be use it when you want to do another operations. 122 | 123 | * EscposIO(printer, autocut=True, autoclose=True) - class for using with 'with' statement. When autocut=False printer not cut the paper after exit of "with". 124 | * EscposIO.set(\*\*kwargs) - set the params in printing stream 125 | * bold: set bold font 126 | * underline: underline text 127 | * size: Text size 128 | * font: Font type 129 | * align: Text position 130 | * inverted: White on black text 131 | * color: Text color 132 | * EscposIO.writelines(text, \*\*params) - Accept params like "set", and apply them for this lines. You should use set() for setting common params. 133 | 134 | 135 | 136 | 6. Links 137 | -------- 138 | 139 | Please visit project homepage at: 140 | http://repo.bashlinux.com/projects/escpos.html 141 | 142 | * Manuel F Martinez 143 | * Dmitry Orlov 144 | -------------------------------------------------------------------------------- /escpos/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = ["constants","escpos","exceptions","printer"] 2 | -------------------------------------------------------------------------------- /escpos/constants.py: -------------------------------------------------------------------------------- 1 | """ ESC/POS Commands (Constants) """ 2 | 3 | # Feed control sequences 4 | CTL_LF = '\x0a' # Print and line feed 5 | CTL_FF = '\x0c' # Form feed 6 | CTL_CR = '\x0d' # Carriage return 7 | CTL_HT = '\x09' # Horizontal tab 8 | CTL_VT = '\x0b' # Vertical tab 9 | # Printer hardware 10 | HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes 11 | HW_SELECT = '\x1b\x3d\x01' # Printer select 12 | HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware 13 | # Cash Drawer 14 | CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] 15 | CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] 16 | # Paper 17 | PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper 18 | PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper 19 | # Text format 20 | 21 | BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF 22 | BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above 23 | BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below 24 | BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and below 25 | BARCODE_FONT_A = '\x1d\x66\x00' # Font type A for HRI barcode chars 26 | BARCODE_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars 27 | BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] 28 | BARCODE_WIDTH = '\x1d\x77\x03' # Barcode Width [2-6] 29 | BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A 30 | BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E 31 | BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 32 | BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 33 | BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 34 | BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF 35 | BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 36 | 37 | # Image format 38 | S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size 39 | S_RASTER_2W = '\x1d\x76\x30\x01' # Set raster image double width 40 | S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height 41 | S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple 42 | 43 | RESET = '\x1b\x40' 44 | 45 | TEXT_STYLE = { 46 | 'bold': { 47 | 0: '\x1b\x45\x00', # Bold font OFF 48 | 1: '\x1b\x45\x01', # Bold font ON 49 | }, 50 | 'underline': { 51 | None: '\x1b\x2d\x00', # Underline font OFF 52 | 1: '\x1b\x2d\x01', # Underline font 1-dot ON 53 | 2: '\x1b\x2d\x02', # Underline font 2-dot ON 54 | }, 55 | 'size': { 56 | 'normal': '\x1b\x21\x00', # Normal text 57 | '2h': '\x1b\x21\x10', # Double height text 58 | '2w': '\x1b\x21\x20', # Double width text 59 | '2x': '\x1b\x21\x30', # Quad area text 60 | }, 61 | 'font': { 62 | 'a': '\x1b\x4d\x00', # Font type A 63 | 'b': '\x1b\x4d\x01', # Font type B 64 | 'c': '\x1b\x4d\x02', # Font type C (may not support) 65 | }, 66 | 'align': { 67 | 'left': '\x1b\x61\x00', # Left justification 68 | 'right': '\x1b\x61\x02', # Right justification 69 | 'center': '\x1b\x61\x01', # Centering 70 | }, 71 | 'inverted': { 72 | False: '\x1d\x42\x00', # Inverted mode ON 73 | True: '\x1d\x42\x01', # Inverted mode OFF 74 | }, 75 | 'color': { 76 | 1: '\x1b\x72\x00', # Select 1st printing color 77 | 2: '\x1b\x72\x00', # Select 2nd printing color 78 | } 79 | } 80 | 81 | PAGE_CP_SET_COMMAND = '\x1b\x74' 82 | PAGE_CP_CODE = { 83 | 'cp437' : 0, 84 | # 'katakana' : 1, 85 | 'cp850' : 2, 86 | 'cp860' : 3, 87 | 'cp863' : 4, 88 | 'cp865' : 5, 89 | 'cp1251' : 6, 90 | 'cp866' : 7, 91 | 'mac_cyrillic': 8, 92 | 'cp775' : 9, 93 | 'cp1253' : 10, 94 | 'cp737' : 11, 95 | 'cp857' : 12, 96 | 'iso8859_9' : 13, 97 | 'cp864' : 14, 98 | 'cp862' : 15, 99 | 'iso8859_2' : 16, 100 | 'cp1253' : 17, 101 | 'cp1250' : 18, 102 | 'cp858' : 19, 103 | 'cp1254' : 20, 104 | # 'TIS_14' : 21, 105 | # 'TIS_17' : 22, 106 | # 'TIS_11' : 23, 107 | 'cp737' : 24, 108 | 'cp1257' : 25, 109 | 'cp847' : 26, 110 | # 'cp720' : 27, 111 | 'cp885' : 28, 112 | 'cp857' : 29, 113 | 'cp1250' : 30, 114 | 'cp775' : 31, 115 | 'cp1254' : 32, 116 | # '' : 33, 117 | 'cp1256' : 34, 118 | 'cp1258' : 35, 119 | 'iso8859_2' : 36, 120 | 'iso8859_3' : 37, 121 | 'iso8859_4' : 38, 122 | 'iso8859_5' : 39, 123 | 'iso8859_6' : 40, 124 | 'iso8859_7' : 41, 125 | 'iso8859_8' : 42, 126 | 'iso8859_9' : 43, 127 | 'iso8859_15' : 44, 128 | # '???' : 45, 129 | 'cp856' : 46, 130 | 'cp874' : 47, 131 | } 132 | -------------------------------------------------------------------------------- /escpos/escpos.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | ''' 3 | @author: Manuel F Martinez 4 | @organization: Bashlinux 5 | @copyright: Copyright (c) 2012 Bashlinux 6 | @license: GPL 7 | ''' 8 | 9 | try: 10 | import Image 11 | except ImportError: 12 | from PIL import Image 13 | 14 | import qrcode 15 | import time 16 | 17 | from constants import * 18 | from exceptions import * 19 | 20 | class EscposIO(object): 21 | ''' ESC/POS Printer IO object''' 22 | def __init__(self, printer, autocut=True, autoclose=True): 23 | self.printer = printer 24 | self.params = {} 25 | self.autocut = autocut 26 | self.autoclose = autoclose 27 | 28 | 29 | def set(self, **kwargs): 30 | """ 31 | :type bold: bool 32 | :param bold: set bold font 33 | :type underline: [None, 1, 2] 34 | :param underline: underline text 35 | :type size: ['normal', '2w', '2h' or '2x'] 36 | :param size: Text size 37 | :type font: ['a', 'b', 'c'] 38 | :param font: Font type 39 | :type align: ['left', 'center', 'right'] 40 | :param align: Text position 41 | :type inverted: boolean 42 | :param inverted: White on black text 43 | :type color: [1, 2] 44 | :param color: Text color 45 | :rtype: NoneType 46 | :returns: None 47 | """ 48 | 49 | self.params.update(kwargs) 50 | 51 | 52 | def writelines(self, text, **kwargs): 53 | params = dict(self.params) 54 | params.update(kwargs) 55 | 56 | if isinstance(text, unicode) or isinstance(text, str): 57 | lines = text.split('\n') 58 | elif isinstance(text, list) or isinstance(text, tuple): 59 | lines = text 60 | else: 61 | lines = ["{0}".format(text),] 62 | 63 | for line in lines: 64 | self.printer.set(**params) 65 | if isinstance(text, unicode): 66 | self.printer.text(u"{0}\n".format(line)) 67 | else: 68 | self.printer.text("{0}\n".format(line)) 69 | 70 | 71 | def close(self): 72 | self.printer.close() 73 | 74 | 75 | def __enter__(self, **kwargs): 76 | return self 77 | 78 | 79 | def __exit__(self, type, value, traceback): 80 | if not (type is not None and issubclass(type, Exception)): 81 | if self.autocut: 82 | self.printer.cut() 83 | 84 | if self.autoclose: 85 | self.close() 86 | 87 | 88 | 89 | class Escpos(object): 90 | """ ESC/POS Printer object """ 91 | device = None 92 | _codepage = None 93 | stored_args = {} 94 | 95 | 96 | def _check_image_size(self, size): 97 | """ Check and fix the size of the image to 32 bits """ 98 | if size % 32 == 0: 99 | return (0, 0) 100 | else: 101 | image_border = 32 - (size % 32) 102 | if (image_border % 2) == 0: 103 | return (image_border / 2, image_border / 2) 104 | else: 105 | return (image_border / 2, (image_border / 2) + 1) 106 | 107 | 108 | def _print_image(self, line, size): 109 | """ Print formatted image """ 110 | i = 0 111 | cont = 0 112 | buffer = "" 113 | 114 | self._raw(S_RASTER_N) 115 | buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1], 0) 116 | self._raw(buffer.decode('hex')) 117 | buffer = "" 118 | 119 | while i < len(line): 120 | hex_string = int(line[i:i+8],2) 121 | buffer += "%02X" % hex_string 122 | i += 8 123 | cont += 1 124 | if cont % 4 == 0: 125 | self._raw(buffer.decode("hex")) 126 | buffer = "" 127 | cont = 0 128 | 129 | 130 | def _convert_image(self, im): 131 | """ Parse image and prepare it to a printable format """ 132 | pixels = [] 133 | pix_line = "" 134 | im_left = "" 135 | im_right = "" 136 | switch = 0 137 | img_size = [ 0, 0 ] 138 | 139 | 140 | if im.size[0] > 512: 141 | print ("WARNING: Image is wider than 512 and could be truncated at print time ") 142 | if im.size[1] > 255: 143 | raise ImageSizeError() 144 | 145 | im_border = self._check_image_size(im.size[0]) 146 | for i in range(im_border[0]): 147 | im_left += "0" 148 | for i in range(im_border[1]): 149 | im_right += "0" 150 | 151 | for y in range(im.size[1]): 152 | img_size[1] += 1 153 | pix_line += im_left 154 | img_size[0] += im_border[0] 155 | for x in range(im.size[0]): 156 | img_size[0] += 1 157 | RGB = im.getpixel((x, y)) 158 | im_color = (RGB[0] + RGB[1] + RGB[2]) 159 | im_pattern = "1X0" 160 | pattern_len = len(im_pattern) 161 | switch = (switch - 1 ) * (-1) 162 | for x in range(pattern_len): 163 | if im_color <= (255 * 3 / pattern_len * (x+1)): 164 | if im_pattern[x] == "X": 165 | pix_line += "%d" % switch 166 | else: 167 | pix_line += im_pattern[x] 168 | break 169 | elif im_color > (255 * 3 / pattern_len * pattern_len) and im_color <= (255 * 3): 170 | pix_line += im_pattern[-1] 171 | break 172 | pix_line += im_right 173 | img_size[0] += im_border[1] 174 | 175 | self._print_image(pix_line, img_size) 176 | 177 | 178 | def image(self,path_img): 179 | """ Open image file """ 180 | im_open = Image.open(path_img) 181 | im = im_open.convert("RGB") 182 | # Convert the RGB image in printable image 183 | self._convert_image(im) 184 | 185 | 186 | def qr(self, text, *args, **kwargs): 187 | """ Print QR Code for the provided string """ 188 | qr_args = dict( 189 | version=4, 190 | box_size=4, 191 | border=1, 192 | error_correction=qrcode.ERROR_CORRECT_M 193 | ) 194 | 195 | qr_args.update(kwargs) 196 | qr_code = qrcode.QRCode(**qr_args) 197 | 198 | qr_code.add_data(text) 199 | qr_code.make(fit=True) 200 | qr_img = qr_code.make_image() 201 | im = qr_img._img.convert("RGB") 202 | # Convert the RGB image in printable image 203 | self._convert_image(im) 204 | 205 | 206 | def barcode(self, code, bc, width, height, pos, font): 207 | """ Print Barcode """ 208 | # Align Bar Code() 209 | self._raw(TXT_ALIGN_CT) 210 | # Height 211 | if height >=2 or height <=6: 212 | self._raw(BARCODE_HEIGHT) 213 | else: 214 | raise BarcodeSizeError() 215 | # Width 216 | if width >= 1 or width <=255: 217 | self._raw(BARCODE_WIDTH) 218 | else: 219 | raise BarcodeSizeError() 220 | # Font 221 | if font.upper() == "B": 222 | self._raw(BARCODE_FONT_B) 223 | else: # DEFAULT FONT: A 224 | self._raw(BARCODE_FONT_A) 225 | # Position 226 | if pos.upper() == "OFF": 227 | self._raw(BARCODE_TXT_OFF) 228 | elif pos.upper() == "BOTH": 229 | self._raw(BARCODE_TXT_BTH) 230 | elif pos.upper() == "ABOVE": 231 | self._raw(BARCODE_TXT_ABV) 232 | else: # DEFAULT POSITION: BELOW 233 | self._raw(BARCODE_TXT_BLW) 234 | # Type 235 | if bc.upper() == "UPC-A": 236 | self._raw(BARCODE_UPC_A) 237 | elif bc.upper() == "UPC-E": 238 | self._raw(BARCODE_UPC_E) 239 | elif bc.upper() == "EAN13": 240 | self._raw(BARCODE_EAN13) 241 | elif bc.upper() == "EAN8": 242 | self._raw(BARCODE_EAN8) 243 | elif bc.upper() == "CODE39": 244 | self._raw(BARCODE_CODE39) 245 | elif bc.upper() == "ITF": 246 | self._raw(BARCODE_ITF) 247 | elif bc.upper() == "NW7": 248 | self._raw(BARCODE_NW7) 249 | else: 250 | raise BarcodeTypeError() 251 | # Print Code 252 | if code: 253 | self._raw(code) 254 | else: 255 | raise exception.BarcodeCodeError() 256 | 257 | 258 | def text(self, text): 259 | """ Print alpha-numeric text """ 260 | if text: 261 | if self._codepage: 262 | self._raw(unicode(text).encode(self._codepage)) 263 | else: 264 | self._raw(text) 265 | else: 266 | raise TextError() 267 | 268 | 269 | def set(self, codepage=None, **kwargs): 270 | """ 271 | :type bold: bool 272 | :param bold: set bold font 273 | :type underline: [None, 1, 2] 274 | :param underline: underline text 275 | :type size: ['normal', '2w', '2h' or '2x'] 276 | :param size: Text size 277 | :type font: ['a', 'b', 'c'] 278 | :param font: Font type 279 | :type align: ['left', 'center', 'right'] 280 | :param align: Text position 281 | :type inverted: boolean 282 | :param inverted: White on black text 283 | :type color: [1, 2] 284 | :param color: Text color 285 | :rtype: NoneType 286 | :returns: None 287 | """ 288 | 289 | for key in kwargs.iterkeys(): 290 | if not TEXT_STYLE.has_key(key): 291 | raise KeyError('Parameter {0} is wrong.'.format(key)) 292 | 293 | for key, value in TEXT_STYLE.iteritems(): 294 | if kwargs.has_key(key): 295 | cur = kwargs[key] 296 | if isinstance(cur, str) or isinstance(cur, unicode): 297 | cur = cur.lower() 298 | 299 | if value.has_key(cur): 300 | self._raw(value[cur]) 301 | else: 302 | raise AttributeError( 303 | 'Attribute {0} is wrong.'.format(cur) 304 | ) 305 | 306 | # Codepage 307 | if codepage: 308 | self._codepage = codepage 309 | self._raw(PAGE_CP_SET_COMMAND + chr(PAGE_CP_CODE[codepage])) 310 | 311 | def cut(self, mode='', postfix="\n\n\n\n\n"): 312 | """ Cut paper """ 313 | # Fix the size between last line and cut 314 | # TODO: handle this with a line feed 315 | self._raw(postfix) 316 | if mode.upper() == "PART": 317 | self._raw(PAPER_PART_CUT) 318 | else: # DEFAULT MODE: FULL CUT 319 | self._raw(PAPER_FULL_CUT) 320 | 321 | 322 | def cashdraw(self, pin): 323 | """ Send pulse to kick the cash drawer """ 324 | if pin == 2: 325 | self._raw(CD_KICK_2) 326 | elif pin == 5: 327 | self._raw(CD_KICK_5) 328 | else: 329 | raise CashDrawerError() 330 | 331 | 332 | def hw(self, hw): 333 | """ Hardware operations """ 334 | if hw.upper() == "INIT": 335 | self._raw(HW_INIT) 336 | elif hw.upper() == "SELECT": 337 | self._raw(HW_SELECT) 338 | elif hw.upper() == "RESET": 339 | self._raw(HW_RESET) 340 | else: # DEFAULT: DOES NOTHING 341 | pass 342 | 343 | self._codepage = None 344 | 345 | 346 | def control(self, ctl): 347 | """ Feed control sequences """ 348 | if ctl.upper() == "LF": 349 | self._raw(CTL_LF) 350 | elif ctl.upper() == "FF": 351 | self._raw(CTL_FF) 352 | elif ctl.upper() == "CR": 353 | self._raw(CTL_CR) 354 | elif ctl.upper() == "HT": 355 | self._raw(CTL_HT) 356 | elif ctl.upper() == "VT": 357 | self._raw(CTL_VT) 358 | 359 | def close(self): 360 | self._raw(RESET) 361 | self.__del__() 362 | -------------------------------------------------------------------------------- /escpos/exceptions.py: -------------------------------------------------------------------------------- 1 | """ ESC/POS Exceptions classes """ 2 | 3 | import os 4 | 5 | class Error(Exception): 6 | """ Base class for ESC/POS errors """ 7 | def __init__(self, msg, status=None): 8 | Exception.__init__(self) 9 | self.msg = msg 10 | self.resultcode = 1 11 | if status is not None: 12 | self.resultcode = status 13 | 14 | def __str__(self): 15 | return self.msg 16 | 17 | # Result/Exit codes 18 | # 0 = success 19 | # 10 = No Barcode type defined 20 | # 20 = Barcode size values are out of range 21 | # 30 = Barcode text not supplied 22 | # 40 = Image height is too large 23 | # 50 = No string supplied to be printed 24 | # 60 = Invalid pin to send Cash Drawer pulse 25 | 26 | 27 | class BarcodeTypeError(Error): 28 | def __init__(self, msg=""): 29 | Error.__init__(self, msg) 30 | self.msg = msg 31 | self.resultcode = 10 32 | 33 | def __str__(self): 34 | return "No Barcode type is defined" 35 | 36 | class BarcodeSizeError(Error): 37 | def __init__(self, msg=""): 38 | Error.__init__(self, msg) 39 | self.msg = msg 40 | self.resultcode = 20 41 | 42 | def __str__(self): 43 | return "Barcode size is out of range" 44 | 45 | class BarcodeCodeError(Error): 46 | def __init__(self, msg=""): 47 | Error.__init__(self, msg) 48 | self.msg = msg 49 | self.resultcode = 30 50 | 51 | def __str__(self): 52 | return "Code was not supplied" 53 | 54 | class ImageSizeError(Error): 55 | def __init__(self, msg=""): 56 | Error.__init__(self, msg) 57 | self.msg = msg 58 | self.resultcode = 40 59 | 60 | def __str__(self): 61 | return "Image height is longer than 255px and can't be printed" 62 | 63 | class TextError(Error): 64 | def __init__(self, msg=""): 65 | Error.__init__(self, msg) 66 | self.msg = msg 67 | self.resultcode = 50 68 | 69 | def __str__(self): 70 | return "Text string must be supplied to the text() method" 71 | 72 | 73 | class CashDrawerError(Error): 74 | def __init__(self, msg=""): 75 | Error.__init__(self, msg) 76 | self.msg = msg 77 | self.resultcode = 60 78 | 79 | def __str__(self): 80 | return "Valid pin must be set to send pulse" 81 | -------------------------------------------------------------------------------- /escpos/printer.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | ''' 3 | @author: Manuel F Martinez 4 | @organization: Bashlinux 5 | @copyright: Copyright (c) 2012 Bashlinux 6 | @license: GPL 7 | ''' 8 | 9 | import usb.core 10 | import usb.util 11 | import serial 12 | import socket 13 | 14 | from escpos import * 15 | from constants import * 16 | from exceptions import * 17 | 18 | class Usb(Escpos): 19 | """ Define USB printer """ 20 | 21 | def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, out_ep=0x01): 22 | """ 23 | @param idVendor : Vendor ID 24 | @param idProduct : Product ID 25 | @param interface : USB device interface 26 | @param in_ep : Input end point 27 | @param out_ep : Output end point 28 | """ 29 | self.idVendor = idVendor 30 | self.idProduct = idProduct 31 | self.interface = interface 32 | self.in_ep = in_ep 33 | self.out_ep = out_ep 34 | self.open() 35 | 36 | 37 | def open(self): 38 | """ Search device on USB tree and set is as escpos device """ 39 | self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct) 40 | if self.device is None: 41 | print "Cable isn't plugged in" 42 | 43 | if self.device.is_kernel_driver_active(0): 44 | try: 45 | self.device.detach_kernel_driver(0) 46 | except usb.core.USBError as e: 47 | print "Could not detatch kernel driver: %s" % str(e) 48 | 49 | try: 50 | self.device.set_configuration() 51 | self.device.reset() 52 | except usb.core.USBError as e: 53 | print "Could not set configuration: %s" % str(e) 54 | 55 | 56 | def _raw(self, msg): 57 | """ Print any command sent in raw format """ 58 | self.device.write(self.out_ep, msg, self.interface) 59 | 60 | 61 | def __del__(self): 62 | """ Release USB interface """ 63 | if self.device: 64 | usb.util.dispose_resources(self.device) 65 | self.device = None 66 | 67 | 68 | 69 | class Serial(Escpos): 70 | """ Define Serial printer """ 71 | 72 | def __init__(self, devfile="/dev/ttyS0", baudrate=9600, bytesize=8, timeout=1): 73 | """ 74 | @param devfile : Device file under dev filesystem 75 | @param baudrate : Baud rate for serial transmission 76 | @param bytesize : Serial buffer size 77 | @param timeout : Read/Write timeout 78 | """ 79 | self.devfile = devfile 80 | self.baudrate = baudrate 81 | self.bytesize = bytesize 82 | self.timeout = timeout 83 | self.open() 84 | 85 | 86 | def open(self): 87 | """ Setup serial port and set is as escpos device """ 88 | self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate, bytesize=self.bytesize, parity=serial.PARITY_NONE, stopbits=serial.STOPBITS_ONE, timeout=self.timeout, dsrdtr=True) 89 | 90 | if self.device is not None: 91 | print "Serial printer enabled" 92 | else: 93 | print "Unable to open serial printer on: %s" % self.devfile 94 | 95 | 96 | def _raw(self, msg): 97 | """ Print any command sent in raw format """ 98 | self.device.write(msg) 99 | 100 | 101 | def __del__(self): 102 | """ Close Serial interface """ 103 | if self.device is not None: 104 | self.device.close() 105 | 106 | 107 | 108 | class Network(Escpos): 109 | """ Define Network printer """ 110 | 111 | def __init__(self,host,port=9100): 112 | """ 113 | @param host : Printer's hostname or IP address 114 | @param port : Port to write to 115 | """ 116 | self.host = host 117 | self.port = port 118 | self.open() 119 | 120 | 121 | def open(self): 122 | """ Open TCP socket and set it as escpos device """ 123 | self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 124 | self.device.connect((self.host, self.port)) 125 | 126 | if self.device is None: 127 | print "Could not open socket for %s" % self.host 128 | 129 | 130 | def _raw(self, msg): 131 | """ Print any command sent in raw format """ 132 | self.device.send(msg) 133 | 134 | 135 | def __del__(self): 136 | """ Close TCP connection """ 137 | self.device.close() 138 | 139 | 140 | 141 | class File(Escpos): 142 | """ Define Generic file printer """ 143 | 144 | def __init__(self, devfile="/dev/usb/lp0"): 145 | """ 146 | @param devfile : Device file under dev filesystem 147 | """ 148 | self.devfile = devfile 149 | self.open() 150 | 151 | 152 | def open(self): 153 | """ Open system file """ 154 | self.device = open(self.devfile, "wb") 155 | 156 | if self.device is None: 157 | print "Could not open the specified file %s" % self.devfile 158 | 159 | 160 | def _raw(self, msg): 161 | """ Print any command sent in raw format """ 162 | self.device.write(msg); 163 | 164 | 165 | def __del__(self): 166 | """ Close system file """ 167 | self.device.close() 168 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | from distutils.core import setup 4 | 5 | setup( 6 | name='python-escpos', 7 | version='1.1.0', 8 | url='https://github.com/mosquito/python-escpos', 9 | download_url='https://github.com/mosquito/python-escpos/archive/master.zip', 10 | description='Python library to manipulate ESC/POS Printers', 11 | long_description=open('README.rst').read(), 12 | license='LGPL', 13 | author=['Manuel F Martinez', 'Dmitry Orlov'], 14 | author_email=['manpaz@bashlinux.com', 'me@mosquito.su'], 15 | platforms=['linux'], 16 | packages=[ 17 | 'escpos', 18 | ], 19 | install_requires=[ 20 | 'pyusb', 21 | 'Pillow>=2.0', 22 | 'qrcode>=4.0', 23 | 'pyserial', 24 | ], 25 | ) 26 | --------------------------------------------------------------------------------