├── .gitignore ├── CMakeLists.txt ├── LICENSE ├── ct.cpp ├── ct.hpp ├── decode.cpp ├── ftcom.cpp ├── ftcom.h ├── ftcom.hpp ├── genPlots.cpp ├── plots ├── PowerOn.csv ├── PowerOn.plt ├── RemoteOff.csv ├── RemoteOff.plt ├── RemoteOn.csv ├── RemoteOn.plt └── ct.plt ├── rxGraph.dot ├── testCT.cpp ├── testFTCom.cpp ├── testFTComC.c └── txGraph.dot /.gitignore: -------------------------------------------------------------------------------- 1 | CMakeCache.txt 2 | CMakeDoxyfile.in 3 | CMakeDoxygenDefaults.cmake 4 | CMakeFiles/ 5 | Doxyfile.doxygen 6 | Makefile 7 | cmake_install.cmake 8 | decode 9 | genPlots 10 | testCT 11 | testFTCom 12 | testFTComC 13 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required (VERSION 2.6) 2 | project (libft) 3 | 4 | # Require dot, treat the other components as optional 5 | find_package(Doxygen 6 | REQUIRED dot) 7 | 8 | set(DOXYGEN_DOTFILE_DIRS .) 9 | set(DOXYGEN_EXTRACT_PRIVATE yes) 10 | set(DOXYGEN_HIDE_UNDOC_MEMBERS yes) 11 | 12 | doxygen_add_docs( 13 | doxygen 14 | ${PROJECT_SOURCE_DIR} 15 | ) 16 | 17 | 18 | set(CMAKE_BUILD_TYPE Debug) 19 | 20 | add_executable(genPlots ftcom.cpp genPlots.cpp) 21 | add_executable(testCT ct.cpp ftcom.cpp testCT.cpp) 22 | add_executable(testFTCom ct.cpp ftcom.cpp testFTCom.cpp) 23 | add_executable(decode ftcom.cpp decode.cpp) 24 | 25 | add_executable(testFTComC ftcom.cpp testFTComC.c) 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /ct.cpp: -------------------------------------------------------------------------------- 1 | #include "ct.hpp" 2 | 3 | void CT::setState(const bool on) { 4 | if (on) { 5 | txBuf[0] = 23; 6 | txBuf[1] = 1; 7 | } else { 8 | txBuf[0] = 23; 9 | txBuf[1] = 172; 10 | } 11 | transmit(txBuf, 2); 12 | }; 13 | 14 | void CT::setLevel(uint8_t level) { 15 | txBuf[0] = 35; 16 | txBuf[1] = 1; 17 | txBuf[2] = level; 18 | transmit(txBuf, 3); 19 | }; 20 | -------------------------------------------------------------------------------- /ct.hpp: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #include "ftcom.hpp" 3 | 4 | class CT : public FTCom { 5 | public: 6 | CT(bool(*updatePinTimer)(const uint8_t pinState , const uint8_t cycles), const Role role = SLAVE, const uint8_t rxOF = 1) : FTCom(updatePinTimer, role, rxOF) {}; 7 | void setState(const bool on); 8 | void setLevel(uint8_t level); 9 | private: 10 | uint8_t txBuf[3]; 11 | }; 12 | -------------------------------------------------------------------------------- /decode.cpp: -------------------------------------------------------------------------------- 1 | #include "ftcom.hpp" 2 | 3 | #include 4 | #include 5 | 6 | using namespace std; 7 | 8 | ifstream inFile; 9 | 10 | bool simUpdate(const uint8_t pinState, const uint8_t cycles) { 11 | return true; 12 | } 13 | 14 | int decide(double value, double mean) { 15 | if (value > mean) { 16 | return 1; 17 | } else { 18 | return 0; 19 | } 20 | } 21 | 22 | void printData(FTCom& ftcom, int numBytesReq) { 23 | uint8_t data[numBytesReq]; 24 | if (ftcom.getRxRole() == FTCom::MASTER) { 25 | cout << "Master: "; 26 | } else { 27 | cout << "Slave : "; 28 | } 29 | int numBytes = ftcom.readData(data, numBytesReq); 30 | for (int b = 0; b < numBytes; b++) { 31 | cout << (int) *(data + b) << " "; 32 | } 33 | cout << endl; 34 | } 35 | 36 | int main(int argc, char** argv) { 37 | if (argc <= 1 || argc >= 4) { 38 | cout << "Syntax: " << endl; 39 | cout << "\t" << argv[0] << " file" << endl; 40 | cout << "\t" << argv[0] << " file OF" << endl; 41 | return -1; 42 | } 43 | 44 | int OF = 2; 45 | 46 | if (argc == 3) { 47 | try { 48 | OF = stoi(argv[2]); 49 | } catch (...) { 50 | cout << "Unable to parse OF" << endl; 51 | return -1; 52 | } 53 | } 54 | 55 | inFile.open(argv[1]); 56 | if (!inFile.good()) { 57 | cout << "Unable to read from " << argv[1] << endl; 58 | return -1; 59 | } 60 | 61 | cout << "Reading " << argv[1] << " with OF of " << OF << endl; 62 | 63 | FTCom ftcom(&simUpdate, FTCom::SLAVE, OF); 64 | 65 | double time; 66 | double value; 67 | double mean; 68 | 69 | { 70 | bool firstRound = true; 71 | double minValue; 72 | double maxValue; 73 | while (inFile >> time >> value) { 74 | if (firstRound) { 75 | minValue = value; 76 | maxValue = value; 77 | firstRound = false; 78 | } 79 | if (value > maxValue) { 80 | maxValue = value; 81 | } 82 | if (value < minValue) { 83 | minValue = value; 84 | } 85 | } 86 | inFile.close(); 87 | 88 | mean = minValue + abs(maxValue - minValue) / 2; 89 | 90 | cout << "Max: " << maxValue << " Min: " << minValue << endl; 91 | cout << "Decision level: " << mean << endl; 92 | } 93 | 94 | { 95 | bool firstRound = true; 96 | int lastCnt; 97 | int cnt = 0; 98 | int lastState; 99 | int state; 100 | inFile.open(argv[1]); 101 | while (inFile >> time >> value) { 102 | if (firstRound) { 103 | lastCnt = cnt; 104 | lastState = decide(value, mean); 105 | firstRound = false; 106 | } 107 | state = decide(value, mean); 108 | if (lastState != state) { 109 | int duration = cnt - lastCnt; 110 | int bytesRead = ftcom.nextEdge(duration); 111 | if (bytesRead > 0) { 112 | printData(ftcom, bytesRead); 113 | } 114 | lastState = state; 115 | lastCnt = cnt; 116 | } 117 | cnt++; 118 | } 119 | inFile.close(); 120 | 121 | // Simulate final toggle 122 | int duration = cnt - lastCnt; 123 | int bytesRead = ftcom.nextEdge(duration); 124 | if (bytesRead > 0) { 125 | printData(ftcom, bytesRead); 126 | } 127 | cout << "Errors: " << ftcom.getRxErrors() << endl; 128 | } 129 | } 130 | -------------------------------------------------------------------------------- /ftcom.cpp: -------------------------------------------------------------------------------- 1 | #include "ftcom.hpp" 2 | #include 3 | 4 | using namespace std; 5 | 6 | extern "C" { 7 | FTCom* newFTCom(bool (*updatePinTimer)(const uint8_t pinState, const uint8_t duration)) { 8 | return new FTCom(updatePinTimer); 9 | } 10 | 11 | void deleteFTCom(FTCom* ftcom) { 12 | delete ftcom; 13 | } 14 | 15 | 16 | void FTCom_timeElapsed(FTCom* ftcom) { 17 | ftcom->timeElapsed(); 18 | } 19 | 20 | bool FTCom_transmit(FTCom* ftcom, const uint8_t* data, const uint8_t numBytes) { 21 | return ftcom->transmit(data, numBytes); 22 | } 23 | 24 | void FTCom_setTxRole(FTCom* ftcom, uint8_t role) { 25 | ftcom->setTxRole((FTCom::Role) role); 26 | } 27 | 28 | uint8_t FTCom_getState(FTCom* ftcom) { 29 | return ftcom->getState(); 30 | } 31 | 32 | uint8_t FTCom_getMaxNumBytes(FTCom* ftcom) { 33 | return ftcom->maxNumBytes; 34 | } 35 | 36 | } 37 | 38 | 39 | FTCom::FTCom(bool(*updatePinTimerIn)(uint8_t , uint8_t), const Role txRoleIn, const uint8_t rxOFIn) { 40 | /*** Tx ***/ 41 | txRole = txRoleIn; 42 | updatePinTimer = updatePinTimerIn; 43 | txState = WAIT_DATA; 44 | txBuffer = new uint8_t[maxNumBytes]; 45 | 46 | /*** Rx ***/ 47 | rxBuffer = new uint8_t[maxNumBytes]; 48 | rxState = START_0; 49 | rxOF = rxOFIn; 50 | rxErr = 0; 51 | } 52 | 53 | FTCom::~FTCom() { 54 | delete[] txBuffer; 55 | delete[] rxBuffer; 56 | } 57 | 58 | void FTCom::setTxRole(Role txRoleIn) { 59 | txRole = txRoleIn; 60 | } 61 | 62 | FTCom::Role FTCom::getRxRole() { 63 | return rxRole; 64 | } 65 | 66 | uint16_t FTCom::getRxErrors(const bool clear) { 67 | uint16_t tmp = rxErr; 68 | if (clear) { 69 | rxErr = 0; 70 | } 71 | return tmp; 72 | } 73 | 74 | FTCom::State FTCom::getState() { 75 | if (txState == WAIT_DATA && rxState == START_0) { 76 | return IDLE; 77 | } else if (txState == COLLISION) { 78 | return TX_COLLISION; 79 | } else if (txState == WAIT_DATA) { 80 | return RECEIVING; 81 | } else if (rxState == START_0) { 82 | return TRANSMITTING; 83 | } 84 | return INVALID_STATE; 85 | } 86 | 87 | bool FTCom::transmit(const uint8_t* txBufferIn, const uint8_t numBytes) { 88 | if ((getState() == IDLE) && (numBytes <= maxNumBytes)) { 89 | txNumBits = numBytes * 8; 90 | for (int b = 0; b < numBytes; b++) { 91 | txBuffer[b] = txBufferIn[b]; 92 | } 93 | txState = START_0; 94 | txBitIdx = 0; 95 | timeElapsed(); 96 | return true; 97 | } 98 | return false; 99 | } 100 | 101 | bool FTCom::checkPuls(const uint16_t realIn, const uint8_t expected, const bool allowLarger) { 102 | uint8_t real = round((double) realIn / (double) rxOF); 103 | if (expected - 1 <= real && (expected + 1 >= real || allowLarger)) { 104 | return true; 105 | } 106 | return false; 107 | } 108 | 109 | int8_t FTCom::readData(uint8_t* dataOut, const uint8_t bufferLen) { 110 | if (rxState == WAIT_DATA) { 111 | uint8_t numBytes = rxBitIdx / 8; 112 | if (numBytes > 0) { 113 | if (numBytes <= bufferLen) { 114 | for (int byteIdx = 0; byteIdx < numBytes; byteIdx++) { 115 | *(dataOut + byteIdx) = rxBuffer[byteIdx]; 116 | } 117 | rxState = START_0; 118 | return numBytes; 119 | } else { 120 | return -1; 121 | } 122 | } 123 | } 124 | return 0; 125 | } 126 | 127 | void FTCom::zerroRxBuffer() { 128 | for (int b = 0; b < maxNumBytes; b++) { 129 | *(rxBuffer + b) = 0; 130 | } 131 | } 132 | 133 | int8_t FTCom::nextEdge(const uint16_t duration) { 134 | if (txState != WAIT_DATA) { 135 | return -1; 136 | } 137 | 138 | switch (rxState) { 139 | case START_0: 140 | if (checkPuls(duration, 8)) { // <11111111> 141 | rxState = START_1; 142 | rxLastBit = 0; 143 | rxBitIdx = 0; 144 | zerroRxBuffer(); 145 | } else { 146 | rxErr++; 147 | } 148 | break; 149 | case START_1: 150 | if (checkPuls(duration, 4)) { // 11111111<0000>1.... 151 | rxState = START_2; 152 | rxRole = SLAVE; 153 | } else if (checkPuls(duration, 9)) { //11111111<000000000>1... 154 | rxState = START_2; 155 | rxRole = MASTER; 156 | } else { 157 | rxErr++; 158 | rxState = START_0; 159 | } 160 | break; 161 | case START_2: 162 | if (checkPuls(duration, 2)) { // ...0<11>0... state change with end of header 163 | rxState = BIT_HALF; 164 | } else if (checkPuls(duration, 4)) { // ...0<11|11>0... end of header and two bit samples together 165 | setNextBitInv(true); 166 | rxState = BIT_FULL; 167 | } else { 168 | rxErr++; 169 | rxState = START_0; 170 | } 171 | break; 172 | case BIT_HALF: 173 | if (checkPuls(duration, 2)) { 174 | rxState = BIT_FULL; 175 | setNextBitInv(false); 176 | } else { 177 | rxErr++; 178 | rxState = START_0; 179 | } 180 | break; 181 | case BIT_FULL: 182 | if (checkPuls(duration, 2)) { 183 | rxState = BIT_HALF; 184 | } else if (checkPuls(duration, 4)) { 185 | rxState = BIT_FULL; 186 | setNextBitInv(true); 187 | } else if (rxLastBit == 0 && checkPuls(duration, 8) && (rxBitIdx % 8 == 0)) { 188 | rxState = STOP; 189 | } else if (rxLastBit == 1 && checkPuls(duration, 8, true) && (rxBitIdx % 8 == 0)) { 190 | rxState = WAIT_DATA; 191 | return rxBitIdx / 8; 192 | } else { 193 | rxErr++; 194 | rxState = START_0; 195 | } 196 | break; 197 | case STOP: 198 | rxState = WAIT_DATA; 199 | return rxBitIdx / 8; 200 | default: 201 | break; 202 | } 203 | return 0; 204 | } 205 | 206 | bool FTCom::setNextBitInv(const bool invert) { 207 | if (rxBitIdx < maxNumBytes * 8) { 208 | uint8_t curBit = rxLastBit ^ invert; 209 | *(rxBuffer + (rxBitIdx / 8)) |= curBit << rxBitIdx % 8; 210 | rxLastBit = curBit; 211 | rxBitIdx++; 212 | return true; 213 | } 214 | return false; 215 | } 216 | 217 | void FTCom::timeElapsed() { 218 | bool hasNextBit = true; 219 | switch (txState) { 220 | case START_2: 221 | case BIT_FULL: 222 | if (txBitIdx < txNumBits) { 223 | txLastBit = txBit; 224 | txBit = (*(txBuffer+(txBitIdx / 8)) >> (txBitIdx % 8)) & 1; 225 | txBitIdx++; 226 | } else { 227 | hasNextBit = false; 228 | } 229 | break; 230 | default: 231 | break; 232 | } 233 | 234 | switch (txState) { 235 | case WAIT_DATA: 236 | break; 237 | case START_0: 238 | txState = START_1; 239 | if (!updatePinTimer(0, 8)) { 240 | txState = COLLISION; 241 | } 242 | break; 243 | case START_1: 244 | txState = START_2; 245 | if (txRole == MASTER) { 246 | if (!updatePinTimer(1, 9)) { 247 | txState = COLLISION; 248 | } 249 | } else { 250 | if (!updatePinTimer(1, 4)) { 251 | txState = COLLISION; 252 | } 253 | } 254 | break; 255 | case START_2: 256 | if (txBit == 0) { 257 | txState = BIT_HALF; 258 | if (!updatePinTimer(0, 2)) { 259 | txState = COLLISION; 260 | } 261 | } else { 262 | txState = BIT_FULL; 263 | if (!updatePinTimer(0, 4)) { 264 | txState = COLLISION; 265 | } 266 | } 267 | break; 268 | case BIT_HALF: 269 | txState = BIT_FULL; 270 | if (!updatePinTimer(txBit ^ 1, 2)) { 271 | txState = COLLISION; 272 | } 273 | break; 274 | case BIT_FULL: 275 | if (hasNextBit) { 276 | if (txLastBit == txBit) { 277 | txState = BIT_HALF; 278 | if (!updatePinTimer(txBit, 2)) { 279 | txState = COLLISION; 280 | } 281 | } else { 282 | txState = BIT_FULL; 283 | if (!updatePinTimer(txBit ^ 1, 4)) { 284 | txState = COLLISION; 285 | } 286 | } 287 | } else { 288 | if (txBit == 0) { 289 | txState = STOP; 290 | } else { 291 | txState = WAIT_DATA; 292 | } 293 | if (!updatePinTimer(txBit, 8)) { 294 | txState = COLLISION; 295 | } 296 | } 297 | break; 298 | case STOP: 299 | txState = WAIT_DATA; 300 | if (!updatePinTimer(1, 0)) { 301 | txState = COLLISION; 302 | } 303 | break; 304 | default: 305 | break; 306 | } 307 | } 308 | -------------------------------------------------------------------------------- /ftcom.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | #include 5 | #include 6 | 7 | #ifdef __cplusplus 8 | extern "C" { 9 | #endif 10 | 11 | typedef struct FTCom FTCom; 12 | 13 | FTCom* newFTCom(bool (*updatePinTimer)(const uint8_t pinState, const uint8_t duration)); 14 | void deleteFTCom(FTCom* ftcom); 15 | 16 | void FTCom_timeElapsed(FTCom* ftcom); 17 | bool FTCom_transmit(FTCom* ftcom, const uint8_t* data, const uint8_t numBytes); 18 | uint8_t FTCom_getState(FTCom* ftcom); 19 | uint8_t FTCom_getMaxNumBytes(FTCom* ftcom); 20 | void FTCom_setTxRole(FTCom* ftcom, uint8_t role); 21 | 22 | bool (*updatePinTimer)(const uint8_t pinState, const uint8_t duration); 23 | 24 | enum FTComState { FTCOM_IDLE = 0, FTCOM_TRANSMITTING = 1, FTCOM_RECEIVING = 2, FTCOM_TX_COLLISION = 3, FTCOM_INVALID_STATE = 4 }; 25 | enum FTComRole { FTCOM_MASTER = 0, FTCOM_SLAVE = 1 }; 26 | 27 | #ifdef __cplusplus 28 | } 29 | #endif 30 | -------------------------------------------------------------------------------- /ftcom.hpp: -------------------------------------------------------------------------------- 1 | #pragma once 2 | 3 | #include 4 | 5 | /** Implementation of a serial protocol used by the company Festool e. g. for the communication of their vacuum cleaners from the CT series with a bluetooth remote control module. 6 | * Protocol specification, as far as currently known, are given in \"protospec.pdf\" . 7 | * The 4-pin connector on the vacuum cleaner has the following assignment with pin numbering from the top.: 8 | * 1: +5V 9 | * 2: unknown 10 | * 3: Serial IO with a pull-up to 5V by the master device 11 | * 4: GND */ 12 | 13 | class FTCom { 14 | public: 15 | /** State of the transceiver */ 16 | enum State : uint8_t { 17 | /** Ready for transmitting and receiving */ 18 | IDLE = 0, 19 | /** Receiving or waiting for user to read received data */ 20 | TRANSMITTING = 1, 21 | /** Transmitting */ 22 | RECEIVING = 2, 23 | /** Collision detected by user routine updatePinTimer when testing bus before changing its state */ 24 | TX_COLLISION = 3, 25 | /** Better, this never happens */ 26 | INVALID_STATE = 4 27 | }; 28 | 29 | /** Allowed maximum is 32, due to bitIdx variable definition */ 30 | static const uint8_t maxNumBytes = 6; 31 | 32 | enum Role : uint8_t { 33 | /** The device with an internal pull-up e. g. the vacuum cleaner */ 34 | MASTER = 0, 35 | /** Communication partner with open-drain output */ 36 | SLAVE = 1 37 | }; 38 | 39 | ~FTCom(); 40 | 41 | /** Set transmitter role */ 42 | void setTxRole(const Role txRole); 43 | 44 | /** 45 | * \param updatePinTimer is a user-defined funtion for updating the mcu peripherals 46 | * \param role is SLAVE for a device with no internal pull-up like the Festool bluetooth module */ 47 | FTCom(bool(*updatePinTimer)(const uint8_t pinState , const uint8_t duration), Role role = SLAVE, const uint8_t rxOF = 1); 48 | 49 | /** 50 | * To be called by the timer ISR 51 | * \dotfile rxGraph.dot */ 52 | void timeElapsed(); 53 | 54 | /** 55 | * Transmit new data block 56 | * \param data Pointer to input data 57 | * \param numBytes Number of bytes to be read from data 58 | * \return true on success, false if transmit is in progress (data is not accepted) or numBytes exceeds maxNumBytes */ 59 | bool transmit(const uint8_t* data, const uint8_t numBytes); 60 | 61 | /** 62 | * State of transceiver */ 63 | FTCom::State getState(); 64 | 65 | /** 66 | * To be called by client, when edge on serial io pin is detected, e. g. using port interrupt 67 | * \return Number of bytes received (on last edge of receive sequence), 68 | * 0: Receiving in progress, 69 | * -1: Receiving not possible, transmitting in progress 70 | * \dotfile txGraph.dot */ 71 | int8_t nextEdge(const uint16_t duration); 72 | 73 | /** 74 | * Copies received values to data 75 | * \param dataOut Allocated memory block of bufferLen 76 | * \param Size of buffer 77 | * \return Number of bytes received, -1 if buffer is not large enough */ 78 | int8_t readData(uint8_t* dataOut, const uint8_t bufferLen); 79 | 80 | /** 81 | * Get role of received packet 82 | * \return We expect the value to be the opposite of the txRole set. This function is useful when processing bus recordings. */ 83 | Role getRxRole(); 84 | 85 | /** 86 | * Get error counter of receiver unit 87 | * \param clear Reset counter on read */ 88 | uint16_t getRxErrors(const bool clear = false); 89 | 90 | private: 91 | enum TrxState : uint8_t {START_0, START_1, START_2, BIT_HALF, BIT_FULL, STOP, WAIT_DATA, COLLISION}; 92 | 93 | TrxState txState; 94 | Role txRole; 95 | uint8_t txBitIdx; 96 | uint8_t* txBuffer; 97 | uint8_t txNumBits; 98 | uint8_t txBit; 99 | uint8_t txLastBit; 100 | 101 | /** 102 | * \param updatePinTimer is a used-defined function with the following two requirements 103 | * a) Start a timer with given duration value 104 | * b) On timer hit: Update the serial port pin to pinState and call timeElapsed() 105 | * 106 | * \param duration duration * 0.5 ms specifies the time to wait till changing the state of the serial io pin to pinState 107 | * \param pinState is the new state of the serial io pin 108 | * \return true: collision on bus detected 109 | * */ 110 | bool (*updatePinTimer)(const uint8_t pinState, const uint8_t duration); 111 | 112 | TrxState rxState; 113 | Role rxRole; 114 | uint8_t rxBitIdx; 115 | uint8_t* rxBuffer; 116 | uint8_t rxLastBit; 117 | uint16_t rxErr; 118 | uint8_t rxOF; 119 | 120 | bool checkPuls(const uint16_t real, const uint8_t expected, const bool allowLarger = false); 121 | bool setNextBitInv(const bool invert); 122 | void zerroRxBuffer(); 123 | 124 | }; 125 | -------------------------------------------------------------------------------- /genPlots.cpp: -------------------------------------------------------------------------------- 1 | #include "ftcom.hpp" 2 | 3 | #include 4 | #include 5 | 6 | using namespace std; 7 | 8 | int cyclesAcc; 9 | ofstream outFile; 10 | int OF; 11 | 12 | bool simUpdate(const uint8_t pinState, const uint8_t cycles) { 13 | outFile << cyclesAcc * OF << "\t" << (int) pinState * 5 << endl; //Scale to 5V and oversample with OF 14 | cyclesAcc += cycles; 15 | return true; 16 | } 17 | 18 | int main() { 19 | FTCom ftcom(&simUpdate); 20 | uint8_t data[ftcom.maxNumBytes]; 21 | uint8_t numBytes; 22 | 23 | { 24 | outFile.open("plots/RemoteOn.test"); 25 | OF = 2; 26 | numBytes = 2; 27 | 28 | cyclesAcc = 4992/OF; 29 | simUpdate(1, 0); 30 | 31 | ftcom.setTxRole(FTCom::SLAVE); 32 | data[0] = 23; 33 | data[1] = 1; 34 | ftcom.transmit(data, numBytes); 35 | while (ftcom.getState() == FTCom::TRANSMITTING) { 36 | ftcom.timeElapsed(); 37 | } 38 | cyclesAcc += 1523/OF; 39 | 40 | ftcom.setTxRole(FTCom::MASTER); 41 | data[0] = 22; 42 | data[1] = 0; 43 | ftcom.transmit(data, numBytes); 44 | while (ftcom.getState() == FTCom::TRANSMITTING) { 45 | ftcom.timeElapsed(); 46 | } 47 | 48 | cyclesAcc += 582/OF; 49 | ftcom.setTxRole(FTCom::SLAVE); 50 | data[0] = 35; 51 | data[1] = 255; 52 | ftcom.transmit(data, numBytes); 53 | while (ftcom.getState() == FTCom::TRANSMITTING) { 54 | ftcom.timeElapsed(); 55 | } 56 | 57 | cyclesAcc += 1011/OF - 1; 58 | ftcom.setTxRole(FTCom::MASTER); 59 | data[0] = 35; 60 | data[1] = 84; 61 | ftcom.transmit(data, numBytes); 62 | while (ftcom.getState() == FTCom::TRANSMITTING) { 63 | ftcom.timeElapsed(); 64 | } 65 | 66 | cyclesAcc += 1906/OF - 1; 67 | ftcom.setTxRole(FTCom::SLAVE); 68 | data[0] = 23; 69 | data[1] = 1; 70 | ftcom.transmit(data, numBytes); 71 | while (ftcom.getState() == FTCom::TRANSMITTING) { 72 | ftcom.timeElapsed(); 73 | } 74 | 75 | outFile.close(); 76 | } 77 | 78 | { 79 | outFile.open("plots/PowerOn.test"); 80 | OF = 8; 81 | cyclesAcc = 1252/OF; 82 | simUpdate(1, 0); 83 | 84 | ftcom.setTxRole(FTCom::MASTER); 85 | numBytes = 2; 86 | data[0] = 22; 87 | data[1] = 1; 88 | ftcom.transmit(data, numBytes); 89 | while (ftcom.getState() == FTCom::TRANSMITTING) { 90 | ftcom.timeElapsed(); 91 | } 92 | cyclesAcc += 7698/OF; 93 | 94 | ftcom.setTxRole(FTCom::SLAVE); 95 | numBytes = 1; 96 | data[0] = 29; 97 | ftcom.transmit(data, numBytes); 98 | while (ftcom.getState() == FTCom::TRANSMITTING) { 99 | ftcom.timeElapsed(); 100 | } 101 | 102 | cyclesAcc += 4014/OF + 1; 103 | ftcom.setTxRole(FTCom::MASTER); 104 | numBytes = 5; 105 | data[0] = 29; 106 | data[1] = 0; 107 | data[2] = 120; 108 | data[3] = 5; 109 | data[4] = 24; 110 | ftcom.transmit(data, numBytes); 111 | while (ftcom.getState() == FTCom::TRANSMITTING) { 112 | ftcom.timeElapsed(); 113 | } 114 | 115 | outFile.close(); 116 | } 117 | 118 | { 119 | outFile.open("plots/RemoteOff.test"); 120 | OF = 4; 121 | cyclesAcc = 3391/OF; 122 | simUpdate(1, 0); 123 | 124 | ftcom.setTxRole(FTCom::SLAVE); 125 | numBytes = 2; 126 | data[0] = 23; 127 | data[1] = 172; 128 | ftcom.transmit(data, numBytes); 129 | while (ftcom.getState() == FTCom::TRANSMITTING) { 130 | ftcom.timeElapsed(); 131 | } 132 | cyclesAcc += 186/OF; 133 | 134 | ftcom.setTxRole(FTCom::SLAVE); 135 | numBytes = 3; 136 | data[0] = 35; 137 | data[1] = 1; 138 | data[2] = 0; 139 | ftcom.transmit(data, numBytes); 140 | while (ftcom.getState() == FTCom::TRANSMITTING) { 141 | ftcom.timeElapsed(); 142 | } 143 | cyclesAcc += 1123/OF + 1; 144 | 145 | ftcom.setTxRole(FTCom::MASTER); 146 | numBytes = 3; 147 | data[0] = 22; 148 | data[1] = 0; 149 | data[2] = 0; 150 | ftcom.transmit(data, numBytes); 151 | while (ftcom.getState() == FTCom::TRANSMITTING) { 152 | ftcom.timeElapsed(); 153 | } 154 | cyclesAcc += 1003/OF; 155 | 156 | ftcom.setTxRole(FTCom::MASTER); 157 | numBytes = 2; 158 | data[0] = 35; 159 | data[1] = 84; 160 | ftcom.transmit(data, numBytes); 161 | while (ftcom.getState() == FTCom::TRANSMITTING) { 162 | ftcom.timeElapsed(); 163 | } 164 | cyclesAcc += 1527/OF + 1; 165 | 166 | ftcom.setTxRole(FTCom::SLAVE); 167 | numBytes = 2; 168 | data[0] = 160; 169 | data[1] = 0; 170 | ftcom.transmit(data, numBytes); 171 | while (ftcom.getState() == FTCom::TRANSMITTING) { 172 | ftcom.timeElapsed(); 173 | } 174 | outFile.close(); 175 | } 176 | } 177 | -------------------------------------------------------------------------------- /plots/PowerOn.plt: -------------------------------------------------------------------------------- 1 | set xtics 8 2 | set grid 3 | set yrange [-0.2:5.2] 4 | plot "PowerOn.test" w step, "PowerOn.csv" using ($2*-10) w l 5 | 6 | pause mouse close 7 | -------------------------------------------------------------------------------- /plots/RemoteOff.plt: -------------------------------------------------------------------------------- 1 | set xtics 4 2 | set grid 3 | set yrange [-0.2:5.2] 4 | plot "RemoteOff.test" w step, "RemoteOff.csv" using ($2*-10) w l 5 | 6 | pause mouse close 7 | 8 | -------------------------------------------------------------------------------- /plots/RemoteOn.plt: -------------------------------------------------------------------------------- 1 | set xtics 2 2 | set grid 3 | set yrange [-0.2:5.2] 4 | plot "RemoteOn.test" w step, "RemoteOn.csv" using ($2*-10) w l 5 | 6 | pause mouse close 7 | -------------------------------------------------------------------------------- /plots/ct.plt: -------------------------------------------------------------------------------- 1 | set xtics 1 2 | set grid 3 | set yrange [-0.2:5.2] 4 | plot "ctOn.test" w step 5 | 6 | pause mouse close 7 | -------------------------------------------------------------------------------- /rxGraph.dot: -------------------------------------------------------------------------------- 1 | digraph G { 2 | START_0 -> START_1 [label="duration == 8"] 3 | 4 | START_1 -> START_2 [label="duration == 4\nrxRole = SLAVE"] 5 | START_1 -> START_2 [label="duration == 9\nrxRole = MASTER"] 6 | START_1 -> START_0 [label="else"] 7 | 8 | START_2 -> BIT_HALF [label="duration == 2"] 9 | START_2 -> BIT_FULL [label="duration == 4\nsetNextBitInv(1)"] 10 | START_2 -> START_0 [label="else"] 11 | 12 | BIT_HALF -> BIT_FULL [label="duration == 2\nsetNextBitInv(0)"] 13 | BIT_HALF -> START_0 [label="else"] 14 | 15 | BIT_FULL -> BIT_HALF [label="duration == 2"] 16 | BIT_FULL -> BIT_FULL [label="duration == 4\nsetNextBitInv(1)"] 17 | BIT_FULL-> STOP [label="lastBit == 0; duration == 8; bitCnt % 8 == 0"] 18 | BIT_FULL-> RX_WAIT_DATA [label="lastBit == 1; duration >= 8; bitCnt % 8 == 0"] 19 | BIT_FULL -> START_0 [label="else"] 20 | 21 | STOP -> RX_WAIT_DATA 22 | } 23 | -------------------------------------------------------------------------------- /testCT.cpp: -------------------------------------------------------------------------------- 1 | #include "ct.hpp" 2 | 3 | #include 4 | #include 5 | 6 | using namespace std; 7 | 8 | int cyclesAcc; 9 | ofstream outFile; 10 | int OF = 1; 11 | 12 | bool simUpdate(const uint8_t pinState, const uint8_t cycles) { 13 | outFile << cyclesAcc * OF << "\t" << (int) pinState * 5 << endl; //Scale to 5V and oversample with 2 14 | cyclesAcc += cycles; 15 | return true; 16 | } 17 | 18 | int main() { 19 | CT ct(&simUpdate); 20 | 21 | ct.setTxRole(FTCom::SLAVE); 22 | outFile.open("plots/ctOff.test"); 23 | ct.setState(0); 24 | while (ct.getState() == FTCom::TRANSMITTING) { 25 | ct.timeElapsed(); 26 | } 27 | outFile.close(); 28 | 29 | outFile.open("plots/ctOn.test"); 30 | ct.setState(1); 31 | while (ct.getState() == FTCom::TRANSMITTING) { 32 | ct.timeElapsed(); 33 | } 34 | outFile.close(); 35 | } 36 | -------------------------------------------------------------------------------- /testFTCom.cpp: -------------------------------------------------------------------------------- 1 | #include "ftcom.hpp" 2 | 3 | #include 4 | #include 5 | 6 | using namespace std; 7 | 8 | FTCom* tx; 9 | FTCom* rx; 10 | 11 | void printData(FTCom& ftcom, int numBytesReq) { 12 | cout << "Received from "; 13 | uint8_t data[numBytesReq]; 14 | if (ftcom.getRxRole() == FTCom::MASTER) { 15 | cout << "Master : "; 16 | } else { 17 | cout << "Slave : "; 18 | } 19 | int numBytes = ftcom.readData(data, numBytesReq); 20 | for (int b = 0; b < numBytes; b++) { 21 | cout << (int) *(data + b) << " "; 22 | } 23 | cout << endl; 24 | } 25 | 26 | bool simUpdate(const uint8_t pinState, const uint8_t cycles) { 27 | int numBytes = rx->nextEdge(cycles); 28 | if (numBytes > 0) { 29 | printData(*rx, numBytes); 30 | } 31 | return true; 32 | } 33 | 34 | int main(int argc, char** argv) { 35 | tx = new FTCom(&simUpdate, FTCom::SLAVE); 36 | rx = new FTCom(&simUpdate, FTCom::MASTER); 37 | uint8_t txData[tx->maxNumBytes]; 38 | uint8_t numTxBytes = 3; 39 | 40 | { 41 | txData[0] = 23; 42 | txData[1] = 33; 43 | txData[2] = 43; 44 | 45 | uint8_t rxData[rx->maxNumBytes]; 46 | 47 | cout << "Transmitting as SLAVE : "; 48 | for (int b = 0; b < numTxBytes; b++) { 49 | cout << (int) txData[b] << " "; 50 | } 51 | cout << endl; 52 | 53 | tx->transmit(txData, numTxBytes); 54 | while (tx->getState() == FTCom::TRANSMITTING) { 55 | tx->timeElapsed(); 56 | } 57 | } 58 | 59 | cout << endl; 60 | 61 | { 62 | txData[0] = 44; 63 | txData[1] = 55; 64 | txData[2] = 66; 65 | 66 | uint8_t rxData[rx->maxNumBytes]; 67 | 68 | tx->setTxRole(FTCom::MASTER); 69 | cout << "Transmitting as MASTER: "; 70 | for (int b = 0; b < numTxBytes; b++) { 71 | cout << (int) txData[b] << " "; 72 | } 73 | cout << endl; 74 | 75 | tx->transmit(txData, numTxBytes); 76 | while (tx->getState() == FTCom::TRANSMITTING) { 77 | tx->timeElapsed(); 78 | } 79 | } 80 | 81 | delete tx; 82 | delete rx; 83 | } 84 | -------------------------------------------------------------------------------- /testFTComC.c: -------------------------------------------------------------------------------- 1 | #include "ftcom.h" 2 | 3 | bool simUpdate(const uint8_t pinState, const uint8_t cycles) { 4 | printf("State %d for %d cycles\n", pinState, cycles); 5 | return true; 6 | } 7 | 8 | int main() { 9 | struct FTCom* ftcom = newFTCom(&simUpdate); 10 | 11 | uint8_t txData[FTCom_getMaxNumBytes(ftcom)]; 12 | uint8_t numTxBytes = 3; 13 | txData[0] = 23; 14 | txData[1] = 33; 15 | txData[2] = 43; 16 | 17 | FTCom_transmit(ftcom, txData, numTxBytes); 18 | while (FTCom_getState(ftcom) == FTCOM_TRANSMITTING) { 19 | FTCom_timeElapsed(ftcom); 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /txGraph.dot: -------------------------------------------------------------------------------- 1 | digraph G { 2 | START_0 -> START_1 [label="out(0, 8)"]; 3 | 4 | START_1 -> START_2 [label="txRole == MASTER\nout(1, 9)"]; 5 | START_1 -> START_2 [label="txRole == SLAVE\nout(1, 4)"]; 6 | 7 | START_2 -> BIT_HALF [label="bit == 0\nout(0, 2)"] 8 | START_2 -> BIT_FULL [label="bit == 1\nout(0, 4)"] 9 | 10 | BIT_HALF -> BIT_FULL [label="out(bit^1, 2)"] 11 | 12 | BIT_FULL -> BIT_HALF [label="hasNext(); last == bit\nout(bit, 2)"] 13 | BIT_FULL -> BIT_FULL [label="hasNext(); last != bit\nout(bit^1, 4)"] 14 | BIT_FULL -> STOP_0 [label="!hasNext();bit == 0\nout(bit, 8)"] 15 | BIT_FULL -> TX_WAIT_DATA [label="!hasNext(); bit == 1\nout(bit, 8)"] 16 | 17 | STOP_0 -> TX_WAIT_DATA [label="out(1, 0)"] 18 | 19 | START_2 [label="START_2\nhasNext()\nlast = bit; bit = getNext()"] 20 | BIT_FULL [label="BIT_FULL\nhasNext()\nlast = bit; bit = getNext()"] 21 | } 22 | --------------------------------------------------------------------------------