epickiwi/brother_ql
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: Moving the *Analyze* section into DEBUG.md

Browse Source
This commit is contained in:
Philipp Klaus
2016-11-20 13:37:09 +01:00
parent e0e53bc502
commit 6e06149579
2 changed files with 24 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
DEBUG.md
View File

@@ -1,4 +1,24 @@
### DEBUG
This document shows some ways to help debugging the package brother\_ql.
One way is to look into the binary raster instruction file, see the *Analyse* section.
The other way is to send those instructions to the printer one by one and check how it reacts, see the *Debug* section.
#### Analyse
To analyse a binary file containing Brother QL Raster instructions:
brother_ql_analyse 720x300_monochrome.bin --loglevel DEBUG
The tool will dissect your file and print the opcodes to stdout.
In addition, it creates PNG images of what the printer's output would look like.
They are saved to page0001.png etc. (yes, one .bin file can contain more than one "page").
This tool also has the `--help` option.
(This specific tool doesn't work on Python 2.)
#### Debug
If your printer has problems printing the instructions file, it may blink its LED (green or red) depending on the model. This can have many reasons, eg.:

22
README.md
View File

@@ -6,8 +6,6 @@ In more details, the following is possible with this package:
* Create raster language files for the Brother label printers.
These binary files contain the instructions for the printer and can be created from image files or programmatically in your own Python script.
* Analyze files containing raster instructions.
A tool to dissect the binary files (interprets all the instructions, writes out information about all of them, and creates PNG images of the printouts to be expected).
* Print raster instruction files with your Brother label printer via different backends:
* pyusb (works cross-platform)
* network (works cross-platform for WiFi/Ethernet-enabled printers)
@@ -86,20 +84,6 @@ Some notes:
Currently, the `brother_ql_create` tool doesn't support the 600x300 dpi mode supported by some printers.
The output will always use the 300dpix300dpi mode with the *high quality preference* set.
#### Analyse
To analyse a binary file containing Brother QL Raster instructions:
brother_ql_analyse 720x300_monochrome.bin --loglevel DEBUG
The tool will dissect your file and print the opcodes to stdout.
In addition, it creates images of what the printer's output would look like.
They are saved to page0001.png etc. (yes, one .bin file can contain more than one "page").
This tool also has the `--help` option.
(This specific tool doesn't work on Python 2.)
#### Print
Once you have a Brother QL instruction file, you can send it to the printer like this:
@@ -124,6 +108,8 @@ If your printer has problems printing the instructions file, it may blink its LE
* The selected label doesn't match.
* End of paper.
* Unsupported opcode (wrong --model when using `brother_ql_create`?)
* Unsupported opcode (wrong `--model` when using `brother_ql_create`?)
More info on how to debug difficult situations to be found in the [DEBUG doc](DEBUG.md).
### Debugging
More info on how to debug difficult situations is to be found in the [DEBUG doc](DEBUG.md).