diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/Padroes.txt b/Padroes.txt new file mode 100644 index 0000000..f62ad9c --- /dev/null +++ b/Padroes.txt @@ -0,0 +1,7 @@ +->tipo _NomeVar == esse tipo de declaração sera utilizado para variaveis de pinos. +->metodos com a 1° letra maiuscula == são sets e gets da biblioteca. Devem sempre ser do tipo publica. +->metodos com _no inicio == sao utilizados apenas dentro da classe a fim de resolver determinados problemas. Devem sempre ser do tipo Protected +->pinos sao sempre uint8_t. + +->Os iniciadores de componentes devem ter o seguinte formato: iniciaNomeDoSensor(); nao deve conter parametros. +->qualquer subBiblioteca deve ser nomeada: Guarateca_funçãoDaBiblioteca.h/.cpp \ No newline at end of file diff --git a/README.md b/README.md index 2793d35..8eb53d8 100644 --- a/README.md +++ b/README.md @@ -1 +1,48 @@ -# GuaraTeca_Hardware \ No newline at end of file +## Sobre a GuaraTeca_Hardware + +A GuaraTeca_Hardware é uma sub-biblioteca da biblioteca [Guarateca](https://github.com/JoaquimFlavio/GuaraTeca), focada na programação de estruturas eletronicas e roboticas em nivel mediano. Atraves da utilização de funçoes simples e em portugues essa biblioteca permite um maior aproveitamento do hardware do Arduino em contraposição à uma experiência de programação em alto nivel. + +## Instalação + +1. **Instalação** + - Primeiro baixe a biblioteca clicando [aqui](https://codeload.github.com/JoaquimFlavio/GuaraTeca_Hardware/zip/1.2.0) + - Abra a sua IDE do Arduino, clique em ```Sketch > Incluir Biblioteca > Adicionar biblioteca .ZIP``` + - Procure a biblioteca GuaraTeca_Hardware baixada em arquivo .ZIP em sua pasta de downloads + - Pronto, agora a sua biblioteca está instalada e pronta para ser utilizada! + +## Exemplo de uso + +```c++ +#define funcao Hardware +#include + +#define porta 1 + +MotorShield robo; + +void setup() { + robo.iniciaMotorShield(); + robo.controleDeCorrente(1, 255); +} + +void loop() { + robo.sentido1(porta); + delay(150); + robo.sentido2(porta); + delay(150); + robo.trava(porta); + delay(150); +} +``` + +## Aprendendo + +Na [documentação oficial da GuaraTeca](http://guarabots.wordpress.com/guarateca) você encontrará tudo o que precisa para dominar a biblioteca. + +## Suporte + +Caso encontre falhas ou tenha sugestões, não exite em nos contatar em [guarabots@gmail.com](mailto:guarabots@gmail.com?Subject=GuaraTeca) ou [joaquimflavio.quirino@yahoo.com.br](mailto:joaquimflavio.quirino@yahoo.com.br?Subject=GuaraTeca). + +## Licença + +A GuaraTeca é licenciada sob a [Licença Pública Geral GNU GPL](https://www.gnu.org/licenses/gpl-3.0.html) diff --git a/biblios.txt b/biblios.txt new file mode 100644 index 0000000..e033880 --- /dev/null +++ b/biblios.txt @@ -0,0 +1,12 @@ +PonteH Control_PonteH +MotorShield Control_MotorShield +Servo Control_Servo +SensorRefletancia Control_SensorRefletancia +SensorCor Control_SensorCor +SensorUltrassonico Control_SensorUltrassonico +SensorGiroscopioAcelerometro Control_SensorGiroscopioAcelerometro +SensorAgua Control_SensorAgua +SensorDHT Control_SensorDHT +Buzzer Control_Buzzer +Bluetooth Control_bluetooth +-->>FIM_________________________ \ No newline at end of file diff --git a/examples/MotorShield/MotorShield.ino b/examples/MotorShield/MotorShield.ino new file mode 100644 index 0000000..0642247 --- /dev/null +++ b/examples/MotorShield/MotorShield.ino @@ -0,0 +1,37 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso da MotorShield GuaraTeca_Hardware---------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +MotorShield motor;//declaramos um motor + +void setup() { + motor.iniciaMotorShield();//preparamos a motorShield para receber os comandos + motor.controleDeCorrente(1, 255);//definimos a velocidade do motor, na porta 1, como maxima +} + +void loop() { + motor.sentido1(1);//motor gira no sentido 1 + delay(1000); + motor.trava(1);//motor para + delay(1000); + motor.sentido2(1);//motor gira no sentido 2 + delay(1000); +} diff --git a/examples/PonteH/PonteH.ino b/examples/PonteH/PonteH.ino new file mode 100644 index 0000000..b9d1589 --- /dev/null +++ b/examples/PonteH/PonteH.ino @@ -0,0 +1,41 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso da PonteH GuaraTeca_Hardware--------------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +PonteH motor;//declaramos um motor + +void setup() { + motor.iniciaPonteH(3,4,10,5,6,11);//preparamos a PonteH para receber os comandos + motor.controleDeCorrente(10, 255);//definimos a velocidade do motor, na porta 1, como maxima + motor.controleDeCorrente(11, 255);//definimos a velocidade do motor, na porta 2, como maxima +} + +void loop() { + motor.sentido1(3, 4);//motor 1 gira no sentido 1 + motor.sentido1(5, 6);//motor 2 gira no sentido 1 + delay(1000); + motor.trava(3, 4);//motor 1 para + motor.trava(5, 6);//motor 2 para + delay(1000); + motor.sentido2(3, 4);//motor 1 gira no sentido 2 + motor.sentido2(5, 6);//motor 2 gira no sentido 2 + delay(1000); +} diff --git a/examples/SensorAgua/SensorAgua.ino b/examples/SensorAgua/SensorAgua.ino new file mode 100644 index 0000000..cd5c049 --- /dev/null +++ b/examples/SensorAgua/SensorAgua.ino @@ -0,0 +1,37 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_agua GuaraTeca_Hardware---------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorAgua hidro;//declaramos um sensor de agua + +void setup() { + hidro.iniciaSensorAgua(A0, 2);//declaramos sensor de agua, temos a opção de receber sinal = (analogico) ou (analogico e digital) + Serial.begin(9600); +} + +void loop() { + if(hidro.leitura(A0, 2) == true){//le o sinal digital do sensor + Serial.print("leitura: "); + Serial.println(hidro.leitura(A0));//imprime leitura analogica + }else{ + Serial.println("Sem leitura!!!!"); + } +} diff --git a/examples/SensorCor/SensorCor.ino b/examples/SensorCor/SensorCor.ino new file mode 100644 index 0000000..05c036a --- /dev/null +++ b/examples/SensorCor/SensorCor.ino @@ -0,0 +1,62 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_Cor GuaraTeca_Hardware----------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorCor color;//declaramos um sensor de cor + +/*Portas + * out = 10 + * S0 = 8 + * S1 = 9 + * S2 = 12 + * S3 = 11 + */ + +/*Frequecia de operação + * 1 => 2% + * 2 => 20% + * 3 => 100% + * 4 => 0% + */ + +void setup() { + color.iniciaSensorCor(10, 8, 9, 12, 11);//declaramos sensor de cor + Serial.begin(9600); + color.frequencia(3);//definimos a frequencia de operação em 100% +} + +void loop() { + Serial.print("Filtro Vermelho: "); + color.filtroVermelho();//ativamos o filtro de vermelho + Serial.print(color.leitura());//imprimimos a leitura + + Serial.print("| Filtro Verde: "); + color.filtroVerde();//ativamos o filtro de verde + Serial.print(color.leitura());//imprimimos a leitura + + Serial.print("| Filtro Azul: "); + color.filtroAzul();//ativamos o filtro de azul + Serial.print(color.leitura());//imprimimos a leitura + + Serial.print("| Sem Filtro: "); + color.filtroNulo();//desativamos todos os filtros + Serial.println(color.leitura());//imprimimos a leitura +} diff --git a/examples/SensorDHT/SensorDHT.ino b/examples/SensorDHT/SensorDHT.ino new file mode 100644 index 0000000..8708371 --- /dev/null +++ b/examples/SensorDHT/SensorDHT.ino @@ -0,0 +1,34 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_DHT GuaraTeca_Hardware----------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorDHT objct(A0);//declaramos e iniciamos um sensor DHT11 + +void setup() { + Serial.begin(9600); +} + +void loop() { + Serial.print("temperatura: "); + Serial.print(objct.leitura_temperatura());//imprimimos a leitura de temperatura do sensor + Serial.print("| umidade: "); + Serial.println(objct.leitura_umidade());//imprimimos a leitura de umidade do sensor +} diff --git a/examples/SensorGiroscopioAcelerometro/SensorGiroscopioAcelerometro.ino b/examples/SensorGiroscopioAcelerometro/SensorGiroscopioAcelerometro.ino new file mode 100644 index 0000000..844c18a --- /dev/null +++ b/examples/SensorGiroscopioAcelerometro/SensorGiroscopioAcelerometro.ino @@ -0,0 +1,45 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_Giroscopio GuaraTeca_Hardware---------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorGiroscopioAcelerometro objct;//declaramos o sensor giroscopio + +void setup() { + Serial.begin(9600); + objct.iniciaSensorGiroscopioAcelerometro();//iniciamos o sensor giroscopio nas portas A4 e A5 +} + +void loop() { + Serial.print("Ax: "); + Serial.print(objct.AcelerometroX());//imprimimos a leitura do eixo X do acelerometro + Serial.print(" Ay: "); + Serial.print(objct.AcelerometroY());//imprimimos a leitura do eixo Y do acelerometro + Serial.print(" Az: "); + Serial.print(objct.AcelerometroZ());//imprimimos a leitura do eixo Z do acelerometro + Serial.print(" Gx: "); + Serial.print(objct.GiroscopioX());//imprimimos a leitura do eixo X do Giroscopio + Serial.print(" Gy: "); + Serial.print(objct.GiroscopioY());//imprimimos a leitura do eixo Y do Giroscopio + Serial.print(" Gz: "); + Serial.print(objct.GiroscopioZ());//imprimimos a leitura do eixo Z do Giroscopio + Serial.print(" temp: "); + Serial.println(objct.temperatura());//imprimimos a leitura de temperatura +} diff --git a/examples/SensorRefletancia/SensorRefletancia.ino b/examples/SensorRefletancia/SensorRefletancia.ino new file mode 100644 index 0000000..22b6ee7 --- /dev/null +++ b/examples/SensorRefletancia/SensorRefletancia.ino @@ -0,0 +1,33 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_Refletancia GuaraTeca_Hardware--------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorRefletancia objct;//declaramos o sensor de refletancia + +void setup() { + Serial.begin(9600); + objct.iniciaSensorRefletancia(A0);//iniciamos o sensor de refletancia na porta A0 +} + +void loop() { + Serial.print("Refletancia: "); + Serial.println(objct.leitura(A0));//imprimimos a leitura do sensor na porta A0 +} diff --git a/examples/SensorUltrassonico/SensorUltrassonico.ino b/examples/SensorUltrassonico/SensorUltrassonico.ino new file mode 100644 index 0000000..6a2bb3b --- /dev/null +++ b/examples/SensorUltrassonico/SensorUltrassonico.ino @@ -0,0 +1,33 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do sensor_Ultrassonico GuaraTeca_Hardware-------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +SensorUltrassonico objct;//declaramos o sensor ultrassonico + +void setup() { + Serial.begin(9600); + objct.iniciaSensorUltrassonico(A0, A1);//iniciamos o sensor de refletancia na porta A0(Trig pin) e A1(Echo pin) +} + +void loop() { + Serial.print("Distancia: "); + Serial.println(objct.leitura(A0, A1));//imprimimos a leitura do sensor na porta A0 +} diff --git a/examples/Servo/Servo.ino b/examples/Servo/Servo.ino new file mode 100644 index 0000000..39bcde1 --- /dev/null +++ b/examples/Servo/Servo.ino @@ -0,0 +1,38 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do Servo GuaraTeca_Hardware---------------------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +Servo objct;//declaramos o Servo motor + +void setup() { + objct.iniciaServo(A0);//iniciamos o servo motor na porta A0 +} + +void loop() { + objct.vaPara(A0, 0);//move o eixo do motor na porta A0, para a posição 0 graus + delay(200); + objct.vaPara(A0, 45);//move o eixo do motor na porta A0, para a posição 45 graus + delay(200); + objct.vaPara(A0, 90);//move o eixo do motor na porta A0, para a posição 90 graus + delay(200); + objct.vaPara(A0, 45);//move o eixo do motor na porta A0, para a posição 45 graus + delay(200); +} diff --git a/examples/TelaCristalLiquido/TelaCristalLiquido.ino b/examples/TelaCristalLiquido/TelaCristalLiquido.ino new file mode 100644 index 0000000..a527b97 --- /dev/null +++ b/examples/TelaCristalLiquido/TelaCristalLiquido.ino @@ -0,0 +1,42 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +//Uso do TelaCristalLiquido GuaraTeca_Hardware--------------------------* +//versao: 1.0-----------------------------------------------------------* + +#include + +/*Pinos + * RS = 12 + * E = 11 + * D4 = 5 + * D5 = 4 + * D6 = 3 + * D7 = 2 + */ + +TelaCristalLiquido objct(12, 11, 5, 4, 3, 2);//declaramos o display LCD + +void setup() { + objct.iniciaTelaCristalLiquido(20, 2);//iniciamos o display LCD, com 20 colunas e 2 linhas + objct.vaParaHome(); + objct.escreveTela("ola mundo"); + delay(1000); + objct.limpaTela(); +} + +void loop() {} diff --git a/keywords.txt b/keywords.txt new file mode 100644 index 0000000..b8025f5 --- /dev/null +++ b/keywords.txt @@ -0,0 +1,80 @@ +Buzzer KEYWORD1 +iniciaBuzzer KEYWORD2 +beepSimples KEYWORD2 +beep KEYWORD2 +marcha KEYWORD2 +mario KEYWORD2 + +MotorShield KEYWORD1 +iniciaMotorShield KEYWORD2 +sentido1 KEYWORD2 +sentido2 KEYWORD2 +trava KEYWORD2 +controleDeCorrente KEYWORD2 +identificadorDeComando KEYWORD2 +converteComando KEYWORD2 + +PonteH KEYWORD1 +iniciaPonteH KEYWORD2 +sentido1 KEYWORD2 +sentido2 KEYWORD2 +trava KEYWORD2 +controleDeCorrente KEYWORD2 + +SensorAgua KEYWORD1 +iniciaSensorAgua KEYWORD2 +leitura KEYWORD2 + +SensorCor KEYWORD1 +iniciaSensorCor KEYWORD2 +filtroVermelho KEYWORD2 +filtroVerde KEYWORD2 +filtroAzul KEYWORD2 +filtroNulo KEYWORD2 +frequencia KEYWORD2 +leitura + +SensorDHT KEYWORD1 +leitura_temperatura KEYWORD2 +leitura_umidade KEYWORD2 + +SensorGiroscopioAcelerometro KEYWORD1 +iniciaSensorGiroscopioAcelerometro KEYWORD2 +AcelerometroX KEYWORD2 +AcelerometroY KEYWORD2 +AcelerometroZ KEYWORD2 +GiroscopioX KEYWORD2 +GiroscopioY KEYWORD2 +GiroscopioZ KEYWORD2 +temperatura KEYWORD2 +_ObtemDados KEYWORD2 + +SensorRefletancia KEYWORD1 +iniciaSensorRefletancia KEYWORD2 +leitura KEYWORD2 + +SensorUltrassonico KEYWORD1 +iniciaSensorUltrassonico KEYWORD2 +leitura KEYWORD2 + +Servo KEYWORD1 +vaPara KEYWORD2 +direita KEYWORD2 +esquerda KEYWORD2 + +TelaCristalLiquido KEYWORD1 +TelaCristalLiquido_12C KEYWORD1 +iniciaTelaCristalLiquido KEYWORD2 +escreveTela KEYWORD2 +limpaTela KEYWORD2 +vaParaHome KEYWORD2 +vaParaDireita KEYWORD2 +vaParaEsquerda KEYWORD2 +posicaoCursor KEYWORD2 +estadoLigado KEYWORD2 +estadoDesligado KEYWORD2 +pisca KEYWORD2 +paraPiscar KEYWORD2 +pisca_cursor KEYWORD2 +paraPiscar_cursor KEYWORD2 +luzFundo KEYWORD2 \ No newline at end of file diff --git a/library.properties b/library.properties new file mode 100644 index 0000000..bf3d699 --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=GuaraTeca_Hardware +version=1.2.0 +author=Joaquim Flávio Almeida Quirino Gomes (joaquimflavio.quirino@yahoo.com.br), Dêmis Carlos Fonseca Gomes (demis.gomes@ifto.edu.br), Marcos Dias da Conceição (marcos.conceicao@ifto.edu.br) e Diego de Castro Rodrigues +maintainer=Guarabots +sentence=Biblioteca de controle de diversas plataformas roboticas. +paragraph=Controle de diversas plataformas roboticas, de forma simples e eficiente, priorizando a eficiência do hardware do Arduino! Necessário baixar: GuaraTeca_Menu!!!! +category=Device Control +url=https://github.com/JoaquimFlavio/GuaraTeca_Hardware/ +architectures=* diff --git a/src/GuaraTeca_Bluethoth.cpp b/src/GuaraTeca_Bluethoth.cpp new file mode 100644 index 0000000..a69a4f4 --- /dev/null +++ b/src/GuaraTeca_Bluethoth.cpp @@ -0,0 +1,29 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* +#include + +Bluethoth::Bluethoth(uint8_t pino1, uint8_t pino2){ + SoftwareSerial MinhaSerial(pino1, pino2); + MinhaSerial.begin(9600); +} + +void enviaNum(int numero){ + +} +int recebeNum(){ + +} diff --git a/src/GuaraTeca_Bluethoth.h b/src/GuaraTeca_Bluethoth.h new file mode 100644 index 0000000..cb3e999 --- /dev/null +++ b/src/GuaraTeca_Bluethoth.h @@ -0,0 +1,36 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* +#ifndef GuaraTeca_Bluethoth_H +#define GuaraTeca_Bluethoth_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +#include + +//Classes para controle de comunicadores--------------------------------------------------------------------- +class Bluethoth{ + public: + Bluethoth(uint8_t pino1, uint8_t pino2);//construtor da classe SensorRefletancia. + /*void enviaT(char texto[255]); + char recebeT();*/ + void enviaNum(int numero); + int recebeNum(); +}; + +#endif diff --git a/src/GuaraTeca_Buzzer.cpp b/src/GuaraTeca_Buzzer.cpp new file mode 100644 index 0000000..36dc561 --- /dev/null +++ b/src/GuaraTeca_Buzzer.cpp @@ -0,0 +1,175 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* +#include + +Buzzer::Buzzer(){ + Serial.println(""); +} + +void Buzzer::iniciaBuzzer(unsigned char pino){ + pinMode(pino, OUTPUT); +} + +void Buzzer::beepSimples(unsigned char pino, int tempo){ + digitalWrite(pino, HIGH); + if (tempo > 0){ + delay(tempo); + digitalWrite(pino, LOW); + } +} + +void Buzzer::beep(unsigned char speakerPin, int frequencyInHertz, long timeInMilliseconds){ + //digitalWrite(ledPin, HIGH); + //use led to visualize the notes being played + + int x; + long delayAmount = (long)(1000000/frequencyInHertz); + long loopTime = (long)((timeInMilliseconds*1000)/(delayAmount*2)); + for (x=0;x--------* +#ifndef GuaraTeca_Buzzer_H +#define GuaraTeca_Buzzer_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class Buzzer{ + public: + Buzzer(); + void iniciaBuzzer(unsigned char pino); + + void beepSimples(unsigned char pino, int tempo); + void beep(unsigned char speakerPin, int frequencyInHertz, long timeInMilliseconds); + void marcha(unsigned char pino); + void mario(unsigned char pino); + private: + int c, d, e, f, g, gS, a, aS, b, cH, cSH, dH, dSH, eH, fH, fSH, gH, gSH, aH; +}; + +#endif diff --git a/src/GuaraTeca_MotorShield.cpp b/src/GuaraTeca_MotorShield.cpp new file mode 100644 index 0000000..b647d0a --- /dev/null +++ b/src/GuaraTeca_MotorShield.cpp @@ -0,0 +1,148 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +#include + +MotorShield::MotorShield(){} + +void MotorShield::iniciaMotorShield(){ + pinMode(_dir_clk, OUTPUT);//saída para clock + pinMode(_dir_ser, OUTPUT);//saída para dados + pinMode(_dir_latch, OUTPUT);//saída para latch + pinMode(_dir_en, OUTPUT);//saída para enable + pinMode(_PMW1, OUTPUT);//saída para pwm motor1 + pinMode(_PMW2, OUTPUT);//saída para pwm motor2 + pinMode(_PMW3, OUTPUT);//saída para pwm motor3 + pinMode(_PMW4, OUTPUT);//saída para pwm motor4 + + digitalWrite(_dir_en, LOW);//seta a variavel como de baixa energia ou desabilitado + analogWrite(_PMW1, 0);//seta a corrente do pino PMW1, como 0 + analogWrite(_PMW2, 0);//seta a corrente do pino PMW2, como 0 + analogWrite(_PMW3, 0);//seta a corrente do pino PMW3, como 0 + analogWrite(_PMW4, 0);//seta a corrente do pino PMW4, como 0 +} + +void MotorShield::sentido1(uint8_t conexao){ + switch(conexao){ + case 1: + comando[2] = 0; + comando[3] = 1; + break; + case 2: + comando[1] = 0; + comando[4] = 1; + break; + case 3: + comando[5] = 1; + comando[7] = 0; + break; + case 4: + comando[0] = 1; + comando[6] = 0; + break; + } + converteComando(identificadorDeComando());//atualiza o estado dos motores da motor shield. +} +void MotorShield::sentido2(uint8_t conexao){ + switch(conexao){ + case 1: + comando[2] = 1; + comando[3] = 0; + break; + case 2: + comando[1] = 1; + comando[4] = 0; + break; + case 3: + comando[5] = 0; + comando[7] = 1; + break; + case 4: + comando[0] = 0; + comando[6] = 1; + break; + } + converteComando(identificadorDeComando());//atualiza o estado dos motores da motor shield. +} +void MotorShield::trava(uint8_t conexao){ + switch(conexao){ + case 1: + comando[2] = 1; + comando[3] = 1; + break; + case 2: + comando[1] = 1; + comando[4] = 1; + break; + case 3: + comando[5] = 1; + comando[7] = 1; + break; + case 4: + comando[0] = 1; + comando[6] = 1; + break; + } + converteComando(identificadorDeComando());//atualiza o estado dos motores da motor shield. +} +void MotorShield::controleDeCorrente(uint8_t conexao, unsigned char corrente){ + switch(conexao){ + case 1: + analogWrite(_PMW1, corrente); + break; + case 2: + analogWrite(_PMW2, corrente); + break; + case 3: + analogWrite(_PMW3, corrente); + break; + case 4: + analogWrite(_PMW4, corrente); + break; + } +} + +int MotorShield::identificadorDeComando(){ + int i, aux = 1, temp = 0; + for(i = 7; i >= 0 ; i--){ + if(comando[i] == 1){ + temp += aux; + } + aux *= 2; + } + return temp; +} +void MotorShield::converteComando(unsigned char identificador){ + boolean verifica;//bit de controle + + digitalWrite(_dir_latch, LOW);//desliga latch + digitalWrite(_dir_clk, LOW);//desabilita o clock + + for(unsigned char i=0x0; i<0x08; i++)//loop finito para enviar os 8 bits + { + digitalWrite(_dir_clk, LOW);//clock em low + + if(identificador & (1<--------* + +#ifndef GuaraTeca_MotorShield_H +#define GuaraTeca_MotorShield_H + +#include + +/* + Mapeamento do vetor de controle da Classe MotorShield: + comando[0] ==> Conexão M4, sentido B || 2(+/-)-------> + comando[1] ==> Conexão M2, sentido A || 1(-/+)----> | + comando[2] ==> Conexão M1, sentido A || 1(-/+)-> | | + comando[3] ==> Conexão M1, sentido B || 2(+/-)-> | | + comando[4] ==> Conexão M2, sentido B || 2(+/-)----> | + comando[5] ==> Conexão M3, sentido B || 2(+/-)-> | + comando[6] ==> Conexão M4, sentido A || 1(-/+)-|-----> + comando[7] ==> Conexão M3, sentido A || 1(-/+)-> +*/ + +#define _PMW1 11 //pino de controle de corrente +#define _PMW2 3 //pino de controle de corrente +#define _PMW3 6 //pino de controle de corrente +#define _PMW4 5 //pino de controle de corrente +#define _dir_clk 4 //clock do registrador no digital 4 +#define _dir_ser 8 //dados do registrador no digital 8 +#define _dir_latch 12 //latch do registrador no digital 12 +#define _dir_en 7 //enable do registrador no digital 7 + +class MotorShield{ + public: + MotorShield();//construtor da classe MotorShield. + void iniciaMotorShield();//metodo para preparar o hardware para os devidos comandos + void sentido1(uint8_t conexao);//metodo para ativar o motor DC no sentido 1, enviando o pulso positivo para o P2 e o terra para o P1. + void sentido2(uint8_t conexao);//metodo para ativar o motor DC no sentido 1, enviando o pulso positivo para o P1 e o terra para o P2. + void trava(uint8_t conexao);//metodo para travar o motor, enviando pulso positivo para ambas as portas. + void controleDeCorrente(uint8_t conexao, unsigned char corrente);//metodo de controle de corrente passada para o pino de controle da MotorShield. + protected: + int identificadorDeComando();//funcao para converter as cadeias binarias para a funcao "converteComando". + void converteComando(unsigned char identificador);//converte os comandos em pulsos para as portas determinadas da MotorShield. + private: + int comando[10];//variavel que guarda a cadeia de comandos binarios para a MotorShield. +}; +#endif \ No newline at end of file diff --git a/src/GuaraTeca_PonteH.cpp b/src/GuaraTeca_PonteH.cpp new file mode 100644 index 0000000..ed1a142 --- /dev/null +++ b/src/GuaraTeca_PonteH.cpp @@ -0,0 +1,44 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +PonteH::PonteH(){} + +void PonteH::iniciaPonteH(uint8_t P1, uint8_t P2, uint8_t P3, uint8_t P4, uint8_t P5, uint8_t P6){ + pinMode(P1, OUTPUT);//define o P1 como saida. + pinMode(P2, OUTPUT);//define o P2 como saida. + pinMode(P3, OUTPUT);//define o P3 como saida. + pinMode(P4, OUTPUT);//define o P4 como saida. + pinMode(P5, OUTPUT);//define o P5 como saida. + pinMode(P6, OUTPUT);//define o P6 como saida. +} +void PonteH::sentido1(uint8_t P1, uint8_t P2){ + digitalWrite(P1, HIGH);//define o P1 como ativo. + digitalWrite(P2, LOW);//define o P2 como desativado. +} +void PonteH::sentido2(uint8_t P1, uint8_t P2){ + digitalWrite(P1, LOW);//define o P1 como desativado. + digitalWrite(P2, HIGH);//define o P2 como ativo. +} +void PonteH::trava(uint8_t P1, uint8_t P2){ + digitalWrite(P1, HIGH);//define o P1 como ativo. + digitalWrite(P2, HIGH);//define o P2 como ativo. +} +void PonteH::controleDeCorrente(uint8_t P1, float corrente){ + analogWrite(P1, corrente);//define a corrente que saira para o motor; Conecte em um pino PWM. +} diff --git a/src/GuaraTeca_PonteH.h b/src/GuaraTeca_PonteH.h new file mode 100644 index 0000000..57ab7b6 --- /dev/null +++ b/src/GuaraTeca_PonteH.h @@ -0,0 +1,34 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +#ifndef GuaraTeca_PonteH_H +#define GuaraTeca_PonteH_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class PonteH{ + public: + PonteH();//construtor da classe PonteH + void iniciaPonteH(uint8_t P1, uint8_t P2, uint8_t P3, uint8_t P4, uint8_t P5, uint8_t P6);//metodo para preparar o hardware para os devidos comandos. + void sentido1(uint8_t P1, uint8_t P2);//metodo para ativar o motor DC no sentido 1, enviando o pulso positivo para o P1 e o terra para o P2. + void sentido2(uint8_t P1, uint8_t P2);//metodo para ativar o motor DC no sentido 2, enviando o pulso positivo para o P2 e o terra para o P1. + void trava(uint8_t P1, uint8_t P2);//metodo para travar o motor, enviando pulso positivo para ambas as portas. + void controleDeCorrente(uint8_t P1, float corrente);//metodo de controle de corrente passada para o pino de controle da ponteH. +}; +#endif \ No newline at end of file diff --git a/src/GuaraTeca_SensorAgua.cpp b/src/GuaraTeca_SensorAgua.cpp new file mode 100644 index 0000000..5e247f5 --- /dev/null +++ b/src/GuaraTeca_SensorAgua.cpp @@ -0,0 +1,36 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +SensorAgua::SensorAgua(){} + +void SensorAgua::iniciaSensorAgua(uint8_t pinoA, uint8_t pinoD){ + if(pinoD == 0){ + pinMode(pinoA, INPUT); + }else{ + pinMode(pinoA, INPUT); + pinMode(pinoD, INPUT); + } +} +short int SensorAgua::leitura(uint8_t pinoA, uint8_t pinoD){ + if(pinoD == 0){ + return analogRead(pinoA); + }else{ + return digitalRead(pinoD); + } +} diff --git a/src/GuaraTeca_SensorAgua.h b/src/GuaraTeca_SensorAgua.h new file mode 100644 index 0000000..e649b73 --- /dev/null +++ b/src/GuaraTeca_SensorAgua.h @@ -0,0 +1,32 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#ifndef GuaraTeca_SensorAgua_H +#define GuaraTeca_SensorAgua_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class SensorAgua{ + public: + SensorAgua();//construtor da classe SensorChuva. + void iniciaSensorAgua(uint8_t pinoA, uint8_t pinoD = 0);//metodo para preparar o hardware para os devidos comandos + + short int leitura(uint8_t pinoA, uint8_t pinoD = 0);//metodo para retornar o valor lido pelo sensor. +}; +#endif \ No newline at end of file diff --git a/src/GuaraTeca_SensorCor.cpp b/src/GuaraTeca_SensorCor.cpp new file mode 100644 index 0000000..a8b400e --- /dev/null +++ b/src/GuaraTeca_SensorCor.cpp @@ -0,0 +1,72 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +SensorCor::SensorCor(){} + +void SensorCor::iniciaSensorCor(uint8_t out, uint8_t S0, uint8_t S1, uint8_t S2, uint8_t S3){ + this->_S0 = S0; + this->_S1 = S1; + this->_S2 = S2; + this->_S3 = S3; + this->_out = out; + + pinMode(_S0, OUTPUT); + pinMode(_S1, OUTPUT); + pinMode(_S2, OUTPUT); + pinMode(_S3, OUTPUT); + pinMode(_out, INPUT); +} +void SensorCor::filtroVermelho(){ + digitalWrite(_S2, LOW); + digitalWrite(_S3, LOW); +} +void SensorCor::filtroVerde(){ + digitalWrite(_S2, HIGH); + digitalWrite(_S3, HIGH); +} +void SensorCor::filtroAzul(){ + digitalWrite(_S2, LOW); + digitalWrite(_S3, HIGH); +} +void SensorCor::filtroNulo(){ + digitalWrite(_S2, HIGH); + digitalWrite(_S3, LOW); +} +void SensorCor::frequencia(uint8_t OPT){ + switch(OPT){ + case 1://2% + digitalWrite(_S0, LOW); + digitalWrite(_S1, HIGH); + break; + case 2://20% + digitalWrite(_S0, HIGH); + digitalWrite(_S1, LOW); + break; + case 3://100% + digitalWrite(_S0, HIGH); + digitalWrite(_S1, HIGH); + break; + default://0% + digitalWrite(_S0, LOW); + digitalWrite(_S1, LOW); + } +} +float SensorCor::leitura(){ + return pulseIn(_out, digitalRead(_out) == HIGH ? LOW : HIGH); +} diff --git a/src/GuaraTeca_SensorCor.h b/src/GuaraTeca_SensorCor.h new file mode 100644 index 0000000..f609ca5 --- /dev/null +++ b/src/GuaraTeca_SensorCor.h @@ -0,0 +1,55 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +#ifndef GuaraTeca_SensorCor_H +#define GuaraTeca_SensorCor_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +/* + Mapeamento de estado dos pinos para filtros do sensor de cor + + -> 0 == LOW + -> 1 == HIGH + + Pino : S0 | S1 --> frequencia de saida | Pino : S2 | S3 --> Filtro + 0 | 0 --> Desligado | 0 | 0 --> Vermelho____Red + 0 | 1 --> 2% | 0 | 1 --> Azul________Blue + 1 | 0 --> 20% | 1 | 0 --> sem filtro + 1 | 1 --> 100% | 1 | 1 --> Verde_______Green +*/ +class SensorCor{ + public: + SensorCor();//construtor da classe SensorCor. + void iniciaSensorCor(uint8_t out, uint8_t S0, uint8_t S1, uint8_t S2, uint8_t S3);//metodo para preparar o hardware para os devidos comandos + + void filtroVermelho();//metodo para ativar o filtro de cor vermelha. + void filtroVerde();//metodo para ativar o filtro de cor verde. + void filtroAzul();//metodo para ativar o filtro de cor azul. + void filtroNulo();//metodo para desativar os filtros de cor. + void frequencia(uint8_t OPT);//define a frequencia de operação do pino. + float leitura();//metodo para retornar o valor lido pelo sensor. + private: + uint8_t _S0;//pino de controle de frequencia, S0; + uint8_t _S1;//pino de controle de frequencia, S1; + uint8_t _S2;//pino de controle de filtros, S2; + uint8_t _S3;//pino de controle de filtros, S3; + uint8_t _out;//pino de leitura do sensor; +}; +#endif diff --git a/src/GuaraTeca_SensorDHT.cpp b/src/GuaraTeca_SensorDHT.cpp new file mode 100644 index 0000000..49baba9 --- /dev/null +++ b/src/GuaraTeca_SensorDHT.cpp @@ -0,0 +1,32 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +SensorDHT::SensorDHT(uint8_t pino, uint8_t modelo_sensor) : DHT(pino, modelSensor){ + this->_pino = pino; + this->modelo_sensor = modelo_sensor; + + DHT::begin(); +} + +float SensorDHT::leitura_temperatura(){ + return DHT::readTemperature(); +} +float SensorDHT::leitura_umidade(){ + return DHT::readHumidity(); +} diff --git a/src/GuaraTeca_SensorDHT.h b/src/GuaraTeca_SensorDHT.h new file mode 100644 index 0000000..1909eee --- /dev/null +++ b/src/GuaraTeca_SensorDHT.h @@ -0,0 +1,39 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +#ifndef GuaraTeca_SensorDHT_H +#define GuaraTeca_SensorDHT_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif +//#include +#include + +#define modelSensor DHT11 + +class SensorDHT : public DHT{ + public: + SensorDHT(uint8_t pino, uint8_t modelo_sensor=1);//construtor da classe SensorDHT. + + float leitura_temperatura();//metodo para retornar o valor lido pelo sensor. + float leitura_umidade();//metodo para retornar o valor lido pelo sensor. + private: + uint8_t _pino;//pino de leitura do sensor. + uint8_t modelo_sensor;//definição da verção do sensor. +}; +#endif \ No newline at end of file diff --git a/src/GuaraTeca_SensorGiroscopioAcelerometro.cpp b/src/GuaraTeca_SensorGiroscopioAcelerometro.cpp new file mode 100644 index 0000000..c6f6b61 --- /dev/null +++ b/src/GuaraTeca_SensorGiroscopioAcelerometro.cpp @@ -0,0 +1,69 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +SensorGiroscopioAcelerometro::SensorGiroscopioAcelerometro(){} + +void SensorGiroscopioAcelerometro::iniciaSensorGiroscopioAcelerometro(){ + Wire.begin(); + Wire.beginTransmission(0x68); + Wire.write(0x6B); + //Inicializa o MPU-6050 + Wire.write(0); + Wire.endTransmission(true); +} +void SensorGiroscopioAcelerometro::_ObtemDados(){ + Wire.beginTransmission(0x68); + Wire.write(0x3B); // starting with register 0x3B (ACCEL_XOUT_H) + Wire.endTransmission(false); + + //Solicita os dados do sensor + Wire.requestFrom(0x68,14,true); + + //Armazena o valor dos sensores nas variaveis correspondentes + dadosGiroscopio[0] = Wire.read()<<8|Wire.read(); //0x3B (ACCEL_XOUT_H) & 0x3C (ACCEL_XOUT_L) + dadosGiroscopio[1] = Wire.read()<<8|Wire.read(); //0x3D (ACCEL_YOUT_H) & 0x3E (ACCEL_YOUT_L) + dadosGiroscopio[2] = Wire.read()<<8|Wire.read(); //0x3F (ACCEL_ZOUT_H) & 0x40 (ACCEL_ZOUT_L) + dadosGiroscopio[3] = Wire.read()<<8|Wire.read(); //0x41 (TEMP_OUT_H) & 0x42 (TEMP_OUT_L) + dadosGiroscopio[4] = Wire.read()<<8|Wire.read(); //0x43 (GYRO_XOUT_H) & 0x44 (GYRO_XOUT_L) + dadosGiroscopio[5] = Wire.read()<<8|Wire.read(); //0x45 (GYRO_YOUT_H) & 0x46 (GYRO_YOUT_L) + dadosGiroscopio[6] = Wire.read()<<8|Wire.read(); //0x47 (GYRO_ZOUT_H) & 0x48 (GYRO_ZOUT_L) +} +float SensorGiroscopioAcelerometro::AcelerometroX(){ + return dadosGiroscopio[0]; +} +float SensorGiroscopioAcelerometro::AcelerometroY(){ + return dadosGiroscopio[1]; +} +float SensorGiroscopioAcelerometro::AcelerometroZ(){ + return dadosGiroscopio[2]; +} + +float SensorGiroscopioAcelerometro::GiroscopioX(){ + return dadosGiroscopio[4]; +} +float SensorGiroscopioAcelerometro::GiroscopioY(){ + return dadosGiroscopio[5]; +} +float SensorGiroscopioAcelerometro::GiroscopioZ(){ + return dadosGiroscopio[6]; +} + +float SensorGiroscopioAcelerometro::temperatura(){ + return dadosGiroscopio[3]; +} diff --git a/src/GuaraTeca_SensorGiroscopioAcelerometro.h b/src/GuaraTeca_SensorGiroscopioAcelerometro.h new file mode 100644 index 0000000..bda6985 --- /dev/null +++ b/src/GuaraTeca_SensorGiroscopioAcelerometro.h @@ -0,0 +1,47 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#ifndef GuaraTeca_SensorGiroscopioAcelerometro_H +#define GuaraTeca_SensorGiroscopioAcelerometro_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif +#include + + +class SensorGiroscopioAcelerometro{ + public: + SensorGiroscopioAcelerometro();//construtor da classe SensorGiroscopioAcelerometro. + void iniciaSensorGiroscopioAcelerometro();//metodo para preparar o hardware para os devidos comandos. + + float AcelerometroX();//pino de leitura do sensor Acelerometro, eixo X. + float AcelerometroY();//pino de leitura do sensor Acelerometro, eixo Y. + float AcelerometroZ();//pino de leitura do sensor Acelerometro, eixo Z. + + float GiroscopioX();//pino de leitura do sensor Giroscopio, eixo X. + float GiroscopioY();//pino de leitura do sensor Giroscopio, eixo Y. + float GiroscopioZ();//pino de leitura do sensor Giroscopio, eixo Z. + + float temperatura();//pino de leitura do sensor de temperatura. + //protected: + void _ObtemDados();//metodo interno para leitura do vetor de dados do sensor. + private: + int dadosGiroscopio[7];//variavel para armazenar os dados lidos pelo sensor. +}; + +#endif \ No newline at end of file diff --git a/src/GuaraTeca_SensorRefletancia.cpp b/src/GuaraTeca_SensorRefletancia.cpp new file mode 100644 index 0000000..54dc410 --- /dev/null +++ b/src/GuaraTeca_SensorRefletancia.cpp @@ -0,0 +1,27 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +SensorRefletancia::SensorRefletancia(){} + +void SensorRefletancia::iniciaSensorRefletancia(uint8_t pino){ + pinMode(pino, INPUT); +} +int SensorRefletancia::leitura(uint8_t pino){ + return analogRead(pino); +} diff --git a/src/GuaraTeca_SensorRefletancia.h b/src/GuaraTeca_SensorRefletancia.h new file mode 100644 index 0000000..01d206f --- /dev/null +++ b/src/GuaraTeca_SensorRefletancia.h @@ -0,0 +1,32 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#ifndef GuaraTeca_SensorRefletancia_H +#define GuaraTeca_SensorRefletancia_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class SensorRefletancia{ + public: + SensorRefletancia();//construtor da classe SensorRefletancia. + void iniciaSensorRefletancia(uint8_t pino);//metodo para preparar o hardware para os devidos comandos + int leitura(uint8_t pino);//metodo para retornar o valor lido pelo sensor. +}; + +#endif \ No newline at end of file diff --git a/src/GuaraTeca_SensorUltrassonico.cpp b/src/GuaraTeca_SensorUltrassonico.cpp new file mode 100644 index 0000000..81cf550 --- /dev/null +++ b/src/GuaraTeca_SensorUltrassonico.cpp @@ -0,0 +1,44 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* +#include + +SensorUltrassonico::SensorUltrassonico(){} + +void SensorUltrassonico::iniciaSensorUltrassonico(uint8_t Tp, uint8_t Ep){ + pinMode(Tp, OUTPUT); + pinMode(Ep, INPUT); +} +float SensorUltrassonico::leitura(uint8_t Tp, uint8_t Ep){ + digitalWrite(Tp, LOW); + delayMicroseconds(2); + digitalWrite(Tp, HIGH); + delayMicroseconds(10); + digitalWrite(Tp, LOW); + long microsec = pulseIn(Ep, HIGH); + + if(next_bug == true){ + return 255; + }else if((microsec / 27.6233 / 2.0) >= 255.00){ + return 255; + next_bug = true; + }else if((microsec / 27.6233 / 2.0) < 255.00 && next_bug == true){ + return (microsec / 27.6233 / 2.0); + next_bug = false; + }else{ + return (microsec / 27.6233 / 2.0); + } +} diff --git a/src/GuaraTeca_SensorUltrassonico.h b/src/GuaraTeca_SensorUltrassonico.h new file mode 100644 index 0000000..d7da713 --- /dev/null +++ b/src/GuaraTeca_SensorUltrassonico.h @@ -0,0 +1,34 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#ifndef GuaraTeca_SensorUltrassonico_H +#define GuaraTeca_SensorUltrassonico_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class SensorUltrassonico{ + public: + SensorUltrassonico();//construtor da classe SensorUltrassonico. + void iniciaSensorUltrassonico(uint8_t Tp, uint8_t Ep);//metodo para preparar o hardware para os devidos comandos + + float leitura(uint8_t Tp, uint8_t Ep);//metodo para retornar o valor lido pelo sensor. + private: + bool next_bug;//variavel auxiliar para corigir erro de hardware do sensor. +}; +#endif diff --git a/src/GuaraTeca_Servo.cpp b/src/GuaraTeca_Servo.cpp new file mode 100644 index 0000000..5b3cc4f --- /dev/null +++ b/src/GuaraTeca_Servo.cpp @@ -0,0 +1,45 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +Servo::Servo(){} + +void Servo::iniciaServo(uint8_t pinoControle){ + pinMode(pinoControle, OUTPUT); +} +void Servo::vaPara(uint8_t pinoControle, int angle){ + localizacao = angle; + int tempo = ((0.6+((1.8*angle)/180))*1000); + + for(int ii = 0;ii < 25; ii++){ + digitalWrite(pinoControle, HIGH); + delayMicroseconds(tempo); + digitalWrite(pinoControle, LOW); + + for(int i=0;i<((20000-tempo)/tempo);i++){ + delayMicroseconds(tempo); + } + } +} +void Servo::direita(uint8_t pinoControle, int x){ + digitalWrite(pinoControle, HIGH); + delay(x); + digitalWrite(pinoControle, LOW); +} +void Servo::esquerda(){} +//return map( this->readMicroseconds()+1, SERVO_MIN(), SERVO_MAX(), 0, 180); diff --git a/src/GuaraTeca_Servo.h b/src/GuaraTeca_Servo.h new file mode 100644 index 0000000..693c1e3 --- /dev/null +++ b/src/GuaraTeca_Servo.h @@ -0,0 +1,36 @@ +//Copyright 2017 Joaquim Flávio Almeida Quirino Gomes, Dêmis Carlos ----* +//Fonseca Gomes, Marcos Dias da Conceição e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo é parte da Biblioteca de Funções GuaráTeca---------------* +//A GuaráTeca é um software livre; você pode redistribuí-lo e/ou--------* +//modificá-lo sob os termos da Licença Pública Geral GNU como publicada-* +//pela Fundação do Software Livre (FSF); na versão 3 da Licença,--------* +//ou (a seu critério) qualquer versão posterior.------------------------* +// +//Este programa é distribuído na esperança de que possa ser útil,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO-----* +//a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a-----------------* +//Licença Pública Geral GNU para mais detalhes.-------------------------* +// +//Você deve ter recebido uma cópia da Licença Pública Geral GNU junto---* +//com este programa. Se não, veja --------* + +#ifndef GuaraTeca_Servo_H +#define GuaraTeca_Servo_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif + +class Servo{ + public: + Servo();//construtor da classe Servo. + void iniciaServo(uint8_t pinoControle); + + void vaPara(uint8_t pinoControle, int angle);//metodo para posicionar o Servo motor em x graus. + void direita(uint8_t pinoControle, int x);//metodo para o servo se mover para uma direçao por certo tempo. + void esquerda();//metodo para o servo se mover para outra direçao por certo tempo. + private: + uint8_t localizacao;//localização do servo. +}; +#endif \ No newline at end of file diff --git a/src/GuaraTeca_TelaCristalLiquido.cpp b/src/GuaraTeca_TelaCristalLiquido.cpp new file mode 100644 index 0000000..8333508 --- /dev/null +++ b/src/GuaraTeca_TelaCristalLiquido.cpp @@ -0,0 +1,84 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#include + +TelaCristalLiquido::TelaCristalLiquido(uint8_t RS, uint8_t E, + uint8_t D4, uint8_t D5, uint8_t D6, uint8_t D7, + uint8_t D0, uint8_t D1, uint8_t D2, uint8_t D3 + ) : LiquidCrystal(RS, E, D4, D5, D6, D7, D3, D2, D1, D0){ + this->_RS = RS; + this->_E = E; + this->_D0 = D0; + this->_D1 = D1; + this->_D2 = D2; + this->_D3 = D3; + this->_D4 = D4; + this->_D5 = D5; + this->_D6 = D6; + this->_D7 = D7; +} +TelaCristalLiquido::TelaCristalLiquido(uint8_t RS, uint8_t E, + uint8_t D4, uint8_t D5, uint8_t D6, uint8_t D7 + ) : LiquidCrystal(RS, E, D4, D5, D6, D7){ + this->_RS = RS; + this->_E = E; + this->_D4 = D4; + this->_D5 = D5; + this->_D6 = D6; + this->_D7 = D7; +} + +void TelaCristalLiquido::iniciaTelaCristalLiquido(int C, int L){ + LiquidCrystal::begin(C, L); +} +void TelaCristalLiquido::escreveTela(char x[]){ + LiquidCrystal::print(x); +} +void TelaCristalLiquido::escreveTela2(int x){ + LiquidCrystal::print(x,1); +} +void TelaCristalLiquido::limpaTela(){ + LiquidCrystal::clear(); +} +void TelaCristalLiquido::vaParaHome(){ + LiquidCrystal::home(); +} +void TelaCristalLiquido::vaParaDireita(){ + LiquidCrystal::scrollDisplayRight(); +} +void TelaCristalLiquido::vaParaEsquerda(){ + LiquidCrystal::scrollDisplayLeft(); +} +void TelaCristalLiquido::posicaoCursor(int C, int L){ + LiquidCrystal::setCursor(C, L); +} +void TelaCristalLiquido::estadoLigado(){ + LiquidCrystal::display(); +} +void TelaCristalLiquido::estadoDesligado(){ + LiquidCrystal::noDisplay(); +} +void TelaCristalLiquido::pisca(){ + LiquidCrystal::blink(); +} +void TelaCristalLiquido::paraPiscar(){ + LiquidCrystal::noBlink(); +} +/*void TelaCristalLiquido::desenha(uint8_t n, char nome[15]){ + //LiquidCrystal::createChar(n, nome); +}*/ diff --git a/src/GuaraTeca_TelaCristalLiquido.h b/src/GuaraTeca_TelaCristalLiquido.h new file mode 100644 index 0000000..a82a4bf --- /dev/null +++ b/src/GuaraTeca_TelaCristalLiquido.h @@ -0,0 +1,64 @@ +//Copyright 2017 Joaquim Fl�vio Almeida Quirino Gomes, D�mis Carlos ----* +//Fonseca Gomes, Marcos Dias da Concei��o e Diego de Castro Rodrigues---* +//----------------------------------------------------------------------* +//Este arquivo � parte da Biblioteca de Fun��es Guar�Teca---------------* +//A Guar�Teca � um software livre; voc� pode redistribu�-lo e/ou--------* +//modific�-lo sob os termos da Licen�a P�blica Geral GNU como publicada-* +//pela Funda��o do Software Livre (FSF); na vers�o 3 da Licen�a,--------* +//ou (a seu crit�rio) qualquer vers�o posterior.------------------------* +// +//Este programa � distribu�do na esperan�a de que possa ser �til,-------* +//mas SEM NENHUMA GARANTIA; sem uma garantia impl�cita de ADEQUA��O-----* +//a qualquer MERCADO ou APLICA��O EM PARTICULAR. Veja a-----------------* +//Licen�a P�blica Geral GNU para mais detalhes.-------------------------* +// +//Voc� deve ter recebido uma c�pia da Licen�a P�blica Geral GNU junto---* +//com este programa. Se n�o, veja --------* + +#ifndef GuaraTeca_TelaCristalLiquido_H +#define GuaraTeca_TelaCristalLiquido_H + +#if ARDUINO >= 100 + #include "Arduino.h" +#endif +//#include +#include + +class TelaCristalLiquido : public LiquidCrystal{ + public: + TelaCristalLiquido(uint8_t RS, uint8_t E, + uint8_t D4, uint8_t D5, uint8_t D6, uint8_t D7, + uint8_t D0, uint8_t D1, uint8_t D2, uint8_t D3);//construtor da classe TelaCristalLiquido, modo 8 bits. + TelaCristalLiquido(uint8_t RS, uint8_t E, + uint8_t D4, uint8_t D5, uint8_t D6, uint8_t D7);//construtor da classe TelaCristalLiquido, modo 4 bits. + + void iniciaTelaCristalLiquido(int C, int L);//metodo para iniciar o display + void escreveTela(char x[]);//metodo de escrita no display + void escreveTela2(int x);//metodo de escrita no display + void limpaTela();//metodo de limpeza do display + + void vaParaHome();//metodo para posicaonar o cursor em 0, 0 + void vaParaDireita();//metodo para mover toda a LINHA para a direita em 1 casa + void vaParaEsquerda();//metodo para mover toda a LINHA para a esquerda em 1 casa + void posicaoCursor(int C, int L);//metodo para posicionar o cursor onde for desejado + void estadoLigado();//exibi textos no display + void estadoDesligado();//esconde os textos do display + void pisca(); + void paraPiscar(); + + private: + + uint8_t _RS; + uint8_t _E; + uint8_t _D4; + uint8_t _D5; + uint8_t _D6; + uint8_t _D7; + uint8_t _D0; + uint8_t _D1; + uint8_t _D3; + uint8_t _D2; + uint8_t C; + uint8_t L; +}; +#endif \ No newline at end of file diff --git a/src/Others/Print.cpp b/src/Others/Print.cpp new file mode 100644 index 0000000..5a092af --- /dev/null +++ b/src/Others/Print.cpp @@ -0,0 +1,266 @@ +/* + Print.cpp - Base class that provides print() and println() + Copyright (c) 2008 David A. Mellis. All right reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Modified 23 November 2006 by David A. Mellis + Modified 03 August 2015 by Chuck Todd + */ + +#include +#include +#include +#include +#include "Arduino.h" + +#include "Print.h" + +// Public Methods ////////////////////////////////////////////////////////////// + +/* default implementation: may be overridden */ +size_t Print::write(const uint8_t *buffer, size_t size) +{ + size_t n = 0; + while (size--) { + if (write(*buffer++)) n++; + else break; + } + return n; +} + +size_t Print::print(const __FlashStringHelper *ifsh) +{ + PGM_P p = reinterpret_cast(ifsh); + size_t n = 0; + while (1) { + unsigned char c = pgm_read_byte(p++); + if (c == 0) break; + if (write(c)) n++; + else break; + } + return n; +} + +size_t Print::print(const String &s) +{ + return write(s.c_str(), s.length()); +} + +size_t Print::print(const char str[]) +{ + return write(str); +} + +size_t Print::print(char c) +{ + return write(c); +} + +size_t Print::print(unsigned char b, int base) +{ + return print((unsigned long) b, base); +} + +size_t Print::print(int n, int base) +{ + return print((long) n, base); +} + +size_t Print::print(unsigned int n, int base) +{ + return print((unsigned long) n, base); +} + +size_t Print::print(long n, int base) +{ + if (base == 0) { + return write(n); + } else if (base == 10) { + if (n < 0) { + int t = print('-'); + n = -n; + return printNumber(n, 10) + t; + } + return printNumber(n, 10); + } else { + return printNumber(n, base); + } +} + +size_t Print::print(unsigned long n, int base) +{ + if (base == 0) return write(n); + else return printNumber(n, base); +} + +size_t Print::print(double n, int digits) +{ + return printFloat(n, digits); +} + +size_t Print::println(const __FlashStringHelper *ifsh) +{ + size_t n = print(ifsh); + n += println(); + return n; +} + +size_t Print::print(const Printable& x) +{ + return x.printTo(*this); +} + +size_t Print::println(void) +{ + return write("\r\n"); +} + +size_t Print::println(const String &s) +{ + size_t n = print(s); + n += println(); + return n; +} + +size_t Print::println(const char c[]) +{ + size_t n = print(c); + n += println(); + return n; +} + +size_t Print::println(char c) +{ + size_t n = print(c); + n += println(); + return n; +} + +size_t Print::println(unsigned char b, int base) +{ + size_t n = print(b, base); + n += println(); + return n; +} + +size_t Print::println(int num, int base) +{ + size_t n = print(num, base); + n += println(); + return n; +} + +size_t Print::println(unsigned int num, int base) +{ + size_t n = print(num, base); + n += println(); + return n; +} + +size_t Print::println(long num, int base) +{ + size_t n = print(num, base); + n += println(); + return n; +} + +size_t Print::println(unsigned long num, int base) +{ + size_t n = print(num, base); + n += println(); + return n; +} + +size_t Print::println(double num, int digits) +{ + size_t n = print(num, digits); + n += println(); + return n; +} + +size_t Print::println(const Printable& x) +{ + size_t n = print(x); + n += println(); + return n; +} + +// Private Methods ///////////////////////////////////////////////////////////// + +size_t Print::printNumber(unsigned long n, uint8_t base) +{ + char buf[8 * sizeof(long) + 1]; // Assumes 8-bit chars plus zero byte. + char *str = &buf[sizeof(buf) - 1]; + + *str = '\0'; + + // prevent crash if called with base == 1 + if (base < 2) base = 10; + + do { + char c = n % base; + n /= base; + + *--str = c < 10 ? c + '0' : c + 'A' - 10; + } while(n); + + return write(str); +} + +size_t Print::printFloat(double number, uint8_t digits) +{ + size_t n = 0; + + if (isnan(number)) return print("nan"); + if (isinf(number)) return print("inf"); + if (number > 4294967040.0) return print ("ovf"); // constant determined empirically + if (number <-4294967040.0) return print ("ovf"); // constant determined empirically + + // Handle negative numbers + if (number < 0.0) + { + n += print('-'); + number = -number; + } + + // Round correctly so that print(1.999, 2) prints as "2.00" + double rounding = 0.5; + for (uint8_t i=0; i 0) { + n += print("."); + } + + // Extract digits from the remainder one at a time + while (digits-- > 0) + { + remainder *= 10.0; + int toPrint = int(remainder); + n += print(toPrint); + remainder -= toPrint; + } + + return n; +} diff --git a/src/Others/Print.h b/src/Others/Print.h new file mode 100644 index 0000000..7b53aa4 --- /dev/null +++ b/src/Others/Print.h @@ -0,0 +1,84 @@ +/* + Print.h - Base class that provides print() and println() + Copyright (c) 2008 David A. Mellis. All right reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef Print_h +#define Print_h + +#include +#include // for size_t + +#include "WString.h" +#include "Printable.h" + +#define DEC 10 +#define HEX 16 +#define OCT 8 +#define BIN 2 + +class Print +{ + private: + int write_error; + size_t printNumber(unsigned long, uint8_t); + size_t printFloat(double, uint8_t); + protected: + void setWriteError(int err = 1) { write_error = err; } + public: + Print() : write_error(0) {} + + int getWriteError() { return write_error; } + void clearWriteError() { setWriteError(0); } + + virtual size_t write(uint8_t) = 0; + size_t write(const char *str) { + if (str == NULL) return 0; + return write((const uint8_t *)str, strlen(str)); + } + virtual size_t write(const uint8_t *buffer, size_t size); + size_t write(const char *buffer, size_t size) { + return write((const uint8_t *)buffer, size); + } + + size_t print(const __FlashStringHelper *); + size_t print(const String &); + size_t print(const char[]); + size_t print(char); + size_t print(unsigned char, int = DEC); + size_t print(int, int = DEC); + size_t print(unsigned int, int = DEC); + size_t print(long, int = DEC); + size_t print(unsigned long, int = DEC); + size_t print(double, int = 2); + size_t print(const Printable&); + + size_t println(const __FlashStringHelper *); + size_t println(const String &s); + size_t println(const char[]); + size_t println(char); + size_t println(unsigned char, int = DEC); + size_t println(int, int = DEC); + size_t println(unsigned int, int = DEC); + size_t println(long, int = DEC); + size_t println(unsigned long, int = DEC); + size_t println(double, int = 2); + size_t println(const Printable&); + size_t println(void); +}; + +#endif diff --git a/src/Others/inttypes.h b/src/Others/inttypes.h new file mode 100644 index 0000000..34c6465 --- /dev/null +++ b/src/Others/inttypes.h @@ -0,0 +1,533 @@ +/* Copyright (c) 2004,2005,2007 Joerg Wunsch + Copyright (c) 2005, Carlos Lamas + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + * Neither the name of the copyright holders nor the names of + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. */ + +/* $Id$ */ + +#ifndef __INTTYPES_H_ +#define __INTTYPES_H_ + +#include + +/** \file */ +/** \defgroup avr_inttypes : Integer Type conversions + \code #include \endcode + + This header file includes the exact-width integer definitions from + , and extends them with additional facilities + provided by the implementation. + + Currently, the extensions include two additional integer types + that could hold a "far" pointer (i.e. a code pointer that can + address more than 64 KB), as well as standard names for all printf + and scanf formatting options that are supported by the \ref avr_stdio. + As the library does not support the full range of conversion + specifiers from ISO 9899:1999, only those conversions that are + actually implemented will be listed here. + + The idea behind these conversion macros is that, for each of the + types defined by , a macro will be supplied that portably + allows formatting an object of that type in printf() or scanf() + operations. Example: + + \code + #include + + uint8_t smallval; + int32_t longval; + ... + printf("The hexadecimal value of smallval is %" PRIx8 + ", the decimal value of longval is %" PRId32 ".\n", + smallval, longval); + \endcode +*/ + +/** \name Far pointers for memory access >64K */ + +/*@{*/ +/** \ingroup avr_inttypes + signed integer type that can hold a pointer > 64 KB */ +typedef int32_t int_farptr_t; + +/** \ingroup avr_inttypes + unsigned integer type that can hold a pointer > 64 KB */ +typedef uint32_t uint_farptr_t; +/*@}*/ + +#if !defined(__cplusplus) || defined(__STDC_LIMIT_MACROS) + + +/** \name macros for printf and scanf format specifiers + + For C++, these are only included if __STDC_LIMIT_MACROS + is defined before including . + */ + +/*@{*/ +/** \ingroup avr_inttypes + decimal printf format for int8_t */ +#define PRId8 "d" +/** \ingroup avr_inttypes + decimal printf format for int_least8_t */ +#define PRIdLEAST8 "d" +/** \ingroup avr_inttypes + decimal printf format for int_fast8_t */ +#define PRIdFAST8 "d" + +/** \ingroup avr_inttypes + integer printf format for int8_t */ +#define PRIi8 "i" +/** \ingroup avr_inttypes + integer printf format for int_least8_t */ +#define PRIiLEAST8 "i" +/** \ingroup avr_inttypes + integer printf format for int_fast8_t */ +#define PRIiFAST8 "i" + + +/** \ingroup avr_inttypes + decimal printf format for int16_t */ +#define PRId16 "d" +/** \ingroup avr_inttypes + decimal printf format for int_least16_t */ +#define PRIdLEAST16 "d" +/** \ingroup avr_inttypes + decimal printf format for int_fast16_t */ +#define PRIdFAST16 "d" + +/** \ingroup avr_inttypes + integer printf format for int16_t */ +#define PRIi16 "i" +/** \ingroup avr_inttypes + integer printf format for int_least16_t */ +#define PRIiLEAST16 "i" +/** \ingroup avr_inttypes + integer printf format for int_fast16_t */ +#define PRIiFAST16 "i" + + +/** \ingroup avr_inttypes + decimal printf format for int32_t */ +#define PRId32 "ld" +/** \ingroup avr_inttypes + decimal printf format for int_least32_t */ +#define PRIdLEAST32 "ld" +/** \ingroup avr_inttypes + decimal printf format for int_fast32_t */ +#define PRIdFAST32 "ld" + +/** \ingroup avr_inttypes + integer printf format for int32_t */ +#define PRIi32 "li" +/** \ingroup avr_inttypes + integer printf format for int_least32_t */ +#define PRIiLEAST32 "li" +/** \ingroup avr_inttypes + integer printf format for int_fast32_t */ +#define PRIiFAST32 "li" + + +#ifdef __avr_libc_does_not_implement_long_long_in_printf_or_scanf + +#define PRId64 "lld" +#define PRIdLEAST64 "lld" +#define PRIdFAST64 "lld" + +#define PRIi64 "lli" +#define PRIiLEAST64 "lli" +#define PRIiFAST64 "lli" + + +#define PRIdMAX "lld" +#define PRIiMAX "lli" + +#endif + +/** \ingroup avr_inttypes + decimal printf format for intptr_t */ +#define PRIdPTR PRId16 +/** \ingroup avr_inttypes + integer printf format for intptr_t */ +#define PRIiPTR PRIi16 + +/** \ingroup avr_inttypes + octal printf format for uint8_t */ +#define PRIo8 "o" +/** \ingroup avr_inttypes + octal printf format for uint_least8_t */ +#define PRIoLEAST8 "o" +/** \ingroup avr_inttypes + octal printf format for uint_fast8_t */ +#define PRIoFAST8 "o" + +/** \ingroup avr_inttypes + decimal printf format for uint8_t */ +#define PRIu8 "u" +/** \ingroup avr_inttypes + decimal printf format for uint_least8_t */ +#define PRIuLEAST8 "u" +/** \ingroup avr_inttypes + decimal printf format for uint_fast8_t */ +#define PRIuFAST8 "u" + +/** \ingroup avr_inttypes + hexadecimal printf format for uint8_t */ +#define PRIx8 "x" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_least8_t */ +#define PRIxLEAST8 "x" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_fast8_t */ +#define PRIxFAST8 "x" + +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint8_t */ +#define PRIX8 "X" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_least8_t */ +#define PRIXLEAST8 "X" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_fast8_t */ +#define PRIXFAST8 "X" + + +/** \ingroup avr_inttypes + octal printf format for uint16_t */ +#define PRIo16 "o" +/** \ingroup avr_inttypes + octal printf format for uint_least16_t */ +#define PRIoLEAST16 "o" +/** \ingroup avr_inttypes + octal printf format for uint_fast16_t */ +#define PRIoFAST16 "o" + +/** \ingroup avr_inttypes + decimal printf format for uint16_t */ +#define PRIu16 "u" +/** \ingroup avr_inttypes + decimal printf format for uint_least16_t */ +#define PRIuLEAST16 "u" +/** \ingroup avr_inttypes + decimal printf format for uint_fast16_t */ +#define PRIuFAST16 "u" + +/** \ingroup avr_inttypes + hexadecimal printf format for uint16_t */ +#define PRIx16 "x" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_least16_t */ +#define PRIxLEAST16 "x" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_fast16_t */ +#define PRIxFAST16 "x" + +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint16_t */ +#define PRIX16 "X" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_least16_t */ +#define PRIXLEAST16 "X" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_fast16_t */ +#define PRIXFAST16 "X" + + +/** \ingroup avr_inttypes + octal printf format for uint32_t */ +#define PRIo32 "lo" +/** \ingroup avr_inttypes + octal printf format for uint_least32_t */ +#define PRIoLEAST32 "lo" +/** \ingroup avr_inttypes + octal printf format for uint_fast32_t */ +#define PRIoFAST32 "lo" + +/** \ingroup avr_inttypes + decimal printf format for uint32_t */ +#define PRIu32 "lu" +/** \ingroup avr_inttypes + decimal printf format for uint_least32_t */ +#define PRIuLEAST32 "lu" +/** \ingroup avr_inttypes + decimal printf format for uint_fast32_t */ +#define PRIuFAST32 "lu" + +/** \ingroup avr_inttypes + hexadecimal printf format for uint32_t */ +#define PRIx32 "lx" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_least32_t */ +#define PRIxLEAST32 "lx" +/** \ingroup avr_inttypes + hexadecimal printf format for uint_fast32_t */ +#define PRIxFAST32 "lx" + +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint32_t */ +#define PRIX32 "lX" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_least32_t */ +#define PRIXLEAST32 "lX" +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uint_fast32_t */ +#define PRIXFAST32 "lX" + + +#ifdef __avr_libc_does_not_implement_long_long_in_printf_or_scanf + +#define PRIo64 "llo" +#define PRIoLEAST64 "llo" +#define PRIoFAST64 "llo" + +#define PRIu64 "llu" +#define PRIuLEAST64 "llu" +#define PRIuFAST64 "llu" + +#define PRIx64 "llx" +#define PRIxLEAST64 "llx" +#define PRIxFAST64 "llx" + +#define PRIX64 "llX" +#define PRIXLEAST64 "llX" +#define PRIXFAST64 "llX" + +#define PRIoMAX "llo" +#define PRIuMAX "llu" +#define PRIxMAX "llx" +#define PRIXMAX "llX" + +#endif + +/** \ingroup avr_inttypes + octal printf format for uintptr_t */ +#define PRIoPTR PRIo16 +/** \ingroup avr_inttypes + decimal printf format for uintptr_t */ +#define PRIuPTR PRIu16 +/** \ingroup avr_inttypes + hexadecimal printf format for uintptr_t */ +#define PRIxPTR PRIx16 +/** \ingroup avr_inttypes + uppercase hexadecimal printf format for uintptr_t */ +#define PRIXPTR PRIX16 + + +#ifdef __avr_libc_does_not_implement_hh_in_scanf + +#define SCNd8 "hhd" +#define SCNdLEAST8 "hhd" +#define SCNdFAST8 "hhd" + +#define SCNi8 "hhi" +#define SCNiLEAST8 "hhi" +#define SCNiFAST8 "hhi" + +#endif + + +/** \ingroup avr_inttypes + decimal scanf format for int16_t */ +#define SCNd16 "d" +/** \ingroup avr_inttypes + decimal scanf format for int_least16_t */ +#define SCNdLEAST16 "d" +/** \ingroup avr_inttypes + decimal scanf format for int_fast16_t */ +#define SCNdFAST16 "d" + +/** \ingroup avr_inttypes + generic-integer scanf format for int16_t */ +#define SCNi16 "i" +/** \ingroup avr_inttypes + generic-integer scanf format for int_least16_t */ +#define SCNiLEAST16 "i" +/** \ingroup avr_inttypes + generic-integer scanf format for int_fast16_t */ +#define SCNiFAST16 "i" + + +/** \ingroup avr_inttypes + decimal scanf format for int32_t */ +#define SCNd32 "ld" +/** \ingroup avr_inttypes + decimal scanf format for int_least32_t */ +#define SCNdLEAST32 "ld" +/** \ingroup avr_inttypes + decimal scanf format for int_fast32_t */ +#define SCNdFAST32 "ld" + +/** \ingroup avr_inttypes + generic-integer scanf format for int32_t */ +#define SCNi32 "li" +/** \ingroup avr_inttypes + generic-integer scanf format for int_least32_t */ +#define SCNiLEAST32 "li" +/** \ingroup avr_inttypes + generic-integer scanf format for int_fast32_t */ +#define SCNiFAST32 "li" + + +#ifdef __avr_libc_does_not_implement_long_long_in_printf_or_scanf + +#define SCNd64 "lld" +#define SCNdLEAST64 "lld" +#define SCNdFAST64 "lld" + +#define SCNi64 "lli" +#define SCNiLEAST64 "lli" +#define SCNiFAST64 "lli" + +#define SCNdMAX "lld" +#define SCNiMAX "lli" + +#endif + +/** \ingroup avr_inttypes + decimal scanf format for intptr_t */ +#define SCNdPTR SCNd16 +/** \ingroup avr_inttypes + generic-integer scanf format for intptr_t */ +#define SCNiPTR SCNi16 + +#ifdef __avr_libc_does_not_implement_hh_in_scanf + +#define SCNo8 "hho" +#define SCNoLEAST8 "hho" +#define SCNoFAST8 "hho" + +#define SCNu8 "hhu" +#define SCNuLEAST8 "hhu" +#define SCNuFAST8 "hhu" + +#define SCNx8 "hhx" +#define SCNxLEAST8 "hhx" +#define SCNxFAST8 "hhx" + +#endif + +/** \ingroup avr_inttypes + octal scanf format for uint16_t */ +#define SCNo16 "o" +/** \ingroup avr_inttypes + octal scanf format for uint_least16_t */ +#define SCNoLEAST16 "o" +/** \ingroup avr_inttypes + octal scanf format for uint_fast16_t */ +#define SCNoFAST16 "o" + +/** \ingroup avr_inttypes + decimal scanf format for uint16_t */ +#define SCNu16 "u" +/** \ingroup avr_inttypes + decimal scanf format for uint_least16_t */ +#define SCNuLEAST16 "u" +/** \ingroup avr_inttypes + decimal scanf format for uint_fast16_t */ +#define SCNuFAST16 "u" + +/** \ingroup avr_inttypes + hexadecimal scanf format for uint16_t */ +#define SCNx16 "x" +/** \ingroup avr_inttypes + hexadecimal scanf format for uint_least16_t */ +#define SCNxLEAST16 "x" +/** \ingroup avr_inttypes + hexadecimal scanf format for uint_fast16_t */ +#define SCNxFAST16 "x" + + +/** \ingroup avr_inttypes + octal scanf format for uint32_t */ +#define SCNo32 "lo" +/** \ingroup avr_inttypes + octal scanf format for uint_least32_t */ +#define SCNoLEAST32 "lo" +/** \ingroup avr_inttypes + octal scanf format for uint_fast32_t */ +#define SCNoFAST32 "lo" + +/** \ingroup avr_inttypes + decimal scanf format for uint32_t */ +#define SCNu32 "lu" +/** \ingroup avr_inttypes + decimal scanf format for uint_least32_t */ +#define SCNuLEAST32 "lu" +/** \ingroup avr_inttypes + decimal scanf format for uint_fast32_t */ +#define SCNuFAST32 "lu" + +/** \ingroup avr_inttypes + hexadecimal scanf format for uint32_t */ +#define SCNx32 "lx" +/** \ingroup avr_inttypes + hexadecimal scanf format for uint_least32_t */ +#define SCNxLEAST32 "lx" +/** \ingroup avr_inttypes + hexadecimal scanf format for uint_fast32_t */ +#define SCNxFAST32 "lx" + + +#ifdef __avr_libc_does_not_implement_long_long_in_printf_or_scanf + +#define SCNo64 "llo" +#define SCNoLEAST64 "llo" +#define SCNoFAST64 "llo" + +#define SCNu64 "llu" +#define SCNuLEAST64 "llu" +#define SCNuFAST64 "llu" + +#define SCNx64 "llx" +#define SCNxLEAST64 "llx" +#define SCNxFAST64 "llx" + +#define SCNoMAX "llo" +#define SCNuMAX "llu" +#define SCNxMAX "llx" + +#endif + +/** \ingroup avr_inttypes + octal scanf format for uintptr_t */ +#define SCNoPTR SCNo16 +/** \ingroup avr_inttypes + decimal scanf format for uintptr_t */ +#define SCNuPTR SCNu16 +/** \ingroup avr_inttypes + hexadecimal scanf format for uintptr_t */ +#define SCNxPTR SCNx16 + +/*@}*/ + + +#endif /* !defined(__cplusplus) || defined(__STDC_LIMIT_MACROS) */ + + +#endif /* __INTTYPES_H_ */