Property Ksktscanpropidtimersdevice - Socket ScanAPI Reference Manual

Socket ScanAPI Reference
C#:
The constant definition can be found in
ScanAPI.ISktScanProperty.values.soundConfig.
Objective C:
The helper macro can be found in the SktScanPropIds.h file.
Parameter type
Get
Byte
Version
ScanAPI Interface Version

14.19 Property kSktScanPropIdTimersDevice

This property gets or sets the various Timers of the connected device. There are
three timers that can be modified. The first is the trigger lock out timer, which is the
time the trigger is locked out. If the device receives a confirmation from the host, it
then unlocks the trigger, otherwise the trigger lock out timeout occurs and unlocks
the trigger. The other timers are used to know when to turn the device off when no
activity is detected. These timers are dependent on the device connection state.
There is one timer when the device is in disconnected state and a second one for
when the device is in a connected state. When the timeout is reached the device
turns itself off.
The first parameter of this property is a mask to indicate for which timer the values
should be modified.
All the parameters are expressed in 16 bit words in big-endian format.
The following table describes the parameters format used in the property for the Set
Operation and the Get Complete response:
Name
Timers Mask
Trigger Lock out
timer
Disconnected auto
© 2013 Socket Mobile, Inc.
Get Complete
Array
Size
2 bytes
2 bytes
2 bytes
Set
Array
1.0.0 or higher
Description
Mask indicating which timer is involved
in the following parameters. The mask
can a combination of any of the
following values:
kSktScanTimerTriggerAutoLockTimeout
kSktScanTimerPowerOffConnected
kSktScanTimerPowerOffDisconnected
Time in 1/4 second increments for the
trigger to be locked out.
Time in minutes to leave power on
Set Complete
None
102/152