Making money with Project Fugu

A presentation at HalfStack on the Shore(ditch) in November 2023 in London, UK by Niels Leenheer

Slide 1

Slide 1

Making money with Project Fugu building a cash register with web technologies

Slide 2

Slide 2

Hi, I am Niels Leenheer. First of all, it is great to be back here in London. Who was here last year? Lots of familiar faces, new great location. But in general, lots of changes since last year.

Slide 3

Slide 3

Anyway. I am the co-founder and CTO of Salonhub.

Slide 4

Slide 4

And we make software for hair salons. You know the whole point of sale system and appointment booking system. Everything is based on web technology. Deployed on desktop using Electron, or on tablets using Capacitor, or just a plain Progressive Web App. Just look how happy these people are using our PWA. PWA’s are awesome.

Slide 5

Slide 5

So yeah… I don’t often talk about my job. What I usually talk about is WebBluetooth and programming Lego cars with JavaScript. You know, fun stuff. And nobody wants to hear a 30 minute talk about the exiting world of hair styling. But today is an exception. No fun stu today. Just me venting about my day job.

Slide 6

Slide 6

Earlier this year I got this email from Thomas at Google. He’s part of the Chrome team and focuses on Project Fugu, a multi-vendor e ort to make the web more capable. To add new API’s that allow the web to compete with native applications.

Slide 7

Slide 7

Our PWA uses quite a few API’s that are part of Project Fugu, including the API’s responsive for integrating with hardware devices, like receipt printers, customer displays and cash drawers. A couple of years ago that was simply not possible. But it is getting closer and closer. Thanks to Project Fugu and

Slide 8

Slide 8

The various hardware API’s like WebUSB, WebSerial, WebHID and more.

Slide 9

Slide 9

Could we do it in time for Google I/O Connect in Miami. In four weeks…

Slide 10

Slide 10

So… two weeks later…

Slide 11

Slide 11

We had a fully functioning demo that was completely browser based. Of course it wasn’t two weeks work. It was years in the making. In fact I started working on the receipt printer code for my HalfStack talk about WebBluetooth back in 2017.

Slide 12

Slide 12

We could scan barcodes to add products. Items are shown on the customer pole. The receipt is visible on the display. And when we pay we can print a paper receipt.

Slide 13

Slide 13

So we went to Miami.

Slide 14

Slide 14

Slide 15

Slide 15

After that we went to Amsterdam.

Slide 16

Slide 16

Thomas took our demo to Bengalore and in September it was shown in I/O Connect Shanghai. All and all an amazing experience.

Slide 17

Slide 17

So, who wants to see it? And afterwards I’ll tell you how we created it.

Slide 18

Slide 18

So, yeah. That was a little bit underwhelming maybe. It is just a cash register. You scan a product, you pay and you’ll get a receipt. You can see that every day, in pretty much every shop or store. But it is more complicated than you might think. So how did we build it? Like I said it was years in the making. I’ve been playing with this in some way or form for the last 10 years.

Slide 19

Slide 19

Receipt printer Let’s start with receipt printers. This is an essential part of a cash register. Nowadays most are USB, but they still sell serial or even parallel port versions.

Slide 20

Slide 20

But the one we’re using is a USB device. So we’re going to use WebUSB. The API allows us to request a device with specific filters. The user then gets a list of all devices that they can choose from. And the browser then gets access to the device that is chosen.

Slide 21

Slide 21

Then we have to open the device. Claim the interface and transfer out our data to the endpoint.

Slide 22

Slide 22

Yeah, this may require some extra explanation.

Slide 23

Slide 23

USB devices have one or more interfaces. This usually depends on functionality.

Slide 24

Slide 24

Most have one interface, but if you have a device that combines multiple functions, like a scanner and printer combination, you would usually have one interface for the printer and one for the scanner.

Slide 25

Slide 25

And each interface has one or more endpoints. Endpoints can be use to send data, or receive data. So in case of a printer you have two endpoints, one for sending what you want to print and one for receiving for example status information about how much paper you have.

Slide 26

Slide 26

So we claim the right interface. And we claim it, so we can use the device exclusively and there are no other applications that can interfere while we use it. And then we send the data using the proper endpoint.

Slide 27

Slide 27

And now we can talk to our printer, but we still have no idea about what to tell it. We need to learn their language first.

Slide 28

Slide 28

Let’s start really simple. Say we want to print this. Just two lines. One line in bold text. And then cut the receipt. If we were to do this with the web platform, this would be really, really simple.

Slide 29

Slide 29

Just npm install react. And tailwind. Obviously. Then have a good think about what build system you want to use. Add some div’s to the root and apply a whole bunch of css classes. Simple….

Slide 30

Slide 30

Okay, okay. Let’s use some proper HTML. And I am keeping it simple here. Just a couple of <br> and <b> tags. And that is it. But that is not how printers do it. The language printers use long predate HTML.

Slide 31

Slide 31

Let’s travel back to 1990. Epson is launching their first receipt printer. Nowadays all receipt printers use thermal paper, but back then it used dot matrix technology. And Epson was famous for creating the MX-80 dot matrix printer back in 1980.

So they took a shortcut and basically used the ESC/P language from that dot matrix printer and adapted it a bit and called it ESC/POS. And that is what receipt printers have been using ever since.

Slide 32

Slide 32

And the language is basically 7 bit ASCII. And with ASCII we have all the printable characters you would ever need. 26 of them. A to Z. And you get numbers. Some special characters. But that is not all, you also have lowercase version of A to Z… Whoooowww. What more do you need… It is the American Standards Code for Information Interchange after all.

Slide 33

Slide 33

And we have some control characters for data transmission, including LF or Line Feed. Or what we nowadays commonly call a newline.

Slide 34

Slide 34

So we can just send this to the printer and it will work. But this is not entirely what we wanted. It’s not bold…

Slide 35

Slide 35

So let’s fix the bold part. We’re not using tags, like HTML, but we send a special escape character that signals to the printer that what follows is a command.

Slide 36

Slide 36

ESC E-for-emphasis. And 1 to turn emphasis on. That makes the text bold. And ESC E 0 is to turn it off.

Slide 37

Slide 37

And there are many commands for all kinds of formatting and commands for inserting things like barcodes and images. Too many to list here and too many to go into details. There is a manual.

Slide 38

Slide 38

We need to send a command for cutting the paper. GS V 0. But we’re not done yet.

Slide 39

Slide 39

First we need to initialise our printer. We forgot to do that. And by initialising we make sure the printer is back to the default state and we don’t have the styles of the previous user of the printer interfering with what we want to do.

Slide 40

Slide 40

But what about these letters? We don’t have Unicode. Just ASCII… Which is fine for the US, but really not for the rest of the world. Even a simple character like the Euro is not part of ASCII… Eh. I mean the pound. Even the pound is not part of ASCII.

Slide 41

Slide 41

And even in the US they have IKEA…

Slide 42

Slide 42

So let’s go on a tangent and talk about internationalisation. In fact, this could a whole talk in itself. Internationalisation is so complex that we’re not even going to scratch the surface. But that is okay. Because this is not proper internationalisation, it is… Internationalisation before Unicode.

Slide 43

Slide 43

In other words… How can we sell computers to the rest of the world with the least amount of effort.

Slide 44

Slide 44

So welcome to…. Internationalisation before Unicode.

Slide 45

Slide 45

So ASCII is just 7 bits. That means just 128 different characters and we still have another 128 left over.

Slide 46

Slide 46

And for that we have codepages. We can swap out a different set of 128 characters that are in the upper range of an 8 bit byte.

Slide 47

Slide 47

It can be Western European, which contains the characters we want. Which is by the way exactly the reason why you should never test your software with that particular string.

Slide 48

Slide 48

Or Hebrew…

Slide 49

Slide 49

Or Greek…

Slide 50

Slide 50

Ukrainian, which has its own codepage, which is different from Russian, because Ukrainian uses number of different characters.

Slide 51

Slide 51

Or even Thai…

Slide 52

Slide 52

We have so many codepage. So….

Slide 53

Slide 53

Many codepages.

Slide 54

Slide 54

But we want codepage 858, which contains all the letters that have here.

Slide 55

Slide 55

So we start with a unicode string and then we lookup the byte value for each character in the codepage table. Luckily there is a library to do that. But unfortunately the codepages used by printers can be pretty obscure, so it only supports a fraction.

Slide 56

Slide 56

So I created a library called CodepageEncoder, specifically for receipt printers. And it even allows us to things like automatically choosing the right codepage and for the characters you want to print and switching on the fly when needed.

Slide 57

Slide 57

Of course, not every printer supports every codepage.

Slide 58

Slide 58

Some support even less.

Slide 59

Slide 59

Some support more, but use a different identifier than what Epson does. And Epson created ESC/POS, so why…. Why!? It is really annoying.

Slide 60

Slide 60

But it is not just cheap Chinese printers that do that…

Slide 61

Slide 61

But wait… what about cash drawers. As you can see with this model there is an integrated cash drawer. How do we open the cash drawer?

Slide 62

Slide 62

Well, all receipt printers have a DK port. You connect your cash drawer to that port and then you can tell the printer to send a pulse to that port and that activates the solenoid in the cash drawer and it opens. And with the combined printer cash drawer it works in the same way. So the cash drawer is not really a di erent device, it is a function of the receipt printer.

Slide 63

Slide 63

When I started this journey I really wished there was somebody who would that created a javascript library to make my life easier. And there were libraries, but mostly server side, badly written, php or python. Or JavaScript, but for Node. Not for the browser. So I created one.

Slide 64

Slide 64

And to get the receipt that we want we just need to do this. This is much easier and you can forget everything I just mentioned.

Slide 65

Slide 65

But wait… it can’t be that simple.

Slide 66

Slide 66

No of course not. I mentioned all printers support ESC/POS, but yeah… I lied.

Slide 67

Slide 67

Introducing StarPRINT. Exactly the same as ESC/POS, except that everything is different. Great!

Slide 68

Slide 68

Instead ESC @ we now need to initialise…

Slide 69

Slide 69

with ESC @ CAN… because…. We can?

Slide 70

Slide 70

ESC t turns into ESC GS t….

Slide 71

Slide 71

And instead of ESC Emphasis On and O . You now just have ESC Emphasis and ESC F for ehh…. F this.

Slide 72

Slide 72

So if you have a Star printer, EscPosEncoder is completely useless. You need something specifically for StarPRNT.

Slide 73

Slide 73

So I created a library called StarPrntEncoder….

Slide 74

Slide 74

But don’t use it… I’ll get back to that.

Slide 75

Slide 75

There were several points during this almost 5 year long journey that I just wanted to give up. There are no standards. And I haven’t even talked about different methods of image encoding. Barcode support that di ers between even models from the same manufacturer. Printers that use 203 dpi, or 180 dpi. How many characters can t on one line? Yes that can be 44, or 42. Or 35. Or 32. It depends. It’s a big mess.

Slide 76

Slide 76

This is how my office currently looks like. I’ve got more receipt printers than what is considered healthy. It’s starting to mess with me and and every shop or store that I visit I try to look for the model and make of their printer. Wondering if I should get one more.

Slide 77

Slide 77

If somebody says to you: “You don’t need another receipt printer. You already have more than enough receipt printers”. Just ignore them. You don’t need that kind of negativity in your life.

Slide 78

Slide 78

The result this madness is a library called ThermalPrinterEncoder that supports both ESC/POS and StarPRNT. It supports all the different resolutions and codepage mappings.

Slide 79

Slide 79

So if we want to print our original receipt. This is how we do it. And send the payload to the printer. Any receipt printer. StarPRNT or ESC/POS.

Slide 80

Slide 80

So if we want to print our original receipt. This is how we do it. And send the payload to the printer. Any receipt printer. StarPRNT or ESC/POS.

Slide 81

Slide 81

As a companion to ThermalPrinterEncoder, also I created a library that wraps WebUSB and allows you to simply connect to any supported printer and print. No need to worry about endpoints, interfaces.

Slide 82

Slide 82

And it is actually a set of libraries, with both WebSerial and WebBluetooth versions, that use the same API.

Slide 83

Slide 83

And that allows me to support all three protocols in our demo. The difference is just which library is instantiated. So now we’re done with printers. We’re done with ESC/ POS and codepages. We can finally discuss some of the other devices.

Slide 84

Slide 84

Like this customer display. It is basically two lines of 20 vacuum fluorescent characters that we use to show the current item added to the receipt and the price, so that the customer can check if the cashier added the right item for the right price.

Slide 85

Slide 85

So the important question. Do we need to learn another obscure language from the 80s? What language do customer displays speak?

Slide 86

Slide 86

Ehh… yeah. They speak printer. The next question would obviously be…. Why?

Slide 87

Slide 87

And the reason is again found in the 1980s… Because computers back then usually only had one serial port. So if you had two devices, you needed share that port. And to make that sharing work, both need to work together and speak the same language.

Slide 88

Slide 88

So when you initialise your printer slash display, both are active. Everything you print is also shown on the display. But you can send ESC = to turn off the printer, or turn off the display. When you turn it off, it will ignore everything it receives, until the next initialisation where you can make another choice.

Slide 89

Slide 89

So WebSerial. We request a port.

Slide 90

Slide 90

We open the port… specify the right speed. 10 Gigabit per second? 20? No… 9600… bits… per second.

Slide 91

Slide 91

We get our writable stream for sending data to the device… and we write our payload to the stream, effectively sending it to the display.

Slide 92

Slide 92

And that is it. Well… we still have to deal with codepages, still need to deal with ESC/POS….

Slide 93

Slide 93

But wait… This isn’t right. Our display is connected using USB. Why is it using WebSerial? And not WebUSB? Because of the 1980s…

Slide 94

Slide 94

And to see why, we need to look at USB classes.

Slide 95

Slide 95

USB defines a number of default classes. If you have a device that uses these default classes you don’t need to install a driver. It just works. ADC for audio. Human Input Device or HID for keyboards and mice. Mass storage for hard drives. And many more. And we have CDC for communication, which includes ACM - which is a modern replacement for legacy serial port communication.

Slide 96

Slide 96

Some of these classes have lower level API’s. Like WebHID for HID and WebSerial for legacy serial devices, Bluetooth based serial devices, but also the USB ACM class. And we have WebUSB for all other devices that do not fit into these classes. So this is why we need WebSerial, even though it is USB, and not WebUSB.

Slide 97

Slide 97

But ACM is a replacement and not backwards compatible, so USB to serial port dongles don’t use ACM. In fact most USB serial devices don’t use ACM. They just took their old 1980s serial port device and added a custom Serial to USB chip from FTDI or Prolific with a custom driver.

Slide 98

Slide 98

And the driver creates a virtual serial port. And you use WebSerial for any type of serial port. Legacy, ACM or virtual. But… it is the custom class… so in theory you could write a WebUSB implementation… There is no documentation, so you would have to reverse engineer it. Besides, it would be completely useless… You can use WebSerial. It’s a big waste of time. But in theory you could.

Slide 99

Slide 99

Slide 100

Slide 100

Don’t use it.

Slide 101

Slide 101

So in conclusion. Almost nobody uses actual legacy serial ports anymore. But for some USB connected devices you still need to use WebSerial.

Slide 102

Slide 102

So I created a library that uses WebSerial to connect to that display and show some simple text. It will handle the codepages and ESC/POS encoding for you.

Slide 103

Slide 103

And that brings us to barcode scanners. And that is really easy. We do not need to do anything to support barcode scanners, because

Slide 104

Slide 104

Barcode scanners are just keyboards.

Slide 105

Slide 105

When you scan a barcode they just literally type out the numbers of the barcode. So you could use keyboard events. Of course you need to figure out what belongs to the barcode and where it starts and ends, but that could be solved. Well, maybe not perfect, but good enough… Next…

Slide 106

Slide 106

Oh, but a barcode scanner is a HID device… what if we could use WebHID to get the actual barcodes instead of the keystrokes.

Slide 107

Slide 107

We request the device. The user then selects the barcode scanner.

Slide 108

Slide 108

And we actually get back a list of “devices”, because most HID devices are composite devices. This barcode scanner, also. It is a keyboard… like we just said. And a barcode scanner. So we need to figure out which devices is the barcode scanner part, and not the keyboard part.

Slide 109

Slide 109

Then we need to tell it to turn off the keyboard emulation and use plain HID reports instead.

Slide 110

Slide 110

And listen for the input reports.

Slide 111

Slide 111

And then we get this back.

Slide 112

Slide 112

And we just need to parse this and extract the value of the barcode.

Slide 113

Slide 113

But you don’t need to do any of that, because I have this library for you.

Slide 114

Slide 114

And if you have a serial based scanner, I also have a similar library that uses WebSerial instead.

Slide 115

Slide 115

And that is our final device. Still think that demo was underwhelming? The demo made it look easy. And that is great. It is supposed to be easy for the end user. But is still a huge effort to get this working.

Slide 116

Slide 116

We’ve always used web technologies for our app. But integrating with Point of Sale devices was always a struggle. We needed wrappers or middleware. But now all the puzzle pieces are in place. But this is what I love about Project Fugu. It really allows us to move towards a future where we don’t need Electron for our application.

Slide 117

Slide 117

But Project Fugu is not just about cash registers or hardware. It is about all kinds of API’s to make the web more capable and making sure that PWA’s can compete with native applications. Be it on mobile or on desktop. And for us that really works. And it might work for you too.

Slide 118

Slide 118

Thank you!