├── .circleci
└── config.yml
├── .gitignore
├── .mdlrc
├── .vscode
├── launch.json
├── settings.json
└── tasks.json
├── .yamllint
├── Dockerfile
├── LICENSE
├── PPL-1.3.3-64bit.deb
├── README.md
├── example-docker-compose.yaml
├── init.sh
├── pwrstat.yaml
├── pwrstat_api.py
├── pwrstat_mqtt.py
├── pwrstat_prometheus.py
├── pwrstat_rest.py
├── pwrstat_schemas.py
├── pylintrc
├── requirements.txt
├── setup.cfg
└── tox.ini
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | ---
2 | version: 2.1
3 | executors:
4 | python_executor:
5 | docker:
6 | - image: circleci/python:3.8
7 | yaml_executor:
8 | docker:
9 | - image: sdesbure/yamllint
10 | md_executor:
11 | docker:
12 | - image: ruby:alpine
13 | json_executor:
14 | docker:
15 | - image: sahsu/docker-jsonlint
16 |
17 | jobs:
18 | lint_python:
19 | executor: python_executor
20 | working_directory: ~/repo
21 | steps:
22 | - checkout
23 | - restore_cache:
24 | keys:
25 | - v1-dependencies-{{ checksum "requirements.txt" }}
26 | - v1-dependencies-
27 | - run:
28 | name: install dependencies
29 | command: |
30 | python3 -m venv venv
31 | . venv/bin/activate
32 | pip install -r requirements.txt
33 | - save_cache:
34 | paths:
35 | - ./venv
36 | key: v1-dependencies-{{ checksum "requirements.txt" }}
37 | - run:
38 | name: black
39 | command: |
40 | . venv/bin/activate
41 | for file in $(find ~/repo/config -type f -name "*.py"); do
42 | black $file
43 | done
44 | - run:
45 | name: flake8
46 | command: |
47 | . venv/bin/activate
48 | for file in $(find ~/repo/config -type f -name "*.py"); do
49 | flake8 $file
50 | done
51 | - run:
52 | name: pylint
53 | command: |
54 | . venv/bin/activate
55 | for file in $(find ~/repo/config -type f -name "*.py"); do
56 | pylint --rcfile=pylintrc $file
57 | done
58 | lint_yaml:
59 | executor: yaml_executor
60 | working_directory: ~/repo
61 | steps:
62 | - checkout
63 | - run:
64 | name: yamllint
65 | command: |
66 | yamllint --version
67 | for file in $(find ~/repo -type f \( -name "*.yaml" -o -name "*.yml" \)); do
68 | yamllint $file
69 | done
70 | lint_md:
71 | executor: md_executor
72 | working_directory: ~/repo
73 | steps:
74 | - checkout
75 | - run:
76 | name: md_lint
77 | command: |
78 | gem install mdl
79 | mdl --version
80 | mdl --style all --warnings ~/repo -c .mdlrc
81 | lint_json:
82 | executor: json_executor
83 | working_directory: ~/repo
84 | steps:
85 | - checkout
86 | - run:
87 | name: json_lint
88 | command: |
89 | jsonlint --version || true
90 | for file in $(find ~/repo -type f -name "*.json"); do
91 | if ! jsonlint -q $file; then
92 | export FAILED=1
93 | else
94 | echo "$file OK"
95 | fi
96 | done
97 | if [ "${FAILED}" = "1" ]; then
98 | exit 1
99 | fi
100 | build:
101 | working_directory: ~/repo
102 | docker:
103 | - image: docker:latest
104 | steps:
105 | - checkout
106 | - setup_remote_docker
107 | # build and push Docker image
108 | - run: |
109 | TAG=<< pipeline.git.branch >>_CI
110 | cd ~/repo
111 | docker build -t ${DOCKER_REPO}:${TAG} .
112 | echo ${DOCKER_PASS} | docker login -u ${DOCKER_USER} --password-stdin
113 | docker push ${DOCKER_REPO}:${TAG}
114 | workflows:
115 | version: 2
116 | lint_and_test:
117 | jobs:
118 | - lint_python
119 | - lint_yaml
120 | - lint_md
121 | - lint_json
122 | - build
123 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .mypy_cache
2 | .vscode/.ropeproject
3 | __pycache__
4 | venv
--------------------------------------------------------------------------------
/.mdlrc:
--------------------------------------------------------------------------------
1 | rules "~MD046"
2 |
--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.2.0",
3 | "configurations": [
4 | {
5 | "name": "Python: Current File",
6 | "type": "python",
7 | "request": "launch",
8 | "program": "${workspaceFolder}/pwrstat_api.py",
9 | "console": "integratedTerminal"
10 | }
11 | ]
12 | }
13 |
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "python.linting.pylintEnabled": true,
3 | "python.linting.pylintArgs": ["--rcfile=pylintrc"],
4 | "python.linting.flake8Enabled": true,
5 | "python.autoComplete.addBrackets": true,
6 | "python.linting.mypyEnabled": true,
7 | "python.linting.pydocstyleEnabled": true,
8 | "python.linting.pycodestyleEnabled": true,
9 | "python.formatting.provider": "black",
10 | "python.jediEnabled": false
11 | }
12 |
--------------------------------------------------------------------------------
/.vscode/tasks.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "2.0.0",
3 | "tasks": [
4 | {
5 | "label": "Black",
6 | "type": "shell",
7 | "problemMatcher": [],
8 | "presentation": {
9 | "echo": true,
10 | "reveal": "always",
11 | "focus": false,
12 | "panel": "shared",
13 | "showReuseMessage": true,
14 | "clear": true
15 | },
16 | "command": "python.exe -m black ${file}"
17 | },
18 | {
19 | "label": "Black all",
20 | "type": "shell",
21 | "problemMatcher": [],
22 | "command": "python.exe -m black ${workspaceFolder}"
23 | }
24 | ]
25 | }
26 |
--------------------------------------------------------------------------------
/.yamllint:
--------------------------------------------------------------------------------
1 | ---
2 | ignore: |
3 | custom_components/
4 | ip_bans.yaml
5 | esphomeyaml/*/
6 | notebooks/
7 | rules:
8 | braces:
9 | level: error
10 | min-spaces-inside: 0
11 | max-spaces-inside: 1
12 | min-spaces-inside-empty: -1
13 | max-spaces-inside-empty: -1
14 | brackets:
15 | level: error
16 | min-spaces-inside: 0
17 | max-spaces-inside: 0
18 | min-spaces-inside-empty: -1
19 | max-spaces-inside-empty: -1
20 | colons:
21 | level: error
22 | max-spaces-before: 0
23 | max-spaces-after: 1
24 | commas:
25 | level: error
26 | max-spaces-before: 0
27 | min-spaces-after: 1
28 | max-spaces-after: 1
29 | comments:
30 | level: error
31 | require-starting-space: true
32 | min-spaces-from-content: 1
33 | comments-indentation: disable
34 | document-end:
35 | level: error
36 | present: false
37 | document-start:
38 | level: error
39 | present: true
40 | ignore: |
41 | config/known_devices.yaml
42 | empty-lines:
43 | level: error
44 | max: 1
45 | max-start: 0
46 | max-end: 1
47 | hyphens:
48 | level: error
49 | max-spaces-after: 1
50 | indentation:
51 | level: error
52 | spaces: 2
53 | indent-sequences: true
54 | check-multi-line-strings: false
55 | key-duplicates:
56 | level: error
57 | line-length:
58 | ignore: |
59 | .github/support.yml
60 | .github/settings.yml
61 | .gitlab-ci.yml
62 | config/packages/alarm_clock.yaml
63 | config/packages/finance_tracker.yaml
64 | config/packages/weather.yaml
65 | level: warning
66 | max: 120
67 | allow-non-breakable-words: true
68 | allow-non-breakable-inline-mappings: true
69 | new-line-at-end-of-file:
70 | level: error
71 | new-lines:
72 | level: error
73 | type: unix
74 | trailing-spaces:
75 | level: error
76 | truthy:
77 | level: error
78 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3.8-slim
2 | LABEL Description="CyberPower PowerPanel"
3 | LABEL Maintainer="Daniel Winks"
4 |
5 | COPY *.py requirements.txt PPL-1.3.3-64bit.deb init.sh pwrstat.yaml /
6 |
7 | RUN apt-get update && apt-get dist-upgrade -y && \
8 | apt-get install -y procps && \
9 | apt-get install -y curl && \
10 | chmod +x /init.sh && chmod +x /pwrstat_api.py && \
11 | pip install --trusted-host pypi.python.org -r requirements.txt && \
12 | apt-get install -y /PPL-1.3.3-64bit.deb && \
13 | apt-get -y --purge autoremove && apt-get clean && \
14 | rm -rf /tmp/* /var/tmp/* /var/lib/apt/lists/* /PPL-1.3.3-64bit.deb
15 |
16 | CMD ["/init.sh"]
17 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/PPL-1.3.3-64bit.deb:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DanielWinks/pwrstat_docker/ec4dcbba80ebdbc6a337ad1f64169dd9a98046bb/PPL-1.3.3-64bit.deb
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # PowerPanel (pwrstat) API & MQTT container
2 |
3 | [](https://circleci.com/gh/DanielWinks/pwrstat_docker)
4 |
5 | This is a container for the CyberPower 'pwrstat' utility.
6 | Basic GET support for a single JSON object response for
7 | all parameters of the UPS are implemented.
8 | MQTT is also supported, with broker, port, client_id and topic
9 | options all being specified in the config file.
10 | Optionally, username/password may be specified.
11 | TLS support soon.
12 | Note: client_id must be unique.
13 |
14 | ## Usage
15 |
16 | Available healthchecks:
17 | 1) `http://server:port/health` <- `200 'OK'` if REST client functional
18 | 1) `http://server:port/mqtthealth` <- `200 'OK'` if MQTT client is connected to broker
19 |
20 | ### Example Kubernetes manifest
21 |
22 | ```yaml
23 | ---
24 | apiVersion: v1
25 | kind: Namespace
26 | metadata:
27 | labels:
28 | app: pwrstat
29 | name: pwrstat
30 |
31 | ---
32 | apiVersion: apps/v1
33 | kind: StatefulSet
34 | metadata:
35 | name: pwrstat
36 | namespace: pwrstat
37 | labels:
38 | app: pwrstat
39 | spec:
40 | replicas: 1
41 | serviceName: pwrstat
42 | selector:
43 | matchLabels:
44 | app: pwrstat
45 | template:
46 | metadata:
47 | labels:
48 | app: pwrstat
49 | spec:
50 | nodeSelector:
51 | kubernetes.io/hostname: my_host
52 | containers:
53 | - name: pwrstat
54 | securityContext:
55 | privileged: true
56 | image: dwinks/pwrstat_docker
57 | imagePullPolicy: "Always"
58 | livenessProbe:
59 | httpGet:
60 | path: /health
61 | port: 5003
62 | initialDelaySeconds: 10
63 | periodSeconds: 30
64 | failureThreshold: 5
65 | readinessProbe:
66 | httpGet:
67 | path: /health
68 | port: 5003
69 | initialDelaySeconds: 10
70 | periodSeconds: 30
71 | failureThreshold: 5
72 | startupProbe:
73 | httpGet:
74 | path: /health
75 | port: 5003
76 | initialDelaySeconds: 6
77 | periodSeconds: 6
78 | failureThreshold: 10
79 | resources:
80 | requests:
81 | cpu: "50m"
82 | memory: "50Mi"
83 | limits:
84 | cpu: "100m"
85 | memory: "100Mi"
86 | ports:
87 | - containerPort: 5003
88 | volumeMounts:
89 | - name: pwrstat-configmap
90 | mountPath: /pwrstat.yaml
91 | subPath: pwrstat.yaml
92 | - name: cyberpower-ups
93 | mountPath: /dev/bus/usb/001/001
94 | readOnly: false
95 |
96 | volumes:
97 | - name: pwrstat-configmap
98 | configMap:
99 | defaultMode: 0644
100 | name: pwrstat-configmap
101 | items:
102 | - key: pwrstat.yaml
103 | path: pwrstat.yaml
104 | mode: 0644
105 | - name: cyberpower-ups
106 | hostPath:
107 | path: /dev/bus/usb/003/002
108 |
109 | ---
110 | apiVersion: v1
111 | kind: Service
112 | metadata:
113 | name: pwrstat
114 | namespace: pwrstat
115 | labels:
116 | app: pwrstat
117 | spec:
118 | type: NodePort
119 | selector:
120 | app: pwrstat
121 | ports:
122 | - port: 5003
123 | targetPort: 5003
124 | name: http
125 |
126 | ---
127 | apiVersion: v1
128 | kind: ConfigMap
129 | metadata:
130 | name: pwrstat-configmap
131 | namespace: pwrstat
132 | data:
133 | pwrstat.yaml: |
134 | ---
135 | pwrstat_api: # optional
136 | log_level: "DEBUG" # optional
137 | mqtt:
138 | broker: "mosquitto.mosquitto"
139 | port: 1883
140 | client_id: "pwrstat_mqtt"
141 | topic: "sensors/basement/power/ups"
142 | refresh: 30
143 | qos: 0
144 | retained: true
145 | # username: "my_username" # optional
146 | # password: "my_password" # optional, required if username specified
147 | rest:
148 | port: 5003
149 | bind_address: "0.0.0.0"
150 | ```
151 |
152 | ### Example docker-compose
153 |
154 | ```yaml
155 | ---
156 | version: '2.4'
157 | services:
158 | pwr_stat:
159 | container_name: pwr_stat
160 | hostname: pwr_stat
161 | restart: always
162 | image: dwinks/pwrstat_docker:latest
163 | devices:
164 | - /dev/bus/usb/003/003:/dev/bus/usb/001/001
165 | volumes:
166 | - /docker_binds/pwr_stat/pwrstat.yaml:/pwrstat.yaml:ro
167 | # Optionally override the powerstatd configuration file
168 | - /docker_binds/pwr_stat/pwrstatd.conf:/etc/pwrstatd.conf:ro
169 | healthcheck:
170 | test: ["CMD", "curl", "-sI", "http://127.0.0.1:5002/pwrstat"]
171 | interval: 30s
172 | timeout: 1s
173 | retries: 24
174 | privileged: true
175 | network_mode: host
176 |
177 | ```
178 |
179 | ### Example config file
180 |
181 | ```yaml
182 | ---
183 | pwrstat_api: # optional
184 | log_level: WARNING # optional, may be 'DEBUG', 'WARNING', 'INFO', 'CRITICAL'
185 | mqtt:
186 | broker: "192.168.1.100"
187 | port: 1883
188 | client_id: "pwrstat_mqtt"
189 | topic: "sensors/basement/power/ups"
190 | refresh: 3
191 | qos: 0
192 | retained: true
193 | # username: "my_username" # optional
194 | # password: "my_password" # optional, required if username specified
195 | rest:
196 | port: 5002
197 | bind_address: "0.0.0.0"
198 | ```
199 |
--------------------------------------------------------------------------------
/example-docker-compose.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | version: '2.4'
3 | services:
4 | pwr_stat:
5 | container_name: pwr_stat
6 | hostname: pwr_stat
7 | restart: always
8 | image: dwinks/pwrstat_docker:latest
9 | devices:
10 | - /dev/bus/usb/003/003:/dev/bus/usb/001/001
11 | volumes:
12 | - /docker_binds/pwr_stat/pwrstat.yaml:/pwrstat.yaml:ro
13 | # Optionally override the powerstatd configuration file
14 | - /docker_binds/pwr_stat/pwrstatd.conf:/etc/pwrstatd.conf:ro
15 | healthcheck:
16 | test: ["CMD", "curl", "-sI", "http://127.0.0.1:5002/pwrstat"]
17 | interval: 30s
18 | timeout: 1s
19 | retries: 24
20 | privileged: true
21 | network_mode: host
22 |
--------------------------------------------------------------------------------
/init.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | /pwrstat_api.py
3 |
--------------------------------------------------------------------------------
/pwrstat.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | pwrstat_api: # optional
3 | log_level: WARNING # optional
4 | mqtt:
5 | broker: "192.168.1.100"
6 | port: 1883
7 | client_id: "pwrstat_mqtt"
8 | topic: "sensors/basement/power/ups"
9 | refresh: 30
10 | qos: 0
11 | retained: true
12 | # username: "my_username" # optional
13 | # password: "my_password" # optional, required if username specified
14 | rest:
15 | port: 5003
16 | bind_address: "0.0.0.0"
17 | prometheus:
18 | port: 9222
19 | bind_address: "0.0.0.0"
20 | labels:
21 | rack: "0"
22 |
--------------------------------------------------------------------------------
/pwrstat_api.py:
--------------------------------------------------------------------------------
1 | #!/usr/local/bin/python3
2 | """Get output from pwrstat program and send results to REST or MQTT clients."""
3 | from threading import Thread
4 | import logging
5 | from subprocess import DEVNULL, Popen, PIPE
6 | from typing import Any, Dict, List, Optional
7 |
8 | from ruamel.yaml import YAML as yaml
9 | from ruamel.yaml import YAMLError
10 |
11 | import pwrstat_prometheus
12 | import pwrstat_mqtt
13 | import pwrstat_rest
14 | from pwrstat_schemas import PWRSTAT_API_SCHEMA, MQTT_SCHEMA, REST_SCHEMA, PROMETHEUS_SCHEMA
15 |
16 | _LOGGER = logging.getLogger("PwrstatApi")
17 | YAML = yaml(typ="safe")
18 |
19 |
20 | class PwrstatApi:
21 | """Get output from pwrstat program and send results to REST or MQTT clients."""
22 |
23 | def __init__(self) -> None:
24 | """Initialize Pwrstat class."""
25 | _start_pwrstatd_watchdog()
26 | _process_config()
27 |
28 |
29 | def _process_config() -> None:
30 | """Process YAML config file. Starts servers if configured."""
31 | with open("pwrstat.yaml") as file:
32 | try:
33 | yaml_config: Dict[str, Any] = YAML.load(file)
34 | except YAMLError as ex:
35 | _LOGGER.log(level=logging.ERROR, msg=ex)
36 |
37 | pwrstat_api_yaml: Dict[str, Any] = yaml_config.get("pwrstat_api") or {}
38 | pwrstat_api_config: Dict[str, Any] = PWRSTAT_API_SCHEMA(pwrstat_api_yaml)
39 |
40 | _LOGGER.setLevel(pwrstat_api_config["log_level"])
41 |
42 | if "mqtt" in yaml_config:
43 | _start_mqtt(yaml_config["mqtt"])
44 |
45 | if "prometheus" in yaml_config:
46 | _start_prometheus(yaml_config["prometheus"])
47 |
48 | if "rest" in yaml_config:
49 | _start_rest(yaml_config["rest"])
50 |
51 |
52 | def get_status() -> Optional[Dict[str, str]]:
53 | """Return status from pwrstat program."""
54 | _LOGGER.info("Getting status from pwrstatd...")
55 | status: str = Popen(
56 | ["pwrstat", "-status"], stdout=PIPE, stderr=DEVNULL
57 | ).communicate()[0].decode("utf-8")
58 | status_dict = _get_status_dict(status)
59 | if len(status_dict) > 1:
60 | return status_dict
61 | _LOGGER.warning("Pwrstatd did not return any data.")
62 | _LOGGER.warning("Check USB connection and UPS.")
63 | _LOGGER.warning("If USB device frequently changes, consider creating a udev rule.")
64 | return None
65 |
66 |
67 | def _get_status_dict(status: str) -> Dict[str, str]:
68 | """Return status dict from status message."""
69 | status_list: List[List[str]] = []
70 | for line in status.splitlines():
71 | line = line.lstrip()
72 | line = line.replace(". ", ";")
73 | line = line.replace(".", "")
74 | lines: List[str] = line.split(";")
75 | if len(lines) > 1:
76 | status_list.append(lines)
77 | return {k[0]: k[1] for k in status_list}
78 |
79 |
80 | def _start_pwrstatd() -> Popen:
81 | """Start pwrstatd daemon to allow communication with UPS."""
82 | return Popen(["/usr/sbin/pwrstatd", "start"], stdout=DEVNULL, stderr=DEVNULL)
83 |
84 |
85 | def _start_pwrstatd_watchdog() -> None:
86 | """Start pwrstatd and ensure it's running."""
87 | pwrstatd_process = _start_pwrstatd()
88 |
89 | # def watchdog():
90 | # while True:
91 | # time.sleep(30)
92 | # if pwrstatd_process.poll() is None:
93 | # _start_pwrstatd()
94 |
95 | # Thread(target=watchdog).start()
96 |
97 |
98 | def _start_mqtt(mqtt_config_yaml: Dict[str, Any]) -> None:
99 | """Start MQTT client."""
100 | mqtt_config: Dict[str, Any] = MQTT_SCHEMA(mqtt_config_yaml)
101 | _LOGGER.info("Initializing MQTT...")
102 | pwrstatmqtt = pwrstat_mqtt.PwrstatMqtt(mqtt_config=mqtt_config)
103 | Thread(target=pwrstatmqtt.loop).start()
104 |
105 |
106 | def _start_prometheus(prometheus_config_yaml: Dict[str, Any]) -> None:
107 | """Start Prometheus client."""
108 | _LOGGER.info("Initializing Prometheus...")
109 | prometheus_config: Dict[str, Any] = PROMETHEUS_SCHEMA(prometheus_config_yaml)
110 |
111 | from prometheus_client.core import CollectorRegistry
112 | from prometheus_client import make_wsgi_app
113 | from wsgiref.simple_server import make_server
114 |
115 | registry = CollectorRegistry(auto_describe=True)
116 | registry.register(pwrstat_prometheus.CustomCollector(prometheus_config["labels"]))
117 |
118 | app = make_wsgi_app(registry)
119 | httpd = make_server(prometheus_config["bind_address"], prometheus_config["port"], app)
120 | Thread(target=httpd.serve_forever).start()
121 | _LOGGER.info("After Prometheus")
122 |
123 |
124 | def _start_rest(rest_config_yaml: Dict[str, Any]) -> None:
125 | """Start REST client."""
126 | _LOGGER.info("Initializing REST...")
127 | rest_config: Dict[str, Any] = REST_SCHEMA(rest_config_yaml)
128 | pwrstat_rest.APP.run(port=rest_config["port"], host=rest_config["bind_address"])
129 | _LOGGER.info("After REST")
130 |
131 |
132 | if __name__ == "__main__":
133 | logging.basicConfig(level=logging.DEBUG, format="%(message)s")
134 | _LOGGER.info("Starting Pwrstat_API...")
135 | PwrstatApi()
136 |
--------------------------------------------------------------------------------
/pwrstat_mqtt.py:
--------------------------------------------------------------------------------
1 | """Create MQTT publisher."""
2 | import time
3 | import json
4 | import logging
5 | from typing import Any, Dict, Optional
6 |
7 | import paho.mqtt.client as mqtt
8 |
9 | import pwrstat_api
10 |
11 | _LOGGER = logging.getLogger("PwrstatApi")
12 | _CLIENT = mqtt.Client()
13 |
14 |
15 | class PwrstatMqtt:
16 | """Create MQTT publisher."""
17 |
18 | def __init__(self, mqtt_config: Dict[str, Any]) -> None:
19 | """Start MQTT loop."""
20 | self.mqtt_config = mqtt_config
21 | client_id: Optional[str] = self.mqtt_config.get("client_id")
22 | if client_id:
23 | _CLIENT.reinitialise(client_id=client_id)
24 | username = self.mqtt_config.get("username")
25 | password = self.mqtt_config.get("password")
26 | if None not in (username, password):
27 | _CLIENT.username_pw_set(username=username, password=password)
28 | self.refresh_interval: int = self.mqtt_config["refresh"]
29 |
30 | def _connect_mqtt(self) -> None:
31 | """Connect to MQTT broker."""
32 | mqtt_host: str = self.mqtt_config["broker"]
33 | mqtt_port: int = self.mqtt_config["port"]
34 | _LOGGER.info(f"Connecting to MQTT broker {mqtt_host}:{mqtt_port}...")
35 | _CLIENT.connect(host=mqtt_host, port=mqtt_port, keepalive=60)
36 | _CLIENT.loop_start()
37 | while not _CLIENT.is_connected():
38 | time.sleep(10)
39 | _LOGGER.debug("Connecting to broker...")
40 | _LOGGER.info(f"MQTT Broker connected: {_CLIENT.is_connected()}")
41 |
42 | def loop(self) -> None:
43 | """Loop for MQTT updates."""
44 | _LOGGER.info("Starting MQTT loop...")
45 | while True:
46 | if not is_connected():
47 | self._connect_mqtt()
48 | self._publish_update()
49 | _LOGGER.debug("Publishing message to MQTT broker...")
50 | time.sleep(self.refresh_interval)
51 |
52 | def _publish_update(self) -> bool:
53 | """Update MQTT topic with latest status."""
54 | topic = self.mqtt_config["topic"]
55 | qos: int = self.mqtt_config["qos"]
56 | retain: bool = self.mqtt_config["retained"]
57 | status = pwrstat_api.get_status()
58 | if status is not None:
59 | json_payload = json.dumps(status)
60 | result = _CLIENT.publish(topic, json_payload, qos=qos, retain=retain)
61 | return result.is_published()
62 | return False
63 |
64 |
65 | def is_connected() -> bool:
66 | """Check connection to MQTT broker."""
67 | return _CLIENT.is_connected()
68 |
69 |
70 | if __name__ == "__main__":
71 | pass
72 |
--------------------------------------------------------------------------------
/pwrstat_prometheus.py:
--------------------------------------------------------------------------------
1 | """Get output from pwrstat program and send results to REST or MQTT clients."""
2 | import re
3 | from typing import Dict
4 |
5 | from prometheus_client.core import GaugeMetricFamily, InfoMetricFamily
6 |
7 | import pwrstat_api
8 |
9 |
10 | class CustomCollector(object):
11 | def __init__(self, labels: Dict[str, str] = None):
12 | if labels is None:
13 | labels = {}
14 |
15 | self.label_names = list(labels.keys())
16 | self.label_values = list(labels.values())
17 |
18 | def collect(self):
19 | status = pwrstat_api.get_status()
20 | if status is None:
21 | return
22 |
23 | info = InfoMetricFamily("pwrstat_status_info", "General info about the UPS", labels=self.label_names)
24 | info.add_metric(labels=self.label_values, value={
25 | "rating_voltage": status["Rating Voltage"],
26 | "firmware_number": status["Firmware Number"],
27 | "rating_power": status["Rating Power"],
28 | "last_power_event": status["Last Power Event"],
29 | "line_interaction": status["Line Interaction"],
30 | "test_result": status["Test Result"],
31 | })
32 | yield info
33 |
34 | state = GaugeMetricFamily("pwrstat_status_state", "State value enum", labels=(self.label_names + ["state"]))
35 | state.add_metric(labels=(self.label_values + ["normal"]), value=(status["State"] == "Normal"))
36 | yield state
37 |
38 | state = GaugeMetricFamily("pwrstat_status_supply", "Power supplied by", labels=(self.label_names + ["supply"]))
39 | state.add_metric(
40 | labels=(self.label_values + ["utility"]),
41 | value=(status["Power Supply by"] == "Utility Power"),
42 | )
43 | state.add_metric(
44 | labels=(self.label_values + ["battery"]),
45 | value=(status["Power Supply by"] == "Battery"),
46 | )
47 | yield state
48 |
49 | bat_cap = GaugeMetricFamily("pwrstat_status_battery_capacity", "Current battery capacity",
50 | unit="percent", labels=self.label_names)
51 | bat_cap.add_metric(labels=self.label_values,
52 | value=re.search(r"\d+(?:\.\d+)?", status["Battery Capacity"]).group())
53 | yield bat_cap
54 |
55 | load = GaugeMetricFamily("pwrstat_status_load", "Current load on supply",
56 | unit="watts", labels=self.label_names)
57 | load.add_metric(labels=self.label_values,
58 | value=re.search(r"\d+(?:\.\d+)?", status["Load"]).group())
59 | yield load
60 |
61 | output_voltage = GaugeMetricFamily("pwrstat_status_output_voltage", "Output voltage to connected devices",
62 | unit="volts", labels=self.label_names)
63 | output_voltage.add_metric(labels=self.label_values,
64 | value=re.search(r"\d+(?:\.\d+)?", status["Output Voltage"]).group())
65 | yield output_voltage
66 |
67 | remaining_runtime = GaugeMetricFamily("pwrstat_status_remaining_runtime",
68 | "Estimated remaining battery time",
69 | unit="minutes", labels=self.label_names)
70 | remaining_runtime.add_metric(labels=self.label_values,
71 | value=re.search(r"\d+(?:\.\d+)?", status["Remaining Runtime"]).group())
72 | yield remaining_runtime
73 |
74 | utility_voltage = GaugeMetricFamily("pwrstat_status_utility_voltage",
75 | "Input voltage from the wall",
76 | unit="volts", labels=self.label_names)
77 | utility_voltage.add_metric(labels=self.label_values,
78 | value=re.search(r"\d+(?:\.\d+)?", status["Utility Voltage"]).group())
79 | yield utility_voltage
80 |
81 |
82 | if __name__ == "__main__":
83 | from prometheus_client.core import CollectorRegistry
84 | from prometheus_client import make_wsgi_app
85 | from wsgiref.simple_server import make_server
86 |
87 | registry = CollectorRegistry(auto_describe=True)
88 | registry.register(CustomCollector({
89 | "test": "test",
90 | }))
91 |
92 | app = make_wsgi_app(registry)
93 | httpd = make_server('', 9222, app)
94 | httpd.serve_forever()
95 |
--------------------------------------------------------------------------------
/pwrstat_rest.py:
--------------------------------------------------------------------------------
1 | """Get output from pwrstat program and send results to REST or MQTT clients."""
2 | from flask import Flask, Response, make_response, jsonify
3 |
4 | import pwrstat_api
5 | import pwrstat_mqtt
6 |
7 | APP = Flask(__name__)
8 |
9 |
10 | @APP.route("/pwrstat", methods=["GET"])
11 | def pwrstat() -> Response:
12 | """Responder for get requests."""
13 | status = pwrstat_api.get_status()
14 | if status is not None:
15 | return jsonify(status)
16 | data = {"message": "Unavailable: pwrstatd failure", "code": "ERROR"}
17 | return make_response(jsonify(data), 503)
18 |
19 |
20 | @APP.route("/health", methods=["GET"])
21 | def health() -> Response:
22 | """Responder for get requests."""
23 | data = {"message": "OK", "code": "SUCCESS"}
24 | return make_response(jsonify(data), 200)
25 |
26 |
27 | @APP.route("/mqtthealth", methods=["GET"])
28 | def mqtthealth() -> Response:
29 | """Responder for get requests."""
30 | mqtt_status = pwrstat_mqtt.is_connected()
31 | if mqtt_status:
32 | data = {"message": "OK", "code": "SUCCESS"}
33 | return make_response(jsonify(data), 200)
34 | data = {"message": "MQTT Disconnected!", "code": "ERROR"}
35 | return make_response(jsonify(data), 503)
36 |
37 |
38 | if __name__ == "__main__":
39 | pass
40 |
--------------------------------------------------------------------------------
/pwrstat_schemas.py:
--------------------------------------------------------------------------------
1 | """Schemas for Powerstat API."""
2 |
3 | import voluptuous as vol
4 |
5 | VALID_IP_REGEX = (
6 | r"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.)"
7 | r"{3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$"
8 | )
9 |
10 | PWRSTAT_API_SCHEMA = vol.Schema({vol.Optional("log_level", default="WARNING"): str})
11 |
12 | MQTT_SCHEMA = vol.Schema(
13 | {
14 | vol.Optional("broker", default="192.168.1.100"): str,
15 | vol.Optional("port", default=1883): int,
16 | vol.Optional("client_id", default="pwrstat_mqtt"): str,
17 | vol.Optional("topic", "sensors/basement/power/ups"): str,
18 | vol.Optional("refresh", default=30): int,
19 | vol.Optional("qos", default=0): int,
20 | vol.Optional("retained", default=True): bool,
21 | vol.Optional("username"): str,
22 | vol.Optional("password"): str,
23 | }
24 | )
25 |
26 | REST_SCHEMA = vol.Schema(
27 | {
28 | vol.Optional("port", default=5002): vol.All(
29 | int, vol.Range(min=1025, max=65535)
30 | ),
31 | vol.Optional("bind_address", default="0.0.0.0"): vol.All(
32 | str, vol.Length(min=7, max=15), vol.Match(VALID_IP_REGEX)
33 | ),
34 | }
35 | )
36 |
37 | PROMETHEUS_SCHEMA = vol.Schema(
38 | {
39 | vol.Optional("port", default=5002): vol.All(
40 | int, vol.Range(min=1025, max=65535)
41 | ),
42 | vol.Optional("bind_address", default="0.0.0.0"): vol.All(
43 | str, vol.Length(min=7, max=15), vol.Match(VALID_IP_REGEX)
44 | ),
45 | vol.Optional("labels", default={}): vol.All(
46 | dict
47 | ),
48 | }
49 | )
50 |
--------------------------------------------------------------------------------
/pylintrc:
--------------------------------------------------------------------------------
1 | [MASTER]
2 | ignore=tests
3 |
4 | [BASIC]
5 | good-names=i,j,k,ex,Run,_,fp
6 |
7 | [MESSAGES CONTROL]
8 | # Reasons disabled:
9 | # locally-disabled - it spams too much
10 | # duplicate-code - unavoidable
11 | # cyclic-import - doesn't test if both import on load
12 | # abstract-class-little-used - prevents from setting right foundation
13 | # unused-argument - generic callbacks and setup methods create a lot of warnings
14 | # global-statement - used for the on-demand requirement installation
15 | # redefined-variable-type - this is Python, we're duck typing!
16 | # too-many-* - are not enforced for the sake of readability
17 | # too-few-* - same as too-many-*
18 | # abstract-method - with intro of async there are always methods missing
19 | # inconsistent-return-statements - doesn't handle raise
20 | # not-an-iterable - https://github.com/PyCQA/pylint/issues/2311
21 | # unnecessary-pass - readability for functions which only contain pass
22 | disable=
23 | abstract-class-little-used,
24 | abstract-method,
25 | attribute-defined-outside-init,
26 | cyclic-import,
27 | duplicate-code,
28 | expected-line-ending-format,
29 | global-statement,
30 | inconsistent-return-statements,
31 | locally-disabled,
32 | not-an-iterable,
33 | not-context-manager,
34 | redefined-variable-type,
35 | too-few-public-methods,
36 | too-many-arguments,
37 | too-many-branches,
38 | too-many-instance-attributes,
39 | too-many-lines,
40 | too-many-locals,
41 | too-many-public-methods,
42 | too-many-return-statements,
43 | too-many-statements,
44 | unnecessary-pass,
45 | unused-argument
46 |
47 | [REPORTS]
48 | reports=no
49 |
50 | [TYPECHECK]
51 | # For attrs
52 | ignored-classes=_CountingAttr
53 |
54 | [FORMAT]
55 | max-line-length=88
56 |
57 | [EXCEPTIONS]
58 | overgeneral-exceptions=Exception,HomeAssistantError
59 |
60 | [LOGGING]
61 | logging-format-style=fstr
62 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | flask
2 |
3 | prometheus_client
4 | paho-mqtt
5 | ruamel.yaml
6 | voluptuous
7 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [flake8]
2 | exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build
3 | max-line-length = 110
4 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | [pep8]
2 | max-line-length=110
3 |
--------------------------------------------------------------------------------