summaryrefslogtreecommitdiff
path: root/python-octoprint-firmwarecheck.spec
blob: fc63cd998b4f30422d735f780cd7b4988e7d3836 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
%global _empty_manifest_terminate_build 0
Name:		python-OctoPrint-FirmwareCheck
Version:	2021.10.11
Release:	1
Summary:	Checks for unsafe or broken printer firmwares
License:	AGPLv3
URL:		https://github.com/OctoPrint/OctoPrint-FirmwareCheck
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/db/31/fe4ddb176b5de9930278a72ed15fdfc57470066c000f23c6fdd056bbcd8b/OctoPrint-FirmwareCheck-2021.10.11.tar.gz
BuildArch:	noarch

Requires:	python3-pre-commit

%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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot.png)

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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot2.png)

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.




%package -n python3-OctoPrint-FirmwareCheck
Summary:	Checks for unsafe or broken printer firmwares
Provides:	python-OctoPrint-FirmwareCheck
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-OctoPrint-FirmwareCheck
# 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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot.png)

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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot2.png)

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.




%package help
Summary:	Development documents and examples for OctoPrint-FirmwareCheck
Provides:	python3-OctoPrint-FirmwareCheck-doc
%description help
# 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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot.png)

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](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FirmwareCheck/master/extras/screenshot2.png)

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.




%prep
%autosetup -n OctoPrint-FirmwareCheck-2021.10.11

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-OctoPrint-FirmwareCheck -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 2021.10.11-1
- Package Spec generated