├── .coveragerc ├── .gitignore ├── .travis.yml ├── AUTHORS ├── COPYING ├── README.rst ├── pylacrosse ├── __init__.py ├── cli_tool.py └── lacrosse.py ├── setup.py └── tests ├── __init__.py └── test_lacrosse.py /.coveragerc: -------------------------------------------------------------------------------- 1 | [report] 2 | omit = 3 | */python?.?/* 4 | */site-packages/nose/* 5 | */tests/* 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.egg-info/ 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | python: 4 | - '2.7' 5 | - '3.5' 6 | - '3.6' 7 | - '3.7' 8 | install: 9 | - pip install python-coveralls 10 | - pip install coverage 11 | - pip install nose 12 | - pip install future 13 | - pip install pyserial 14 | script: 15 | - python setup.py install 16 | - nosetests --with-coverage 17 | after_success: 18 | - coveralls 19 | 20 | jobs: 21 | include: 22 | - stage: PyPi deploy 23 | script: true 24 | python: 3.6 25 | deploy: 26 | provider: pypi 27 | user: hthiery 28 | password: 29 | secure: wtLnhUD1A2hOv4c1Yha/UtiLtVpObSlHnSOM1+BlQvuYKIwYl8lWvb7pYFLIasCtwBlzWTxTUHhylI1N3VES/+yRAdd0sSAVa5hJIZHMH0r2u+Q02PKIKpCgpm8PhekaKtB1DK7/2bEDQpc23/bu96SNl0qxSlREcdyOptbvJs7+BAKvbDkcA/EQHOKkofFvFnzkyNLxCZNeOajBh7oyANsBBsxc3sMh6VTI2JHUR80jveSspe60fptDdO6JBcOY8vBx9A0Ezp7D/kDs+TQoyVc/9eexowGr6W1AhTcEqsWe/9fT332/Y6A64RP4KBqdm9Ok4FC9TO1QiX+q9foPLjuQDbVWyYh9AiidU9TwRO6SxE0uskYCKl1vl0aBqjj9Z7AGOFwCjJ7nlu0VJkVI0tIm875ZYiSLDxdqmfpNYcEmoWhT3UswyFAMMbptP/fhc+qvUAtcppgfHqd/fi6RlF7VJnNhm1TP9IOU9wL2mIkXwp7YDENqcTq0kxKGkZ+pHjX32duiP/od9+FUV3qzOxdaYtJTPddbV/Q16EL/5ZdmhCQXaOx4HKqMurOnRWX9ESpTGPPeSwC3TFD71XK+ylLOz9jId+9sMSVthHKD1cD4C+34ZkshJrxBWvG9eC8UVHNmL62wAxDO+LN2rCmotUBqZvYAJaDgBvx6IK/YWPg= 30 | on: 31 | tags: true 32 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Heiko Thiery 2 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Pure Python Jeelink LaCrosse Library 2 | ==================================== 3 | 4 | |BuildStatus| |PypiVersion| |PyPiPythonVersions| |Coveralls| |CodeClimate| 5 | 6 | 7 | Requirements 8 | ------------ 9 | 10 | This library works with the `Jeelink`_ USB RF adapter and the Arduino `sketch`_ hosted on the `FHEM`_ website. 11 | 12 | Tested Devices 13 | -------------- 14 | * Technoline TX 29IT 15 | * Technoline TX 29DTH-IT 16 | 17 | Command Line Tool 18 | ----------------- 19 | 20 | .. code :: shell 21 | 22 | # pylacrosse -h 23 | usage: LaCrosse sensor CLI tool. [-h] [-v] [-d DEVICE] [-f FREQUENCY_RFM1] 24 | [-F FREQUENCY_RFM2] [-t TOGGLE_INTERVAL_RFM1] 25 | [-T TOGGLE_INTERVAL_RFM2] 26 | [-m TOGGLE_MASK_RFM1] [-M TOGGLE_MASK_RFM2] 27 | [-r DATARATE_RFM1] [-R DATARATE_RFM2] 28 | {scan,info,led} ... 29 | 30 | optional arguments: 31 | -h, --help show this help message and exit 32 | -v be more verbose 33 | -d DEVICE, --device DEVICE 34 | set local device e.g. '/dev/ttyUSB0' or 35 | set remote device e.g. 'rfc2217://[IP]:[PORT]' 36 | default: '/dev/ttyUSB0' 37 | -f FREQUENCY_RFM1 set the frequency for RFM1 38 | -F FREQUENCY_RFM2 set the frequency for RFM2 39 | -t TOGGLE_INTERVAL_RFM1 40 | set the toggle interval for RFM1 41 | -T TOGGLE_INTERVAL_RFM2 42 | set the toggle interval for RFM2 43 | -m TOGGLE_MASK_RFM1 set the toggle mask for RFM1 44 | -M TOGGLE_MASK_RFM2 set the toggle mask for RFM2 45 | -r DATARATE_RFM1 set the datarate for RFM1 46 | -R DATARATE_RFM2 set the datarate for RFM2 47 | 48 | Commands: 49 | {scan,info,led} 50 | scan Show all received sensors 51 | info Get configuration info 52 | led Set traffic LED state 53 | 54 | 55 | The LaCrosse sensor generates the ID every time the battery is changed. 56 | 57 | Use the cli tool ``pylacrosse`` to find your device: 58 | 59 | .. code :: shell 60 | 61 | # pylacrosse -d /dev/ttyUSB0 scan 62 | id=40 t=16.000000 h=69 nbat=0 name=unknown 63 | id=16 t=18.700000 h=60 nbat=0 name=unknown 64 | id=0 t=17.400000 h=65 nbat=0 name=unknown 65 | 66 | You can generate a file with know devices at ``~/.lacrosse/known_sensors.ini`` 67 | 68 | .. code :: shell 69 | 70 | [0] 71 | name = Kitchen 72 | [16] 73 | name = Livingroom 74 | [40] 75 | name = Bedroom 76 | 77 | then the tool will print the defined names 78 | 79 | .. code :: shell 80 | 81 | # pylacrosse -d /dev/ttyUSB0 scan 82 | id=40 t=16.000000 h=69 nbat=0 name=Bedroom 83 | id=16 t=18.700000 h=60 nbat=0 name=Livingroom 84 | id=0 t=17.400000 h=65 nbat=0 name=Kitchen 85 | 86 | Using remote serial port with ser2net 87 | ------------------------------------- 88 | 89 | You can also use ``ser2net`` to connect to a remote JeeLink Adapter. This can be useful, if you use 90 | a Docker container or if you can not attach a JeeLink adapter to your host running ``pylacrosse``. On your 91 | remote device install ``ser2net`` and add the following line to your ``ser2net.conf`` file: 92 | 93 | .. code :: shell 94 | 95 | 20001:telnet:0:/dev/ttyUSB0:57600 remctl banner 96 | 97 | Restart the ``ser2net`` daemon and connect to your remote host using ``pylacrosse`` command line tool: 98 | 99 | .. code :: shell 100 | 101 | # pylacrosse -d rfc2217://[REMOTE_IP]]:20001 scan 102 | id=40 t=16.000000 h=69 nbat=0 name=Bedroom 103 | id=16 t=18.700000 h=60 nbat=0 name=Livingroom 104 | id=0 t=17.400000 h=65 nbat=0 name=Kitchen 105 | 106 | .. _Jeelink: https://www.digitalsmarties.net/products/jeelink 107 | .. _sketch: https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip 108 | .. _FHEM: https://wiki.fhem.de/wiki/JeeLink 109 | 110 | .. |BuildStatus| image:: https://travis-ci.org/hthiery/python-lacrosse.png?branch=master 111 | :target: https://travis-ci.org/hthiery/python-lacrosse 112 | .. |PyPiVersion| image:: https://badge.fury.io/py/pylacrosse.svg 113 | :target: http://badge.fury.io/py/pylacrosse 114 | .. |PyPiPythonVersions| image:: https://img.shields.io/pypi/pyversions/pylacrosse.svg 115 | :alt: Python versions 116 | :target: http://badge.fury.io/py/pylacrosse 117 | .. |CodeClimate| image:: https://api.codeclimate.com/v1/badges/fc83491ef0ae81080882/maintainability 118 | :target: https://codeclimate.com/github/hthiery/python-lacrosse/maintainability 119 | :alt: Maintainability 120 | .. |Coveralls| image:: https://coveralls.io/repos/github/hthiery/python-lacrosse/badge.svg?branch=master 121 | :target: https://coveralls.io/github/hthiery/python-lacrosse?branch=master 122 | -------------------------------------------------------------------------------- /pylacrosse/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2017 Heiko Thiery 2 | # 3 | # This library is free software; you can redistribute it and/or 4 | # modify it under the terms of the GNU Lesser General Public 5 | # License as published by the Free Software Foundation; either 6 | # version 2.1 of the License, or (at your option) any later version. 7 | # 8 | # This library is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | # Lesser General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU Lesser General Public 14 | # License along with this library; if not, write to the Free Software 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 16 | # USA 17 | 18 | from .lacrosse import LaCrosse, LaCrosseSensor 19 | -------------------------------------------------------------------------------- /pylacrosse/cli_tool.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2017 Heiko Thiery 2 | # 3 | # This library is free software; you can redistribute it and/or 4 | # modify it under the terms of the GNU Lesser General Public 5 | # License as published by the Free Software Foundation; either 6 | # version 2.1 of the License, or (at your option) any later version. 7 | # 8 | # This library is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | # Lesser General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU Lesser General Public 14 | # License along with this library; if not, write to the Free Software 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 16 | # USA 17 | 18 | import argparse 19 | import codecs 20 | import logging 21 | import os 22 | import time 23 | try: 24 | from ConfigParser import (SafeConfigParser, NoOptionError) 25 | except ImportError: 26 | from configparser import (ConfigParser, NoOptionError) 27 | 28 | import pylacrosse 29 | 30 | _LOGGER = logging.getLogger(__name__) 31 | 32 | DEFAULT_DEVICE = '/dev/ttyUSB0' 33 | def get_known_sensor_name(sensor_id, config): 34 | try: 35 | if str(sensor_id) in config.sections(): 36 | name = config.get(str(sensor_id), 'name') 37 | return name 38 | except NoOptionError as e: 39 | return 'unknown' 40 | except AttributeError: 41 | return 'unknown' 42 | return 'unknown' 43 | 44 | 45 | def scan_callback(sensor, config): 46 | name = get_known_sensor_name(sensor.sensorid, config) 47 | print('%s name=%s' % (sensor, name)) 48 | 49 | 50 | def configure(lacrosse, config, args): 51 | if args.frequency_rfm1: 52 | lacrosse.set_frequency(args.frequency_rfm1, 1) 53 | if args.frequency_rfm2: 54 | lacrosse.set_frequency(args.frequency_rfm2, 2) 55 | 56 | if args.datarate_rfm1: 57 | lacrosse.set_datarate(args.datarate_rfm1, 1) 58 | if args.datarate_rfm2: 59 | lacrosse.set_datarate(args.datarate_rfm1, 2) 60 | 61 | if args.toggle_mask_rfm1: 62 | lacrosse.set_toggle_mask(args.toggle_mask_rfm1, 1) 63 | if args.toggle_mask_rfm2: 64 | lacrosse.set_toggle_mask(args.toggle_mask_rfm2, 2) 65 | 66 | if args.toggle_interval_rfm1: 67 | lacrosse.set_toggle_interval(args.toggle_interval_rfm1, 1) 68 | if args.toggle_interval_rfm2: 69 | lacrosse.set_toggle_interval(args.toggle_interval_rfm1, 2) 70 | 71 | 72 | def scan(lacrosse, config, args): 73 | lacrosse.register_all(scan_callback, user_data=config) 74 | lacrosse.start_scan() 75 | while True: 76 | time.sleep(1) 77 | 78 | def get_info(lacrosse, config, args): 79 | info = lacrosse.get_info() 80 | print('name: {}'.format(info['name'])) 81 | print('version: {}'.format(info['version'])) 82 | if 'rfm1name' in info: 83 | print('rfm1name: {}'.format(info['rfm1name'])) 84 | print('rfm1frequency: {}'.format(info['rfm1frequency'])) 85 | print('rfm1datarate: {}'.format(info['rfm1datarate'])) 86 | print('rfm1toggleinterval: {}'.format(info['rfm1toggleinterval'])) 87 | print('rfm1togglemask: {}'.format(info['rfm1togglemask'])) 88 | 89 | def led(lacrosse, config, args): 90 | state = args.led_state.lower() == 'on' 91 | lacrosse.led_config(state) 92 | 93 | def main(args=None): 94 | parser = argparse.ArgumentParser('LaCrosse sensor CLI tool.', formatter_class=argparse.RawTextHelpFormatter) 95 | parser.add_argument('-v', action='store_true', dest='verbose', 96 | help='be more verbose') 97 | parser.add_argument('-d', '--device', type=str, dest='device', 98 | help='set local device e.g. \'{0}\' or\n' 99 | 'set remote device e.g. \'rfc2217://[IP]:[PORT]\'\n' 100 | 'default: \'{0}\''.format(DEFAULT_DEVICE), 101 | default=DEFAULT_DEVICE) 102 | parser.add_argument('-f', type=str, dest='frequency_rfm1', 103 | help='set the frequency for RFM1') 104 | parser.add_argument('-F', type=str, dest='frequency_rfm2', 105 | help='set the frequency for RFM2') 106 | parser.add_argument('-t', type=str, dest='toggle_interval_rfm1', 107 | help='set the toggle interval for RFM1') 108 | parser.add_argument('-T', type=str, dest='toggle_interval_rfm2', 109 | help='set the toggle interval for RFM2') 110 | parser.add_argument('-m', type=str, dest='toggle_mask_rfm1', 111 | help='set the toggle mask for RFM1') 112 | parser.add_argument('-M', type=str, dest='toggle_mask_rfm2', 113 | help='set the toggle mask for RFM2') 114 | parser.add_argument('-r', type=str, dest='datarate_rfm1', 115 | help='set the datarate for RFM1') 116 | parser.add_argument('-R', type=str, dest='datarate_rfm2', 117 | help='set the datarate for RFM2') 118 | 119 | _sub = parser.add_subparsers(title='Commands') 120 | 121 | # list all devices 122 | subparser = _sub.add_parser('scan', 123 | help='Show all received sensors') 124 | subparser.set_defaults(func=scan) 125 | 126 | subparser = _sub.add_parser('info', 127 | help='Get configuration info') 128 | subparser.set_defaults(func=get_info) 129 | 130 | subparser = _sub.add_parser('led', 131 | help='Set traffic LED state') 132 | subparser.add_argument('led_state', type=str, choices=['on', 'off'], 133 | metavar="STATE", help='LED state') 134 | subparser.set_defaults(func=led) 135 | 136 | args = parser.parse_args(args) 137 | 138 | logging.basicConfig() 139 | if args.verbose: 140 | _LOGGER.setLevel(logging.DEBUG) 141 | 142 | try: 143 | config = ConfigParser() 144 | config.read_file(codecs.open(os.path.expanduser( 145 | '~/.lacrosse/known_sensors.ini'), 'r', 'UTF-8')) 146 | except IOError: 147 | config = None 148 | 149 | lacrosse = None 150 | try: 151 | lacrosse = pylacrosse.LaCrosse(args.device, 57600) 152 | lacrosse.open() 153 | configure(lacrosse, config, args) 154 | args.func(lacrosse, config, args) 155 | 156 | finally: 157 | if lacrosse is not None: 158 | lacrosse.close() 159 | 160 | if __name__ == '__main__': 161 | main() 162 | -------------------------------------------------------------------------------- /pylacrosse/lacrosse.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2017 Heiko Thiery 2 | # 3 | # This library is free software; you can redistribute it and/or 4 | # modify it under the terms of the GNU Lesser General Public 5 | # License as published by the Free Software Foundation; either 6 | # version 2.1 of the License, or (at your option) any later version. 7 | # 8 | # This library is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | # Lesser General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU Lesser General Public 14 | # License along with this library; if not, write to the Free Software 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 16 | # USA 17 | 18 | from __future__ import unicode_literals 19 | import logging 20 | import re 21 | import threading 22 | 23 | _LOGGER = logging.getLogger(__name__) 24 | 25 | """ 26 | Jeelink lacrosse firmware commands 27 | a set to 0 if the blue LED bothers 28 | f initial frequency in kHz (5 kHz steps, 860480 ... 879515) (for RFM 29 | #1) 30 | F initial frequency in kHz (5 kHz steps, 860480 ... 879515) (for RFM 31 | #2) 32 | h altituide above sea level 33 | m bits 1: 17.241 kbps, 2 : 9.579 kbps, 4 : 8.842 kbps (for RFM #1) 34 | M bits 1: 17.241 kbps, 2 : 9.579 kbps, 4 : 8.842 kbps (for RFM #2) 35 | r use one of the possible data rates (for RFM #1) 36 | R use one of the possible data rates (for RFM #2) 37 | t 0=no toggle, else interval in seconds (for RFM #1) 38 | T 0=no toggle, else interval in seconds (for RFM #2) 39 | v show version 40 | y if 1 all received packets will be retransmitted (Relay mode) 41 | """ 42 | 43 | class LaCrosse(object): 44 | 45 | sensors = {} 46 | _registry = {} 47 | _callback = None 48 | _serial = None 49 | _stopevent = None 50 | _thread = None 51 | 52 | def __init__(self, port, baud, timeout=2): 53 | """Initialize the Lacrosse device.""" 54 | self._port = port 55 | self._baud = baud 56 | self._timeout = timeout 57 | self._serial = SerialPortFactory().create_serial_port(port) 58 | self._callback_data = None 59 | 60 | def open(self): 61 | """Open the device.""" 62 | self._serial.port = self._port 63 | self._serial.baudrate = self._baud 64 | self._serial.timeout = self._timeout 65 | self._serial.open() 66 | self._serial.flushInput() 67 | self._serial.flushOutput() 68 | 69 | def close(self): 70 | """Close the device.""" 71 | self._stop_worker() 72 | self._serial.close() 73 | 74 | def start_scan(self): 75 | """Start scan task in background.""" 76 | self._start_worker() 77 | 78 | def _write_cmd(self, cmd): 79 | """Write a cmd.""" 80 | self._serial.write(cmd.encode()) 81 | 82 | @staticmethod 83 | def _parse_info(line): 84 | """ 85 | The output can be: 86 | - [LaCrosseITPlusReader.10.1s (RFM12B f:0 r:17241)] 87 | - [LaCrosseITPlusReader.10.1s (RFM12B f:0 t:10~3)] 88 | """ 89 | re_info = re.compile( 90 | r'\[(?P\w+).(?P.*) ' + 91 | r'\((?P\w+) (\w+):(?P\d+) ' + 92 | r'(?P.*)\)\]') 93 | 94 | info = { 95 | 'name': None, 96 | 'version': None, 97 | 'rfm1name': None, 98 | 'rfm1frequency': None, 99 | 'rfm1datarate': None, 100 | 'rfm1toggleinterval': None, 101 | 'rfm1togglemask': None, 102 | } 103 | match = re_info.match(line) 104 | if match: 105 | info['name'] = match.group('name') 106 | info['version'] = match.group('ver') 107 | info['rfm1name'] = match.group('rfm1name') 108 | info['rfm1frequency'] = match.group('rfm1freq') 109 | values = match.group('rfm1mode').split(':') 110 | if values[0] == 'r': 111 | info['rfm1datarate'] = values[1] 112 | elif values[0] == 't': 113 | toggle = values[1].split('~') 114 | info['rfm1toggleinterval'] = toggle[0] 115 | info['rfm1togglemask'] = toggle[1] 116 | 117 | return info 118 | 119 | def get_info(self): 120 | """Get current configuration info from 'v' command.""" 121 | re_info = re.compile(r'\[.*\]') 122 | 123 | self._write_cmd('v') 124 | while True: 125 | line = self._serial.readline() 126 | try: 127 | line = line.encode().decode('utf-8') 128 | except AttributeError: 129 | line = line.decode('utf-8') 130 | 131 | match = re_info.match(line) 132 | if match: 133 | return self._parse_info(line) 134 | 135 | def led_mode_state(self, state): 136 | """Set the LED mode. 137 | 138 | The LED state can be True or False. 139 | """ 140 | self._write_cmd('{}a'.format(int(state))) 141 | 142 | def set_frequency(self, frequency, rfm=1): 143 | """Set frequency in kHz. 144 | 145 | The frequency can be set in 5kHz steps. 146 | """ 147 | cmds = {1: 'f', 2: 'F'} 148 | self._write_cmd('{}{}'.format(frequency, cmds[rfm])) 149 | 150 | def set_datarate(self, rate, rfm=1): 151 | """Set datarate (baudrate).""" 152 | cmds = {1: 'r', 2: 'R'} 153 | self._write_cmd('{}{}'.format(rate, cmds[rfm])) 154 | 155 | def set_toggle_interval(self, interval, rfm=1): 156 | """Set the toggle interval.""" 157 | cmds = {1: 't', 2: 'T'} 158 | self._write_cmd('{}{}'.format(interval, cmds[rfm])) 159 | 160 | def set_toggle_mask(self, mode_mask, rfm=1): 161 | """Set toggle baudrate mask. 162 | 163 | The baudrate mask values are: 164 | 1: 17.241 kbps 165 | 2 : 9.579 kbps 166 | 4 : 8.842 kbps 167 | These values can be or'ed. 168 | """ 169 | cmds = {1: 'm', 2: 'M'} 170 | self._write_cmd('{}{}'.format(mode_mask, cmds[rfm])) 171 | 172 | def _start_worker(self): 173 | if self._thread is not None: 174 | return 175 | self._stopevent = threading.Event() 176 | self._thread = threading.Thread(target=self._refresh, args=()) 177 | self._thread.daemon = True 178 | self._thread.start() 179 | 180 | def _stop_worker(self): 181 | if self._stopevent is not None: 182 | self._stopevent.set() 183 | if self._thread is not None: 184 | self._thread.join() 185 | 186 | def _refresh(self): 187 | """Background refreshing thread.""" 188 | 189 | while not self._stopevent.isSet(): 190 | line = self._serial.readline() 191 | #this is for python2/python3 compatibility. Is there a better way? 192 | try: 193 | line = line.encode().decode('utf-8') 194 | except AttributeError: 195 | line = line.decode('utf-8') 196 | 197 | if LaCrosseSensor.re_reading.match(line): 198 | sensor = LaCrosseSensor(line) 199 | self.sensors[sensor.sensorid] = sensor 200 | 201 | if self._callback: 202 | self._callback(sensor, self._callback_data) 203 | 204 | if sensor.sensorid in self._registry: 205 | for cbs in self._registry[sensor.sensorid]: 206 | cbs[0](sensor, cbs[1]) 207 | 208 | def register_callback(self, sensorid, callback, user_data=None): 209 | """Register a callback for the specified sensor id.""" 210 | if sensorid not in self._registry: 211 | self._registry[sensorid] = list() 212 | self._registry[sensorid].append((callback, user_data)) 213 | 214 | def register_all(self, callback, user_data=None): 215 | """Register a callback for all sensors.""" 216 | self._callback = callback 217 | self._callback_data = user_data 218 | 219 | 220 | class LaCrosseSensor(object): 221 | """The LaCrosse Sensor class.""" 222 | # OK 9 248 1 4 150 106 223 | re_reading = re.compile(r'OK (\d+) (\d+) (\d+) (\d+) (\d+) (\d+)') 224 | 225 | def __init__(self, line=None): 226 | if line: 227 | self._parse(line) 228 | 229 | def _parse(self, line): 230 | match = self.re_reading.match(line) 231 | if match: 232 | data = [int(c) for c in match.group().split()[1:]] 233 | self.sensorid = data[1] 234 | self.sensortype = data[2] & 0x7f 235 | self.new_battery = True if data[2] & 0x80 else False 236 | self.temperature = float(data[3] * 256 + data[4] - 1000) / 10 237 | self.humidity = data[5] & 0x7f 238 | self.low_battery = True if data[5] & 0x80 else False 239 | 240 | def __repr__(self): 241 | return "id=%d t=%f h=%d nbat=%d" % \ 242 | (self.sensorid, self.temperature, self.humidity, self.new_battery) 243 | 244 | 245 | class SerialPortFactory(object): 246 | def create_serial_port(self, port): 247 | if port.startswith("rfc2217://"): 248 | from serial.rfc2217 import Serial 249 | return Serial() 250 | else: 251 | from serial import Serial 252 | return Serial() 253 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | from setuptools import setup, find_packages 5 | import os 6 | import re 7 | import subprocess 8 | 9 | name = 'pylacrosse' 10 | version_py = os.path.join(os.path.dirname(__file__), name, 'version.py') 11 | try: 12 | version = subprocess.check_output( 13 | ['git', 'describe', '--tags', '--always', '--dirty'], 14 | stderr=subprocess.STDOUT).rstrip().decode('ascii') 15 | with open(version_py, 'w') as f: 16 | f.write('# This file was autogenerated by setup.py\n') 17 | f.write('__version__ = \'%s\'\n' % (version,)) 18 | except (OSError, subprocess.CalledProcessError, IOError) as e: 19 | try: 20 | with open(version_py, 'r') as f: 21 | for line in f.readlines(): 22 | val = re.findall("__version__ = '([^']+)'", line) 23 | version = val[0] 24 | except IOError: 25 | version = 'unknown' 26 | 27 | with open('README.rst') as f: 28 | readme = f.read() 29 | 30 | setup(name = name, 31 | version = version, 32 | description = 'LaCrosse sensor library', 33 | long_description = readme, 34 | author = 'Heiko Thiery', 35 | author_email = 'heiko.thiery@gmail.com', 36 | packages = find_packages(exclude=('tests', 'tests.*')), 37 | url = 'http://github.com/hthiery/python-lacrosse', 38 | license = 'LGPLv2+', 39 | classifiers = [ 40 | 'Development Status :: 3 - Alpha', 41 | 'Environment :: Console', 42 | 'License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)', 43 | 'Natural Language :: English', 44 | 'Operating System :: OS Independent', 45 | 'Programming Language :: Python :: 2', 46 | 'Programming Language :: Python :: 2.7', 47 | 'Programming Language :: Python :: 3', 48 | 'Programming Language :: Python :: 3.4', 49 | 'Programming Language :: Python :: 3.5', 50 | 'Programming Language :: Python :: 3.6', 51 | 'Topic :: Software Development :: Libraries :: Python Modules', 52 | ], 53 | entry_points = { 54 | 'console_scripts': [ 55 | 'pylacrosse= pylacrosse.cli_tool:main', 56 | ] 57 | }, 58 | test_suite = 'tests', 59 | include_package_data = True, 60 | install_requires=['pyserial'], 61 | ) 62 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hthiery/python-lacrosse/cc26d70750d3db496b602e57aa59a50a85f76ce2/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_lacrosse.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time 4 | import pytest 5 | 6 | from mock import MagicMock 7 | 8 | from pylacrosse import (LaCrosse, LaCrosseSensor) 9 | 10 | def static_vars(**kwargs): 11 | def decorate(func): 12 | for k in kwargs: 13 | setattr(func, k, kwargs[k]) 14 | return func 15 | return decorate 16 | 17 | class TestLacrosse(object): 18 | 19 | def test_refresh(self): 20 | mock_readline = MagicMock() 21 | 22 | def side_effect_fct(): 23 | if not hasattr(side_effect_fct, "counter"): 24 | side_effect_fct.counter = 0 25 | values = [ 26 | 'OK 9 1 1 4 150 106', 27 | 'OK 9 2 1 4 150 106', 28 | 'OK 9 2 1 4 150 106', 29 | ] 30 | 31 | if side_effect_fct.counter >= len(values): 32 | value = "" 33 | else: 34 | value = values[side_effect_fct.counter] 35 | side_effect_fct.counter += 1 36 | return value 37 | 38 | mock_readline.side_effect = side_effect_fct 39 | 40 | mock_cb_1 = MagicMock(return_value=None) 41 | mock_cb_2 = MagicMock(return_value=None) 42 | 43 | l = LaCrosse('/dev/ttyTEST', 115200) 44 | l._serial.readline = mock_readline 45 | l.register_callback(1, mock_cb_1) 46 | l.register_callback(2, mock_cb_2) 47 | 48 | l._start_worker() 49 | time.sleep(0.01) 50 | l._stop_worker() 51 | 52 | assert mock_cb_1.call_count == 1 53 | assert mock_cb_2.call_count == 2 54 | 55 | def test_get_info(self): 56 | info = LaCrosse._parse_info('[LaCrosseITPlusReader.10.1s (RFM12B f:0 r:17241)]') 57 | assert info['name'] == 'LaCrosseITPlusReader' 58 | assert info['version'] == '10.1s' 59 | 60 | info = LaCrosse._parse_info('[LaCrosseITPlusReader.10.1s (RFM12B f:0 r:17241)]') 61 | assert info['rfm1name'] == 'RFM12B' 62 | assert info['rfm1frequency'] == '0' 63 | assert info['rfm1datarate'] == '17241' 64 | 65 | info = LaCrosse._parse_info('[LaCrosseITPlusReader.10.1s (RFM12B f:0 t:10~3)]') 66 | assert info['rfm1name'] == 'RFM12B' 67 | assert info['rfm1frequency'] == '0' 68 | assert info['rfm1datarate'] == None 69 | assert info['rfm1toggleinterval'] == '10' 70 | assert info['rfm1togglemask'] == '3' 71 | 72 | def test_led_mode_state(self): 73 | mock = MagicMock() 74 | 75 | l = LaCrosse('/dev/ttyTEST', 115200) 76 | l._serial.write = mock 77 | 78 | l.led_mode_state(True) 79 | l._serial.write.assert_called_with(b'1a') 80 | 81 | l.led_mode_state(False) 82 | l._serial.write.assert_called_with(b'0a') 83 | 84 | def test_set_frequency(self): 85 | mock = MagicMock() 86 | 87 | l = LaCrosse('/dev/ttyTEST', 115200) 88 | l._serial.write = mock 89 | 90 | l.set_frequency(100) 91 | l._serial.write.assert_called_with(b'100f') 92 | 93 | l.set_frequency('200') 94 | l._serial.write.assert_called_with(b'200f') 95 | 96 | l.set_frequency(300, rfm=1) 97 | l._serial.write.assert_called_with(b'300f') 98 | 99 | l.set_frequency(400, rfm=2) 100 | l._serial.write.assert_called_with(b'400F') 101 | 102 | def test_set_frequency_invalid_rfm(self): 103 | mock = MagicMock() 104 | 105 | l = LaCrosse('/dev/ttyTEST', 115200) 106 | l._serial.write = mock 107 | 108 | with pytest.raises(KeyError): 109 | l.set_frequency(500, rfm=3) 110 | l._serial.write.assert_called_with(b'400f') 111 | 112 | def test_set_datarate(self): 113 | mock = MagicMock() 114 | 115 | l = LaCrosse('/dev/ttyTEST', 115200) 116 | l._serial.write = mock 117 | 118 | l.set_datarate(0) 119 | l._serial.write.assert_called_with(b'0r') 120 | l.set_datarate('1') 121 | l._serial.write.assert_called_with(b'1r') 122 | 123 | l.set_datarate(0, rfm=1) 124 | l._serial.write.assert_called_with(b'0r') 125 | l.set_datarate(0, rfm=2) 126 | l._serial.write.assert_called_with(b'0R') 127 | 128 | def test_set_toggle_interval(self): 129 | mock = MagicMock() 130 | 131 | l = LaCrosse('/dev/ttyTEST', 115200) 132 | l._serial.write = mock 133 | 134 | l.set_toggle_interval(10) 135 | l._serial.write.assert_called_with(b'10t') 136 | l.set_toggle_interval('10') 137 | l._serial.write.assert_called_with(b'10t') 138 | 139 | l.set_toggle_interval(10, rfm=1) 140 | l._serial.write.assert_called_with(b'10t') 141 | l.set_toggle_interval(10, rfm=2) 142 | l._serial.write.assert_called_with(b'10T') 143 | 144 | def test_set_toggle_mask(self): 145 | mock = MagicMock() 146 | 147 | l = LaCrosse('/dev/ttyTEST', 115200) 148 | l._serial.write = mock 149 | 150 | l.set_toggle_mask(1) 151 | l._serial.write.assert_called_with(b'1m') 152 | l.set_toggle_mask('1') 153 | l._serial.write.assert_called_with(b'1m') 154 | 155 | l.set_toggle_mask(2, rfm=1) 156 | l._serial.write.assert_called_with(b'2m') 157 | l.set_toggle_mask(3, rfm=2) 158 | l._serial.write.assert_called_with(b'3M') 159 | 160 | class TestLaCrosseSensor(object): 161 | 162 | def test_init(self): 163 | s = LaCrosseSensor('OK 9 1 1 4 150 66') 164 | assert s.sensorid == 1 165 | assert s.sensortype == 1 166 | assert s.temperature == 17.4 167 | assert s.humidity == 66 168 | assert not s.new_battery 169 | assert not s.low_battery 170 | --------------------------------------------------------------------------------