├── .gitignore ├── .gitmodules ├── .travis.yml ├── LICENSE ├── README.md ├── sniffer ├── Makefile ├── README.md ├── main.c └── tools │ ├── README.md │ └── sniffer.py └── spectrum-scanner ├── Makefile ├── README.md ├── main.c └── tools ├── README.md ├── example.png └── plot_rssi.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Object files 2 | *.o 3 | # Built binaries 4 | *bin 5 | # Backup files 6 | *~ 7 | *.orig 8 | .*.swp 9 | cachegrind.out* 10 | # Eclipse workspace files 11 | .project 12 | .cproject 13 | .settings 14 | .idea 15 | # KDevelop4 project files 16 | .kdev4 17 | *.kdev4 18 | # Codelite (among others) project files 19 | *.project 20 | 21 | # Eclipse symbol file (output from make eclipsesym) 22 | eclipsesym.xml 23 | /toolchain 24 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "RIOT"] 2 | path = RIOT 3 | url = https://github.com/RIOT-OS/RIOT 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | 3 | language: minimal 4 | 5 | before_install: 6 | - sudo apt-get install coreutils cppcheck pcregrep python3 python3-pip uncrustify 7 | 8 | notifications: 9 | email: 10 | recipients: 11 | - maintainer@riot-os.org 12 | on_success: change 13 | on_failure: always 14 | 15 | script: 16 | - ./RIOT/dist/tools/whitespacecheck/check.sh 17 | - find . -path ./RIOT -prune -o \( -name *.c -o -name *.h \) -exec cppcheck --std=c99 --enable=style --force --error-exitcode=2 --quiet -j 1 {} + 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Archival notice 2 | 3 | The applications that resided in this repository have been [moved into RIOT]. 4 | Please see the [examples inside RIOT] to find both these and other applications. 5 | 6 | The repository is left online only for documentation of the applications' history. 7 | 8 | [moved into RIOT]: https://github.com/RIOT-OS/RIOT/pull/18602 9 | [examples inside RIOT]: https://github.com/RIOT-OS/RIOT/tree/master/examples 10 | 11 | --- 12 | 13 | [![Build Status](https://travis-ci.org/RIOT-OS/applications.svg?branch=master)](https://travis-ci.org/RIOT-OS/applications) 14 | 15 | # RIOT Applications 16 | 17 | This repository provides more applications for the [RIOT operating system][riot-repo]. 18 | Some of them are just useful tools for development work, others showcase 19 | more extensive implementations of features of RIOT compared to the rather simple 20 | [examples in the RIOT main codebase][riot-repo/examples]. 21 | 22 | ## Usage 23 | 24 | To build and use them follow [the instructions in the RIOT repository][getting-started] 25 | and the READMEs within the respective application directory. 26 | 27 | The RIOT main code is included as a submodule. This always points to the latest 28 | release. To change the RIOT version to build against (e.g. current master), 29 | clone the RIOT repository in a separate repository and point the `RIOTBASE` 30 | environment variable there: 31 | 32 | ```sh 33 | # assuming you are in the working directory of your local clone of this repo 34 | cd .. 35 | git clone git@github.com:RIOT-OS/RIOT.git 36 | cd applications 37 | RIOTBASE="../RIOT" BOARD=samr21-xpro make -C sniffer flash 38 | ``` 39 | 40 | Alternatively you can use RIOT as a submodule. To initialize the submodule, from the 41 | root of the repository run: 42 | 43 | ```sh 44 | git submodule update --init --recursive 45 | ``` 46 | 47 | If you want to use master then simply step into the submodule and checkout master or 48 | any other desired branch. 49 | 50 | ```sh 51 | cd RIOT 52 | git checkout master 53 | git pull 54 | ``` 55 | 56 | Note that there is no guarantee that it will build or work, since we only test 57 | this repository against the latest release. 58 | 59 | [riot-repo]: https://github.com/RIOT-OS/RIOT 60 | [riot-repo/examples]: https://github.com/RIOT-OS/RIOT/tree/master/examples 61 | [getting-started]: https://github.com/RIOT-OS/RIOT/blob/master/README.md#getting-started 62 | -------------------------------------------------------------------------------- /sniffer/Makefile: -------------------------------------------------------------------------------- 1 | # Set the name of your application: 2 | APPLICATION = sniffer 3 | 4 | # If no BOARD is found in the environment, use this default: 5 | BOARD ?= native 6 | 7 | # This has to be the absolute path to the RIOT base directory: 8 | RIOTBASE ?= $(CURDIR)/../RIOT 9 | 10 | # Define modules that are used 11 | USEMODULE += fmt 12 | USEMODULE += gnrc 13 | USEMODULE += netdev_default 14 | USEMODULE += auto_init_gnrc_netif 15 | USEMODULE += shell 16 | USEMODULE += shell_commands 17 | USEMODULE += ps 18 | USEMODULE += ztimer64_usec 19 | 20 | # Change this to 0 show compiler invocation lines by default: 21 | QUIET ?= 1 22 | 23 | include $(RIOTBASE)/Makefile.include 24 | -------------------------------------------------------------------------------- /sniffer/README.md: -------------------------------------------------------------------------------- 1 | About 2 | ===== 3 | 4 | This application is built to run together with the script `./tools/sniffer.py` 5 | as a sniffer for (wireless) data traffic. This application works with any board 6 | with any network device that supports the gnrc network stack (or precisely the 7 | gnrc parts up to the link-layer). Further the network device (and its driver) 8 | needs to support promiscuous and raw mode for usable output. Finally the board 9 | needs to include auto-initialization code for the targeted network device. 10 | 11 | 12 | Usage 13 | ===== 14 | 15 | Compile and flash this application to the board of your choice. You can check 16 | if everything on the RIOT side works by connecting to the board via UART and by 17 | checking with `ifconfig` if a network device is available. Also note the 18 | interface number for the following commands. Then you can check with 19 | `ifconfig promisc` if promiscuous mode is supported and with 20 | `ifconfig raw` if raw mode is supported by the driver/network device. 21 | 22 | For further information on setting up the host part, see `./tools/README.md`. 23 | -------------------------------------------------------------------------------- /sniffer/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2015-18 Freie Universität Berlin 3 | * 4 | * This file is subject to the terms and conditions of the GNU Lesser 5 | * General Public License v2.1. See the file LICENSE in the top level 6 | * directory for more details. 7 | */ 8 | 9 | /** 10 | * @defgroup app_sniffer 11 | * @brief Sniffer application based on the new network stack 12 | * @{ 13 | * 14 | * @file 15 | * @brief Sniffer application for RIOT 16 | * 17 | * @author Hauke Petersen 18 | * @author Martine Lenders 19 | * 20 | * @} 21 | */ 22 | 23 | #include 24 | 25 | #include "fmt.h" 26 | #include "thread.h" 27 | #include "shell.h" 28 | #include "net/gnrc.h" 29 | #include "ztimer64.h" 30 | 31 | /** 32 | * @brief Buffer size used by the shell 33 | */ 34 | #define SHELL_BUFSIZE (64U) 35 | 36 | /** 37 | * @brief Priority of the RAW dump thread 38 | */ 39 | #define RAWDUMP_PRIO (THREAD_PRIORITY_MAIN - 1) 40 | 41 | /** 42 | * @brief Message queue size of the RAW dump thread 43 | */ 44 | #define RAWDUMP_MSG_Q_SIZE (32U) 45 | 46 | /** 47 | * @brief Stack for the raw dump thread 48 | */ 49 | static char rawdmp_stack[THREAD_STACKSIZE_SMALL]; 50 | 51 | /** 52 | * @brief Make a raw dump of the given packet contents 53 | */ 54 | void dump_pkt(gnrc_pktsnip_t *pkt) 55 | { 56 | gnrc_pktsnip_t *snip = pkt; 57 | uint8_t lqi = 0; 58 | if (pkt->next) { 59 | if (pkt->next->type == GNRC_NETTYPE_NETIF) { 60 | gnrc_netif_hdr_t *netif_hdr = pkt->next->data; 61 | lqi = netif_hdr->lqi; 62 | pkt = gnrc_pktbuf_remove_snip(pkt, pkt->next); 63 | } 64 | } 65 | uint64_t now_us = ztimer64_now(ZTIMER64_USEC); 66 | 67 | print_str("rftest-rx --- len "); 68 | print_u32_hex((uint32_t)gnrc_pkt_len(pkt)); 69 | print_str(" lqi "); 70 | print_byte_hex(lqi); 71 | print_str(" rx_time "); 72 | print_u64_hex(now_us); 73 | print_str("\n"); 74 | while (snip) { 75 | for (size_t i = 0; i < snip->size; i++) { 76 | print_byte_hex(((uint8_t *)(snip->data))[i]); 77 | print_str(" "); 78 | } 79 | snip = snip->next; 80 | } 81 | print_str("\n\n"); 82 | 83 | gnrc_pktbuf_release(pkt); 84 | } 85 | 86 | /** 87 | * @brief Event loop of the RAW dump thread 88 | * 89 | * @param[in] arg unused parameter 90 | */ 91 | void *rawdump(void *arg) 92 | { 93 | msg_t msg_q[RAWDUMP_MSG_Q_SIZE]; 94 | 95 | (void)arg; 96 | msg_init_queue(msg_q, RAWDUMP_MSG_Q_SIZE); 97 | while (1) { 98 | msg_t msg; 99 | 100 | msg_receive(&msg); 101 | switch (msg.type) { 102 | case GNRC_NETAPI_MSG_TYPE_RCV: 103 | dump_pkt((gnrc_pktsnip_t *)msg.content.ptr); 104 | break; 105 | default: 106 | /* do nothing */ 107 | break; 108 | } 109 | } 110 | 111 | /* never reached */ 112 | return NULL; 113 | } 114 | 115 | /** 116 | * @brief Maybe you are a golfer?! 117 | */ 118 | int main(void) 119 | { 120 | gnrc_netreg_entry_t dump; 121 | 122 | puts("RIOT sniffer application"); 123 | 124 | /* start and register rawdump thread */ 125 | puts("Run the rawdump thread and register it"); 126 | dump.target.pid = thread_create(rawdmp_stack, sizeof(rawdmp_stack), RAWDUMP_PRIO, 127 | THREAD_CREATE_STACKTEST, rawdump, NULL, "rawdump"); 128 | dump.demux_ctx = GNRC_NETREG_DEMUX_CTX_ALL; 129 | gnrc_netreg_register(GNRC_NETTYPE_UNDEF, &dump); 130 | 131 | /* start the shell */ 132 | puts("All ok, starting the shell now"); 133 | char line_buf[SHELL_DEFAULT_BUFSIZE]; 134 | shell_run(NULL, line_buf, SHELL_DEFAULT_BUFSIZE); 135 | 136 | return 0; 137 | } 138 | -------------------------------------------------------------------------------- /sniffer/tools/README.md: -------------------------------------------------------------------------------- 1 | # RIOT Sniffer Application 2 | 3 | 4 | ## About 5 | 6 | This sniffer script can be used to monitor and capture network traffic using 7 | a RIOT based node. It is primarily designed for sniffing wireless data traffic, 8 | but can also well be used for wired network traffic, as long as used network 9 | devices support promiscuous mode and output of raw data. 10 | 11 | The python script `sniffer.py` requires a RIOT node running the sniffer app, its 12 | source code is located in this repository (see main folder). This node outputs 13 | received network traffic via a serial port or a network socket in the common 14 | Wireshark/libpcap (pcap) format. This output is then parsed by the `sniffer.py` 15 | script included in this folder run on a host computer. 16 | 17 | The `sniffer.py` script is a modified version of [malvira's script](https://github.com/malvira/libmc1322x/blob/master/tools/rftestrx2pcap.py) 18 | for the Redbee Ecotag (https://github.com/malvira/libmc1322x/wiki/wireshark). 19 | 20 | ## Dependencies 21 | 22 | The `sniffer.py` script is written in Python and needs [pyserial](https://pypi.python.org/pypi/pyserial). 23 | 24 | Installing the dependencies: 25 | 26 | 27 | #### Debuntu 28 | apt-get install python-serial 29 | 30 | #### PIP 31 | pip install pyserial 32 | 33 | 34 | ## Usage 35 | 36 | General usage: 37 | 38 | 1. Flash an applicable RIOT node with the sniffer application (insert path to 39 | RIOT source and board name), as follows: 40 | ``` 41 | $ git clone https://github.com/RIOT-OS/applications/ 42 | $ cd applications/sniffer 43 | $ BOARD= make clean all flash 44 | ``` 45 | 46 | 2. Run the `sniffer.py` script (change to subfolder `tools/`) as follows : 47 | For serial port: 48 | ``` 49 | $ ./sniffer.py [-b baudrate] [outfile] 50 | ``` 51 | For network socket: 52 | ``` 53 | $ ./sniffer.py : [outfile] 54 | ``` 55 | 56 | You should see output like below: 57 | ``` 58 | ifconfig 3 set chan 26 59 | ifconfig 3 raw 60 | ifconfig 3 promisc 61 | RX: 0 62 | ``` 63 | 64 | For detailed information on the parameters use the scripts on-line help: 65 | 66 | ``` 67 | ./sniffer.py -h 68 | ``` 69 | 70 | ### Examples 71 | 72 | The following examples are made when using the sniffer application together with 73 | an `iotlab-m3` node that is connected to `/dev/ttyUSB1`(or COM1) (`serial` connection type) 74 | and runs per default with a baudrate of 500000. For the `socket` connection type port 20000 75 | is used. 76 | 77 | #### Linux (serial) 78 | 79 | Dump packets to a file: 80 | ``` 81 | $ ./sniffer.py -b 500000 /dev/ttyUSB1 17 foo.pcap 82 | ``` 83 | 84 | This .pcap can then be opened in Wireshark. 85 | 86 | Alternatively for live captures, you can pipe directly into Wireshark with: 87 | ``` 88 | $ ./sniffer.py -b 500000 /dev/ttyUSB1 17 | wireshark -k -i - 89 | ``` 90 | 91 | #### Windows (serial) 92 | 93 | For windows you can use the optional third argument to output to a 94 | .pcap: 95 | 96 | ``` 97 | $ ./sniffer.py -b 500000 COM1 17 foo.pcap 98 | ``` 99 | 100 | #### IoT-Lab Testbed (socket) 101 | 102 | Start an experiment either via the website provided by the IoT-Lab testbed or 103 | by using the RIOT specific iotlab Makefile with 3 neighboring `iotlab-m3` nodes, 104 | where one of them runs the sniffer application and the others run the `gnrc_networking` application. 105 | 106 | Now you can bind the sniffer node to localhost: 107 | ssh -L 20000:_node-id_:20000 _user_@_site_.iot-lab.info 108 | 109 | Then you can dump or observe the traffic generated by the other nodes running the `gnrc_networking` 110 | application via one of the following commands: 111 | ``` 112 | $ ./sniffer.py localhost:20000 26 foo.pcap 113 | $ ./sniffer.py localhost:20000 26 | wireshark -k -i - 114 | ``` 115 | -------------------------------------------------------------------------------- /sniffer/tools/sniffer.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | """ 4 | (C) 2012, Mariano Alvira 5 | (C) 2014, Oliver Hahm 6 | (C) 2015, Hauke Petersen 7 | (C) 2015, Martine Lenders 8 | (C) 2015, Cenk Gündoğan 9 | 10 | Redistribution and use in source and binary forms, with or without 11 | modification, are permitted provided that the following conditions 12 | are met: 13 | 1. Redistributions of source code must retain the above copyright 14 | notice, this list of conditions and the following disclaimer. 15 | 2. Redistributions in binary form must reproduce the above copyright 16 | notice, this list of conditions and the following disclaimer in the 17 | documentation and/or other materials provided with the distribution. 18 | 3. Neither the name of the Institute nor the names of its contributors 19 | may be used to endorse or promote products derived from this software 20 | without specific prior written permission. 21 | 22 | THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 23 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 | ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 26 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 | OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 | SUCH DAMAGE. 33 | """ 34 | 35 | from __future__ import print_function 36 | import argparse 37 | import sys 38 | import re 39 | import socket 40 | from time import sleep, time 41 | from struct import pack 42 | from serial import Serial 43 | 44 | # PCAP setup 45 | MAGIC = 0xA1B2C3D4 46 | MAJOR = 2 47 | MINOR = 4 48 | ZONE = 0 49 | SIG = 0 50 | SNAPLEN = 0xFFFF 51 | NETWORK = 230 # 802.15.4 no FCS 52 | 53 | DEFAULT_BAUDRATE = 115200 54 | 55 | 56 | def configure_interface(port, channel): 57 | line = "" 58 | iface = 0 59 | port.write("ifconfig\n".encode()) 60 | while True: 61 | line = port.readline() 62 | if line == b"": 63 | print("Application has no network interface defined", file=sys.stderr) 64 | sys.exit(2) 65 | match = re.search(r"^Iface +(\d+)", line.decode(errors="ignore")) 66 | if match is not None: 67 | iface = int(match.group(1)) 68 | break 69 | 70 | # set channel, raw mode, and promiscuous mode 71 | print("ifconfig %d set chan %d" % (iface, channel), file=sys.stderr) 72 | print("ifconfig %d raw" % iface, file=sys.stderr) 73 | print("ifconfig %d promisc" % iface, file=sys.stderr) 74 | port.write(("ifconfig %d set chan %d\n" % (iface, channel)).encode()) 75 | port.write(("ifconfig %d raw\n" % iface).encode()) 76 | port.write(("ifconfig %d promisc\n" % iface).encode()) 77 | 78 | 79 | def generate_pcap(port, out): 80 | # count incoming packets 81 | count = 0 82 | # output overall PCAP header 83 | out.write(pack("? *rftest-rx --- len (\w+).*", line.decode(errors="ignore") 90 | ) 91 | if pkt_header: 92 | now = time() 93 | sec = int(now) 94 | usec = int((now - sec) * 1000000) 95 | length = int(pkt_header.group(1), 16) 96 | out.write(pack(" (3,): 140 | default_outfile = sys.stdout.buffer 141 | else: 142 | default_outfile = sys.stdout 143 | p = argparse.ArgumentParser() 144 | p.add_argument( 145 | "-b", 146 | "--baudrate", 147 | type=int, 148 | default=DEFAULT_BAUDRATE, 149 | help="Baudrate of the serial port (only evaluated " 150 | "for non TCP-terminal, default: %d)" % DEFAULT_BAUDRATE, 151 | ) 152 | p.add_argument( 153 | "conn", 154 | metavar="tty/host:port", 155 | type=str, 156 | help="Serial port or TCP (host, port) tuple to " 157 | "terminal with sniffer application", 158 | ) 159 | p.add_argument("channel", type=int, help="Channel to sniff on") 160 | p.add_argument( 161 | "outfile", 162 | type=argparse.FileType("w+b"), 163 | default=default_outfile, 164 | nargs="?", 165 | help="PCAP file to output to (default: stdout)", 166 | ) 167 | args = p.parse_args() 168 | 169 | conn = connect(args) 170 | 171 | sleep(1) 172 | configure_interface(conn, args.channel) 173 | sleep(1) 174 | 175 | try: 176 | generate_pcap(conn, args.outfile) 177 | except KeyboardInterrupt: 178 | conn.close() 179 | print() 180 | sys.exit(2) 181 | 182 | 183 | if __name__ == "__main__": 184 | main() 185 | -------------------------------------------------------------------------------- /spectrum-scanner/Makefile: -------------------------------------------------------------------------------- 1 | # Set the name of your application: 2 | APPLICATION = spectrum-scanner 3 | 4 | # If no BOARD is found in the environment, use this default: 5 | BOARD ?= samr21-xpro 6 | 7 | # This has to be the absolute path to the RIOT base directory: 8 | RIOTBASE ?= $(CURDIR)/../RIOT 9 | 10 | # Define modules that are used 11 | USEMODULE += gnrc 12 | USEMODULE += netdev_default 13 | USEMODULE += auto_init_gnrc_netif 14 | USEMODULE += xtimer 15 | USEMODULE += ztimer64_xtimer_compat 16 | USEMODULE += fmt 17 | 18 | # Change this to 0 show compiler invocation lines by default: 19 | QUIET ?= 1 20 | 21 | include $(RIOTBASE)/Makefile.include 22 | -------------------------------------------------------------------------------- /spectrum-scanner/README.md: -------------------------------------------------------------------------------- 1 | About 2 | ===== 3 | 4 | This application is designed to run together with the script 5 | `tools/plot_rssi.py` to monitor energy levels on all 6 | available wireless channels. This application works with any board with a 7 | network device that supports the gnrc network stack (or precisely the gnrc parts 8 | up to the link-layer). Further, in order to get any measurements from the 9 | device, the network device and its driver needs to support the netopt options 10 | for executing a manual CCA and getting the last ED level 11 | (NETOPT_IS_CHANNEL_CLR, and NETOPT_LAST_ED_LEVEL, respectively). Finally the 12 | board needs to include auto-initialization code for the targeted network device. 13 | 14 | Usage 15 | ===== 16 | 17 | Compile and flash this application to the board of your choice. You can check if 18 | everything on the RIOT side works by connecting to the board via UART and 19 | looking at the output. 20 | 21 | Data format 22 | =========== 23 | 24 | The format of the data on the UART is: 25 | 26 | ``` 27 | [interface_number, timestamp, count] channel: ed_level, channel: ed_level, ... 28 | ``` 29 | 30 | where interface_number is the interface number (in RIOT's `ifconfig`), timestamp 31 | is the time since power on in microseconds, count is the number of measurements 32 | that were averaged, channel is a channel number, ed_level is the average energy 33 | level for that channel since the last update. 34 | 35 | For further information on setting up the host part, see 36 | `tools/README.md`. 37 | -------------------------------------------------------------------------------- /spectrum-scanner/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2017 Eistec AB 3 | * 4 | * This file is subject to the terms and conditions of the GNU Lesser 5 | * General Public License v2.1. See the file LICENSE in the top level 6 | * directory for more details. 7 | */ 8 | 9 | /** 10 | * @defgroup app_spectrum_scanner 11 | * @brief Scanner application to find free channels 12 | * @{ 13 | * 14 | * @file 15 | * @brief Spectrum scanner application for RIOT 16 | * 17 | * @author Joakim Nohlgård 18 | * 19 | * @} 20 | */ 21 | 22 | #include 23 | #include 24 | 25 | #include "fmt.h" 26 | #include "thread.h" 27 | #include "xtimer.h" 28 | #include "net/ieee802154.h" 29 | #include "net/gnrc.h" 30 | 31 | /* Scanning interval */ 32 | #define INTERVAL (500U * US_PER_MS) 33 | 34 | /** 35 | * @brief Measure the radio energy spectrum and print on stdout 36 | * 37 | * Algorithm description: 38 | * 39 | * The process will repeat as many measurements as possible during the 40 | * measurement interval, before the average power is computed. This reduces the 41 | * noise in the measurement and will yield a better image of what the radio 42 | * environment contains. 43 | * 44 | * Still, 122 measurements per second (frdm-kw41z) and 128 us per measurement 45 | * will only give a time coverage of about 1.5%, but because the measurements are 46 | * spread out over time they should still give a good representation of which 47 | * channels are free. 48 | * 49 | * Note that because the ED values are given in decibels, the average radio 50 | * power is not the same as the arithmetic mean of the ED measurements. To 51 | * compute the average of the dB measurements this algorithm requires both 52 | * logarithm and exponentiation, quite heavy operations on the kinds of CPUs 53 | * that RIOT targets. Increasing the CPU clock frequency may therefore reduce 54 | * the noise in the output, because of the more frequent energy measurements 55 | * possible. 56 | */ 57 | void spectrum_scanner(unsigned long interval_us) 58 | { 59 | size_t netif_numof = gnrc_netif_numof(); 60 | 61 | /* Using expf(x) (natural exponent) gives quicker computations on Cortex-M0+, 62 | * compared to using powf(10, x). */ 63 | /* 64 | * This was optimized by testing different combinations of expf, powf, logf, log10f: 65 | * 66 | * functions used | measurement iterations per 0.5 s on reference system (frdm-kw41z) 67 | * ------------------------------------------------------------------ 68 | * expf, logf | 64 69 | * powf, log10f | 46 70 | * expf, log10f | 61 71 | * no-op (baseline) | 83 (but the measurements are useless) 72 | */ 73 | 74 | while (1) { 75 | /* Stack optimization, statically allocate this buffer */ 76 | float ed_average[netif_numof][IEEE802154_CHANNEL_MAX + 1]; 77 | 78 | memset(ed_average, 0, sizeof(ed_average)); 79 | 80 | uint64_t last_wakeup = xtimer_now_usec64(); 81 | uint64_t target = last_wakeup + interval_us; 82 | /* We spin and try to do as many measurements as possible in the 83 | * interval time */ 84 | unsigned int count = 0; 85 | do { 86 | gnrc_netif_t *netif = NULL; 87 | for (unsigned int k = 0; (netif = gnrc_netif_iter(netif)); k++) { 88 | for (unsigned int ch = IEEE802154_CHANNEL_MIN; ch <= IEEE802154_CHANNEL_MAX; ++ch) { 89 | uint16_t tmp_ch = ch; 90 | int res; 91 | res = gnrc_netapi_set(netif->pid, NETOPT_CHANNEL, 0, &tmp_ch, sizeof(uint16_t)); 92 | if (res < 0) { 93 | continue; 94 | } 95 | netopt_enable_t tmp; 96 | /* Perform CCA to update ED level */ 97 | res = gnrc_netapi_get(netif->pid, NETOPT_IS_CHANNEL_CLR, 0, &tmp, sizeof(netopt_enable_t)); 98 | if (res < 0) { 99 | continue; 100 | } 101 | int8_t level = 0; 102 | res = gnrc_netapi_get(netif->pid, NETOPT_LAST_ED_LEVEL, 0, &level, sizeof(int8_t)); 103 | if (res < 0) { 104 | continue; 105 | } 106 | /* Convert dB to pseudo-energy before summing together the 107 | * measurements. "Pseudo" because we use the natural 108 | * exponential function e^x instead of computing 10^x which 109 | * would be required if we needed the real measured energy. 110 | * There is no need to know the real energy level because we 111 | * will be converting back to dB again before printing. */ 112 | ed_average[k][ch] += expf((float)level / 128.f); 113 | } 114 | } 115 | ++count; 116 | thread_yield(); 117 | } while (xtimer_now_usec64() < target); 118 | for (unsigned int k = 0; k < netif_numof; ++k) { 119 | print("[", 1); 120 | print_u32_dec(k); 121 | print(", ", 2); 122 | print_u64_dec(target); 123 | print(", ", 2); 124 | print_u32_dec(count); 125 | print("] ", 2); 126 | for (unsigned int ch = IEEE802154_CHANNEL_MIN; ch <= IEEE802154_CHANNEL_MAX; ++ch) { 127 | /* Compute the average pseudo-energy and convert back to dB */ 128 | ed_average[k][ch] = logf(ed_average[k][ch] / count) * 128.f; 129 | print_u32_dec(ch); 130 | print(": ", 2); 131 | print_float(ed_average[k][ch], 4); 132 | print(", ", 2); 133 | } 134 | print("\n", 1); 135 | } 136 | } 137 | } 138 | 139 | int main(void) 140 | { 141 | puts("RIOT scanner application"); 142 | 143 | spectrum_scanner(INTERVAL); 144 | return 0; 145 | } 146 | -------------------------------------------------------------------------------- /spectrum-scanner/tools/README.md: -------------------------------------------------------------------------------- 1 | # RIOT Spectrum Scanner Application 2 | 3 | ## About 4 | 5 | This script can be used to plot the radio signal spectrum when a connected node 6 | is running the spectrum-scanner application application located in the parent 7 | directory. 8 | This node scans over the available radio channels performing CCA measurements 9 | and outputting the measured ED level via a serial port. This output is then 10 | parsed by the `plot_rssi.py` script included in this folder run on a host computer. 11 | 12 | ## Dependencies 13 | 14 | The `plot_rssi.py` script requires [pyserial](https://pypi.python.org/pypi/pyserial) 15 | for the serial port access, and [matplotlib](https://matplotlib.org) and 16 | [numpy](http://www.numpy.org) for the plotting functionality. 17 | 18 | Installing the dependencies: 19 | 20 | #### Debian/Ubuntu 21 | apt-get install python-serial python-matplotlib python-numpy 22 | 23 | #### PIP 24 | pip install pyserial matplotlib numpy 25 | 26 | ## Usage 27 | 28 | General usage: 29 | 30 | 1. Flash a RIOT node with the spectrum-scanner application from 31 | (https://github.com/RIOT-OS/applications/tree/master/spectrum-scanner) 32 | 33 | 2. Run the `plot_rssi.py` script 34 | ``` 35 | $ ./plot_rssi.py -b 36 | ``` 37 | 38 | ### Examples 39 | 40 | ![Example screenshot](https://github.com/RIOT-OS/applications/tree/master/spectrum-scanner/tools/example.png) 41 | -------------------------------------------------------------------------------- /spectrum-scanner/tools/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RIOT-OS/applications/eb837841bda652f1e780dc06313286395f47136e/spectrum-scanner/tools/example.png -------------------------------------------------------------------------------- /spectrum-scanner/tools/plot_rssi.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # Copyright (C) 2017 Eistec AB 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | import sys 19 | import re 20 | import logging 21 | import argparse 22 | import serial 23 | import numpy as np 24 | import matplotlib.pyplot as plt 25 | import matplotlib.animation as animation 26 | 27 | 28 | class SpectrumEmitter(object): 29 | def __init__(self, port): 30 | self.port = port 31 | 32 | def data_gen(self): 33 | logging.info("Begin collecting data from serial port") 34 | while True: 35 | # Read one line from the spectrum device 36 | line = self.port.readline().rstrip() 37 | pkt_data = re.match( 38 | r"\[([-+]?\d+),\s*([-+]?\d+),\s*([-+]?\d+)\]\s*(.*)", 39 | line.decode(errors="replace"), 40 | ) 41 | if pkt_data: 42 | ed = {} 43 | try: 44 | iface_id = int(pkt_data.group(1)) 45 | timestamp = int(pkt_data.group(2)) 46 | count = int(pkt_data.group(3)) 47 | except ValueError: 48 | # Incorrect data received, probably UART noise or debugging 49 | # messages from the device, not much else we can do other 50 | # than try again with the next line 51 | continue 52 | logging.debug("data: if=%d cnt=%d t=%d", iface_id, count, timestamp) 53 | raw = pkt_data.group(4) 54 | for ch_ed in raw.split(","): 55 | try: 56 | pair = ch_ed.split(":") 57 | ch = int(pair[0]) 58 | ed[ch] = float(pair[1]) 59 | except (ValueError, IndexError): 60 | continue 61 | yield ed 62 | 63 | 64 | class RSSIPlot(object): 65 | def __init__(self, ax, *args, tlen=120, dt=0.5, nchannels=27): 66 | self.ax = ax 67 | self.count = 0 68 | self.dt = dt 69 | self.tlen = tlen 70 | # Generate mesh for plotting, this creates a grid of nchannel rows and 71 | # (tlen / dt) columns 72 | self.Y, self.X = np.mgrid[ 73 | slice(0 - 0.5, nchannels + 0.5, 1), 74 | slice(-self.tlen - self.dt / 2, 0 + 1 - self.dt / 2, self.dt), 75 | ] 76 | Z = np.zeros_like(self.X) 77 | # X and Y are the bounds, so Z should be the value *inside* those bounds. 78 | # Therefore, remove the last row and column from the Z array. 79 | self.Z = Z[:-1, :-1] 80 | self.pcm = self.ax.pcolormesh( 81 | self.X, self.Y, self.Z, vmin=-100, vmax=-20, cmap=plt.cm.get_cmap("jet") 82 | ) 83 | self.ax.get_figure().colorbar(self.pcm, label="Measured signal level [dB]") 84 | self.ax.set_ylabel("Channel number") 85 | self.ax.set_xlabel("Time [s]") 86 | self.ch_min = nchannels 87 | self.ch_max = 0 88 | 89 | def update(self, ed): 90 | resize = False 91 | for ch in ed.keys(): 92 | if ch < self.ch_min: 93 | self.ch_min = ch 94 | resize = True 95 | if ch > self.ch_max: 96 | self.ch_max = ch 97 | resize = True 98 | col = np.zeros((self.Z.shape[0], 1)) 99 | for ch in ed.keys(): 100 | col[ch, 0] = ed[ch] 101 | self.Z = np.hstack((self.Z[:, 1:], col)) 102 | if resize: 103 | self.ax.set_ylim([self.ch_min - 0.5, self.ch_max + 0.5]) 104 | self.ax.set_yticks(range(self.ch_min, self.ch_max + 1)) 105 | self.pcm.set_array(self.Z.ravel()) 106 | return (self.pcm,) 107 | 108 | 109 | def main(argv): 110 | loglevels = [ 111 | logging.CRITICAL, 112 | logging.ERROR, 113 | logging.WARN, 114 | logging.INFO, 115 | logging.DEBUG, 116 | ] 117 | parser = argparse.ArgumentParser(argv) 118 | parser.add_argument( 119 | "-v", 120 | "--verbosity", 121 | type=int, 122 | default=4, 123 | help="set logging verbosity, 1=CRITICAL, 5=DEBUG", 124 | ) 125 | parser.add_argument("tty", help="Serial port device file name") 126 | parser.add_argument( 127 | "-b", "--baudrate", default=115200, type=int, help="Serial port baudrate" 128 | ) 129 | args = parser.parse_args() 130 | # logging setup 131 | logging.basicConfig(level=loglevels[args.verbosity - 1]) 132 | 133 | # open serial port 134 | try: 135 | logging.debug("Open serial port %s, baud=%d", args.tty, args.baudrate) 136 | port = serial.Serial( 137 | port=args.tty, baudrate=9600, dsrdtr=0, rtscts=0, timeout=0.3 138 | ) 139 | # This baudrate reconfiguration is necessary for certain USB to serial 140 | # adapters, the Linux cdc_acm driver will keep repeating stale buffer 141 | # contents otherwise. No idea about the cause, but this fixes the symptom. 142 | port.baudrate = args.baudrate 143 | except IOError: 144 | logging.critical("error opening serial port", file=sys.stderr) 145 | sys.exit(2) 146 | 147 | try: 148 | logging.debug("Creating figure") 149 | fig, ax = plt.subplots() 150 | graph = RSSIPlot(ax) 151 | emitter = SpectrumEmitter(port) 152 | animation.FuncAnimation( 153 | fig, graph.update, emitter.data_gen, interval=10, blit=True 154 | ) 155 | plt.show() 156 | except KeyboardInterrupt: 157 | port.close() 158 | sys.exit(2) 159 | 160 | 161 | if __name__ == "__main__": 162 | main(sys.argv) 163 | --------------------------------------------------------------------------------