├── LICENSE ├── README.md ├── SConscript ├── button.c ├── button.h └── example.c /LICENSE: -------------------------------------------------------------------------------- 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.md: -------------------------------------------------------------------------------- 1 | # rtpkg_button 2 | rtt packages button drive 3 | 自己写的一个按键驱动，支持单双击、连按、长按；采用回调处理按键事件（自定义消抖时间），使用只需3步，创建按键，按键事件与回调处理函数链接映射，周期检查按键。 4 | 源码地址：[https://github.com/jiejieTop/ButtonDrive](https://github.com/jiejieTop/ButtonDrive)。作者:[杰杰](https://github.com/jiejieTop) 5 | 6 | 7 | ## 前言 8 | 前几天写了个按键驱动，参考了[MulitButton](https://github.com/0x1abin/MultiButton)的数据结构的用法，逻辑实现并不一样。 9 | 在这里感谢所有的开源开发者，让我从中学到了很多，同时网络也是一个好平台，也希望所有的开发者能形成良性循环，从网络中学知识，回馈到网络中去。感谢[MulitButton](https://github.com/0x1abin/MultiButton)的作者[0x1abin](https://github.com/0x1abin)，感谢两位rtt的大佬：[大法师](https://github.com/uestczyh222)、[流光](https://github.com/liu2guang)。 10 | ## Button_drive简介 11 | Button_drive是一个小巧的按键驱动，支持单击、双击、长按、连续触发等（后续可以在按键控制块中添加触发事件），理论上可无限量扩展Button，Button_drive采用按键触发事件回调方式处理业务逻辑，支持在RTOS中使用，我目前仅在[RT-Thread](https://github.com/RT-Thread/rt-thread)上测试过。 12 | 写按键驱动的目的是想要将用户按键逻辑与按键处理事件分离，用户无需处理复杂麻烦的逻辑事件。 13 | 14 | ## Button_drive使用效果 15 | 1. **单击与长按** 16 | 17 | ![单击与长按](https://github.com/jiejieTop/ButtonDrive/blob/master/png/1.png?raw=true) 18 | 19 | 2. **双击** 20 | 21 | ![双击](https://github.com/jiejieTop/ButtonDrive/blob/master/png/2.png?raw=true) 22 | 23 | 3. **连按** 24 | 25 | ![连按](https://github.com/jiejieTop/ButtonDrive/blob/master/png/3.png?raw=true) 26 | 27 | 4. **连按释放** 28 | 29 | ![连按释放](https://github.com/jiejieTop/ButtonDrive/blob/master/png/4.png?raw=true) 30 | 31 | ## 使用方法 32 | 1. 创建按键句柄 33 | ``` 34 | Button_t Button1; 35 | Button_t Button2; 36 | ``` 37 | 2. 创建按键，初始化按键信息，包括按键名字、按键电平检测函数接口、按键触发电平。 38 | ``` 39 | Button_Create("Button1", //按键名字 40 | &Button1, //按键句柄 41 | Read_Button1_Level, //按键电平检测函数接口 42 | BTN_TRIGGER); //触发电平 43 | 44 | ...... 45 | ``` 46 | 3. 按键触发事件与事件回调函数链接映射，当按键事件被触发的时候，自动跳转回调函数中处理业务逻辑。 47 | ``` 48 | Button_Attach(&Button1,BUTTON_DOWM,Btn2_Dowm_CallBack); //按键单击 49 | Button_Attach(&Button1,BUTTON_DOUBLE,Btn2_Double_CallBack); //双击 50 | Button_Attach(&Button1,BUTTON_LONG,Btn2_Long_CallBack); //长按 51 | 52 | ....... 53 | ``` 54 | 4. 周期调用回调按键处理函数即可，建议调用周期20-50ms。 55 | ``` 56 | Button_Process(); //需要周期调用按键处理函数 57 | ``` 58 | 59 | --- 60 | 需要用户实现的 **2** 个函数： 61 | 62 | - 按键电平检测接口： 63 | ``` 64 | uint8_t Read_Button1_Level(void) 65 | { 66 | return GPIO_ReadInputDataBit(BTN1_GPIO_PORT,BTN1_GPIO_PIN); 67 | } 68 | 69 | uint8_t Read_Button2_Level(void) 70 | { 71 | return GPIO_ReadInputDataBit(BTN2_GPIO_PORT,BTN2_GPIO_PIN); 72 | } 73 | 74 | // 这是我在stm32上简单测试的伪代码，以实际源码为准 75 | 76 | ``` 77 | 78 | - 按键逻辑处理 79 | ``` 80 | void Btn1_Dowm_CallBack(void *btn) 81 | { 82 | PRINT_INFO("Button1 单击!"); 83 | } 84 | 85 | void Btn1_Double_CallBack(void *btn) 86 | { 87 | PRINT_INFO("Button1 双击!"); 88 | } 89 | 90 | void Btn1_Long_CallBack(void *btn) 91 | { 92 | PRINT_INFO("Button1 长按!"); 93 | 94 | Button_Delete(&Button2); 95 | PRINT_INFO("删除Button1"); 96 | Search_Button(); 97 | } 98 | ``` 99 | 100 | ## 特点 101 | Button_drive开放源码，按键控制块采用数据结构方式，按键事件采用枚举类型，确保不会重复，也便于添加用户需要逻辑，采用宏定义方式定义消抖时间、连按触发时间、双击时间间隔、长按时间等，便于修改。 102 | 同时所有被创建的按键采用单链表方式连击，用户只管创建，无需理会按键处理，只需调用`Button_Process()`即可，在函数中会自动遍历所有被创建的按键。 103 | 支持按键删除操作，用户无需在代码中删除对应的按键创建于映射链接代码，也无需删除关于按键的任何回调事件处理函数，只需调用`Button_Delete()`函数即可，这样子，就不会处理关于被删除按键的任何状态。当然目前按键内存不会释放，如果使用os的话，建议释放按键内存。 104 | ##### 按键控制块 105 | ``` 106 | /* 107 | 每个按键对应1个全局的结构体变量。 108 | 其成员变量是实现消抖和多种按键状态所必须的 109 | */ 110 | typedef struct button 111 | { 112 | /* 下面是一个函数指针，指向判断按键手否按下的函数 */ 113 | uint8_t (*Read_Button_Level)(void); /* 读取按键电平函数，需要用户实现 */ 114 | 115 | char Name[BTN_NAME_MAX]; 116 | 117 | uint8_t Button_State : 4; /* 按键当前状态（按下还是弹起） */ 118 | uint8_t Button_Last_State : 4; /* 上一次的按键状态，用于判断双击 */ 119 | uint8_t Button_Trigger_Level : 2; /* 按键触发电平 */ 120 | uint8_t Button_Last_Level : 2; /* 按键当前电平 */ 121 | 122 | uint8_t Button_Trigger_Event; /* 按键触发事件，单击，双击，长按等 */ 123 | 124 | Button_CallBack CallBack_Function[number_of_event]; 125 | uint8_t Button_Cycle; /* 连续按键周期 */ 126 | 127 | uint8_t Timer_Count; /* 计时 */ 128 | uint8_t Debounce_Time; /* 消抖时间 */ 129 | 130 | uint8_t Long_Time; /* 按键按下持续时间 */ 131 | 132 | struct button *Next; 133 | 134 | }Button_t; 135 | 136 | ``` 137 | ##### 触发事件 138 | ``` 139 | typedef enum { 140 | BUTTON_DOWM = 0, 141 | BUTTON_UP, 142 | BUTTON_DOUBLE, 143 | BUTTON_LONG, 144 | BUTTON_CONTINUOS, 145 | BUTTON_CONTINUOS_FREE, 146 | BUTTON_ALL_RIGGER, 147 | number_of_event, /* 触发回调的事件 */ 148 | NONE_TRIGGER 149 | }Button_Event; 150 | 151 | ``` 152 | ##### 宏定义选择 153 | ``` 154 | #define BTN_NAME_MAX 32 //名字最大为32字节 155 | 156 | /* 按键消抖时间40ms, 建议调用周期为20ms 157 | 只有连续检测到40ms状态不变才认为有效，包括弹起和按下两种事件 158 | */ 159 | 160 | #define CONTINUOS_TRIGGER 0 //是否支持连续触发，连发的话就不要检测单双击与长按了 161 | 162 | /* 是否支持单击&双击同时存在触发，如果选择开启宏定义的话，单双击都回调，只不过单击会延迟响应， 163 | 因为必须判断单击之后是否触发了双击否则，延迟时间是双击间隔时间 BUTTON_DOUBLE_TIME。 164 | 而如果不开启这个宏定义，建议工程中只存在单击/双击中的一个，否则，在双击响应的时候会触发一次单击， 165 | 因为双击必须是有一次按下并且释放之后才产生的 */ 166 | #define SINGLE_AND_DOUBLE_TRIGGER 1 167 | 168 | /* 是否支持长按释放才触发，如果打开这个宏定义，那么长按释放之后才触发单次长按， 169 | 否则在长按指定时间就一直触发长按，触发周期由 BUTTON_LONG_CYCLE 决定 */ 170 | #define LONG_FREE_TRIGGER 0 171 | 172 | #define BUTTON_DEBOUNCE_TIME 2 //消抖时间 (n-1)*调用周期 173 | #define BUTTON_CONTINUOS_CYCLE 1 //连按触发周期时间 (n-1)*调用周期 174 | #define BUTTON_LONG_CYCLE 1 //长按触发周期时间 (n-1)*调用周期 175 | #define BUTTON_DOUBLE_TIME 15 //双击间隔时间 (n-1)*调用周期 建议在200-600ms 176 | #define BUTTON_LONG_TIME 50 /* 持续n秒((n-1)*调用周期 ms)，认为长按事件 */ 177 | 178 | #define TRIGGER_CB(event) \ 179 | if(btn->CallBack_Function[event]) \ 180 | btn->CallBack_Function[event]((Button_t*)btn) 181 | ``` 182 | 183 | ##### 例子 184 | ``` 185 | Button_Create("Button1", 186 | &Button1, 187 | Read_KEY1_Level, 188 | KEY_ON); 189 | Button_Attach(&Button1,BUTTON_DOWM,Btn1_Dowm_CallBack); //单击 190 | Button_Attach(&Button1,BUTTON_DOUBLE,Btn1_Double_CallBack); //双击 191 | Button_Attach(&Button1,BUTTON_CONTINUOS,Btn1_Continuos_CallBack); //连按 192 | Button_Attach(&Button1,BUTTON_CONTINUOS_FREE,Btn1_ContinuosFree_CallBack); //连按释放 193 | Button_Attach(&Button1,BUTTON_LONG,Btn1_Long_CallBack); //长按 194 | 195 | 196 | Button_Create("Button2", 197 | &Button2, 198 | Read_KEY2_Level, 199 | KEY_ON); 200 | Button_Attach(&Button2,BUTTON_DOWM,Btn2_Dowm_CallBack); //单击 201 | Button_Attach(&Button2,BUTTON_DOUBLE,Btn2_Double_CallBack); //双击 202 | Button_Attach(&Button2,BUTTON_CONTINUOS,Btn2_Continuos_CallBack); //连按 203 | Button_Attach(&Button2,BUTTON_CONTINUOS_FREE,Btn2_ContinuosFree_CallBack); //连按释放 204 | Button_Attach(&Button2,BUTTON_LONG,Btn2_Long_CallBack); //长按 205 | 206 | Get_Button_Event(&Button1); 207 | Get_Button_Event(&Button2); 208 | ``` 209 | 210 | 211 | ## 后续 212 | [流光](https://github.com/liu2guang)大佬的要求，让我玩一玩RTT的[rtkpgs](https://github.com/liu2guang/buildpkg)，打算用Button_drive练一练手吧。 213 | 214 | ## ButtonDrive在env使用 215 | 目前我已将按键驱动做成软件包（packages），如果使用RT-Thread操作系统的话，可以在env中直接配置使用! 216 | 217 | 步骤如下： 218 | 219 | 1. **选择在线软件包** 220 | 221 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/5.png?raw=true) 222 | 223 | 2. **选择软件包属性为外设相关** 224 | 225 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/6.png?raw=true) 226 | 227 | 3. **选择button_drive** 228 | 229 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/7.png?raw=true) 230 | 231 | 4. **进入驱动的选项配置（自带默认属性）** 232 | 233 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/8.png?raw=true) 234 | 235 | 5. **如果不懂按键的配置是什么意思，按下“shift+？”，即可有解释** 236 | 237 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/9.png?raw=true) 238 | 239 | 6. **编译生成mdk/iar工程** 240 | 241 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/10.png?raw=true) 242 | 243 | ![](https://github.com/jiejieTop/ButtonDrive/blob/master/png/11.png?raw=true) 244 | 245 | 246 | ## 联系人 247 | 248 | * 邮箱：[1161959934@qq.com](mailto:1161959934@qq.com) 249 | * 主页：[jiejie](https://github.com/jiejieTop) 250 | * 仓库：[Github](https://github.com/jiejieTop) 251 | -------------------------------------------------------------------------------- /SConscript: -------------------------------------------------------------------------------- 1 | Import('RTT_ROOT') 2 | Import('rtconfig') 3 | from building import * 4 | 5 | cwd = GetCurrentDir() 6 | src = Glob('button.c') 7 | 8 | CPPPATH = [cwd] 9 | 10 | group = DefineGroup('button_drive', src, depend = ['PKG_USING_BUTTON'], CPPPATH = CPPPATH) 11 | 12 | Return('group') 13 | -------------------------------------------------------------------------------- /button.c: -------------------------------------------------------------------------------- 1 | /************************************************************ 2 | * @brief button_drive 3 | * @param RT_NULL 4 | * @return RT_NULL 5 | * @author jiejie 6 | * @github https://github.com/jiejieTop 7 | * @date 2018-xx-xx 8 | * @version v1.0.1 9 | * @note button.c 10 | ***********************************************************/ 11 | 12 | #include "button.h" 13 | 14 | #ifdef PKG_USING_BUTTON 15 | 16 | /******************************************************************* 17 | * Variable Declaration 18 | *******************************************************************/ 19 | 20 | static struct button* Head_Button = RT_NULL; 21 | 22 | 23 | /******************************************************************* 24 | * Function Declaration 25 | *******************************************************************/ 26 | static char *StrnCopy(char *dst, const char *src, rt_uint32_t n); 27 | static void Print_Btn_Info(Button_t* btn); 28 | static void Add_Button(Button_t* btn); 29 | 30 | 31 | /************************************************************ 32 | * @brief Create a Button 33 | * @param name:button name 34 | * @param btn:button structure 35 | * @param read_btn_level:Button trigger level reading function, 36 | * Return the level of the rt_uint8_t type by yourself 37 | * @param btn_trigger_level:Button trigger level 38 | * @return RT_NULL 39 | * @author jiejie 40 | * @github https://github.com/jiejieTop 41 | * @date 2018-xx-xx 42 | * @version v1.0 43 | * @note RT_NULL 44 | ***********************************************************/ 45 | void Button_Create(const char *name, 46 | Button_t *btn, 47 | rt_uint8_t(*read_btn_level)(void), 48 | rt_uint8_t btn_trigger_level) 49 | { 50 | if( btn == RT_NULL) 51 | { 52 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("struct button is RT_NULL!")); 53 | } 54 | 55 | memset(btn, 0, sizeof(struct button)); //Clear structure information 56 | 57 | StrnCopy(btn->Name, name, BTN_NAME_MAX); //button name 58 | 59 | 60 | btn->Button_State = NONE_TRIGGER; //Button status 61 | btn->Button_Last_State = NONE_TRIGGER; //Button last status 62 | btn->Button_Trigger_Event = NONE_TRIGGER; //Button trigger event 63 | btn->Read_Button_Level = read_btn_level; //Button trigger level reading function 64 | btn->Button_Trigger_Level = btn_trigger_level; //Button trigger level 65 | btn->Button_Last_Level = btn->Read_Button_Level(); //Button current level 66 | btn->Debounce_Time = 0; 67 | 68 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("button create success!")); 69 | 70 | Add_Button(btn); //Added to the singly linked list when button created 71 | 72 | Print_Btn_Info(btn); //printf info 73 | 74 | } 75 | 76 | /************************************************************ 77 | * @brief burron trigger events are attach to callback function 78 | * @param btn:button structure 79 | * @param btn_event:button events 80 | * @param btn_callback : Callback handler after the button is triggered.Need user implementation 81 | * @return RT_NULL 82 | * @author jiejie 83 | * @github https://github.com/jiejieTop 84 | * @date 2018-xx-xx 85 | * @version v1.0 86 | ***********************************************************/ 87 | void Button_Attach(Button_t *btn,Button_Event btn_event,Button_CallBack btn_callback) 88 | { 89 | if( btn == RT_NULL) 90 | { 91 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("struct button is RT_NULL!")); 92 | } 93 | 94 | if(BUTTON_ALL_RIGGER == btn_event) 95 | { 96 | for(rt_uint8_t i = 0 ; i < number_of_event-1 ; i++) 97 | /*A callback function triggered by a button event ,Used to handle button events */ 98 | btn->CallBack_Function[i] = btn_callback; 99 | } 100 | else 101 | { 102 | btn->CallBack_Function[btn_event] = btn_callback; 103 | } 104 | } 105 | 106 | /************************************************************ 107 | * @brief Delete an already created button 108 | * @param RT_NULL 109 | * @return RT_NULL 110 | * @author jiejie 111 | * @github https://github.com/jiejieTop 112 | * @date 2018-xx-xx 113 | * @version v1.0 114 | * @note RT_NULL 115 | ***********************************************************/ 116 | void Button_Delete(Button_t *btn) 117 | { 118 | struct button** curr; 119 | for(curr = &Head_Button; *curr;) 120 | { 121 | struct button* entry = *curr; 122 | if (entry == btn) 123 | { 124 | *curr = entry->Next; 125 | } 126 | else 127 | { 128 | curr = &entry->Next; 129 | } 130 | } 131 | } 132 | 133 | /************************************************************ 134 | * @brief Get Button Event Info 135 | * @param RT_NULL 136 | * @return RT_NULL 137 | * @author jiejie 138 | * @github https://github.com/jiejieTop 139 | * @date 2018-xx-xx 140 | * @version v1.0 141 | ***********************************************************/ 142 | void Get_Button_EventInfo(Button_t *btn) 143 | { 144 | for(rt_uint8_t i = 0 ; i < number_of_event-1 ; i++) 145 | { 146 | if(btn->CallBack_Function[i] != 0) 147 | { 148 | /* print */ 149 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Button_Event:%d",i)); 150 | } 151 | } 152 | } 153 | 154 | /************************************************************ 155 | * @brief Get Button Event 156 | * @param RT_NULL 157 | * @return RT_NULL 158 | * @author jiejie 159 | * @github https://github.com/jiejieTop 160 | * @date 2018-xx-xx 161 | * @version v1.0 162 | ***********************************************************/ 163 | rt_uint8_t Get_Button_Event(Button_t *btn) 164 | { 165 | return (rt_uint8_t)(btn->Button_Trigger_Event); 166 | } 167 | 168 | /************************************************************ 169 | * @brief Get Button State 170 | * @param RT_NULL 171 | * @return RT_NULL 172 | * @author jiejie 173 | * @github https://github.com/jiejieTop 174 | * @date 2018-xx-xx 175 | * @version v1.0 176 | ***********************************************************/ 177 | rt_uint8_t Get_Button_State(Button_t *btn) 178 | { 179 | return (rt_uint8_t)(btn->Button_State); 180 | } 181 | 182 | /************************************************************ 183 | * @brief button cycle processing function 184 | * @param btn:button structure 185 | * @return RT_NULL 186 | * @author jiejie 187 | * @github https://github.com/jiejieTop 188 | * @date 2018-xx-xx 189 | * @version v1.0 190 | * @note This function must be called in a certain period. The recommended period is 20~50ms. 191 | ***********************************************************/ 192 | void Button_Cycle_Process(Button_t *btn) 193 | { 194 | /* Get the current button level */ 195 | rt_uint8_t current_level = (rt_uint8_t)btn->Read_Button_Level(); 196 | 197 | /* Button level changes, debounce */ 198 | if((current_level != btn->Button_Last_Level)&&(++(btn->Debounce_Time) >= BUTTON_DEBOUNCE_TIME)) 199 | { 200 | /* Update current button level */ 201 | btn->Button_Last_Level = current_level; 202 | 203 | /* button is pressed */ 204 | btn->Debounce_Time = 0; 205 | 206 | /* If the button is not pressed, change the button state to press (first press / double trigger) */ 207 | if((btn->Button_State == NONE_TRIGGER)||(btn->Button_State == BUTTON_DOUBLE)) 208 | { 209 | btn->Button_State = BUTTON_DOWM; 210 | } 211 | //free button 212 | else if(btn->Button_State == BUTTON_DOWM) 213 | { 214 | btn->Button_State = BUTTON_UP; 215 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("button release")); 216 | } 217 | } 218 | 219 | switch(btn->Button_State) 220 | { 221 | /* button dowm */ 222 | case BUTTON_DOWM : 223 | { 224 | if(btn->Button_Last_Level == btn->Button_Trigger_Level) 225 | { 226 | /* Support continuous triggering */ 227 | #ifdef CONTINUOS_TRIGGER 228 | 229 | if(++(btn->Button_Cycle) >= BUTTON_CONTINUOS_CYCLE) 230 | { 231 | btn->Button_Cycle = 0; 232 | btn->Button_Trigger_Event = BUTTON_CONTINUOS; 233 | /* continuous triggering */ 234 | TRIGGER_CB(BUTTON_CONTINUOS); 235 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("continuous triggering")); 236 | } 237 | 238 | #else 239 | 240 | btn->Button_Trigger_Event = BUTTON_DOWM; 241 | 242 | /* Update the trigger event before releasing the button as long press */ 243 | if(++(btn->Long_Time) >= BUTTON_LONG_TIME) 244 | { 245 | #ifdef LONG_FREE_TRIGGER 246 | 247 | btn->Button_Trigger_Event = BUTTON_LONG; 248 | 249 | #else 250 | 251 | /* Continuous triggering of long press cycles */ 252 | if(++(btn->Button_Cycle) >= BUTTON_LONG_CYCLE) 253 | { 254 | btn->Button_Cycle = 0; 255 | btn->Button_Trigger_Event = BUTTON_LONG; 256 | 257 | /* long triggering */ 258 | TRIGGER_CB(BUTTON_LONG); 259 | } 260 | #endif 261 | 262 | /* Update time overflow */ 263 | if(btn->Long_Time == 0xFF) 264 | { 265 | btn->Long_Time = BUTTON_LONG_TIME; 266 | } 267 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Long press")); 268 | } 269 | 270 | #endif 271 | } 272 | 273 | break; 274 | } 275 | 276 | /* button up */ 277 | case BUTTON_UP : 278 | { 279 | /* Trigger click */ 280 | if(btn->Button_Trigger_Event == BUTTON_DOWM) 281 | { 282 | /* double click */ 283 | if((btn->Timer_Count <= BUTTON_DOUBLE_TIME)&&(btn->Button_Last_State == BUTTON_DOUBLE)) 284 | { 285 | btn->Button_Trigger_Event = BUTTON_DOUBLE; 286 | TRIGGER_CB(BUTTON_DOUBLE); 287 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("double click")); 288 | btn->Button_State = NONE_TRIGGER; 289 | btn->Button_Last_State = NONE_TRIGGER; 290 | } 291 | else 292 | { 293 | btn->Timer_Count=0; 294 | /* Detection long press failed, clear 0 */ 295 | btn->Long_Time = 0; 296 | 297 | #ifndef SINGLE_AND_DOUBLE_TRIGGER 298 | 299 | /* click */ 300 | TRIGGER_CB(BUTTON_DOWM); 301 | #endif 302 | btn->Button_State = BUTTON_DOUBLE; 303 | btn->Button_Last_State = BUTTON_DOUBLE; 304 | 305 | } 306 | } 307 | 308 | else if(btn->Button_Trigger_Event == BUTTON_LONG) 309 | { 310 | #ifdef LONG_FREE_TRIGGER 311 | /* Long press */ 312 | TRIGGER_CB(BUTTON_LONG); 313 | #else 314 | 315 | /* Long press free */ 316 | TRIGGER_CB(BUTTON_LONG_FREE); 317 | #endif 318 | btn->Long_Time = 0; 319 | btn->Button_State = NONE_TRIGGER; 320 | btn->Button_Last_State = BUTTON_LONG; 321 | } 322 | 323 | #ifdef CONTINUOS_TRIGGER 324 | /* Press continuously */ 325 | else if(btn->Button_Trigger_Event == BUTTON_CONTINUOS) 326 | { 327 | btn->Long_Time = 0; 328 | /* Press continuously free */ 329 | TRIGGER_CB(BUTTON_CONTINUOS_FREE); 330 | btn->Button_State = NONE_TRIGGER; 331 | btn->Button_Last_State = BUTTON_CONTINUOS; 332 | } 333 | #endif 334 | 335 | break; 336 | } 337 | 338 | case BUTTON_DOUBLE : 339 | { 340 | /* Update time */ 341 | btn->Timer_Count++; 342 | if(btn->Timer_Count>=BUTTON_DOUBLE_TIME) 343 | { 344 | btn->Button_State = NONE_TRIGGER; 345 | btn->Button_Last_State = NONE_TRIGGER; 346 | } 347 | #ifdef SINGLE_AND_DOUBLE_TRIGGER 348 | 349 | if((btn->Timer_Count>=BUTTON_DOUBLE_TIME)&&(btn->Button_Last_State != BUTTON_DOWM)) 350 | { 351 | btn->Timer_Count=0; 352 | TRIGGER_CB(BUTTON_DOWM); 353 | btn->Button_State = NONE_TRIGGER; 354 | btn->Button_Last_State = BUTTON_DOWM; 355 | } 356 | 357 | #endif 358 | 359 | break; 360 | } 361 | 362 | default : 363 | break; 364 | } 365 | 366 | } 367 | 368 | /************************************************************ 369 | * @brief Traversing the way to scan the button without losing each button 370 | * @param RT_NULL 371 | * @return RT_NULL 372 | * @author jiejie 373 | * @github https://github.com/jiejieTop 374 | * @date 2018-xx-xx 375 | * @version v1.0 376 | * @note This function is called periodically, it is recommended to call 20-50ms once. 377 | ***********************************************************/ 378 | void Button_Process(void) 379 | { 380 | struct button* pass_btn; 381 | for(pass_btn = Head_Button; pass_btn != RT_NULL; pass_btn = pass_btn->Next) 382 | { 383 | Button_Cycle_Process(pass_btn); 384 | } 385 | } 386 | 387 | /************************************************************ 388 | * @brief Search Button 389 | * @param RT_NULL 390 | * @return RT_NULL 391 | * @author jiejie 392 | * @github https://github.com/jiejieTop 393 | * @date 2018-xx-xx 394 | * @version v1.0 395 | * @note RT_NULL 396 | ***********************************************************/ 397 | void Search_Button(void) 398 | { 399 | struct button* pass_btn; 400 | for(pass_btn = Head_Button; pass_btn != RT_NULL; pass_btn = pass_btn->Next) 401 | { 402 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("button node have %s",pass_btn->Name)); 403 | } 404 | } 405 | 406 | /************************************************************ 407 | * @brief Handle all button callback functions 408 | * @param RT_NULL 409 | * @return RT_NULL 410 | * @author jiejie 411 | * @github https://github.com/jiejieTop 412 | * @date 2018-xx-xx 413 | * @version v1.0 414 | * @note Not implemented yet 415 | ***********************************************************/ 416 | void Button_Process_CallBack(void *btn) 417 | { 418 | rt_uint8_t btn_event = Get_Button_Event(btn); 419 | 420 | switch(btn_event) 421 | { 422 | case BUTTON_DOWM: 423 | { 424 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your press trigger")); 425 | break; 426 | } 427 | 428 | case BUTTON_UP: 429 | { 430 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your trigger release")); 431 | break; 432 | } 433 | 434 | case BUTTON_DOUBLE: 435 | { 436 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your double-click trigger")); 437 | break; 438 | } 439 | 440 | case BUTTON_LONG: 441 | { 442 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your long press trigger")); 443 | break; 444 | } 445 | 446 | case BUTTON_LONG_FREE: 447 | { 448 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your long press trigger free")); 449 | break; 450 | } 451 | 452 | case BUTTON_CONTINUOS: 453 | { 454 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add your continuous trigger processing logic")); 455 | break; 456 | } 457 | 458 | case BUTTON_CONTINUOS_FREE: 459 | { 460 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("Add processing logic for your continuous trigger release")); 461 | break; 462 | } 463 | 464 | } 465 | } 466 | 467 | 468 | /**************************** The following is the internal call function ********************/ 469 | 470 | /************************************************************ 471 | * @brief Copy the specified length string 472 | * @param RT_NULL 473 | * @return RT_NULL 474 | * @author jiejie 475 | * @github https://github.com/jiejieTop 476 | * @date 2018-xx-xx 477 | * @version v1.0 478 | * @note RT_NULL 479 | ***********************************************************/ 480 | static char *StrnCopy(char *dst, const char *src, rt_uint32_t n) 481 | { 482 | if (n != 0) 483 | { 484 | char *d = dst; 485 | const char *s = src; 486 | do 487 | { 488 | if ((*d++ = *s++) == 0) 489 | { 490 | while (--n != 0) 491 | *d++ = 0; 492 | break; 493 | } 494 | } while (--n != 0); 495 | } 496 | return (dst); 497 | } 498 | 499 | /************************************************************ 500 | * @brief Print button related information 501 | * @param RT_NULL 502 | * @return RT_NULL 503 | * @author jiejie 504 | * @github https://github.com/jiejieTop 505 | * @date 2018-xx-xx 506 | * @version v1.0 507 | * @note RT_NULL 508 | ***********************************************************/ 509 | static void Print_Btn_Info(Button_t* btn) 510 | { 511 | 512 | RT_DEBUG_LOG(RT_DEBUG_THREAD,("button struct information:\n\ 513 | btn->Name:%s \n\ 514 | btn->Button_State:%d \n\ 515 | btn->Button_Trigger_Event:%d \n\ 516 | btn->Button_Trigger_Level:%d \n\ 517 | btn->Button_Last_Level:%d \n\ 518 | ", 519 | btn->Name, 520 | btn->Button_State, 521 | btn->Button_Trigger_Event, 522 | btn->Button_Trigger_Level, 523 | btn->Button_Last_Level)); 524 | Search_Button(); 525 | } 526 | /************************************************************ 527 | * @brief Connect buttons with a single linked list 528 | * @param RT_NULL 529 | * @return RT_NULL 530 | * @author jiejie 531 | * @github https://github.com/jiejieTop 532 | * @date 2018-xx-xx 533 | * @version v1.0 534 | * @note RT_NULL 535 | ***********************************************************/ 536 | static void Add_Button(Button_t* btn) 537 | { 538 | struct button *pass_btn = Head_Button; 539 | 540 | while(pass_btn) 541 | { 542 | pass_btn = pass_btn->Next; 543 | } 544 | 545 | btn->Next = Head_Button; 546 | Head_Button = btn; 547 | } 548 | 549 | #endif 550 | 551 | 552 | 553 | -------------------------------------------------------------------------------- /button.h: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jiejieTop/rtpkg_button/799daaade8ea7be4237aad1dab2b2871e5bd0b8d/button.h -------------------------------------------------------------------------------- /example.c: -------------------------------------------------------------------------------- 1 | 2 | #include "button.h" 3 | 4 | /** 5 | ****************************************************************** 6 | Variable declaration 7 | ****************************************************************** 8 | */ 9 | 10 | Button_t Button1; 11 | Button_t Button2; 12 | 13 | 14 | /** 15 | ****************************************************************** 16 | Function declaration 17 | ****************************************************************** 18 | */ 19 | 20 | static void BSP_Init(void); 21 | 22 | void Btn1_Dowm_CallBack(void *btn) 23 | { 24 | PRINT_INFO("Button1 Click!"); 25 | } 26 | 27 | void Btn1_Double_CallBack(void *btn) 28 | { 29 | PRINT_INFO("Button1 Double click!"); 30 | } 31 | 32 | void Btn1_Long_CallBack(void *btn) 33 | { 34 | PRINT_INFO("Button1 Long press!"); 35 | } 36 | 37 | void Btn1_Continuos_CallBack(void *btn) 38 | { 39 | PRINT_INFO("Button1 Press continuously!"); 40 | } 41 | void Btn1_ContinuosFree_CallBack(void *btn) 42 | { 43 | PRINT_INFO("Button1 Press continuously free!"); 44 | } 45 | 46 | 47 | void Btn2_Dowm_CallBack(void *btn) 48 | { 49 | PRINT_INFO("Button2 Click!"); 50 | } 51 | 52 | void Btn2_Double_CallBack(void *btn) 53 | { 54 | PRINT_INFO("Button2 Double click!"); 55 | } 56 | 57 | void Btn2_Long_CallBack(void *btn) 58 | { 59 | PRINT_INFO("Button2 Long press!"); 60 | } 61 | 62 | void Btn2_Continuos_CallBack(void *btn) 63 | { 64 | PRINT_INFO("Button2 Press continuously!"); 65 | } 66 | void Btn2_ContinuosFree_CallBack(void *btn) 67 | { 68 | PRINT_INFO("Button2 Press continuously free!"); 69 | } 70 | 71 | /** 72 | ****************************************************************** 73 | * @brief main 74 | * @author jiejie 75 | * @version V1.0 76 | * @date 2018-xx-xx 77 | ****************************************************************** 78 | */ 79 | int main(void) 80 | { 81 | uint32_t i = 100000; 82 | 83 | BSP_Init(); 84 | 85 | Button_Create("Button1", 86 | &Button1, 87 | Read_KEY1_Level, 88 | KEY_ON); 89 | Button_Attach(&Button1,BUTTON_DOWM,Btn1_Dowm_CallBack); //Click 90 | Button_Attach(&Button1,BUTTON_DOUBLE,Btn1_Double_CallBack); //Double click 91 | Button_Attach(&Button1,BUTTON_CONTINUOS,Btn1_Continuos_CallBack); //Press continuously 92 | Button_Attach(&Button1,BUTTON_CONTINUOS_FREE,Btn1_ContinuosFree_CallBack); //Press continuously free 93 | Button_Attach(&Button1,BUTTON_LONG,Btn1_Long_CallBack); //Long press 94 | 95 | 96 | Button_Create("Button2", 97 | &Button2, 98 | Read_KEY2_Level, 99 | KEY_ON); 100 | Button_Attach(&Button2,BUTTON_DOWM,Btn2_Dowm_CallBack); //Click 101 | Button_Attach(&Button2,BUTTON_DOUBLE,Btn2_Double_CallBack); //Double click 102 | Button_Attach(&Button2,BUTTON_CONTINUOS,Btn2_Continuos_CallBack); //Press continuously 103 | Button_Attach(&Button2,BUTTON_CONTINUOS_FREE,Btn2_ContinuosFree_CallBack); //Press continuously free 104 | Button_Attach(&Button2,BUTTON_LONG,Btn2_Long_CallBack); //Long press 105 | 106 | Get_Button_Event(&Button1); 107 | Get_Button_Event(&Button2); 108 | 109 | while(1) 110 | { 111 | 112 | Button_Process(); //Need to call the button handler function periodically 113 | 114 | Delay_ms(20); 115 | 116 | 117 | } 118 | } 119 | 120 | /** 121 | ****************************************************************** 122 | * @brief BSP_Init 123 | * @author jiejie 124 | * @version V1.0 125 | * @date 2018-xx-xx 126 | ****************************************************************** 127 | */ 128 | static void BSP_Init(void) 129 | { 130 | /* LED Config */ 131 | LED_GPIO_Config(); 132 | 133 | /* USART Config */ 134 | USART_Config(); 135 | 136 | /* button config */ 137 | Key_GPIO_Config(); 138 | 139 | 140 | /* print info */ 141 | PRINT_INFO("welcome to learn jiejie stm32 library!\n"); 142 | 143 | } 144 | 145 | 146 | /********************************END OF FILE***************************************/ 147 | --------------------------------------------------------------------------------