commit 39740276ec2d52d9b71a4eb3dbd7e0268270dbf5 Author: simon Date: Tue Feb 16 10:40:22 2021 +0700 minimum viable product diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..70ab999 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# python stuff +__pycache__ + +# protect real config files +config +config.h + +# frontend font files +*.ttf \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..09c3f8d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,621 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc0a467 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# AQI sensor project + +This is a place to show off what went into building my AQI measuring station currently publishing to: + +[lpb-air.com](lpb-air.com) + +This is a *Minimum Viable Product* and under development. The main purpose is educational. + +The webserver is a simple VPS, provisioned with docker-compose.yml. + +## aqi_monitor +*aqi_monitor.ino* is the arduino script running on the **nodeMCU ESP8266** microcontroller. The microcontroller posts data to the flask backend on a regular interval. +Connected to that is: +* SDS011: pm2.5 and pm10 sensor from Nova Fitness. +* BME280: Pressure Humidity Temperature Sensor Module. + +## backend +A [flask](https://pypi.org/project/Flask/) based application that takes the data from the ESP8266 for processing and storage. + +## frontend +A simple web site that gets AQI values from the backend to publish it nicely to see. Mostly build with HTML/CSS/JS and a little bit of PHP. diff --git a/aqi_monitor/aqi_monitor.ino b/aqi_monitor/aqi_monitor.ino new file mode 100644 index 0000000..1610544 --- /dev/null +++ b/aqi_monitor/aqi_monitor.ino @@ -0,0 +1,169 @@ +// config file +#include "config.h" + +// basics +#include +#include "base64.h" + +// wifi +#include +#include +#include + +// sds +#include + +// bme +#include +#include +#include +#include + + +// pin mapping +#define SDS_PIN_RX D7 +#define SDS_PIN_TX D8 +#define BME_SCK D1 +#define BME_MISO D4 +#define BME_MOSI D2 +#define BME_CS D3 + + +// initiate devices +NovaSDS011 sds011; +Adafruit_BME280 bme(BME_CS, BME_MOSI, BME_MISO, BME_SCK); // software SPI +ESP8266WiFiMulti WiFiMulti; + + +// build base64 auth string +String auth = base64::encode(String(authUsername) + ":" + String(authPassword)); + + +void setup() { + Serial.begin(9600); + delay(500); + Serial.println(); + + // initiate device + sds011.begin(SDS_PIN_RX, SDS_PIN_TX); + + + if (sds011.setWorkingMode(WorkingMode::work)) { + Serial.println("SDS011 working mode \"Work\""); + } else { + Serial.println("FAIL: Unable to set working mode \"Work\""); + } + + // main loop speed + if (sds011.setDutyCycle(3)) { + Serial.println("SDS011 Duty Cycle set to 3min"); + } else { + Serial.println("FAIL: Unable to set Duty Cycle"); + } + + // BME setup + // default settings + bool status; + status = bme.begin(); + if (!status) { + Serial.println("Could not find a valid BME280 sensor, check wiring!"); + } + + // wifi setup + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); + + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("."); + } + Serial.println(""); + Serial.println("WiFi connected"); + Serial.println("IP address: "); + Serial.println(WiFi.localIP()); + Serial.println(); + +} + + +void loop() { + // setup vars + float pm25, pm10, temperature, pressure, humidity; + int uptime; + // wait until no errors to print values + if (sds011.queryData(pm25, pm10) == QuerryError::no_error) { + + uptime = millis() / 1000; + // bme vars + temperature = bme.readTemperature(); + pressure = bme.readPressure() / 100.0F; + humidity = bme.readHumidity(); + + // build JSON + StaticJsonDocument<200> doc; + + doc["uptime"] = uptime; + doc["temperature"] = temperature; + doc["pressure"] = pressure; + doc["humidity"] = humidity; + doc["pm25"] = pm25; + doc["pm10"] = pm10; + + // send data + String response; + + if (WiFi.status() == WL_CONNECTED) { + + // format json body + String requestBody; + serializeJson(doc, requestBody); + Serial.println(requestBody); + + // connect to remote + WiFiClientSecure client; + client.setInsecure(); + char host[] = "data.lpb-air.com"; + + // retry on error + int retry = 0; + while ((!client.connect(host, 443)) && (retry < 5)) { + delay(1000); + Serial.print("."); + retry++; + } + if (retry == 5) { + Serial.println("Connection failed"); + } + // build request + client.print(String("POST ") + "/ingest" + + " HTTP/1.1\r\n" + + "Host: " + host + "\r\n" + + "Authorization: Basic " + auth + "\r\n" + + "Connection: close\r\n" + + "Content-Length: " + requestBody.length() + "\r\n" + + "Content-Type: application/json;charset=UTF-8\r\n\r\n" + + requestBody + "\r\n"); + + // read response + while (client.connected()) { + String line = client.readStringUntil('\n'); + if (line == "\r") { + break; + } + } + while (client.available()) { + response += client.readStringUntil('\n'); + } + Serial.println(response); + + } else { + + // wifi problems + Serial.println("wifi not connected"); + + } + + delay(60000); + + } +} diff --git a/aqi_monitor/config.sample.h b/aqi_monitor/config.sample.h new file mode 100644 index 0000000..756bc3d --- /dev/null +++ b/aqi_monitor/config.sample.h @@ -0,0 +1,7 @@ +// example config file + +const char* ssid = "my-wifi-ssid"; +const char* password = "my-wifi-password"; + +const char* authUsername = "username"; +const char* authPassword = "password"; diff --git a/backend/flask/.dockerignore b/backend/flask/.dockerignore new file mode 100644 index 0000000..ed8ebf5 --- /dev/null +++ b/backend/flask/.dockerignore @@ -0,0 +1 @@ +__pycache__ \ No newline at end of file diff --git a/backend/flask/Dockerfile b/backend/flask/Dockerfile new file mode 100644 index 0000000..7138ce8 --- /dev/null +++ b/backend/flask/Dockerfile @@ -0,0 +1,14 @@ +# Use the Python3.7.2 image +FROM python + +# Set the working directory to /app +WORKDIR /app + +# Copy the current directory contents into the container at /app +ADD . /app + +# Install the dependencies +RUN pip install -r requirements.txt + +# run the command to start uWSGI +CMD ["uwsgi", "app.ini"] diff --git a/backend/flask/app.ini b/backend/flask/app.ini new file mode 100644 index 0000000..4e98651 --- /dev/null +++ b/backend/flask/app.ini @@ -0,0 +1,10 @@ +[uwsgi] +wsgi-file = run.py +callable = app +socket = :8080 +processes = 4 +threads = 2 +master = true +chmod-socket = 660 +vacuum = true +die-on-term = true diff --git a/backend/flask/app/__init__.py b/backend/flask/app/__init__.py new file mode 100644 index 0000000..7b1c6f4 --- /dev/null +++ b/backend/flask/app/__init__.py @@ -0,0 +1,5 @@ +from flask import Flask + +app = Flask(__name__) + +from app import views diff --git a/backend/flask/app/aqi_parser.py b/backend/flask/app/aqi_parser.py new file mode 100644 index 0000000..17a2b59 --- /dev/null +++ b/backend/flask/app/aqi_parser.py @@ -0,0 +1,73 @@ +import json +from datetime import datetime +import numpy as np + +def input_process(data): + # parse string + # print(data) + # print('type' + type(data)) + json_dict = data + + pm25 = json_dict['pm25'] + + aqi, aqi_category = get_AQI(pm25) + json_dict['aqi_value'] = float(aqi) + json_dict['aqi_category'] = aqi_category + + now = datetime.now() + timestamp = now.strftime("%Y-%m-%d %H:%M:%S") + epoch_time = int(now.strftime('%s')) + + json_dict['timestamp'] = timestamp + json_dict['epoch_time'] = epoch_time + + new_string = json.dumps(json_dict) + + return new_string + + +def get_AQI(pm25): + if pm25 <= 12: + aqi = (pm25 / 12) * 50 + aqi_category = "Good" + elif pm25 > 12 and pm25 <= 35.4: + perc = (pm25 - 12) / (35.4 - 12) + aqi = (100 - 50) * perc + 50 + aqi_category = "Moderate" + elif pm25 > 35.4 and pm25 <= 55.4: + perc = (pm25 - 35.4) / (55.4 - 35.4) + aqi = (150 - 100) * perc + 100 + aqi_category = "Unhealthy for Sensitive Groups" + elif pm25 > 55.4 and pm25 <= 150.4: + perc = (pm25 - 55.4) / (150.4 - 55.4) + aqi = (200 - 150) * perc + 150 + aqi_category = "Unhealthy" + elif pm25 > 150.4 and pm25 <= 199.9: + perc = (pm25 - 150.4) / (199.9 - 150.4) + aqi = (250 - 200) * perc + 200 + aqi_category = "Very Unhealthy" + elif pm25 > 199.9 and pm25 <= 250.4: + perc = (pm25 - 199.9) / (250.4 - 199.9) + aqi = (300 - 250) * perc + 250 + aqi_category = "Very Unhealthy" + elif pm25 > 250.4 and pm25 <= 299.9: + perc = (pm25 - 250.4) / (299.9 - 250.4) + aqi = (350 - 300) * perc + 300 + aqi_category = "Hazardous" + elif pm25 > 299.9 and pm25 <= 350.4: + perc = (pm25 - 299.9) / (350.4 - 299.9) + aqi = (400 - 350) * perc + 350 + aqi_category = "Hazardous" + elif pm25 > 350.4 and pm25 <= 424.6: + perc = (pm25 - 350.4) / (424.6 - 350.4) + aqi = (450 - 400) * perc + 400 + aqi_category = "Hazardous" + elif pm25 > 424.6 and pm25 <= 500.4: + perc = (pm25 - 424.6) / (500.4 - 424.6) + aqi = (500 - 450) * perc + 450 + aqi_category = "Hazardous" + elif pm25 > 500.4: + aqi = pm25 + aqi_category = "Hazardous" + aqi = np.round_(int(aqi), decimals=0, out=None) + return aqi, aqi_category diff --git a/backend/flask/app/views.py b/backend/flask/app/views.py new file mode 100644 index 0000000..df1402c --- /dev/null +++ b/backend/flask/app/views.py @@ -0,0 +1,63 @@ +import configparser + +from flask_cors import CORS +from flask import request +from flask_httpauth import HTTPBasicAuth + +from app import app +from app import aqi_parser + +cors = CORS(app, resources={r"/": {"origins": "*"}}) +auth = HTTPBasicAuth() + + +def get_config(): + """ read out config file """ + # parse + config_parser = configparser.ConfigParser() + config_parser.read('config') + # build dict + config = {} + config["authUsername"] = config_parser.get('aqi_monitor', "authUsername") + config["authPassword"] = config_parser.get('aqi_monitor', "authPassword") + return config + + +config = get_config() + + +# build username / pw dict for basic auth +USER_DATA = {} +USER_DATA[config['authUsername']] = config['authPassword'] + + +@auth.verify_password +def verify(username, password): + if not (username and password): + return False + return USER_DATA.get(username) == password + + +# ingest +@app.route('/ingest', methods=['POST']) +@auth.login_required +def ingest(): + data = request.json + if data: + data = aqi_parser.input_process(data) + with open('dyn/values.json', 'w') as f: + f.write(data) + print(data) + return 'ingest' + + +# output +@app.route('/') +def home(): + try: + with open('dyn/values.json', 'r') as f: + data = f.read() + except FileNotFoundError: + # will get regeneratod on next run + data = '{}' + return data diff --git a/backend/flask/config.sample b/backend/flask/config.sample new file mode 100644 index 0000000..e664d09 --- /dev/null +++ b/backend/flask/config.sample @@ -0,0 +1,3 @@ +[aqi_monitor] +authUsername = username +authPassword = password \ No newline at end of file diff --git a/backend/flask/dyn/values.json b/backend/flask/dyn/values.json new file mode 100644 index 0000000..b678851 --- /dev/null +++ b/backend/flask/dyn/values.json @@ -0,0 +1 @@ +{"uptime": 1476, "temperature": 28.46, "pressure": 975.0873, "humidity": 40.52051, "pm25": 11, "pm10": 64.4, "aqi_value": 45.0, "aqi_category": "Good", "timestamp": "2021-02-14 14:27:06", "epoch_time": 1613287626} \ No newline at end of file diff --git a/backend/flask/requirements.txt b/backend/flask/requirements.txt new file mode 100644 index 0000000..b30c269 --- /dev/null +++ b/backend/flask/requirements.txt @@ -0,0 +1,5 @@ +Flask +flask-cors +Flask-HTTPAuth +uWSGI +numpy diff --git a/backend/flask/run.py b/backend/flask/run.py new file mode 100644 index 0000000..d014d8e --- /dev/null +++ b/backend/flask/run.py @@ -0,0 +1,26 @@ +""" + +Documentation: https://flask.palletsprojects.com + +Install on Arch +- sudo pacman -S python-flask +- sudo pacman -S python-flask-httpauth + +or with pip +- pip install Flask +- pip install Flask-HTTPAuth + + +Run Debug env: +export FLASK_APP=run.py +export FLASK_DEBUG=1 + +""" + + +from app import app + + + +if __name__ == "__main__": + app.run() diff --git a/backend/nginx/Dockerfile b/backend/nginx/Dockerfile new file mode 100644 index 0000000..e60bd5b --- /dev/null +++ b/backend/nginx/Dockerfile @@ -0,0 +1,8 @@ +# Use the Nginx image +FROM nginx + +# Remove the default nginx.conf +RUN rm /etc/nginx/conf.d/default.conf + +# Replace with our own nginx.conf +COPY nginx.conf /etc/nginx/conf.d/ diff --git a/backend/nginx/nginx.conf b/backend/nginx/nginx.conf new file mode 100644 index 0000000..1ffac49 --- /dev/null +++ b/backend/nginx/nginx.conf @@ -0,0 +1,10 @@ +server { + + listen 80; + + location / { + include uwsgi_params; + uwsgi_pass flask:8080; + } + +} \ No newline at end of file diff --git a/deploy.sh b/deploy.sh new file mode 100755 index 0000000..244099c --- /dev/null +++ b/deploy.sh @@ -0,0 +1,9 @@ +#!/bin/bash +# upload project to vps2 + +rsync --progress -a docker-compose.yml vps2:docker/ +rsync --progress -a --delete-after --exclude dyn --exclude config.sample backend vps2:docker/ +rsync --progress -a --delete-after frontend vps2:docker/ + +## +exit 0 diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..a200e77 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,73 @@ +version: "3" + +services: + # ssl + letsencrypt: + image: jrcs/letsencrypt-nginx-proxy-companion + container_name: nginx-proxy-letsencrypt + restart: always + volumes: + - ./volume/nginx-proxy/html:/usr/share/nginx/html + - ./volume/nginx-proxy/dhparam:/etc/nginx/dhparam + - ./volume/nginx-proxy/vhost:/etc/nginx/vhost.d + - ./volume/nginx-proxy/certs:/etc/nginx/certs + - /run/docker.sock:/var/run/docker.sock:ro + environment: + - NGINX_PROXY_CONTAINER=nginx-proxy + - DEFAULT_EMAIL=simobilleter@gmail.com + # proxy for all web services + nginx-proxy: + image: jwilder/nginx-proxy + container_name: nginx-proxy + restart: always + ports: + - "80:80" + - "443:443" + volumes: + - ./volume/nginx-proxy/html:/usr/share/nginx/html + - ./volume/nginx-proxy/dhparam:/etc/nginx/dhparam + - ./volume/nginx-proxy/vhost:/etc/nginx/vhost.d + - ./volume/nginx-proxy/certs:/etc/nginx/certs + - /run/docker.sock:/tmp/docker.sock:ro + labels: + - "com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy" + # backend flask + flask: + build: ./backend/flask + container_name: flask + restart: always + environment: + - APP_NAME=FlaskBackend + - TZ=Asia/Bangkok + expose: + - "8080" + # backend nginx + nginx: + build: ./backend/nginx + container_name: backend_nginx + restart: always + environment: + - VIRTUAL_HOST=data.lpb-air.com + - LETSENCRYPT_HOST=data.lpb-air.com + expose: + - "80" + # php fast-cgi + php: + image: php:7-fpm + container_name: php-fpm + restart: always + volumes: + - ./frontend/nginx:/air + # lpb-air + air: + image: nginx + container_name: lpb-air_nginx + restart: always + expose: + - "80" + volumes: + - ./frontend/nginx:/air:rw + - ./frontend/nginx.conf:/etc/nginx/conf.d/default.conf + environment: + - VIRTUAL_HOST=www.lpb-air.com,lpb-air.com + - LETSENCRYPT_HOST=www.lpb-air.com,lpb-air.com diff --git a/frontend/nginx.conf b/frontend/nginx.conf new file mode 100644 index 0000000..2114710 --- /dev/null +++ b/frontend/nginx.conf @@ -0,0 +1,23 @@ +server { + listen 80; + index index.php index.html; + server_name localhost; + error_log /var/log/nginx/error.log; + access_log /var/log/nginx/access.log; + root /air; + + location ~ \.php$ { + try_files $uri =404; + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_pass php:9000; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; + fastcgi_param PATH_INFO $fastcgi_path_info; + } +} + +server { + server_name lpb-air.com; + return 301 https://www.lpb-air.com$request_uri; +} diff --git a/frontend/nginx/css/style.css b/frontend/nginx/css/style.css new file mode 100644 index 0000000..64110ed --- /dev/null +++ b/frontend/nginx/css/style.css @@ -0,0 +1,91 @@ +@font-face { + font-family: Rubik-Bold; + src: url(/font/Rubik-Bold.ttf); +} + +@font-face { + font-family: Rubik-Light; + src: url(/font/Rubik-Light.ttf); +} + +@font-face { + font-family: Rubik-Regular; + src: url(/font/Rubik-Regular.ttf); +} + +body { + margin: 0; + padding: 0; +} + +h1 { + font-family: Rubik-Bold; + font-size: 3em; +} + +h2 { + font-family: Rubik-Light; +} + +p { + font-family: Rubik-Regular; +} + +.colorbox { + height: 40px; + margin: 0; + padding: 0; +} + +.title { + padding: 30px 0; +} + +.top_content, .tagline_content { + width: 70%; + max-width: 800px; + margin-left: auto; + margin-right: auto; +} + +.cloud { + position: relative; + padding-bottom: 30px; +} + +.cloud img { + width: 100%; +} + +.aqi_box { + position: absolute; + top: 50%; + left: 50%; + text-align: right; + transform: translate(-50%, -50%); + color: #fff; +} + +.aqi_box h1 { + font-size: 10em; + margin: 0; +} + +.aqi_box h2 { + margin: 0; +} + +.tagline_content { + text-align: center; +} + +/* responsiv */ +@media screen and (max-width: 700px) { + + .top_content { + width: 90%; + } + .aqi_box h1 { + font-size: 7em; + } +} \ No newline at end of file diff --git a/frontend/nginx/favicon.ico b/frontend/nginx/favicon.ico new file mode 100644 index 0000000..ba9ca4f Binary files /dev/null and b/frontend/nginx/favicon.ico differ diff --git a/frontend/nginx/img/cloud.png b/frontend/nginx/img/cloud.png new file mode 100644 index 0000000..b04f0dc Binary files /dev/null and b/frontend/nginx/img/cloud.png differ diff --git a/frontend/nginx/index.php b/frontend/nginx/index.php new file mode 100644 index 0000000..4dc1d9d --- /dev/null +++ b/frontend/nginx/index.php @@ -0,0 +1,35 @@ + + + + + + + + + AQI + + +
+
+
+
+

Live Air Quality

+

in Luang Prabang Laos PDR

+

Last updated:

+
+
+ cloud +
+

+

+
+
+
+
+
+
+

More is coming soon here!

+
+
+ + \ No newline at end of file diff --git a/frontend/nginx/js/aqi.js b/frontend/nginx/js/aqi.js new file mode 100644 index 0000000..cd09159 --- /dev/null +++ b/frontend/nginx/js/aqi.js @@ -0,0 +1,77 @@ +document.addEventListener("DOMContentLoaded", startInterval); + + +var colorConfig = +{ + // green + 'Good': [ + "#85a762", "#dbe4d1", + "invert(66%) sepia(11%) saturate(1318%) hue-rotate(47deg) brightness(92%) contrast(86%)"], + // yellow + 'Moderate': [ + "#d4b93c", "#f9f0c7", + "invert(79%) sepia(5%) saturate(4660%) hue-rotate(9deg) brightness(89%) contrast(103%)"], + // orange + 'Unhealthy for Sensitive Groups': [ + "#e96843", "#f8d0c8", + "invert(61%) sepia(93%) saturate(3252%) hue-rotate(333deg) brightness(95%) contrast(91%)"], + // red + 'Unhealthy': [ + "#d03f3b", "#f1c5c4", + "invert(39%) sepia(16%) saturate(2264%) hue-rotate(314deg) brightness(97%) contrast(110%)"], + // pink + 'Very Unhealthy': [ + "#be4173", "#e9c9d6", + "invert(45%) sepia(32%) saturate(3238%) hue-rotate(308deg) brightness(77%) contrast(90%)"], + // violet + 'Hazardous': [ + "#714261", "#d7c6d0", + "invert(31%) sepia(8%) saturate(2659%) hue-rotate(268deg) brightness(91%) contrast(88%)"] +} + +function startInterval() { + refreshAqiValues(); + setInterval("refreshAqiValues();",60000); +} + + +// wrap for setAqiValues +function refreshAqiValues() { + var req = new XMLHttpRequest(); + req.responseType = 'json'; + req.open('GET', 'https://data.lpb-air.com', true); + req.setRequestHeader('cache-control', 'no-cache'); + req.onload = function() { + var responseAqi = req.response; + var timestamp = responseAqi['timestamp']; + var aqiValue = responseAqi['aqi_value']; + var aqiCategory = responseAqi['aqi_category']; + setAqiValues(timestamp,aqiValue,aqiCategory); + setAqiColors(aqiCategory) + }; + req.send(); +} + +function setAqiValues(timestamp,aqiValue,aqiCategory) { + + document.getElementById('aqiValue').innerHTML = aqiValue; + document.getElementById('aqiCategory').innerHTML = aqiCategory; + document.getElementById('timestamp').innerHTML = timestamp; + +} + +function setAqiColors(aqiCategory) { + // parse config + var colMain = colorConfig[aqiCategory][0]; + var colSecond = colorConfig[aqiCategory][1]; + var colFilter = colorConfig[aqiCategory][2]; + // apply main col + document.getElementById('colorbox').style.backgroundColor = colMain; + // apply light background change + var lightBg = document.getElementsByClassName('light_background'); + for(var i = 0; i < lightBg.length; i++) { + lightBg[i].style.backgroundColor = colSecond; + }; + // apply cloud + document.getElementById('cloud').style.filter = colFilter; +} diff --git a/tests/example_post.py b/tests/example_post.py new file mode 100755 index 0000000..fd2d8c0 --- /dev/null +++ b/tests/example_post.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python3 +""" test script to post data to the ingest route """ + +import requests +import json +import configparser + +# get auth +config_parser = configparser.ConfigParser() +config_parser.read('../backend/flask/config') +user_name = config_parser.get('aqi_monitor', "authUsername") +user_pass = config_parser.get('aqi_monitor', "authPassword") + +# example json data as from the esp8266 +json_data = { + "uptime": 1476, + "temperature": 28.46, + "pressure": 995.0873, + "humidity": 10.52051, + "pm25": 56.5, + "pm10": 64.4 +} + +# make the call +response = requests.post("https://data.lpb-air.com/ingest", json=json_data, auth = (user_name, user_pass)) + +# print result +print(response) +print(response.text)