Home  Contents

v4kf:insert

V4kf Core4 Lua Event System

SYNOPSIS

#include <v4kf.lh>
rdrhandle:insert([flags])

DESCRIPTION

This command can only be used if the reader is ready.

The command returns immediately. Actual execution of any reader operation is done within the event loop.

Insertion readers

Sets up the reader for card insertion. The shutter opens and allows a card to be inserted. The optional flags, when 1, asks for the chip contact to engage as soon as the card is fully inserted.

When done, the state machine will enter the Inserted or Locked state, respectively, as requested by flags.

Motor readers

Sets up the reader for card insertion. The shutter is enabled and allows a card to be inserted. The optional flags value is a bit-wise or of zero or more options:

V4KF_INSERT_AUTOLOCK Automatically engage chip contact after insertion.
V4KF_INSERT_CHECK_FOR_MAGSTRIPE (V2XF only) Only accept cards with a proper magstripe.
V4KF_INSERT_WIGGLE (V2XF only) Wiggle card back and forth during insertion.

When done, the state machine will enter the Inserted or Locked state, respectively, as requested by flags. The Locked state indicates that the chip contact is engaged.

Notes

The Sankyo and Hopt+Schuler readers make no distinction between Inserted and Locked. An inserted card is always automatically mechanically connected to the chip contact. The state machine never enters the Inserted state.

The Hopt+Schuler CHD845 and CHD862 do not have protection against surprise removal of the card. The term Locked is misleading in that case, but kept anyway for compatibility reasons.

The Leadus V4KF insertion reader actively prevents card removal while in Locked state.

SEE ALSO