├── .gitignore ├── LICENSE ├── PayloadDecoder.md ├── README.md ├── bauanleitung.md └── ttnulmdust ├── .gitignore ├── BME280_Sensor.cpp ├── BME280_Sensor.h ├── DHT_Sensor.cpp ├── DHT_Sensor.h ├── SDS011.cpp ├── SDS011.h ├── configuration.h.default ├── platformio.ini ├── sleep_32u4.h └── ttnulmdust.ino /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | cmake-build-debug 3 | .DS_Store 4 | bin/*/ 5 | *build-* 6 | *~ 7 | build-tmp/ 8 | Makefile 9 | ttnulmdust/.vscode/* 10 | ttnulmdust/configuration.h -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /PayloadDecoder.md: -------------------------------------------------------------------------------- 1 | # Payload Decoder für die TTN Konsole 2 | 3 | Um die übertragenen Daten in der The Things Network Konsole direkt sichtbar zu 4 | machen und in einen lesbaren Wert zu konvertieren, kann der folgende Payload 5 | Decoder in der Feinstaub Application in der The Things Network Konsole eingefügt 6 | werden. Die Daten für PM10, PM2.5, Temperatur, Luftfeuchtigkeit und Luftdruck 7 | (falls vorhanden) werden automatisch dekodiert und an die JSON Daten angehängt. 8 | 9 | ## JavaScript Code 10 | 11 | ```javascript 12 | function Decoder(bytes, port) { 13 | var decoded = {}; 14 | 15 | if (port === 1) 16 | { 17 | // decode dust sensor data 18 | decoded.pm10 = (bytes[0] << 8 | bytes[1]) / 100.0; 19 | decoded.pm25 = (bytes[2] << 8 | bytes[3]) / 100.0; 20 | 21 | // decode weather sensor data 22 | decoded.humidity = (bytes[4] << 8 | bytes[5]) / 100.0; 23 | decoded.temperature = (bytes[6] << 8 | bytes[7]) / 100.0; 24 | 25 | // if pressure was transfered, decode it, too 26 | if (bytes.length >= 10) 27 | { 28 | decoded.pressure = (bytes[8] << 8 | bytes[9]) / 100.0; 29 | } 30 | } 31 | 32 | return decoded; 33 | } 34 | ``` -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TTN Ulm particulate matter sensor 2 | 3 | A Arduino sketch to measure particulates in the air via the SDS011 sensor and sending them to TheThingsNetwork. 4 | 5 | ## Intro 6 | 7 | 8 | 9 | 10 | ## Usage 11 | 1. Connect the SDS011 to the PINs configured in the sketch (PIN 8 and 9 are preconfigured) 12 | 2. Connect the 5V and GND pins 13 | 3. Connect the DHT sensor to PIN 10, 3.3v and GND or connect the BME280 sensor to PIN SCL, SDA, 3.3V and GND. 14 | 4. Copy the file "configuration.h.default" to "configuration.h" 15 | 5. Fill in your TTN credentials in the "configuration.h" 16 | 6. If you are using a BME280 sensor, uncomment the "#define BME280" line in the "configuration.h" 17 | 7. Make sure you have the TheThingsNetwork, DHT library and BME280 library installed, 18 | you can get them from the Arduino Library Manager (see below) 19 | 8. Write the sketch to the The Things Uno 20 | 21 | ## Quick explanation what this does 22 | 1. sleeps for a given amount of time. 23 | 2. spins up the fan for some time to clean the fan and the housing (1 minute recommened). 24 | 3. takes 10 samples of sensor data (pm2.5 and pm10) 25 | 4. calculates the median of each to avoid outlier 26 | 5. takes the current humidity and temperature values 27 | 6. encodes the values into bytes 28 | 7. send them to the given TTN app 29 | 30 | ## Arduino Libraries 31 | 32 | Install the following libraries through the Arduino Library Manager: 33 | 34 | * TheThingsNetwork 35 | * Adafruit Unified Sensor (scroll wayyy down) 36 | * DHT sensor library 37 | * Adafruit BME280 library 38 | 39 | 40 | ## License 41 | GNU Affero General Public License v3 (AGPL-3.0) 42 | See LICENSE file 43 | 44 | ## Other code used 45 | SDS011 library by R. Zschiegner (rz@madavi.de) https://github.com/ricki-z/SDS011 46 | We keep a local copy if this library. Makes building easier for new users. 47 | 48 | TheThingsNetwork library by Johan Stokking (johan@stokking.nl) 49 | https://github.com/TheThingsNetwork/arduino-node-lib 50 | -------------------------------------------------------------------------------- /bauanleitung.md: -------------------------------------------------------------------------------- 1 | # luftdaten.info mit LoRa / TTN 2 | 3 | Die folgende Anleitung beschreibt eine Variante zum Bau des Feinstaubsensors 4 | von bzw. für [luftdaten.info](http://luftdaten.info). 5 | Statt die Messdaten mit einem ESP8266 per WLAN zu übertragen kommt LoRa(WAN) und 6 | das [The Things Network (TTN)](https://www.thethingsnetwork.org) zum Einsatz. 7 | Viele der hier aufgeführten Informationen und Ideen stammen von 8 | luftdaten.info, so dass man bei Fragen auch gut [dort nachlesen kann](http://luftdaten.info/feinstaubsensor-bauen/). 9 | 10 | Wir gehen hier davon aus, dass du an unserem Ulmer 11 | Feinstaub Projekt mit [TTN](https://www.thethingsnetwork.org/community/ulm/) 12 | teilnimmst, denn da rufen wir die Messdaten an einer zentralen 13 | Stelle aus TTN ab und leiten sie gesammelt direkt an die API von 14 | luftdaten.info weiter. 15 | 16 | Wer dies nicht möchte oder braucht, kann natürlich die Daten in TTN z.B. 17 | via MQTT selbst abholen und weiterverarbeiten. 18 | 19 | **Kontakt und Rückfragen** am einfachsten im (verschwoerhaus.slack.com) 20 | im Channel #feinstaub. 21 | 22 | 23 | ## Benötigte Hardware 24 | 25 | Neben den Sensoren hast du die Wahl zwischen ~zwei Arduinos~ mehreren Boards. 26 | Der The Things UNO wird mittlerweile offenbar nicht mehr vertrieben. Der Adafruit 27 | war zum Zeitpunkt des ersten Aufschriebs dieses Dokuments unsere Empfehlung. Mittlerweile 28 | gibt es auf den üblichen Versandportalen auch viele weitere günstige Boards mit LoRa 29 | (868 MHz!) z.B. auf Basis des ESP32. 30 | 31 | * SDS011 - [Bestellen](http://de.aliexpress.com/wholesale?site=deu&SortType=price_asc&shipCountry=de&SearchText=sds011&CatId=523) 32 | * DHT22 - [Bestellen](http://de.aliexpress.com/wholesale?site=deu&SortType=price_asc&shipCountry=de&SearchText=dht22&CatId=523) 33 | * BME280 (statt DHT22) - [Bestellen](http://de.aliexpress.com/wholesale?site=deu&SortType=price_asc&shipCountry=de&SearchText=bme280&CatId=523) 34 | * LoRA Node (nur eine nötig) 35 | * ~The Things UNO - [Bestellen](https://shop.thethingsnetwork.com/index.php/product/the-things-uno/)~ wird offenbar nicht mehr vertrieben 36 | * Adafruit Feather - [Bestellen](http://www.exp-tech.de/adafruit-feather-m0-with-rfm95-lora-radio-900mhz) (nicht wundern, 900Mhz ist korrekt) 37 | * Oder ein passendes anderes Board, z.B. nach „ESP32 LoRa“ suchen 38 | * Micro USB Flachband Kabel, 2m - [Bestellen](https://www.amazon.de/s/?field-keywords=micro+usb+flachbandkabel+2m) 39 | * Kabel (Dupont) 40 | * Kabelbinder 41 | * flexibler Schlauch Innendurchmesser 6 mm (Baumarkt) 42 | * Wetterschutz, z.B. Marley Silent HT Bogen (DN 75 87°, Baumarkt) 43 | 44 | Andere Arduinos mit LoRa an Board funktionieren natürlich auch, nur 45 | haben wir für diese soweit keine genaue Anleitung parat. Aber, wenn du 46 | dich mit der Materie auskennst, ist eine Anpassung sicher sehr einfach. 47 | 48 | 49 | ## Benötigte Software 50 | 51 | Den Arduino-Sketch bekommt man in unserem [Github Repository](https://github.com/verschwoerhaus/ttn-ulm-feinstaub) 52 | ([direkter Download](https://github.com/verschwoerhaus/ttn-ulm-feinstaub/archive/master.zip)). 53 | 54 | Kopiere (oder `git clone`) den kompletten Ordner in dein Arduino-Sketch-Verzeichnis 55 | und öffne diesen in deiner Arduino IDE. 56 | 57 | Damit der Sketch funktioniert, musst du noch folgende Bibliotheken in 58 | der Arduino IDE über den Arduino Library Manager hinzufügen: 59 | 60 | * TheThingsNetwork 61 | * Adafruit Unified Sensor (weit nach unten scrollen) 62 | * DHT sensor library 63 | * Adafruit BME280 library 64 | 65 | 66 | ## Zusammenbauen 67 | 68 | ### The Things UNO 69 | 70 | #### Feinstaubsensor SDS011 71 | 72 | Am Feinstaubsensor werden von links nach rechts (wenn der Sensor flach 73 | auf dem Tisch liegt, Lüfter oben) folgende Pins verbunden: 74 | 75 | * PIN 1: freilassen 76 | * PIN 2: freilassen 77 | * PIN 3: 5V am The Things Uno 78 | * PIN 4: freilassen 79 | * PIN 5: GND am The Things Uno (egal welcher GND, es gibt 2) 80 | * PIN 6: PIN 8 am The Things Uno 81 | * PIN 7: PIN 9 am The Things Uno 82 | 83 | (Wer sich auskennt dann die Belegung der PINs auch im Sketch ändern.) 84 | 85 | #### Temperatur- und Feuchtigkeitssensor 86 | 87 | Die Software unterstützt mit dem DHT22 und dem BME280 zwei unterschiedliche 88 | Temperatur- und Luftfeuchtigkeitssensoren. In der Software ist standardmäßig 89 | der DHT22 aktiviert. Durch einkommentieren von "#define BME280" unterstützt 90 | die Software den BME280. Der Anschluß der beiden Sensoren wird im folgenden 91 | beschrieben. 92 | 93 | ##### DHT22 Temperatur- und Feuchtigkeitssensor 94 | 95 | Am Sensor werden vorne (das Gitter) von links nach rechts folgende Pins 96 | verbunden: 97 | 98 | * PIN 1: 3.3V am The Things Uno 99 | * PIN 2: PIN 10 am The Things Uno 100 | * PIN 3: freilassen 101 | * PIN 4: GND am The Things Uno (egal welcher GND, gibt 2) 102 | 103 | Eventuell kann es helfen, die Kabel am Sensorrücken mit einem Stück 104 | Gewebeband zu fixieren. Manche Kabel sitzen nicht sehr satt and den 105 | dünnen Beinchen. 106 | 107 | (Auch hier kann man die PIN-Belegung im Sketch anpassen, falls nötig.) 108 | 109 | ##### BME280 (statt DHT22) Temperatur- und Feuchtigkeitssensor 110 | 111 | Am BME280 sind die Pins bereits mit ihren I2C Namen markiert. Sie werden 112 | eins zu eins mit den Pins am The Things Uno verbunden: 113 | 114 | * VIN: 3.3V am The Things Uno 115 | * GND: GND am The Things Uno (egal welcher GND) 116 | * SCL: SCL am The Things Uno 117 | * SDA: SDA am The Things Uno 118 | 119 | 120 | 121 | ### Adafruit Feather 122 | 123 | Anleitung hierzu folgt bald. 124 | 125 | 126 | ### Zusammenstecken 127 | 128 | Wie man die Einzelteile in das Rohr einsetzt wird sehr gut direkt 129 | bei [luftdaten.info erklärt](http://luftdaten.info/feinstaubsensor-bauen/#komponenten-zusammenbau) 130 | erklärt. Besser könnten wir das hier auch nicht. 131 | 132 | 133 | ## Bei TTN registrieren & freischalten 134 | 135 | Damit du Daten via TTN versenden und empfangen kannst, musst 136 | du dich bei TTN anmelden. 137 | Wie oben geschrieben kommen die Messdaten am einfachsten über die Ulmer 138 | Feinstaub TTN-App `ttnulm-particulates` zu luftdaten.info; zu dieser App 139 | fügen wir dich natürlich gerne hinzu. Danach kannst du in dieser App 140 | ein Device erstellen, um deinen Feinstaubsensor am Netzwerk anzumelden 141 | und loszulegen. 142 | 143 | ### Schritt für Schritt: 144 | 145 | 1. [Anmelden bei The Things Network](https://www.thethingsnetwork.org/). 146 | Rechts oben auf *Sign up* klicken und registrieren. 147 | 2. Deinen The Things Network Username über [dieses Formular](TODO) oder 148 | kurz Nachricht im Verschwörhausslack (siehe weiter oben) an uns schicken. 149 | 3. Wir fügen dich über deinen Username zu unserer TTN Feinstaub App hinzu 150 | und benachrichtigen dich via E-Mail, sobald du hinzugefügt wurdest (wir 151 | verwenden deine Mailadresse für nichts anderes, versprochen). 152 | 4. Erstelle in deiner neuen TTN Feinstaub App `ttnulm-particulates` ein 153 | neues Device. Die Device EUI kannst du zuerst automatisch generieren 154 | lassen (2 Pfeilchen links), diese wird aber später nochmal ersetzt. 155 | Achte darauf, dass du bei der Erstellung die Aktivierungsmethode OTAA 156 | auswählst (sollte aber der Default sein). 157 | 5. Das luftdaten.info Projekt möchte zu jedem Sensor noch Details wie 158 | Aufstellungsort, Umgebung, etc. wissen, damit die Daten möglichst gut 159 | ausgewertet werden können. Wir übernehmen diese Kommunikation für dich, 160 | fülle dazu einfach [dieses Formular](TODO) aus. 161 | 6. Du bekommst von uns nochmal eine Mail, wenn alles freigeschalten und 162 | abgeschlossen ist. 163 | 164 | 165 | ## Arduino flashen 166 | 167 | Bevor der Arduino-Sketch auf den Arduino geflasht wird, 168 | müssen noch die TTN Daten deines Devices (siehe vorigen Schritt) 169 | hinzugefügt werden. 170 | Die Konfiguration befindet sich in der "configuration.h" Datei. Sollte 171 | die Datei noch nicht existieren, so kopiert die Standard Konfiguration 172 | "configuration.h.default" nach "configuration.h". 173 | 174 | Öffne die Datei "configuation.h" und ersetzte dort die zwei Zeilen 175 | ``` 176 | const char *devAddr = ""; 177 | const char *appSKey = ""; 178 | ``` 179 | mit den zwei Zeilen, die du am unteren Ende der Device Seite bei TTN 180 | siehst ("Example Code"). 181 | 182 | Solltest du einen BME280 Sensor verwenden, dann kommentiere bitte die 183 | Zeile "#define BME280_SENSOR" ein. Der Code wird dann mit der 184 | Unterstützug für den BME280 gebaut. 185 | 186 | Danach kannst du wie gewohnt über die Arduino IDE den Flashvorgang starten. 187 | 188 | **Wichtiger Schritt:** 189 | 190 | Beim ersten Start wird dir auf der seriellen Konsole die *echte* Device EUI 191 | der Node angezeigt. Kopiere diese und ersetze die vorher generierte Device EUI 192 | unter `Settings` bei deinem Device in der TTN Console. Nur dann kann deine OTAA Aktivierung funktionieren, es muss 193 | die Device EUI bei TTN mit der auf der seriellen Console übereinstimmen. 194 | 195 | 196 | ## Funktioniert es? 197 | 198 | Ob Daten ankommen und damit alles geklappt hat, kannst du in der TTN Console 199 | im Menüpunkt *Data* beim Device sehen. Dort tauchen je nach Sendeintervall deine 200 | Daten auf. Darauf achten, dass man auch dein Device ausgewählt hat, weil 201 | im App-übergreifenden *Data*-Bereich alle Daten aller Devices sieht. 202 | 203 | *Es funktioniert irgendwie nicht?* Hilfe zum Debugging [können wir hoffentlich bald anbieten](TODO). 204 | -------------------------------------------------------------------------------- /ttnulmdust/.gitignore: -------------------------------------------------------------------------------- 1 | .pioenvs 2 | .piolibdeps 3 | .vscode 4 | .vscode/* 5 | configuration.h 6 | -------------------------------------------------------------------------------- /ttnulmdust/BME280_Sensor.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "BME280_Sensor.h" 3 | #include "Adafruit_BME280.h" 4 | 5 | BME280_Sensor::BME280_Sensor(Serial_ serial, uint8_t bme280Address) 6 | { 7 | debugSerial = serial; 8 | address = bme280Address; 9 | } 10 | 11 | // **************************************************************** 12 | // Initialize the weather sensor 13 | // **************************************************************** 14 | bool BME280_Sensor::setup() 15 | { 16 | bool status = bme280.begin(address); 17 | if (!status) 18 | { 19 | debugSerial.println(F("Could not find a valid BME280 sensor, check wiring!")); 20 | while (1); 21 | } 22 | 23 | // set BME280 weather station mode (save some energy) 24 | bme280.setSampling(Adafruit_BME280::MODE_FORCED, 25 | Adafruit_BME280::SAMPLING_X1, // temperature 26 | Adafruit_BME280::SAMPLING_X1, // pressure 27 | Adafruit_BME280::SAMPLING_X1, // humidity 28 | Adafruit_BME280::FILTER_OFF); 29 | 30 | return true; 31 | } 32 | 33 | // **************************************************************** 34 | // read Temperature 35 | // **************************************************************** 36 | int16_t BME280_Sensor::readTemperature(void) 37 | { 38 | float temperature = bme280.readTemperature(); 39 | if (isnan(temperature)) 40 | { 41 | return -1; 42 | } 43 | 44 | debugSerial.print(F("Temperature: ")); 45 | debugSerial.println(String(temperature)); 46 | 47 | return round(temperature * 100); 48 | } 49 | 50 | // **************************************************************** 51 | // read barometric pressure 52 | // **************************************************************** 53 | int16_t BME280_Sensor::readPressure(void) 54 | { 55 | float pressure = bme280.readPressure(); 56 | if (isnan(pressure)) 57 | { 58 | return -1; 59 | } 60 | 61 | debugSerial.print(F("Pressure: ")); 62 | debugSerial.println(String(pressure)); 63 | 64 | return round(pressure * 100); 65 | } 66 | 67 | // **************************************************************** 68 | // read humidity 69 | // **************************************************************** 70 | int16_t BME280_Sensor::readHumidity(void) 71 | { 72 | float humidity = bme280.readHumidity(); 73 | if (isnan(humidity)) 74 | { 75 | return -1; 76 | } 77 | 78 | debugSerial.print(F("Humidity: ")); 79 | debugSerial.println(String(humidity)); 80 | 81 | return round(humidity * 100); 82 | } -------------------------------------------------------------------------------- /ttnulmdust/BME280_Sensor.h: -------------------------------------------------------------------------------- 1 | #ifndef __BME280_SENSOR_H__ 2 | #define __BME280_SENSOR_H__ 3 | 4 | #include 5 | #include "Adafruit_BME280.h" 6 | 7 | // **************************************************************** 8 | // BME280 Sensor class 9 | // used to move out the code for the sensors from the main sketch 10 | // NOTE: the methods shall return the normalized "int" values for 11 | // the data transmission 12 | // **************************************************************** 13 | class BME280_Sensor 14 | { 15 | public: 16 | BME280_Sensor(Serial_ serial, uint8_t address); 17 | bool setup(); 18 | int16_t readTemperature(void); 19 | int16_t readPressure(void); 20 | int16_t readHumidity(void); 21 | 22 | private: 23 | Serial_ debugSerial; 24 | uint8_t address; 25 | Adafruit_BME280 bme280; 26 | }; 27 | 28 | #endif -------------------------------------------------------------------------------- /ttnulmdust/DHT_Sensor.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "DHT_Sensor.h" 3 | #include "DHT.h" 4 | 5 | DHT_Sensor::DHT_Sensor(Serial_ serial, uint8_t pin, uint8_t type) : dht(pin, type) 6 | { 7 | debugSerial = serial; 8 | } 9 | 10 | // **************************************************************** 11 | // Initialize the weather sensor 12 | // **************************************************************** 13 | bool DHT_Sensor::setup() 14 | { 15 | dht.begin(); 16 | 17 | return true; 18 | } 19 | 20 | // **************************************************************** 21 | // read Temperature 22 | // **************************************************************** 23 | int16_t DHT_Sensor::readTemperature(void) 24 | { 25 | float temperature = dht.readTemperature(); 26 | if (isnan(temperature)) 27 | { 28 | return -1; 29 | } 30 | 31 | debugSerial.print(F("Temperature: ")); 32 | debugSerial.println(String(temperature)); 33 | 34 | return round(temperature * 100); 35 | } 36 | 37 | // **************************************************************** 38 | // read barometric pressure 39 | // **************************************************************** 40 | int16_t DHT_Sensor::readPressure(void) 41 | { 42 | return -1; 43 | } 44 | 45 | // **************************************************************** 46 | // read humidity 47 | // **************************************************************** 48 | int16_t DHT_Sensor::readHumidity(void) 49 | { 50 | float humidity = dht.readHumidity(); 51 | if (isnan(humidity)) 52 | { 53 | return -1; 54 | } 55 | 56 | debugSerial.print(F("Humidity: ")); 57 | debugSerial.println(String(humidity)); 58 | 59 | return round(humidity * 100); 60 | } -------------------------------------------------------------------------------- /ttnulmdust/DHT_Sensor.h: -------------------------------------------------------------------------------- 1 | #ifndef __DHT_SENSOR_H__ 2 | #define __DHT_SENSOR_H__ 3 | 4 | #include 5 | #include "DHT.h" 6 | 7 | // **************************************************************** 8 | // DHT Sensor class 9 | // used to move out the code for the sensors from the main sketch 10 | // NOTE: the methods shall return the normalized "int" values for 11 | // the data transmission 12 | // **************************************************************** 13 | class DHT_Sensor 14 | { 15 | public: 16 | DHT_Sensor(Serial_ serial, uint8_t pin, uint8_t type); 17 | bool setup(); 18 | int16_t readTemperature(void); 19 | int16_t readPressure(void); 20 | int16_t readHumidity(void); 21 | 22 | private: 23 | Serial_ debugSerial; 24 | DHT dht; 25 | }; 26 | 27 | #endif -------------------------------------------------------------------------------- /ttnulmdust/SDS011.cpp: -------------------------------------------------------------------------------- 1 | // SDS011 dust sensor PM2.5 and PM10 2 | // --------------------- 3 | // 4 | // By R. Zschiegner (rz@madavi.de) 5 | // April 2016 6 | // 7 | // Documentation: 8 | // - The iNovaFitness SDS011 datasheet 9 | // 10 | 11 | #include "SDS011.h" 12 | 13 | static const byte SLEEPCMD[19] = { 14 | 0xAA, // head 15 | 0xB4, // command id 16 | 0x06, // data byte 1 17 | 0x01, // data byte 2 (set mode) 18 | 0x00, // data byte 3 (sleep) 19 | 0x00, // data byte 4 20 | 0x00, // data byte 5 21 | 0x00, // data byte 6 22 | 0x00, // data byte 7 23 | 0x00, // data byte 8 24 | 0x00, // data byte 9 25 | 0x00, // data byte 10 26 | 0x00, // data byte 11 27 | 0x00, // data byte 12 28 | 0x00, // data byte 13 29 | 0xFF, // data byte 14 (device id byte 1) 30 | 0xFF, // data byte 15 (device id byte 2) 31 | 0x05, // checksum 32 | 0xAB // tail 33 | }; 34 | 35 | SDS011::SDS011(void) { 36 | 37 | } 38 | 39 | // -------------------------------------------------------- 40 | // SDS011:read 41 | // -------------------------------------------------------- 42 | int SDS011::read(float *p25, float *p10) { 43 | byte buffer; 44 | int value; 45 | int len = 0; 46 | int pm10_serial = 0; 47 | int pm25_serial = 0; 48 | int checksum_is; 49 | int checksum_ok = 0; 50 | int error = 1; 51 | while ((sds_data->available() > 0) && (sds_data->available() >= (10-len))) { 52 | buffer = sds_data->read(); 53 | value = int(buffer); 54 | switch (len) { 55 | case (0): if (value != 170) { len = -1; }; break; 56 | case (1): if (value != 192) { len = -1; }; break; 57 | case (2): pm25_serial = value; checksum_is = value; break; 58 | case (3): pm25_serial += (value << 8); checksum_is += value; break; 59 | case (4): pm10_serial = value; checksum_is += value; break; 60 | case (5): pm10_serial += (value << 8); checksum_is += value; break; 61 | case (6): checksum_is += value; break; 62 | case (7): checksum_is += value; break; 63 | case (8): if (value == (checksum_is % 256)) { checksum_ok = 1; } else { len = -1; }; break; 64 | case (9): if (value != 171) { len = -1; }; break; 65 | } 66 | len++; 67 | if (len == 10 && checksum_ok == 1) { 68 | *p10 = pm10_serial/10.0; 69 | *p25 = pm25_serial/10.0; 70 | len = 0; checksum_ok = 0; pm10_serial = 0.0; pm25_serial = 0.0; checksum_is = 0; 71 | error = 0; 72 | } 73 | yield(); 74 | } 75 | return error; 76 | } 77 | 78 | // -------------------------------------------------------- 79 | // SDS011:sleep 80 | // -------------------------------------------------------- 81 | void SDS011::sleep() { 82 | for (uint8_t i = 0; i < 19; i++) { 83 | sds_data->write(SLEEPCMD[i]); 84 | } 85 | sds_data->flush(); 86 | while (sds_data->available() > 0) { 87 | sds_data->read(); 88 | } 89 | } 90 | 91 | // -------------------------------------------------------- 92 | // SDS011:wakeup 93 | // -------------------------------------------------------- 94 | void SDS011::wakeup() { 95 | sds_data->write(0x01); 96 | sds_data->flush(); 97 | } 98 | 99 | void SDS011::begin(uint8_t pin_rx, uint8_t pin_tx) { 100 | _pin_rx = pin_rx; 101 | _pin_tx = pin_tx; 102 | 103 | SoftwareSerial *softSerial = new SoftwareSerial(_pin_rx, _pin_tx); 104 | 105 | //Initialize the 'Wire' class for I2C-bus communication. 106 | softSerial->begin(9600); 107 | 108 | sds_data = softSerial; 109 | } 110 | 111 | -------------------------------------------------------------------------------- /ttnulmdust/SDS011.h: -------------------------------------------------------------------------------- 1 | // SDS011 dust sensor PM2.5 and PM10 2 | // --------------------------------- 3 | // 4 | // By R. Zschiegner (rz@madavi.de) 5 | // April 2016 6 | // 7 | // Documentation: 8 | // - The iNovaFitness SDS011 datasheet 9 | // 10 | 11 | #if ARDUINO >= 100 12 | #include "Arduino.h" 13 | #else 14 | #include "WProgram.h" 15 | #endif 16 | 17 | #include 18 | 19 | 20 | class SDS011 { 21 | public: 22 | SDS011(void); 23 | void begin(uint8_t pin_rx, uint8_t pin_tx); 24 | int read(float *p25, float *p10); 25 | void sleep(); 26 | void wakeup(); 27 | private: 28 | uint8_t _pin_rx, _pin_tx; 29 | Stream *sds_data; 30 | }; 31 | -------------------------------------------------------------------------------- /ttnulmdust/configuration.h.default: -------------------------------------------------------------------------------- 1 | /***************************************************** 2 | * TTN Ulm particulate matter sensor 3 | * 4 | * To configure the sensor, enter your The Things Network 5 | * keys in "*appEui" and "*appKey" (you can copy the 6 | * values directly from the TTN Console). 7 | * 8 | * To use a BME280 sensor instead of the DHT22, just 9 | * uncomment the "#define BME280_SENSOR" line. In case 10 | * that the BME280 is not found, you can configure the 11 | * BME_ADDRESS below. 12 | * 13 | ******************************************************/ 14 | 15 | // copy and paste these values from your TTN console application 16 | const char *appEui = ""; 17 | const char *appKey = ""; 18 | 19 | // PIN configuration for the SDS011 dust sensor 20 | #define PIN_RX 8 // connect the SDS011 RX pin to this The Things Uno pin 21 | #define PIN_TX 9 // connect the SDS011 TX pin to this The Things Uno pin 22 | 23 | // DHT configuration 24 | #define DHTPIN 10 // connect the DHT22 PIN to this The Things Uno PIN 25 | #define DHTTYPE DHT22 // DHT 22 (AM2302), AM2321 26 | 27 | // uncomment to use BME280 weather sensor 28 | // #define BME280_SENSOR 29 | 30 | // default I2C address for the BME280 is 0x77 31 | // if your chinese import does not work, try to use 0x76 instead 32 | #define BME_ADDRESS 0x77 33 | 34 | // timeouts for power saving and measurements 35 | #define SLEEP_ON 1 // if the fan should go to sleep 36 | #define SLEEP_TIME 5 // sleep for x minutes between readings 37 | #define FAN_SPINUP 30 // how long should the fan 'clean' itself before measurements are taken (if SLEEP_ON = 1) 38 | #define PWR_DOWN 0 // set to 1 to use power down mode of µC, new flash needs manual reset 39 | 40 | //*************************************************** 41 | // You don't need to change anyhting below this line 42 | //*************************************************** 43 | #define DEBUGRATE 9600 44 | #define LORA_RATE 57600 45 | 46 | #define loraSerial Serial1 47 | #define debugSerial Serial -------------------------------------------------------------------------------- /ttnulmdust/platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; http://docs.platformio.org/page/projectconf.html 10 | 11 | 12 | [platformio] 13 | src_dir = . 14 | 15 | [env:thingsuno] 16 | platform = atmelavr 17 | board = leonardo 18 | framework = arduino 19 | monitor_speed= 9600 20 | lib_deps = 21 | DHT sensor library 22 | TheThingsNetwork 23 | Adafruit Unified Sensor 24 | 25 | -------------------------------------------------------------------------------- /ttnulmdust/sleep_32u4.h: -------------------------------------------------------------------------------- 1 | /* 2 | Sleepfunctions for Arduino Leonardo (ATmega32u4) 3 | !!! experimental !!! 4 | sleep mode leads to shutdown of usb port, atm it wont wake up again. 5 | New flash is only possible by reseting the board manually. 6 | */ 7 | 8 | #define SLEEP_FACTOR 15 9 | 10 | static uint16_t iSleepTimeout = 0; 11 | extern volatile uint16_t iWakeCntr; 12 | 13 | // set sleep timeout in minutes 14 | static bool setSleepTime(uint16_t iSleep){ 15 | if(iSleep <= UINT16_MAX/SLEEP_FACTOR){ 16 | iSleepTimeout = iSleep*SLEEP_FACTOR; 17 | Serial.println("Device sleep time set to "+String(iSleepTimeout/SLEEP_FACTOR)+" minutes"); 18 | return true; 19 | } 20 | return false; 21 | } 22 | 23 | // deactivate functions to save energy while running the program 24 | // e.g. if you don't use i2c deactivate the TWI 25 | void setupPowerMode(){ 26 | // prepare power down mode 27 | ADCSRA &= ~(1<<7); // disable ADCSRA 28 | ACSR = 0b10000000; // disable analog comperator 29 | SMCR |= (1<= iSleepTimeout) 76 | break; 77 | 78 | __asm__ __volatile__("sleep"); 79 | } 80 | prepareSleep(false); 81 | Serial.println("Ticker: "+String(iWakeCntr)); 82 | iWakeCntr = 0; 83 | Serial.println("back from sleep"); 84 | 85 | return true; 86 | } 87 | else 88 | Serial.println("Invalid sleep timeout"); 89 | 90 | return false; 91 | } 92 | -------------------------------------------------------------------------------- /ttnulmdust/ttnulmdust.ino: -------------------------------------------------------------------------------- 1 | /***************************************************** 2 | * TTN Ulm particulate matter sensor 3 | * 4 | * Reads data from a SDS011 sensor and send the data 5 | * to the TTN network via LoRaWAN. 6 | * 7 | * To configure your particulate matter sensor, copy 8 | * the configuration.h.default file to configuration.h 9 | * and enter the correct values for your sensor (e.g. 10 | * the keys for the The Things Network). 11 | * 12 | * Works like this: 13 | * 1) sleeps for a given amount of time. 14 | * 2) spins up the fan for a minute to clean the fan 15 | * and the housing. 16 | * 3) takes 10 samples of sensor data (pm2.5 and pm10) 17 | * 4) calculates the median of each to avoid outlier 18 | * 5) encodes the values into bytes 19 | * 6) send them to the given TTN application 20 | * 21 | ******************************************************/ 22 | #include "SDS011.h" 23 | #include "configuration.h" 24 | #include 25 | #include "sleep_32u4.h" 26 | 27 | // include and create an instance of the weather sensor 28 | #ifdef BME280_SENSOR 29 | #include "BME280_Sensor.h" 30 | 31 | BME280_Sensor weatherSensor(debugSerial, BME_ADDRESS); // I2C - connect SCL to SCL and SDA to SDA 32 | #else 33 | #include 34 | 35 | DHT_Sensor weatherSensor(debugSerial, DHTPIN, DHTTYPE); 36 | #endif 37 | 38 | // sleep time between fan spinup and sleep in minutes. 39 | volatile uint16_t iWakeCntr = 0; 40 | 41 | // WDT ISR 42 | ISR(WDT_vect) 43 | { 44 | if (iWakeCntr > UINT16_MAX-1) 45 | { 46 | iWakeCntr = 0; 47 | } 48 | else 49 | { 50 | iWakeCntr++; 51 | } 52 | } 53 | 54 | // TTN settings (no editing needed) 55 | const ttn_fp_t freqPlan = TTN_FP_EU868; 56 | TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan); 57 | 58 | // SDS011, paticulate matter variables (no editing needed) 59 | float p10, p25; 60 | float samples_p10[10]; 61 | float samples_p25[10]; 62 | int error; 63 | SDS011 my_sds; 64 | 65 | void setup() 66 | { 67 | debugSerial.begin(DEBUGRATE); 68 | loraSerial.begin(LORA_RATE); 69 | 70 | while (!debugSerial && millis() < 10000); 71 | 72 | // fine dust 73 | debugSerial.println(F("Started!")); 74 | my_sds.begin(PIN_RX, PIN_TX); 75 | 76 | // start the weather sensor 77 | weatherSensor.setup(); 78 | 79 | #if PWR_DOWN 80 | // for debugging 81 | pinMode(13, OUTPUT); 82 | setupPowerMode(); 83 | #endif 84 | 85 | ttn.showStatus(); 86 | ttn.join(appEui, appKey); // OTAA 87 | } 88 | 89 | void loop() { 90 | digitalWrite(13, HIGH); 91 | 92 | // ************************** 93 | // Wake up and fan speed up 94 | // ************************** 95 | // wake up the sensor 96 | #if SLEEP_ON 97 | debugSerial.println(F("Waking up SDS...")); 98 | my_sds.wakeup(); 99 | 100 | // let the fan run for a minute to clean the fan 101 | debugSerial.println(F("Letting fan speed up and clean itself for a minute...")); 102 | long delay1 = 1000L * FAN_SPINUP; 103 | delay(delay1); 104 | #endif 105 | 106 | // ****************************************************************** 107 | // Read weather sensor data (temperature / humidity) 108 | // ****************************************************************** 109 | int16_t hint = weatherSensor.readHumidity(); 110 | int16_t tint = weatherSensor.readTemperature(); 111 | 112 | // ********************** 113 | // SDS011 114 | // ********************** 115 | debugSerial.println(F("Reading 10 samples of sensor data (some may fail)...")); 116 | 117 | // read pm25 and pm10 values from the sensor 118 | long delay2 = 1100; 119 | long samples = 10; 120 | 121 | for (int i = 0; i < samples; i++) 122 | { 123 | error = my_sds.read(&p25, &p10); 124 | if (!error) 125 | { 126 | samples_p25[i] = p25; 127 | samples_p10[i] = p10; 128 | 129 | debugSerial.println("P2.5: " + String(p25)); 130 | debugSerial.println("P10: " + String(p10)); 131 | } 132 | else 133 | { 134 | debugSerial.println(F("error reading data!")); 135 | } 136 | 137 | delay(delay2); 138 | } 139 | 140 | float p25median = median(samples_p25, 10); 141 | float p10median = median(samples_p10, 10); 142 | 143 | // Encode float as int (20.98 becomes 2098) 144 | int16_t p10int = round(p10median * 100); 145 | int16_t p25int = round(p25median * 100); 146 | 147 | // show the median on the debug console 148 | debugSerial.print(F("P2.5 median: ")); 149 | debugSerial.println(String(p25median)); 150 | debugSerial.print(F("P10 median: ")); 151 | debugSerial.println(String(p10median)); 152 | 153 | // ********************** 154 | // TTN 155 | // ********************** 156 | // Encode int as bytes 157 | byte payload[8]; 158 | 159 | // sds011 160 | payload[0] = highByte(p10int); 161 | payload[1] = lowByte(p10int); 162 | payload[2] = highByte(p25int); 163 | payload[3] = lowByte(p25int); 164 | 165 | // sensor (temperature / humidity) 166 | payload[4] = highByte(hint); // humidity 167 | payload[5] = lowByte(hint); 168 | payload[6] = highByte(tint); // temperature 169 | payload[7] = lowByte(tint); 170 | 171 | // send via TTN 172 | debugSerial.println(F("Sending data to TTN...")); 173 | ttn.sendBytes(payload, sizeof(payload)); 174 | 175 | // ********************** 176 | // Sleep 177 | // ********************** 178 | #if SLEEP_ON 179 | // put sensor to sleep so save battery 180 | debugSerial.println(F("Sending SDS to sleep...")); 181 | my_sds.sleep(); 182 | 183 | // sleep for a few minutes to save energy 184 | #if PWR_DOWN 185 | //delay(5000); 186 | enterSleepFor(SLEEP_TIME); 187 | #else 188 | delay((1000L * 60 * SLEEP_TIME) - (delay1 + samples * delay2)); // substract wakup time to prevent heavy drift 189 | #endif 190 | 191 | #endif 192 | } 193 | 194 | //***************************** 195 | // Helper functions 196 | //***************************** 197 | 198 | // calculate the median 199 | float median(float samples[], int m) 200 | { 201 | float sorted[m]; 202 | 203 | for(int i = 0; i < m; i++) 204 | { 205 | sorted[i] = samples[i]; 206 | } 207 | 208 | bubbleSort(sorted, m); 209 | 210 | if ((m & 0x01) == 0) 211 | { 212 | // even number of elements 213 | return (sorted[(m / 2) - 1] + sorted[m / 2]) / 2; 214 | } 215 | else 216 | { 217 | // odd number of elements 218 | return sorted[m / 2]; 219 | } 220 | } 221 | 222 | // sort array with bubble sort (needed for the median) 223 | void bubbleSort(float A[], int len) { 224 | unsigned long newn; 225 | unsigned long n = len; 226 | float temp = 0.0; 227 | 228 | do { 229 | newn = 1; 230 | 231 | for(int p = 1; p < len; p++) 232 | { 233 | if (A[p - 1] > A[p]) 234 | { 235 | temp = A[p]; 236 | A[p] = A[p - 1]; 237 | A[p - 1] = temp; 238 | newn = p; 239 | } 240 | } 241 | 242 | n = newn; 243 | } while (n > 1); 244 | } 245 | --------------------------------------------------------------------------------