REST API Devices Objects DEVICE Hardware Characteristics

April 13, 2023 at 2:39 AM

Hardware Characteristics

The Characteristics field in the DEVICE object contains a comma-separated list of the features provided by the device. The application shall use this information, if present, to expose either features in the configuration pages or alike.

List of characteristics

  • nfc : the device features a complete Contactless (NFC) interface (poller + listener),
  • nfc-reader: the device features a Contactless (NFC) interface that is only able to do reader (poller) mode,
  • nfc-target: the device features a Contactless (NFC) interface that is only able to do card emulation (listener or target) mode,
  • 7816: the device features a SmartCard interface,
  • id1: the device features one ID-1 SmartCard slot; id1*2: the device features two ID-1 SmartCard slots,
  • sim/sam: the device features one SIM/SAM (ID-000) SmartCard slot; sim/sam*2, sim/sam*3 sim/sam*4: the device features respectively two, three, four SIM/SAM (ID-000) SmartCard slots,
  • ethernet: the device features an Ethernet interface,
  • ble: the device features a Bluetooth Low Energy interface,
  • battery: the device has a battery,
  • poe: the device is able to be powered by the Ethernet network (POE),
  • jack: the device has a dedicated power input (jack or alike),
  • led-rgb: the device features a RGB LED (or a set of RGB LEDs),
  • led*4: the device features a ramp of 4 LEDs,
  • led(s): the device features some LEDs,
  • lcd-graphic: the device features a LCD (graphic),
  • lcd-text: the device features a LCD (text only),
  • buzzer: the device features a buzzer,
  • music: the device features a loudspeaker and a mean to play “nice” sounds,
  • rumbler: the device features a rumbler for haptic returns,
  • keyboard: the device features a keyboard,
  • pinpad: the device features a pinpad,
  • button(s): the device features some input buttons,
  • atecc: the device features an AtEcc Secure Element,
  • ataes: the device features an AtAes Secure Element,
  • samav: the device features an NXP SamAV Secure Element,
  • crypto: the device’s microcontroller includes at least an AES engine and a PRNG,
  • crypto++: the device’s microcontroller includes a complete crypto engine,
  • rtc: the device features a real-time clock.

Example

For a Puck Blue (USB + Bluetooth Low Energy, no SIM/SAM slot), this entry says:

"Characteristics": "nfc,usb,ble,led-rgb,buzzer,atecc,samav,crypto"