DEVICE object

The JSON DEVICE object returns all the technical data regarding a SpringCard device.

Use List connected devices to retrieve all the DEVICE objects, or Get device data if you already know the device's DeviceId.

Object definition

Field name Type Status Description Condition
"DeviceId" string always The DeviceId of the device. Use this as {$id} in all /device/{$id}/* requests
"Name" string always Name of the device, as returned by the driver or collected from the device's meta-data
"FriendlyName" string option Alternate name of the device, possibly used by the system in its own views Not empty
Not equal to Name
"Channel" string always Communication channel: usb, ble or network
"Profile" string always Main communication profile of the device: pc/sc, hid, comm, direct or unknown
"Status" string always Current status returned by the system: ok, error or unknown
"PnpId" string always Technical identifier of the device, in the form ssvvvvpppprrrr where
-ss is the VendorID source (02for USB Workgroup),
-vvvvis the VendorID in hex (1C34 for SpringCard),
-pppp is the ProductID in hex,
-rrrr the Release (for instance, 0210 for version "2.10")
"Mode" string always Operating mode of the device: coupler, reader, idle or unknown
"VendorId" integer always VendorID (vvvvpart of the PnpID) in decimal (7220 for SpringCard)
"ProductId" integer always ProductID (pppppart of the PnpID) in decimal
"SerialNumber" string option Serial number of the device Not empty
"Version" string always Version of the device (ex: "2.10")
"Firmware" string always Identification of the firmware
"Hardware" string option Identification of the hardware (part number) Not empty
"Characteristics" string option Technical characteristics of the hardware (see Hardware Characteristics) Not empty
"UniqueId" string always Unique Identifier of the device (signature of the hardware)
"ConfigId" string option The GUID of the configuration (signature of the settings) (register 0200) Register set in NVM
"Inventory" string option Inventory number (register 0201) Register set in NVM
"Location" string option Location (register 0202) Register set in NVM
"Application" string option Application name or integrator specific string (register 0208) Register set in NVM
"LicenseKey" string option License key or license number (register 0209) Register set in NVM
"LicenseCryptogram" string option License cryptogram (register 020A) Register set in NVM
"Pcsc" object option The list of PC/SC readers associated to this device. This object has 2 entries:
Names: an array of strings with the name of every PC/SC reader
ReaderIds: an array of strings with the ReaderId of every PC/SC reader.
Profile is pc/sc
"HidInstance" string option The name of the HID driver instance associated to this device Profile is hid
"CommPort" string option The name of the COM port associated to this device Profile is comm
"PhysAddress" string option Physical address of the device, as an hex-string, if this information is available and makes sense.
For a BLE device, this is the BT_ADDR, for a network device, the MAC address.
"IpAddress" string option IPv4 network address, if the device has one
"IpAddress6" string option IPv6 network address, if the device has one

Warning

The DeviceId field is only a temporary value. The very same device may have a different "DeviceId" the next time it connects to the computer. A different device may have the same DeviceId as a previously connected one.

Always use List devices to enumerate all the devices that are currently connected to the computer, and do not store the DeviceId values anywhere.

If you want to identify a particular device, use the SerialNumber or UniqueId fields.

Example

{
	"DeviceId": "z1FyhlpOKF72WuAdurpwaa",
	"Channel": "usb",
	"Profile": "hid",
	"Status": "ok",
	"PnpId": "021C3492410179",
	"Mode": "reader",
	"VendorId": 7220,
	"ProductId": 37441,
	"SerialNumber": "00000000",
	"Version": "1.79",
	"Name": "SpringCard RFID Scanner HSP",
	"HidInstance": "hid#vid_1c34&pid_9241#7&3482e2d5&0&0000",
	"UniqueId": "72967A11-6089-8B0D-F36E-9ED0CC493BE4",
	"ConfigId": "1DA1B7F7-106A-4EE4-A069-50F0C5BB43FD",
	"Hardware": "EAN18199-CA",
	"Characteristics": "nfc-poller",
	"Location": "Creative Room"
}