├── .gitignore ├── LICENSE.md ├── README.md ├── bitalino.py ├── samples └── sample.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 105 | __pypackages__/ 106 | 107 | # Celery stuff 108 | celerybeat-schedule 109 | celerybeat.pid 110 | 111 | # SageMath parsed files 112 | *.sage.py 113 | 114 | # Environments 115 | .env 116 | .venv 117 | env/ 118 | venv/ 119 | ENV/ 120 | env.bak/ 121 | venv.bak/ 122 | 123 | # Spyder project settings 124 | .spyderproject 125 | .spyproject 126 | 127 | # Rope project settings 128 | .ropeproject 129 | 130 | # mkdocs documentation 131 | /site 132 | 133 | # mypy 134 | .mypy_cache/ 135 | .dmypy.json 136 | dmypy.json 137 | 138 | # Pyre type checker 139 | .pyre/ 140 | 141 | # pytype static type analyzer 142 | .pytype/ 143 | 144 | # Cython debug symbols 145 | cython_debug/ 146 | 147 | # PyCharm 148 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 149 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 150 | # and can be added to the global gitignore or merged into this file. For a more nuclear 151 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 152 | #.idea/ 153 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 | # BITalino (r)evolution Python API 2 | 3 | The BITalino (r)evolution Python API provides the needed tools to interact with BITalino (r)evolution using Python. 4 | 5 | ## Dependencies 6 | 7 | - [Python3.7 +](https://www.python.org/downloads/) 8 | - [NumPy](https://github.com/numpy/numpy) 9 | - [pySerial](https://github.com/pyserial/pyserial) 10 | - [PyBluez](https://github.com/pybluez/pybluez) (Not needed for macOS) 11 | 12 | ## Installation 13 | 14 | Install [**bitalino**](https://pypi.org/project/bitalino/) API package from PyPI: 15 | 16 | ```winbatch 17 | pip install bitalino 18 | ``` 19 | 20 | Or clone this repository and install using pip: 21 | 22 | ```winbatch 23 | git clone https://github.com/BITalinoWorld/revolution-python-api.git 24 | cd revolution-python-api 25 | pip install . 26 | ``` 27 | 28 | ## Documentation 29 | 30 | 31 | 32 | ## Example 33 | 34 | A sample script is available at [**samples**](samples) folder. 35 | 36 | ## License 37 | 38 | This project is licensed under the [GNU GPL v3](LICENSE.md) 39 | -------------------------------------------------------------------------------- /bitalino.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | """ 3 | .. module:: bitalino 4 | :synopsis: BITalino API 5 | 6 | *Created on Fri Jun 20 2014* 7 | 8 | *Last Modified on Thur Jun 25 2015* 9 | """ 10 | __author__ = "Pedro Gonçalves & Carlos Azevedo" 11 | __credits__ = [ 12 | "Carlos Azevedo", 13 | "Pedro Gonçalves", 14 | "Hugo Silva", 15 | "Takuma Hashimoto", 16 | "Rui Freixo", 17 | "Margarida Reis", 18 | ] 19 | __license__ = "GPL" 20 | __version__ = "v3" 21 | __email__ = "bitalino@plux.info" 22 | 23 | 24 | import math 25 | import platform 26 | import re 27 | import select 28 | import socket 29 | import struct 30 | import sys 31 | import time 32 | 33 | import numpy 34 | import serial 35 | 36 | 37 | def find(): 38 | """ 39 | :returns: list of (tuples) with name and MAC address of each device found 40 | 41 | Searches for bluetooth devices nearby. 42 | """ 43 | if platform.system() == "Windows" or platform.system() == "Linux": 44 | try: 45 | import bluetooth 46 | except Exception as e: 47 | raise Exception(ExceptionCode.IMPORT_FAILED + str(e)) 48 | nearby_devices = bluetooth.discover_devices(lookup_names=True) 49 | return nearby_devices 50 | else: 51 | raise Exception(ExceptionCode.INVALID_PLATFORM) 52 | 53 | 54 | class ExceptionCode: 55 | INVALID_ADDRESS = "The specified address is invalid." 56 | INVALID_PLATFORM = "This platform does not support bluetooth connection." 57 | CONTACTING_DEVICE = "The computer lost communication with the device." 58 | DEVICE_NOT_IDLE = "The device is not idle." 59 | DEVICE_NOT_IN_ACQUISITION = "The device is not in acquisition mode." 60 | INVALID_PARAMETER = "Invalid parameter." 61 | INVALID_VERSION = "Only available for Bitalino 2.0." 62 | IMPORT_FAILED = "Please connect using the Virtual COM Port or confirm that PyBluez is installed; bluetooth wrapper failed to import with error: " 63 | 64 | 65 | class BITalino(object): 66 | """ 67 | :param macAddress: MAC address or serial port for the bluetooth device 68 | :type macAddress: str 69 | :param timeout: maximum amount of time (seconds) elapsed while waiting for the device to respond 70 | :type timeout: int, float or None 71 | :raises Exception: invalid MAC address or serial port 72 | :raises Exception: invalid timeout value 73 | 74 | Connects to the bluetooth device with the MAC address or serial port provided. 75 | 76 | Possible values for parameter *macAddress*: 77 | 78 | * MAC address: e.g. ``00:0a:95:9d:68:16`` 79 | * Serial port - device name: depending on the operating system. e.g. ``COM3`` on Windows; ``/dev/tty.bitalino-DevB`` on Mac OS X; ``/dev/ttyUSB0`` on GNU/Linux. 80 | * IP address and port - server: e.g. ``192.168.4.1:8001`` 81 | 82 | Possible values for *timeout*: 83 | 84 | =============== ================================================================ 85 | Value Result 86 | =============== ================================================================ 87 | None Wait forever 88 | X Wait X seconds for a response and raises a connection Exception 89 | =============== ================================================================ 90 | """ 91 | 92 | def __init__(self, macAddress, timeout=None): 93 | regCompiled = re.compile("^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$") 94 | checkMatch = re.match(regCompiled, macAddress) 95 | self.isPython2 = True if sys.version_info[0] == 2 else False 96 | self.blocking = True if timeout is None else False 97 | if not self.blocking: 98 | try: 99 | self.timeout = float(timeout) 100 | except Exception: 101 | raise Exception(ExceptionCode.INVALID_PARAMETER) 102 | if checkMatch: 103 | if platform.system() == "Windows" or platform.system() == "Linux": 104 | try: 105 | import bluetooth 106 | except Exception as e: 107 | raise Exception(ExceptionCode.IMPORT_FAILED + str(e)) 108 | self.socket = bluetooth.BluetoothSocket(bluetooth.RFCOMM) 109 | self.socket.connect((macAddress, 1)) 110 | self.wifi = False 111 | self.serial = False 112 | else: 113 | raise Exception(ExceptionCode.INVALID_PLATFORM) 114 | elif (macAddress[0:3] == "COM" and platform.system() == "Windows") or ( 115 | macAddress[0:5] == "/dev/" and platform.system() != "Windows" 116 | ): 117 | self.socket = serial.Serial(macAddress, 115200) 118 | self.wifi = False 119 | self.serial = True 120 | elif macAddress.count(":") == 1: 121 | self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 122 | self.socket.connect((macAddress.split(":")[0], int(macAddress.split(":")[1]))) 123 | self.wifi = True 124 | self.serial = False 125 | else: 126 | raise Exception(ExceptionCode.INVALID_ADDRESS) 127 | self.started = False 128 | self.macAddress = macAddress 129 | split_string = "_v" 130 | split_string_old = "V" 131 | version = self.version() 132 | if split_string in version: 133 | version_nbr = float(version.split(split_string)[1][:3]) 134 | else: 135 | version_nbr = float(version.split(split_string_old)[1][:3]) 136 | self.isBitalino2 = True if version_nbr >= 4.2 else False 137 | self.isBitalino52 = True if version_nbr >= 5.2 else False 138 | 139 | def start(self, SamplingRate=1000, analogChannels=[0, 1, 2, 3, 4, 5]): 140 | """ 141 | :param SamplingRate: sampling frequency (Hz) 142 | :type SamplingRate: int 143 | :param analogChannels: channels to be acquired 144 | :type analogChannels: array, tuple or list of int 145 | :raises Exception: device already in acquisition (not IDLE) 146 | :raises Exception: sampling rate not valid 147 | :raises Exception: list of analog channels not valid 148 | 149 | Sets the sampling rate and starts acquisition in the analog channels set. 150 | Setting the sampling rate and starting the acquisition implies the use of the method :meth:`send`. 151 | 152 | Possible values for parameter *SamplingRate*: 153 | 154 | * 1 155 | * 10 156 | * 100 157 | * 1000 158 | 159 | Possible values, types, configurations and examples for parameter *analogChannels*: 160 | 161 | =============== ==================================== 162 | Values 0, 1, 2, 3, 4, 5 163 | Types list ``[]``, tuple ``()``, array ``[[]]`` 164 | Configurations Any number of channels, identified by their value 165 | Examples ``[0, 3, 4]``, ``(1, 2, 3, 5)`` 166 | =============== ==================================== 167 | 168 | .. note:: To obtain the samples, use the method :meth:`read`. 169 | """ 170 | if self.started is False: 171 | if int(SamplingRate) not in [1, 10, 100, 1000]: 172 | raise Exception(ExceptionCode.INVALID_PARAMETER) 173 | 174 | # CommandSRate: 0 0 0 0 1 1 175 | if int(SamplingRate) == 1000: 176 | commandSRate = 3 177 | elif int(SamplingRate) == 100: 178 | commandSRate = 2 179 | elif int(SamplingRate) == 10: 180 | commandSRate = 1 181 | elif int(SamplingRate) == 1: 182 | commandSRate = 0 183 | 184 | if isinstance(analogChannels, list): 185 | analogChannels = analogChannels 186 | elif isinstance(analogChannels, tuple): 187 | analogChannels = list(analogChannels) 188 | elif isinstance(analogChannels, numpy.ndarray): 189 | analogChannels = analogChannels.astype("int").tolist() 190 | else: 191 | raise Exception(ExceptionCode.INVALID_PARAMETER) 192 | 193 | analogChannels = list(set(analogChannels)) 194 | 195 | if ( 196 | len(analogChannels) == 0 197 | or len(analogChannels) > 6 198 | or any([item not in range(6) or type(item) != int for item in analogChannels]) 199 | ): 200 | raise Exception(ExceptionCode.INVALID_PARAMETER) 201 | 202 | self.send((commandSRate << 6) | 0x03) 203 | 204 | # CommandStart: A6 A5 A4 A3 A2 A1 0 1 205 | commandStart = 1 206 | for i in analogChannels: 207 | commandStart = commandStart | 1 << (2 + i) 208 | 209 | self.send(commandStart) 210 | self.started = True 211 | self.analogChannels = analogChannels 212 | else: 213 | raise Exception(ExceptionCode.DEVICE_NOT_IDLE) 214 | 215 | def stop(self): 216 | """ 217 | :raises Exception: device not in acquisition (IDLE) 218 | 219 | Stops the acquisition. Stoping the acquisition implies the use of the method :meth:`send`. 220 | """ 221 | if self.started: 222 | self.send(0) 223 | else: 224 | if self.isBitalino2: 225 | # Command: 1 1 1 1 1 1 1 1 - Go to idle mode from all modes. 226 | self.send(255) 227 | else: 228 | raise Exception(ExceptionCode.DEVICE_NOT_IN_ACQUISITION) 229 | self.started = False 230 | 231 | def close(self): 232 | """ 233 | Closes the bluetooth or serial port socket. 234 | """ 235 | if self.wifi: 236 | self.socket.settimeout(1.0) # force a timeout on TCP/IP sockets 237 | try: 238 | self.receive(1024) # receive any pending data 239 | self.socket.shutdown(socket.SHUT_RDWR) 240 | self.socket.close() 241 | except socket.timeout: 242 | self.socket.shutdown(socket.SHUT_RDWR) 243 | self.socket.close() 244 | else: 245 | self.socket.close() 246 | 247 | def send(self, data): 248 | """ 249 | Sends a command to the BITalino device. 250 | """ 251 | time.sleep(0.1) 252 | if self.serial: 253 | if self.isPython2: 254 | self.socket.write(chr(data)) 255 | else: 256 | self.socket.write(bytes([data])) 257 | else: 258 | if self.isPython2: 259 | self.socket.send(chr(data)) 260 | else: 261 | self.socket.send(bytes([data])) 262 | 263 | def battery(self, value=0): 264 | """ 265 | :param value: threshold value 266 | :type value: int 267 | :raises Exception: device in acquisition (not IDLE) 268 | :raises Exception: threshold value is invalid 269 | 270 | Sets the battery threshold for the BITalino device. Setting the battery threshold implies the use of the method :meth:`send`. 271 | 272 | Possible values for parameter *value*: 273 | 274 | =============== ======= ===================== 275 | Range *value* Corresponding threshold (Volts) 276 | =============== ======= ===================== 277 | Minimum *value* 0 3.4 Volts 278 | Maximum *value* 63 3.8 Volts 279 | =============== ======= ===================== 280 | """ 281 | if self.started is False: 282 | if 0 <= int(value) <= 63: 283 | # CommandBattery: 0 0 284 | commandBattery = int(value) << 2 285 | self.send(commandBattery) 286 | else: 287 | raise Exception(ExceptionCode.INVALID_PARAMETER) 288 | else: 289 | raise Exception(ExceptionCode.DEVICE_NOT_IDLE) 290 | 291 | def pwm(self, pwmOutput=100): 292 | """ 293 | :param pwmOutput: value for the pwm output 294 | :type pwmOutput: int 295 | :raises Exception: invalid pwm output value 296 | :raises Exception: device is not a BITalino 2.0 297 | 298 | Sets the pwm output for the BITalino 2.0 device. Implies the use of the method :meth:`send`. 299 | 300 | Possible values for parameter *pwmOutput*: 0 - 255. 301 | """ 302 | if self.isBitalino2: 303 | if 0 <= int(pwmOutput) <= 255: 304 | self.send(163) 305 | self.send(pwmOutput) 306 | else: 307 | raise Exception(ExceptionCode.INVALID_PARAMETER) 308 | else: 309 | raise Exception(ExceptionCode.INVALID_VERSION) 310 | 311 | def state(self): 312 | """ 313 | :returns: dictionary with the state of all channels 314 | :raises Exception: device is not a BITalino version 2.0 315 | :raises Exception: device in acquisition (not IDLE) 316 | :raises Exception: lost communication with the device when data is corrupted 317 | 318 | Returns the state of all analog and digital channels. Reading channel State from BITalino implies the use of the method :meth:`send` and :meth:`receive`. 319 | The returned dictionary structure contains the following key-value pairs: 320 | 321 | ================= ================================ ============== ===================== 322 | Key Value Type Examples 323 | ================= ================================ ============== ===================== 324 | analogChannels Value of all analog channels Array of int [A1 A2 A3 A4 A5 A6] 325 | battery Value of the battery channel int 326 | batteryThreshold Value of the battery threshold int :meth:`battery` 327 | digitalChannels Value of all digital channels Array of int [I1 I2 O1 O2] 328 | ================= ================================ ============== ===================== 329 | """ 330 | if self.isBitalino2: 331 | if self.started is False: 332 | # CommandState: 0 0 0 0 1 0 1 1 333 | # Response: 334 | # 335 | # 336 | # 337 | # )> 338 | self.send(11) 339 | if self.isBitalino52: 340 | number_bytes = 17 341 | else: 342 | number_bytes = 16 343 | Data = self.receive(number_bytes) 344 | decodedData = list(struct.unpack(number_bytes * "B ", Data)) 345 | crc = decodedData[-1] & 0x0F 346 | decodedData[-1] = decodedData[-1] & 0xF0 347 | x = 0 348 | for i in range(number_bytes): 349 | for bit in range(7, -1, -1): 350 | x = x << 1 351 | if x & 0x10: 352 | x = x ^ 0x03 353 | x = x ^ ((decodedData[i] >> bit) & 0x01) 354 | if crc == x & 0x0F: 355 | digitalPorts = [] 356 | digitalPorts.append(decodedData[-1] >> 7 & 0x01) 357 | digitalPorts.append(decodedData[-1] >> 6 & 0x01) 358 | digitalPorts.append(decodedData[-1] >> 5 & 0x01) 359 | digitalPorts.append(decodedData[-1] >> 4 & 0x01) 360 | offset = 0 361 | if self.isBitalino52: 362 | offset = -1 363 | batteryThreshold = decodedData[-2 + offset] 364 | battery = decodedData[-3 + offset] << 8 | decodedData[-4 + offset] 365 | A6 = decodedData[-5 + offset] << 8 | decodedData[-6 + offset] 366 | A5 = decodedData[-7 + offset] << 8 | decodedData[-8 + offset] 367 | A4 = decodedData[-9 + offset] << 8 | decodedData[-10 + offset] 368 | A3 = decodedData[-11 + offset] << 8 | decodedData[-12 + offset] 369 | A2 = decodedData[-13 + offset] << 8 | decodedData[-14 + offset] 370 | A1 = decodedData[-15 + offset] << 8 | decodedData[-16 + offset] 371 | acquiredData = {} 372 | acquiredData["analogChannels"] = [A1, A2, A3, A4, A5, A6] 373 | acquiredData["battery"] = battery 374 | acquiredData["batteryThreshold"] = batteryThreshold 375 | acquiredData["digitalChannels"] = digitalPorts 376 | return acquiredData 377 | else: 378 | raise Exception(ExceptionCode.CONTACTING_DEVICE) 379 | else: 380 | raise Exception(ExceptionCode.DEVICE_NOT_IDLE) 381 | else: 382 | raise Exception(ExceptionCode.INVALID_VERSION) 383 | 384 | def trigger(self, digitalArray=None): 385 | """ 386 | :param digitalArray: array which acts on digital outputs according to the value: 0 or 1 387 | :type digitalArray: array, tuple or list of int 388 | :raises Exception: list of digital channel output is not valid 389 | :raises Exception: device not in acquisition (IDLE) (for BITalino 1.0) 390 | 391 | Acts on digital output channels of the BITalino device. Triggering these digital outputs implies the use of the method :meth:`send`. 392 | Digital Outputs can be set on IDLE or while in acquisition for BITalino 2.0. 393 | 394 | Each position of the array *digitalArray* corresponds to a digital output, in ascending order. Possible values, types, configurations and examples for parameter *digitalArray*: 395 | 396 | =============== ============================================== ============================================== 397 | Meta BITalino 1.0 BITalino 2.0 398 | =============== ============================================== ============================================== 399 | Values 0 or 1 0 or 1 400 | Types list ``[]``, tuple ``()``, array ``[[]]`` list ``[]``, tuple ``()``, array ``[[]]`` 401 | Configurations 4 values, one for each digital channel output 2 values, one for each digital channel output 402 | Examples ``[1, 0, 1, 0]`` ``[1, 0]`` 403 | =============== ============================================== ============================================== 404 | """ 405 | arraySize = 2 if self.isBitalino2 else 4 406 | if not self.isBitalino2 and not self.started: 407 | raise Exception(ExceptionCode.DEVICE_NOT_IN_ACQUISITION) 408 | else: 409 | digitalArray = [0 for i in range(arraySize)] if digitalArray is None else digitalArray 410 | if isinstance(digitalArray, list): 411 | digitalArray = digitalArray 412 | elif isinstance(digitalArray, tuple): 413 | digitalArray = list(digitalArray) 414 | elif isinstance(digitalArray, numpy.ndarray): 415 | digitalArray = digitalArray.astype("int").tolist() 416 | else: 417 | raise Exception(ExceptionCode.INVALID_PARAMETER) 418 | 419 | pValues = [0, 1] 420 | if len(digitalArray) != arraySize or any( 421 | [item not in pValues or type(item) != int for item in digitalArray] 422 | ): 423 | raise Exception(ExceptionCode.INVALID_PARAMETER) 424 | 425 | if self.isBitalino2: 426 | # CommandDigital: 1 0 1 1 O2 O1 1 1 - Set digital outputs 427 | data = 179 428 | else: 429 | # CommandDigital: 1 0 O4 O3 O2 O1 1 1 - Set digital outputs 430 | data = 3 431 | 432 | for i, j in enumerate(digitalArray): 433 | data = data | j << (2 + i) 434 | self.send(data) 435 | 436 | def read(self, nSamples=100): 437 | """ 438 | :param nSamples: number of samples to acquire 439 | :type nSamples: int 440 | :returns: array with the acquired data 441 | :raises Exception: device not in acquisition (in IDLE) 442 | :raises Exception: lost communication with the device when data is corrupted 443 | 444 | Acquires `nSamples` from BITalino. Reading samples from BITalino implies the use of the method :meth:`receive`. 445 | 446 | Requiring a low number of samples (e.g. ``nSamples = 1``) may be computationally expensive; it is recommended to acquire batches of samples (e.g. ``nSamples = 100``). 447 | 448 | The data acquired is organized in a matrix whose lines correspond to samples and the columns are as follows: 449 | 450 | * Sequence Number 451 | * 4 Digital Channels (always present) 452 | * 1-6 Analog Channels (as defined in the :meth:`start` method) 453 | 454 | Example matrix for ``analogChannels = [0, 1, 3]`` used in :meth:`start` method: 455 | 456 | ================== ========= ========= ========= ========= ======== ======== ======== 457 | Sequence Number* Digital 0 Digital 1 Digital 2 Digital 3 Analog 0 Analog 1 Analog 3 458 | ================== ========= ========= ========= ========= ======== ======== ======== 459 | 0 460 | 1 461 | (...) 462 | 15 463 | 0 464 | 1 465 | (...) 466 | ================== ========= ========= ========= ========= ======== ======== ======== 467 | 468 | .. note:: *The sequence number overflows at 15 469 | """ 470 | if self.started: 471 | nChannels = len(self.analogChannels) 472 | 473 | if nChannels <= 4: 474 | number_bytes = int(math.ceil((12.0 + 10.0 * nChannels) / 8.0)) 475 | else: 476 | number_bytes = int(math.ceil((52.0 + 6.0 * (nChannels - 4)) / 8.0)) 477 | 478 | dataAcquired = numpy.zeros((nSamples, 5 + nChannels), dtype=int) 479 | for sample in range(nSamples): 480 | Data = self.receive(number_bytes) 481 | decodedData = list(struct.unpack(number_bytes * "B ", Data)) 482 | crc = decodedData[-1] & 0x0F 483 | decodedData[-1] = decodedData[-1] & 0xF0 484 | x = 0 485 | for i in range(number_bytes): 486 | for bit in range(7, -1, -1): 487 | x = x << 1 488 | if x & 0x10: 489 | x = x ^ 0x03 490 | x = x ^ ((decodedData[i] >> bit) & 0x01) 491 | if crc == x & 0x0F: 492 | dataAcquired[sample, 0] = decodedData[-1] >> 4 493 | dataAcquired[sample, 1] = decodedData[-2] >> 7 & 0x01 494 | dataAcquired[sample, 2] = decodedData[-2] >> 6 & 0x01 495 | dataAcquired[sample, 3] = decodedData[-2] >> 5 & 0x01 496 | dataAcquired[sample, 4] = decodedData[-2] >> 4 & 0x01 497 | if nChannels > 0: 498 | dataAcquired[sample, 5] = ((decodedData[-2] & 0x0F) << 6) | ( 499 | decodedData[-3] >> 2 500 | ) 501 | if nChannels > 1: 502 | dataAcquired[sample, 6] = ((decodedData[-3] & 0x03) << 8) | decodedData[-4] 503 | if nChannels > 2: 504 | dataAcquired[sample, 7] = (decodedData[-5] << 2) | (decodedData[-6] >> 6) 505 | if nChannels > 3: 506 | dataAcquired[sample, 8] = ((decodedData[-6] & 0x3F) << 4) | ( 507 | decodedData[-7] >> 4 508 | ) 509 | if nChannels > 4: 510 | dataAcquired[sample, 9] = ((decodedData[-7] & 0x0F) << 2) | ( 511 | decodedData[-8] >> 6 512 | ) 513 | if nChannels > 5: 514 | dataAcquired[sample, 10] = decodedData[-8] & 0x3F 515 | else: 516 | raise Exception(ExceptionCode.CONTACTING_DEVICE) 517 | return dataAcquired 518 | else: 519 | raise Exception(ExceptionCode.DEVICE_NOT_IN_ACQUISITION) 520 | 521 | def version(self): 522 | """ 523 | :returns: str with the version of BITalino 524 | :raises Exception: device in acquisition (not IDLE) 525 | 526 | Retrieves the BITalino version. Retrieving the version implies the use of the methods :meth:`send` and :meth:`receive`. 527 | """ 528 | if self.started is False: 529 | # CommandVersion: 0 0 0 0 0 1 1 1 530 | self.send(7) 531 | version_str = "" 532 | while True: 533 | if self.isPython2: 534 | version_str += self.receive(1) 535 | else: 536 | version_str += self.receive(1).decode("utf-8") 537 | if version_str[-1] == "\n" and "BITalino" in version_str: 538 | break 539 | return version_str[version_str.index("BITalino") : -1] 540 | else: 541 | raise Exception(ExceptionCode.DEVICE_NOT_IDLE) 542 | 543 | def receive(self, nbytes): 544 | """ 545 | :param nbytes: number of bytes to retrieve 546 | :type nbytes: int 547 | :return: string packed binary data 548 | :raises Exception: lost communication with the device when timeout is reached 549 | 550 | Retrieves `nbytes` from the BITalino device and returns it as a string pack with length of `nbytes`. The timeout is defined on instantiation. 551 | """ 552 | if self.isPython2: 553 | data = "" 554 | else: 555 | data = b"" 556 | if self.serial: 557 | while len(data) < nbytes: 558 | if not self.blocking: 559 | initTime = time.time() 560 | while self.socket.inWaiting() < 1: 561 | finTime = time.time() 562 | if (finTime - initTime) > self.timeout: 563 | raise Exception(ExceptionCode.CONTACTING_DEVICE) 564 | data += self.socket.read(1) 565 | else: 566 | while len(data) < nbytes: 567 | if not self.blocking: 568 | ready = select.select([self.socket], [], [], self.timeout) 569 | if ready[0]: 570 | pass 571 | else: 572 | raise Exception(ExceptionCode.CONTACTING_DEVICE) 573 | data += self.socket.recv(1) 574 | return data 575 | 576 | 577 | if __name__ == "__main__": 578 | macAddress = "00:00:00:00:00:00" 579 | 580 | running_time = 5 581 | 582 | batteryThreshold = 30 583 | acqChannels = [0, 1, 2, 3, 4, 5] 584 | samplingRate = 1000 585 | nSamples = 10 586 | digitalOutput = [1, 1] 587 | 588 | # Connect to BITalino 589 | device = BITalino(macAddress) 590 | 591 | # Set battery threshold 592 | device.battery(batteryThreshold) 593 | 594 | # Read BITalino version 595 | print(device.version()) 596 | 597 | # Start Acquisition 598 | device.start(samplingRate, acqChannels) 599 | 600 | start = time.time() 601 | end = time.time() 602 | while (end - start) < running_time: 603 | # Read samples 604 | print(device.read(nSamples)) 605 | end = time.time() 606 | 607 | # Turn BITalino led on 608 | device.trigger(digitalOutput) 609 | 610 | # Stop acquisition 611 | device.stop() 612 | 613 | # Close connection 614 | device.close() 615 | -------------------------------------------------------------------------------- /samples/sample.py: -------------------------------------------------------------------------------- 1 | import time 2 | 3 | from bitalino import BITalino 4 | 5 | # The macAddress variable on Windows can be "XX:XX:XX:XX:XX:XX" or "COMX" 6 | # while on Mac OS can be "/dev/tty.BITalino-XX-XX-DevB" for devices ending with the last 4 digits of the MAC address or "/dev/tty.BITalino-DevB" for the remaining 7 | macAddress = "00:00:00:00:00:00" 8 | 9 | # This example will collect data for 5 sec. 10 | running_time = 5 11 | 12 | batteryThreshold = 30 13 | acqChannels = [0, 1, 2, 3, 4, 5] 14 | samplingRate = 1000 15 | nSamples = 10 16 | digitalOutput_on = [1, 1] 17 | digitalOutput_off = [0, 0] 18 | 19 | # Connect to BITalino 20 | device = BITalino(macAddress) 21 | 22 | # Set battery threshold 23 | device.battery(batteryThreshold) 24 | 25 | # Read BITalino version 26 | print(device.version()) 27 | 28 | # Start Acquisition 29 | device.start(samplingRate, acqChannels) 30 | 31 | start = time.time() 32 | end = time.time() 33 | while (end - start) < running_time: 34 | # Read samples 35 | print(device.read(nSamples)) 36 | end = time.time() 37 | 38 | # Turn BITalino led and buzzer on 39 | device.trigger(digitalOutput_on) 40 | 41 | # Script sleeps for n seconds 42 | time.sleep(running_time) 43 | 44 | # Turn BITalino led and buzzer off 45 | device.trigger(digitalOutput_off) 46 | 47 | # Stop acquisition 48 | device.stop() 49 | 50 | # Close connection 51 | device.close() 52 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | BITalino (R)evolution Python API 3 | 4 | Setup for package installation. 5 | """ 6 | 7 | import sys 8 | 9 | from setuptools import setup 10 | 11 | if sys.version_info[:2] < (3, 7): 12 | raise RuntimeError("Python version >= 3.7 required.") 13 | 14 | 15 | def readme(): 16 | with open("README.md", "r") as f: 17 | description = f.read() 18 | return description 19 | 20 | 21 | setup( 22 | name="bitalino", 23 | version="1.2.6", 24 | author="BITalinoWorld", 25 | author_email="bitalino@plux.info", 26 | url="http://www.bitalino.com/", 27 | py_modules=["bitalino"], 28 | description="revolution-python-api", 29 | long_description=readme(), 30 | download_url="https://github.com/BITalinoWorld/revolution-python-api", 31 | classifiers=[ 32 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 33 | "Programming Language :: Python", 34 | "Programming Language :: Python :: 3.7", 35 | "Programming Language :: Python :: 3.8", 36 | "Programming Language :: Python :: 3.9", 37 | "Programming Language :: Python :: 3.10", 38 | "Topic :: Scientific/Engineering", 39 | "Topic :: Software Development :: Libraries", 40 | ], 41 | license="GNU GPL v3", 42 | keywords="BITalino, Physiological Computing, Biosignal, Physiological Signal", 43 | python_requires=">=3.7", 44 | install_requires=[ 45 | "numpy>1.19", 46 | "pyserial==3.5", 47 | "PyBluez-bitalino==0.30", 48 | ], 49 | zip_safe=False, 50 | ) 51 | --------------------------------------------------------------------------------