├── COPYING ├── README ├── analog.ino ├── dtmf.ino ├── morse.ino ├── repeater.ino ├── timer.h └── tone.ino /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | Ham radio repeater controller 2 | ----------------------------- 3 | 4 | This is an arduino sketch aiming at providing a flexible 5 | repeater controller. 6 | 7 | The code is provided under GNU GPL v3 8 | 9 | Features: 10 | - Fully non-blocking code 11 | - Easy to modify PIN allocation 12 | - Programmable delays 13 | - Programmable morse messages 14 | - Opening controllable by 1750, CTCSS, Carrier 15 | - Programmable Beacon 16 | - Too long PTT timer 17 | 18 | Configurations: 19 | - Pins (Pin Allocations) 20 | - DELAYS 21 | INACTIVE_CLOSE: delay from last PTT to repeater closing 22 | RELEASE_BEEP: delay between PTT release and roger beep 23 | BEEP_LENGTH: when single beep is used, length of the beep 24 | PTT_ON_DELAY: Time between PTT on and morse 25 | PTT_OFF_DELAY: Time between morse and PTT off 26 | CARRIER_1750_DELAY: Required 1750/Carrier length before opening 27 | 28 | BEACON_DELAY: time between two beacons when repeater is closed 29 | TIMEOUT_DELAY: closes repeater if PTT is on for TIMEOUT_DELAY ms 30 | MORSE_DOT: time of the morse dot in ms 31 | 32 | USE_1750_OPEN: Open repeater when 1750 pin is asserted (1 for enabled) 33 | USE_CTCSS_OPEN: Open repeater when CTCSS pin is asserted (1 for enabled) 34 | USE_CARRIER_OPEN: Open repeater when Carrier pin is asserted (1 for enabled) 35 | 36 | USE_CTCSS_BUSY: active when CTCSS pin is asserted (1 for enabled) 37 | USE_CARRIER_BUSY: active when Carrier pin is asserted (1 for enabled) 38 | 39 | ROGER_TONE: use one single tone beep (exclusive with ROGER_K) 40 | ROGER_K: use morse K (exclusive with ROGER_TONE) 41 | 42 | BEEP_FREQ: Roger beep frequency 43 | MORSE_FREQ: Morse frequency 44 | 45 | Avoid modifying the other defines unless you know what you are doing... 46 | 47 | - Messages 48 | openMsg: message when repeater is opened 49 | closeMsg: message when the repeater is closing 50 | kMsg: message for roger beep 51 | beaconMsg: ID message when repeater is closed 52 | timeoutMsg: message when PTT is held for too long 53 | 54 | Code internals: 55 | In the setup function, pins are configured in ioSetup function. 56 | Serial is enabled for debug purposes. And Watchdog is enabled. 57 | 58 | In the loop function, PTT is controlled, repeater is controlled 59 | to be opened or closed. Morse is generated and beacon is controlled. 60 | 61 | Watchdog is reset every loop iteration and timeout is 8 s. 62 | 63 | Repeater can be in 3 states: 64 | REPEATER_CLOSED: Repeater is IDLE, identifying itself every 65 | BEACON_DELAY. If the 1750, CTCSS or Carrier pin is enabled, State goes to 66 | REPEATER_OPEN. 67 | 68 | REPEATER_OPEN: Detects Sql openings, Generates Roger beep 69 | and timeout timer 70 | 71 | REPEATER_MORSE: Currently sending morse, keeping PTT open before closing 72 | 73 | -------------------------------------------------------------------------------- /analog.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | // Calibration values (output in mV by default) 20 | #define VREF 5000 21 | #define RANGE 256 22 | 23 | #define A0_NUM 1 24 | #define A0_DEN 1 25 | #define A0_OFFSET 0 26 | 27 | #define A1_NUM 1 28 | #define A1_DEN 1 29 | #define A1_OFFSET 0 30 | 31 | #define A2_NUM 1 32 | #define A2_DEN 1 33 | #define A2_OFFSET 0 34 | 35 | #define A3_NUM 1 36 | #define A3_DEN 1 37 | #define A3_OFFSET 0 38 | 39 | #define A4_NUM 1 40 | #define A4_DEN 1 41 | #define A4_OFFSET 0 42 | 43 | #define A5_NUM 1 44 | #define A5_DEN 1 45 | #define A5_OFFSET 0 46 | 47 | void analogTask() 48 | { 49 | static bool acquiredInThisCycle = false; 50 | int rawAnalog [6]; 51 | long intermediateVal [6]; 52 | if (millis() % 1000) // Measure every second 53 | { 54 | if (!acquiredInThisCycle) // Acquire measurements only once 55 | { 56 | rawAnalog[0] = analogRead (A0); 57 | rawAnalog[1] = analogRead (A1); 58 | rawAnalog[2] = analogRead (A2); 59 | rawAnalog[3] = analogRead (A3); 60 | rawAnalog[4] = analogRead (A4); 61 | rawAnalog[5] = analogRead (A5); 62 | 63 | // Compute Physical value 64 | // /!\ Keep output within a 16 bits signed range -32768 to 32767 /!\ 65 | // ------------------------------------------------------------------ 66 | 67 | intermediateVal [0] = ((VREF * rawAnalog [0] * A0_NUM) / A0_DEN / RANGE) - A0_OFFSET; 68 | analogValues[0] = (int)intermediateVal [0]; 69 | 70 | intermediateVal [1] = ((VREF * rawAnalog [1] * A1_NUM) / A1_DEN / RANGE) - A1_OFFSET; 71 | analogValues[1] = (int)intermediateVal [1]; 72 | 73 | intermediateVal [2] = ((VREF * rawAnalog [2] * A2_NUM) / A2_DEN / RANGE) - A2_OFFSET; 74 | analogValues[2] = (int)intermediateVal [2]; 75 | 76 | intermediateVal [3] = ((VREF * rawAnalog [3] * A3_NUM) / A3_DEN / RANGE) - A3_OFFSET; 77 | analogValues[3] = (int)intermediateVal [3]; 78 | 79 | intermediateVal [4] = ((VREF * rawAnalog [4] * A4_NUM) / A4_DEN / RANGE) - A4_OFFSET; 80 | analogValues[4] = (int)intermediateVal [4]; 81 | 82 | intermediateVal [5] = ((VREF * rawAnalog [5] * A5_NUM) / A5_DEN / RANGE) - A5_OFFSET; 83 | analogValues[5] = (int)intermediateVal [5]; 84 | 85 | acquiredInThisCycle = true; 86 | } 87 | } 88 | else // Outside the 1 ms window every second, reset the flag 89 | { 90 | acquiredInThisCycle = false; 91 | } 92 | } 93 | 94 | -------------------------------------------------------------------------------- /dtmf.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | #include "timer.h" 20 | 21 | // MT8870 DTMF table 22 | PROGMEM prog_uchar dtmf_table[16] = 23 | {'D','1','2','3','4','5','6','7', 24 | '8','9','0','*','#','A','B','C'}; 25 | 26 | timer_t adminModeExitTimer; 27 | timer_t bufferClearTimer; // Clear buffer after some time 28 | 29 | #define ADMIN_TIMEOUT 10000u 30 | #define BUFFER_CLEAR 1500u 31 | 32 | #define dtmfBufferSz 4 33 | 34 | #define DTMF_ENTER_CODE "A52D" 35 | #define DTMF_PASS "1234" 36 | 37 | // Messages 38 | #define AUTHMSG "PASS" 39 | #define OKMSG "OK" 40 | #define NOKMSG "ERR" 41 | #define EXITMSG "EXIT" 42 | #define PERMMSG "PERM" 43 | 44 | // Command dispatcher return values 45 | #define RET_CMD_OK 0 46 | #define RET_CMD_FAIL 1 47 | #define RET_CMD_PERM 2 48 | #define RET_CMD_NOTEXIST 3 49 | 50 | String dtmfString = " "; 51 | bool prevStrobe = false; 52 | uchar dtmfStrIndex; 53 | 54 | // Structure containing all the possible commands 55 | typedef struct 56 | { 57 | String commandStr; // 4 Digits command string 58 | bool priviledged; // Checks for authentication for this function 59 | void (*runFunction)(int); // Call function when OK 60 | int param0; // First parameter 61 | } 62 | commandEntry_t; 63 | 64 | commandEntry_t commandList[] = 65 | // CODE PERMISSION REQUIRED FUNCTION NAME PARAMETER 66 | { 67 | {"0000", true, &adminDisableAll, 0 }, 68 | {"1000", true, &adminEnableAll, 0 }, 69 | {"2000", true, &adminColdReset, 0 }, 70 | {"####", true, &adminExitMode, 0 }, 71 | {"A000", false, &adminGetAnalogValue, 0 }, 72 | {"A001", false, &adminGetAnalogValue, 1 }, 73 | {"A002", false, &adminGetAnalogValue, 2 }, 74 | {"A003", false, &adminGetAnalogValue, 3 }, 75 | {"A004", false, &adminGetAnalogValue, 4 }, 76 | {"A005", false, &adminGetAnalogValue, 5 }, 77 | }; 78 | 79 | #define COMMAND_COUNT (int)(sizeof(commandList)/sizeof(commandList[0])) 80 | 81 | void dtmfCaptureTask() 82 | { 83 | uchar dtmfIn; 84 | uchar dtmfChar; 85 | if ((!prevStrobe) && digitalRead(PIN_8870_STB)) // If rising edge on 8870 strobe 86 | { 87 | dtmfIn = (digitalRead(PIN_8870_D0) | (digitalRead(PIN_8870_D1) << 1) | 88 | (digitalRead(PIN_8870_D2) << 2) | (digitalRead(PIN_8870_D3) << 3)); // Generate Input 89 | dtmfChar = pgm_read_byte_near (dtmf_table + dtmfIn); 90 | debugPrint (String("Got DTMF ")+(char)dtmfChar); 91 | dtmfString[dtmfStrIndex] = dtmfChar; 92 | dtmfStrIndex = (dtmfStrIndex+1) % dtmfBufferSz; 93 | if (dtmfStrIndex == 0) // If we got 4 chars, interpret it 94 | { 95 | debugPrint ("Analyzing DTMF code " + dtmfString); 96 | interpretDTMF(); 97 | } 98 | UpdateTimer(adminModeExitTimer, ADMIN_TIMEOUT); 99 | UpdateTimer(bufferClearTimer, BUFFER_CLEAR); 100 | } 101 | 102 | // After some time, clear the input buffer 103 | if (dtmfStrIndex != 0 && TimerElapsed(bufferClearTimer)) 104 | { 105 | debugPrint ("Clear DTMF buffer"); 106 | dtmfString = " "; 107 | dtmfStrIndex = 0; 108 | } 109 | 110 | // Exit Admin mode some time after the last command 111 | if (adminState != ADMIN_IDLE && TimerElapsed(adminModeExitTimer)) 112 | { 113 | adminExitMode(0); 114 | } 115 | 116 | prevStrobe = digitalRead(PIN_8870_STB); 117 | } 118 | 119 | // Interpret function and administration FSM 120 | void interpretDTMF() 121 | { 122 | UpdateTimer(adminModeExitTimer, ADMIN_TIMEOUT); // Update Admin mode exit timer every time a new word is received 123 | switch (adminState) 124 | { 125 | case ADMIN_IDLE: // Enter privileged mode 126 | if (dtmfString == DTMF_ENTER_CODE) 127 | { 128 | adminState = ADMIN_AUTH; 129 | sendMorse (AUTHMSG, MORSE_FREQ); 130 | } 131 | else // Use unprivileged commands 132 | { 133 | if (ECHOLINK_MODE && State != REPEATER_OPEN) // Do not interpret commands when repeater is opened 134 | getCommands(); 135 | } 136 | break; 137 | 138 | case ADMIN_AUTH: // Get credentials 139 | if (dtmfString == DTMF_PASS) 140 | { 141 | adminState = ADMIN_CMD; 142 | sendMorse (OKMSG, MORSE_FREQ); 143 | } 144 | else 145 | { 146 | adminState = ADMIN_IDLE; 147 | sendMorse(PERMMSG, MORSE_FREQ); 148 | } 149 | break; 150 | 151 | case ADMIN_CMD: // Privileged mode 152 | getCommands(); 153 | break; 154 | } 155 | } 156 | 157 | // Get commands from command list 158 | void getCommands() 159 | { 160 | char retVal = RET_CMD_NOTEXIST; 161 | int i; 162 | for (i = 0; i < COMMAND_COUNT; i++) 163 | { 164 | if (commandList[i].commandStr == dtmfString) // Check for input command 165 | { 166 | debugPrint ("Found match for "+dtmfString); 167 | if (commandList[i].priviledged) 168 | { 169 | if (adminState == ADMIN_CMD) // Check for permissions 170 | { // Return OK, run function, function need to send whatever it wants in morse 171 | debugPrint ("Permission granted for "+dtmfString); 172 | retVal = RET_CMD_OK; 173 | } 174 | else // Permission denied, go to admin mode first 175 | { 176 | debugPrint ("Permission denied for "+dtmfString); 177 | sendMorse (PERMMSG, MORSE_FREQ); 178 | retVal = RET_CMD_PERM; 179 | } 180 | } 181 | else // No permission required 182 | { // Return OK, run function, function need to send whatever it wants in morse 183 | debugPrint ("No permission required for "+dtmfString); 184 | retVal = RET_CMD_OK; 185 | } 186 | break; 187 | } 188 | } 189 | 190 | if (retVal == RET_CMD_OK) // Action for OK commands 191 | { 192 | if (commandList[i].runFunction) // If not NULL, run actual function 193 | commandList[i].runFunction(commandList[i].param0); 194 | } 195 | 196 | if (retVal == RET_CMD_NOTEXIST) // Action for Not existing commands 197 | { 198 | debugPrint ("No match found for "+dtmfString); 199 | sendMorse (NOKMSG, MORSE_FREQ); 200 | } 201 | } 202 | 203 | ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// 204 | // Functions to be executed upon DTMF command 205 | // prototype is void function (int); 206 | // Each function has to send the morse feedback itself 207 | // DO NOT INLINE 208 | 209 | // Enable all (Beacon when opened, close, repeater itself) 210 | void adminEnableAll(int param0) 211 | { 212 | Configuration.onBeaconEnabled = true; 213 | Configuration.offBeaconEnabled = true; 214 | Configuration.repeaterEnabled = true; 215 | sendMorse ("OK QRV", MORSE_FREQ); 216 | } 217 | 218 | // Disable all (Beacon when opened, close, repeater itself) 219 | void adminDisableAll(int param0) 220 | { 221 | Configuration.onBeaconEnabled = false; 222 | Configuration.offBeaconEnabled = false; 223 | Configuration.repeaterEnabled = false; 224 | sendMorse ("OK QRT", MORSE_FREQ); 225 | } 226 | 227 | // Action to do on admin mode exit 228 | void adminExitMode(int param0) 229 | { 230 | sendMorse ("EXIT", MORSE_FREQ); 231 | adminState = ADMIN_IDLE; 232 | } 233 | 234 | // Get analogValue 235 | void adminGetAnalogValue(int param0) 236 | { // Array index will always be in range 237 | sendMorse ("OK "+String(analogValues[param0]), MORSE_FREQ); 238 | } 239 | 240 | // Do a cold reset 241 | void adminColdReset(int param0) 242 | { 243 | volatile int i; // Use this variable to ensure that compiler will never optimize the loop away 244 | wdt_reset(); 245 | wdt_enable(WDTO_250MS); 246 | while(1) { i++; } 247 | } 248 | 249 | -------------------------------------------------------------------------------- /morse.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | #include "timer.h" 20 | 21 | timer_t morseTimer; 22 | 23 | String morseStr; // Pointer to the morse string 24 | int strCounter; // Morse string index 25 | unsigned int morseFreq; 26 | 27 | // Constants 28 | // Thanks to KB8OJH 29 | #define MORSE_NONE 1 30 | PROGMEM prog_uchar morse_ascii[] = { 31 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 32 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 33 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 34 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 35 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 36 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 37 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 38 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 39 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 40 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 41 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 42 | 0x73, MORSE_NONE, 0x55, 0x32, /* , _ . / */ 43 | 0x3F, 0x2F, 0x27, 0x23, /* 0 1 2 3 */ 44 | 0x21, 0x20, 0x30, 0x38, /* 4 5 6 7 */ 45 | 0x3C, 0x37, MORSE_NONE, MORSE_NONE, /* 8 9 _ _ */ 46 | MORSE_NONE, 0x31, MORSE_NONE, 0x4C, /* _ = _ ? */ 47 | MORSE_NONE, 0x05, 0x18, 0x1A, /* _ A B C */ 48 | 0x0C, 0x02, 0x12, 0x0E, /* D E F G */ 49 | 0x10, 0x04, 0x17, 0x0D, /* H I J K */ 50 | 0x14, 0x07, 0x06, 0x0F, /* L M N O */ 51 | 0x16, 0x1D, 0x0A, 0x08, /* P Q R S */ 52 | 0x03, 0x09, 0x11, 0x0B, /* T U V W */ 53 | 0x19, 0x1B, 0x1C, MORSE_NONE, /* X Y Z _ */ 54 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 55 | MORSE_NONE, 0x05, 0x18, 0x1A, /* _ A B C */ 56 | 0x0C, 0x02, 0x12, 0x0E, /* D E F G */ 57 | 0x10, 0x04, 0x17, 0x0D, /* H I J K */ 58 | 0x14, 0x07, 0x06, 0x0F, /* L M N O */ 59 | 0x16, 0x1D, 0x0A, 0x08, /* P Q R S */ 60 | 0x03, 0x09, 0x11, 0x0B, /* T U V W */ 61 | 0x19, 0x1B, 0x1C, MORSE_NONE, /* X Y Z _ */ 62 | MORSE_NONE, MORSE_NONE, MORSE_NONE, MORSE_NONE, 63 | }; 64 | 65 | // Send morse command 66 | void sendMorse (String message, unsigned int freq) 67 | { 68 | if (! morseActive) // If no morse is being sent do it otherwise drop 69 | { 70 | morseActive = true; 71 | morseStr = message; 72 | morseFreq = freq; 73 | strCounter = 0; 74 | debugPrint ("Sending Morse message : "+message); 75 | } 76 | else 77 | { 78 | debugPrint ("Dropped Morse message : "+message); 79 | } 80 | } 81 | 82 | // Morse generation task 83 | void morseGenerator() 84 | { 85 | static bool newChar = true; 86 | static char currentChar = 0; 87 | static char symCounter = 0; 88 | 89 | if (newChar && morseActive) // Find first one 90 | { 91 | currentChar = pgm_read_byte_near(morse_ascii + morseStr[strCounter]); 92 | strCounter++; 93 | if (strCounter >= morseStr.length()+1) // If end of string stop sending 94 | { 95 | morseActive = false; 96 | currentChar = 0; 97 | } 98 | 99 | while (!(currentChar & 0x80) && (symCounter < 8)) // Shift to find first one 100 | { 101 | currentChar <<= 1; 102 | symCounter ++; 103 | } 104 | currentChar <<= 1; // Shift one to get the first element of the morse symbol 105 | symCounter ++; 106 | newChar = false; 107 | } 108 | 109 | if (TimerElapsed(morseTimer) && morseActive) // Generate symbols for every character 110 | { 111 | if (symCounter < 8) 112 | { 113 | if (currentChar & 0x80) // Decode the higher bit 114 | morseDash(); 115 | else 116 | morseDot(); 117 | 118 | currentChar <<= 1; 119 | symCounter ++; 120 | } 121 | else 122 | { 123 | symCounter = 0; 124 | newChar = true; 125 | currentChar = 0x0C; 126 | UpdateTimer(morseTimer,MORSE_LETTER_SPC); 127 | } 128 | } 129 | } 130 | 131 | void morseDash() 132 | { 133 | if (TimerElapsed(morseTimer)) 134 | { 135 | startBeep (morseFreq, MORSE_DASH); 136 | UpdateTimer(morseTimer,MORSE_DASH+MORSE_SYM_SPC); 137 | } 138 | } 139 | 140 | void morseDot() 141 | { 142 | if (TimerElapsed(morseTimer)) 143 | { 144 | startBeep (morseFreq, MORSE_DOT); 145 | UpdateTimer(morseTimer,MORSE_DOT+MORSE_SYM_SPC); 146 | } 147 | } 148 | 149 | -------------------------------------------------------------------------------- /repeater.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include "timer.h" 24 | 25 | //////////////////////////////////////////// 26 | // Static Repeater Configuration 27 | //////////////////////////////////////////// 28 | 29 | // Debug Mode (set to 0 to enable Watchdog) 30 | #define USE_DEBUGMODE 1 31 | 32 | #define DEFAULT_UNO 33 | 34 | // PINS 35 | #ifdef DEFAULT_UNO 36 | #define PIN_1750 10 37 | #define PIN_CTCSS 12 38 | #define PIN_CARRIER 6 39 | #define PIN_PTT 13 40 | // Pins for Audio Mux 41 | #define PIN_AMUX0 8 42 | #define PIN_AMUX1 9 43 | // PIN for MORSE OUTPUT is fixed to 5 for Arduino Leonardo 44 | // PIN for MORSE OUTPUT is fixed to 11 for Arduino Uno 45 | // /!\ WARNING DO NOT USE tone() function as we act directly on TIMERS 46 | 47 | // DTMF decoder 48 | #define PIN_8870_D0 2 49 | #define PIN_8870_D1 3 50 | #define PIN_8870_D2 4 51 | #define PIN_8870_D3 5 52 | #define PIN_8870_STB 7 53 | #endif 54 | 55 | // DELAYS (in ms) 56 | #define INACTIVE_CLOSE 15000 57 | #define RELEASE_BEEP 200 58 | #define ROGER_BEEP_MINIMUM 2000 59 | #define BEEP_LENGTH 100 60 | #define PTT_ON_DELAY 1000 61 | #define PTT_OFF_DELAY 1000 62 | #define CARRIER_1750_DELAY 200 63 | 64 | // DELAYS (in ms) 65 | #define BEACON_DELAY (600UL*1000UL) 66 | #define TIMEOUT_DELAY (600UL*1000UL) 67 | 68 | #define MORSE_WPM 20 69 | 70 | // Morse definitions (do not touch) 71 | #define MORSE_DOT (1200/MORSE_WPM) 72 | #define MORSE_DASH (3*MORSE_DOT) 73 | // Spaces equal Number of dots - 1 74 | #define MORSE_SYM_SPC MORSE_DOT 75 | #define MORSE_LETTER_SPC (2*MORSE_DOT) 76 | #define MORSE_WORD_SPC (5*MORSE_DOT) 77 | 78 | // BEHAVIOUR (set to 1 to enable, 0 to disable) 79 | #define USE_1750_OPEN 1 80 | #define USE_CTCSS_OPEN 1 81 | #define USE_CARRIER_OPEN 0 82 | 83 | #define USE_CTCSS_BUSY 1 84 | #define USE_CARRIER_BUSY 1 85 | #define USE_OPEN_ROGER_BEEP 0 86 | 87 | #define ADMIN_MODE_WHEN_OPENED 1 88 | // Echolink mode enabled the repeater to ignore DTMF codes when opened except ADMIN 89 | #define ECHOLINK_MODE 1 90 | #define CUT_1750 1 91 | 92 | // BEHAVIOUR of the roger beep define only _ONE_ of those or none 93 | #define ROGER_TONE 94 | //#define ROGER_K 95 | //#define ROGER_SMETER 96 | 97 | // BEEP Frequencies (in tens of Hertz) 98 | #define BEEP_FREQ 8000 99 | #define MORSE_FREQ 6500 100 | // CTCSS Value (in tens of Hertz, please refer to CTCSS table http://en.wikipedia.org/wiki/Continuous_Tone-Coded_Squelch_System) 101 | #define TX_CTCSS_ENABLE 1 102 | #define CTCSS_FREQ 1072 103 | 104 | #define CPU_FREQ 16000000UL 105 | 106 | // Define Test Pin (test millis() reference on PIN 12 500 Hz signal) 107 | //#define TEST_ENABLE 108 | #define TEST_PIN 12 109 | 110 | // Messages 111 | #define POWER_ON_MSG "ON4SEB QRV" 112 | #define OPENMSG "ON4SEB" 113 | #define CLOSEMSG "ON4SEB SK" 114 | #define KMSG "K" 115 | #define BEACONMSG "ON4SEB" 116 | #define TIMEOUTMSG "TOT" 117 | 118 | // System Defines (DO NOT TOUCH) 119 | enum State_t { 120 | REPEATER_CLOSED, // Repeater IDLE 121 | REPEATER_OPEN, // Repeater working 122 | REPEATER_ID, // Repeater identifying when IDLE 123 | REPEATER_OPENING, // Repeater sending morse opening message 124 | REPEATER_CLOSING, // Repeater sending morse closing message 125 | REPEATER_PTTON, // Wait before opening 126 | REPEATER_PTTOFF // Wait after closing 127 | }; 128 | 129 | enum adminState_t {ADMIN_IDLE, ADMIN_AUTH, ADMIN_CMD}; 130 | adminState_t adminState = ADMIN_IDLE; 131 | 132 | // Type definitions 133 | typedef unsigned char uchar; 134 | typedef unsigned long ulong; 135 | struct Config_t 136 | { 137 | bool onBeaconEnabled; 138 | bool offBeaconEnabled; 139 | bool rogerBeepEnabled; 140 | bool repeaterEnabled; 141 | }; 142 | 143 | struct Config_t Configuration; 144 | 145 | ///////////////////////////////////////////// 146 | // Setup phase 147 | ///////////////////////////////////////////// 148 | void setup() 149 | { 150 | ioSetup(); 151 | setupTimer(); 152 | repeaterSetup(); 153 | Serial.begin(115200); 154 | #if (!USE_DEBUGMODE) 155 | wdt_enable (WDTO_8S); // Enable watchdog 156 | #endif 157 | } 158 | 159 | void ioSetup() 160 | { 161 | // Configure Pins properly 162 | pinMode (PIN_1750, INPUT); 163 | pinMode (PIN_CTCSS, INPUT); 164 | pinMode (PIN_CARRIER, INPUT); 165 | pinMode (PIN_PTT, OUTPUT); 166 | pinMode (PIN_AMUX0, OUTPUT); 167 | pinMode (PIN_AMUX1, OUTPUT); 168 | 169 | // Set it low by default 170 | digitalWrite(PIN_PTT, LOW); 171 | digitalWrite(PIN_AMUX0, LOW); 172 | digitalWrite(PIN_AMUX1, LOW); 173 | } 174 | 175 | void repeaterSetup() 176 | { 177 | Configuration.onBeaconEnabled = true; 178 | Configuration.offBeaconEnabled = true; 179 | Configuration.rogerBeepEnabled = true; 180 | Configuration.repeaterEnabled = true; 181 | } 182 | 183 | void debugPrint (String msg) 184 | { 185 | #if (USE_DEBUGMODE) 186 | Serial.print (String(millis())); 187 | Serial.println (" "+msg); 188 | #endif 189 | } 190 | 191 | ///////////////////////////////////////////// 192 | // Main loop 193 | ///////////////////////////////////////////// 194 | State_t State = REPEATER_CLOSED; 195 | State_t nextState = REPEATER_CLOSED; // State after PTT ON delay 196 | 197 | // Timers 198 | timer_t closeTimer; 199 | timer_t rogerBeepTimer; 200 | timer_t rogerBeepMinumumTimer; // Minumum time before triggering the roger beep 201 | timer_t beaconTimer; 202 | timer_t timeoutTimer; // Cut too long keydowns 203 | timer_t pttEnableTimer; // PTT enabled to morse 204 | timer_t pttDisableTimer; // End of morse to PTT off 205 | timer_t carrier1750openTimer; // Carrier/1750 length before opening 206 | 207 | bool beepEnabled; // A Roger beep can be sent 208 | bool beepUpdateTimer = true; // Update the minimum keydown counter for roger beep 209 | bool timeOutEnabled; // TimeOut is enabled 210 | bool prevRxActive; // Current Squelch status 211 | bool beepOn = false; // Beep is currently enabled 212 | bool morseActive = false; // currently sending morse 213 | bool firstIdentification = true; // First time the CPU 214 | 215 | String cwMessage; // Message to send when off 216 | unsigned int cwFreq; 217 | 218 | // Analog measurements 219 | int analogValues [6]; 220 | 221 | void loop() 222 | { 223 | updateIO(); // Control PTT 224 | setRepeaterState(); 225 | morseGenerator(); // Morse generator task 226 | beaconTask(); 227 | dtmfCaptureTask(); 228 | analogTask(); 229 | updateBeep(); // Start/Stop the beep when timer elapsed 230 | #if defined(TEST_ENABLE) 231 | testTask(); 232 | #endif 233 | #if (!USE_DEBUGMODE) 234 | wdt_reset(); // reset 8s watchdog 235 | #else 236 | if (millis() % 60000 == 0) 237 | debugPrint ("Timestamp"); 238 | #endif 239 | 240 | } 241 | 242 | void setRepeaterState() 243 | { 244 | switch (State) 245 | { 246 | // ----------- REPEATER IS IDLE ---------------- 247 | case REPEATER_CLOSED: 248 | // Open Repeater 249 | if (openRequest()) 250 | { 251 | if (TimerElapsed(carrier1750openTimer)) 252 | { 253 | UpdateTimer(closeTimer,INACTIVE_CLOSE); 254 | State = REPEATER_PTTON; 255 | nextState = REPEATER_OPENING; 256 | UpdateTimer(pttEnableTimer, PTT_ON_DELAY); 257 | debugPrint ("Opening"); 258 | } 259 | } 260 | else 261 | { // When no opening request is done, update timer 262 | UpdateTimer(carrier1750openTimer, CARRIER_1750_DELAY); 263 | } 264 | 265 | break; 266 | 267 | // ----------- REPEATER IS OPENED ---------------- 268 | case REPEATER_OPEN: 269 | // Keep repeater open as long there is some input 270 | if (rxActive()) 271 | { 272 | UpdateTimer(closeTimer, INACTIVE_CLOSE); // Repeater closing timer 273 | UpdateTimer(rogerBeepTimer,RELEASE_BEEP); // Roger beep start timer 274 | timeOutEnabled = true; 275 | } 276 | else 277 | { 278 | UpdateTimer(timeoutTimer, TIMEOUT_DELAY); // Update only when PTT is released 279 | timeOutEnabled = false; 280 | } 281 | 282 | if (!prevRxActive && rxActive()) // On squelch opening, rising edge 283 | { 284 | if (beepUpdateTimer) 285 | UpdateTimer(rogerBeepMinumumTimer,ROGER_BEEP_MINIMUM); // Count Minimum time to trigger roger beep 286 | } 287 | 288 | if (prevRxActive && !rxActive()) // If the Squelch was previously opened, falling edge 289 | { 290 | beepUpdateTimer = false; // Do not reload roger beep timer on a falling edge (flutter protection) 291 | if (TimerElapsed(rogerBeepMinumumTimer)) // Enable roger beep after some time only 292 | { 293 | beepEnabled = true; 294 | } 295 | } 296 | 297 | prevRxActive = rxActive(); 298 | 299 | // Set timeout after a known time 300 | if (TimerElapsed(closeTimer) 301 | || (ADMIN_MODE_WHEN_OPENED && adminState == ADMIN_AUTH)) // Close repeater when entering in admin mode 302 | { 303 | debugPrint ("Closing"); 304 | sendMorse (CLOSEMSG, MORSE_FREQ); 305 | State = REPEATER_CLOSING; 306 | UpdateTimer(beaconTimer,BEACON_DELAY); // Force Identification BEACON_DELAY time after closing 307 | } 308 | 309 | // If the PTT is hold for too long, close the repeater 310 | if (timeOutEnabled && TimerElapsed(timeoutTimer)) 311 | { 312 | debugPrint ("Timeout"); 313 | sendMorse (TIMEOUTMSG, MORSE_FREQ); 314 | State = REPEATER_CLOSING; 315 | UpdateTimer(beaconTimer,BEACON_DELAY); // Force Identification BEACON_DELAY time after timeout 316 | timeOutEnabled = false; 317 | } 318 | 319 | // Roger Beep 320 | if (TimerElapsed(rogerBeepTimer)) // PTT Release time to roger beep 321 | { 322 | beepUpdateTimer = true; 323 | if (beepEnabled) 324 | { 325 | debugPrint ("Beep"); 326 | beepEnabled = false; 327 | rogerBeep(); 328 | } 329 | } 330 | 331 | break; 332 | 333 | // --------------- REPEATER SENDING MORSE WHILE OPENING ------- 334 | case REPEATER_OPENING: // Wait with PTT on till there is no morse to send 335 | static bool openSent = false; 336 | 337 | if (!openSent) // Send ID only once 338 | { 339 | sendMorse (OPENMSG, MORSE_FREQ); 340 | openSent = true; 341 | enableCTCSS(true); // Enable CTCSS at opening 342 | } 343 | 344 | if (!morseActive) 345 | { 346 | openSent = false; 347 | State = REPEATER_OPEN; 348 | if (USE_OPEN_ROGER_BEEP) 349 | rogerBeep(); // Send a roger beep once opened 350 | } 351 | 352 | UpdateTimer(timeoutTimer, TIMEOUT_DELAY); // Update timer when opening 353 | UpdateTimer(closeTimer, INACTIVE_CLOSE); // Repeater closing timer 354 | UpdateTimer(rogerBeepTimer,RELEASE_BEEP); // Roger beep start timer 355 | beepEnabled = false; // Disable roger beep on opening 356 | 357 | break; 358 | 359 | // --------------- REPEATER SENDING MORSE WHILE OPENED ------- 360 | case REPEATER_CLOSING: // Wait with PTT on till there is no more morse to send 361 | if (!morseActive) 362 | { 363 | enableCTCSS(false); // Disable CTCSS when closing 364 | State = REPEATER_PTTOFF; 365 | UpdateTimer(pttDisableTimer, PTT_OFF_DELAY); 366 | } 367 | 368 | break; 369 | 370 | // --------------- REPEATER SENDING MORSE WHILE CLOSED ------- 371 | case REPEATER_ID: // Wait with PTT on till there is no morse to send 372 | static bool idSent = false; 373 | 374 | if (!idSent) // Send ID only once 375 | { 376 | sendMorse (cwMessage, cwFreq); 377 | idSent = true; 378 | } 379 | 380 | if (!morseActive) 381 | { 382 | idSent = false; 383 | State = REPEATER_PTTOFF; 384 | UpdateTimer(pttDisableTimer, PTT_OFF_DELAY); 385 | } 386 | 387 | break; 388 | 389 | // --------------- REPEATER ON BEFORE MORSE ------- 390 | case REPEATER_PTTON: // PTT on before sending morse 391 | 392 | if (TimerElapsed(pttEnableTimer)) 393 | { 394 | State = nextState; 395 | } 396 | 397 | break; 398 | 399 | // --------------- REPEATER OFF AFTER MORSE ------- 400 | case REPEATER_PTTOFF: // PTT on after sending morse 401 | 402 | if (TimerElapsed(pttDisableTimer)) 403 | { 404 | State = REPEATER_CLOSED; 405 | } 406 | 407 | break; 408 | 409 | } 410 | } 411 | 412 | // Generation of the Roger beep 413 | void rogerBeep() 414 | { 415 | if (Configuration.rogerBeepEnabled) 416 | { 417 | #ifdef ROGER_TONE 418 | if (!morseActive) 419 | startBeep (BEEP_FREQ, BEEP_LENGTH); 420 | #endif 421 | 422 | #ifdef ROGER_K 423 | sendMorse(KMSG, BEEP_FREQ); 424 | #endif 425 | 426 | #ifdef ROGER_SMETER 427 | // TODO: Attach a Smeter measurement to this 428 | sendMorse("9", BEEP_FREQ); 429 | #endif 430 | } 431 | } 432 | 433 | // Beacon task 434 | void beaconTask() 435 | { 436 | if (TimerElapsed(beaconTimer)) 437 | { 438 | if (State == REPEATER_CLOSED && Configuration.offBeaconEnabled) 439 | { 440 | if (firstIdentification) // Power on identification message 441 | { 442 | sendClosedMorse (POWER_ON_MSG, MORSE_FREQ); 443 | firstIdentification = false; 444 | } 445 | else 446 | { 447 | sendClosedMorse (BEACONMSG, MORSE_FREQ); 448 | } 449 | 450 | debugPrint ("Beacon closed"); 451 | UpdateTimer(beaconTimer, BEACON_DELAY); 452 | } 453 | else if (State == REPEATER_OPEN && (!morseActive) && (!beepEnabled) && (!rxActive()) && Configuration.onBeaconEnabled) 454 | { 455 | sendMorse (BEACONMSG, MORSE_FREQ); 456 | debugPrint ("Beacon open"); 457 | UpdateTimer(beaconTimer, BEACON_DELAY); // Update timer here to ensure that it will be retransmitted when rx is not active 458 | } 459 | } 460 | } 461 | 462 | // Control IO Pins 463 | void updateIO() 464 | { 465 | // Set the PTT control depending on repeater state 466 | if (State != REPEATER_CLOSED || morseActive) 467 | digitalWrite(PIN_PTT, HIGH); 468 | else 469 | digitalWrite(PIN_PTT, LOW); 470 | 471 | // Control the Audio Mux depending on repeater state 472 | if (State != REPEATER_OPEN) 473 | { 474 | // Use CW input 475 | digitalWrite(PIN_AMUX0, HIGH); 476 | digitalWrite(PIN_AMUX1, LOW); 477 | } 478 | else 479 | { 480 | if (morseActive || beepOn || adminState != ADMIN_IDLE || !rxActive() || (CUT_1750 && digitalRead(PIN_1750))) // If no beep, morse or DTMF is present 481 | { 482 | // Use CW input 483 | digitalWrite(PIN_AMUX0, HIGH); 484 | digitalWrite(PIN_AMUX1, LOW); 485 | } 486 | else 487 | { 488 | // Use Audio Input 489 | digitalWrite(PIN_AMUX0, HIGH); 490 | digitalWrite(PIN_AMUX1, HIGH); 491 | } 492 | } 493 | } 494 | 495 | // Check if opening is requested 496 | bool openRequest() 497 | { 498 | return (((USE_1750_OPEN && digitalRead(PIN_1750)) 499 | || (USE_CTCSS_OPEN && digitalRead(PIN_CTCSS)) 500 | || (USE_CARRIER_OPEN && digitalRead(PIN_CARRIER))) 501 | && Configuration.repeaterEnabled 502 | && adminState == ADMIN_IDLE); // Do not open repeater when in admin mode 503 | } 504 | 505 | // Check if RX channel is active 506 | bool rxActive() 507 | { 508 | return ((USE_CTCSS_BUSY && digitalRead(PIN_CTCSS)) 509 | || (USE_CARRIER_BUSY && digitalRead(PIN_CARRIER))); 510 | } 511 | 512 | // Send Morse when closed with PTT control 513 | void sendClosedMorse(String msg, unsigned int freq) 514 | { 515 | nextState = REPEATER_ID; 516 | State = REPEATER_PTTON; 517 | UpdateTimer(pttEnableTimer, PTT_ON_DELAY); 518 | cwMessage = msg; 519 | cwFreq = freq; 520 | } 521 | 522 | #if defined(TEST_ENABLE) 523 | void testTask() 524 | { 525 | pinMode (TEST_PIN, OUTPUT); 526 | digitalWrite (TEST_PIN, millis() & 1); 527 | } 528 | #endif 529 | 530 | -------------------------------------------------------------------------------- /timer.h: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | #ifndef __TIMER_H__ 20 | #define __TIMER_H__ 21 | #include "Arduino.h" 22 | 23 | typedef struct 24 | { 25 | unsigned long value; 26 | bool ovf; 27 | } timer_t; 28 | 29 | inline void UpdateTimer(timer_t& tname, unsigned long tval) 30 | { 31 | tname.value = millis() + tval; 32 | if (tname.value <= millis()) // Check if overflow occurs 33 | tname.ovf = true; 34 | else 35 | tname.ovf = false; 36 | } 37 | 38 | inline bool TimerElapsed(timer_t& tname) 39 | { 40 | static unsigned long prevMillis; 41 | if (millis() < prevMillis) // detect rollover condition 42 | tname.ovf = false; 43 | prevMillis = millis(); 44 | return !tname.ovf && (millis() >= tname.value); 45 | } 46 | 47 | #endif 48 | -------------------------------------------------------------------------------- /tone.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Ham radio repeater controller 3 | Copyright (C) 2012 Sebastien Van Cauwenberghe ON4SEB 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | // Dependant on the arduino model we are using 20 | 21 | #include "timer.h" 22 | // Shift right of the CTCSS output value to attenuate output (increases distortion) 23 | #define CTCSS_ATT 1 24 | 25 | // Timers 26 | timer_t beepToneTimer; 27 | 28 | ulong ddsToneTuningWord; // DDS tuning word 29 | ulong ddsTonePhaseAccu; // DDS Phase accumulator 30 | 31 | ulong ddsCTCSSTuningWord; // DDS tuning word 32 | ulong ddsCTCSSPhaseAccu; // DDS Phase accumulator 33 | 34 | bool ctcssEnabled = false; // CTCSS is enabled 35 | 36 | // Sine wave table 37 | PROGMEM prog_uchar sine[] = { 38 | 127,130,133,136,139,143,146,149,152,155,158,161,164,167,170,173, 39 | 176,178,181,184,187,190,192,195,198,200,203,205,208,210,212,215, 40 | 217,219,221,223,225,227,229,231,233,234,236,238,239,240,242,243, 41 | 244,245,247,248,249,249,250,251,252,252,253,253,253,254,254,254, 42 | 254,254,254,254,253,253,253,252,252,251,250,249,249,248,247,245, 43 | 244,243,242,240,239,238,236,234,233,231,229,227,225,223,221,219, 44 | 217,215,212,210,208,205,203,200,198,195,192,190,187,184,181,178, 45 | 176,173,170,167,164,161,158,155,152,149,146,143,139,136,133,130, 46 | 127,124,121,118,115,111,108,105,102,99,96,93,90,87,84,81,78,76, 47 | 73,70,67,64,62,59,56,54,51,49,46,44,42,39,37,35,33,31,29,27,25, 48 | 23,21,20,18,16,15,14,12,11,10,9,7,6,5,5,4,3,2,2,1,1,1,0,0,0,0, 49 | 0,0,0,1,1,1,2,2,3,4,5,5,6,7,9,10,11,12,14,15,16,18,20,21,23,25, 50 | 27,29,31,33,35,37,39,42,44,46,49,51,54,56,59,62,64,67,70,73,76, 51 | 78,81,84,87,90,93,96,99,102,105,108,111,115,118,121,124 52 | }; 53 | 54 | // Configure timer for morse PWM 55 | void setupTimer() 56 | { 57 | // Arduino Leonardo 58 | #if defined(__AVR_ATmega32U4__) 59 | TCCR3A = (1 << WGM30); // Enable Fast PWM mode 60 | TCCR3B = (1 << WGM32) | (1 << CS30); // Prescaler = 1 61 | DDRC |= (1 << DDC6); // Pin 6 as output 62 | // Arduino Uno 63 | #else 64 | TCCR2A = (1 << WGM21) | (1 << WGM20); // Enable Fast PWM mode 65 | TCCR2B = (1 << CS20); // Prescaler = 1 66 | DDRB |= (1 << DDB3); // Pin 3 as output 67 | #endif 68 | } 69 | 70 | void enableCTCSS(bool value) 71 | { 72 | #if (TX_CTCSS_ENABLE) 73 | ctcssEnabled=value; 74 | ddsCTCSSTuningWord = ((4294967295UL / (CPU_FREQ/256)) * CTCSS_FREQ)/10; 75 | #endif 76 | } 77 | 78 | // Do a beep for a known time 79 | void startBeep(unsigned int freq, unsigned long duration) 80 | { 81 | ddsToneTuningWord = ((4294967295UL / (CPU_FREQ/256)) * freq)/10; 82 | if (!beepOn) 83 | { 84 | UpdateTimer(beepToneTimer,duration); 85 | beepOn = true; 86 | } 87 | } 88 | 89 | // Check that the beep time is elapsed and stop it if needed 90 | // CALLED only once in updateIO 91 | void updateBeep() 92 | { 93 | if (beepOn || ctcssEnabled) // When Beep is enabled 94 | { 95 | // Start Timer 96 | // Arduino Leonardo 97 | #if defined(__AVR_ATmega32U4__) 98 | TCCR3A |= (1 << COM3A1); // Enable comparator output 99 | TIMSK3 |= (1 << TOIE3); // Enable Timer interrupt 100 | // Arduino Uno 101 | #else 102 | TCCR2A |= (1 << COM2A1); // Enable comparator output 103 | TIMSK2 |= (1 << TOIE2); // Enable Timer interrupt 104 | #endif 105 | } 106 | else // When nothing is enabled 107 | { 108 | // Arduino Leonardo 109 | #if defined(__AVR_ATmega32U4__) 110 | TCCR3A &= ~(1 << COM3A1); // Disable comparator output 111 | TIMSK3 &= ~(1 << TOIE3); // Disable Timer interrupt 112 | // Arduino Uno 113 | #else 114 | TCCR2A &= ~(1 << COM2A1); // Disable comparator output 115 | TIMSK2 &= ~(1 << TOIE2); // Disable Timer interrupt 116 | #endif 117 | } 118 | 119 | if (TimerElapsed(beepToneTimer)) // When tone must finish 120 | { 121 | beepOn = false; 122 | } 123 | } 124 | 125 | // Tone Generation function 126 | inline unsigned char ddsTone() 127 | { 128 | unsigned char index; // Sample Index 129 | unsigned char value; // Sample Value 130 | value = 0; 131 | if (beepOn) // When using the beep generator 132 | { 133 | ddsTonePhaseAccu += ddsToneTuningWord; 134 | index = ddsTonePhaseAccu >> 24; 135 | value += pgm_read_byte_near(sine + index) >> 1; 136 | } 137 | #if (TX_CTCSS_ENABLE) 138 | if (ctcssEnabled) // CTCSS generation 139 | { 140 | ddsCTCSSPhaseAccu += ddsCTCSSTuningWord; 141 | index = ddsCTCSSPhaseAccu >> 24; 142 | value += pgm_read_byte_near(sine + index) >> CTCSS_ATT; 143 | } 144 | #endif 145 | return value; // Value of the PWM output 146 | } 147 | 148 | // Tone generation DDS timer overflow interrupt 149 | // For Arduino Leonardo 150 | #if defined(__AVR_ATmega32U4__) 151 | ISR(TIMER3_OVF_vect) 152 | { 153 | OCR3A = ddsTone(); // Write Comparator value 154 | } 155 | #endif 156 | 157 | // Tone generation DDS timer overflow interrupt 158 | // For Arduino Uno 159 | #if !defined(__AVR_ATmega32U4__) 160 | ISR(TIMER2_OVF_vect) 161 | { 162 | OCR2A = ddsTone(); // Write Comparator value 163 | } 164 | #endif 165 | 166 | 167 | 168 | --------------------------------------------------------------------------------