MSP430™CapTIvateSoftwareLibraryAPIGuide 1_70_00_03

Data Structures | Macros | Typedefs | Enumerations
CAPT_TYPE

CapTIvate™ Capacitive Touch Library type definitions. More...

## Data Structures
union | IQ16_t
| typedef IQ16_t More...
struct | tDeBounceSettings
| typedef tDeBounceSettings More...
struct | tCaptivateElementTuning
| typedef tCaptivateElementTuning More...
struct | tElement
| typedef tElement More...
struct | tCycle
struct | tGenericSensorParams
struct | tSensor
struct | tButtonSensorParams
struct | tSliderSensorParams
struct | tTrackPadSensorParams
| typedef tTrackPadSensorParams More...
struct | tProxSensorParams
struct | tEMCConfig
| typedef tEMCConfig More...
struct | tCaptivateApplication
| typedef tCaptivateApplication More...

## Macros
#define | NULL (0)
#define | _IQ31(x) (((IQ31_t)((x) * ((IQ31_t)1 << 30))) << 1)
| def _IQ31 More...

## Typedefs
typedef uint8_t | tSensorType
typedef uint8_t | tSenseTechnology
typedef uint8_t | tDirectionOfInterest
typedef uint8_t | tPositionAlgorithm
typedef uint8_t | tFilterOption
typedef uint8_t | tRawConversionStyle
typedef uint8_t | tOversamplingStyle
typedef uint8_t | tElementStatusType
typedef int32_t | IQ31_t
| typedef IQ31_t More...
typedef tSliderSensorParams | tWheelSensorParams
typedef uint8_t | tAppState

## Enumerations
enum | { eButtonGroup = 0x00, eSlider = 0x01, eWheel = 0x02, eTrackpad = 0x03, eProx = 0x04 }
| typedef tSensorType More...
enum | { eSelf = 0x00, eProjected = 0x01 }
enum | { eDOIDown = 0x00, eDOIUp = 0x01 }
enum | { eVectors = 0x00, eOtherPositionAlg }
| typedef tPositionAlgorithm More...
enum | { eCount = 0x00, eLTA = 0x01 }
| typedef tFilterOption More...
enum | { eStandard = 0x00, eMultiFrequency = 0x01, eMultiFrequencyWithOutlierRemoval = 0x02, eMultiFrequencyWithOutlierRemovalAndErrCorrection = 0x03, eNrOfConversionStyles }
| typedef tRawConversionStyle More...
enum | { eNoOversampling = 0x00, e2xOversampling = 0x01, e4xOversampling = 0x02, e8xOversampling = 0x03, e16xOversampling = 0x04, e32xOversampling = 0x05, eNrOfOversamplingStyles }
| typedef tOversamplingStyle More...
enum | { eTouchStatus = 0x00, eProxStatus, eNegativeTouchStatus, eDetectStatus, eBISTStatus, eNoiseStatus }
| typedef tElementStatusType More...
enum | tXYFilterType { eStatic, eDynamic }
enum | tXYAlgorithm { eSingle, eMulti }
enum | { eUIActive, eUIWakeOnProx }
| typedef tAppState More...

## Detailed Description

CapTIvate™ Capacitive Touch Library type definitions.

Version
  VERSION Released on RELEASE_DATE

## Macro Definition Documentation

## § NULL

#define NULL (0)

## § _IQ31

#define _IQ31 | ( |  | x | ) | (((IQ31_t)((x) * ((IQ31_t)1 << 30))) << 1)

def _IQ31

Convert a value into IQ31 format.

## Typedef Documentation

## § tSensorType

typedef uint8_t tSensorType

## § tSenseTechnology

typedef uint8_t tSenseTechnology

## § tDirectionOfInterest

typedef uint8_t tDirectionOfInterest

## § tPositionAlgorithm

typedef uint8_t tPositionAlgorithm

## § tFilterOption

typedef uint8_t tFilterOption

## § tRawConversionStyle

typedef uint8_t tRawConversionStyle

## § tOversamplingStyle

typedef uint8_t tOversamplingStyle

## § tElementStatusType

typedef uint8_t tElementStatusType

## § IQ31_t

typedef int32_t IQ31_t

typedef IQ31_t

IQ31_t is a fixed-point fractional data type that supports the following range and accuracy: MIN=-1; MAX=0.999999999; RES=0.0000000005

## § tWheelSensorParams

typedef tSliderSensorParams tWheelSensorParams

typedef tWheelSensorParams

Wheel sensor specific parameters. One instance must be created and tied to every wheel sensor. Note that the wheel sensor parameters are identical to the slider sensor's.

## § tAppState

typedef uint8_t tAppState

## Enumeration Type Documentation

## § anonymous enum

anonymous enum

typedef tSensorType

Specifies the different Capacitive Sensor Implementations available Note: This is defined as a 4 bit field in the structures, limiting the maximum number of sensor types to 16.

Enumerator
eButtonGroup | Single Button or Button Group Sensor Composed of at least 1 but no more than 256 elements
eSlider | Slider Sensor (1D Sensor) Composed of at least 3 but no more than 12 elements
eWheel | Wheel Sensor (1D Sensor) Composed of at least 3 but no more than 12 elements Identical to slider, but with the endpoints connected
eTrackpad | Track Pad (2D Sensor) Only supported on specific devices
eProx | Proximity Sensor Composed of exactly 1 element. Projected capacitance implementation has special considerations.

## § anonymous enum

anonymous enum

typedef tSenseTechnology

Specifies the different sensing methods available to an element, namely Self or Projected capacitance.

NOTE: This fits in a single bit field in the element structure!

Enumerator
eSelf | Self capacitive sensing Single-ended electrodes to earth ground, 1 device pin per element
eProjected | Projected capacitive sensing Measurement between two electrodes, one transmitter and one receiver

## § anonymous enum

anonymous enum

typedef tDirectionOfInterest

Specifies the direction of interest for a sensor group. The direction refers to the count value of successive conversions, either increasing (up) or decreasing (down).

NOTE: This fits in a single bit field in the element structure!

Enumerator
eDOIDown | Decreasing Counts.
eDOIUp | Increasing Counts.

## § anonymous enum

anonymous enum

typedef tPositionAlgorithm

Specifies the two different algorithms available for the slider position algorithm.

Enumerator
eVectors | Selection of the vector algorithm.
eOtherPositionAlg | Selection of alternative algorithm (not implemented to date)

## § anonymous enum

anonymous enum

typedef tFilterOption

Specifies the two filtered values in an element.

Enumerator
eCount | Select the filtered count value.
eLTA | Select the filtered LTA (long term average) value.

## § anonymous enum

anonymous enum

typedef tRawConversionStyle

Specifies the conversion style to use when performing a raw conversion.

Enumerator
eStandard | One sample is perfomed at the base (default) conversion frequency.
eMultiFrequency | The element is sampled at multiple conversion frequencies, and the composite raw count is populated via an averaging filter
eMultiFrequencyWithOutlierRemoval | The element is sampled at multiple conversion frequencies, and the largest outlier is removed from the dataset and the composite raw count is populated via an averaging filter after the outlier is removed
eMultiFrequencyWithOutlierRemovalAndErrCorrection | This option is being DEPRECATED for library version 1.10.03.00. From this version forward, eStandard, eMultiFrequency and eMultiFrequencyWithOutlierRemoval have error correction built-in and there is no longer an option to not have error correction. This means that all max count error conversion that result in a conversion result of zero will have their conversion result value set equal to the max count error threshold, rather than to zero. This improves algorithm performance, and allows for efficient true max count error detection based on the composite result value. Passing eMultiFrequencyWithOutlierRemovalAndErrCorrection will give the same results as passing eMultiFrequencyWithOutlierRemoval.
eNrOfConversionStyles | Indicates the number of available conversion styles.

## § anonymous enum

anonymous enum

typedef tOversamplingStyle

Specifies the number of oversamples to perform when noise immunity (EMC) mode is enabled.

Enumerator
eNoOversampling | Oversampling is disabled.
e2xOversampling | 2x oversampling is enabled
e4xOversampling | 4x oversampling is enabled
e8xOversampling | 8x oversampling is enabled
e16xOversampling | 16x oversampling is enabled
e32xOversampling | 32x oversampling is enabled
eNrOfOversamplingStyles | The number of different oversampling styles.

## § anonymous enum

anonymous enum

typedef tElementStatusType

Specifies the different element status flags

Enumerator
eTouchStatus | Touch status flag.
eProxStatus | Prox status flag.
eNegativeTouchStatus | Negative touch status flag.
eDetectStatus | Detect status flag.
eBISTStatus | BIST status flag.
eNoiseStatus | Noise status flag.

## § tXYFilterType

enum tXYFilterType

Specifies the two different filter beta options available.

eStatic - The beta is kept to a fixed value (constant filtering)

eDynmaic - The beta is dynamically changed relative to the speed of movement of the XY point

Enumerator
eStatic |
eDynamic |

## § tXYAlgorithm

enum tXYAlgorithm

Specifies the two different XY position algorithms implemented.

eSingle - Only computes one point, based on a large weighted sum across the whole trackpad (better for large/flat finger inputs)

eMulti - Computes multiple position outputs (large/flat inputs could be seen as multiple small inputs)

Enumerator
eSingle |
eMulti |

## § anonymous enum

anonymous enum

typedef tAppState

The app state enumeration is used by the CapTIvate™ application structure to manage the current state of the application (active or autonomous).

Enumerator
eUIActive | eUIActive indicates that the UI is the active state
eUIWakeOnProx | eUIWakeOnProx indicates that the UI is the autonomous state

© Copyright 1995-2018, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale