commit 297e22d1768fd277ee0b53c0d151823f289e1d9a Author: Sergi Almacellas Abellana Date: Fri Jan 31 21:16:01 2014 +0100 Initial commit diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..909b4eb --- /dev/null +++ b/CHANGELOG @@ -0,0 +1 @@ +* Initial release diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..0ce049c --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,14 @@ +Copyright (C) 2013 NaN·tic + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..3f932bc --- /dev/null +++ b/INSTALL @@ -0,0 +1,27 @@ +Installing +========== + +Prerequisites +------------- + + * see setup.py file + +Installation +------------ + +Once you've downloaded and unpacked the source release, enter the +directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install module to the Python +site-packages directory on your system. + +For advanced options, please refer to the easy_install and/or the distutils +documentation: + + http://peak.telecommunity.com/DevCenter/EasyInstall + http://docs.python.org/inst/inst.html + +To use without installation, extract the archive into ``trytond/modules``. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f040e5e --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,14 @@ +include INSTALL +include README +include TODO +include COPYRIGHT +include CHANGELOG +include LICENSE +include tryton.cfg +include *.xml +include view/*.xml +include *.odt +include locale/*.po +include doc/* +include icons/* +include tests/*.rst diff --git a/README b/README new file mode 100644 index 0000000..413bfc5 --- /dev/null +++ b/README @@ -0,0 +1,35 @@ + +This Module runs with the Tryton application platform. + +Installing +---------- + +See INSTALL + +Support +------- + +If you encounter any problems with this module, please don't hesitate to ask +questions on the NaN·tic bug tracker, mailing list, +wiki or IRC channel: + +* http://doc.tryton-erp.es/ +* http://bitbucket.org/nantic/trytond-sale_pos_esc +* http://groups.tryton.org/ +* http://wiki.tryton.org/ +* irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the NaN·tic web site: + + http://www.nan-tic.com/ diff --git a/TODO b/TODO new file mode 100644 index 0000000..e69de29 diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..e334030 --- /dev/null +++ b/__init__.py @@ -0,0 +1,17 @@ +# The COPYRIGHT file at the top level of this repository contains the full +# copyright notices and license terms. +from trytond.pool import Pool +from .sale import * +from .device import * +from .reporting import * + + +def register(): + Pool.register( + Sale, + PosDevice, + module='sale_pos_esc', type_='model') + Pool.register( + Receipt, + Display, + module='sale_pos_esc', type_='report') diff --git a/device.py b/device.py new file mode 100644 index 0000000..fde0ca2 --- /dev/null +++ b/device.py @@ -0,0 +1,71 @@ +# The COPYRIGHT file at the top level of this repository contains +# the full copyright notices and license terms. +import serial +from escpos import escpos + +from trytond.model import ModelView, fields +from trytond.pool import Pool, PoolMeta +from trytond.rpc import RPC + +__all__ = ['PosDevice'] +__metaclass__ = PoolMeta + + +class PosDevice: + __name__ = 'sale_pos.device' + printer_port = fields.Char(string='Printer Port', help='Port type the ' + 'receipt printer is conntected to.') + display_port = fields.Char('Display port', help='Like /dev/ttyS0') + display_baud = fields.Numeric('BAUD-Rate', digits=(10, 0)) + display_digits = fields.Numeric('Digits per Row', digits=(10, 0)) + logo = fields.Binary('Receipt Logo') + + @classmethod + def __setup__(cls): + super(PosDevice, cls).__setup__() + cls.__rpc__.update({ + 'test_printer': RPC(instantiate=0), + 'test_display': RPC(instantiate=0), + }) + + cls._error_messages.update({ + 'device_unplugged': 'Device %s not found...!', + }) + + @staticmethod + def default_printer_port(): + return '/dev/usb/lp0' + + @staticmethod + def default_display_port(): + return '/dev/ttyS0' + + @staticmethod + def default_display_baud(): + return 9600 + + @classmethod + @ModelView.button + def test_printer(cls, devices): + Receipt = Pool().get('sale_pos.receipt', 'report') + receipt = Receipt() + device = devices[0] + if not device.printer_port or not receipt.device_active(device): + cls.raise_user_error('device_unplugged', device.printer_port) + return + receipt.test_printer(device) + + @classmethod + @ModelView.button + def test_display(cls, devices): + device = devices[0] + if device.display_port: + port = serial.Serial(device.display_port, device.display_baud) + display = escpos.Display(port) + display.set_cursor(False) + display.clear() + display.text('Display works!') + display.new_line() + display.text('Congratulations!') + del display + port.close() diff --git a/device.xml b/device.xml new file mode 100644 index 0000000..f0df3dc --- /dev/null +++ b/device.xml @@ -0,0 +1,18 @@ + + + + + + sale_pos.device + + pos_device_form + + + sale_pos.device + + pos_device_tree + + + + diff --git a/escpos/COPYING b/escpos/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/escpos/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/escpos/INSTALL b/escpos/INSTALL new file mode 100644 index 0000000..4daa4cc --- /dev/null +++ b/escpos/INSTALL @@ -0,0 +1,8 @@ +python-escpos +============= + +Ensure it is present under ${lib_arch}/${python_ver}/site-packages/escpos + +Enjoy !!! + +Manuel F Martinez diff --git a/escpos/README b/escpos/README new file mode 100644 index 0000000..34274f7 --- /dev/null +++ b/escpos/README @@ -0,0 +1,87 @@ +ESCPOS +====== + +Python library to manipulate ESC/POS Printers. + +------------------------------------------------------------------ +1. Dependencies + +In order to start getting access to your printer, you must ensure +you have previously installed the following python modules: + + * pyusb (python-usb) + * PIL (Python Image Library) + +------------------------------------------------------------------ +2. Description + +Python ESC/POS is a library which lets the user have access to all +those printers handled by ESC/POS commands, as defined by Epson, +from a Python application. + +The standard usage is send raw text to the printer, but in also +helps the user to enhance the experience with those printers by +facilitating the bar code printing in many different standards, +as well as manipulating images so they can be printed as brand +logo or any other usage images migh have. + +Text can be aligned/justified and fonts can be changed by size, +type and weight. + +Also, this module handles some hardware functionalities like, cut +paper, carrier return, printer reset and others concerned to the +carriage alignment. + +------------------------------------------------------------------ +3. Define your printer + +Before start create your Python ESC/POS printer instance, you must +see at your system for the printer parameters. This is done with +the 'lsusb' command. + +First run the command to look for the "Vendor ID" and "Product ID", +then write down the values, these values are displayed just before +the name of the device with the following format: + + xxxx:xxxx + +Example: + Bus 002 Device 001: ID 1a2b:1a2b Device name + +Write down the the values in question, then issue the following +command so you can get the "Interface" number and "End Point" + + lsusb -vvv -d xxxx:xxxx | grep iInterface + lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT + +The first command will yields the "Interface" number that must +be handy to have and the second yields the "Output Endpoint" +address. + +By default the "Interface" number is "0" and the "Output Endpoint" +address is "0x82", if you have other values then you can define +with your instance. + +------------------------------------------------------------------ +4. Define your instance + +The following example shows how to initialize the Epson TM-TI88IV + + from escpos import * + + """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ + Epson = escpos.Escpos(0x04b8,0x0202,0) + Epson.text("Hello World") + Epson.image("logo.gif") + Epson.barcode + Epson.barcode('1324354657687','EAN13',64,2,'','') + Epson.cut() + +------------------------------------------------------------------ +5. Links + +Please visit project homepage at: +http://repo.bashlinux.com/projects/escpos.html + +Manuel F Martinez + diff --git a/escpos/__init__.py b/escpos/__init__.py new file mode 100644 index 0000000..b1d15b4 --- /dev/null +++ b/escpos/__init__.py @@ -0,0 +1 @@ +__all__ = ["constants", "escpos", "exceptions"] diff --git a/escpos/constants.py b/escpos/constants.py new file mode 100644 index 0000000..00c6739 --- /dev/null +++ b/escpos/constants.py @@ -0,0 +1,74 @@ +""" ESC/POS Commands (Constants) """ + +# Feed control sequences +CTL_LF = '\x0a' # Print and line feed +CTL_FF = '\x0c' # Form feed +CTL_CR = '\x0d' # Carriage return +CTL_HT = '\x09' # Horizontal tab +CTL_VT = '\x0b' # Vertical tab +# Printer hardware +HW_INIT = '\x1b\x40' # Clear data in buffer and reset modes +HW_SELECT = '\x1b\x3d\x01' # Printer select +HW_RESET = '\x1b\x3f\x0a\x00' # Reset printer hardware +# Printer Modes +MODE_STANDARD = '\x1b\x53' +# Cash Drawer +CD_KICK_2 = '\x1b\x70\x00' # Sends a pulse to pin 2 [] +CD_KICK_5 = '\x1b\x70\x01' # Sends a pulse to pin 5 [] +# Paper +PAPER_FULL_CUT = '\x1d\x56\x00' # Full cut paper +PAPER_PART_CUT = '\x1d\x56\x01' # Partial cut paper +# Text format +TXT_NORMAL = '\x1b\x21\x00' # Normal text +TXT_2HEIGHT = '\x1b\x21\x10' # Double height text +TXT_2WIDTH = '\x1b\x21\x20' # Double width text +TXT_UNDERL_OFF = '\x1b\x2d\x00' # Underline font OFF +TXT_UNDERL_ON = '\x1b\x2d\x01' # Underline font 1-dot ON +TXT_UNDERL2_ON = '\x1b\x2d\x02' # Underline font 2-dot ON +TXT_BOLD_OFF = '\x1b\x45\x00' # Bold font OFF +TXT_BOLD_ON = '\x1b\x45\x01' # Bold font ON +TXT_FONT_A = '\x1b\x4d\x00' # Font type A +TXT_FONT_B = '\x1b\x4d\x01' # Font type B +TXT_ALIGN_LT = '\x1b\x61\x00' # Left justification +TXT_ALIGN_CT = '\x1b\x61\x01' # Centering +TXT_ALIGN_RT = '\x1b\x61\x02' # Right justification +# Barcode format +BARCODE_TXT_OFF = '\x1d\x48\x00' # HRI barcode chars OFF +BARCODE_TXT_ABV = '\x1d\x48\x01' # HRI barcode chars above +BARCODE_TXT_BLW = '\x1d\x48\x02' # HRI barcode chars below +BARCODE_TXT_BTH = '\x1d\x48\x03' # HRI barcode chars both above and below +BARCODE_FONT_A = '\x1d\x66\x00' # Font type A for HRI barcode chars +BARCODE_FONT_B = '\x1d\x66\x01' # Font type B for HRI barcode chars +BARCODE_HEIGHT = '\x1d\x68\x64' # Barcode Height [1-255] +BARCODE_WIDTH = '\x1d\x77\x02' # Barcode Width [2-6] +BARCODE_UPC_A = '\x1d\x6b\x00' # Barcode type UPC-A +BARCODE_UPC_E = '\x1d\x6b\x01' # Barcode type UPC-E +BARCODE_EAN13 = '\x1d\x6b\x02' # Barcode type EAN13 +BARCODE_EAN8 = '\x1d\x6b\x03' # Barcode type EAN8 +BARCODE_CODE39 = '\x1d\x6b\x04' # Barcode type CODE39 +BARCODE_ITF = '\x1d\x6b\x05' # Barcode type ITF +BARCODE_NW7 = '\x1d\x6b\x06' # Barcode type NW7 +BARCODE_CODE128 = '\x1d\x6b\x49' # Barcode type CODE128 +BARCODE_CODE128B = '\x7b\x42' # Code128 character set B +# Image format +S_RASTER_N = '\x1d\x76\x30\x00' # Set raster image normal size +S_RASTER_2W = '\x1d\x76\x30\x01' # Set raster image double width +S_RASTER_2H = '\x1d\x76\x30\x02' # Set raster image double height +S_RASTER_Q = '\x1d\x76\x30\x03' # Set raster image quadruple + +# +# Display Commands +# +DISPLAY_CLEAR = '\x0c' +DISPLAY_CLEAR_LINE = '\x18' +DISPLAY_RESET = '\x1b\x40' +DISPLAY_CURS_MOVE_LEFT = '\x08' +DISPLAY_CURS_MOVE_RIGHT = '\x09' +DISPLAY_CURS_MOVE_UP = '\x1f\x0a' +DISPLAY_CURS_MOVE_DOWN = '\x0a' +DISPLAY_CURS_MOVE_LEFT_MOST = '\x0d' +DISPLAY_CURS_MOVE_RIGHT_MOST= '\x1f\x0d' +DISPLAY_CURS_ON = '\x1f\x43\x01' +DISPLAY_CURS_OFF = '\x1f\x43\x00' +DISPLAY_CURS_MOVE_HOME = '\x0b' + diff --git a/escpos/escpos.py b/escpos/escpos.py new file mode 100644 index 0000000..7e65b98 --- /dev/null +++ b/escpos/escpos.py @@ -0,0 +1,439 @@ +#!/usr/bin/python +''' +@author: Manuel F Martinez +@organization: Bashlinux +@copyright: Copyright (c) 2010 Bashlinux +@license: GPL +''' + +import usb +import Image +import time +from constants import * +from exceptions import * + + +class DeviceDescriptor: + """ Search device on USB tree and return it if found """ + def __init__(self, idVendor, idProduct, interface) : + self.idVendor = idVendor + self.idProduct = idProduct + self.interface = interface + + def get_device(self) : + buses = usb.busses() + for bus in buses : + for device in bus.devices : + if (device.idVendor == self.idVendor + and device.idProduct == self.idProduct): + return device + return None + + +class UsbDevice(object): + handle = None + device = None + + def __init__(self, idVendor, idProduct, interface=0, in_ep=0x82, + out_ep=0x01) : + self.idVendor = idVendor + self.idProduct = idProduct + self.interface = interface + self.in_ep = in_ep + self.out_ep = out_ep + + device_descriptor = DeviceDescriptor(self.idVendor, self.idProduct, + self.interface) + self.device = device_descriptor.get_device() + if not self.device: + print "Cable isn't plugged in" + try: + self.handle = self.device.open() + self.handle.detachKernelDriver(self.interface) # Claim the interface + self.handle.setConfiguration(self.device.configurations[0]) + self.handle.claimInterface(device_descriptor.interface) + #self.handle.AltInterface(device_descriptor.interface) + except usb.USBError, err: + print err + + def write(self, msg): + """ Print any of the commands above, or clear text """ + self.handle.bulkWrite(self.out_ep, msg, 1000) + + def __del__(self): + """ Release device interface """ + if self.handle: + try: + self.handle.releaseInterface() + self.handle.resetEndpoint(self.out_ep) + self.handle.reset() + except Exception, err: + print err + self.handle, self.device = None, None + # Give a chance to return the interface to the system + # The following message could appear if the application is executed + # too fast twice or more times. + # + # >> could not detach kernel driver from interface 0: No data available + # >> No interface claimed + time.sleep(1) + + +class FileDevice(object): + """ + Can be used for printing to /dev/lpX + """ + def __init__(self, filename): + self._filename = filename + self._file = False + + def open_device(self): + try: + self._file = open(self._filename, 'wb') + return True + except: + return False + + def close_device(self): + if self._file: + self._file.close() + self._file = False + + def is_open(self): + return self._file is False + + def write(self, text): + if not self._file: + #raise Exception('Device not open.') + pass + self._file.write(text) + + +class EscPos(object): + """ + Base class for esc/pos devices. + Provides the common communication functionality. + """ + + def __init__(self, port, charset='cp850'): + """ + Port must provide a write method like: + serial.Serial, sys.stdout etc. + """ + self.port = port + self._charset = charset + + def text(self, text): + text = text.encode(self._charset) + self._raw(text) + + def _raw(self, msg): + try: + self.port.write(msg) + except: + print 'Log: Exception of write' + + def close(self): + self.port.close() + + +class Printer(EscPos): + """ ESC/POS Printer object """ + + def _check_image_size(self, size): + """Check and fix the size of the image to 32 bits""" + if size % 32 == 0: + return (0, 0) + else: + image_border = 32 - (size % 32) + if (image_border % 2) == 0: + return (image_border / 2, image_border / 2) + else: + return (image_border / 2, (image_border / 2) + 1) + + def _print_image(self, line, size): + i = 0 + cont = 0 + buffer = "" + self._raw(S_RASTER_N) + buffer = "%02X%02X%02X%02X" % (((size[0]/size[1])/8), 0, size[1], 0) + self._raw(buffer.decode('hex')) + buffer = "" + + while i < len(line): + hex_string = int(line[i:i+8],2) + buffer += "%02X" % hex_string + i += 8 + cont += 1 + if cont % 4 == 0: + self._raw(buffer.decode("hex")) + buffer = "" + cont = 0 + + def image(self, img): + """Parse image and then print it""" + pix_line = "" + im_left = "" + im_right = "" + switch = 0 + img_size = [0, 0] + im_open = Image.open(img) + im = im_open.convert("RGB") + + if im.size[0] > 512: + print "WARNING: Image is wider than 512 and could be truncated at " \ + "print time " + if im.size[1] > 255: + raise ImageSizeError() + + im_border = self._check_image_size(im.size[0]) + for i in range(im_border[0]): + im_left += "0" + for i in range(im_border[1]): + im_right += "0" + + for y in range(im.size[1]): + img_size[1] += 1 + pix_line += im_left + img_size[0] += im_border[0] + for x in range(im.size[0]): + img_size[0] += 1 + RGB = im.getpixel((x, y)) + im_color = (RGB[0] + RGB[1] + RGB[2]) + im_pattern = "1X0" + pattern_len = len(im_pattern) + switch = (switch - 1 ) * (-1) + for x in range(pattern_len): + if im_color <= (255 * 3 / pattern_len * (x+1)): + if im_pattern[x] == "X": + pix_line += "%d" % switch + else: + pix_line += im_pattern[x] + break + elif im_color > (255 * 3 / pattern_len * pattern_len) \ + and im_color <= (255 * 3): + pix_line += im_pattern[-1] + break + pix_line += im_right + img_size[0] += im_border[1] + + self._print_image(pix_line, img_size) + + def barcode(self, code, bc, width, height, pos, font): + """ Print Barcode """ + close_bc = False + + # Align Bar Code() + self._raw(TXT_ALIGN_CT) + self._raw(MODE_STANDARD) + # Height + if height >=2 or height <=6: + self._raw(BARCODE_HEIGHT) + else: + raise BarcodeSizeError() + # Width + + if width >= 1 or width <=255: + self._raw(BARCODE_WIDTH) + else: + raise BarcodeSizeError() + # Font + if font.upper() == "B": + self._raw(BARCODE_FONT_B) + else: # DEFAULT FONT: A + self._raw(BARCODE_FONT_A) + # Position + if pos.upper() == "OFF": + self._raw(BARCODE_TXT_OFF) + elif pos.upper() == "BOTH": + self._raw(BARCODE_TXT_BTH) + elif pos.upper() == "ABOVE": + self._raw(BARCODE_TXT_ABV) + else: # DEFAULT POSITION: BELOW + self._raw(BARCODE_TXT_BLW) + # Type + if bc.upper() == "UPC-A": + self._raw(BARCODE_UPC_A) + elif bc.upper() == "UPC-E": + self._raw(BARCODE_UPC_E) + elif bc.upper() == "EAN13": + self._raw(BARCODE_EAN13) + elif bc.upper() == "EAN8": + self._raw(BARCODE_EAN8) + elif bc.upper() == "CODE39": + self._raw(BARCODE_CODE39) + close_bc = True + elif bc.upper() == "ITF": + self._raw(BARCODE_ITF) + elif bc.upper() == "NW7": + self._raw(BARCODE_NW7) + elif bc.upper() == "CODE128B": + self._raw(BARCODE_CODE128) + self._raw(('%02X' % (len(code) + len(BARCODE_CODE128B)) + ).decode('hex')) + self._raw(BARCODE_CODE128B) + else: + raise BarcodeTypeError() + # Print Code + if code: + self._raw(code) + if close_bc: + self._raw('\x00') + else: + raise exception.BarcodeCodeError() + + def text(self, txt): + """ Print alpha-numeric text """ + if txt: + super(Printer, self).text(txt) + else: + raise TextError() + + def set(self, align='left', font='a', type='normal', width=1, height=1): + """ Set text properties """ + # Align + if align.upper() == "CENTER": + self._raw(TXT_ALIGN_CT) + elif align.upper() == "RIGHT": + self._raw(TXT_ALIGN_RT) + elif align.upper() == "LEFT": + self._raw(TXT_ALIGN_LT) + # Font + if font.upper() == "B": + self._raw(TXT_FONT_B) + else: # DEFAULT FONT: A + self._raw(TXT_FONT_A) + # Type + if type.upper() == "B": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_OFF) + elif type.upper() == "U": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "U2": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL2_ON) + elif type.upper() == "BU": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL_ON) + elif type.upper() == "BU2": + self._raw(TXT_BOLD_ON) + self._raw(TXT_UNDERL2_ON) + elif type.upper == "NORMAL": + self._raw(TXT_BOLD_OFF) + self._raw(TXT_UNDERL_OFF) + # Width + if width == 2 and height != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2WIDTH) + elif height == 2 and width != 2: + self._raw(TXT_NORMAL) + self._raw(TXT_2HEIGHT) + elif height == 2 and width == 2: + self._raw(TXT_2WIDTH) + self._raw(TXT_2HEIGHT) + else: # DEFAULT SIZE: NORMAL + self._raw(TXT_NORMAL) + + def cut(self, mode=''): + """ Cut paper """ + # Fix the size between last line and cut + # TODO: handle this with a line feed + self._raw("\n\n\n\n\n\n") + if mode.upper() == "PART": + self._raw(PAPER_PART_CUT) + else: # DEFAULT MODE: FULL CUT + self._raw(PAPER_FULL_CUT) + + def cashdraw(self, pin): + """ Send pulse to kick the cash drawer """ + print "pulso enviado-------------------------------" + if pin == 2: + self._raw(CD_KICK_2) + elif pin == 5: + self._raw(CD_KICK_5) + else: + raise CashDrawerError() + + def hw(self, hw): + """ Hardware operations """ + if hw.upper() == "INIT": + self._raw(HW_INIT) + elif hw.upper() == "SELECT": + self._raw(HW_SELECT) + elif hw.upper() == "RESET": + self._raw(HW_RESET) + else: # DEFAULT: DOES NOTHING + pass + + def control(self, ctl): + """ Feed control sequences """ + if ctl.upper() == "LF": + self._raw(CTL_LF) + elif ctl.upper() == "FF": + self._raw(CTL_FF) + elif ctl.upper() == "CR": + self._raw(CTL_CR) + elif ctl.upper() == "HT": + self._raw(CTL_HT) + elif ctl.upper() == "VT": + self._raw(CTL_VT) + + +class Display(EscPos): + """ + Esc/Pos Display class + """ + def __init__(self, port, digits=20, charset='cp850'): + super(Display, self).__init__(port, charset) + self._align = 'LEFT' + self._digits = digits + + def text(self, text): + text = text[:self._digits] + if self._align == 'RIGHT': + self.curs_move_right_most() + for i in range(1, len(text)): + self.curs_move_left() + + super(Display, self).text(text) + # Display adds newline if last character is written + if (len(text) == self._digits + or self._align == 'RIGHT'): + self.curs_move_up() + + def set_cursor(self, visible=True): + if visible: + self._raw(DISPLAY_CURS_ON) + else: + self._raw(DISPLAY_CURS_OFF) + + def new_line(self): + self._raw('\n' + DISPLAY_CURS_MOVE_LEFT_MOST) + + def curs_move_left(self): + self._raw(DISPLAY_CURS_MOVE_LEFT) + + def curs_move_right(self): + self._raw(DISPLAY_CURS_MOVE_RIGHT) + + def curs_move_up(self): + self._raw(DISPLAY_CURS_MOVE_UP) + + def curs_move_down(self): + self._raw(DISPLAY_CURS_MOVE_DOWN) + + def curs_move_left_most(self): + self._raw(DISPLAY_CURS_MOVE_LEFT_MOST) + + def curs_move_right_most(self): + self._raw(DISPLAY_CURS_MOVE_RIGHT_MOST) + + def clear(self): + self._raw(DISPLAY_CLEAR) + self._align = 'LEFT' + + def set_align(self, align='left'): + if align.upper() not in ['LEFT', 'RIGHT']: + raise Exception('Align must be left or right') + self._align = align.upper() diff --git a/escpos/exceptions.py b/escpos/exceptions.py new file mode 100644 index 0000000..adbe648 --- /dev/null +++ b/escpos/exceptions.py @@ -0,0 +1,80 @@ +""" ESC/POS Exceptions classes """ + +import os + +class Error(Exception): + """ Base class for ESC/POS errors """ + def __init__(self, msg, status=None): + Exception.__init__(self) + self.msg = msg + self.resultcode = 1 + if status is not None: + self.resultcode = status + + def __str__(self): + return self.msg + +# Result/Exit codes +# 0 = success +# 10 = No Barcode type defined +# 20 = Barcode size values are out of range +# 30 = Barcode text not supplied +# 40 = Image height is too large +# 50 = No string supplied to be printed +# 60 = Invalid pin to send Cash Drawer pulse + + +class BarcodeTypeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 10 + + def __str__(self): + return "No Barcode type is defined" + +class BarcodeSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 20 + + def __str__(self): + return "Barcode size is out of range" + +class BarcodeCodeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 30 + + def __str__(self): + return "Code was not supplied" + +class ImageSizeError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 40 + + def __str__(self): + return "Image height is longer than 255px and can't be printed" + +class TextError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 50 + + def __str__(self): + return "Text string must be supplied to the text() method" + + +class CashDrawerError(Error): + def __init__(self, msg=""): + Error.__init__(self, msg) + self.msg = msg + self.resultcode = 60 + + def __str__(self): + return "Valid pin must be set to send pulse" diff --git a/escpos/test.py b/escpos/test.py new file mode 100644 index 0000000..fe2bbde --- /dev/null +++ b/escpos/test.py @@ -0,0 +1,6 @@ +#! /usr/bin/env python +from escpos import Display +import serial + +display = Display(serial.Serial('/dev/ttyS0', 9600), digits=20, lang='de_DE') +display.text(u'HALLO') diff --git a/locale/ca_ES.po b/locale/ca_ES.po new file mode 100644 index 0000000..5ec5d79 --- /dev/null +++ b/locale/ca_ES.po @@ -0,0 +1,40 @@ +# +msgid "" +msgstr "Content-Type: text/plain; charset=utf-8\n" + +msgctxt "error:sale_pos_esc.device:" +msgid "Device %s not found...!" +msgstr "No s'ha trobat el dispositiu %s." + +msgctxt "field:sale_pos_esc.device,display_baud:" +msgid "BAUD-Rate" +msgstr "Velocitat (BAUD)" + +msgctxt "field:sale_pos_esc.device,display_digits:" +msgid "Digits per Row" +msgstr "Dígits per fila" + +msgctxt "field:sale_pos_esc.device,display_port:" +msgid "Display port" +msgstr "Port del display" + +msgctxt "field:sale_pos_esc.device,logo:" +msgid "Receipt Logo" +msgstr "Logo tiquet" + +msgctxt "field:sale_pos_esc.device,printer_port:" +msgid "Printer Port" +msgstr "Port de la impressora" + +msgctxt "field:sale_pos_esc.device,rec_name:" +msgid "Name" +msgstr "Nom" + +msgctxt "help:sale_pos_esc.device,display_port:" +msgid "Like /dev/ttyS0" +msgstr "Per exemple /dev/ttyS0" + +msgctxt "help:sale_pos_esc.device,printer_port:" +msgid "Port type the receipt printer is conntected to." +msgstr "Tipus de port al que està connectada la impressora de tiquets." + diff --git a/locale/es_ES.po b/locale/es_ES.po new file mode 100644 index 0000000..0e4be61 --- /dev/null +++ b/locale/es_ES.po @@ -0,0 +1,36 @@ +# +msgid "" +msgstr "Content-Type: text/plain; charset=utf-8\n" + +msgctxt "error:sale_pos.device:" +msgid "Device %s not found...!" +msgstr "No se ha encontrado el dispositivo %s." + +msgctxt "field:sale_pos.device,display_baud:" +msgid "BAUD-Rate" +msgstr "Velocidad (BAUD)" + +msgctxt "field:sale_pos.device,display_digits:" +msgid "Digits per Row" +msgstr "Dígitos por fila" + +msgctxt "field:sale_pos.device,display_port:" +msgid "Display port" +msgstr "Puerto del display" + +msgctxt "field:sale_pos.device,name:" +msgid "Device Name" +msgstr "Nombre dispositivo" + +msgctxt "field:sale_pos.device,printer_port:" +msgid "Printer Port" +msgstr "Puerto de la impresora" + +msgctxt "help:sale_pos.device,display_port:" +msgid "Like /dev/ttyS0" +msgstr "Por ejemplo /dev/ttyS0" + +msgctxt "help:sale_pos.device,printer_port:" +msgid "Port type the receipt printer is conntected to." +msgstr "Tipo de puerto al que está conectada la impresora de tickets." + diff --git a/reporting.py b/reporting.py new file mode 100644 index 0000000..a253b70 --- /dev/null +++ b/reporting.py @@ -0,0 +1,337 @@ +# This file is part of sale_pos module for Tryton. +# The COPYRIGHT file at the top level of this repository contains +# the full copyright notices and license terms. +from escpos import escpos +from decimal import Decimal +from cStringIO import StringIO +import datetime +import serial + +from trytond.transaction import Transaction +from trytond.report import Report +from trytond.pool import Pool + +__all__ = ['Receipt', 'Display'] + +_ROW_CHARACTERS = 48 +_DIGITS = 9 + + +class Receipt(Report): + 'Receipt' + __name__ = 'sale_pos.receipt' + + @classmethod + def __setup__(cls): + super(Receipt, cls).__setup__() + cls._config = False + + def load_config(self, device): + self._port = None + self._logo = None + self._config = device + if self._config.printer_port: + self._port = escpos.FileDevice(self._config.printer_port) + if self._config.logo: + self._logo = StringIO(self._config.logo) + + def _open_device(self, device): + self._printer = None + if not self._config: + self.load_config() + + if self._port: + self.is_open = self._port.open_device() + if self.is_open: + self._printer = escpos.Printer(self._port) + return + + def device_active(self, device): + if not self._config: + self.load_config(device) + if self._port: + file_dev = escpos.FileDevice(self._config.printer_port) + return file_dev.open_device() + + def _close_device(self): + if self._port: + self._port.close_device() + if self._printer: + del self._printer + + def printing(f): + def p(self, *p, **kw): + self._open_device(device) + try: + res = f(self, *p, **kw) + finally: + self._close_device() + return res + return p + + @printing + def test_printer(self, device): + #Configuration = Pool().get('sale_pos.device') + #configuration = Configuration(1) + + if device.printer_port: + self.print_logo() + self._printer.text('\n\n') + self.print_impressum() + self._printer.text('\n\n\n') + self._printer.cut() + + def print_logo(self): + if not self._logo: + return + self._printer.set(align='center') + self._printer.image(self._logo) + self._printer.text('\n') + + def print_impressum(self): + self._printer.set(align='center') + company = self._config.company + street = None + city = None + zip_ = None + contact_type = None + contact_value = None + if company.party.addresses: + street = company.party.addresses[0].street + city = company.party.addresses[0].city + zip_ = company.party.addresses[0].zip + if company.party.contact_mechanisms: + contact_type = company.party.contact_mechanisms[0].type + contact_value = company.party.contact_mechanisms[0].value + + self._printer.text(company.party.name + '\n') + if street: + self._printer.text(street + ' ') + if city: + self._printer.text(city) + if street or city: + self._printer.text('\n') + if zip_: + self._printer.text(zip_ + '\n') + if company.party.vat_number: + self._printer.text('NIT ' + company.party.vat_number + ' ') + if contact_type: + self._printer.text(contact_type + ':' + contact_value) + self._printer.text('\n') + + @printing + def kick_cash_drawer(self): + self._printer.cashdraw(2) + + @printing + def print_sale(self, sale): + Lang = Pool().get('ir.lang') + lang, = Lang.search([('code', '=', Transaction().language)]) + Tax = Pool().get('account.tax') + + def print_split(left, right): + len_left = _ROW_CHARACTERS - len(right) - 1 + left = left[:len_left] + left += (len_left - len(left) + 1) * ' ' + self._printer.text(left) + self._printer.text(right + '\n') + + self.print_logo() + self.print_impressum() + self._printer.set(align='left') + self._printer.text('\n') + user = 'Usuario: %s' % sale.create_uid.name + self._printer.text(user) + self._printer.text('\n') + party = 'Tercero: %s' % sale.party.rec_name + self._printer.text(party) + self._printer.text('\n') + + taxes = {} + i = 0 + for tax in sale.taxes: + i += 1 + taxes[tax.id] = {} + taxes[tax.id]['code'] = str(i) + taxes[tax.id]['rec'] = tax + taxes[tax.id]['amount'] = Decimal(0) + taxes = {} + self._printer.text('\n') + num_products = 0 + for line in sale.lines: + if line.line_type == 'subtotal': + print_split('', '------------') + print_split('Total:', self.format_lang(line.total, + lang) + ' ') + self._printer.text('\n') + else: + num_products += 1 + if line.taxes: + for tax in line.taxes: + values = Tax.compute([tax], line.unit_price, + line.quantity)[0] + tax_id = values['tax'].id + if tax_id not in taxes.keys(): + taxes[tax_id] = { + 'name': values['tax'].percentage, + 'base': 0, + 'tax': 0, + 'total': 0 + } + taxes[tax_id]['base'] += values['base'] + taxes[tax_id]['tax'] += values['amount'] + taxes[tax_id]['total'] += (values['base'] + + values['amount']) + else: + tax_id = 0 + base = line.unit_price * line.quantity + tax = 0 + total = base + tax + if '0' not in taxes.keys(): + taxes['0'] = { + 'name': 0, + 'base': 0, + 'tax': 0, + 'total': 0, + } + taxes['0']['base'] += base + taxes['0']['tax'] += tax + taxes['0']['total'] += total + + tax_id = str(tax_id) + if line.quantity != 1 or len(line.name) > (_ROW_CHARACTERS - + (_DIGITS + 1)): + self._printer.text(line.name[:_ROW_CHARACTERS] + '\n') + pos_text = ' %s x %s' % ( + self.format_lang(line.quantity, lang, digits=1), + self.format_lang(line.unit_price, lang), + ) + total = self.format_lang(line.total, lang) + print_split(pos_text, total + ' ' + tax_id) + else: + print_split( + line.name, + self.format_lang(line.total, lang) + ' ' + tax_id + ), + + print_split('Efectivo:', self.format_lang(sale.total_paid, + lang) + ' ') + print_split('Cambio:', self.format_lang(sale.drawback, lang) + ' ') + self._printer.text('\n' * 2) + #cols = 4 + col_width = int(_ROW_CHARACTERS / 4) + f = lambda x, l: self._printer.text(x[:l] + (l - len(x)) * ' ') + f('Tipo', col_width) + f('Base', col_width) + f('Imp.', col_width) + f('Total', col_width) + self._printer.text('\n') + for tax in taxes: + f(str(tax) + '=' + self.format_lang(taxes[tax]['name'], + lang) + '%', col_width) + total = taxes[tax]['total'] + base = taxes[tax]['base'] + tax = taxes[tax]['tax'] + f(self.format_lang(base, lang), col_width) + f(self.format_lang(tax, lang), col_width) + f(self.format_lang(total, lang), col_width) + self._printer.text('\n') + + self._printer.text('\n') + no_products = 'No Productos: %d' % num_products + self._printer.text(no_products) + self._printer.text('\n') + self._printer.set(align='center') + self._printer.text('No Fact. ' + sale.receipt_code) + #printer.barcode(sale.receipt_code, 'CODE128B', 3, 50,'','') + self._printer.text('\n') + self._printer.text(self.format_lang(datetime.datetime.now(), lang, + date=True)) + self._printer.text('\n') + self._printer.text('Presik Technologies - POS System') + self._printer.text('\n') + self._printer.text('www.presik.com - Cel: 3012457967') + self._printer.cut() + + def _compute_tax(self, sale): + tax_codes = [] + return tax_codes + + +class Display(Report): + 'Display' + __name__ = 'sale_pos.display' + + @classmethod + def __setup__(cls): + super(Display, cls).__setup__() + cls._display = False + + def _get_lang(self): + Lang = Pool().get('ir.lang') + lang, = Lang.search([('code', '=', Transaction().language)]) + return lang + + def load_display(self): + Configuration = Pool().get('sale_pos.pos_device') + configuration = Configuration(1) + + if configuration.display_port: + self._display = escpos.Display(serial.Serial( + configuration.display_port, configuration.display_baud), + digits=int(configuration.display_digits)) + self._display.set_cursor(False) + + def displaying(f): + def p(self, *p, **kw): + if not self._display: + self.load_display() + return f(self, *p, **kw) + return p + + @displaying + def show_sale_line(self, sale_line): + Configuration = Pool().get('sale_pos.pos_device') + configuration = Configuration(1) + if configuration.display_port: + lang = self._get_lang() + self._display.clear() + self._display.set_align('left') + self._display.text(sale_line.product.name) + self._display.new_line() + self._display.text('%s x %s' % ( + self.format_lang(sale_line.quantity, lang, digits=0), + self.format_lang(sale_line.unit_price, lang), + )) + self._display.set_align('right') + self._display.text(self.format_lang(sale_line.total, lang)) + + @displaying + def show_total(self, sale): + Configuration = Pool().get('sale_pos.pos_device') + configuration = Configuration(1) + + if configuration.display_port: + lang = self._get_lang() + self._display.clear() + self._display.text('Total:') + self._display.set_align('right') + self._display.text(self.format_lang(sale.total_amount, lang)) + + @displaying + def show_paid(self, sale): + Configuration = Pool().get('sale_pos.pos_device') + configuration = Configuration(1) + + if configuration.display_port: + lang = self._get_lang() + self._display.clear() + self._display.text('Pagado:') + self._display.set_align('right') + f = lambda x: self.format_lang(x, lang) + self._display.text(f(sale.total_paid)) + self._display.new_line() + self._display.set_align('left') + self._display.text('Cambio:') + self._display.set_align('right') + self._display.text(f(sale.drawback)) diff --git a/sale.py b/sale.py new file mode 100644 index 0000000..cf3daf3 --- /dev/null +++ b/sale.py @@ -0,0 +1,24 @@ +# The COPYRIGHT file at the top level of this repository contains +# the full copyright notices and license terms. +from trytond.pool import PoolMeta + +__metaclass__ = PoolMeta + + +class Sale: + __name__ = 'sale.sale' + + @classmethod + def __setup__(cls): + super(Sale, cls).__setup__() +# cls.__rpc__.update({ +# 'add_sum': RPC(readonly=False, instantiate=0), +# }) + + @classmethod + def add_sum(cls, sales): + super(Sale, cls).add_sum(sales) +# Configuration = Pool().get('sale_pos.configuration') +# configuration = Configuration(1) +# if configuration.display_port: +# sale._display.show_total(cls.browse(sales)) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..fbf5e40 --- /dev/null +++ b/setup.py @@ -0,0 +1,88 @@ +#!/usr/bin/env python +# encoding: utf-8 + +from setuptools import setup +import re +import os +import ConfigParser + +MODULE = 'sale_pos_esc' +PREFIX = 'nantic' +MODULE2PREFIX = {} + + +def read(fname): + return open(os.path.join(os.path.dirname(__file__), fname)).read() + +config = ConfigParser.ConfigParser() +config.readfp(open('tryton.cfg')) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +major_version, minor_version, _ = info.get('version', '0.0.1').split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) + +requires = [] +for dep in info.get('depends', []): + if not re.match(r'(ir|res|webdav)(\W|$)', dep): + prefix = MODULE2PREFIX.get(dep, 'trytond') + requires.append('%s_%s >= %s.%s, < %s.%s' % + (prefix, dep, major_version, minor_version, + major_version, minor_version + 1)) +requires.append('trytond >= %s.%s, < %s.%s' % + (major_version, minor_version, major_version, minor_version + 1)) + +tests_require = ['proteus >= %s.%s, < %s.%s' % + (major_version, minor_version, major_version, minor_version + 1)] + +setup(name='%s_%s' % (PREFIX, MODULE), + version=info.get('version', '0.0.1'), + description='', + long_description=read('README'), + author='NaN·tic', + url='http://www.nan-tic.com/', + download_url="https://bitbucket.org/nantic/trytond-%s" % MODULE, + package_dir={'trytond.modules.%s' % MODULE: '.'}, + packages=[ + 'trytond.modules.%s' % MODULE, + 'trytond.modules.%s.tests' % MODULE, + ], + package_data={ + 'trytond.modules.%s' % MODULE: (info.get('xml', []) + + ['tryton.cfg', 'locale/*.po', 'tests/*.rst']), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Framework :: Tryton', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: GNU General Public License (GPL)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Catalan', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Russian', + 'Natural Language :: Spanish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Topic :: Office/Business', + ], + license='GPL-3', + install_requires=requires, + zip_safe=False, + entry_points=""" + [trytond.modules] + %s = trytond.modules.%s + """ % (MODULE, MODULE), + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + ) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..8e90a56 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,3 @@ +# The COPYRIGHT file at the top level of this repository contains the full +# copyright notices and license terms. +from .test_sale_pos_esc import suite diff --git a/tests/test_sale_pos_esc.py b/tests/test_sale_pos_esc.py new file mode 100644 index 0000000..461807e --- /dev/null +++ b/tests/test_sale_pos_esc.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python +# The COPYRIGHT file at the top level of this repository contains the full +# copyright notices and license terms. +import sys +import os +DIR = os.path.abspath(os.path.normpath(os.path.join(__file__, + '..', '..', '..', '..', '..', 'trytond'))) +if os.path.isdir(DIR): + sys.path.insert(0, os.path.dirname(DIR)) + +import unittest +import trytond.tests.test_tryton +from trytond.tests.test_tryton import test_view, test_depends + + +class TestCase(unittest.TestCase): + ''' + Test module. + ''' + + def setUp(self): + trytond.tests.test_tryton.install_module('sale_pos_esc') + + def test0005views(self): + ''' + Test views. + ''' + test_view('sale_pos_esc') + + def test0006depends(self): + ''' + Test depends. + ''' + test_depends() + + +def suite(): + suite = trytond.tests.test_tryton.suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestCase)) + return suite + +if __name__ == '__main__': + unittest.TextTestRunner(verbosity=2).run(suite()) diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000..7395857 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,6 @@ +[tryton] +version=3.0.0 +depends: + sale_pos +xml: + device.xml diff --git a/view/pos_device_form.xml b/view/pos_device_form.xml new file mode 100644 index 0000000..a791514 --- /dev/null +++ b/view/pos_device_form.xml @@ -0,0 +1,21 @@ + + + + +