HapticBase.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "HapticDefs.hpp"
 
class HapticBase
{
public:
    virtual ~HapticBase() = default;
 
    // ==================== Lifecycle ====================
 
    virtual void end() {}
 
    virtual bool isReady() const = 0;
 
    // ==================== Playback Control ====================
 
    virtual bool run() = 0;
 
    virtual bool stop() = 0;
 
    virtual bool isPlaying() const = 0;
 
    virtual HapticStatus getStatus() const = 0;
 
    virtual void emergencyStop()
    {
        stop();
    }
 
    // ==================== Gain Control ====================
 
    virtual bool setGain(uint8_t gain) = 0;
 
    virtual uint8_t getGain() const = 0;
 
    // ==================== Effect Playback ====================
 
    virtual bool playEffect(HapticEffectId effect) = 0;
 
    virtual bool playEffectAsync(HapticEffectId effect)
    {
        return playEffect(effect);
    }
 
    virtual void continuousVibration(uint32_t duration_ms, bool blocking = true);
 
    virtual void vibrationUpdate() {}
 
    // ==================== Waveform Sequence ====================
 
    virtual bool setSequence(uint8_t slot, HapticEffectId effect)
    {
        (void)slot;
        (void)effect;
        return false;
    }
 
    virtual bool clearSequence()
    {
        return false;
    }
 
    virtual bool playSequence()
    {
        return false;
    }
 
    // ==================== Device Information ====================
 
    virtual const char *getChipName() const = 0;
 
    virtual uint8_t getChipID() const = 0;
 
    virtual HapticActuatorType getActuatorType() const = 0;
 
    virtual bool setActuatorType(HapticActuatorType type) = 0;
 
    virtual HapticCapabilities getCapabilities() const = 0;
 
    // ==================== Calibration ====================
 
    virtual bool calibrate()
    {
        return false;
    }
 
    virtual bool needsCalibration() const
    {
        return false;
    }
 
    virtual uint32_t getF0() const
    {
        return 0;
    }
 
    virtual uint32_t getVbat()
    {
        return 0;
    }
 
    // ==================== Mode Control ====================
 
    virtual bool setMode(HapticMode mode)
    {
        (void)mode;
        return false;
    }
 
    virtual HapticMode getMode() const
    {
        return HapticMode::INTERNAL_TRIGGER;
    }
 
    // ==================== RTP (Real-Time Playback) ====================
 
    virtual bool setRealtimeValue(uint8_t value)
    {
        (void)value;
        return false;
    }
 
protected:
    explicit HapticBase(const char* name) : _chipName(name), _isReady(false) {}
 
    void setReady(bool ready)
    {
        _isReady = ready;
    }
 
    const char *_chipName;
    bool _isReady;
};
 
 
inline void HapticBase::continuousVibration(uint32_t duration_ms, bool blocking)
{
    (void)duration_ms;
    (void)blocking;
}