WIP: update printing architecture #139

tr3v3r · 2024-03-11T22:53:06Z

How to test:

General instructions are here.

To install npm package:

npm i [email protected]

or

yarn add [email protected]

Summary (To be updated)

Reworked the way of printing. Fixes almost all known issues.

Get rid of the init and instantiate methods and introduce a new class Printer
Printer is as singleton instance of the printer and can be used for single and multiple printing.
Printer class provides:
- print queue on JS side
- print SDK methods that are now just a proxy from native SDK
- error handling which includes description and native error code
- proper typing

Example:

const printer = new Printer({
          target: printer.target,
          deviceName: printer.deviceName,
});

const status = await printer.queue.add(async () => {
      await printer.connect();
      
      await printer.addText('Hello world!);
      await printer.addFeedLine();
      await printer.addCut();
      await printer.sendData();

      await printer.disconnect();
})

Detailed example.

Changelog

In progress...

Migration guide

In progress...

To do

Remove legacy code
Update documentations
Test multiple printing (Thanks to @Waleed065. Test cases)
Refactoring
Validation for method properties on JS side

* Added New Method 'clearCommandBuffer' To forcefully clear buffer

tolypash · 2024-03-21T08:57:01Z

Still working on implementing this to local project. Looks like it works well for now. Will keep you updated when I'm done with the refactor that is needed.

tr3v3r · 2024-03-21T10:01:41Z

Still working on implementing this to local project. Looks like it works well for now. Will keep you updated when I'm done with the refactor that is needed.

Thanks. If any question appears don't hesitate to reach me.

BTW. @Waleed065 have already tested a lot of scenarios with single and multiple printing - so far so good.
I'm waiting for final approval from him.

Waleed065 · 2024-03-21T10:15:49Z

Have integrated this version in our PROD app and all use cases work for us.
We can consider it a stable version.
We're using LAN connections.

Use cases tested

Multi Printing ✅
Queue Printing ✅
Printing On Wifi Reconnection ✅
Printing On Printer Reconnection ✅
Warning and errors (eg: Paper Out, Open Lid) ✅

… static methods

…nts to helpers

tolypash · 2024-03-22T07:29:11Z

@tr3v3r Would like to clarify something. Is the intended use that I connect to all discovered printers in the beginning and stay connected, or connect to each printer to print and then disconnect each time?

tr3v3r · 2024-03-22T07:36:32Z

@tr3v3r Would like to clarify something. Is the intended use that I connect to all discovered printers in the beginning and stay connected, or connect to each printer to print and then disconnect each time?

@tolypash Both scenarios are valid.
But, to be honest. I don't think it's a good approach to leave the printer to be connected all the time.

you can connect and disconnect - it's cheap action.

Or if you need to do copies you can repeat commands after connection:

async function print() { // your print receipt commands
      await printer.addText('Hello world!);
      await printer.addFeedLine();
      await printer.addCut();
      await printer.sendData();
}

await printer.connect(); // connect

   await print()
   awaith printer.clearCommandBuffer();
   
   await print() // copy 1
   awaith printer.clearCommandBuffer();
   
 await printer.disconnect();  // disconnect after all copies are printed

I hope this makes sense/

tolypash · 2024-03-22T07:50:09Z

Yes of course, thank you. It's just that we have many devices connecting to many printers. I will implement it by connecting and disconnecting then. Thank you!

tr3v3r · 2024-03-22T08:39:59Z

Yes of course, thank you. It's just that we have many devices connecting to many printers. I will implement it by connecting and disconnecting then. Thank you!

Correct. The previous implementation did the connection and disconnection under the hood by the lib, but it also added constraints because of that. So in this implementation, you can control yourself when connect and disconnect

tr3v3r · 2024-03-28T13:57:36Z

@Waleed065 I've released beta.2 with some small breaking changes and refactoring. Could you please try it out when you have time?
P.S. After this update, no other breaking changes are planned.

Waleed065 · 2024-03-28T21:14:51Z

@Waleed065 I've released beta.2 with some small breaking changes and refactoring. Could you please try it out when you have time? P.S. After this update, no other breaking changes are planned.

Sure, I'll test it and let you know

Waleed065 · 2024-03-31T12:26:46Z

@tr3v3r There are few issues with this update ( beta.2 ). Specifically releated to imports

tr3v3r · 2024-03-31T19:24:50Z

@tr3v3r There are few issues with this update ( beta.2 ). Specifically releated to imports

I see. Can I ask you why you need this enums, can't you use PrinterConstants instead? Or it's for error handling?

Waleed065 · 2024-03-31T23:54:31Z

@tr3v3r There are few issues with this update ( beta.2 ). Specifically releated to imports

I see. Can I ask you why you need this enums, can't you use PrinterConstants instead? Or it's for error handling?

Yes I need them for error handling. Some PrinterConstants errorCodes have same error code that is why. But these should be available to import anyway

mroswald · 2024-04-05T09:13:52Z

Is there a need to bundle the queue into this library? We have our own queue around print jobs and p-queue causing strange build issues on our end. For simplicity, a more modular approach would be nice (import and use if necessary)

tr3v3r · 2024-04-26T09:30:37Z

Just released beta.5.

Fixed thread blocking on Android
Increased timeouts for Android
Try to fix the issue when it's not possible to print after print error

Details: https://github.com/tr3v3r/react-native-esc-pos-printer/releases/tag/v4.0.0-beta.5
Thanks everyone for the help!
CC: @tolypash @Waleed065 @mroswald

Waleed065 · 2024-04-29T00:31:54Z

Just released beta.5.

Fixed thread blocking on Android

Increased timeouts for Android

Try to fix the issue when it's not possible to print after print error

Details: https://github.com/tr3v3r/react-native-esc-pos-printer/releases/tag/v4.0.0-beta.5 Thanks everyone for the help! CC: @tolypash @Waleed065 @mroswald

This version Works Great, lets release it as a stable version.

Great work @tr3v3r

…o disconnect in case connection has lost

tr3v3r · 2024-05-08T09:29:22Z

Hello everyone.

I finally started to work on documentation. And added docs on Printer class constructor and connect method.
After all the methods covered, I'm about to release the 4.0.0 stable version.
If someone wants to speed up the release, I'd appreciate any help.

In general, what is needed:

Take any undocumented method and cover it. As a reference connect docs can be used.

Rules:

Each method must be documented by using original docs for Android and iOS

CC: @tolypash @Waleed065 @mroswald @vsnaichuk

omarst9 · 2024-05-11T13:39:29Z

I noticed that when using an older USB printer (TM-T88IV) the print times out, while it prints normally on my newer USB printer TM-T88V. Even printing “Hello World” takes around 5 seconds on the older model. Has anyone experienced that?

tr3v3r · 2024-05-11T17:56:16Z

I noticed that when using an older USB printer (TM-T88IV) the print times out, while it prints normally on my newer USB printer TM-T88V. Even printing “Hello World” takes around 5 seconds on the older model. Has anyone experienced that?

Please create separate issues for that case, probably you'll get an answer from contributors. Also, what I can suggest is that you can try to test printing using Epson official applications. If there is still an issue with a specific model - that means it's not lib issues thanks.

softwaredev927 · 2024-07-18T07:13:43Z

Hi,
Can use 4.0.0 beta.6 version to print in multi printer with multi device?
Now I'm try to print in multi printer with multi device, but is not working on 3.1.1 version.

tr3v3r · 2024-07-18T08:00:24Z

Hi, Can use 4.0.0 beta.6 version to print in multi printer with multi device? Now I'm try to print in multi printer with multi device, but is not working on 3.1.1 version.

Hello, @softwaredev927

Yes, you can.
#139 (comment)

softwaredev927 · 2024-07-18T08:46:10Z

Hi, Can use 4.0.0 beta.6 version to print in multi printer with multi device? Now I'm try to print in multi printer with multi device, but is not working on 3.1.1 version.

Hello, @softwaredev927

Yes, you can. #139 (comment)

Thank you. for your help.
And then now this error happened while debugging.

 BUNDLE  ./index.js

error: Error: Unable to resolve module ./constants from D:\ReactNative\olouris\node_modules\react-native-esc-pos-printer\src\index.tsx:

None of these files exist:
  * node_modules\react-native-esc-pos-printer\src\constants(.native|.android.js|.native.js|.js|.android.json|.native.json|.json|.android.ts|.native.ts|.ts|.android.tsx|.native.tsx|.tsx)
  * node_modules\react-native-esc-pos-printer\src\constants\index(.native|.android.js|.native.js|.js|.android.json|.native.json|.json|.android.ts|.native.ts|.ts|.android.tsx|.native.tsx|.tsx)
> 1 | export * from './discovery';
  2 | export * from './printer';
  3 |

How can solve it?

tr3v3r · 2024-07-25T09:25:05Z

I am happy to announce that version 4.0.0 has finally been released!
Thanks to everyone for your support!

feat(changed): updated printing architecture

a183577

tr3v3r changed the title ~~feat(changed): updated printing architecture~~ WIP: update printing architecture Mar 11, 2024

tr3v3r added 2 commits March 13, 2024 00:03

feat(add): add print helpers and pairing printer method

4f32215

tryToConnectUtil

a9fef44

tr3v3r mentioned this pull request Mar 13, 2024

Instantiate printer does not work on multiple devices #125

Closed

tr3v3r added 2 commits March 14, 2024 09:36

fix lint

cc0f2fd

chore: release 4.0.0-beta.0

64e7f04

tr3v3r mentioned this pull request Mar 15, 2024

simultaneously printing: Error: ERR_ILLEGAL #104

Closed

tr3v3r and others added 4 commits March 15, 2024 14:48

feat(changed): add addTextLang method, get rid of legacy code

05b993f

add clearCommandBuffer method

065f6a2

* Added New Method 'clearCommandBuffer' To forcefully clear buffer

fix lint

1149aca

chore: release 4.0.0-beta.1

ef430d6

tr3v3r mentioned this pull request Mar 20, 2024

Can't print other languages properly #135

Open

tr3v3r added 2 commits March 21, 2024 15:05

move pairBluetoothDevice to Discovery module, move printer helpers to…

f0bb84f

… static methods

refactor: remover redundant code, regroup folders, move native consta…

f81ae8f

…nts to helpers

chore: release 4.0.0-beta.2

021cb51

tr3v3r mentioned this pull request Apr 2, 2024

Use of undeclared identifiers #143

Closed

tolypash approved these changes Apr 26, 2024

View reviewed changes

tr3v3r added 2 commits May 7, 2024 15:28

feat(added): docs for Printer constructor and connect method, allow t…

9da6f38

…o disconnect in case connection has lost

chore: release 4.0.0-beta.6

862821b

tr3v3r mentioned this pull request May 8, 2024

hey all, I came across this repo while trying a few things on my Epson printers but i'm having trouble connecting to either of my printers (1 Lan and 1 USB) using this latest version 4.0.0-beta.6 #146

Closed

Repository owner deleted a comment from omarst9 May 8, 2024

tr3v3r mentioned this pull request May 9, 2024

XCode Error: type specifier missing, defaults to 'int' #147

Closed

tr3v3r mentioned this pull request May 11, 2024

Update ThePrinterWrapper.m #149

Merged

tr3v3r added 2 commits May 11, 2024 20:17

docs(added): add docs for addText, disconnect, addFeedLine methods

a59014d

docs(added): add docs for sendData method

1ede5fe

omarst9 mentioned this pull request May 17, 2024

Bluetooth printer not discoverable #151

Closed

tr3v3r added 5 commits May 21, 2024 10:28

doc(added): cover addCut, getPrinterSetting methods

c01ddc6

docs(added): cover getStatus method

952fc69

docs(added): cover addImage method

5445f8c

docs(added): cover addBarcode

3b78e2b

docs(added): cover addSymbol

550ee68

docs(added) cover addCommand, addPulse, addTextAlign

18a445b

tr3v3r added 4 commits July 19, 2024 10:22

docs(added): cover addTextSize, addTextStyle, addTextLang, addTextSmooth

5575f1d

docs(added): cover addTextLine static method

db0f6aa

docs(added): finish docs

d42ec77

resolve conflicts

1e37295

tr3v3r merged commit 9f51666 into main Jul 25, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: update printing architecture #139

WIP: update printing architecture #139

tr3v3r commented Mar 11, 2024 •

edited

Loading

tolypash commented Mar 21, 2024

tr3v3r commented Mar 21, 2024

Waleed065 commented Mar 21, 2024

tolypash commented Mar 22, 2024

tr3v3r commented Mar 22, 2024 •

edited

Loading

tolypash commented Mar 22, 2024

tr3v3r commented Mar 22, 2024

tr3v3r commented Mar 28, 2024

Waleed065 commented Mar 28, 2024

Waleed065 commented Mar 31, 2024 •

edited

Loading

tr3v3r commented Mar 31, 2024

Waleed065 commented Mar 31, 2024

mroswald commented Apr 5, 2024

tr3v3r commented Apr 26, 2024 •

edited

Loading

Waleed065 commented Apr 29, 2024 •

edited

Loading

tr3v3r commented May 8, 2024

omarst9 commented May 11, 2024 •

edited

Loading

tr3v3r commented May 11, 2024

softwaredev927 commented Jul 18, 2024 •

edited

Loading

tr3v3r commented Jul 18, 2024

softwaredev927 commented Jul 18, 2024 •

edited

Loading

tr3v3r commented Jul 25, 2024

WIP: update printing architecture #139

WIP: update printing architecture #139

Conversation

tr3v3r commented Mar 11, 2024 • edited Loading

How to test:

Summary (To be updated)

Changelog

Migration guide

To do

tolypash commented Mar 21, 2024

tr3v3r commented Mar 21, 2024

Waleed065 commented Mar 21, 2024

tolypash commented Mar 22, 2024

tr3v3r commented Mar 22, 2024 • edited Loading

tolypash commented Mar 22, 2024

tr3v3r commented Mar 22, 2024

tr3v3r commented Mar 28, 2024

Waleed065 commented Mar 28, 2024

Waleed065 commented Mar 31, 2024 • edited Loading

tr3v3r commented Mar 31, 2024

Waleed065 commented Mar 31, 2024

mroswald commented Apr 5, 2024

tr3v3r commented Apr 26, 2024 • edited Loading

Waleed065 commented Apr 29, 2024 • edited Loading

tr3v3r commented May 8, 2024

In general, what is needed:

Rules:

omarst9 commented May 11, 2024 • edited Loading

tr3v3r commented May 11, 2024

softwaredev927 commented Jul 18, 2024 • edited Loading

tr3v3r commented Jul 18, 2024

softwaredev927 commented Jul 18, 2024 • edited Loading

tr3v3r commented Jul 25, 2024

tr3v3r commented Mar 11, 2024 •

edited

Loading

tr3v3r commented Mar 22, 2024 •

edited

Loading

Waleed065 commented Mar 31, 2024 •

edited

Loading

tr3v3r commented Apr 26, 2024 •

edited

Loading

Waleed065 commented Apr 29, 2024 •

edited

Loading

omarst9 commented May 11, 2024 •

edited

Loading

softwaredev927 commented Jul 18, 2024 •

edited

Loading

softwaredev927 commented Jul 18, 2024 •

edited

Loading