Skip to content

Commit 7b53066

Browse files
committed
docs(coverage): the docker column plans what a printer connection in the image would reach
1 parent faac661 commit 7b53066

4 files changed

Lines changed: 231 additions & 155 deletions

File tree

‎docs/zpl-coverage.md‎

Lines changed: 77 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Every command of the ZPL II Programming Guide and what it takes to use it in ZPL
66
|---|---|
77
| **Web** | The browser build reads the command on import and writes it back on export: as itself, folded into object properties (`^FW`, `^LR`, `^BY`, `^MU`, `^LH`, `^LT`, `^CI`), or into the Setup Script (printer setup commands). Structural commands (`^XA`, `^FS`, prefix changers) carry no user state |
88
| **Desktop** | The same in the desktop app, which also talks to a connected printer; commands that need one (host queries, calibration, downloads to printer storage, RFID hardware) can only ever get a mark here |
9-
| **Docker** | The same in the self-hosted image. The image serves the web build today, so this column repeats Web. It will diverge once the image gains server-side features |
9+
| **Docker** | The same in the self-hosted image, which serves the web build today. A container can open a printer connection, so what the desktop reaches that way is planned here |
1010

1111
| Mark | Meaning |
1212
|:-:|---|
@@ -79,7 +79,7 @@ never share. The row total is pinned in `packages/core/src/catalog/catalog.test.
7979
| `^CW` | font alias | `[x]` | `[x]` | `[x]` |
8080
| `^CO` | font cache size | `[x]` | `[x]` | `[x]` |
8181
| `^FL` | font linking | `[x]` | `[x]` | `[x]` |
82-
| `^LF` | list font links | `[ ]` | `[~]` | `[ ]` |
82+
| `^LF` | list font links | `[ ]` | `[~]` | `[~]` |
8383
| `~DB` | download bitmap font | `[x]` | `[x]` | `[x]` |
8484
| `~DS` | download scalable font | `[x]` | `[x]` | `[x]` |
8585
| `~DT` | download TrueType font | `[x]` | `[x]` | `[x]` |
@@ -132,12 +132,12 @@ never share. The row total is pinned in `packages/core/src/catalog/catalog.test.
132132
| `^GS` | graphic symbol | `[x]` | `[x]` | `[x]` |
133133
| `^IL` | image load | `[x]` | `[x]` | `[x]` |
134134
| `^IM` | image move | `[x]` | `[x]` | `[x]` |
135-
| `^ID` | delete stored graphics, fonts and formats | `[ ]` | `[x]` | `[ ]` |
136-
| `^IS` | image save | `[ ]` | `[x]` | `[ ]` |
135+
| `^ID` | delete stored graphics, fonts and formats | `[ ]` | `[x]` | `[~]` |
136+
| `^IS` | image save | `[ ]` | `[x]` | `[~]` |
137137
| `~DG` | download graphic | `[x]` | `[x]` | `[x]` |
138-
| `~DN` | abort download | `[ ]` | `[~]` | `[ ]` |
138+
| `~DN` | abort download | `[ ]` | `[~]` | `[~]` |
139139
| `~DY` | download font / graphic | `[x]` | `[x]` | `[x]` |
140-
| `~EG` | erase download graphics | `[ ]` | `[~]` | `[ ]` |
140+
| `~EG` | erase download graphics | `[ ]` | `[~]` | `[~]` |
141141

142142
## Serialisation
143143

@@ -181,11 +181,11 @@ never share. The row total is pinned in `packages/core/src/catalog/catalog.test.
181181
| `~JS` | change backfeed sequence | `[x]` | `[x]` | `[x]` |
182182
| `^PF` | slew given number of dot rows | `[x]` | `[x]` | `[x]` |
183183
| `^PH` | slew home | `[x]` | `[x]` | `[x]` |
184-
| `~PH` | slew home, immediate | `[ ]` | `[~]` | `[ ]` |
184+
| `~PH` | slew home, immediate | `[ ]` | `[~]` | `[~]` |
185185
| `^PP` | programmable pause | `[x]` | `[x]` | `[x]` |
186-
| `~PP` | pause, immediate | `[ ]` | `[~]` | `[ ]` |
187-
| `~PR` | applicator reprint | `[ ]` | `[~]` | `[ ]` |
188-
| `~PS` | print start | `[ ]` | `[~]` | `[ ]` |
186+
| `~PP` | pause, immediate | `[ ]` | `[~]` | `[~]` |
187+
| `~PR` | applicator reprint | `[ ]` | `[~]` | `[~]` |
188+
| `~PS` | print start | `[ ]` | `[~]` | `[~]` |
189189
| `^CN` | cut now, KR403 kiosk only | `[ ]` | `[ ]` | `[ ]` |
190190
| `~PL` | present length addition, KR403 kiosk only | `[ ]` | `[ ]` | `[ ]` |
191191
| `^PN` | presenter cycle, KR403 kiosk only | `[ ]` | `[ ]` | `[ ]` |
@@ -223,71 +223,71 @@ never share. The row total is pinned in `packages/core/src/catalog/catalog.test.
223223
| `^CC` / `~CC` | change caret | `[x]` | `[x]` | `[x]` |
224224
| `^CD` / `~CD` | change delimiter | `[x]` | `[x]` | `[x]` |
225225
| `^CT` / `~CT` | change tilde | `[x]` | `[x]` | `[x]` |
226-
| `^CM` | change memory letter assignment | `[ ]` | `[~]` | `[ ]` |
226+
| `^CM` | change memory letter assignment | `[ ]` | `[~]` | `[~]` |
227227

228228
## Hardware control & calibration
229229

230230
Printer-side control, calibration and device actions; most need a connection or feedback from the device.
231231

232232
| Command | Name | Web | Desktop | Docker |
233233
|---|---|:-:|:-:|:-:|
234-
| `~JA` | cancel all | `[ ]` | `[~]` | `[ ]` |
235-
| `^JB` | initialize flash memory | `[ ]` | `[~]` | `[ ]` |
236-
| `~JB` | reset optional memory | `[ ]` | `[~]` | `[ ]` |
237-
| `~JC` | media sensor calibration | `[ ]` | `[~]` | `[ ]` |
238-
| `~JD` | enable communications diagnostics | `[ ]` | `[~]` | `[ ]` |
239-
| `~JE` | disable communications diagnostics | `[ ]` | `[~]` | `[ ]` |
234+
| `~JA` | cancel all | `[ ]` | `[~]` | `[~]` |
235+
| `^JB` | initialize flash memory | `[ ]` | `[~]` | `[~]` |
236+
| `~JB` | reset optional memory | `[ ]` | `[~]` | `[~]` |
237+
| `~JC` | media sensor calibration | `[ ]` | `[~]` | `[~]` |
238+
| `~JD` | enable communications diagnostics | `[ ]` | `[~]` | `[~]` |
239+
| `~JE` | disable communications diagnostics | `[ ]` | `[~]` | `[~]` |
240240
| `~JF` | set battery condition, PA400 and PT400 only | `[ ]` | `[ ]` | `[ ]` |
241-
| `~JG` | graphing sensor calibration | `[ ]` | `[~]` | `[ ]` |
242-
| `^JI` / `~JI` | start ZBI | `[ ]` | `[~]` | `[ ]` |
243-
| `^JJ` | set auxiliary port | `[ ]` | `[~]` | `[ ]` |
244-
| `^JS` | sensor select | `[ ]` | `[~]` | `[ ]` |
245-
| `~JL` | set label length | `[ ]` | `[~]` | `[ ]` |
241+
| `~JG` | graphing sensor calibration | `[ ]` | `[~]` | `[~]` |
242+
| `^JI` / `~JI` | start ZBI | `[ ]` | `[~]` | `[~]` |
243+
| `^JJ` | set auxiliary port | `[ ]` | `[~]` | `[~]` |
244+
| `^JS` | sensor select | `[ ]` | `[~]` | `[~]` |
245+
| `~JL` | set label length | `[ ]` | `[~]` | `[~]` |
246246
| `^JM` | dots per millimeter | `[x]` | `[x]` | `[x]` |
247-
| `~JN` | printhead test fatal | `[ ]` | `[~]` | `[ ]` |
248-
| `~JO` | printhead test non-fatal | `[ ]` | `[~]` | `[ ]` |
249-
| `~JP` | pause and cancel format | `[ ]` | `[~]` | `[ ]` |
250-
| `~JQ` | terminate ZBI | `[ ]` | `[~]` | `[ ]` |
251-
| `~JR` | power on reset | `[ ]` | `[~]` | `[ ]` |
252-
| `~JX` | cancel partial format | `[ ]` | `[~]` | `[ ]` |
253-
| `~RO` | reset advanced counter | `[ ]` | `[~]` | `[ ]` |
254-
| `^SC` | set serial communications | `[ ]` | `[~]` | `[ ]` |
255-
| `^SI` | set sensor intensity | `[ ]` | `[~]` | `[ ]` |
247+
| `~JN` | printhead test fatal | `[ ]` | `[~]` | `[~]` |
248+
| `~JO` | printhead test non-fatal | `[ ]` | `[~]` | `[~]` |
249+
| `~JP` | pause and cancel format | `[ ]` | `[~]` | `[~]` |
250+
| `~JQ` | terminate ZBI | `[ ]` | `[~]` | `[~]` |
251+
| `~JR` | power on reset | `[ ]` | `[~]` | `[~]` |
252+
| `~JX` | cancel partial format | `[ ]` | `[~]` | `[~]` |
253+
| `~RO` | reset advanced counter | `[ ]` | `[~]` | `[~]` |
254+
| `^SC` | set serial communications | `[ ]` | `[~]` | `[~]` |
255+
| `^SI` | set sensor intensity | `[ ]` | `[~]` | `[~]` |
256256
| `^SP` | start print at dot row, throughput hint only | `[ ]` | `[ ]` | `[ ]` |
257-
| `^SQ` | halt ZebraNet alert | `[ ]` | `[~]` | `[ ]` |
258-
| `^SR` | set printhead resistance | `[ ]` | `[~]` | `[ ]` |
259-
| `^SS` | set media sensors | `[ ]` | `[~]` | `[ ]` |
260-
| `^SX` | set ZebraNet alert | `[ ]` | `[~]` | `[ ]` |
261-
| `^TO` | transfer object | `[ ]` | `[~]` | `[ ]` |
262-
| `~WC` | print configuration label | `[ ]` | `[~]` | `[ ]` |
263-
| `^WD` | print directory label | `[ ]` | `[~]` | `[ ]` |
264-
| `~WQ` | write query | `[ ]` | `[~]` | `[ ]` |
257+
| `^SQ` | halt ZebraNet alert | `[ ]` | `[~]` | `[~]` |
258+
| `^SR` | set printhead resistance | `[ ]` | `[~]` | `[~]` |
259+
| `^SS` | set media sensors | `[ ]` | `[~]` | `[~]` |
260+
| `^SX` | set ZebraNet alert | `[ ]` | `[~]` | `[~]` |
261+
| `^TO` | transfer object | `[ ]` | `[~]` | `[~]` |
262+
| `~WC` | print configuration label | `[ ]` | `[~]` | `[~]` |
263+
| `^WD` | print directory label | `[ ]` | `[~]` | `[~]` |
264+
| `~WQ` | write query | `[ ]` | `[~]` | `[~]` |
265265
| `^KV` | cutter and presenter settings, KR403 only | `[ ]` | `[ ]` | `[ ]` |
266-
| `^XS` | set dynamic media calibration | `[ ]` | `[~]` | `[ ]` |
267-
| `~PM` | decommissioning mode | `[ ]` | `[~]` | `[ ]` |
266+
| `^XS` | set dynamic media calibration | `[ ]` | `[~]` | `[~]` |
267+
| `~PM` | decommissioning mode | `[ ]` | `[~]` | `[~]` |
268268
| `^ZZ` | printer sleep, PA400 and PT400 only | `[ ]` | `[ ]` | `[ ]` |
269269
| `^CP` | eject or retract a presented page, KR403 only | `[ ]` | `[ ]` | `[ ]` |
270-
| `~KB` | kill battery | `[ ]` | `[~]` | `[ ]` |
270+
| `~KB` | kill battery | `[ ]` | `[~]` | `[~]` |
271271

272272
## Host communication
273273

274274
| Command | Name | Web | Desktop | Docker |
275275
|---|---|:-:|:-:|:-:|
276276
| `~HB` | battery status, mobile printers only | `[ ]` | `[ ]` | `[ ]` |
277-
| `~HD` | printhead diagnostic | `[ ]` | `[~]` | `[ ]` |
278-
| `^HF` | host format | `[ ]` | `[~]` | `[ ]` |
279-
| `^HG` | host graphic | `[ ]` | `[x]` | `[ ]` |
280-
| `^HH` | configuration label return | `[ ]` | `[x]` | `[ ]` |
281-
| `~HI` | host identification | `[ ]` | `[x]` | `[ ]` |
282-
| `~HM` | host RAM status | `[ ]` | `[x]` | `[ ]` |
283-
| `~HQ` | host query | `[ ]` | `[~]` | `[ ]` |
284-
| `~HS` | host status return | `[ ]` | `[x]` | `[ ]` |
285-
| `^HT` | host linked fonts list | `[ ]` | `[~]` | `[ ]` |
286-
| `~HU` | ZebraNet alert configuration | `[ ]` | `[~]` | `[ ]` |
287-
| `^HV` | host verification | `[ ]` | `[~]` | `[ ]` |
288-
| `^HW` | host directory | `[ ]` | `[x]` | `[ ]` |
289-
| `^HY` | upload graphics | `[ ]` | `[x]` | `[ ]` |
290-
| `^HZ` | display description information | `[ ]` | `[~]` | `[ ]` |
277+
| `~HD` | printhead diagnostic | `[ ]` | `[~]` | `[~]` |
278+
| `^HF` | host format | `[ ]` | `[~]` | `[~]` |
279+
| `^HG` | host graphic | `[ ]` | `[x]` | `[~]` |
280+
| `^HH` | configuration label return | `[ ]` | `[x]` | `[~]` |
281+
| `~HI` | host identification | `[ ]` | `[x]` | `[~]` |
282+
| `~HM` | host RAM status | `[ ]` | `[x]` | `[~]` |
283+
| `~HQ` | host query | `[ ]` | `[~]` | `[~]` |
284+
| `~HS` | host status return | `[ ]` | `[x]` | `[~]` |
285+
| `^HT` | host linked fonts list | `[ ]` | `[~]` | `[~]` |
286+
| `~HU` | ZebraNet alert configuration | `[ ]` | `[~]` | `[~]` |
287+
| `^HV` | host verification | `[ ]` | `[~]` | `[~]` |
288+
| `^HW` | host directory | `[ ]` | `[x]` | `[~]` |
289+
| `^HY` | upload graphics | `[ ]` | `[x]` | `[~]` |
290+
| `^HZ` | display description information | `[ ]` | `[~]` | `[~]` |
291291

292292
## RFID
293293

@@ -299,45 +299,45 @@ password-coupled ^RL. Read-back stays native. ^RM/^RR folded into ^RS,
299299
| Command | Name | Web | Desktop | Docker |
300300
|---|---|:-:|:-:|:-:|
301301
| `^RF` | read / write RFID | `[~]` | `[~]` | `[~]` |
302-
| `^RI` | get tag ID | `[ ]` | `[~]` | `[ ]` |
302+
| `^RI` | get tag ID | `[ ]` | `[~]` | `[~]` |
303303
| `^RM` | enable motion, pre-Link-OS, folded into ^RS | `[ ]` | `[ ]` | `[ ]` |
304304
| `^RN` | detect multiple tags, pre-Link-OS, absent from guide | `[ ]` | `[ ]` | `[ ]` |
305305
| `^RR` | RFID retries, pre-Link-OS, folded into ^RS | `[ ]` | `[ ]` | `[ ]` |
306306
| `^RB` | define EPC data structure | `[x]` | `[x]` | `[x]` |
307307
| `^RS` | RFID setup | `[x]` | `[x]` | `[x]` |
308-
| `^RT` | read tag | `[ ]` | `[~]` | `[ ]` |
308+
| `^RT` | read tag | `[ ]` | `[~]` | `[~]` |
309309
| `^WT` | legacy RFID write, superseded by ^RF | `[ ]` | `[ ]` | `[ ]` |
310-
| `^RU` | read unique chip serialisation | `[ ]` | `[~]` | `[ ]` |
310+
| `^RU` | read unique chip serialisation | `[ ]` | `[~]` | `[~]` |
311311
| `~RV` | report encoding result, pre-Link-OS, absent from guide | `[ ]` | `[ ]` | `[ ]` |
312312
| `^RW` | set read and write power | `[x]` | `[x]` | `[x]` |
313313
| `^RL` | lock / permalock tag memory | `[~]` | `[~]` | `[~]` |
314-
| `^HR` | calibrate RFID tag position | `[ ]` | `[~]` | `[ ]` |
315-
| `^HL` / `~HL` | RFID data log | `[ ]` | `[~]` | `[ ]` |
314+
| `^HR` | calibrate RFID tag position | `[ ]` | `[~]` | `[~]` |
315+
| `^HL` / `~HL` | RFID data log | `[ ]` | `[~]` | `[~]` |
316316

317317
## Network
318318

319319
| Command | Name | Web | Desktop | Docker |
320320
|---|---|:-:|:-:|:-:|
321-
| `^NB` | check for wired print server at boot | `[ ]` | `[~]` | `[ ]` |
322-
| `^NC` | select wired / wireless primary device | `[ ]` | `[~]` | `[ ]` |
321+
| `^NB` | check for wired print server at boot | `[ ]` | `[~]` | `[~]` |
322+
| `^NC` | select wired / wireless primary device | `[ ]` | `[~]` | `[~]` |
323323
| `~NC` | network connect, legacy RS-485 only | `[ ]` | `[ ]` | `[ ]` |
324324
| `^NI` | network ID, legacy RS-485 only | `[ ]` | `[ ]` | `[ ]` |
325-
| `^NN` | set SNMP | `[ ]` | `[~]` | `[ ]` |
326-
| `^NP` | boot settings source: printer vs print server | `[ ]` | `[~]` | `[ ]` |
325+
| `^NN` | set SNMP | `[ ]` | `[~]` | `[~]` |
326+
| `^NP` | boot settings source: printer vs print server | `[ ]` | `[~]` | `[~]` |
327327
| `~NR` | set all transparent, legacy RS-485 only | `[ ]` | `[ ]` | `[ ]` |
328-
| `^NT` | set SMTP | `[ ]` | `[~]` | `[ ]` |
328+
| `^NT` | set SMTP | `[ ]` | `[~]` | `[~]` |
329329
| `~NT` | set connected printer transparent, legacy RS-485 only | `[ ]` | `[ ]` | `[ ]` |
330-
| `^NW` | web auth timeout | `[ ]` | `[~]` | `[ ]` |
331-
| `^KC` | set client identifier | `[ ]` | `[~]` | `[ ]` |
332-
| `^ND` | change network settings | `[ ]` | `[~]` | `[ ]` |
333-
| `^NS` | change wired network settings | `[ ]` | `[~]` | `[ ]` |
334-
| `^WA` | set antenna parameters | `[ ]` | `[~]` | `[ ]` |
330+
| `^NW` | web auth timeout | `[ ]` | `[~]` | `[~]` |
331+
| `^KC` | set client identifier | `[ ]` | `[~]` | `[~]` |
332+
| `^ND` | change network settings | `[ ]` | `[~]` | `[~]` |
333+
| `^NS` | change wired network settings | `[ ]` | `[~]` | `[~]` |
334+
| `^WA` | set antenna parameters | `[ ]` | `[~]` | `[~]` |
335335
| `^WE` | set WEP mode, obsolete, use ^WX | `[ ]` | `[ ]` | `[ ]` |
336336
| `^WL` | set LEAP, obsolete, use ^WX | `[ ]` | `[ ]` | `[ ]` |
337-
| `^WP` | set wireless password | `[ ]` | `[~]` | `[ ]` |
338-
| `^WR` | set transmit rate | `[ ]` | `[~]` | `[ ]` |
339-
| `^WS` | set wireless radio card values | `[ ]` | `[~]` | `[ ]` |
340-
| `^WX` | configure wireless security | `[ ]` | `[~]` | `[ ]` |
341-
| `~WL` | print network configuration label | `[ ]` | `[~]` | `[ ]` |
342-
| `~WR` | reset wireless radio card | `[ ]` | `[~]` | `[ ]` |
337+
| `^WP` | set wireless password | `[ ]` | `[~]` | `[~]` |
338+
| `^WR` | set transmit rate | `[ ]` | `[~]` | `[~]` |
339+
| `^WS` | set wireless radio card values | `[ ]` | `[~]` | `[~]` |
340+
| `^WX` | configure wireless security | `[ ]` | `[~]` | `[~]` |
341+
| `~WL` | print network configuration label | `[ ]` | `[~]` | `[~]` |
342+
| `~WR` | reset wireless radio card | `[ ]` | `[~]` | `[~]` |
343343
<!-- coverage:end -->

‎packages/core/src/catalog/catalog.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ describe("zpl command catalog", () => {
9898
expect(commandId(catalogEntry("~HL")!)).toBe("^HL");
9999
// Prefix twins with diverging support are separate entries.
100100
expect(catalogEntry("^PH")?.support).toEqual({ web: "yes", desktop: "yes", docker: "yes" });
101-
expect(catalogEntry("~PH")?.support).toEqual({ web: "no", desktop: "planned", docker: "no" });
101+
expect(catalogEntry("~PH")?.support).toEqual({ web: "no", desktop: "planned", docker: "planned" });
102102
expect(catalogEntry("^QQ")).toBeUndefined();
103103
});
104104

0 commit comments

Comments
 (0)