Detailed device data

Role

Read the detailed data from a device. The data set comes from the GET DATA instruction.

Prototype

URL : /device/{$id}/data

Method : GET

URL Params : {$id} : the DeviceId of the device. Use GET /devices to enumerate the connected devices.

Request data : None

Success Response

Code : 200 OK

Content : a DEVICE-INFO object, as specified below.

DEVICE-INFO object definition

Field name Type Status Description
"DeviceName" string option Complete device name (Vendor name<space>Product name)
"VendorName" string option Vendor name
"ProductName" string option Product name
"SerialNumbner" string option Serial number (as an hex. string)
"PnpId" string option USB device identifier (VendorID, ProductID as an hex. string)
"Version" string option Product version string
"FirmwareRevision" string option Firmware revision string
"FirmwareName" string option Identification of the firmware
"BuildUser" string option Build info: user name
"BuildDateTime" string option Build info: date & time
"EthernetAddress" string option Ethernet address (MAC address as an hex. string)
"BluetoothAddress" string option Bluetooth address (BD_ADDRas an hex. string)
"BluetoothDeviceName" string option Bluetooth device name
"UniqueId" string option Unique IDentifier of the device (GUID-formatted text)
"ConfigId" string option Configuration IDentifier (GUID-formatted text)
"HardwareReference" string option Hardware reference
"ContactlessLibraryVersion" string option Version of the NFC/RFID HF library
"SmartcardLibraryVersion" string option Version of the smartcard library
"BluetoothLibraryVersion" string option Version of the Bluetooth library
"NetworkLibraryVersion" string option Version of the network library
"KernelVersion" string option Version of the kernel
"NetworkStack" string option Name of the network stack
"Kernel" string option Name of the kernel
"DaughterFirmware" string option Firmware of the antenna daughter-board
"DaughterHardware" string option Hardware version of the antenna daughter-board
"DaughterConfiguration" string option Configuration of the antenna daughter-board
"DaughterSequences" string option Sequence pack of the antenna daughter-board
"ContactlessChipset" string option Name of the NFC/RFID HF chipset
"ContactlessChipsetVersion" string option Version of the NFC/RFID HF chipset
"SmartcardChipset" string option Name of the smartcard chipset
"BluetoothChipset" string option Name of the Bluetooth chipset
"BluetoothChipsetVersion" string option Version of the Bluetooth chipset
"Mcu" string option Name of the MCU
"OriginalVendorName" string option Original vendor name
"OriginalProductName" string option Original product name
"DetectedProductVariant" string option Detected variant name (if some)
"OriginalEthernetAddress" string option Original Ethernet address (MAC address as an hex.string)
"OriginalBluetoothAddress" string option Original Bluetooth address (BD_ADDR as an hex.string)
"MainProfile" string option Name of the main operating profile
"UsbProfile" string option Name of the USB profile
"BluetoothProfile" string option Name of the BLE profile
"NetworkProfile" string option Name of the network profile
"IPv4Address" string option Active IPv4 address (x.x.x.x)
"iCcidSlotCount" integer option Count of PC/SC or CCID slots
"iCcidHostDriver" integer option Identified PC/SC driver
0 : not identified
1 : SpringCard PC/SC driver for Windows
2 : CCID driver for PCSC-Lite (Linux / Mac)
"hSerialNumber" hex string option Serial number
"hPnpId" hex string option USB device identifier (VendorID, ProductID)
"hVersion" hex string option Product version MMmmBBBB
"hDirectPublicKey" hex string option ECC public key of the device for Direct protocol
"hEthernetAddress" hex string option Ethernet address (MAC address)
"hBluetoothAddress" hex string option Bluetooth address (BD_ADDR)
"hBluetoothSdkVersion" hex string option Bluetooth SDK version
"hUniqueId" hex string option Unique IDentifier of the device
"hConfigId" hex string option Configuration IDentifier
"hHardwareCharacteristics" hex string option Hardware characteristics
"hDaughterConfiguration" hex string option Configuration of the antenna daughter-board
"hBootloaderFlags" hex string option Bootloader flags
"hRunningFirmwareId" hex string option ID of the running firmware
"hFactoryConfigFirmwareId" hex string option ID of the factory settings
"hUsbState" hex string option USB state
"hBluetoothState" hex string option Bluetooth state
"hNetworkState" hex string option Network state
"hPowerState" hex string option Power state
"hBatteryState" hex string option Battery state
"hDeviceState" hex string option Global state of the device
"hOriginalEthernetAddress" hex string option Original Ethernet address (MAC address)
"hOriginalBluetoothAddress" hex string option Original Bluetooth address (BD_ADDR)

Example

{
	"DeviceName": "SpringCard Puck",
	"VendorName": "SpringCard",
	"ProductName": "Puck",
	"SerialNumber": "68A556F0",
	"PnpId": "1C346132",
	"Version": "1.19",
	"FirmwareRevision": "1.19-23-g00a4fad0",
	"FirmwareName": "springcore/h518/puck",
	"BuildUser": "johann.d",
	"BuildDateTime": "210203 1705",
	"BluetoothAddress": "EC1BBDF53870",
	"BluetoothDeviceName": "SpringCard Puck [F53870]",
	"UniqueId": "40A65F1A-63A4-0527-8E1D-D37EDD073DE9",
	"ConfigId": "00000000-0000-0000-0000-000000000000",
	"ContactlessLibraryVersion": "20.04.1",
	"SmartcardLibraryVersion": "20.12.2",
	"BluetoothLibraryVersion": "21.01.1",
	"KernelVersion": "10.02.0",
	"Kernel": "FreeRTOS",
	"DaughterFirmware": "Vegas-1.02",
	"DaughterHardware": "EAS17204-AC",
	"DaughterConfiguration": "LED:0,RGB:1,BUZZER:1,TARGET:1",
	"DaughterSequences": "Puck-01",
	"ContactlessChipset": "PN5180",
	"BluetoothChipset": "BGM111",
	"BluetoothChipsetVersion": "2.13.6",
	"Mcu": "RX651",
	"OriginalVendorName": "SpringCard",
	"OriginalProductName": "Puck",
	"DetectedProductVariant": "Blue",
	"OriginalBluetoothAddress": "EC1BBDF53870",
	"MainProfile": "PC/SC",
	"UsbProfile": "PC/SC",
	"BluetoothProfile": "CCID",
	"iCcidSlotCount": 1,
	"iCcidHostDriver": 1,
	"hSerialNumber": "68A556F0",
	"hPnpId": "1C346132",
	"hVersion": "01190014",
	"hBluetoothAddress": "EC1BBDF53870",
	"hBluetoothSdkVersion": "020D06",
	"hUniqueId": "1A5FA640A46327058E1DD37EDD073DE9",
	"hConfigId": "00000000000000000000000000000000",
	"hHardwareCharacteristics": "0206030C04010525479F100805",
	"hDaughterConfiguration": "E8",
	"hBootloaderFlags": "1B05010A0000F0FF00C0FFFF5620F7B4",
	"hRunningFirmwareId": "E7E7E7E7",
	"hFactoryConfigFirmwareId": "E7E7E7E7",
	"hPowerState": "0202",
	"hBatteryState": "640000000000000000",
	"hDeviceState": "14",
	"hOriginalBluetoothAddress": "EC1BBDF53870"
}

Error Response

See Error Responses.