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

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

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 two types of warnings: firmware-unsafe for firmware known to have severe safety issues and firmware-broken for firmware known to have a broken implementation of the communication protocol.

Unsafe firmware

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

Broken firmware

"CBD" firmware

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

Project details


Download files

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

Files for OctoPrint-FirmwareCheck, version 2020.3.27
Filename, size File type Python version Upload date Hashes
Filename, size OctoPrint_FirmwareCheck-2020.3.27-py2.py3-none-any.whl (26.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size OctoPrint-FirmwareCheck-2020.3.27.tar.gz (25.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page