Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorocampos/escpos
A ESC/POS Printer Commands Helper
https://github.com/igorocampos/escpos
barcode cfe esc esc-pos escpos hacktoberfest pos printer qrcode receipt sat
Last synced: about 1 month ago
JSON representation
A ESC/POS Printer Commands Helper
- Host: GitHub
- URL: https://github.com/igorocampos/escpos
- Owner: igorocampos
- Created: 2019-08-23T11:56:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T15:54:38.000Z (11 months ago)
- Last Synced: 2024-10-28T13:33:31.913Z (about 2 months ago)
- Topics: barcode, cfe, esc, esc-pos, escpos, hacktoberfest, pos, printer, qrcode, receipt, sat
- Language: C#
- Homepage:
- Size: 927 KB
- Stars: 56
- Watchers: 5
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://github.com/dotnet/sourcelink)
[](https://dev.azure.com/igorocampos/PersonalProjects/_build?definitionId=1&_a=summary)
[](#)
[](http://www.nuget.org/packages/ESCPOS)
[](ESCPOS/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Figorocampos%2FESCPOS?ref=badge_shield)
# ESCPOS
A ESC/POS Printer Commands Helper.
# Installing via NuGet Package
The NuGet Package can be found [here](https://www.nuget.org/packages/ESCPOS/) and you can install it with:
```powershell
PM> Install-Package ESCPOS
```
# Usage
All command methods will return a **byte array** that you should concatenate with the bytes of your data, and then send it all to your printer using the `Print` extension method, which will send a byte array to the informed printer address. It can be something like `COM3`, `LPT1`, `\\127.0.0.1\printer`, `192.168.0.100:9100`, etc. or even a path to a text file like `./print.txt`.
There is also 2 extension methods, `Add` and `ToBytes`, located in the namespace `ESCPOS.Utils`.
The first one can be used in byte arrays, so you can concatenate 2 or more byte arrays just like this:
```cs
byte[] result = array1.Add(array2, array3, ..., arrayN);
```
In addition there's an overload to the mentioned `Add` method that will accept string parameters instead of byte arrays. It appends all strings into one new string and then converts it to a byte array.
And yet another overload to accept the mix of byte arrays and strings parameters, but since it's accepting an object type parameter, this will ignore any parameter that is not `string` or `byte[]` (e.g. `int`).
With `ToBytes` method you can convert a UTF-8 string to a byte array:
```cs
byte[] result = "Some string".ToBytes();
```
Alternatively you can choose whatever Encoding you wish to use for that:
```cs
byte[] result = "汉字".ToBytes(Encoding.GetEncoding("GBK"));
```
*Just make sure your Printer has a corresponding CodePage for that Encoding!
## Printer Class
As an alternative, if you'd like to instantiate a Printer class that will handle all about bytes, encoding, and even have printer specific features like an horizontal line or print text aligned to the left AND to the right in the same line, which is only possible by knowing the number of columns your printer has, you can use the `Printer` class and its methods.
```cs
//Instantiate printer with its details for encoding, column count and address
var printer = new Printer { Encoding = Encoding.UTF8, Columns = 32, Address = "COM4" };
//Add all bytes to the Cache
printer.AddToCache(
printer.HorizontalLine,
LF,
printer.SameLineLeftAndRightAlignedText("Sample Product", "$10.99"),
LF,
printer.HorizontalLine
);
//Send everything that is currently in the cache to the printer
printer.Print();
```
## Examples
All examples will assume the using statements below:
```cs
using static ESCPOS.Commands;
using ESCPOS;
using ESCPOS.Utils;
```
### QRCode
```cs
byte[] qrCodeCommand = QRCode("Some data");
qrCodeCommand.Print("COM2");
```
Or using the Extension Method
```cs
string data = "Some data";
data.ToQRCode().Print("COM2");
```
### Barcode
```cs
byte[] barCodeCommand = Barcode(BarCodeType.EAN13, "9780201379624");
barCodeCommand.Print("192.168.0.100:9100");
```
Or using the Extension Method
```cs
string code = "9780201379624";
code.ToBarcode(BarCodeType.EAN13).Print("192.168.0.100:9100");
```
### Formatted Text
```cs
byte[] cmd = AlignToCenter.Add(CharSizeDoubleHeight, "Fancy Title");
cmd.Print(@"\\127.0.0.1\printer");
```
### Example using Printer class
```cs
var printer = new Printer { Encoding = Encoding.UTF8, Columns = 32, Address = "192.168.0.100:9100" };
printer.AddToCache(
printer.HorizontalDoubleLine,
LF,
printer.SameLineLeftAndRightAlignedText("Product Name", "Price"),
LF,
printer.HorizontalLine,
LF,
printer.SameLineLeftAndRightAlignedText("Sample Product", "$10.99"),
LF,
printer.SameLineLeftAndRightAlignedText("Sample Product with a very long description", "$0.01"),
LF,
AlignToRight,
"----------",
LF,
CharSizeDoubleHeight,
"$11.00",
CharSizeReset,
LF,
"----------",
AlignToLeft,
LF,
printer.HorizontalDoubleLine
);
printer.Print();
```
### Full CFe SAT Receipt without using Printer class
This example will assume that the variable `cfe` is a deserialized object from the [CFe](https://portal.fazenda.sp.gov.br/servicos/sat) XML, and will print the receipt using its fields.
Also this example will print a 32 columns receipt, which is ideal for 56mm paper roll.
```cs
var line = "--------------------------------";
byte[] array = LF;
array = array.Add(CharSizeDoubleHeight, AlignToCenter);
if (cfe.infCFe.emit.xFant != null)
array.Add(cfe.infCFe.emit.xFant);
array.Add(LF, CharSizeReset, cfe.infCFe.emit.xNome,
LF, $"{cfe.infCFe.emit.enderEmit.xLgr},{cfe.infCFe.emit.enderEmit.nro} {cfe.infCFe.emit.enderEmit.xBairro} - {cfe.infCFe.emit.enderEmit.xMun} {cfe.infCFe.emit.enderEmit.CEP}",
LF, $"CNPJ: {cfe.infCFe.emit.CNPJ}",
LF, $"IE: {cfe.infCFe.emit.IE}",
LF, line, CharSizeDoubleHeight, $"Extrato No. {cfe.infCFe.ide.nCFe}",
LF, "CUPOM FISCAL ELETRONICO - SAT", CharSizeReset,
LF, LF);
if (!string.IsNullOrEmpty(cfe.infCFe.dest?.Item))
array.Add(line, "CPF/CNPJ do Consumidor:", cfe.infCFe.dest.Item, LF);
array.Add(line,
"#|COD|DESC|QTD|UN|VL UNIT R$|(VL TRIB R$)*|VL ITEM R$", LF,
line,
AlignLeft);
int i = 1;
foreach (var det in cfe.infCFe.det)
{
string prod = $"{det.prod.cProd} {det.prod.xProd} {det.prod.qCom:0.0##} {det.prod.uCom} X {det.prod.vUnCom:0.00#} {((det.imposto?.vItem12741 ?? 0) == 0 ? "" : $"({det.imposto.vItem12741:f2})*")}";
array.Add($" {i++:D3} ");
while (prod.Length > 20)
{
var wrap = prod.Length >= 20 ? prod.Substring(0, 20) : prod;
array.Add(wrap), LF, " ");
prod = prod.Substring(20);
}
array.Add(prod.PadRight(20), det.prod.vProd.ToString("f2").PadLeft(6), LF);
}
array.Add(LF);
if (cfe.infCFe.total.ICMSTot.vDesc > 0)
array.Add($" Desconto R${cfe.infCFe.total.ICMSTot.vDesc.ToString("f2").PadLeft(19)}", LF);
if (cfe.infCFe.total.ICMSTot.vOutro > 0)
array.Add($" Acrescimo R${cfe.infCFe.total.ICMSTot.vOutro.ToString("f2").PadLeft(18)}", LF);
array.Add(CharSizeDoubleHeight, $" TOTAL R${cfe.infCFe.total.vCFe.ToString("f2").PadLeft(22)}", LF,
CharSizeReset, LF);
foreach (var mp in cfe.infCFe.pgto.MP)
{
string description;
switch (Convert.ToInt32(mp.cMP ?? "1"))
{
case 2:
description = "Cheque";
break;
case 3:
description = "Cartao de Credito";
break;
case 4:
description = "Cartao de Debito";
break;
case 5:
description = "Credito na Loja";
break;
case 10:
description = "Vale Alimentacao";
break;
case 11:
description = "Vale Refeicao";
break;
case 12:
description = "Vale Presente";
break;
case 13:
description = "Vale Combustivel";
break;
case 14:
description = "Duplicata Mercantil";
break;
case 90:
description = "Sem Pagamento";
break;
default:
description = "Dinheiro";
break;
}
array.Add($" {description.PadRight(18)}{mp.vMP.ToString("f2").PadLeft(12)}", LF);
}
String accessKey = cfe.infCFe.Id.Substring(3, 44);
array.Add($" Troco{cfe.infCFe.pgto.vTroco.ToString("f2").PadLeft(25)}", LF);
foreach (var obs in cfe.infCFe.infAdic.obsFisco)
array.Add($" {obs.xCampo}-{obs.xTexto}", LF);
array.Add(line, "OBSERVACOES DO CONTRIBUINTE", LF);
foreach (var item in cfe.infCFe.infAdic.infCpl.Split(';'))
array.Add(item, LF);
array.Add(LF, line, CharSizeDoubleHeight, AlignTOCenter, $"SAT No. {cfe.infCFe.ide.nserieSAT}",
LF, CharSizeReset, DateTime.ParseExact($"{cfe.infCFe.ide.dEmi} {cfe.infCFe.ide.hEmi}", "yyyyMMdd HHmmss", System.Globalization.CultureInfo.InvariantCulture).ToString("dd/MM/yyyy HH:mm:ss"),
LF, LF, CharSizeDoubleHeight, accessKey,
LF, LF, accessKey.Substring(0, 22).ToBarcode(BarCodeType.CODE128, 30), accessKey.Substring(22).ToBarcode(BarCodeType.CODE128, 30),
LF, LF,
$"{accessKey}|{cfe.infCFe.ide.dEmi}{cfe.infCFe.ide.hEmi}|{cfe.infCFe.total.vCFe}|{cfe.infCFe.dest?.Item ?? ""}|{cfe.infCFe.ide.assinaturaQRCODE}".ToQRCode(),
CharSizeReset,
LF, line, LF, LF, LF);
array.Print(@"\\127.0.0.1\printer");
```
# Considerations
When printing CODE128 barcodes, it will use automatically subset B, which supports numbers, upper and lower case letters and some additional characters.
You can see the changelog [here](CHANGELOG.md).
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Figorocampos%2FESCPOS?ref=badge_large)