From 2cec286dd357943662bd16f4bdf77242ef8bbc6b Mon Sep 17 00:00:00 2001 From: FauconSpartiate <49079695+FauconSpartiate@users.noreply.github.com> Date: Tue, 7 Jun 2022 08:13:03 +0200 Subject: [PATCH] Rebase because I'm a shitty dev --- .gitignore | 7 + .vscode/extensions.json | 10 + .vscode/settings.json | 55 ++++ LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++ README.md | 59 ++++ platformio.ini | 24 ++ src/OmniWeather.cpp | 260 ++++++++++++++++ src/OmniWeather.h | 13 + src/sensors.cpp | 229 ++++++++++++++ src/sensors.h | 18 ++ src/ssh.cpp | 674 ++++++++++++++++++++++++++++++++++++++++ src/ssh.h | 32 ++ 12 files changed, 2055 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json create mode 100644 LICENSE create mode 100644 README.md create mode 100644 platformio.ini create mode 100644 src/OmniWeather.cpp create mode 100644 src/OmniWeather.h create mode 100644 src/sensors.cpp create mode 100644 src/sensors.h create mode 100644 src/ssh.cpp create mode 100644 src/ssh.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7065325 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch +src/authentication.h +resources \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..fd9c56d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,55 @@ +{ + "files.associations": { + "string": "cpp", + "string_view": "cpp", + "array": "cpp", + "deque": "cpp", + "unordered_map": "cpp", + "unordered_set": "cpp", + "vector": "cpp", + "initializer_list": "cpp", + "*.tcc": "cpp", + "cctype": "cpp", + "clocale": "cpp", + "cmath": "cpp", + "cstdarg": "cpp", + "cstddef": "cpp", + "cstdint": "cpp", + "cstdio": "cpp", + "cstdlib": "cpp", + "cstring": "cpp", + "ctime": "cpp", + "cwchar": "cpp", + "cwctype": "cpp", + "exception": "cpp", + "algorithm": "cpp", + "functional": "cpp", + "system_error": "cpp", + "tuple": "cpp", + "type_traits": "cpp", + "fstream": "cpp", + "iomanip": "cpp", + "iosfwd": "cpp", + "istream": "cpp", + "limits": "cpp", + "memory": "cpp", + "new": "cpp", + "ostream": "cpp", + "numeric": "cpp", + "sstream": "cpp", + "stdexcept": "cpp", + "streambuf": "cpp", + "cinttypes": "cpp", + "utility": "cpp", + "typeinfo": "cpp" + }, + "C_Cpp.errorSquiggles": "Disabled", + "C_Cpp.dimInactiveRegions": false, + "search.exclude": { + ".pio": true, + ".vscode": true, + "include": true, + "lib": true, + "test": true + } +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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 + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ab649f --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +
+ + +# OmniWeather + +A simple weather station, powered by an Adafruit ESP32 Feather. The measured results are uploaded every hour to a SSH server. + +
+ +## Measured Data + +- Temperature +- Humidity +- Barometric pressure +- Wind speed +- Wind direction +- Rainfall +- UV index + +## Features + +- Periodic data upload on a SSH server (default is 1h) +- WI-FI connection / reconnection on signal loss + +## Usage/Examples + +[Here's a page](https://foxi.ltam.lu/2CI/pirda350/public/OmniWeather/Weather_Reports/) that shows the output of this code. It should still be running, and new reports are added every hour. + +We also created [an UI in Vue.js](https://foxi.ltam.lu/2CI/collo939/public/OmniWeather/) that goes through the latest hourly report and shows it in an user friendly way. You may take a look at it, it should also be updating every hour. + +## Tech Stack + +**Microcontroller:** PlatformIO + +**Server:** Simple SSH storage server + +## Deployment + +You'll first need some sensors : + +- BME280 sensor for temperature, humidity and pressure +- VEML6070 sensor for UV light + +The wind speed, wind direction and rain sensors were 3D printed from this awesome project : +[LTB Weather Station by RobWLakes](https://www.thingiverse.com/thing:2849562). He also explains how to mount the whole thing, and I also took some code from there. Massive thanks to him for that! + +## Optimizations + +Everything was programmed with my ass, the code is kinda fucked, but it works and that's the only thing that matters. Every optimization is welcome! + +## Authors + +- [@fauconspartiate](https://github.com/FauconSpartiate) +- [@xavion-lux](https://github.com/xavion-lux) +- [@aiglespartiate](https://github.com/AigleSpartiate) + +## License + +[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/) diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..7ad248a --- /dev/null +++ b/platformio.ini @@ -0,0 +1,24 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:featheresp32] +platform = espressif32 +board = featheresp32 +framework = arduino +monitor_speed = 115200 +lib_deps = + beegee-tokyo/DHT sensor library for ESPx@^1.18 + bblanchon/ArduinoJson@^6.19.4 + ewpa/LibSSH-ESP32@^2.2.0 + adafruit/DHT sensor library@^1.4.3 + adafruit/Adafruit BMP280 Library@^2.6.2 + adafruit/Adafruit BME280 Library@^2.2.2 + adafruit/Adafruit VEML6070 Library@^1.0.6 + adafruit/Adafruit AM2320 sensor library@^1.2.2 diff --git a/src/OmniWeather.cpp b/src/OmniWeather.cpp new file mode 100644 index 0000000..9a11ea9 --- /dev/null +++ b/src/OmniWeather.cpp @@ -0,0 +1,260 @@ +#include +#include +#include "SPIFFS.h" +#include "IPv6Address.h" +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include "tcpip_adapter.h" +#include +#include "driver/uart.h" +#include "esp_vfs_dev.h" + +#include "OmniWeather.h" +#include "sensors.h" +#include "ssh.h" + +struct _reent reent_data_esp32; +struct _reent *_impure_ptr = &reent_data_esp32; + +// Timing and timeout configuration. +#define WIFI_TIMEOUT_S 10 +#define NET_WAIT_MS 100 + +bool wifiConnected; +bool gotIpAddr; + +unsigned long getUNIX() +{ + time_t now; + struct tm timeinfo; + if (!getLocalTime(&timeinfo)) + { + Serial.println("Failed to obtain time"); + return (0); + } + time(&now); + return now; +} + +String getTime(bool fileName) +{ + struct tm timeinfo; + if (!getLocalTime(&timeinfo)) + { + Serial.println(F("Failed to obtain time")); + return "Failed to obtain time"; + } + + String month = String(timeinfo.tm_mon + 1); + String day = String(timeinfo.tm_mday); + String hours = String(timeinfo.tm_hour); + String mins = String(timeinfo.tm_min); + + if (timeinfo.tm_mon + 1 < 10) + month = "0" + month; + if (timeinfo.tm_mday < 10) + day = "0" + day; + if (timeinfo.tm_hour < 10) + hours = "0" + hours; + if (timeinfo.tm_min < 10) + mins = "0" + mins; + + if (!fileName) + return (String(timeinfo.tm_year + 1900) + "-" + month + "-" + day + " " + hours + ":" + mins); + else + return (String(timeinfo.tm_year + 1900) + "-" + month + "-" + day + "-" + hours + "-" + mins); +} + +#define delayTime 60000 +#define TICK 100 + +void controlTask(void *pvParameter) +{ + _REENT_INIT_PTR((&reent_data_esp32)); + + init(); + Serial.println("% Sensors set up"); + + // Mount the file system. + boolean fsGood = SPIFFS.begin(); + if (!fsGood) + { + printf("%% No formatted SPIFFS filesystem found to mount.\n"); + printf("%% Formatting SPIFFS\n"); + fsGood = SPIFFS.format(); + if (fsGood) + SPIFFS.begin(); + } + if (!fsGood) + { + printf("%% Aborting now.\n"); + while (true) + vTaskDelay(TICK); + } + printf("%% Mounted SPIFFS used=%d total=%d\r\n", SPIFFS.usedBytes(), SPIFFS.totalBytes()); + + connectWiFI(); + + configTime(3600, 3600, NTPSERVER); + + vTaskDelay(2000); + + disconnectWiFI(); + + int lastHour = -1; + + while (true) + { + struct tm timeinfo; + if (!getLocalTime(&timeinfo)) + { + Serial.println(F("Failed to obtain time")); + break; + } + + // if (timeinfo.tm_sec == 0) + if (timeinfo.tm_min == 0 && timeinfo.tm_hour != lastHour) + { + lastHour = timeinfo.tm_hour; + + DynamicJsonDocument doc(2048); + + doc["time"] = getTime(false); + doc["UNIX"] = getUNIX(); // UNIX + doc["temperature"] = getTemp(); // ° + doc["humidity"] = getHumid(); // % + doc["UV"] = getUV(); // UV Index + doc["rain"] = getRain(); // mm + doc["wind_speed"] = getWindSpeed(); // km/h + doc["wind_direction"] = getWindDirection(); // ° + doc["barometric_pressure"] = getPressure(); // hPA + doc["altitude"] = getAltitude(); // m + + resetValues(); + + connectWiFI(); + + libssh_begin(); + + String fileNameS = (String("/") + getTime(true) + String(".json")); + char fileName[fileNameS.length() + 1]; + fileNameS.toCharArray(fileName, fileNameS.length() + 1); + + String fileName2S = "/spiffs" + fileNameS; + char fileName2[fileName2S.length() + 1]; + fileName2S.toCharArray(fileName2, fileName2S.length() + 1); + + char *fileCommand[] = {"libssh_scp", fileName2, SSHSERVER, NULL}; + + File file = SPIFFS.open(fileName, FILE_WRITE); + + Serial.println("Writing JSON:"); + serializeJsonPretty(doc, file); + serializeJsonPretty(doc, Serial); + Serial.println(""); + + file.close(); + + int ex_argc = sizeof fileCommand / sizeof fileCommand[0] - 1; + printf("%% Execution in progress:"); + short a; + for (a = 0; a < ex_argc; a++) + printf(" %s", fileCommand[a]); + printf("\n"); + int ex_rc = ex_main(ex_argc, fileCommand); + printf("%% Execution completed with return code: %d\n", ex_rc); + + // SPIFFS.format(); + SPIFFS.remove(fileNameS); + + disconnectWiFI(); + } + + vTaskDelay(TICK); + } +} + +void setup() +{ + uart_driver_install((uart_port_t)CONFIG_CONSOLE_UART_NUM, 256, 0, 0, NULL, 0); + esp_vfs_dev_uart_use_driver(CONFIG_CONSOLE_UART_NUM); + Serial.begin(115200); + + tcpip_adapter_init(); + esp_event_loop_init(event_cb, NULL); + + // Stack size needs to be larger, so continue in a new task. + xTaskCreatePinnedToCore(controlTask, "ctl", 40960, NULL, (tskIDLE_PRIORITY + 3), NULL, portNUM_PROCESSORS - 1); +} + +void loop() +{ + // Nothing to do here since controlTask has taken over. + vTaskDelay(TICK); +} + +void connectWiFI() +{ + disconnectWiFI(); + WiFi.mode(WIFI_MODE_STA); + WiFi.setHostname("OmniWeather"); + WiFi.begin(WIFISSID, WIFIPASSWORD); + + unsigned long lastTime = millis(); + + while (!gotIpAddr) + { + vTaskDelay(TICK); + + if (!wifiConnected && millis() - lastTime > 10000) + connectWiFI(); + } +} + +void disconnectWiFI() +{ + gotIpAddr = false; + WiFi.disconnect(true); + WiFi.mode(WIFI_OFF); +} + +// WiFi +esp_err_t event_cb(void *ctx, system_event_t *event) +{ + switch (event->event_id) + { + case SYSTEM_EVENT_STA_START: + Serial.print("% WiFi Enabled - SSID: "); + Serial.println(WIFISSID); + break; + case SYSTEM_EVENT_STA_CONNECTED: + wifiConnected = true; + Serial.print("% WiFi Connected - SSID: "); + Serial.println(WIFISSID); + break; + case SYSTEM_EVENT_STA_GOT_IP: + gotIpAddr = true; + Serial.print("% WIFi - IPv4 Address: "); + Serial.println(IPAddress(event->event_info.got_ip.ip_info.ip.addr)); + break; + case SYSTEM_EVENT_STA_LOST_IP: + case SYSTEM_EVENT_STA_DISCONNECTED: + wifiConnected = false; + gotIpAddr = false; + Serial.print("% WIFi Disconnected - SSID: "); + Serial.println(WIFISSID); + // connectWiFI(); + break; + default: + break; + } + return ESP_OK; +} \ No newline at end of file diff --git a/src/OmniWeather.h b/src/OmniWeather.h new file mode 100644 index 0000000..8fe60e7 --- /dev/null +++ b/src/OmniWeather.h @@ -0,0 +1,13 @@ +#ifndef OMNIWEATHER_H +#define OMNIWEATHER_H + +#include +#include +#include "authentication.h" + +ssh_session connect_ssh(const char *hostname, const char *user, int verbosity); +esp_err_t event_cb(void *ctx, system_event_t *event); +void connectWiFI(); +void disconnectWiFI(); + +#endif diff --git a/src/sensors.cpp b/src/sensors.cpp new file mode 100644 index 0000000..90d5458 --- /dev/null +++ b/src/sensors.cpp @@ -0,0 +1,229 @@ +#include "sensors.h" + +#include +#include +#include +#include + +#define RAINPIN 32 +#define WINDSPEEDPIN 33 +#define BME280ADDRESS 0x76 +const int WINDDIRECTIONPINS[8] = {39, 36, 4, 18, 19, 16, 17, 21}; + +const char *compass[] = {"N ", "NNE", "NE ", "ENE", "E ", "ESE", "SE ", "SSE", "S ", "SSW", "SW ", "WSW", "W ", "WNW", "NW ", "NNW", "???"}; + +#define TIMERDELAY 400 + +unsigned long rainFall = 0; +unsigned long windSpeed = 0; +unsigned long rainFallTimer = 0; +unsigned long windSpeedTimer = 0; + +Adafruit_BME280 bme; +Adafruit_VEML6070 uv = Adafruit_VEML6070(); + +void init() +{ + bme.begin(BME280ADDRESS); + uv.begin(VEML6070_2_T); + + pinMode(RAINPIN, INPUT_PULLUP); + attachInterrupt(RAINPIN, rainTick, FALLING); + + pinMode(WINDSPEEDPIN, INPUT_PULLUP); + attachInterrupt(WINDSPEEDPIN, windTick, FALLING); + + pinMode(WINDDIRECTIONPINS[0], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[1], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[2], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[3], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[4], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[5], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[6], INPUT_PULLUP); + pinMode(WINDDIRECTIONPINS[7], INPUT_PULLUP); +} + +void IRAM_ATTR rainTick() +{ + if (millis() - rainFallTimer > TIMERDELAY) + { + if (digitalRead(RAINPIN)) + { + rainFall++; + Serial.print("Rain clapper tilted: "); + Serial.println(rainFall); + + rainFallTimer = millis(); + } + } +} + +void IRAM_ATTR windTick() +{ + if (millis() - windSpeedTimer > TIMERDELAY / 2) + { + if (digitalRead(WINDSPEEDPIN)) + { + windSpeed++; + Serial.print("Wind magnet passed: "); + Serial.println(windSpeed); + + windSpeedTimer = millis(); + } + } +} + +float getTemp() +{ + if (isnan(bme.readTemperature())) + /*sensors_event_t event; + dht.temperature().getEvent(&event); + if (isnan(event.temperature))*/ + { + Serial.println(F("Error reading temperature!")); + return -1; + } + else + { + int a = (int)bme.readTemperature() * 10; + // int a = (int)event.temperature * 10; + return (a / 10.0); + } +} + +float getHumid() +{ + if (isnan(bme.readHumidity())) + /*sensors_event_t event; + dht.humidity().getEvent(&event); + if (isnan(event.relative_humidity))*/ + { + Serial.println(F("Error reading humidity!")); + return -1; + } + else + { + int a = (int)bme.readHumidity() * 10; + // int a = (int)event.relative_humidity * 10; + return (a / 10.0); + } +} + +int getPressure() +{ + if (isnan(bme.readPressure())) + { + Serial.println(F("Error reading pressure!")); + return -1; + } + else + { + int a = (int)(bme.readPressure() / 100.0) * 10; + return (a / 10.0); + } +} + +int getAltitude() +{ + if (isnan(bme.readAltitude(1013.25))) + { + Serial.println(F("Error reading pressure!")); + return -1; + } + else + { + int a = (int)(bme.readAltitude(1013.25)) * 10; + return (a / 10.0); + } +} + +int getUV() +{ + return map(uv.readUV(), 0, 2530, 1, 11); +} + +float getWindSpeed() +{ + windSpeed = 0; + delay(5000); + return (int)((windSpeed * 3.1414 * 2 * 0.065 * 12 * 60 / 1000) * 10) / 10.0; +} + +String getWindDirection() +{ + int pointer = -1; + int direct = 0; + + for (int i = 0; i < 8; i++) + { + direct += pow(digitalRead(WINDDIRECTIONPINS[i]), (2 * i)); + } + + switch (direct) + { + case 1: + pointer = 0; + break; + case 3: + pointer = 1; + break; + case 2: + pointer = 2; + break; + case 6: + pointer = 3; + break; + case 4: + pointer = 4; + break; + case 12: + pointer = 5; + break; + case 8: + pointer = 6; + break; + case 24: + pointer = 7; + break; + case 16: + pointer = 8; + break; + case 48: + pointer = 9; + break; + case 32: + pointer = 10; + break; + case 96: + pointer = 11; + break; + case 64: + pointer = 12; + break; + case 192: + pointer = 13; + break; + case 128: + pointer = 14; + break; + case 129: + pointer = 15; + break; + default: + pointer = 16; + break; + } + + return compass[pointer]; +} + +unsigned long getRain() +{ + // TODO convert to correct unit + return rainFall * 0.3527; +} + +void resetValues() +{ + rainFall = 0; +} \ No newline at end of file diff --git a/src/sensors.h b/src/sensors.h new file mode 100644 index 0000000..5d20bfa --- /dev/null +++ b/src/sensors.h @@ -0,0 +1,18 @@ +#ifndef SENSORS_H +#define SENSORS_H +#include "Arduino.h" + +void init(); +float getTemp(); +float getHumid(); +int getUV(); +unsigned long getRain(); +float getWindSpeed(); +String getWindDirection(); +int getPressure(); +int getAltitude(); +void rainTick(); +void windTick(); +void resetValues(); + +#endif \ No newline at end of file diff --git a/src/ssh.cpp b/src/ssh.cpp new file mode 100644 index 0000000..68281b3 --- /dev/null +++ b/src/ssh.cpp @@ -0,0 +1,674 @@ +#include + +#ifndef BUF_SIZE +#define BUF_SIZE 4096 +#endif + +static char **sources; +static int nsources; +static char *destination; +static int verbosity = 0; + +struct location +{ + int is_ssh; + char *user; + char *host; + char *path; + ssh_session session; + ssh_scp scp; + FILE *file; +}; + +enum +{ + READ, + WRITE +}; + +// Dummy implementation of 'chdir'. +int chdir(const char *path) +{ + (void)path; + return 0; +} + +/* + * authentication.c + * This file contains an example of how to do an authentication to a + * SSH server using libssh + */ + +#include +#include +#include + +void error(ssh_session session) +{ + fprintf(stderr, "Authentication failed: %s\n", ssh_get_error(session)); +} + +int authenticate_console(ssh_session session) +{ + int rc; + int method; + char password[128] = {0}; + char *banner; + + // Try to authenticate + rc = ssh_userauth_none(session, NULL); + if (rc == SSH_AUTH_ERROR) + { + error(session); + return rc; + } + + method = ssh_userauth_list(session, NULL); + // method = SSH_AUTH_METHOD_PUBLICKEY; + while (rc != SSH_AUTH_SUCCESS) + { + // Try to authenticate with password + if (method & SSH_AUTH_METHOD_PASSWORD) + { + rc = ssh_userauth_password(session, NULL, SSHPASSWORD); + if (rc == SSH_AUTH_ERROR) + { + error(session); + return rc; + } + else if (rc == SSH_AUTH_SUCCESS) + { + break; + } + } + memset(password, 0, sizeof(password)); + } + + banner = ssh_get_issue_banner(session); + if (banner) + { + printf("%s\n", banner); + SSH_STRING_FREE_CHAR(banner); + } + + return rc; +} + +/* + * knownhosts.c + * This file contains an example of how verify the identity of a + * SSH server using libssh + */ + +#include "libssh_esp32_config.h" + +#include +#include +#include +#include + +#include "libssh/priv.h" + +void usage(const char *argv0) +{ + fprintf(stderr, "Usage : %s [options] [[user@]host1:]file1 ... \n" + " [[user@]host2:]destination\n" + "sample scp client - libssh-%s\n", + // "Options :\n", + // " -r : use RSA to verify host public key\n", + argv0, + ssh_version(0)); + exit(0); +} + +int opts(int argc, char **argv) +{ + int i; + optind = 0; + + while ((i = getopt(argc, argv, "v")) != -1) + { + switch (i) + { + case 'v': + verbosity++; + break; + default: + fprintf(stderr, "unknown option %c\n", optopt); + usage(argv[0]); + return -1; + } + } + + nsources = argc - optind - 1; + if (nsources < 1) + { + usage(argv[0]); + return -1; + } + + sources = (char **)malloc((nsources + 1) * sizeof(char *)); + if (sources == NULL) + { + return -1; + } + + for (i = 0; i < nsources; ++i) + { + sources[i] = argv[optind]; + optind++; + } + + sources[i] = NULL; + destination = argv[optind]; + return 0; +} + +void location_free(struct location *loc) +{ + if (loc) + { + if (loc->path) + { + free(loc->path); + } + loc->path = NULL; + if (loc->is_ssh) + { + if (loc->host) + { + free(loc->host); + } + loc->host = NULL; + if (loc->user) + { + free(loc->user); + } + loc->user = NULL; + } + free(loc); + } +} + +struct location *parse_location(char *ploc) +{ + char *loc = strdup(ploc); + struct location *location; + char *ptr; + + location = (struct location *)malloc(sizeof(struct location)); + if (location == NULL) + { + return NULL; + } + memset(location, 0, sizeof(struct location)); + + location->host = location->user = NULL; + ptr = strchr(loc, ':'); + + if (ptr != NULL) + { + location->is_ssh = 1; + location->path = strdup(ptr + 1); + *ptr = '\0'; + ptr = strchr(loc, '@'); + + if (ptr != NULL) + { + location->host = strdup(ptr + 1); + *ptr = '\0'; + location->user = strdup(loc); + } + else + { + location->host = strdup(loc); + } + } + else + { + location->is_ssh = 0; + location->path = strdup(loc); + } + free(loc); + return location; +} + +void close_location(struct location *loc) +{ + int rc; + + if (loc) + { + if (loc->is_ssh) + { + if (loc->scp) + { + rc = ssh_scp_close(loc->scp); + if (rc == SSH_ERROR) + { + fprintf(stderr, + "Error closing scp: %s\n", + ssh_get_error(loc->session)); + } + ssh_scp_free(loc->scp); + loc->scp = NULL; + } + if (loc->session) + { + ssh_disconnect(loc->session); + ssh_free(loc->session); + loc->session = NULL; + } + } + else + { + if (loc->file) + { + fclose(loc->file); + loc->file = NULL; + } + } + } +} + +int open_location(struct location *loc, int flag) +{ + if (loc->is_ssh && flag == WRITE) + { + loc->session = connect_ssh(loc->host, loc->user, verbosity); + if (!loc->session) + { + fprintf(stderr, "Couldn't connect to %s\n", loc->host); + return -1; + } + + loc->scp = ssh_scp_new(loc->session, SSH_SCP_WRITE, loc->path); + if (!loc->scp) + { + fprintf(stderr, "error : %s\n", ssh_get_error(loc->session)); + ssh_disconnect(loc->session); + ssh_free(loc->session); + loc->session = NULL; + return -1; + } + + if (ssh_scp_init(loc->scp) == SSH_ERROR) + { + fprintf(stderr, "error : %s\n", ssh_get_error(loc->session)); + ssh_scp_free(loc->scp); + loc->scp = NULL; + ssh_disconnect(loc->session); + ssh_free(loc->session); + loc->session = NULL; + return -1; + } + return 0; + } + else if (loc->is_ssh && flag == READ) + { + loc->session = connect_ssh(loc->host, loc->user, verbosity); + if (!loc->session) + { + fprintf(stderr, "Couldn't connect to %s\n", loc->host); + return -1; + } + + loc->scp = ssh_scp_new(loc->session, SSH_SCP_READ, loc->path); + if (!loc->scp) + { + fprintf(stderr, "error : %s\n", ssh_get_error(loc->session)); + ssh_disconnect(loc->session); + ssh_free(loc->session); + loc->session = NULL; + return -1; + } + + if (ssh_scp_init(loc->scp) == SSH_ERROR) + { + fprintf(stderr, "error : %s\n", ssh_get_error(loc->session)); + ssh_scp_free(loc->scp); + loc->scp = NULL; + ssh_disconnect(loc->session); + ssh_free(loc->session); + loc->session = NULL; + return -1; + } + return 0; + } + else + { + loc->file = fopen(loc->path, flag == READ ? "r" : "w"); + if (!loc->file) + { + if (errno == EISDIR) + { + if (loc->path != NULL && chdir(loc->path)) + { + fprintf(stderr, + "Error changing directory to %s: %s\n", + loc->path, strerror(errno)); + return -1; + } + return 0; + } + fprintf(stderr, + "Error opening %s: %s\n", + loc->path, strerror(errno)); + return -1; + } + return 0; + } + return -1; +} + +/** @brief copies files from source location to destination + * @param src source location + * @param dest destination location + * @param recursive Copy also directories + */ +int do_copy(struct location *src, struct location *dest, int recursive) +{ + size_t size; + socket_t fd; + struct stat s; + int w, r; + char buffer[BUF_SIZE]; + size_t total = 0; + mode_t mode; + char *filename = NULL; + + /* recursive mode doesn't work yet */ + (void)recursive; + /* Get the file name and size*/ + if (!src->is_ssh) + { + fd = fileno(src->file); + if (fd < 0) + { + fprintf(stderr, + "Invalid file pointer, error: %s\n", + strerror(errno)); + return -1; + } + r = fstat(fd, &s); + if (r < 0) + { + return -1; + } + size = s.st_size; + mode = s.st_mode & ~S_IFMT; + filename = ssh_basename(src->path); + } + else + { + size = 0; + do + { + r = ssh_scp_pull_request(src->scp); + if (r == SSH_SCP_REQUEST_NEWDIR) + { + ssh_scp_deny_request(src->scp, "Not in recursive mode"); + continue; + } + if (r == SSH_SCP_REQUEST_NEWFILE) + { + size = ssh_scp_request_get_size(src->scp); + filename = strdup(ssh_scp_request_get_filename(src->scp)); + mode = ssh_scp_request_get_permissions(src->scp); + // ssh_scp_accept_request(src->scp); + break; + } + if (r == SSH_ERROR) + { + fprintf(stderr, + "Error: %s\n", + ssh_get_error(src->session)); + SSH_STRING_FREE_CHAR(filename); + return -1; + } + } while (r != SSH_SCP_REQUEST_NEWFILE); + } + + if (dest->is_ssh) + { + r = ssh_scp_push_file(dest->scp, src->path, size, mode); + // snprintf(buffer, sizeof(buffer), "C0644 %d %s\n", size, src->path); + if (r == SSH_ERROR) + { + fprintf(stderr, + "error: %s\n", + ssh_get_error(dest->session)); + SSH_STRING_FREE_CHAR(filename); + ssh_scp_free(dest->scp); + dest->scp = NULL; + return -1; + } + } + else + { + if (!dest->file) + { + dest->file = fopen(filename, "w"); + if (!dest->file) + { + fprintf(stderr, + "Cannot open %s for writing: %s\n", + filename, strerror(errno)); + if (src->is_ssh) + { + ssh_scp_deny_request(src->scp, "Cannot open local file"); + } + SSH_STRING_FREE_CHAR(filename); + return -1; + } + } + if (src->is_ssh) + { + ssh_scp_accept_request(src->scp); + } + } + + do + { + if (src->is_ssh) + { + r = ssh_scp_read(src->scp, buffer, sizeof(buffer)); + if (r == SSH_ERROR) + { + fprintf(stderr, + "Error reading scp: %s\n", + ssh_get_error(src->session)); + SSH_STRING_FREE_CHAR(filename); + return -1; + } + + if (r == 0) + { + break; + } + } + else + { + r = fread(buffer, 1, sizeof(buffer), src->file); + if (r == 0) + { + break; + } + + if (r < 0) + { + fprintf(stderr, + "Error reading file: %s\n", + strerror(errno)); + SSH_STRING_FREE_CHAR(filename); + return -1; + } + } + + if (dest->is_ssh) + { + w = ssh_scp_write(dest->scp, buffer, r); + if (w == SSH_ERROR) + { + fprintf(stderr, + "Error writing in scp: %s\n", + ssh_get_error(dest->session)); + ssh_scp_free(dest->scp); + dest->scp = NULL; + SSH_STRING_FREE_CHAR(filename); + return -1; + } + } + else + { + w = fwrite(buffer, r, 1, dest->file); + if (w <= 0) + { + fprintf(stderr, + "Error writing in local file: %s\n", + strerror(errno)); + SSH_STRING_FREE_CHAR(filename); + return -1; + } + } + total += r; + + } while (total < size); + + SSH_STRING_FREE_CHAR(filename); + printf("wrote %zu bytes\n", total); + return 0; +} + +/* + * connect_ssh.c + * This file contains an example of how to connect to a + * SSH server using libssh + */ + +#include +#include "OmniWeather.h" +#include + +#include "sensors.h" + +ssh_session connect_ssh(const char *host, const char *user, int verbosity) +{ + ssh_session session; + int auth = 0; + + session = ssh_new(); + if (session == NULL) + { + return NULL; + } + + if (user != NULL) + { + if (ssh_options_set(session, SSH_OPTIONS_USER, user) < 0) + { + ssh_free(session); + return NULL; + } + } + + if (ssh_options_set(session, SSH_OPTIONS_HOST, host) < 0) + { + ssh_free(session); + return NULL; + } + ssh_options_set(session, SSH_OPTIONS_LOG_VERBOSITY, &verbosity); + if (ssh_connect(session)) + { + fprintf(stderr, "Connection failed : %s\n", ssh_get_error(session)); + ssh_disconnect(session); + ssh_free(session); + return NULL; + } + /*if (verify_knownhost(session) < 0) + { + ssh_disconnect(session); + ssh_free(session); + return NULL; + }*/ + auth = authenticate_console(session); + if (auth == SSH_AUTH_SUCCESS) + { + return session; + } + else if (auth == SSH_AUTH_DENIED) + { + fprintf(stderr, "Authentication failed\n"); + } + else + { + fprintf(stderr, "Error while authenticating : %s\n", ssh_get_error(session)); + } + ssh_disconnect(session); + ssh_free(session); + return NULL; +} + +int ex_main(int argc, char **argv) +{ + struct location *dest, *src; + int i; + int r; + if (opts(argc, argv) < 0) + { + return EXIT_FAILURE; + } + + ssh_init(); + + dest = parse_location(destination); + if (dest == NULL) + { + r = EXIT_FAILURE; + goto end; + } + + if (open_location(dest, WRITE) < 0) + { + location_free(dest); + r = EXIT_FAILURE; + goto end; + } + + for (i = 0; i < nsources; ++i) + { + src = parse_location(sources[i]); + if (src == NULL) + { + r = EXIT_FAILURE; + goto close_dest; + } + + if (open_location(src, READ) < 0) + { + location_free(src); + r = EXIT_FAILURE; + goto close_dest; + } + + if (do_copy(src, dest, 0) < 0) + { + close_location(src); + location_free(src); + break; + } + + close_location(src); + location_free(src); + } + + r = 0; + +close_dest: + close_location(dest); + location_free(dest); +end: + ssh_finalize(); + free(sources); + return r; +} \ No newline at end of file diff --git a/src/ssh.h b/src/ssh.h new file mode 100644 index 0000000..68406e6 --- /dev/null +++ b/src/ssh.h @@ -0,0 +1,32 @@ +#ifndef SSH_H +#define SSH_H +#include "Arduino.h" +#include "OmniWeather.h" +#include +#include "libssh_esp32.h" +#include +#include +#include +#include +#include +#include + +int chdir(const char *path); +void error(ssh_session session); +int authenticate_console(ssh_session session); +void usage(const char *argv0); +int opts(int argc, char **argv); +void location_free(struct location *loc); +struct location *parse_location(char *ploc); +void close_location(struct location *loc); +int open_location(struct location *loc, int flag); +/** @brief copies files from source location to destination + * @param src source location + * @param dest destination location + * @param recursive Copy also directories + */ +int do_copy(struct location *src, struct location *dest, int recursive); +ssh_session connect_ssh(const char *host, const char *user, int verbosity); +int ex_main(int argc, char **argv); + +#endif \ No newline at end of file