add notes on usage

This commit is contained in:
Patrick Kanzler 2023-07-29 01:36:28 +02:00
parent ed5a259ad0
commit 1717b9a641
4 changed files with 21 additions and 3 deletions

View File

@ -20,6 +20,7 @@
{{ escape_rst(printer.notes) }} {{ escape_rst(printer.notes) }}
You can select this profile in python-escpos with this identifier: ``{{ item }}``. You can select this profile in python-escpos with this identifier: ``{{ item }}``.
(Set parameter to `profile='{{ item }}'`.)
Basic information Basic information
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^

View File

@ -1,3 +1,5 @@
.. _available-profiles:
Available Profiles Available Profiles
------------------ ------------------
:Last Reviewed: 2023-07-27 :Last Reviewed: 2023-07-27

View File

@ -6,6 +6,19 @@ Since the used command set often differs between printers,
a model for supporting different printers is implemented. a model for supporting different printers is implemented.
This feature is called `capabilities`. This feature is called `capabilities`.
.. todo:: explain capabilities The `capabilities`-feature allows this library to know
.. todo:: explain usage which features are supported.
.. todo:: give hints on how to sideload and improve profiles (profile that is bundled with release can be replaced) If no further information is specified, python-escpos will
try to automatically use features based on the supplied information.
In order to use the `capabilities`-database, the printer instance
simply has to be created with the parameter `profile` set to the
relevant identifier.
The identifier can be found in :ref:`available-profiles`.
This documentation describes the profiles in the database file that
is bundled with this release.
If another configuration is to be used, this chapter can be followed
for information on how to sideload another `capabilities`-database:
:ref:`advanced-usage-change-capabilities-profile`.

View File

@ -238,6 +238,8 @@ Here you can download an example, that will print a set of common barcodes:
* :download:`barcode.bin </download/barcode.bin>` by `@mike42 <https://github.com/mike42>`_ * :download:`barcode.bin </download/barcode.bin>` by `@mike42 <https://github.com/mike42>`_
.. _advanced-usage-change-capabilities-profile:
Advanced Usage: change capabilities-profile Advanced Usage: change capabilities-profile
------------------------------------------- -------------------------------------------