diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..33062a5 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# dspmeterv1 + +Please also refer to the site below. +https://github.com/soligen2010/dspmeterv1 + +------------------------------------------- + +Standalone Signal Analyzer (I2C Type Signal-Meter) for uBITX - Arduino Nano Version + +I do not claim any license for my code. +You may use it in any way. I just hope this will be used for amateur radio. +The other person's source code (CW Morse code) follows the original author's license. + +Ian KD8CEC diff --git a/i2cmeter1/fftfunctions.cpp b/i2cmeter1/fftfunctions.cpp new file mode 100644 index 0000000..6dc25c1 --- /dev/null +++ b/i2cmeter1/fftfunctions.cpp @@ -0,0 +1,362 @@ +/* +FFTFunctions for Nextion LCD and Control MCU +This code is for FFT and CW Decode. +KD8CEC, Ian Lee +----------------------------------------------------------------------- +//The section on CW decode logic is specified at the bottom of this code. +License : I follow the license of the previous code and I do not add any extra constraints. +I hope that the Comment I made or the Comment of OZ1JHM will be maintained. +**********************************************************************/ +#include +#include "i2cmeter1.h" + +// Code Referency : http://paulbourke.net/miscellaneous/dft/ +// DFT, FFT Wiritten by Paul Bourke, June 1993 +void FFT(double *x,double *y, int n, long m) +{ + long i,i1,j,k,i2,l,l1,l2; + double c1,c2,tx,ty,t1,t2,u1,u2,z; + short int dir = 0; + + /* Do the bit reversal */ + i2 = n >> 1; + j = 0; + for (i=0;i>= 1; + } + j += k; + } + + /* Compute the FFT */ + c1 = -1.0; + c2 = 0.0; + l2 = 1; + + for (l=0;l 20) + //{ + //writeCount = 0; + //Serial.println(""); + //} +} + +uint8_t docode() +{ + if (strcmp(code,".-") == 0) printascii(65); + if (strcmp(code,"-...") == 0) printascii(66); + if (strcmp(code,"-.-.") == 0) printascii(67); + if (strcmp(code,"-..") == 0) printascii(68); + if (strcmp(code,".") == 0) printascii(69); + if (strcmp(code,"..-.") == 0) printascii(70); + if (strcmp(code,"--.") == 0) printascii(71); + if (strcmp(code,"....") == 0) printascii(72); + if (strcmp(code,"..") == 0) printascii(73); + if (strcmp(code,".---") == 0) printascii(74); + if (strcmp(code,"-.-") == 0) printascii(75); + if (strcmp(code,".-..") == 0) printascii(76); + if (strcmp(code,"--") == 0) printascii(77); + if (strcmp(code,"-.") == 0) printascii(78); + if (strcmp(code,"---") == 0) printascii(79); + if (strcmp(code,".--.") == 0) printascii(80); + if (strcmp(code,"--.-") == 0) printascii(81); + if (strcmp(code,".-.") == 0) printascii(82); + if (strcmp(code,"...") == 0) printascii(83); + if (strcmp(code,"-") == 0) printascii(84); + if (strcmp(code,"..-") == 0) printascii(85); + if (strcmp(code,"...-") == 0) printascii(86); + if (strcmp(code,".--") == 0) printascii(87); + if (strcmp(code,"-..-") == 0) printascii(88); + if (strcmp(code,"-.--") == 0) printascii(89); + if (strcmp(code,"--..") == 0) printascii(90); + + if (strcmp(code,".----") == 0) printascii(49); + if (strcmp(code,"..---") == 0) printascii(50); + if (strcmp(code,"...--") == 0) printascii(51); + if (strcmp(code,"....-") == 0) printascii(52); + if (strcmp(code,".....") == 0) printascii(53); + if (strcmp(code,"-....") == 0) printascii(54); + if (strcmp(code,"--...") == 0) printascii(55); + if (strcmp(code,"---..") == 0) printascii(56); + if (strcmp(code,"----.") == 0) printascii(57); + if (strcmp(code,"-----") == 0) printascii(48); + + if (strcmp(code,"..--..") == 0) printascii(63); + if (strcmp(code,".-.-.-") == 0) printascii(46); + if (strcmp(code,"--..--") == 0) printascii(44); + if (strcmp(code,"-.-.--") == 0) printascii(33); + if (strcmp(code,".--.-.") == 0) printascii(64); + if (strcmp(code,"---...") == 0) printascii(58); + if (strcmp(code,"-....-") == 0) printascii(45); + if (strcmp(code,"-..-.") == 0) printascii(47); + + if (strcmp(code,"-.--.") == 0) printascii(40); + if (strcmp(code,"-.--.-") == 0) printascii(41); + if (strcmp(code,".-...") == 0) printascii(95); + if (strcmp(code,"...-..-") == 0) printascii(36); + if (strcmp(code,"...-.-") == 0) printascii(62); + if (strcmp(code,".-.-.") == 0) printascii(60); + if (strcmp(code,"...-.") == 0) printascii(126); + ////////////////// + // The specials // + ////////////////// + if (strcmp(code,".-.-") == 0) printascii(3); + if (strcmp(code,"---.") == 0) printascii(4); + if (strcmp(code,".--.-") == 0) printascii(6); + +} + +void Decode_Morse(float magnitude) +{ + //magnitudelimit auto Increase + if (magnitude > magnitudelimit_low) + { + magnitudelimit = (magnitudelimit +((magnitude - magnitudelimit)/6)); /// moving average filter + } + + if (magnitudelimit < magnitudelimit_low) + magnitudelimit = magnitudelimit_low; + + if(magnitude > magnitudelimit*0.6) // just to have some space up + realstate = HIGH; + else + realstate = LOW; + + if (realstate != realstatebefore) + laststarttime = millis(); + + if ((millis()-laststarttime) > nbtime) + { + if (realstate != filteredstate) + { + filteredstate = realstate; + } + } + + if (filteredstate != filteredstatebefore) + { + if (filteredstate == HIGH) + { + starttimehigh = millis(); + lowduration = (millis() - startttimelow); + } + + if (filteredstate == LOW) + { + startttimelow = millis(); + highduration = (millis() - starttimehigh); + + if (highduration < (2*hightimesavg) || hightimesavg == 0) + { + hightimesavg = (highduration+hightimesavg+hightimesavg)/3; // now we know avg dit time ( rolling 3 avg) + } + + if (highduration > (5*hightimesavg) ) + { + hightimesavg = highduration+hightimesavg; // if speed decrease fast .. + } + } + } + + /////////////////////////////////////////////////////////////// + // now we will check which kind of baud we have - dit or dah // + // and what kind of pause we do have 1 - 3 or 7 pause // + // we think that hightimeavg = 1 bit // + /////////////////////////////////////////////////////////////// + + if (filteredstate != filteredstatebefore) + { + stop = LOW; + if (filteredstate == LOW) + { + if (highduration < (hightimesavg*2) && highduration > (hightimesavg*0.6)) /// 0.6 filter out false dits + { + strcat(code,"."); + } + if (highduration > (hightimesavg*2) && highduration < (hightimesavg*6)) + { + strcat(code,"-"); + wpm = (wpm + (1200/((highduration)/3)))/2; //// the most precise we can do ;o) + } + } + + if (filteredstate == HIGH) + { + float lacktime = 1; + if(wpm > 25)lacktime=1.0; /// when high speeds we have to have a little more pause before new letter or new word + if(wpm > 30)lacktime=1.2; + if(wpm > 35)lacktime=1.5; + + if (lowduration > (hightimesavg*(2*lacktime)) && lowduration < hightimesavg*(5*lacktime)) // letter space + { + docode(); + code[0] = '\0'; + } + if (lowduration >= hightimesavg*(5*lacktime)) + { // word space + docode(); + code[0] = '\0'; + printascii(32); + } + } + } + + if ((millis() - startttimelow) > (highduration * 6) && stop == LOW) + { + docode(); + code[0] = '\0'; + stop = HIGH; + } + + /* + if(filteredstate == HIGH) + { + digitalWrite(ledPin, HIGH); + tone(audioOutPin,target_freq); + } + else + { + digitalWrite(ledPin, LOW); + noTone(audioOutPin); + } +*/ + + realstatebefore = realstate; + lasthighduration = highduration; + filteredstatebefore = filteredstate; +} + diff --git a/i2cmeter1/i2cmeter1.h b/i2cmeter1/i2cmeter1.h new file mode 100644 index 0000000..c64d26c --- /dev/null +++ b/i2cmeter1/i2cmeter1.h @@ -0,0 +1,76 @@ +/* +Configuration file for Nextion LCD and Control MCU +The parameter can be set according to the CPU used. + +KD8CEC, Ian Lee +----------------------------------------------------------------------- + +**********************************************************************/ + +#include + +//================================================================ +//COMMUNICATION SECTION +//================================================================ +#define USE_SW_SERIAL + +extern void SWSerial_Write(uint8_t b); +extern void SWSerial_Print(uint8_t *b); + +#ifdef USE_SW_SERIAL + extern void SWSerial_Begin(long speedBaud); + extern int SWSerial_Available(void); + extern int SWSerial_Read(void); +#else + +#define PRINT_MAX_LENGTH 30 +#endif + +//================================================================ +//FFT and Decode Morse +//================================================================ +#define FFTSIZE 64 +#define SAMPLE_PREQUENCY 6000 +#define SAMPLESIZE (FFTSIZE * 2) +#define DECODE_MORSE_SAMPLESIZE 48 + +extern uint8_t cwDecodeHz; +extern int magnitudelimit_low; + +//================================================================ +//EEPROM Section +//================================================================ +#define MAX_FORWARD_BUFF_LENGTH 128 +#define EEPROM_DSPTYPE 100 +#define EEPROM_SMETER_UART 111 +#define EEPROM_SMETER_TIME 112 + +#define EEPROM_CW_FREQ 120 +//#define EEPROM_CW_MAG_LIMIT 121 +#define EEPROM_CW_MAG_LOW 122 +#define EEPROM_CW_NBTIME 126 +#define EEPROM_RTTYDECODEHZ 130 + +//================================================================ +//DEFINE for I2C Command +//================================================================ +//S-Meter Address +#define I2CMETER_ADDR 0x58 //changed from 0x6A +//VALUE TYPE============================================ +//Signal +#define I2CMETER_CALCS 0x59 //Calculated Signal Meter +#define I2CMETER_UNCALCS 0x58 //Uncalculated Signal Meter + +//Power +#define I2CMETER_CALCP 0x57 //Calculated Power Meter +#define I2CMETER_UNCALCP 0x56 //UnCalculated Power Meter + +//SWR +#define I2CMETER_CALCR 0x55 //Calculated SWR Meter +#define I2CMETER_UNCALCR 0x54 //Uncalculated SWR Meter + +#define SIGNAL_METER_ADC A7 +#define POWER_METER_ADC A3 +#define SWR_METER_ADC A2 + + diff --git a/i2cmeter1/i2cmeter1.ino b/i2cmeter1/i2cmeter1.ino new file mode 100644 index 0000000..eb0d4a1 --- /dev/null +++ b/i2cmeter1/i2cmeter1.ino @@ -0,0 +1,1014 @@ +/* +FFT, CW Decode for uBITX +KD8CEC, Ian Lee + +Version : 0.8 +----------------------------------------------------------------------- +License : See fftfunctions.cpp for FFT and CW Decode. +**********************************************************************/ + +#include +#include +#include "i2cmeter1.h" + +#define SWS_HEADER_CHAR_TYPE 'c' //1Byte Protocol Prefix +#define SWS_HEADER_INT_TYPE 'v' //Numeric Protocol Prefex +#define SWS_HEADER_STR_TYPE 's' //for TEXT Line compatiable Character LCD Control + +//Control must have prefix 'v' or 's' +char softSTRHeader[11] = {'p', 'm', '.', 's', '0', '.', 't', 'x', 't', '=', '\"'}; +char softINTHeader[10] = {'p', 'm', '.', 'v', '0', '.', 'v', 'a', 'l', '='}; + +char softTemp[20]; + +const uint8_t ResponseHeader[11]={'p', 'm', '.', 's', 'p', '.', 't', 'x', 't', '=', '"'}; //for Spectrum from DSP +const uint8_t ResponseFooter[4]={'"', 0xFF, 0xFF, 0xFF}; +const char HexCodes[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f', }; + +void FFT(double *x,double *y, int n, long m); + +double FFTReal[SAMPLESIZE]; +double FFTImag[SAMPLESIZE]; +int ADC_MAX = 0; +int ADC_MIN = 0; +int ADC_DIFF = 0; +unsigned long SAMPLE_INTERVAL = 0; + +char nowADCSampling = 0; //prevent for loss signal + +//=================================================================== +//Begin of Nextion LCD Protocol +// +// v0~v9, va~vz : Numeric (Transceiver -> Nextion LCD) +// s0~s9 : String (Text) (Transceiver -> Nextion LCD) +// vlSendxxx, vloxxx: Reserve for Nextion (Nextion LCD -> Transceiver) +// +//=================================================================== +#define CMD_NOW_DISP '0' //c0 +char L_nowdisp = -1; //Sended nowdisp + +#define CMD_VFO_TYPE 'v' //cv +char L_vfoActive; //vfoActive + +#define CMD_CURR_FREQ 'c' //vc +unsigned long L_vfoCurr; //vfoA +#define CMD_CURR_MODE 'c' //cc +byte L_vfoCurr_mode; //vfoA_mode + +#define CMD_VFOA_FREQ 'a' //va +unsigned long L_vfoA; //vfoA +#define CMD_VFOA_MODE 'a' //ca +byte L_vfoA_mode; //vfoA_mode + +#define CMD_VFOB_FREQ 'b' //vb +unsigned long L_vfoB; //vfoB +#define CMD_VFOB_MODE 'b' //cb +byte L_vfoB_mode; //vfoB_mode + +#define CMD_IS_RIT 'r' //cr +char L_ritOn; +#define CMD_RIT_FREQ 'r' //vr +unsigned long L_ritTxFrequency; //ritTxFrequency + +#define CMD_IS_TX 't' //ct +char L_inTx; + +#define CMD_IS_DIALLOCK 'l' //cl +byte L_isDialLock; //byte isDialLock + +#define CMD_IS_SPLIT 's' //cs +byte L_Split; //isTxType +#define CMD_IS_TXSTOP 'x' //cx +byte L_TXStop; //isTxType + +#define CMD_TUNEINDEX 'n' //cn +byte L_tuneStepIndex; //byte tuneStepIndex + +#define CMD_SMETER 'p' //cs +byte L_scaledSMeter; //scaledSMeter + +#define CMD_SIDE_TONE 't' //vt +unsigned long L_sideTone; //sideTone +#define CMD_KEY_TYPE 'k' //ck +byte L_cwKeyType; //L_cwKeyType 0: straight, 1 : iambica, 2: iambicb + +#define CMD_CW_SPEED 's' //vs +unsigned int L_cwSpeed; //cwSpeed + +#define CMD_CW_DELAY 'y' //vy +byte L_cwDelayTime; //cwDelayTime + +#define CMD_CW_STARTDELAY 'e' //ve +byte L_delayBeforeCWStartTime; //byte delayBeforeCWStartTime + +#define CMD_ATT_LEVEL 'f' //vf +byte L_attLevel; + +byte L_isIFShift; //1 = ifShift, 2 extend +#define CMD_IS_IFSHIFT 'i' //ci + +int L_ifShiftValue; +#define CMD_IFSHIFT_VALUE 'i' //vi + +byte L_sdrModeOn; +#define CMD_SDR_MODE 'j' //cj + +#define CMD_UBITX_INFO 'm' //cm Complete Send uBITX Information + +//Once Send Data, When boot +//arTuneStep, When boot, once send +//long arTuneStep[5]; +#define CMD_AR_TUNE1 '1' //v1 +#define CMD_AR_TUNE2 '2' //v2 +#define CMD_AR_TUNE3 '3' //v3 +#define CMD_AR_TUNE4 '4' //v4 +#define CMD_AR_TUNE5 '5' //v5 + +//int idleStep = 0; +byte scaledSMeter = 0; + +//send data for Nextion LCD +void SendHeader(char varType, char varIndex) +{ + if (varType == SWS_HEADER_STR_TYPE) + { + softSTRHeader[4] = varIndex; + for (int i = 0; i < 11; i++) + SWSerial_Write(softSTRHeader[i]); + } + else + { + softINTHeader[4] = varIndex; + for (int i = 0; i < 10; i++) + SWSerial_Write(softINTHeader[i]); + } +} + +void SendCommandUL(char varIndex, unsigned long sendValue) +{ + SendHeader(SWS_HEADER_INT_TYPE, varIndex); + + memset(softTemp, 0, 20); + ultoa(sendValue, softTemp, DEC); + SWSerial_Print(softTemp); + SWSerial_Write(0xff); + SWSerial_Write(0xff); + SWSerial_Write(0xff); +} + +void SendCommandL(char varIndex, long sendValue) +{ + SendHeader(SWS_HEADER_INT_TYPE, varIndex); + + memset(softTemp, 0, 20); + ltoa(sendValue, softTemp, DEC); + SWSerial_Print(softTemp); + SWSerial_Write(0xff); + SWSerial_Write(0xff); + SWSerial_Write(0xff); +} + +void SendCommandStr(char varIndex, char* sendValue) +{ + SendHeader(SWS_HEADER_STR_TYPE, varIndex); + + SWSerial_Print(sendValue); + SWSerial_Write('\"'); + SWSerial_Write(0xFF); + SWSerial_Write(0xFF); + SWSerial_Write(0xFF); +} + +unsigned char softBuff1Num[14] = {'p', 'm', '.', 'c', '0', '.', 'v', 'a', 'l', '=', 0, 0xFF, 0xFF, 0xFF}; +void SendCommand1Num(char varType, char sendValue) //0~9 : Mode, nowDisp, ActiveVFO, IsDialLock, IsTxtType, IsSplitType +{ + softBuff1Num[4] = varType; + softBuff1Num[10] = sendValue + 0x30; + + for (int i = 0; i < 14; i++) + SWSerial_Write(softBuff1Num[i]); +} + +//======================================================= +//END OF Nextion Protocol +//======================================================= + +int I2CCommand = 0; +void CalculateCoeff(uint8_t freqIndex); + +char ForwardBuff[MAX_FORWARD_BUFF_LENGTH + 1]; +static char nowBuffIndex = 0; +static char etxCount = 0; +static char nowSendingProtocol = 0; + +uint8_t SMeterToUartSend = 0; //0 : Send, 1: Idle +uint8_t SMeterToUartIdleCount = 0; +#define SMeterToUartInterval 4 + +char DSPType = 1; //0 : Not Use, 1 : FFT, 2 : Morse Decoder, 3 : RTTY Decoder +char FFTToUartIdleCount = 0; +#define FFTToUartInterval 2 + +unsigned long lastForwardmili = 0; +uint8_t responseCommand = 0; // +uint8_t TXStatus = 0; //0:RX, 1:TX +void ResponseConfig() +{ + if (responseCommand == 2) + { + unsigned long returnValue = 0; + if (DSPType == 0) + { + returnValue = 94; //None + } + else if (DSPType == 1) + { + returnValue = 95; //Spectrum (FFT) mode + } + else if (DSPType == 2) + { + returnValue = 100 + cwDecodeHz; + } + + returnValue = returnValue << 8; + returnValue = returnValue | (SMeterToUartSend & 0xFF); + returnValue = returnValue << 8; + uint8_t tmpValue = 0; + if (magnitudelimit_low > 255) + tmpValue = 255; + else if (magnitudelimit_low < 1) + tmpValue = 0; + else + tmpValue = magnitudelimit_low; + returnValue = returnValue | (tmpValue & 0xFF); + + SendCommandUL('v', returnValue); //Return data + SendCommandUL('g', 0x6A); //Return data + } + responseCommand = 0; +} + +//Result : if found .val=, 1 else 0 +char CommandPasrser(int lastIndex) +{ + //Analysing Forwrd data + //59 58 68 4A 1C 5F 6A E5 FF FF 73 + //Find Loopback protocol + // 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 + //70 6D 2E 76 76 2E 76 61 6C 3D 33 38 34 38 39 35 33 36 32 38 FF FF FF + //pm.vv.val=3848953628\xFF\xFF\xFF + //1234567890XXX + // + int startIndex = 0; + + //Loop back command has 13 ~ 23 + if (lastIndex < 13) + { + return 0; + } + + //Protocol MAX Length : 22 + if (lastIndex >= 22) + { + startIndex = lastIndex - 22; + } + else + { + startIndex = 0; + } + + for (int i = lastIndex - 3; i >= startIndex + 7; i--) + { + //Find = + if (ForwardBuff[i-3] == 'v' && ForwardBuff[i-2] == 'a' && ForwardBuff[i-1] == 'l' && ForwardBuff[i] == '=') //0x3D + { + uint8_t command1 = ForwardBuff[i-6]; //v + uint8_t command2 = ForwardBuff[i-5]; //v + // i-4 //. + ForwardBuff[lastIndex - 2] = 0; + long commandVal=atol(&ForwardBuff[i + 1]); + uint8_t *ReadBuff = (uint8_t *)&commandVal; + + //Loop Back + if (command1 == 'v' && command2 == 'v') + { + //=========================================================== + //Test Code 1 + /* + long tmpVal = 0; + Serial.print("Found :"); + for (int k = i + 1; k <= lastIndex - 3; k++) + { + Serial.write(ForwardBuff[k]); + } + Serial.println(); + Serial.print("Reverse :"); + for (int k = lastIndex - 3; k >= i + 1; k--) + { + Serial.write(ForwardBuff[k]); + } + Serial.println(); + + ForwardBuff[lastIndex - 2] = 0; + + tmpVal=atol(&ForwardBuff[i + 1]); + Serial.println(tmpVal); + + uint8_t *ReadBuff = (uint8_t *)&tmpVal; + char buff[10]; + sprintf(buff, "%x,%x,%x,%x", ReadBuff[0], ReadBuff[1], ReadBuff[2], ReadBuff[3]); + Serial.println(buff); + + int calcChecksumA = ReadBuff[0] + ReadBuff[1] + ReadBuff[2]; + calcChecksumA = calcChecksumA % 256; + + if (calcChecksumA == ReadBuff[3]) + { + Serial.print("Correct Checksum : "); + Serial.print(ReadBuff[3]); + Serial.print(":"); + Serial.println(calcChecksumA); + } + //End of Test Code + */ + + /* + //Test Code 2 + Serial.print("Found :"); + Serial.print(startIndex); + Serial.print(","); + Serial.print(lastIndex); + Serial.print(":"); + for (int k = i + 1; k <= lastIndex - 3; k++) + { + Serial.write(ForwardBuff[k]); + } + Serial.println(""); + //End of Tet Code 2 + */ + + int calcChecksum = ReadBuff[0] + ReadBuff[1] + ReadBuff[2]; + calcChecksum = calcChecksum % 256; + + //Correct Checksum and Receiver is DSP Moudle protocol v1.0 + if (calcChecksum == ReadBuff[3] && ReadBuff[2] == 0x6A) + { + //Serial.print("Correct Checksum Command : "); + //Serial.println(ReadBuff[1]); + uint8_t cmd1 = ReadBuff[1]; + if (cmd1 == 94) + { + DSPType = 0; + EEPROM.put(EEPROM_DSPTYPE, DSPType); + } + else if (cmd1 == 95) + { + //Serial.println("Spectrum Mode"); + DSPType = 1; + EEPROM.put(EEPROM_DSPTYPE, DSPType); + } + else if (cmd1 >= 100 && cmd1 <= 145) + { + cwDecodeHz = cmd1 - 100; + CalculateCoeff(cwDecodeHz); + DSPType = 2; + EEPROM.put(EEPROM_DSPTYPE, DSPType); + EEPROM.put(EEPROM_CW_FREQ, cwDecodeHz); + } + else if (cmd1 > 1 && cmd1 <= 5) //2~5 : Request Configuration + { + responseCommand = cmd1; + } + else if (cmd1 == 50 || cmd1 == 51) //Set Configuration + { + SMeterToUartSend = (cmd1 == 51); + EEPROM.put(EEPROM_SMETER_UART, SMeterToUartSend); + } + else if (cmd1 >= 146 && cmd1 <= 156 ) + { + //Save Mode + magnitudelimit_low = (cmd1 - 146) * 10; + EEPROM.put(EEPROM_CW_MAG_LOW, magnitudelimit_low); + } //end of if + } //end of check Checksum + } //end of check Protocol (vv) + else if (command1 == 'c' && command2 == 't') //TX, RX + { + if (commandVal == 0) //RX + { + TXStatus = 0; + SMeterToUartIdleCount = 0; + } + else if (commandVal == 1) //TX + { + TXStatus = 1; + SMeterToUartIdleCount = 0; + } + } + + return 1; + } //end of check Protocol (.val) + } //end of for + + //Not found Protocol (.val= + return 0; +} + +//#define PROTOCOL_TIMEOUT = 100 +int ForwardData(void) +{ + uint8_t recvChar; + + if (Serial.available() > 0) + { +#ifndef USE_SW_SERIAL + Serial.flush(); +#endif + //Check RX Buffer + while (Serial.available() > 0) + { + recvChar = Serial.read(); + + ForwardBuff[nowBuffIndex] = recvChar; + + if (recvChar == 0xFF) //found ETX + { + etxCount++; //Nextion Protocol, ETX : 0xFF, 0xFF, 0xFF + if (etxCount >= 3) + { + //Finished Protocol + if (CommandPasrser(nowBuffIndex) == 1) + { + nowSendingProtocol = 0; //Finished 1 Set Command + etxCount = 0; + nowBuffIndex = 0; + } + } + } + else + { + etxCount = 0x00; + nowSendingProtocol = 1; //Sending Data + } + + SWSerial_Write(recvChar); + lastForwardmili = millis(); + nowBuffIndex++; + + if (nowBuffIndex > MAX_FORWARD_BUFF_LENGTH -2) + { + nowBuffIndex = 0; + } + } //end of while + +#ifndef USE_SW_SERIAL + Serial.flush(); +#endif + + //lastReceivedTime = millis(); + } //end if (Serial.available + else + { + //check Timeout + + } +} + +int SendMeterData(uint8_t isSend) +{ + //basic : 1.5Khz + int newScaledSMeter = 0; + //if (ADC_DIFF > 26) //-63dBm : S9 + 10dBm + if (ADC_DIFF > 26) //-63dBm : S9 + 10dBm (subtract loss rate) + //if (ADC_DIFF > 55) //-63dBm : S9 + 15dBm + { + newScaledSMeter = 8; + } + else if (ADC_DIFF > 11) //~ -72 S9 + { + newScaledSMeter = 7; + } + else if (ADC_DIFF > 8) + { + newScaledSMeter = 6; + } + else if (ADC_DIFF > 6) //~-80 S7 + //else if (ADC_DIFF > 5) //~-80 S7 + { + newScaledSMeter = 5; + } + else if (ADC_DIFF > 4) + { + newScaledSMeter = 4; //79 S8 + } + else if (ADC_DIFF > 3) + { + newScaledSMeter = 3; //-81 ~ -78 => S7 + } + else if (ADC_DIFF > 2) + { + newScaledSMeter = 2; // -88 ~ -82 => S7 or S6 + } + else if (ADC_DIFF > 1) //-93 ~ -89 => S5 or S4 + { + newScaledSMeter = 1; + } + else // ~ -93.0dBm ~S3 or S4 + { + newScaledSMeter = 0; + } + +/* +1 : with noise (not use 0 ~ S3) +2 : -93 ~ -89 +3 : -88 ~ -81 +4 : -80 ~ -78 +5 : -77 ~ -72 +6 : -71 ~ -69 + */ + + scaledSMeter = newScaledSMeter; + + if (isSend == 1) + { + if (L_scaledSMeter != scaledSMeter) + { + L_scaledSMeter = scaledSMeter; + SendCommand1Num(CMD_SMETER, L_scaledSMeter); + } + } +} + + +void GrepADC(void) +{ + int readedValue = 0; + unsigned long currentms = 0; + int readSampleCount = 0; + + if (DSPType == 2 || DSPType == 0) //Decode Morse + { + readSampleCount = DECODE_MORSE_SAMPLESIZE; + } + else if (DSPType == 3) //Decode RTTY + { + readSampleCount = DECODE_MORSE_SAMPLESIZE; + } + else + { + readSampleCount = SAMPLESIZE; + } + + ADC_MAX = 0; + ADC_MIN = 30000; + + for(int i=0; i < readSampleCount; i++) + { + currentms = micros(); + readedValue = analogRead(SIGNAL_METER_ADC);; + FFTReal[i] = readedValue; + FFTImag[i] = 0; + + if (ADC_MAX < readedValue) + { + ADC_MAX = readedValue; + } + + if (ADC_MIN > readedValue) + { + ADC_MIN = readedValue; + } + + while(micros() < (currentms + SAMPLE_INTERVAL)){} + } //end of for +} + +void SendFFTData(void) +{ + int readedValue = 0; + for (int i = 0; i < 11; i++) + SWSerial_Write(ResponseHeader[i]); + + for(int i = 1; i < 64; i++) + { + readedValue = (int)(FFTReal[i]); + if (readedValue < 0) + { + readedValue = 0; + } + else if (readedValue>255) + { + readedValue=255; + } + SWSerial_Write(HexCodes[readedValue >> 4]); + SWSerial_Write(HexCodes[readedValue & 0xf]); + } + + for (int i = 0; i < 4; i++) + SWSerial_Write(ResponseFooter[i]); +} + +void setup() +{ + //Load Configuration + EEPROM.get(EEPROM_DSPTYPE, DSPType); + if (DSPType > 5) + { + DSPType = 1; + } + + //Signal Meter + EEPROM.get(EEPROM_SMETER_UART, SMeterToUartSend); + if (SMeterToUartSend > 2) + { + SMeterToUartSend = 1; + } + // + EEPROM.get(EEPROM_CW_FREQ, cwDecodeHz); + if (cwDecodeHz > 40 || cwDecodeHz < 1) + { + cwDecodeHz = 9; + } + + //EEPROM_CW_MAG_LOW + EEPROM.get(EEPROM_CW_MAG_LOW, magnitudelimit_low); + if (magnitudelimit_low > 1000 || magnitudelimit_low < 1) + { + magnitudelimit_low = 50; + } + + // put your setup code here, to run once: + Wire.begin(I2CMETER_ADDR); //j : S-Meter Slave Address + //Wire.begin(0x21); //j : S-Meter Slave Address + Wire.onReceive(I2CReceiveEvent); // + Wire.onRequest(I2CRequestEvent); + +#ifdef USE_SW_SERIAL + SWSerial_Begin(9600); +#endif + + Serial.begin(9600, SERIAL_8N1); + Serial.flush(); + SAMPLE_INTERVAL = round(1000000 * (1.0 / SAMPLE_PREQUENCY)); + CalculateCoeff(cwDecodeHz); //Set 750Hz //9 * 50 + 300 = 750Hz + //Serial.println("Start..."); +} + +void I2CReceiveEvent(void) +{ + int readCommand = 0; // byte를 읽어 int로 변환 + + while(Wire.available() > 0) // for Last command + { + readCommand = Wire.read(); + } + + if (0x50 <= readCommand && readCommand <= 0x59) + { + I2CCommand = readCommand; + } +} + +void I2CRequestEvent(void) +{ + int maxValue = 0; + int minValue = 30000; + int readedValue = 0; + unsigned long curr = 0; + + //if (nowADCSampling == 1) //Now Sampling ADC's + //{ + // nowADCSampling = 2; //when finished ADC Sampling, response I2CRequest Event + // return; + //} //end of if + + if (I2CCommand == I2CMETER_CALCS) + { + Wire.write(scaledSMeter); + } + else if (I2CCommand == I2CMETER_UNCALCS) + { + //Wire.write(ADC_DIFF); + //8292Hz + for(int i=0; i < 7; i++) + { + curr = micros(); + readedValue = analogRead(SIGNAL_METER_ADC);; + + if (readedValue > maxValue) + { + maxValue = readedValue; + } + + if (readedValue < minValue) + { + minValue = readedValue; + } + while(micros() < (curr + 127)){} //8Khz / 7 + } //end of for + + readedValue = maxValue - minValue; + readedValue = readedValue * readedValue; + //readedValue = readedValue / 2; + if (readedValue < 0) + { + readedValue = 0; + } + else if (readedValue > 255) + { + readedValue = 255; + } + Wire.write(readedValue); + } + else if (I2CCommand == I2CMETER_CALCP) + { + readedValue = analogRead(POWER_METER_ADC); //POWER + Wire.write(readedValue); + } + else if (I2CCommand == I2CMETER_CALCR) //SWR + { + readedValue = analogRead(SWR_METER_ADC); + Wire.write(readedValue); + } +} + +extern void Decode_Morse(float magnitude); +extern double coeff; + + +#define LAST_TIME_INTERVAL 159 + +//int SWRAdcValue = 0; +float adcFWD = 0; +float adcRWD = 0; +uint16_t adjustPower = 230; +float swrMeasured; + +int clcCount = 0; + + +//for boot Delay, a alot of data transfer +//Delay 2.5 Sec +byte isBooted = 0; + +void loop() +{ + char isProcess = 0; //0 : Init, 1 : Complete ADC Sampling, 2 : Complete FFT + isProcess = 0; + + ForwardData(); + if (isBooted < 100) + { + //Delay 20msec + for (int i = 0; i < 20; i++) + { + ForwardData(); + delay(1); + } + isBooted++; + return; + } + + //=========================================== + //TRANSCEIVER STATUS : RX + //=========================================== + if (TXStatus == 1) //TX Mode + { + /* + int readedValue = 0; + SMeterToUartIdleCount++; + if (SMeterToUartIdleCount > 130) //SWR + { + //SWR Send + SendCommandL('m', SWRAdcValue); + SendCommand1Num('m', 3); + SMeterToUartIdleCount = 0; + } + else if (SMeterToUartIdleCount == 100) //POWER 500msec interval + { + readedValue = analogRead(POWER_METER_ADC ); + SWRAdcValue = analogRead(SWR_METER_ADC); + SendCommandL('m', readedValue); + SendCommand1Num('m',2); + //PWR Send + } + */ + + //************************************************ + //Read FWD and RWD + adcFWD = adcFWD * 0.8 + analogRead(A2) * 0.2; + adcRWD = adcRWD * 0.8 + analogRead(A3) * 0.2; + + if (adcRWD > adcFWD) + { + adcRWD = adcFWD; + } + + //for Realtime LCD Display + ForwardData(); + + if (clcCount++ > 10) + { + //Calculated Power and swr and Send Information + clcCount = 0; + + //Calc PWR + float PWR = pow(adcFWD, 2); + PWR = PWR / adjustPower / 100; + + //Calc SWR + float Vratio = adcRWD / adcFWD; + if (adcRWD < 0.05 && adcFWD < 0.05) + { + //No signal + swrMeasured = 0; + } + else if (Vratio > 0.99) + { + swrMeasured = 1999; + } + else + { + swrMeasured = ((1 + Vratio)/ (1 - Vratio)); + } + + //For Version 0.8 + //Send SWR Information using Receive Signal Meter Protocol + scaledSMeter = (int)(swrMeasured + 0.5); + if (scaledSMeter > 9) + { + scaledSMeter = 9; + } + + if (L_scaledSMeter != scaledSMeter) + { + L_scaledSMeter = scaledSMeter; + SendCommand1Num(CMD_SMETER, L_scaledSMeter); + } + + //For Version 1.0 + //need mod uBITX firmware and Nextion LCD and add Power adjust value option (uBITX Manager) + //Send Information + //SWR Send + //SendCommandL('m', SWRAdcValue); + //SendCommand1Num('m', 3); + //SMeterToUartIdleCount = 0; + //Send Power Information + int readedValue = (int)(PWR * 100); + SendCommandL('m', readedValue); + SendCommand1Num('m',2); + + //Delay 250msec ~ 500msec for Nextion LCD Processing (using m protocol) + + for (int i = 0; i < 10; i++) + { + ForwardData(); + if (TXStatus != 1) //if TX -> RX break + { + break; + } + delay(25); + } //end of delay time + + //Send SWR + readedValue = (int)(swrMeasured * 100); + SendCommandL('m', readedValue); + SendCommand1Num('m', 3); + + //delay(50); + //return; + } + + delay(30); + return; //Do not processing ADC, FFT, Decode Morse or RTTY, only Power and SWR Data Return + } + + //=========================================== + //TRANSCEIVER STATUS : RX + //=========================================== + //=========================================== + // ADC Sampling + //=========================================== + if (nowSendingProtocol == 0) //Idle Status + { + nowADCSampling = 1; //Mark => Start Sampling + GrepADC(); + + //if(nowADCSampling == 2) //Marked ? While ADC Sampling, receive I2C + //{ + // nowADCSampling = 0; //Mark => Finish Sampling + // I2CRequestEvent(); + //} + nowADCSampling = 0; //Mark => Finish Sampling + + int newDiff = ADC_MAX - ADC_MIN; //Calculated for Signal Meter (ADC_DIFF => Signal Strength) + //ADC_DIFF = ((ADC_DIFF * 7) + (newDiff * 3)) / 10; + ADC_DIFF = newDiff; + isProcess = 1; //Mark => Complete ADC Sampling + } + + ForwardData(); + + //=========================================== + // Send Signal Meter to UART + //=========================================== + if (SMeterToUartSend == 1) //SMeter To Uart Send + { + //When selected Morse decode mode, not send signal Meter + //if ((DSPType != 2) && (SMeterToUartIdleCount++ > (SMeterToUartInterval * (DSPType == 1 ? 1 : 12)))) + //User Option + if (SMeterToUartIdleCount++ > (SMeterToUartInterval * (DSPType == 1 ? 1 : 12))) + { + //nowSendingProtocol -> not finished data forward, (not found 0xff, 0xff, 0xff yet) + if (nowSendingProtocol == 0 && isProcess == 1) //Complete ADC Sampling and Idle status + { + SendMeterData(1); + SMeterToUartIdleCount = 0; + } + } + } //end of if + else + { + SendMeterData(0); //only calculate Signal Level + } + + ForwardData(); + + //Check Response Command + if (responseCommand > 0 && millis() > lastForwardmili + LAST_TIME_INTERVAL) + { + ResponseConfig(); + } + + //=================================================================================== + // DSP Routine + //=================================================================================== + if (DSPType == 1 && millis() > lastForwardmili + LAST_TIME_INTERVAL) //Spectrum : FFT => Send To UART + { + FFTToUartIdleCount = 0; + + if (isProcess == 1) + { + FFT(FFTReal, FFTImag, SAMPLESIZE, 7); + isProcess = 2; + } + + ForwardData(); + + if (isProcess == 2) + { + for (uint16_t k = 0; k < SAMPLESIZE; k++) + { + FFTReal[k] = sqrt(FFTReal[k] * FFTReal[k] + FFTImag[k] * FFTImag[k]); + } + + isProcess = 3; + } + + ForwardData(); + + if (isProcess == 3) + { + if (nowSendingProtocol == 0) //Idle Status + { + SendFFTData(); + } + } + } + else if (DSPType == 2) //Decode Morse + { + //Implement Goertzel_algorithm + //https://en.wikipedia.org/wiki/Goertzel_algorithm + + /* + ω = 2 * π * Kterm / Nterms; + cr = cos(ω); + ci = sin(ω); + coeff = 2 * cr; + + sprev = 0; + sprev2 = 0; + for each index n in range 0 to Nterms-1 + s = x[n] + coeff * sprev - sprev2; + sprev2 = sprev; + sprev = s; + end + + power = sprev2 * sprev2 + sprev * sprev - coeff * sprev * sprev2; + */ + double Q1 = 0; + double Q2 = 0; + + for (char index = 0; index < DECODE_MORSE_SAMPLESIZE; index++) + { + float Q0; + Q0 = coeff * Q1 - Q2 + FFTReal[index]; + Q2 = Q1; + Q1 = Q0; + } + double magnitudeSquared = (Q1*Q1)+(Q2*Q2)-Q1*Q2*coeff; // we do only need the real part // + double magnitude = sqrt(magnitudeSquared); + + Decode_Morse(magnitude); + } //enf of if +} //end of main diff --git a/i2cmeter1/uart_forward.cpp b/i2cmeter1/uart_forward.cpp new file mode 100644 index 0000000..2323531 --- /dev/null +++ b/i2cmeter1/uart_forward.cpp @@ -0,0 +1,355 @@ +/* +Softserial for Nextion LCD and Control MCU +KD8CEC, Ian Lee +----------------------------------------------------------------------- +It is a library rewritten in C format based on SoftwareSerial.c. +I tried to use as much as possible without modifying the SoftwareSerial. +But eventually I had to modify the code. + +I rewrote it in C for the following reasons. + - Problems occurred when increasing Program Size and Program Memory + - We had to reduce the program size. + Of course, Software Serial is limited to one. + - reduce the steps for transmitting and receiving + +useage +extern void SWSerial_Begin(long speedBaud); +extern void SWSerial_Write(uint8_t b); +extern int SWSerial_Available(void); +extern int SWSerial_Read(void); +extern void SWSerial_Print(uint8_t *b); + +If you use Softwreserial library instead of this library, you can modify the code as shown below. +I kept the function name of SoftwareSerial so you only need to modify a few lines of code. + +define top of source code +#include +SoftwareSerial sSerial(10, 11); // RX, TX + +replace source code +SWSerial_Begin to sSerial.begin +SWSerial_Write to sSerial.write +SWSerial_Available to sSerial.available +SWSerial_Read to sSerial.read + +KD8CEC, Ian Lee +----------------------------------------------------------------------- +License +All licenses for the source code are subject to the license of the original source SoftwareSerial Library. +However, if you use or modify this code, please keep the all comments in this source code. +KD8CEC +----------------------------------------------------------------------- +License from SoftwareSerial +----------------------------------------------------------------------- +SoftwareSerial.cpp (formerly NewSoftSerial.cpp) - +Multi-instance software serial library for Arduino/Wiring +-- Interrupt-driven receive and other improvements by ladyada + (http://ladyada.net) +-- Tuning, circular buffer, derivation from class Print/Stream, + multi-instance support, porting to 8MHz processors, + various optimizations, PROGMEM delay tables, inverse logic and + direct port writing by Mikal Hart (http://www.arduiniana.org) +-- Pin change interrupt macros by Paul Stoffregen (http://www.pjrc.com) +-- 20MHz processor support by Garrett Mace (http://www.macetech.com) +-- ATmega1280/2560 support by Brett Hagman (http://www.roguerobotics.com/) + +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 + +The latest version of this library can always be found at +http://arduiniana.org. + */ +#include "i2cmeter1.h" + +#ifdef USE_SW_SERIAL +//================================================================ +//Public Variable +//================================================================ +#define TX_PIN 9 +#define RX_PIN 8 +#define _SS_MAX_RX_BUFF 35 // RX buffer size +#define PRINT_MAX_LENGTH 30 + +//================================================================ +//Internal Variable from SoftwareSerial.c and SoftwareSerial.h +//================================================================ +//variable from softwareserial.c and softwareserial.h +static uint8_t swr_receive_buffer[_SS_MAX_RX_BUFF]; + +volatile uint8_t *_transmitPortRegister; //Write Port Register +uint8_t transmit_RegMask; //use Mask bit 1 +uint8_t transmit_InvMask; //use mask bit 0 + +volatile uint8_t *_receivePortRegister; //Read Port Register +uint8_t _receiveBitMask; + +//delay value for Bit +uint16_t _tx_delay; + +//delay value for Receive +uint16_t _rx_delay_stopbit; +uint16_t _rx_delay_centering; +uint16_t _rx_delay_intrabit; + +//Customize for uBITX Protocol +int8_t receiveIndex = 0; +int8_t receivedCommandLength = 0; +int8_t ffCount = 0; + +//Values for Receive Buffer +//uint16_t _buffer_overflow; +//static volatile uint8_t _receive_buffer_head; +//static volatile uint8_t _receive_buffer_tail; + +//Values for Interrupt (check Start Bit) +volatile uint8_t *_pcint_maskreg; +uint8_t _pcint_maskvalue; + +//================================================================ +//Internal Function from SoftwareSerial.c +//================================================================ +uint16_t subtract_cap(uint16_t num, uint16_t sub) +{ + if (num > sub) + return num - sub; + else + return 1; +} + +inline void tunedDelay(uint16_t delay) +{ + _delay_loop_2(delay); +} + +void setRxIntMsk(bool enable) +{ + if (enable) + *_pcint_maskreg |= _pcint_maskvalue; + else + *_pcint_maskreg &= ~_pcint_maskvalue; +} + +uint8_t rx_pin_read() +{ + return *_receivePortRegister & _receiveBitMask; +} + +// +// The receive routine called by the interrupt handler +// +void softSerail_Recv() +{ +#if GCC_VERSION < 40302 +// Work-around for avr-gcc 4.3.0 OSX version bug +// Preserve the registers that the compiler misses +// (courtesy of Arduino forum user *etracer*) + asm volatile( + "push r18 \n\t" + "push r19 \n\t" + "push r20 \n\t" + "push r21 \n\t" + "push r22 \n\t" + "push r23 \n\t" + "push r26 \n\t" + "push r27 \n\t" + ::); +#endif + + uint8_t d = 0; + + // If RX line is high, then we don't see any start bit + // so interrupt is probably not for us + if (!rx_pin_read()) //Start Bit + { + // Disable further interrupts during reception, this prevents + // triggering another interrupt directly after we return, which can + // cause problems at higher baudrates. + setRxIntMsk(false); + + // Wait approximately 1/2 of a bit width to "center" the sample + tunedDelay(_rx_delay_centering); + + // Read each of the 8 bits + for (uint8_t i=8; i > 0; --i) + { + tunedDelay(_rx_delay_intrabit); + d >>= 1; + + if (rx_pin_read()) + d |= 0x80; + } + + if (receivedCommandLength == 0) //check Already Command + { + //Set Received Data + swr_receive_buffer[receiveIndex++] = d; + + //Finded Command + if (d == 0x73 && ffCount > 1 && receiveIndex > 6) + { + receivedCommandLength = receiveIndex; + receiveIndex = 0; + ffCount = 0; + } + else if (receiveIndex > _SS_MAX_RX_BUFF) + { + //Buffer Overflow + receiveIndex = 0; + ffCount = 0; + } + else if (d == 0xFF) + { + ffCount++; + } + else + { + ffCount = 0; + } + } + + // skip the stop bit + tunedDelay(_rx_delay_stopbit); + + // Re-enable interrupts when we're sure to be inside the stop bit + setRxIntMsk(true); + } + +#if GCC_VERSION < 40302 +// Work-around for avr-gcc 4.3.0 OSX version bug +// Restore the registers that the compiler misses + asm volatile( + "pop r27 \n\t" + "pop r26 \n\t" + "pop r23 \n\t" + "pop r22 \n\t" + "pop r21 \n\t" + "pop r20 \n\t" + "pop r19 \n\t" + "pop r18 \n\t" + ::); +#endif +} + +ISR(PCINT0_vect) +{ + softSerail_Recv(); +} + +//================================================================ +//Public Function from SoftwareSerial.c and modified and create +//================================================================ +// Read data from buffer +void SWSerial_Read(uint8_t * receive_cmdBuffer) +{ + for (int i = 0; i < receivedCommandLength; i++) + receive_cmdBuffer[i] = swr_receive_buffer[i]; +} + +void SWSerial_Write(uint8_t b) +{ + volatile uint8_t *reg = _transmitPortRegister; + uint8_t oldSREG = SREG; + uint16_t delay = _tx_delay; + + cli(); // turn off interrupts for a clean txmit + + // Write the start bit + *reg &= transmit_InvMask; + + tunedDelay(delay); + + // Write each of the 8 bits + for (uint8_t i = 8; i > 0; --i) + { + if (b & 1) // choose bit + *reg |= transmit_RegMask; // send 1 + else + *reg &= transmit_InvMask; // send 0 + + tunedDelay(delay); + b >>= 1; + } + + // restore pin to natural state + *reg |= transmit_RegMask; + + SREG = oldSREG; // turn interrupts back on + tunedDelay(_tx_delay); +} + +void SWSerial_Print(uint8_t *b) +{ + for (int i = 0; i < PRINT_MAX_LENGTH; i++) + { + if (b[i] == 0x00) + break; + else + SWSerial_Write(b[i]); + } +} + +void SWSerial_Begin(long speedBaud) +{ + //INT TX_PIN + digitalWrite(TX_PIN, HIGH); + pinMode(TX_PIN, OUTPUT); + transmit_RegMask = digitalPinToBitMask(TX_PIN); //use Bit 1 + transmit_InvMask = ~digitalPinToBitMask(TX_PIN); //use Bit 0 + _transmitPortRegister = portOutputRegister(digitalPinToPort(TX_PIN)); + + //INIT RX_PIN + pinMode(RX_PIN, INPUT); + digitalWrite(RX_PIN, HIGH); // pullup for normal logic! + _receiveBitMask = digitalPinToBitMask(RX_PIN); + _receivePortRegister = portInputRegister(digitalPinToPort(RX_PIN)); + + //Set Values + uint16_t bit_delay = (F_CPU / speedBaud) / 4; + _tx_delay = subtract_cap(bit_delay, 15 / 4); + + if (digitalPinToPCICR(RX_PIN)) + { + _rx_delay_centering = subtract_cap(bit_delay / 2, (4 + 4 + 75 + 17 - 23) / 4); + _rx_delay_intrabit = subtract_cap(bit_delay, 23 / 4); + _rx_delay_stopbit = subtract_cap(bit_delay * 3 / 4, (37 + 11) / 4); + *digitalPinToPCICR(RX_PIN) |= _BV(digitalPinToPCICRbit(RX_PIN)); + _pcint_maskreg = digitalPinToPCMSK(RX_PIN); + _pcint_maskvalue = _BV(digitalPinToPCMSKbit(RX_PIN)); + + tunedDelay(_tx_delay); // if we were low this establishes the end + } + + //Start Listen + setRxIntMsk(true); +} +#else +void SWSerial_Write(uint8_t b) +{ + Serial.write(b); + //Serial.flush(); +} + +void SWSerial_Print(uint8_t *b) +{ + for (int i = 0; i < PRINT_MAX_LENGTH; i++) + { + if (b[i] == 0x00) + break; + else + SWSerial_Write(b[i]); + } +} + +#endif +