Skip to main content

API

Here you will find the methods that you can use to interact with the Locker device.

Setters​

listenOnPort​

Warning

This device can't support the listenOnPort setter, but is on Kernel class

serialFilters​

usbVendorId usbProductId are the filters that you can use to connect to the device

machine.serialFilters = [
  {
    usbVendorId: 0x04d8,
    usbProductId: 0x0053,
  },
];

serialConfigPort​

Warning

This is better don't use once constructor was called

machine.serialConfigPort = {
  baudRate: 9600,
  dataBits: 8,
  stopBits: 1,
  parity: "none",
  bufferSize: 32768,
  flowControl: "none",
};

server​

Set the integration data for server

Tips

Available environments are production, qa, development

machine.server = "SOMETHING_HERE";

bussinessId​

Set the integration data for bussinessId

machine.bussinessId = "SOMETHING_HERE";

encriptionKey​

Set the integration data for encriptionKey

machine.encriptionKey = "SOMETHING_HERE";

apiKey​

Set the integration data for apiKey

machine.apiKey = "SOMETHING_HERE";

Getters​

listenOnPort​

Address of the machine

Warning

This device can't support the listenOnPort getter, but is on Kernel class

console.log(machine.listenOnPort);

serialFilters​

get the filters that apply when require a serial device

console.log(machine.serialFilters);

serialConfigPort​

get the configuration of the serial port

console.log(machine.serialConfigPort);

isConnected​

Check if the machine is connected

console.log(machine.isConnected);

isDisconnected​

Check if the machine is disconnected

console.log(machine.isDisconnected);

deviceNumber​

Get the number of device, isn't the same of the address.

Warning

Number of device is util if you have more than one machine in the same pc

console.log(machine.deviceNumber);

uuid​

Get the uuid of the connection

When you create a new instance of the class, the uuid is generated

console.log(machine.uuid);

typeDevice​

Get the type of the device each class has a different type, in this case is locker

console.log(machine.typeDevice);

queue​

Get the queue of commands that are waiting to be executed

console.log(machine.queue);

isDispensing​

Check if the machine is dispensing

console.log(machine.isDispensing);

server​

console.log(machine.server);

bussinessId​

console.log(machine.bussinessId);

encriptionKey​

console.log(machine.encriptionKey);

apiKey​

console.log(machine.apiKey);

Methods​

softReload​

Soft reload the machine

await machine.softReload();

sendConnect​

Send connect to the machine

await machine.sendConnect();

sendCustomCode​

Send custom code to the machine

await machine.sendCustomCode({ code: "CODEPPCUSTOM" });

connectMessage​

Send connect message to device

Note

You need listen connectMessage to handle response

await machine.login();

login​

Login with provider

Note

You need listen login to handle response

await machine.login();

makeSale​

Make a sale (purchase)

This is the most important method, because with this you can make a sale

Tips

amount and reference are required parameters

Note

You need listen payment to handle response

Example #1 Simple way​

await machine.makeSale({
  amount: 15.0,
  reference: "TEST-001",
});

Example #2 Verbose data​

const makeDateFormatReference = () => {
  const date = new Date();
  return date
    .toISOString()
    .replaceAll(" ", "-")
    .replaceAll(":", "-")
    .replaceAll(".", "-");
};

function getRandomNumber(max) {
  return Math.random() * max;
}

const amount = getRandomNumber(50).toFixed(2);
const reference = "DEV-TEST-" + makeDateFormatReference();

await machine.makeSale({ amount, reference });

getVoucher​

Get the last purchase voucher, you can wait for the response or listen the event voucher as decribed on listeners section

Note

You can listen voucher for response

const response = await machine.getVoucher();
console.log(response)

info​

Get information about device PAX

Note

You need listen info to handle response

await machine.info();