# 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.
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.
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](https://docs.octoprint.org/en/master/features/safemode.html).
## 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](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
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](https://faq.octoprint.org/warning-firmware-unsafe)
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](https://faq.octoprint.org/warning-firmware-broken-cbd)
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](https://faq.octoprint.org/warning-firmware-broken-creality-temp)
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](https://faq.octoprint.org/warning-firmware-development)
for a list of currently detected firmware variants.
Raw data
{
"_id": null,
"home_page": "https://github.com/OctoPrint/OctoPrint-FirmwareCheck",
"name": "OctoPrint-FirmwareCheck",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Gina H\u00e4u\u00dfge",
"author_email": "gina@octoprint.org",
"download_url": "https://files.pythonhosted.org/packages/db/31/fe4ddb176b5de9930278a72ed15fdfc57470066c000f23c6fdd056bbcd8b/OctoPrint-FirmwareCheck-2021.10.11.tar.gz",
"platform": "",
"description": "# Firmware Check\n\nThe Firmware Check plugin tries to identify printers or rather printer firmware with known safety issues, such as\ndisabled thermal runaway protection, or other kinds of severe issues, like known communication crippling bugs, and\ndisplays a warning box to logged in users on identification of such a firmware.\n\n\n\nSince version 2021-2-4 it also displays info/\"heads-ups\" messages if a development firmware build\nis detected. This kind of message can be disabled.\n\n\n\nIt was formerly called \"Printer Safety Check\" and used to be bundled with OctoPrint since version\n1.3.7. It was unbundled in 1.4.1 and turned into an install dependency to allow for a separate release cycle. It is\nstill considered a core plugin of OctoPrint, treated as if bundled and thus also active in [safe mode](https://docs.octoprint.org/en/master/features/safemode.html).\n\n## Setup\n\nThe plugin is part of the core dependencies of OctoPrint 1.4.1+ and will be installed automatically alongside it.\n\nIn case you want to manually install it into an older version for whatever reason, install via the bundled\n[Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)\nor manually using this URL:\n\n https://github.com/OctoPrint/OctoPrint-FirmwareCheck/archive/master.zip\n\nTo install and/or rollback to a specific version `<version>`, either use this URL in the plugin manager:\n\n https://github.com/OctoPrint/OctoPrint-FirmwareCheck/archive/<version>.zip\n\nor run\n\n pip install OctoPrint-FirmwareCheck==<version>\n\nin your OctoPrint virtual environment, substituting `<version>` accordingly.\n\n## Events\n\n### plugin_firmware_check_warning\n\n*(as `Events.PLUGIN_FIRMWARE_CHECK_WARNING`)*\n\nA firmware check warning was triggered.\n\nPayload:\n * `warning_type`: type of warning that was triggered (currently `firmware-unsafe` or `firmware-broken`)\n * `check_name`: name of check that was triggered (e.g. `aneta8`, `cbd`)\n * `check_type`: type of check that was triggered (e.g. `m115`, `received` or `cap`)\n\n## Detected issues\n\nThe plugin currently issues three types of warnings: `firmware-unsafe` for firmware known to have severe safety issues,\n`firmware-broken` for firmware known to have a broken implementation of the communication protocol\nand `firmware-development` for detected development builds of firmware.\n\n### Unsafe firmware\n\nPlease refer to the [entry on the \"unsafe firmware\" warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-unsafe)\nfor a list of currently known to be affected printers.\n\n### Broken firmware\n\n#### \"CBD\"/\"ZWLF\" firmware\n\nPlease refer to the [entry on the \"broken CBD firmware\" warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-broken-cbd)\nfor a list of currently known to be affected printers.\n\n#### Creality firmware with broken temperature reporting\n\nPlease refer to the [entry on the this warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-broken-creality-temp)\nfor variants of this and a list of currently known to be affected printers.\n\n### Development firmware\n\nPlease refer to the [entry on the \"development firmware\" warning in OctoPrint's FAQ](https://faq.octoprint.org/warning-firmware-development)\nfor a list of currently detected firmware variants.\n\n\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Checks for unsafe or broken printer firmwares",
"version": "2021.10.11",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "531a6b0aa071e4c36478008041bb5ef071b1d3299c98379d51e0f323da9a374e",
"md5": "19e73afdfc9e8341fd32d817c2a4e4b1",
"sha256": "31fe050e07f4c0f4dc555b32aeaee00b4d2bd6aade46632e9604e9090262d683"
},
"downloads": -1,
"filename": "OctoPrint_FirmwareCheck-2021.10.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "19e73afdfc9e8341fd32d817c2a4e4b1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 33800,
"upload_time": "2021-10-11T13:04:17",
"upload_time_iso_8601": "2021-10-11T13:04:17.989847Z",
"url": "https://files.pythonhosted.org/packages/53/1a/6b0aa071e4c36478008041bb5ef071b1d3299c98379d51e0f323da9a374e/OctoPrint_FirmwareCheck-2021.10.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db31fe4ddb176b5de9930278a72ed15fdfc57470066c000f23c6fdd056bbcd8b",
"md5": "4e881f30c220e63b9d3d37cb95ccdd2e",
"sha256": "506861624a8faf2633765eaf2aa6635bead8afc7471a375f399cbe5f33d0f99e"
},
"downloads": -1,
"filename": "OctoPrint-FirmwareCheck-2021.10.11.tar.gz",
"has_sig": false,
"md5_digest": "4e881f30c220e63b9d3d37cb95ccdd2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30755,
"upload_time": "2021-10-11T13:04:19",
"upload_time_iso_8601": "2021-10-11T13:04:19.329089Z",
"url": "https://files.pythonhosted.org/packages/db/31/fe4ddb176b5de9930278a72ed15fdfc57470066c000f23c6fdd056bbcd8b/OctoPrint-FirmwareCheck-2021.10.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-10-11 13:04:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "OctoPrint",
"github_project": "OctoPrint-FirmwareCheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "octoprint-firmwarecheck"
}
JSON
