ZAF_Actuator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef ZAF_ACTUATOR_H
#define ZAF_ACTUATOR_H
 
#include <SwTimer.h>
 
struct actuator;
typedef void(*zaf_actuator_callback_t)(struct actuator *pActuator);
 
typedef struct actuator {
    uint32_t defaultRefreshRate; 
    uint32_t refreshRate;        
    uint8_t min;                 
    uint8_t max;                 
    SSwTimer timer;              
    uint16_t valueCurrent;       
    uint16_t valueTarget;        
    zaf_actuator_callback_t cc_cb;         
    uint16_t singleStepValue;    
    bool directionUp;            
    uint8_t lastOnValue;         
    uint8_t durationDefault;     
} s_Actuator;
 
typedef enum _eActuatorState{
  EACTUATOR_NOT_CHANGING,  
  EACTUATOR_CHANGING,      
  EACTUATOR_FAILED         
}eActuatorState;
 
void ZAF_Actuator_Init(s_Actuator *pActuator,
                       uint8_t minValue,
                       uint8_t maxValue,
                       uint16_t refreshRate,
                       uint8_t durationDefault,
                       zaf_actuator_callback_t cc_callback);
eActuatorState ZAF_Actuator_Set(s_Actuator *pActuator, uint8_t value, uint8_t duration);
 
eActuatorState ZAF_Actuator_StartChange(s_Actuator *pActuator,
                                        bool ignoreStartLevel,
                                        bool upDown,
                                        uint8_t startLevel,
                                        uint8_t duration);
 
eActuatorState ZAF_Actuator_StopChange(s_Actuator *pActuator);
 
uint8_t ZAF_Actuator_GetCurrentValue(s_Actuator *pActuator);
 
uint8_t ZAF_Actuator_GetTargetValue(s_Actuator *pActuator);
 
uint8_t ZAF_Actuator_GetDurationRemaining(s_Actuator *pActuator);
 
uint8_t ZAF_Actuator_GetLastOnValue(s_Actuator *pActuator);
 
uint32_t getDurationInMs(uint8_t duration);
 
uint8_t ZAF_Actuator_GetMax(s_Actuator *pActuator);
 
#endif /* ZAF_ACTUATOR_H */