From 5556a095547cd623bc0ea8c054e5a4d8c2021bda Mon Sep 17 00:00:00 2001 From: Loren Moore Date: Tue, 31 Aug 2021 19:26:08 -0400 Subject: [PATCH] More Functional Alpha. Change to GPLv3. --- CHANGELOG | 4 +- LICENSE | 632 +++++++++++++++++++++++++++++++++- README.md | 77 +++-- alpha/alpha001.ino | 163 +++++++++ libraries/rotary/Rotary.cpp | 148 ++++++++ libraries/rotary/Rotary.h | 37 ++ libraries/rotary/keywords.txt | 5 + 7 files changed, 1022 insertions(+), 44 deletions(-) create mode 100644 alpha/alpha001.ino create mode 100644 libraries/rotary/Rotary.cpp create mode 100644 libraries/rotary/Rotary.h create mode 100644 libraries/rotary/keywords.txt diff --git a/CHANGELOG b/CHANGELOG index 8c5331a..c5351c9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,5 +1,5 @@ CHANGELOG: -There have been no revisions to any code as of the initial commit. +31-AUG-2021: -Stay tuned for development updates. \ No newline at end of file +Code actually now interfaces with radio, display, encoder. Does stuff. \ No newline at end of file diff --git a/LICENSE b/LICENSE index 320caca..93795bd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,18 +1,622 @@ -Copyright 2020 Jay Moore +HamHead - Remote Head For Ham Radio +Copyright 2021 Jay Moore - nq4tango@gmail.com -Redistribution and use in source and binary forms, with or without modification, are permitted -provided that the following conditions are met: + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -1. Redistributions of source code must retain the above copyright notice, this -list of conditions and the following disclaimer. + 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. -2. 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. + Preamble -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 HOLDER 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. + 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. \ No newline at end of file diff --git a/README.md b/README.md index 0a68a0f..1d56958 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,32 @@ -ArFO - Arduino Frequency Oscillator +HamHead - Remote Head For Your CAT Rig -A (mobile) remote head for your ham transceiver. +By: Jay Moore/NQ4T - nq4tango@gmail.com # History ``` 8-Feb-2020: Repository Creation, Intitial Commit, Alpha Versions +31-Aug-2020: Name Change, More Alpha Code, Actually Control Radio ```` # About -ArFO is an Arduino-based program that interfaces with an external display, external controls, and your ham rig; +HamHead (formerally ArFO) is an Arduino-based program that interfaces with an external display, external controls, and your ham rig; to allow you the convenience of a remote head for rigs that do not feature one. It is written in Arduino and -commands your rig using it's CAT/CI-V connection. ArFO is a continuation/reboot of PiFO; a previous project +commands your rig using it's CAT/CI-V connection. HamHead is a continuation/reboot of PiFO; a previous project that sought to do the same thing. -In addition to being able to control your operating mode, VFO, and a few other select options; ArFO also provides +In addition to being able to control your operating mode, VFO, and a few other select options; HamHead also provides "advanced logic" for an otherwise older rig. When possible, it uses it's own programming rather than rely on the rig's internal functions. Planned features include a memory function, similar to what the proof-of-concept PiFO was; that will allow you to expand on the memory preset functions of older rigs as well as the ability to carry -your memory presets with you between rigs. ArFO stores the frequency information and sends it to the radio as +your memory presets with you between rigs. HamHead stores the frequency information and sends it to the radio as a frequency for the VFO. -ArFO will use it's own internal logic when necessary, meaning older rigs will get some new features. This means -some limitations (like CI-V WARC band data) are irrelevant to ArFO as we can calculate and process things +HamHead will use it's own internal logic when necessary, meaning older rigs will get some new features. This means +some limitations (like CI-V WARC band data) are irrelevant to HamHead as we can calculate and process things ourselves. # Why The Change To Arduino @@ -69,9 +70,26 @@ act as a USB host and understand all the various serial-to-USB adapters on the m available as an external module; the goal of this project is to keep costs to a minimum. No one wants to spend $300 on a remote head accessory! +Development for iCom stuff is being done primarily on an IC-7100, with a IC-706MKII and IC-725 to check compatibility. +I won't mention the irony of developing a remote head on a rig with a remote head....or the fact I came up with the +thing when I had no rigs with remote heads and now own two. + Additional display types may be supported depending on demand or user-submitted code. The project is open-source; you are welcome to contribute code. +# Software + +All sketches are currently in the "alpha" folder. + +This software currently uses two libraries: + +LEDMatrixDriver by Bartosz Bielawski - Installable in the ArduinoIDE or from https://github.com/bartoszbielawski/LEDMatrixDriver + +Rotary by Ben Buxton - https://github.com/buxtronix/arduino/tree/master/libraries + +A copy of the Rotary library has been included as it is not available in the ArduinoIDE. + +I have also changed from my ususal BSD 2-Clause license to GPL v3 for better compatibility with any libraries. # Current DEV Status @@ -79,34 +97,37 @@ are welcome to contribute code. Development offically started on 5-FEB-2020 with working out the physical interface betweent he rig and the radio. This has been fully tested and I'm able to send and receieve bytes. -The current phase of development is largely focusing on the communication library for CI-V. In it's current state, -the software is able to detect, receive, and filter CI-V data packets and able to process iCom's BCD data in to a -decimal format that can be worked with by the rest of the software. Currently this just displays the frequency to -the serial port on the Mega2560 connected to the USB adapter. The radio is currently using one of the remaining -hardware serial ports. +Current development is extremely early alpha and is largely working on not just getting iCom CI-V communication +working, but making sure I can actually get everything working the way I want. It's not considered ready for +prime-time and the code will likely undergo reorganization to make customizations to physical UI and radio +drivers easier. ![Current Development Version](/images/civdecode.png "CIV Decoding")*Current Development Version* +Development was dorment from early 2020 until late summer 2021 when it was restarted. The current alpha is now capable +of actually controlling a radio and displaying it's frequency. -# License +[Video Showing Current Protptype] (https://youtu.be/GGRZIbIPLOM) -Copyright 2020 Jay Moore -Redistribution and use in source and binary forms, with or without modification, are permitted -provided that the following conditions are met: +# License + + HamHead - Remote Head For Ham Radios + Copyright (C) 2021 Jay Moore - nq4tango@gmail.com -1. Redistributions of source code must retain the above copyright notice, this -list of conditions and the following disclaimer. + 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. -2. 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. + 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. -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 HOLDER 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. + You should have received a copy of the GNU General Public License + along with this program. If not, see . + Rotary encoder handler for arduino. v1.1 + Copyright 2011 Ben Buxton. Licenced under the GNU GPL Version 3. Contact: bb@cactii.net \ No newline at end of file diff --git a/alpha/alpha001.ino b/alpha/alpha001.ino new file mode 100644 index 0000000..e79ae55 --- /dev/null +++ b/alpha/alpha001.ino @@ -0,0 +1,163 @@ +/** +HamHead - Remote Head for Ham Radio +Copyright (C)2020 Jay Moore/NQ4T - nq4tango@gmail.com +Licensed under GPL-3.0-or-later + +Version .001 Alpha +**/ + +#include +#include +// Rotary.h uses hardware SPI on Mega2560 pins 52 and 50 or something +const uint8_t LEDMATRIX_CS_PIN = 49; // You're not going to have GPIO49 on an Uno. +const int NO_OF_DRIVERS = 1; // Each MAX7219 driver can drive eight 7-segment displays. +LEDMatrixDriver lmd(NO_OF_DRIVERS, LEDMATRIX_CS_PIN); +const byte numBytes = 32; +byte rxbytes[numBytes]; // store CI-V incoming bytes here +long dec[5]; // part of the decimal to vfo conversion +int bc = 0; // byte counter +boolean newdata = false; +boolean newvfo = false; +unsigned long vfoa; +byte digit; // used by the display routine. + +Rotary rotary = Rotary(2, 3); +void setup() { +Serial1.begin(19200); // I'm using a Mega2560 so I have multiple hardware UART +// hardware interrupt for rotary encoder +attachInterrupt(0, rotate, CHANGE); +attachInterrupt(1, rotate, CHANGE); +// copied from display library initialization + lmd.setEnabled(true); + lmd.setIntensity(2); // 0 = min, 15 = max + lmd.setScanLimit(7); // 0-7: Show 1-8 digits. Beware of currenct restrictions for 1-3 digits! See datasheet. + lmd.setDecode(0xFF); // Enable "BCD Type B" decoding for all digits. +} + +void loop() { +getdata(); // check for serial data +if (rxbytes[0] == 0x88) newdata=false; // ignore echo (for now. I have an idea) +if (newdata == true) gogovfo(); // Go go VFO! +if (newvfo == true) disp(); // update the LED + +} +void getdata() { + byte rb; + while (Serial1.available() > 0 && newdata == false) { + rb = Serial1.read(); + if (rb == 0xFE) { // if it's a start byte we don't need it. + newdata = false; // make sure we keep looping + bc = 0; // i don't trust myself + } else if (rb == 0xFD) { // end of the frame + rxbytes[bc] = '\0'; // terminate the string + newdata = true; // indicate there's new data + //i--; // I thought I needed this + } else { + rxbytes[bc] = rb; // write the byte to the array + bc++; // increment byte counter + } +} +} +/** +"Go Go VFO" is requires some room to explain just what it does. The data sent +in is both BCD and little-endian; so I not only have to convert the data from BCD, +but I have to load the bytes "backwards". + +Grab a byte, bitshift it 4 to the left, multiply it by 10. Take that same byte, bitwise +AND it aginst 00001111, add them together. Now add those together in to +a new array; multiply each entry in the array by the appropriate power of 10, +add all that together in to a new variable. + +Oh, and then set newvfo to true so we can update displays. +**/ + +void gogovfo() { + int i = 0; + long bcd[4]; + bc -= 2; // adjust for array index starting at 0 and ditch the V/U byte + if (rxbytes[2] == 0){ + for (int x = bc; x > 2; x--) { + bcd[i] = (((rxbytes[x] >> 4) *10) + (rxbytes[x]&0xF)); + i++; + } + vfoa = ((bcd[0]*1000000)+(bcd[1]*10000)+(bcd[2]*100)+(bcd[3])); + newvfo = true; + }} + +void vfoup() { // this is called by the ISR for the rotary encoder. + vfoa += 1000; // right now we're just adding 1000hz, but this will be selectable + vfotobcd(); // black magic voodoo + newvfo = true; // since we technically updated the VFO +} + +void vfodown() { // this is the same thing, but the other direction + vfoa -= 1000; // drop 1000hz + vfotobcd(); // do that voodoo that you do so well + newvfo = true; // since, you know...new VFO +} + +/** +Here's some black magic for ya. In order to go from the internal VFO +number, I have to basically reverse the process for getting it form the +radio; convert everything in to BCD digits in little-endian. + +Do a bunch of math on vfoa that has the basic effect of splitting it in +to two digit chunks, writing each to an array. + +Now divide each array entry by 10, bitshift right, add that by the remainder +and slap them in a byte. Do that 4 times running backwards through the +array. + +**/ +void vfotobcd() { +byte bcd2[10]; +int dec[5]; +int i = 3; + dec[0] = vfoa / 1000000; + dec[1] = (vfoa % 1000000) / 10000; + dec[2] = (vfoa % 10000) / 100; + dec[3] = vfoa % 100; +for (int x = 0; x < 4; x++){ + bcd2[i] = (((dec[x] / 10) << 4) + (dec[x] % 10)); + i--; +} + +// There's got to be a better/cleaner way of doing this I haven't figured out yet +Serial1.write(0xFE); // start byte +Serial1.write(0xFE); // start byte +Serial1.write(0x88); // IC-7100 hex address +Serial1.write(0xE0); // standard E0 controller address +Serial1.write(0x00); // no-reply VFO change +Serial1.write(bcd2, 4); // the BCD data +Serial1.write(0xFD); // end byte +} + +void disp() { + unsigned long vfod = vfoa; // we have to copy this or we'll break vfoa's entry + //bc++; // I thought I needed this. + +/** +I know it's a for loop and it looks like it's just getting the remainder +and dividing by 10 each time to split out the digits, but I haven't +actually figured out how this works. Taken from the library example. +**/ + for (digit = 0; digit < 8; digit++) { + lmd.setDigit(digit, vfod % 10, digit == 3); + vfod /= 10; + } + lmd.display(); + delay(10); +// set these false or you're going to have problems + newdata = false; + newvfo = false; +} + +// this came right from the rotary library example. +void rotate() { + unsigned char result = rotary.process(); + if (result == DIR_CW) { + vfoup(); + } else if (result == DIR_CCW) { + vfodown(); + } +} \ No newline at end of file diff --git a/libraries/rotary/Rotary.cpp b/libraries/rotary/Rotary.cpp new file mode 100644 index 0000000..298925d --- /dev/null +++ b/libraries/rotary/Rotary.cpp @@ -0,0 +1,148 @@ +/* Rotary encoder handler for arduino. v1.1 + * + * Copyright 2011 Ben Buxton. Licenced under the GNU GPL Version 3. + * Contact: bb@cactii.net + * + * A typical mechanical rotary encoder emits a two bit gray code + * on 3 output pins. Every step in the output (often accompanied + * by a physical 'click') generates a specific sequence of output + * codes on the pins. + * + * There are 3 pins used for the rotary encoding - one common and + * two 'bit' pins. + * + * The following is the typical sequence of code on the output when + * moving from one step to the next: + * + * Position Bit1 Bit2 + * ---------------------- + * Step1 0 0 + * 1/4 1 0 + * 1/2 1 1 + * 3/4 0 1 + * Step2 0 0 + * + * From this table, we can see that when moving from one 'click' to + * the next, there are 4 changes in the output code. + * + * - From an initial 0 - 0, Bit1 goes high, Bit0 stays low. + * - Then both bits are high, halfway through the step. + * - Then Bit1 goes low, but Bit2 stays high. + * - Finally at the end of the step, both bits return to 0. + * + * Detecting the direction is easy - the table simply goes in the other + * direction (read up instead of down). + * + * To decode this, we use a simple state machine. Every time the output + * code changes, it follows state, until finally a full steps worth of + * code is received (in the correct order). At the final 0-0, it returns + * a value indicating a step in one direction or the other. + * + * It's also possible to use 'half-step' mode. This just emits an event + * at both the 0-0 and 1-1 positions. This might be useful for some + * encoders where you want to detect all positions. + * + * If an invalid state happens (for example we go from '0-1' straight + * to '1-0'), the state machine resets to the start until 0-0 and the + * next valid codes occur. + * + * The biggest advantage of using a state machine over other algorithms + * is that this has inherent debounce built in. Other algorithms emit spurious + * output with switch bounce, but this one will simply flip between + * sub-states until the bounce settles, then continue along the state + * machine. + * A side effect of debounce is that fast rotations can cause steps to + * be skipped. By not requiring debounce, fast rotations can be accurately + * measured. + * Another advantage is the ability to properly handle bad state, such + * as due to EMI, etc. + * It is also a lot simpler than others - a static state table and less + * than 10 lines of logic. + */ + +#include "Arduino.h" +#include "Rotary.h" + +/* + * The below state table has, for each state (row), the new state + * to set based on the next encoder output. From left to right in, + * the table, the encoder outputs are 00, 01, 10, 11, and the value + * in that position is the new state to set. + */ + +#define R_START 0x0 + +#ifdef HALF_STEP +// Use the half-step state table (emits a code at 00 and 11) +#define R_CCW_BEGIN 0x1 +#define R_CW_BEGIN 0x2 +#define R_START_M 0x3 +#define R_CW_BEGIN_M 0x4 +#define R_CCW_BEGIN_M 0x5 +const unsigned char ttable[6][4] = { + // R_START (00) + {R_START_M, R_CW_BEGIN, R_CCW_BEGIN, R_START}, + // R_CCW_BEGIN + {R_START_M | DIR_CCW, R_START, R_CCW_BEGIN, R_START}, + // R_CW_BEGIN + {R_START_M | DIR_CW, R_CW_BEGIN, R_START, R_START}, + // R_START_M (11) + {R_START_M, R_CCW_BEGIN_M, R_CW_BEGIN_M, R_START}, + // R_CW_BEGIN_M + {R_START_M, R_START_M, R_CW_BEGIN_M, R_START | DIR_CW}, + // R_CCW_BEGIN_M + {R_START_M, R_CCW_BEGIN_M, R_START_M, R_START | DIR_CCW}, +}; +#else +// Use the full-step state table (emits a code at 00 only) +#define R_CW_FINAL 0x1 +#define R_CW_BEGIN 0x2 +#define R_CW_NEXT 0x3 +#define R_CCW_BEGIN 0x4 +#define R_CCW_FINAL 0x5 +#define R_CCW_NEXT 0x6 + +const unsigned char ttable[7][4] = { + // R_START + {R_START, R_CW_BEGIN, R_CCW_BEGIN, R_START}, + // R_CW_FINAL + {R_CW_NEXT, R_START, R_CW_FINAL, R_START | DIR_CW}, + // R_CW_BEGIN + {R_CW_NEXT, R_CW_BEGIN, R_START, R_START}, + // R_CW_NEXT + {R_CW_NEXT, R_CW_BEGIN, R_CW_FINAL, R_START}, + // R_CCW_BEGIN + {R_CCW_NEXT, R_START, R_CCW_BEGIN, R_START}, + // R_CCW_FINAL + {R_CCW_NEXT, R_CCW_FINAL, R_START, R_START | DIR_CCW}, + // R_CCW_NEXT + {R_CCW_NEXT, R_CCW_FINAL, R_CCW_BEGIN, R_START}, +}; +#endif + +/* + * Constructor. Each arg is the pin number for each encoder contact. + */ +Rotary::Rotary(char _pin1, char _pin2) { + // Assign variables. + pin1 = _pin1; + pin2 = _pin2; + // Set pins to input. + pinMode(pin1, INPUT); + pinMode(pin2, INPUT); +#ifdef ENABLE_PULLUPS + digitalWrite(pin1, HIGH); + digitalWrite(pin2, HIGH); +#endif + // Initialise state. + state = R_START; +} + +unsigned char Rotary::process() { + // Grab state of input pins. + unsigned char pinstate = (digitalRead(pin2) << 1) | digitalRead(pin1); + // Determine new state from the pins and state table. + state = ttable[state & 0xf][pinstate]; + // Return emit bits, ie the generated event. + return state & 0x30; +} diff --git a/libraries/rotary/Rotary.h b/libraries/rotary/Rotary.h new file mode 100644 index 0000000..cfe75fe --- /dev/null +++ b/libraries/rotary/Rotary.h @@ -0,0 +1,37 @@ +/* + * Rotary encoder library for Arduino. + */ + +#ifndef rotary_h +#define rotary_h + +#include "Arduino.h" + +// Enable this to emit codes twice per step. +//#define HALF_STEP + +// Enable weak pullups +#define ENABLE_PULLUPS + +// Values returned by 'process' +// No complete step yet. +#define DIR_NONE 0x0 +// Clockwise step. +#define DIR_CW 0x10 +// Anti-clockwise step. +#define DIR_CCW 0x20 + +class Rotary +{ + public: + Rotary(char, char); + // Process pin(s) + unsigned char process(); + private: + unsigned char state; + unsigned char pin1; + unsigned char pin2; +}; + +#endif + diff --git a/libraries/rotary/keywords.txt b/libraries/rotary/keywords.txt new file mode 100644 index 0000000..45de7a8 --- /dev/null +++ b/libraries/rotary/keywords.txt @@ -0,0 +1,5 @@ +DIR_NONE LITERAL1 +DIR_CW LITERAL1 +DIR_CCW LITERAL1 +Rotary KEYWORD1 +process KEYWORD2