twr_module_relay.h

#ifndef _TWR_MODULE_RELAY_H
#define _TWR_MODULE_RELAY_H
 
#include <twr_tca9534a.h>
#include <twr_scheduler.h>
 
#define TWR_MODULE_RELAY_I2C_ADDRESS_DEFAULT 0x3B
#define TWR_MODULE_RELAY_I2C_ADDRESS_ALTERNATE 0x3F
 
 
 
typedef enum
{
    TWR_MODULE_RELAY_STATE_UNKNOWN = -1,
 
    TWR_MODULE_RELAY_STATE_FALSE = 0,
 
    TWR_MODULE_RELAY_STATE_TRUE = 1
 
} twr_module_relay_state_t;
 
 
typedef struct twr_module_relay_t twr_module_relay_t;
 
 
typedef enum
{
    TWR_MODULE_RELAY_TASK_STATE_IDLE,
    TWR_MODULE_RELAY_TASK_STATE_SET,
    TWR_MODULE_RELAY_TASK_STATE_SET_DEMAGNETIZE,
    TWR_MODULE_RELAY_TASK_STATE_PULSE,
    TWR_MODULE_RELAY_TASK_STATE_PULSE_DEMAGNETIZE,
    TWR_MODULE_RELAY_TASK_STATE_PULSE_REVERSE,
    TWR_MODULE_RELAY_TASK_STATE_PULSE_DEMAGNETIZE_2
 
} twr_module_relay_task_state_t;
 
typedef enum
{
    TWR_MODULE_RELAY_COMMAND_NONE = 0,
    TWR_MODULE_RELAY_COMMAND_SET = 1,
    TWR_MODULE_RELAY_COMMAND_PULSE = 2
 
} twr_module_relay_command_t;
 
struct twr_module_relay_t
{
    uint8_t _i2c_address;
    twr_tca9534a_t _tca9534a;
    twr_module_relay_state_t _relay_state;
    twr_tick_t _timestamp;
    twr_scheduler_task_id_t _task_id;
    twr_module_relay_task_state_t _state;
    twr_module_relay_command_t _command;
    twr_module_relay_state_t _desired_state;
    twr_tick_t _pulse_duration;
    bool _task_is_active;
    bool _error;
};
 
 
 
bool twr_module_relay_init(twr_module_relay_t *self, uint8_t i2c_address);
 
 
void twr_module_relay_set_state(twr_module_relay_t *self, bool state);
 
 
twr_module_relay_state_t twr_module_relay_get_state(twr_module_relay_t *self);
 
 
void twr_module_relay_pulse(twr_module_relay_t *self, bool direction, twr_tick_t duration);
 
 
void twr_module_relay_toggle(twr_module_relay_t *self);
 
 
#endif // _TWR_MODULE_RELAY_H