Start a Smart Reader

Role

If the device implements the Smart Reader (or RFID Scanner) operating mode, use this method to start the Smart Reader operations.

Note that a RFID Scanner (Smart Reader with keyboard emulation) is normally enabled on startup (this could be changed by configuration), where a Smart Reader without keyboard emulation shall be started by the application that wants to use it.

Prototype

URL : /device/{$id}/reader/start

Method : POST

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

Request data : Optional, can be left empty to use default values

Field name Type Status Description
"Mode" string option For a Smart Reader with keyboard emulation (RFID Scanner),
- hid to have the tag data go to through the keyboard (HID) interface; this is the default behaviour
- direct to have the tag data go to application(s) as WebSocket events
For a Smart Reader without keyboard emulation only direct is allowed (and assumed by defaut)
"AutoStopAfter" integer option The reader stops automatically after the specified time.The value is expressed in seconds (max 86400).
Set to 0 (default value) to keep reading forever.
"Single" boolean option If set to true, the reader stops automatically after having read a first tag. The application shall then invoke this method again to read another tag.
Default is false (permanent reading mode)
"SingleTimeout" integer option If Single=true, the reader stops automatically if no tag is found in the specified period. The value is expressed in seconds (max 86400).
Set to 0 (default value) to wait forever.

Success Response

Code : 200 OK

Content : a SUCCESS object.

Error Response

See Error Responses.