Cross Point


IHardwareControl Interface Reference

List of all members.

Detailed Description

This interface handles all HardwareControl related functionality.

This interface contains HardwareControl functionality that can be used to get, among others, the last card (using the LastUser property) that was presented to the reader and determine if this card is still in the proximity field of the reader (IsCarrierInField).

Using this object, it is also possible to: get and set the LEDs of the reader, determine the current state of the tamper switch (IsTampered) and to get and set the current status of the IO contacts (IOContacts).

Some other functionality allows the setting the Buzzer and the Relay.


Public Member Functions

HRESULT Reader ([out, retval] IProximityReader **ppintfReader)
 Returns the reader this hardware control object belongs to.

HRESULT EmulatePresentingID ([in] IUser *User)
 This function emulates the presenting of an ID-carrier in the proximity field of the reader.

HRESULT EmulateRPGKeys ([in] BSTR KeyCodes)
 This function emulates the pressing and releasing of keys on an Remote Programmer that is in the proximity of the reader.

HRESULT TransmitIDs ([in] IUser *User,[in] short NumberOfTimes,[in, defaultvalue(0)] VARIANT_BOOL fAsync)
 Forces the RF/ID interface to transmit an ID one or more times.

HRESULT SetRFIDInterfaceMode ([in] ERFIDMode ERFIDMode,[in, defaultvalue(0)] short Type)
 Sets the mode for the RF/ID interface.

HRESULT LastUser ([out, retval] IUser **ppintfUser)
 Returns the last user that was detected by the RF/ID interface.

HRESULT IsCarrierInField ([out, retval] VARIANT_BOOL *pfCarrierInField)
 Returns true if a card/carrier is currently in the proximity field of the reader.

HRESULT IsTampered ([out, retval] VARIANT_BOOL *pfTampered)
 Returns the current state of the tamper switch.

HRESULT IOContacts ([out, retval] EIOContacts *peIOContacts)
 Returns the current input status of the I/O contacts (or-ed).

HRESULT IOContacts ([in] EIOContacts IOContacts)
 Set the current output status of the I/O contacts (or-ed).

HRESULT LEDs ([out, retval] ELEDState *peLEDState)
 Return the current LED status (which LED's are on).

HRESULT LEDs ([in] ELEDState LEDState)
 Set the new settings for the LED's.

HRESULT Relay ([in] VARIANT_BOOL Activate)
 Activate or de-activate the relay.

HRESULT Buzzer ([in] EBuzzerState eNewState)
 Sets the new sound effect.

HRESULT TransmitCompleted ([out, retval] VARIANT_BOOL *pfCompleted)
 Returns true if the transmission of an ID was completed.


Member Function Documentation

IHardwareControl::Reader [out, retval] IProximityReader **  ppintfReader  ) 
 

Returns the reader this hardware control object belongs to.

Parameters:
ppintfReader Receives the reader object.
Precondition:
ppintfReader is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
IProximityReader

IHardwareControl::EmulatePresentingID [in] IUser pintfUser  ) 
 

This function emulates the presenting of an ID-carrier in the proximity field of the reader.

Result of emulating an ID depends on the authorization level and protection settings that have been established prior to starting this operation. For example emulating the presenting of an installer programmer at user level with the 'protect' option (= 10*1* option) active will not succeed into switching to program mode.

Parameters:
pintfUser Pointer to an IUser object with a specific ID.
Note:
Does not work with programmers in 9-digits mode!

Does not work in Basic configuration.

See also:
IUser, EmulateRPGKeys

IHardwareControl::EmulateRPGKeys [in] BSTR  bstrKeyCodes  ) 
 

This function emulates the pressing and releasing of keys on an Remote Programmer that is in the proximity of the reader.

Normally this operation is used for emulating over an RS-485 network the programming of the reader in program mode with a Remote Programmer (refer to Remote Programmer manual for more information about the program mode)·

The Remote Programmer key press emulation function can only be used when the reader is forced in program mode by means of a Remote Programmer or using function EmulatePresentingID to emulate the presenting of a Remote programmer.

Normally every emulation key code string must end with the 0Ah key code for the 'enter' key, just as with every program mode command typed on a real Remote Programmer.

The result of the program mode options that are executed using this emulation operation depends on the authorization level that has been established prior to starting this operation and the setting of the 'protect' option. (10*1* option) For example: emulating the 20* option (= installer level only option) at user level will generate an error.

Parameters:
bstrKeyCodes The keys to emulate, for example "0*1*" (max 18 characters long)
Note:
Does not work in Basic configuration.
See also:
EmulatePresentingID

IHardwareControl::TransmitIDs [in] IUser pintfUser,
[in] short  sNumberOfTimes,
[in, defaultvalue(0)] VARIANT_BOOL  fAsync
 

Forces the RF/ID interface to transmit an ID one or more times.

Can be used to transmit an ID. Another reader within the proximity field of this reader, will receive the ID. This method might be used to copy users from one reader into another.

Parameters:
pintfUser Pointer to an IUser object to transmit.
sNumberOfTimes The number of times the ID should be transmitted.
fAsync Performs this method asynchronously.
Note:
Does not work with programmers in 9-digits mode!

Currently the transmission of IDs is only supported for the EM H4001 RF/ID interface (= default).

Required authorization level: Installer.

See also:
IUser

IHardwareControl::SetRFIDInterfaceMode [in] ERFIDMode  eRFIDMode,
[in, defaultvalue(0)] short  sType
 

Sets the mode for the RF/ID interface.

This method can be used to disable or enable the RFID interface mode. Internally used in the IProximityReader::EnableRFID property.

Parameters:
eRFIDMode The new RFID Mode, see ERFIDMode.
sType Type of interface, currently supported only: 0x00 = EM H4001 (= default).
See also:
ERFIDMode, IProximityReader::EnableRFID

IHardwareControl::LastUser [out, retval] IUser **  ppintfUser  ) 
 

Returns the last user that was detected by the RF/ID interface.

This property will return a user object with data of the last detected user. This property will first try to search the detected ID in the userdatabase, if it finds a user with matching ID, that user object is returned. If it doesn't find a user, a new user object will be made that contains the cardnumber, facilitycode and cardtype of the detected card (note that the user level is unknown!).

The IsCarrierInField can be used to determine if the detected card is still within the proximity field of the reader.

Parameters:
ppintfUser Receives the last detected user.
Precondition:
ppintfUser is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
IUser, IsCarrierInField

IHardwareControl::IsCarrierInField [out, retval] VARIANT_BOOL *  pfCarrierInField  ) 
 

Returns true if a card/carrier is currently in the proximity field of the reader.

The ID of the card that is currently in the proximity field, can be retrieved using the LastUser property.

Parameters:
pfCarrierInField Set to true if a card is currently in the RF/ID field of the reader.
Precondition:
pfCarrierInField is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
LastUser.

IHardwareControl::IsTampered [out, retval] VARIANT_BOOL *  pfTampered  ) 
 

Returns the current state of the tamper switch.

If the tamper switch is uncovered, this property will return true, covered: false.

Parameters:
pfTampered True if the tamper switch is uncovered.
Precondition:
pfTampered is not NULL.
Note:
This is a read-only property when used in scripting languages.

IHardwareControl::IOContacts [out, retval] EIOContacts peIOContacts  ) 
 

Returns the current input status of the I/O contacts (or-ed).

Only the I/O contacts that are set up as INPUT contacts can be retrieved using this property. By default only IO1 and IO2 are configured as INPUT contacts.

Parameters:
peIOContacts The current state of the I/O Contacts (or-ed together),
Precondition:
peIOContacts is not NULL.

IHardwareControl::IOContacts [in] EIOContacts  eIOContacts  ) 
 

Set the current output status of the I/O contacts (or-ed).

Only the I/O contacts that are set up as OUTPUT contacts can be influenced by this property. By default only IO3 and IO4 are configured as OUTPUT contacts.

Parameters:
eIOContacts The new state of the output I/O Contacts (or-ed together),

IHardwareControl::LEDs [out, retval] ELEDState peLEDState  ) 
 

Return the current LED status (which LED's are on).

Parameters:
peLEDState Receives the current LED's state (or-ed together).
Precondition:
peLEDState is not NULL.

IHardwareControl::LEDs [in] ELEDState  eLEDState  ) 
 

Set the new settings for the LED's.

Parameters:
eLEDState The new led state (or-ed together).

IHardwareControl::Relay [in] VARIANT_BOOL  fActivate  ) 
 

Activate or de-activate the relay.

Parameters:
fActivate True to activate the relay.
Note:
This is a WRITE-only property when used in scripting languages.

IHardwareControl::Buzzer [in] EBuzzerState  eNewState  ) 
 

Sets the new sound effect.

Parameters:
eNewState The new buzzer state (EBuzzerState).
See also:
EBuzzerState
Note:
This is a WRITE-only property when used in scripting languages.

IHardwareControl::TransmitCompleted [out, retval] VARIANT_BOOL *  pfCompleted  ) 
 

Returns true if the transmission of an ID was completed.

Parameters:
pfCompleted True if the transmision is completed
Precondition:
pfCompleted is not NULL.
See also:
TransmitIDs


© Copyright 2001 - 2006 Cross Point. Generated on Mon Mar 12 16:29:51 2007 Cross Point