├── .eslintrc.yaml
├── .github
├── ISSUE_TEMPLATE.md
└── workflows
│ └── build.yml
├── .gitignore
├── .pre-commit-config.yaml
├── .prettierignore
├── .prettierrc.yaml
├── LICENSE
├── README.md
├── images
├── custom_cmd_bar1.png
├── custom_cmd_cfg1.png
├── navbar.png
└── navbar_raspi.png
├── octoprint_navbartemp
├── __init__.py
├── libs
│ ├── __init__.py
│ └── sbc.py
├── static
│ ├── css
│ │ └── navbartemp.css
│ ├── js
│ │ └── navbartemp.js
│ └── less
│ │ └── navbartemp.less
└── templates
│ ├── navbartemp_navbar.jinja2
│ ├── navbartemp_settings.jinja2
│ ├── navbartemp_settings_custom.jinja2
│ └── navbartemp_settings_sbc.jinja2
├── setup.cfg
└── setup.py
/.eslintrc.yaml:
--------------------------------------------------------------------------------
1 | parserOptions:
2 | ecmaVersion: 2018
3 |
4 | overrides:
5 | - files:
6 | - "octoprint_navbartemp/static/js/**.js"
7 | env:
8 | browser: true
9 | jquery: true
10 | es6: true
11 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | **PLEASE CAREFULLY FILL EACH POINT**
2 |
3 | **1. Hardware and operating system version:**
4 |
5 |
6 | **2. Octoprint version:**
7 |
8 |
9 | **3. Plugin version:**
10 |
11 |
12 | **4. Print screen of plugin configuration:**
13 |
14 |
15 | **5. Plugin full log file**
16 |
17 |
18 | **6. Clear problem description::**
19 |
20 |
21 | **7. Expectation:**
22 |
--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
1 | name: Build
2 | on:
3 | push:
4 | pull_request:
5 | release:
6 | types: [published]
7 | workflow_dispatch:
8 |
9 | jobs:
10 | build:
11 | name: 🔨 Build distribution
12 | runs-on: ubuntu-latest
13 | steps:
14 | - uses: actions/checkout@v4
15 | with:
16 | fetch-depth: 0
17 | - name: 🏗 Set up Python 3.12
18 | uses: actions/setup-python@v5
19 | with:
20 | python-version: 3.12
21 | - name: 🏗 Install build dependencies
22 | run: |
23 | pip install wheel --user
24 | pip install octoprint[develop]
25 | - name: 🔨 Build a binary wheel and a source tarball
26 | run: |
27 | python setup.py sdist bdist_wheel
28 | - name: ⬆ Upload build result
29 | uses: actions/upload-artifact@v4
30 | with:
31 | name: dist
32 | path: dist
33 |
34 | pre-commit:
35 | name: 🧹 Pre-commit
36 | runs-on: ubuntu-latest
37 | steps:
38 | - uses: actions/checkout@v4
39 | - name: 🏗 Set up Python 3.12
40 | uses: actions/setup-python@v5
41 | with:
42 | python-version: 3.12
43 | - name: 🏗 Set up dev dependencies
44 | run: |
45 | pip install octoprint[develop]
46 | pip install -e .[develop]
47 | - name: 🚀 Run pre-commit
48 | run: |
49 | pre-commit run --all-files --show-diff-on-failure
50 |
51 | test-install:
52 | name: 🧪 Installation tests
53 | needs: build
54 | strategy:
55 | matrix:
56 | python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
57 | installable: ["wheel", "sdist"]
58 | runs-on: ubuntu-latest
59 | steps:
60 | - name: ⬇ Download build result
61 | uses: actions/download-artifact@v4.1.7
62 | with:
63 | name: dist
64 | path: dist
65 | - name: 🏗 Set up Python ${{ matrix.python }}
66 | uses: actions/setup-python@v5
67 | with:
68 | python-version: ${{ matrix.python }}
69 | - name: 🏗 Install OctoPrint
70 | run: |
71 | pip install OctoPrint
72 | - name: 🚀 Install wheel
73 | if: matrix.installable == 'wheel'
74 | run: |
75 | pip install dist/*.whl
76 | - name: 🚀 Install source tarball
77 | if: matrix.installable == 'sdist'
78 | run: |
79 | sdist=$(ls dist/*.tar.gz | grep -v source)
80 | pip install "$sdist"
81 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 |
5 | # C extensions
6 | *.so
7 |
8 | # Distribution / packaging
9 | .Python
10 | env/
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | lib/
17 | lib64/
18 | parts/
19 | sdist/
20 | var/
21 | *.egg-info/
22 | .installed.cfg
23 | *.egg
24 |
25 | # PyInstaller
26 | # Usually these files are written by a python script from a template
27 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
28 | *.manifest
29 | *.spec
30 |
31 | # Installer logs
32 | pip-log.txt
33 | pip-delete-this-directory.txt
34 |
35 | # Unit test / coverage reports
36 | htmlcov/
37 | .tox/
38 | .coverage
39 | .cache
40 | nosetests.xml
41 | coverage.xml
42 |
43 | # Translations
44 | *.mo
45 | *.pot
46 |
47 | # Django stuff:
48 | *.log
49 |
50 | # Sphinx documentation
51 | docs/_build/
52 |
53 | # PyBuilder
54 | target/
55 | *.iml
56 |
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | exclude: ^setup.py
2 | repos:
3 | - repo: https://github.com/pre-commit/pre-commit-hooks
4 | rev: v4.4.0
5 | hooks:
6 | - id: end-of-file-fixer
7 | - id: trailing-whitespace
8 | - id: check-case-conflict
9 | - id: check-json
10 | - id: check-yaml
11 | - id: check-toml
12 | - id: check-merge-conflict
13 | - id: fix-encoding-pragma
14 | args: ["--remove"]
15 | - repo: https://github.com/astral-sh/ruff-pre-commit
16 | rev: v0.4.2
17 | hooks:
18 | - id: ruff
19 | args: ["--fix"]
20 | - id: ruff-format
21 | - repo: https://github.com/pre-commit/mirrors-prettier
22 | rev: v2.7.1
23 | hooks:
24 | - id: prettier
25 | - repo: https://github.com/pre-commit/mirrors-eslint
26 | rev: v8.35.0
27 | hooks:
28 | - id: eslint
29 | files: \.js$
30 |
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | *.md
2 | *.css
3 | **/package.json
4 | **/package-lock.json
5 | **/*.min.js
6 | build
7 | dist
8 | venv
9 |
--------------------------------------------------------------------------------
/.prettierrc.yaml:
--------------------------------------------------------------------------------
1 | printWidth: 90
2 | tabWidth: 4
3 | semi: true
4 | trailingComma: "none"
5 | singleQuote: false
6 | quoteProps: consistent
7 | bracketSpacing: false
8 | overrides:
9 | - files: ["*.yaml", "*.yml", "*.json", "*.less"]
10 | options:
11 | tabWidth: 2
12 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Plugin for OctoPrint - displays temperatures on navbar
2 |
3 | 
4 |
5 |
6 | ## Setup
7 |
8 | Install the plugin using Plugin Manager from Settings
9 |
10 | ## Need new platform support?
11 | If you need support for additional platform, please inform us and add such information:
12 | * How to read temperature
13 | * How to define platform type
14 |
15 | And be ready for testing.
16 |
17 | ## Custom command
18 | Plugin is supporting up to one custom command, in navbar will be displayed raw output
19 | of command.
20 | Example:
21 | 
22 |
23 | 
24 |
25 |
26 | ## Change notes:
27 | v 0.15
28 | - Fix few exceptions
29 | - Themify support added Also made the CSS safe from conflicting with other elements
30 | - Hide tools temps when not active https://github.com/imrahil/OctoPrint-NavbarTemp/issues/80
31 | - Fahrenheit display added https://github.com/imrahil/OctoPrint-NavbarTemp/issues/63 https://github.com/imrahil/OctoPrint-NavbarTemp/issues/37
32 | - Add BCM2711 as supported SoC
33 | - Consolidate vcgencmd path between versions
34 |
35 | v 0.14
36 | - Temperature is visible, connection is no needed #47 #65
37 | - Fix for python 3 - #68
38 | - Support for shorter tool names - #29
39 | - Fix for settings saving reported in #47
40 | - Added possibility to remove target temperature output #57
41 | - Added possibility to configure soc name on navbar #43
42 |
43 | v 0.13
44 | - added support for custom commands
45 |
46 | v 0.11
47 | - added support for all platforms running under Armbian
48 |
--------------------------------------------------------------------------------
/images/custom_cmd_bar1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/imrahil/OctoPrint-NavbarTemp/6d84f5703882ee85fa24d83bbce72ec809695c4d/images/custom_cmd_bar1.png
--------------------------------------------------------------------------------
/images/custom_cmd_cfg1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/imrahil/OctoPrint-NavbarTemp/6d84f5703882ee85fa24d83bbce72ec809695c4d/images/custom_cmd_cfg1.png
--------------------------------------------------------------------------------
/images/navbar.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/imrahil/OctoPrint-NavbarTemp/6d84f5703882ee85fa24d83bbce72ec809695c4d/images/navbar.png
--------------------------------------------------------------------------------
/images/navbar_raspi.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/imrahil/OctoPrint-NavbarTemp/6d84f5703882ee85fa24d83bbce72ec809695c4d/images/navbar_raspi.png
--------------------------------------------------------------------------------
/octoprint_navbartemp/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import absolute_import
2 |
3 | __author__ = "Jarek Szczepanski & Cosik "
4 | __license__ = "GNU Affero General Public License http://www.gnu.org/licenses/agpl.html"
5 | __copyright__ = (
6 | "Copyright (C) 2014 Jarek Szczepanski - Released under terms of the AGPLv3 License"
7 | )
8 |
9 | import os
10 | import sys
11 |
12 | import octoprint.plugin
13 | from octoprint.util import RepeatedTimer
14 |
15 | from .libs.sbc import SBC, SBCFactory
16 |
17 |
18 | class NavBarPlugin(
19 | octoprint.plugin.StartupPlugin,
20 | octoprint.plugin.TemplatePlugin,
21 | octoprint.plugin.AssetPlugin,
22 | octoprint.plugin.SettingsPlugin,
23 | ):
24 | def __init__(self):
25 | # Array of raspberry pi SoC's to check against, saves having a large if/then statement later
26 | self.piSocTypes = ["BCM2708", "BCM2709", "BCM2835", "BCM2711"]
27 | self.debugMode = False # to simulate temp on Win/Mac
28 | self.displayRaspiTemp = None
29 | self._checkTempTimer = None
30 | self._checkCmdTimer = None
31 | self.sbc = SBC()
32 | self.cmd = None
33 | self.cmd_name = None
34 |
35 | def on_after_startup(self):
36 | self.displayRaspiTemp = self._settings.get(["displayRaspiTemp"])
37 | self.piSocTypes = self._settings.get(["piSocTypes"])
38 | self.cmd = self._settings.get(["cmd"])
39 | self.cmd_name = self._settings.get(["cmd_name"])
40 | self._logger.debug("Custom cmd name %r" % self.cmd_name)
41 | self._logger.debug("Custom cmd %r" % self.cmd)
42 |
43 | if sys.platform.startswith("linux"):
44 | self.sbc = SBCFactory().factory(self._logger)
45 | if self.debugMode:
46 | self.sbc.is_supported = True
47 | self.sbc.debugMode = True
48 | if self.sbc.is_supported and self.displayRaspiTemp:
49 | self._logger.debug("Let's start RepeatedTimer!")
50 | interval = 5.0 if self.debugMode else 30.0
51 | self.start_soc_timer(interval)
52 |
53 | if self.cmd_name:
54 | interval = 5.0 if self.debugMode else 30.0
55 | self.start_custom_timer(interval)
56 |
57 | try:
58 | self._logger.debug("is supported? - %s" % self.sbc.is_supported)
59 | except Exception:
60 | self._logger.debug("Embeded platform is not detected")
61 |
62 | def start_soc_timer(self, interval):
63 | self._checkTempTimer = RepeatedTimer(
64 | interval, self.update_soc_temp, run_first=True
65 | )
66 | self._checkTempTimer.start()
67 |
68 | def start_custom_timer(self, interval):
69 | self._checkCmdTimer = RepeatedTimer(
70 | interval, self.update_custom, run_first=True
71 | )
72 | self._checkCmdTimer.start()
73 |
74 | def update_soc_temp(self):
75 | temp = self.sbc.check_soc_temp()
76 | self._logger.debug("match: %s" % temp)
77 | self._plugin_manager.send_plugin_message(
78 | self._identifier, dict(isSupported=self.sbc.is_supported, soctemp=temp)
79 | )
80 |
81 | def update_custom(self):
82 | cmd_rtv = self.get_custom_result()
83 | self._plugin_manager.send_plugin_message(
84 | self._identifier, dict(cmd_result=cmd_rtv, cmd_name=self.cmd_name)
85 | )
86 |
87 | def get_custom_result(self):
88 | if self.cmd:
89 | try:
90 | cmd_rtv = str(os.popen(self.cmd).read())
91 | self._logger.debug("cmd_rtv: %s" % cmd_rtv)
92 | return cmd_rtv
93 | except Exception:
94 | self._logger.debug("cmd error")
95 | return ""
96 |
97 | # ~~ SettingsPlugin
98 | def get_settings_defaults(self):
99 | return dict(
100 | displayRaspiTemp=True,
101 | piSocTypes=self.piSocTypes,
102 | cmd="",
103 | cmd_name="",
104 | useShortNames=False,
105 | makeMoreRoom=False,
106 | soc_name="SoC",
107 | )
108 |
109 | def on_settings_save(self, data):
110 | diff = super(NavBarPlugin, self).on_settings_save(data)
111 | self._logger.debug("data: " + str(data))
112 |
113 | if "displayRaspiTemp" in data:
114 | self.displayRaspiTemp = data["displayRaspiTemp"]
115 | if self.displayRaspiTemp:
116 | interval = 5.0 if self.debugMode else 30.0
117 | self.start_soc_timer(interval)
118 | else:
119 | if self._checkTempTimer is not None:
120 | try:
121 | self._checkTempTimer.cancel()
122 | except Exception:
123 | pass
124 | if "cmd" in data:
125 | self.cmd = data["cmd"]
126 | self.cmd_name = data["cmd_name"]
127 | if self.cmd:
128 | interval = 5.0 if self.debugMode else 30.0
129 | self.start_custom_timer(interval)
130 | else:
131 | if self._checkCmdTimer is not None:
132 | try:
133 | self._checkCmdTimer.cancel()
134 | except Exception:
135 | pass
136 | self._plugin_manager.send_plugin_message(self._identifier, dict())
137 |
138 | return diff
139 |
140 | # ~~ TemplatePlugin API
141 | def get_template_configs(self):
142 | try:
143 | # Todo: settings have to be fixed
144 | # if self.sbc.is_supported:
145 | # return [
146 | # dict(type="settings", template="navbartemp_settings_sbc.jinja2")
147 | # ]
148 | # else:
149 | return [dict(type="settings", template="navbartemp_settings.jinja2")]
150 | except Exception:
151 | return []
152 |
153 | # ~~ AssetPlugin API
154 | def get_assets(self):
155 | return {
156 | "js": ["js/navbartemp.js"],
157 | "css": ["css/navbartemp.css"],
158 | "less": ["less/navbartemp.less"],
159 | }
160 |
161 | # ~~ Softwareupdate hook
162 | def get_update_information(self):
163 | return dict(
164 | navbartemp=dict(
165 | displayName="Navbar Temperature Plugin",
166 | displayVersion=self._plugin_version,
167 | # version check: github repository
168 | type="github_release",
169 | user="imrahil",
170 | repo="OctoPrint-NavbarTemp",
171 | current=self._plugin_version,
172 | # update method: pip w/ dependency links
173 | pip="https://github.com/imrahil/OctoPrint-NavbarTemp/archive/{target_version}.zip",
174 | )
175 | )
176 |
177 |
178 | __plugin_name__ = "Navbar Temperature Plugin"
179 | __plugin_author__ = "Jarek Szczepanski & Cosik"
180 | __plugin_url__ = "https://github.com/imrahil/OctoPrint-NavbarTemp"
181 |
182 | # Starting with OctoPrint 1.4.0 OctoPrint will also support to run under Python 3 in addition to the deprecated
183 | # Python 2. New plugins should make sure to run under both versions for now.
184 | __plugin_pythoncompat__ = ">=2.7,<4" # python 2 and 3
185 |
186 |
187 | def __plugin_load__():
188 | global __plugin_implementation__
189 | __plugin_implementation__ = NavBarPlugin()
190 |
191 | global __plugin_hooks__
192 | __plugin_hooks__ = {
193 | "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
194 | }
195 |
--------------------------------------------------------------------------------
/octoprint_navbartemp/libs/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/imrahil/OctoPrint-NavbarTemp/6d84f5703882ee85fa24d83bbce72ec809695c4d/octoprint_navbartemp/libs/__init__.py
--------------------------------------------------------------------------------
/octoprint_navbartemp/libs/sbc.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | This module contain factory patter for different hardware platforms. Adding new platform is simple, first you need
4 | add class with inheriting from SBC. Inside you have to define differences between parent class and child. You can easily
5 | overwrite methods and parameters. For reference please look at Armbiand and RPi classes.
6 |
7 | Last step is to define way of detecting platform type. It could be very different depending on OS.
8 |
9 | """
10 |
11 | import os
12 | import re
13 |
14 |
15 | class SBCFactory(object):
16 | # Array of raspberry pi SoC's to check against, saves having a large if/then statement later
17 | piSocTypes = ["BCM2708", "BCM2709", "BCM2835", "BCM2711"]
18 |
19 | # Create based on class name:
20 | def factory(self, logger):
21 | """
22 | Method is returning handler to object based on defined criteria
23 | :param logger: global logger
24 | :return: handler to proper object
25 | """
26 | if self._is_armbian():
27 | return Armbian(logger)
28 | elif self._is_rpi(logger):
29 | return RPi(logger)
30 | return SBC()
31 |
32 | def _is_rpi(self, logger):
33 | """
34 | Detecting if is RPi - based on original code
35 | :param logger:
36 | :return:
37 | """
38 | with open("/proc/cpuinfo", "r") as infile:
39 | cpuinfo = infile.read()
40 | # Match a line like 'Hardware : BCM2709'
41 | match = re.search(
42 | r"Hardware\s+:\s+(\w+)", cpuinfo, flags=re.MULTILINE | re.IGNORECASE
43 | )
44 |
45 | if not match:
46 | return False
47 | elif match.group(1) in self.piSocTypes:
48 | logger.debug("Broadcom detected")
49 | return True
50 | return False
51 |
52 | def _is_armbian(self):
53 | """
54 | Detecting armbian - checking if armbian monitor exist
55 | :return:
56 | """
57 | return os.path.exists("/etc/armbianmonitor")
58 |
59 |
60 | class SBC(object):
61 | temp_cmd = ""
62 | is_supported = False
63 | debugMode = False
64 | parse_pattern = ""
65 | _logger = None
66 |
67 | def check_soc_temp(self):
68 | if self.debugMode:
69 | import random
70 |
71 | return str(round(random.uniform(5, 60), 2))
72 |
73 | if self.is_supported:
74 | from sarge import Capture, run
75 |
76 | p = run(self.temp_cmd, stdout=Capture())
77 | if p.returncode == 1:
78 | self.is_supported = False
79 | self._logger.debug("SoC temperature not found.")
80 | else:
81 | p = p.stdout.text
82 |
83 | self._logger.debug("response from sarge: %s" % p)
84 | self._logger.debug("used pattern: %r" % self.parse_pattern)
85 | match = re.search(self.parse_pattern, p)
86 | temp = 0
87 | if not match:
88 | self._logger.debug("match: not found")
89 | self.is_supported = False
90 | else:
91 | temp = self.parse_temperature(match)
92 | self._logger.debug("match: %s" % str(temp))
93 |
94 | return temp
95 |
96 | return 0
97 |
98 | def parse_temperature(self, re_output):
99 | return re_output.group(1)
100 |
101 |
102 | class RPi(SBC):
103 | def __init__(self, logger):
104 | self.is_supported = True
105 | self.temp_cmd = "/usr/bin/vcgencmd measure_temp"
106 | self.parse_pattern = "=(.*)'"
107 | self._logger = logger
108 |
109 |
110 | class Armbian(SBC):
111 | def __init__(self, logger):
112 | self.is_supported = True
113 | self.temp_cmd = "cat /etc/armbianmonitor/datasources/soctemp"
114 | self.parse_pattern = r"(\d+)"
115 | self._logger = logger
116 |
117 | def parse_temperature(self, re_output):
118 | """
119 | We are expecting that temp of SoC will be no more that 3 digit int. Armbian on Odroid is returning ex 44000 but
120 | on orangePi 26
121 | :param re_output:
122 | :return:
123 | """
124 | # TODO: depending on situation in the future maybe it will be necessary to split it.
125 | temp = re_output.group(1)
126 | if len(temp) == 2 or len(temp) == 3:
127 | return float(temp)
128 | elif len(temp) >= 4:
129 | return float(re_output.group(1)) / 1000
130 |
131 | return float(re_output.group(1))
132 |
--------------------------------------------------------------------------------
/octoprint_navbartemp/static/css/navbartemp.css:
--------------------------------------------------------------------------------
1 | #navbar_plugin_navbartemp .navbar-text {
2 | color: #333;
3 | text-shadow: 0 1px 0 #c8c8c8;
4 | cursor: default;
5 | }
6 | /* Standars colors for styling - we have ThemeifyOff to tell us when themeify is not running*/
7 | .navbar-inner.blue #navbar_plugin_navbartemp.ThemeifyOff .navbar-text,
8 | .navbar-inner.red #navbar_plugin_navbartemp.ThemeifyOff .navbar-text,
9 | .navbar-inner.orange #navbar_plugin_navbartemp.ThemeifyOff .navbar-text,
10 | .navbar-inner.yellow #navbar_plugin_navbartemp.ThemeifyOff .navbar-text,
11 | .navbar-inner.violet #navbar_plugin_navbartemp.ThemeifyOff .navbar-text,
12 | .navbar-inner.black #navbar_plugin_navbartemp.ThemeifyOff .navbar-text{
13 | color: #f2f2f2;
14 | }
15 | .navbar-inner.white #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
16 | color: #333;
17 | }
18 | .navbar-inner.black #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
19 | text-shadow: 0 1px 0 #5e5e5e;
20 | }
21 | .navbar-inner.white #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
22 | text-shadow: 0 1px 0 #c8c8c8;
23 | }
24 | .navbar-inner.red #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
25 | text-shadow: 0 1px 0 #d86761;
26 | }
27 | .navbar-inner.blue #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
28 | text-shadow: 0 1px 0 #1a66ff;
29 | }
30 | .navbar-inner.green #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
31 | text-shadow: 0 1px 0 #50da00;
32 | }
33 | .navbar-inner.yellow #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
34 | text-shadow: 0 1px 0 #c2b00c;
35 | }
36 | .navbar-inner.orange #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
37 | text-shadow: 0 1px 0 #f6a570;
38 | }
39 | .navbar-inner.violet #navbar_plugin_navbartemp.ThemeifyOff .navbar-text {
40 | text-shadow: 0 1px 0 #a774ff;
41 | }
42 |
43 | /* themify themes */
44 | .themeify #navbar_plugin_navbartemp .navbar-text{
45 | text-shadow: none;
46 | }
47 | .themeify.discorded #navbar_plugin_navbartemp .navbar-text {
48 | color: #dadadc;
49 | }
50 |
51 | .themeify.material_ui_light #navbar_plugin_navbartemp .navbar-text{
52 | color: #000;
53 | }
54 |
55 | .themeify.cyborg #navbar_plugin_navbartemp .navbar-text{
56 | color: #000;
57 | }
58 |
59 | .themeify.discoranged #navbar_plugin_navbartemp .navbar-text{
60 | color: #fc8003;
61 | }
62 |
63 | .themeify.dyl #navbar_plugin_navbartemp .navbar-text{
64 | color: #fff;
65 | }
66 |
67 | .themeify.nighttime #navbar_plugin_navbartemp .navbar-text{
68 | color: #bac0c6;
69 | }
70 |
--------------------------------------------------------------------------------
/octoprint_navbartemp/static/js/navbartemp.js:
--------------------------------------------------------------------------------
1 | $(function () {
2 | function NavbarTempViewModel(parameters) {
3 | var self = this;
4 |
5 | self.temperatureModel = parameters[0];
6 | self.global_settings = parameters[1];
7 | self.socTemp = ko.observable("");
8 | self.custCmd = ko.observable("");
9 | /*
10 | * raspi and awinner should be combined into something like hasSoc in the python
11 | * source, there's no need for this part to know or care what the sbc is made of
12 | *
13 | */
14 | self.isSupported = ko.observable();
15 | //hassoc should be taken care of in the python source before it gets this far
16 | self.hasSoc = ko.pureComputed(function () {
17 | return self.isSupported;
18 | });
19 |
20 | self.onAllBound = function () {
21 | // Check for themify - sadly the themeify plugin always sets the "themeify" class on html even though themes are not active so we cant use that as not selector in the css - so we use js :(
22 | if (
23 | OctoPrint.coreui.viewmodels.settingsViewModel.settings.plugins.hasOwnProperty(
24 | "themeify"
25 | )
26 | ) {
27 | OctoPrint.coreui.viewmodels.settingsViewModel.settings.plugins.themeify.enabled.subscribe(
28 | function (enabled) {
29 | if (enabled) {
30 | $("#navbar_plugin_navbartemp").removeClass("ThemeifyOff");
31 | } else {
32 | $("#navbar_plugin_navbartemp").addClass("ThemeifyOff");
33 | }
34 | }
35 | );
36 | if (
37 | !OctoPrint.coreui.viewmodels.settingsViewModel.settings.plugins.themeify.enabled()
38 | ) {
39 | $("#navbar_plugin_navbartemp").addClass("ThemeifyOff");
40 | }
41 | } else {
42 | $("#navbar_plugin_navbartemp").addClass("ThemeifyOff");
43 | }
44 | };
45 |
46 | self.onBeforeBinding = function () {
47 | self.settings = self.global_settings.settings.plugins.navbartemp;
48 | };
49 |
50 | self.formatBarTemperature = function (toolName, actual, target) {
51 | if (self.settings.useShortNames() == true) {
52 | var name = toolName.charAt(0);
53 | if (name == "T") {
54 | name = "E";
55 | }
56 | if (toolName.split(" ")[1]) {
57 | name += toolName.split(" ")[1];
58 | }
59 | } else {
60 | var name = toolName;
61 | }
62 | var output = "";
63 |
64 | if (self.settings.makeMoreRoom() == false) {
65 | output = name + ": " + _.sprintf("%.1f°C", actual);
66 | if (target) {
67 | var sign = target >= actual ? " \u21D7 " : " \u21D8 ";
68 | output += sign + _.sprintf("%.1f°C", target);
69 | }
70 | } else {
71 | output = name + ":" + _.sprintf("%.1f°C", actual);
72 | }
73 | // Add fahrenheit
74 | if (
75 | OctoPrint.coreui.viewmodels.settingsViewModel.appearance_showFahrenheitAlso()
76 | ) {
77 | output += " (" + _.sprintf("%.1f°F", actual * (9 / 5) + 32) + ")";
78 | }
79 | return output;
80 | };
81 |
82 | self.onDataUpdaterPluginMessage = function (plugin, data) {
83 | if (plugin != "navbartemp") {
84 | return;
85 | }
86 |
87 | if (data.soctemp) {
88 | // Add fahrenheit
89 | var fahrenheit = "";
90 | if (
91 | OctoPrint.coreui.viewmodels.settingsViewModel.appearance_showFahrenheitAlso()
92 | ) {
93 | fahrenheit =
94 | " (" + _.sprintf("%.1f°F", data.soctemp * (9 / 5) + 32) + ")";
95 | }
96 | if (self.settings.makeMoreRoom() == false) {
97 | self.socTemp(
98 | self.settings.soc_name() +
99 | _.sprintf(": %.1f°C", data.soctemp) +
100 | fahrenheit
101 | );
102 | } else {
103 | self.socTemp(
104 | self.settings.soc_name() +
105 | _.sprintf(":%.1f°C", data.soctemp) +
106 | fahrenheit
107 | );
108 | }
109 | }
110 | if (data.cmd_name) {
111 | self.custCmd(
112 | _.sprintf(" %s: ", data.cmd_name) + _.sprintf("%s", data.cmd_result)
113 | );
114 | }
115 | };
116 |
117 | self.onSettingsHidden = function () {
118 | if (self.settings.displayRaspiTemp() == false) {
119 | self.socTemp("");
120 | }
121 | };
122 | }
123 |
124 | OCTOPRINT_VIEWMODELS.push({
125 | construct: NavbarTempViewModel,
126 | dependencies: ["temperatureViewModel", "settingsViewModel"],
127 | elements: ["#navbar_plugin_navbartemp", "#settings_plugin_navbartemp"]
128 | });
129 | });
130 |
--------------------------------------------------------------------------------
/octoprint_navbartemp/static/less/navbartemp.less:
--------------------------------------------------------------------------------
1 | @default-shadow: #c8c8c8;
2 | @black-shadow: #5e5e5e;
3 | @red-shadow: #d86761;
4 | @blue-shadow: #1a66ff;
5 | @green-shadow: #50da00;
6 | @yellow-shadow: #c2b00c;
7 | @violet-shadow: #a774ff;
8 | @orange-shadow: #f6a570;
9 | @white-shadow: #c8c8c8;
10 |
11 | @whiteish: #f2f2f2;
12 | @darkish: #333;
13 |
14 | .navbar-inner {
15 | .navbar-text {
16 | color: @darkish;
17 | text-shadow: 0 1px 0 @default-shadow;
18 | cursor: default;
19 | }
20 | }
21 |
22 | .navbar-inner {
23 | &.blue,
24 | &.red,
25 | &.orange,
26 | &.yellow,
27 | &.violet,
28 | &.black {
29 | .navbar-text {
30 | color: @whiteish;
31 | }
32 | }
33 | &.white .navbar-text {
34 | color: @darkish;
35 | }
36 | }
37 |
38 | .navbar-inner {
39 | &.black .navbar-text {
40 | text-shadow: 0 1px 0 @black-shadow;
41 | }
42 | &.white .navbar-text {
43 | text-shadow: 0 1px 0 @white-shadow;
44 | }
45 | &.red .navbar-text {
46 | text-shadow: 0 1px 0 @red-shadow;
47 | }
48 | &.blue .navbar-text {
49 | text-shadow: 0 1px 0 @blue-shadow;
50 | }
51 | &.green .navbar-text {
52 | text-shadow: 0 1px 0 @green-shadow;
53 | }
54 | &.yellow .navbar-text {
55 | text-shadow: 0 1px 0 @yellow-shadow;
56 | }
57 | &.orange .navbar-text {
58 | text-shadow: 0 1px 0 @orange-shadow;
59 | }
60 | &.violet .navbar-text {
61 | text-shadow: 0 1px 0 @violet-shadow;
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/octoprint_navbartemp/templates/navbartemp_navbar.jinja2:
--------------------------------------------------------------------------------
1 |