WebSocket Events List of events Smart Reader Tag read

April 13, 2023 at 2:39 AM

Smart Reader Tag read event

When a tag is read by a Smart Reader (not running in keyboard emulation / RFID Scanner), the tag’s data are transmitted through a Tag read event.

Event specification

event : Reader.TagRead

params : a SMART_READER_TAG object

SMART_READER_TAG object

Field name Type Status Description
DeviceId string always The DeviceId of the device that has read the tag
Sequence integer always A sequence number sent by the device
Interface array of strings option Device’s reader interface. See Smart Reader Interfaces
Protocol array of strings option Protocol of the found tag. See Smart Reader Protocols
TagId string always Protocol-level identifier of the tag (UID, PUPI, DIV, … depending on the actual protocol)
Template integer option Which template of the smart reader does the tag match?
TagData string option If the tag matches one of the template, the data fetched from the tag by the template engine
TagDetails object option If the tag matches one of the template, more details regarding the tag or its data (type, source, etc)

Examples

ISO/IEC 144443-A tag, templates disabled (fast inventory mode)

{
	"jsonrpc": "2.0",
	"event": "Reader.TagRead",
	"params":
	{
		"DeviceId": "vkYkoELRDS3p9xhQO1lx8a",
		"Sequence": 1234,
		"Interface": "13.56",
		"Protocol": "NFC-A",
		"TagId": "047C7B02C44080"
	}
}

ISO/IEC 144443-A tag, template expressing a part of the UID in decimal

{
	"jsonrpc": "2.0",
	"event": "Reader.TagRead",
	"params":
	{
		"DeviceId": "vkYkoELRDS3p9xhQO1lx8a",
		"Sequence": 1235,
		"Interface": "13.56",
		"Protocol": "NFC-A",
		"TagId": "047C7B02C44080",
		"Template": 1,
		"TagData": "534639728584"
	}
}

ISO/IEC 144443-A tag, template to fetch a NFC Forum NDEF URL message

{
	"jsonrpc": "2.0",
	"event": "Reader.TagRead",
	"params":
	{
		"DeviceId": "vkYkoELRDS3p9xhQO1lx8a",
		"Sequence": 1236,
		"Interface": "13.56",
		"Protocol": "NFC-A",
		"TagId": "047C7B02C44080",
		"Template": 2,
		"TagData": "https://www.springcard.com"
	}
}