FD1 Client Protocol

FD1 Devices Endpoint

The devices endpoint provides access to read and control all local hardware devices.

Accessing Devices

fd1.devices.get_devices

Returns a list of known devices.

{
    a: "fd1.devices.get_devices"
}
Response
{
    ...
    data: {
        rows: [
            {
                deviceid: "ajadhh4gfg35j5",
                type: "scale"
            },
            {
                deviceid: "skshh5jh58ghfg",
                type: "cashdrawer"
            }
        ]
    }
}

Scales

Access to local retail scales used on checkouts

Reading a scales current weight

{
    a: "fd1.devices.scale.read",
    k: ... Scale Id...
}
Response
{
    ...
    data: {
        rows: [
            {
                current_gram: 2232
            }
        ]
    }
}