From bb2febe2e6a10657e8b520137d24933d79de63f1 Mon Sep 17 00:00:00 2001 From: Martin Date: Wed, 28 Jan 2026 15:16:38 +0100 Subject: [PATCH] created base structure --- .editorconfig | 47 ++ .flake8 | 4 + .gitignore | 3 + .pre-commit-config.yaml | 26 + AUTHORS | 10 + LICENSE | 661 ++++++++++++++++++ MANIFEST.in | 8 + README.rst | 35 + eslint.config.mjs | 63 ++ pyproject.toml | 53 ++ pyscada/__init__.py | 3 + pyscada/influxdb/__init__.py | 12 + pyscada/influxdb/admin.py | 12 + pyscada/influxdb/apps.py | 14 + pyscada/influxdb/daemon.py | 98 +++ pyscada/influxdb/management/__init__.py | 0 .../influxdb/management/commands/__init__.py | 0 .../influxdb/management/commands/sync_data.py | 99 +++ pyscada/influxdb/models.py | 226 ++++++ pyscada/influxdb/signals.py | 9 + pyscada/influxdb/tests.py | 5 + pyscada/influxdb/urls.py | 6 + setup.py | 43 ++ tox.ini | 89 +++ 24 files changed, 1526 insertions(+) create mode 100644 .editorconfig create mode 100644 .flake8 create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 AUTHORS create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100644 eslint.config.mjs create mode 100644 pyproject.toml create mode 100644 pyscada/__init__.py create mode 100644 pyscada/influxdb/__init__.py create mode 100644 pyscada/influxdb/admin.py create mode 100644 pyscada/influxdb/apps.py create mode 100644 pyscada/influxdb/daemon.py create mode 100644 pyscada/influxdb/management/__init__.py create mode 100644 pyscada/influxdb/management/commands/__init__.py create mode 100644 pyscada/influxdb/management/commands/sync_data.py create mode 100644 pyscada/influxdb/models.py create mode 100644 pyscada/influxdb/signals.py create mode 100644 pyscada/influxdb/tests.py create mode 100644 pyscada/influxdb/urls.py create mode 100644 setup.py create mode 100644 tox.ini diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e43144c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,47 @@ +# https://editorconfig.org/ + +root = true + +[*] +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true +end_of_line = lf +charset = utf-8 + +# Docstrings and comments use max_line_length = 79 +[*.py] +max_line_length = 88 + +# Use 2 spaces for the HTML files +[*.html] +indent_size = 2 + +# The JSON files contain newlines inconsistently +[*.json] +indent_size = 2 +insert_final_newline = ignore + +[**/admin/js/vendor/**] +indent_style = ignore +indent_size = ignore + +# Minified JavaScript files shouldn't be changed +[**.min.js] +indent_style = ignore +insert_final_newline = ignore + +# Makefiles always use tabs for indentation +[Makefile] +indent_style = tab + +# Batch files use tabs for indentation +[*.bat] +indent_style = tab + +[docs/**.txt] +max_line_length = 79 + +[*.yml] +indent_size = 2 diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..b863051 --- /dev/null +++ b/.flake8 @@ -0,0 +1,4 @@ +[flake8] +exclude = build,.git,.tox,./tests/.env +extend-ignore = E203 +max-line-length = 88 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..42ed8da --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.pyc +/build/* +/pyscada-influxdb.egg-info/* diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..a1a734a --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,26 @@ +repos: + - repo: https://github.com/psf/black-pre-commit-mirror + rev: 24.4.2 + hooks: + - id: black + exclude: \.py-tpl$ + - repo: https://github.com/adamchainz/blacken-docs + rev: 1.18.0 + hooks: + - id: blacken-docs + additional_dependencies: + - black==24.4.2 + files: 'docs/.*\.txt$' + args: ["--rst-literal-block"] + - repo: https://github.com/PyCQA/isort + rev: 5.13.2 + hooks: + - id: isort + - repo: https://github.com/PyCQA/flake8 + rev: 7.1.0 + hooks: + - id: flake8 + - repo: https://github.com/pre-commit/mirrors-eslint + rev: v9.7.0 + hooks: + - id: eslint diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..ad615d1 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,10 @@ +Current or previous core committers: + +* Martin Schröder + +Current and previous core designers: + +* Martin Schröder + +Contributors (in alphabetical order): + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..8773c6a --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,8 @@ +include AUTHORS +include LICENSE +include README.rst +include CHANGELOG.txt +recursive-include pyscada/influxdb/fixtures * +recursive-include pyscada/influxdb/templates * +recursive-exclude * *.pyc + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d44d9cc --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +PyScada Influxdb Extension +=================================== + +This is a extension for PyScada to Store Data in a Influxdb Bucket. + + +What is Working +--------------- + + - nothing + +What is not Working/Missing +--------------------------- + + - Documentation + - many more + +Installation +------------ + + - pip install pyscada-influxdb + + +Contribute +---------- + + - Issue Tracker: https://github.com/pyscada/PyScada-Influxdb/issues + - Source Code: https://github.com/pyscada/PyScada-Influxdb + + +License +------- + +The project is licensed under the _GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (AGPLv3)_. +- diff --git a/eslint.config.mjs b/eslint.config.mjs new file mode 100644 index 0000000..306adb3 --- /dev/null +++ b/eslint.config.mjs @@ -0,0 +1,63 @@ +import globals from "globals"; +import js from "@eslint/js"; + +export default [ + js.configs.recommended, + { + files: ["**/*.js"], + rules: { + "camelcase": ["off", {"properties": "always"}], + "comma-spacing": ["error", {"before": false, "after": true}], + "curly": ["error", "all"], + "dot-notation": ["error", {"allowKeywords": true}], + "eqeqeq": ["error"], + "indent": ["error", 4], + "key-spacing": ["error", {"beforeColon": false, "afterColon": true}], + "linebreak-style": ["error", "unix"], + "new-cap": ["off", {"newIsCap": true, "capIsNew": true}], + "no-alert": ["off"], + "no-eval": ["error"], + "no-extend-native": ["error", {"exceptions": ["Date", "String"]}], + "no-multi-spaces": ["error"], + "no-octal-escape": ["error"], + "no-script-url": ["error"], + "no-shadow": ["error", {"hoist": "functions"}], + "no-underscore-dangle": ["error"], + "no-unused-vars": ["error", {"vars": "local", "args": "none"}], + "no-var": ["error"], + "prefer-const": ["error"], + "quotes": ["off", "single"], + "semi": ["error", "always"], + "space-before-blocks": ["error", "always"], + "space-before-function-paren": ["error", {"anonymous": "never", "named": "never"}], + "space-infix-ops": ["error", {"int32Hint": false}], + "strict": ["error", "global"] + }, + languageOptions: { + ecmaVersion: 6, + sourceType: "script", + globals: { + ...globals.browser, + ...globals.commonjs, + "django": false + } + } + }, + { + files: ["**/*.mjs"], + languageOptions: { + sourceType: "module" + } + }, + { + ignores: [ + "**/*.min.js", + "**/vendor/**/*.js", + "django/contrib/gis/templates/**/*.js", + "django/views/templates/*.js", + "docs/_build/**/*.js", + "node_modules/**.js", + "tests/**/*.js", + ] + } +]; diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..86a6884 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,53 @@ +[build-system] +requires = ["setuptools>=61.0.0,<69.3.0"] +build-backend = "setuptools.build_meta:__legacy__" + +[project] +name = "PyScada-Influxdb" +version = "0.8.0" +requires-python = ">= 3.10" +dependencies = [ + "pyscada>=0.8.0", + "pytz", + "influxdb_client" +] +authors = [ + {name = "Martin Schröder", email = "team@pyscada.org"}, +] +description = "Influxdb extension for PyScada a Python and Django based Open Source SCADA System" +readme = "README.rst" +license = {text = "AGPLv3"} +classifiers = [ + "Development Status :: 4 - Beta", + "Environment :: Web Environment", + "Environment :: Console", + "Framework :: Django", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: POSIX", + "Operating System :: MacOS :: MacOS X", + "Programming Language :: Python", + "Programming Language :: JavaScript", + "Topic :: Internet :: WWW/HTTP :: Dynamic Content", + "Topic :: Scientific/Engineering :: Visualization", +] + + +[project.urls] +Homepage = "https://www.pyscada.org/" +Documentation = "https://pyscada.readthedocs.io" +Source = "https://github.com/pyscada/PyScada-Influxdb" +Tracker = "https://github.com/pyscada/PyScada-Influxdb/issues" + +[tool.black] +target-version = ["py310"] +force-exclude = "tests/test_runner_apps/tagged/tests_syntax_error.py" + +[tool.isort] +profile = "black" +default_section = "THIRDPARTY" +known_first_party = "pyscada" + +[tool.setuptools.packages.find] +include = ["pyscada*"] diff --git a/pyscada/__init__.py b/pyscada/__init__.py new file mode 100644 index 0000000..b36383a --- /dev/null +++ b/pyscada/__init__.py @@ -0,0 +1,3 @@ +from pkgutil import extend_path + +__path__ = extend_path(__path__, __name__) diff --git a/pyscada/influxdb/__init__.py b/pyscada/influxdb/__init__.py new file mode 100644 index 0000000..76fe847 --- /dev/null +++ b/pyscada/influxdb/__init__.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +__version__ = "0.1.0" +__author__ = "Martin Schröder" +__email__ = "team@pyscada.org" +__description__ = ( + "Influxdb extension for PyScada a Python and Django based Open Source SCADA System" +) +__app_name__ = "influxdb" + +PROTOCOL_ID = 21 diff --git a/pyscada/influxdb/admin.py b/pyscada/influxdb/admin.py new file mode 100644 index 0000000..1ea96ab --- /dev/null +++ b/pyscada/influxdb/admin.py @@ -0,0 +1,12 @@ +import logging +import traceback + +from django.contrib import admin +from pyscada.admin import admin_site +from pyscada.influxdb.models import ( + InfluxDatabase, +) + +logger = logging.getLogger(__name__) + +admin_site.register(InfluxDatabase, InfluxDatabaseAdmin) \ No newline at end of file diff --git a/pyscada/influxdb/apps.py b/pyscada/influxdb/apps.py new file mode 100644 index 0000000..847eeb6 --- /dev/null +++ b/pyscada/influxdb/apps.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.apps import AppConfig +from django.utils.translation import gettext_lazy as _ + + +class PyScadaEMSConfig(AppConfig): + name = "pyscada.influxdb" + verbose_name = _("PyScada Influx Database") + default_auto_field = "django.db.models.AutoField" + + def ready(self): + pass diff --git a/pyscada/influxdb/daemon.py b/pyscada/influxdb/daemon.py new file mode 100644 index 0000000..d7cf7cd --- /dev/null +++ b/pyscada/influxdb/daemon.py @@ -0,0 +1,98 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +try: + driver_ok = True +except ImportError: + driver_ok = False + +import logging + +from pyscada.ems.models import MeteringPoint, VirtualMeteringPoint +from pyscada.models import BackgroundProcess +from pyscada.utils.scheduler import Process + +logger = logging.getLogger(__name__) + + +class Device: + """ + EMS Background class + """ + + def __init__(self, device): + self.device = device + self._device_not_accessible = 0 + self.variables = {} + + def request_data(self): + """process the data that was added to pyscada db""" + output = [] + return output + + +class PreCalculationBackgroundTask(Process): + + def init_process(self): + if hasattr(self, "mp_ids_to_calculate") or hasattr( + self, "vmp_ids_to_calculate" + ): + self.mp_to_calculate = [] + else: + self.mp_to_calculate = [mp for mp in MeteringPoint.objects.all()] + self.calculate_type = "mp" + + if hasattr(self, "mp_ids_to_calculate"): + self.calculate_type = "mp" + if self.mp_ids_to_calculate == "all": + self.mp_to_calculate += [mp for mp in MeteringPoint.objects.all()] + elif self.mp_ids_to_calculate == "none": + pass + else: + self.mp_to_calculate += [ + mp + for mp in MeteringPoint.objects.filter( + pk__in=self.mp_ids_to_calculate + ) + ] + + elif hasattr(self, "vmp_ids_to_calculate"): + self.calculate_type = "vmp" + if self.vmp_ids_to_calculate == "all": + self.mp_to_calculate += [ + mp for mp in VirtualMeteringPoint.objects.all() + ] + elif self.vmp_ids_to_calculate == "none": + pass + else: + self.mp_to_calculate += [ + mp + for mp in VirtualMeteringPoint.objects.filter( + pk__in=self.vmp_ids_to_calculate + ) + ] + self.dt_set = 0.1 + return True + + def loop(self): + if len(self.mp_to_calculate) == 0: + self.next_message = "done" + return 0, None # done + + if self.calculate_type == "vmp" and BackgroundProcess.objects.filter( + process_class="pyscada.ems.daemon.PreCalculationBackgroundTask", + label="update precalculated mp", + done=False, + ): + self.dt_set = 30 + self.next_message = "wait for running update mp processes to finish" + return 1, None + + mp = self.mp_to_calculate.pop(0) + self.dt_set = 0.1 + mp.update_calculated_energy_deltas() + self.next_message = ( + f"Calculated {mp.name}, {len(self.mp_to_calculate)} to calculate" + ) + + return 1, None diff --git a/pyscada/influxdb/management/__init__.py b/pyscada/influxdb/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pyscada/influxdb/management/commands/__init__.py b/pyscada/influxdb/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pyscada/influxdb/management/commands/sync_data.py b/pyscada/influxdb/management/commands/sync_data.py new file mode 100644 index 0000000..3d11eab --- /dev/null +++ b/pyscada/influxdb/management/commands/sync_data.py @@ -0,0 +1,99 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +from __future__ import unicode_literals + +import json + +from django.core.management.base import BaseCommand + +from pyscada.ems.models import MeteringPoint, VirtualMeteringPoint +from pyscada.models import BackgroundProcess +from time import time + +class Command(BaseCommand): + help = "Run Maintenance Jobs for PyScada-EMS" + + def add_arguments(self, parser): + parser.add_argument( + "type", choices=["mp", "vmp", "all"], type=str, default="all" + ) + parser.add_argument( + "id", type=int, default=-1, nargs="?", + ) + + def handle(self, *args, **options): + workers = 10 + if options["id"] >= 0: + tic = time() + if options["type"] == "all": + print("argument id not supported for type == 'all'") + + if options["type"] == "mp": + mp = MeteringPoint.objects.filter(pk=options["id"]).first() + if mp is None: + print(f"MeteringPoint with id {options['id']} not found!") + mp.update_calculated_energy_deltas() + print(f"{(time()-tic):1.2f}") + return + + if options["type"] == "vmp": + tic = time() + vmp = VirtualMeteringPoint.objects.filter(pk=options["id"]).first() + if vmp is None: + print(f"VirtualMeteringPoint with id {options['id']} not found!") + vmp.update_calculated_energy_deltas() + print(f"{(time()-tic):1.2f}") + return + + + + + if options["type"] in ["mp", "all"] and options["id"] == -1: + nb_mp = MeteringPoint.objects.count() + mp_i = 1 + mp_ids_to_calculate = [] + for worker_id in range(workers): + mp_ids_to_calculate.append([]) + worker = 0 + for mp in MeteringPoint.objects.all(): + + print(f"add mp {mp_i}/{nb_mp}: {mp.name} ", end="", flush=True) + # mp.update_calculated_energy_deltas() + mp_ids_to_calculate[worker % workers].append(mp.pk) + worker += 1 + mp_i += 1 + print(" done") + + for worker_id in range(workers): + process_class_kwargs = json.dumps( + {"mp_ids_to_calculate": mp_ids_to_calculate[worker_id]} + ) + if len(process_class_kwargs) > 400: + print( + f"process_class_kwargs to long \ + ({len(process_class_kwargs)}>400)" + ) + continue + + bp = BackgroundProcess( + pid=0, + label="update precalculated mp", + enabled=True, + parent_process_id=1, + process_class="pyscada.ems.daemon.PreCalculationBackgroundTask", + process_class_kwargs=process_class_kwargs, + ) + bp.save() + + if options["type"] in ["vmp", "all"] and options["id"] == -1: + process_class_kwargs = json.dumps({"vmp_ids_to_calculate": "all"}) + bp = BackgroundProcess( + pid=0, + label="update precalculated vmp", + enabled=True, + parent_process_id=1, + process_class="pyscada.ems.daemon.PreCalculationBackgroundTask", + process_class_kwargs=process_class_kwargs, + ) + bp.save() diff --git a/pyscada/influxdb/models.py b/pyscada/influxdb/models.py new file mode 100644 index 0000000..21ab4ab --- /dev/null +++ b/pyscada/influxdb/models.py @@ -0,0 +1,226 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import os +import re +import traceback +from datetime import datetime +import pytz +from django.conf import settings +from django.db import models + +from influxdb_client import InfluxDBClient, Point, WritePrecision +from influxdb_client.client.write_api import SYNCHRONOUS + +from pyscada.models import DataSource + +tz_local = pytz.timezone(settings.TIME_ZONE) + +class InfluxDatabase(DjangoDatabase): + bucket = models.CharField(max_length=255) + api_key = models.CharField(max_length=255) + organisation = models.CharField(max_length=255) + write_precision = models.CharField(default="ms", max_length=2) + url = models.CharField(default="127.0.0.1:8086") + measurement_name = models.CharField(default="pyscada.models.RecordedData", max_length=255) + only_write_to_influxdb = models.BooleanField(default=True, help_text="when selected only a copy of the data is written to the InfluxDB and the SQL Database is used for everything else") + + def connect(self): + self.client = InfluxDBClient(url=self.url, token=self.token, org=self.organisation) + return self.client + + def get_write_api(self): + if self.client is None: + self.connect() + return self.client.write_api(write_options=SYNCHRONOUS) + + def get_query_api(self): + if self.client is None: + self.connect() + return self.client.query_api() + + + def create_data_element_from_variable(self, variable, value, timestamp, **kwargs): + if value is not None: + date_saved = ( + kwargs["date_saved"] + if "date_saved" in kwargs + else variable.date_saved + if hasattr(variable, "date_saved") + else now() + ) + return Point(self.measurement_name) + #.field("id", int(int(int(timestamp) * 2097152) + variable.pk)) + .tag("variable_id", variable.pk) # has to be a tag to be easily filtered by, even if it is an numeric value + .tag("device_protocol", variable.device.protocol.protocol) + .tag"device_id", variable.device_id) # has to be a tag to be easily filtered by, even if it is an numeric value + .tag("value_class", variable.value_class) + .tag("unit", str(variable.unit)) + .field("value", value) + .field("date_saved", date_saved) + .timestamp(timestamp / 1000) + return None + + def last_value(self, **kwargs): + if self.only_write_to_influxdb: + return super(self).last_value(**kwargs) + + variable = kwargs.pop("variable") if "variable" in kwargs else None + use_date_saved = ( + kwargs.pop("use_date_saved") if "use_date_saved" in kwargs else False + ) + query = f'from(bucket: "{self.bucket}") |> range(start: {time_min}) |> filter(fn:(r) => r._measurement == "{self.measurement_name}" ) |> filter(fn:(r) => r.variable_id == "{variable_id}") |> filter(fn:(r) => r._field == "value") |> keep(columns: ["_time","_value"]) |> last()' + r = query_api.query(query) + r = r.to_values(columns=['_time','_value'])[0] + + if len(r) == 0: + return None + return [r[-1][0].timestamp(), r[-1][1]] + + + def read_multiple(self, **kwargs): + if self.only_write_to_influxdb: + return super(self).read_multiple(**kwargs) + + variable_ids = kwargs.pop("variable_ids") if "variable_ids" in kwargs else [] + time_min = kwargs.pop("time_min") if "time_min" in kwargs else 0 + time_max = kwargs.pop("time_max") if "time_max" in kwargs else time.time() + time_in_ms = kwargs.pop("time_in_ms") if "time_in_ms" in kwargs else True + query_first_value = ( + kwargs.pop("query_first_value") if "query_first_value" in kwargs else False + ) + variable_ids = self.datasource.datasource_check( + variable_ids, items_as_id=True, ids_model=Variable + ) + + if kwargs.get("time_min_excluded", False): + time_min = time_min + 0.001 + if kwargs.get("time_max_excluded", False): + time_max = time_max - 0.001 + + if time_in_ms: + f_time_scale = 1000 + else: + f_time_scale = 1 + + values = {} + query_api = self.get_query_api() + tmp_time_max = time_min + date_saved_max = time_min + for variable_id in variable_ids: + query = f'from(bucket: "{self.bucket}") |> range(start: {time_min}, stop: {time_max}) |> filter(fn:(r) => r._measurement == "{self.measurement_name}" ) |> filter(fn:(r) => r.variable_id == "{variable_id}") |> filter(fn:(r) => r._field == "value") |> keep(columns: ["_time","_value"])' + r = query_api.query(query) + values[variable_id] = [ [i_time.timestamp(), i_value] for i_time, i_value in r.to_values(["_time","_value"])] + tmp_time_max = max(tmp_time_max, max([i_time for i_time, i_value in values[variable_id]]) + query = f'from(bucket: "{self.bucket}") |> range(start: {time_min}, stop: {time_max}) |> filter(fn:(r) => r._measurement == "{self.measurement_name}" ) |> filter(fn:(r) => r.variable_id == "{variable_id}") |> filter(fn:(r) => r._field == "date_saved") |> max()' + r = query_api.query(query) + date_saved_max = max(date_saved_max, r.to_values(["_value"])[0][0]) + + values["timestamp"] = tmp_time_max * f_time_scale + values["date_saved_max"] = date_saved_max * f_time_scale + + return values + + def write_multiple(self, **kwargs): + if self.only_write_to_influxdb: + data_model = self._import_model() + items = kwargs.pop("items") if "items" in kwargs else [] + items = self.datasource.datasource_check(items) # FIXME what is happening here? + points = [] + recordings = [] + date_saved = kwargs.pop("date_saved") if "date_saved" in kwargs else now() + write_api = self.get_write_api() + batch_size = kwargs.pop("batch_size") if "batch_size" in kwargs else 5000 + i = 0 + for item in items: + logger.debug(f"{item} has {len(item.cached_values_to_write)} to write.") + if len(item.cached_values_to_write): + for cached_value in item.cached_values_to_write: + # add date saved if not exist in variable object, if date_saved is in kwargs it will be used instead of the variable.date_saved (see the create_data_element_from_variable function) + if not hasattr(item, "date_saved") or item.date_saved is None: + item.date_saved = date_saved + # create the recorded data object + point = self.create_data_element_from_variable( + item, cached_value[1], cached_value[0], **kwargs + ) + if self.only_write_to_influxdb: + rc = data_model.objects.create_data_element_from_variable( + item, cached_value[1], cached_value[0], **kwargs + ) + if rc is not None: + recordings.append(rc) + + # append the object to the elements to save + if point is not None: + points.append(point) + i += 1 + + + + if i%batch_size == 0: + write_api.write(bucket=bucket, org="tub", record=points, write_precision=self.write_precision) + points = [] + + if self.only_write_to_influxdb: + try: + data_model.objects.bulk_create(recorded_datas, batch_size=batch_size, **kwargs) + except IntegrityError: + logger.debug( + f'{data_model._meta.object_name} objects already exists, retrying ignoring conflicts for : {", ".join(str(i.id) + " " + str(i.variable.id) for i in recorded_datas)}' + ) + data_model.objects.bulk_create( + recorded_datas, ignore_conflicts=True, batch_size=batch_size, **kwargs + ) + + if len(points) > 0: + write_api.write(bucket=bucket, org="tub", record=points, write_precision=self.write_precision) + + for item in items: + item.date_saved = None + + def get_first_element_timestamp(self, **kwargs): + """this will likly time out and should be considert non functioning! + """ + if self.only_write_to_influxdb: + return super(self).get_first_element_timestamp(**kwargs) + return self.get_edge_element_timestamp(first_last="first", **kwargs) + + def get_last_element_timestamp(self, **kwargs): + if self.only_write_to_influxdb: + return super(self).get_last_element_timestamp(**kwargs) + return self.get_edge_element_timestamp(first_last="last", **kwargs) + + def get_edge_element_timestamp(self, first_last="last", **kwargs): + if "variables" in kwargs: + variable_ids = [ v.pk for v in kwargs["variables"]] + elif "variable" in kwargs: + variable_ids = [ kwargs["variable"].pk ] + elif "variable_ids" in kwargs: + variable_ids = kwargs["variable_ids"] + elif "variable_id" in kwargs: + variable_ids = [ kwargs["variable_id"]] + else: + return None + + query_api = self.get_query_api() + start_time = "-24h" + query = f'from(bucket: "{self.bucket}") |> range(start: {start_time}) |> filter(fn:(r) => r._measurement == "{self.measurement_name}" ) |> filter(fn:(r) =>' + for variable_id in variable_ids: + query += ' r.variable_id == "{variable_id}" or ' + query = query[:-3] + + if first_last == "last": + query += ') |> keep(columns: ["_time"]) |> sort(columns: ["_time"], desc: false) |> last(column: "_time")' + elif first_last == "first": + query += ') |> keep(columns: ["_time"]) |> sort(columns: ["_time"], desc: false) |> first(column: "_time")' + else: + return None + + r = query_api.query(query) + r = r.to_values(columns=['_time'])[0] + if len(r) == 0: + return None + if first_last == "last": + return r[-1].timestamp() + elif first_last == "first": + return r[0].timestamp() \ No newline at end of file diff --git a/pyscada/influxdb/signals.py b/pyscada/influxdb/signals.py new file mode 100644 index 0000000..290f265 --- /dev/null +++ b/pyscada/influxdb/signals.py @@ -0,0 +1,9 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import logging + +# from django.db.models.signals import post_save, pre_delete +# from django.dispatch import receiver + +logger = logging.getLogger(__name__) diff --git a/pyscada/influxdb/tests.py b/pyscada/influxdb/tests.py new file mode 100644 index 0000000..1bcbcd7 --- /dev/null +++ b/pyscada/influxdb/tests.py @@ -0,0 +1,5 @@ +from datetime import datetime + +from django.test import TestCase + +# Create your tests here. \ No newline at end of file diff --git a/pyscada/influxdb/urls.py b/pyscada/influxdb/urls.py new file mode 100644 index 0000000..1c898ff --- /dev/null +++ b/pyscada/influxdb/urls.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.urls import path + +urlpatterns = [] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..31f5b86 --- /dev/null +++ b/setup.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +import os + +from setuptools import find_packages, setup + +from pyscada import ems as pyscada_app + +CLASSIFIERS = [ + "Development Status :: 4 - Beta", + "Environment :: Web Environment", + "Environment :: Console", + "Framework :: Django", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: POSIX", + "Operating System :: MacOS :: MacOS X", + "Programming Language :: Python", + "Programming Language :: JavaScript", + "Topic :: Internet :: WWW/HTTP :: Dynamic Content", + "Topic :: Scientific/Engineering :: Visualization", +] +setup( + author=pyscada_app.__author__, + author_email=pyscada_app.__email__, + name="pyscada-" + pyscada_app.__app_name__.lower(), + version=pyscada_app.__version__, + description=pyscada_app.__description__, + long_description=open(os.path.join(os.path.dirname(__file__), "README.rst")).read(), + url="http://www.github.com/pyscada/PyScada-Influxdb", + license="AGPLv3", + platforms=["OS Independent"], + classifiers=CLASSIFIERS, + install_requires=[ + "pyscada>=0.8.0", + "pytz", + "influxdb_client" + ], + packages=find_packages(exclude=["project", "project.*"]), + include_package_data=True, + zip_safe=False, + test_suite="runtests.main", +) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..c635a12 --- /dev/null +++ b/tox.ini @@ -0,0 +1,89 @@ +# Tox (https://tox.readthedocs.io/) is a tool for running tests in multiple +# virtualenvs. This configuration file helps to run the test suite on all +# supported Python versions. To use it, "python -m pip install tox" and +# then run "tox" from this directory. + +[tox] +minversion = 4.0 +skipsdist = true +envlist = + py3 + black + blacken-docs + flake8 + docs + isort + +# Add environment to use the default python3 installation +[testenv:py3] +basepython = python3 + +[testenv] +usedevelop = true +# OBJC_DISABLE_INITIALIZE_FORK_SAFETY fixes hung tests for MacOS users. (#30806) +passenv = DJANGO_SETTINGS_MODULE,PYTHONPATH,HOME,DISPLAY,OBJC_DISABLE_INITIALIZE_FORK_SAFETY +setenv = + PYTHONDONTWRITEBYTECODE=1 +deps = + -e . + py{3,310,311,312,py3}: -rtests/requirements/py3.txt + postgres: -rtests/requirements/postgres.txt + mysql: -rtests/requirements/mysql.txt + oracle: -rtests/requirements/oracle.txt +changedir = tests +commands = + {envpython} runtests.py {posargs} + +[testenv:black] +basepython = python3 +usedevelop = false +deps = black +changedir = {toxinidir} +commands = black --check --diff . + +[testenv:blacken-docs] +basepython = python3 +usedevelop = false +allowlist_externals = + make +deps = blacken-docs +changedir = docs +commands = + make black + +[testenv:flake8] +basepython = python3 +usedevelop = false +deps = flake8 >= 3.7.0 +changedir = {toxinidir} +commands = flake8 . + +[testenv:docs] +basepython = python3 +usedevelop = false +allowlist_externals = + make +deps = + Sphinx + pyenchant + sphinxcontrib-spelling +changedir = docs +commands = + make spelling + +[testenv:isort] +basepython = python3 +usedevelop = false +deps = isort >= 5.1.0 +changedir = {toxinidir} +commands = isort --check-only --diff django tests scripts + +[testenv:javascript] +usedevelop = false +deps = +changedir = {toxinidir} +allowlist_externals = + npm +commands = + npm install + npm test