User Guide

MagTek Device Drivers for Windows
104
event
Function
Response to an unsolicited event notification.
Syntax
none
Errors
none
Remarks
This response can occur when an unsolicited event, such as card inserted, occurs.
The format of the response is:
/event n data
n is a numeric event code:
1 – medium has been inserted into the reader
2 – medium has been removed from the reader
data specifies the type of medium that was inserted/removed:
M – magnetic
Events are sent to the application only if the c_events property is 1 (driver supports
events) and the events_on property is set to 1 by the application.
If a card has already been inserted when the driver is opened, there will not be any
notification when
events_on is enabled. Consequently, it is recommended that
/get card_stat be issued immediately after opening the driver to see if a card
is blocking the sensor.
Example
If you wish to be notified when a card has been inserted into the PPINSERT:
Command
/set events_on 1<LF>
Response
/event 1 M<LF>
When a card is inserted into the slot.
get
Function
Get a property.
Syntax
/get prop
prop is one of the valid properties shown in Section 2 or any of those from data
parsing.
Errors
/get abc<LF>
Since abc does not exist.
Remarks
The driver sends a response in the format: /get prop val.
If the requested property does not exist, the val field will be empty, i.e.,
<LF> follows
the prop field. If the command was cancelled, both the prop and val fields will be
empty. In some cases, this command will interrogate the device to determine the
property setting. Some properties cannot be interrogated if a command (such as read)
is pending. The value will be null in this case.
Example
If you wish to find out which tracks are enabled, request the trk_enable property:
Command
/get trk_enable<LF>
Response
/get trk_enable 110<LF>
Indicating track 1 & 2 are enabled, track 3 is disabled.