SensorLib 0.5.0
Multi-platform sensor driver library for Arduino, PlatformIO, and ESP-IDF
Loading...
Searching...
No Matches
HapticCapabilities Struct Reference

Device capability flags. More...

#include <HapticDefs.hpp>

Public Member Functions

constexpr HapticCapabilities ()
 

Public Attributes

uint8_t hasF0Calibration: 1
 Supports F0 (resonant frequency) calibration.
 
uint8_t hasVbatCompensation: 1
 Supports automatic voltage compensation.
 
uint8_t hasRTP: 1
 Supports Real-Time Playback mode.
 
uint8_t hasSequence: 1
 Supports waveform sequencing.
 
uint8_t hasAutoCalibration: 1
 Supports auto-calibration.
 
uint8_t hasBreakEffect: 1
 Supports brake/break effects.
 
uint8_t hasOverdrive: 1
 Supports overdrive effects.
 
uint8_t hasContinuousMode: 1
 Supports continuous vibration mode.
 
uint8_t maxEffectCount
 Maximum number of effect IDs supported.
 
uint8_t maxSequenceLength
 Maximum waveform sequence length.
 
uint16_t maxDurationMs
 Maximum vibration duration in ms (0 = unlimited)
 

Detailed Description

Device capability flags.

Use with getCapabilities() to query what features a specific haptic driver supports.

Definition at line 82 of file HapticDefs.hpp.

Constructor & Destructor Documentation

◆ HapticCapabilities()

constexpr HapticCapabilities::HapticCapabilities ( )
inlineconstexpr

Definition at line 96 of file HapticDefs.hpp.

Member Data Documentation

◆ hasAutoCalibration

uint8_t HapticCapabilities::hasAutoCalibration

Supports auto-calibration.

Definition at line 87 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasBreakEffect

uint8_t HapticCapabilities::hasBreakEffect

Supports brake/break effects.

Definition at line 88 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasContinuousMode

uint8_t HapticCapabilities::hasContinuousMode

Supports continuous vibration mode.

Definition at line 90 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasF0Calibration

uint8_t HapticCapabilities::hasF0Calibration

Supports F0 (resonant frequency) calibration.

Definition at line 83 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasOverdrive

uint8_t HapticCapabilities::hasOverdrive

Supports overdrive effects.

Definition at line 89 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasRTP

uint8_t HapticCapabilities::hasRTP

Supports Real-Time Playback mode.

Definition at line 85 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasSequence

uint8_t HapticCapabilities::hasSequence

Supports waveform sequencing.

Definition at line 86 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ hasVbatCompensation

uint8_t HapticCapabilities::hasVbatCompensation

Supports automatic voltage compensation.

Definition at line 84 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ maxDurationMs

uint16_t HapticCapabilities::maxDurationMs

Maximum vibration duration in ms (0 = unlimited)

Definition at line 94 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ maxEffectCount

uint8_t HapticCapabilities::maxEffectCount

Maximum number of effect IDs supported.

Definition at line 92 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().

◆ maxSequenceLength

uint8_t HapticCapabilities::maxSequenceLength

Maximum waveform sequence length.

Definition at line 93 of file HapticDefs.hpp.

Referenced by HapticDriver_AW86224::getCapabilities(), and HapticDriver_DRV2605::getCapabilities().


The documentation for this struct was generated from the following file: