Socket ScanAPI Reference Manual page 66

Socket ScanAPI Reference
The Buttons Event is not activated by default. The device notification must be
modified in order to turn on this notification. This is accomplished by using the
property kSktScanPropIdNotificationDevice.
The same property can be used to configure which button event the device will
send. See the Property kSktScanPropIdNotificationsDevice for more information.
The buttons code is a byte value with a bit field value and is defined as follows:
7 6
Reserved Reserved Reserved Ring
If the bit is set it means the button has been pressed.
A set of macros are defined to retrieve the status.
Name
SKTBUTTON_ISLEFTPRESSED(buttons)
SKTBUTTON_ISRIGHTPRESSED(buttons)
SKTBUTTON_ISMIDDLEPRESSED(buttons) Returns true if the middle button is
SKTBUTTON_ISPOWERPRESSED(buttons)
SKTBUTTON_ISRINGDETACHED(buttons)
Several buttons can be pressed at the same time and the button code will reflect that
condition with multiple bits set to 1.
The button status can also be retrieved at any time by doing a get operation with the
Property kSktScanPropIdButtonStatusDevice.
NOTE:
On a scanner that has only one trigger button such as 7 series scanners, the Middle
button is the trigger button.
The power button will generate one event when it is pressed and another event
when it is released whereas the left and right buttons generate an event only when
they are pressed.
C/C++:
The helper macro can be found in the SktScanPropIds.h file
© 2013 Socket Mobile, Inc.
5 4
Power
Detached button
Description
Returns true if the left button is
pressed, false otherwise.
Returns true if the right button is
pressed, false otherwise.
pressed, false otherwise.
Returns true if the power button is
pressed, false otherwise.
Returns true if the Ring unit is
detached from the wrist unit, false
otherwise.
3 2
Middle Right
button button
1 0
Left
button
66/152