Skip to content

Commit d78a5dc

Browse files
committed
📝 Update docs in README
1 parent 6a1d9de commit d78a5dc

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ The Firmware Check plugin tries to identify printers or rather printer firmware
44
disabled thermal runaway protection, or other kinds of severe issues, like known communication crippling bugs, and
55
displays a warning box to logged in users on identification of such a firmware.
66

7-
![Screenshot](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot.png)
7+
![Screenshot of two warnings](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot.png)
8+
9+
Since version 2021-2-4 it also displays info/"heads-ups" messages if a development firmware build
10+
is detected. This kind of message can be disabled.
11+
12+
![Screenshot of an info](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot2.png)
813

914
It was formerly called "Printer Safety Check" and used to be bundled with OctoPrint since version
1015
1.3.7. It was unbundled in 1.4.1 and turned into an install dependency to allow for a separate release cycle. It is
@@ -45,8 +50,9 @@ Payload:
4550

4651
## Detected issues
4752

48-
The plugin currently issues two types of warnings: `firmware-unsafe` for firmware known to have severe safety issues
49-
and `firmware-broken` for firmware known to have a broken implementation of the communication protocol.
53+
The plugin currently issues three types of warnings: `firmware-unsafe` for firmware known to have severe safety issues,
54+
`firmware-broken` for firmware known to have a broken implementation of the communication protocol
55+
and `firmware-development` for detected development builds of firmware.
5056

5157
### Unsafe firmware
5258

@@ -65,3 +71,7 @@ for a list of currently known to be affected printers.
6571
Please refer to the [entry on the this warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-broken-creality-temp)
6672
for variants of this and a list of currently known to be affected printers.
6773

74+
### Development firmware
75+
76+
Please refer to the [entry on the "development firmware" warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-development)
77+
for a list of currently detected firmware variants.

extras/screenshot2.png

4.56 KB
Loading

0 commit comments

Comments
 (0)