search

receipt-print-hq / escpos-printer-db

Database of ESC/POS thermal receipt printers
https://mike42.me/escpos-printer-db/
Creative Commons Attribution 4.0 International
108 stars 49 forks source link

Better documentation for features #57

Open andrewshadura opened 5 years ago

andrewshadura commented 5 years ago

Hi,

I’m trying to add profiles for printers I’ve tested, but it’s a bit difficult to figure out what features mean, since some of them seem to be mandatory despite not being used e.g. by python-escpos. E.g. highDensity or starCommands (the latter is probably proprietary commands Star printer support?).

Could you please document them?

Thanks!

mike42 commented 5 years ago

I've labeled this as an enhancement because I agree that it would be useful, though I'm not planning on adding it myself any time soon (pull requests welcome).

We would ideally make this machine-readable, and bundle it with the database itself (eg. as features.yml), since some projects such as this could display the values, and our own build process could use the list in place of the current hard-coded values.

To address your current sticking point though, yes many fields are mandatory. You don't need to include them in your own profile though, I would recommend extending a base profile (or a profile for a similar printer), so that you only need to specify the differences.

For example, the AF-240 profile uses inherits: simple, and does not specify starCommands.

andrewshadura commented 5 years ago

Well, if you could at least explain (e.g. here) what those features refer to, I could write the missing documentation.