Skip to main content

Checks for unsafe or broken printer firmwares

Project description

Firmware Check

The Firmware Check plugin tries to identify printers or rather printer firmware with known safety issues, such as disabled thermal runaway protection, or other kinds of severe issues, like known communication crippling bugs, and displays a warning box to logged in users on identification of such a firmware.

Screenshot of two warnings

Since version 2021-2-4 it also displays info/"heads-ups" messages if a development firmware build is detected. This kind of message can be disabled.

Screenshot of an info

It was formerly called "Printer Safety Check" and used to be bundled with OctoPrint since version 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 still considered a core plugin of OctoPrint, treated as if bundled and thus also active in safe mode.

Setup

The plugin is part of the core dependencies of OctoPrint 1.4.1+ and will be installed automatically alongside it.

In case you want to manually install it into an older version for whatever reason, install via the bundled Plugin Manager or manually using this URL:

https://github.com/OctoPrint/OctoPrint-FirmwareCheck/archive/master.zip

To install and/or rollback to a specific version <version>, either use this URL in the plugin manager:

https://github.com/OctoPrint/OctoPrint-FirmwareCheck/archive/<version>.zip

or run

pip install OctoPrint-FirmwareCheck==<version>

in your OctoPrint virtual environment, substituting <version> accordingly.

Events

plugin_firmware_check_warning

(as Events.PLUGIN_FIRMWARE_CHECK_WARNING)

A firmware check warning was triggered.

Payload:

  • warning_type: type of warning that was triggered (currently firmware-unsafe or firmware-broken)
  • check_name: name of check that was triggered (e.g. aneta8, cbd)
  • check_type: type of check that was triggered (e.g. m115, received or cap)

Detected issues

The plugin currently issues three types of warnings: firmware-unsafe for firmware known to have severe safety issues, firmware-broken for firmware known to have a broken implementation of the communication protocol and firmware-development for detected development builds of firmware.

Unsafe firmware

Please refer to the entry on the "unsafe firmware" warning in OctoPrint's FAQ for a list of currently known to be affected printers.

Broken firmware

"CBD"/"ZWLF" firmware

Please refer to the entry on the "broken CBD firmware" warning in OctoPrint's FAQ for a list of currently known to be affected printers.

Creality firmware with broken temperature reporting

Please refer to the entry on the this warning in OctoPrint's FAQ for variants of this and a list of currently known to be affected printers.

Development firmware

Please refer to the entry on the "development firmware" warning in OctoPrint's FAQ for a list of currently detected firmware variants.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

octoprint_firmwarecheck-2025.7.23.tar.gz (27.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

octoprint_firmwarecheck-2025.7.23-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file octoprint_firmwarecheck-2025.7.23.tar.gz.

File metadata

File hashes

Hashes for octoprint_firmwarecheck-2025.7.23.tar.gz
Algorithm Hash digest
SHA256 a85611dc729f88245305e68e1da2d2f332aace1ccfc9521d004ae44ef1325c3f
MD5 57cb13f0923e7377c7a229d00a9ad926
BLAKE2b-256 49c2b1590616df87fc0006407363253ebd6d3c0409ba0e27f6da77dbd88a3bc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for octoprint_firmwarecheck-2025.7.23.tar.gz:

Publisher: build.yml on OctoPrint/OctoPrint-FirmwareCheck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file octoprint_firmwarecheck-2025.7.23-py3-none-any.whl.

File metadata

File hashes

Hashes for octoprint_firmwarecheck-2025.7.23-py3-none-any.whl
Algorithm Hash digest
SHA256 cf93cef59bd934d5a5b896147699120e2048c1cb33671edaf6e3d9a62194b8aa
MD5 83cd47bbfee4cc32de5dae16e391a088
BLAKE2b-256 edddfcb11819680661a4b193ea22d0f341c9b4f71cfdb133abc5843aae65c97d

See more details on using hashes here.

Provenance

The following attestation bundles were made for octoprint_firmwarecheck-2025.7.23-py3-none-any.whl:

Publisher: build.yml on OctoPrint/OctoPrint-FirmwareCheck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page