servo_source.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sense_link.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define SERVO_SOURCE_FRESH_MS  200u
#define SERVO_SOURCE_SETTLE_MS 1000u
#define SERVO_SOURCE_EVENT_GAP_MS 5000u

typedef enum {
    SERVO_SOURCE_PDMINI  = 0,
    SERVO_SOURCE_INA3221 = 1,
    SERVO_SOURCE_MODEL   = 2,   
} servo_source_id_t;

typedef enum {
    SERVO_SOURCE_WHY_NONE = 0,   
    SERVO_SOURCE_WHY_NO_LINK,    
    SERVO_SOURCE_WHY_OFF,        
    SERVO_SOURCE_WHY_OLD,        
    SERVO_SOURCE_WHY_NOT_HELD,   
    SERVO_SOURCE_WHY_SILENT,     
    SERVO_SOURCE_WHY_NO_WINDOW,  
    SERVO_SOURCE_WHY_RESET,      
    SERVO_SOURCE_WHY_SETTLING,   
} servo_source_why_t;

enum {
    SERVO_SOURCE_EV_OLD   = 0x01,
    SERVO_SOURCE_EV_RESET = 0x02,
};

typedef struct {
    servo_source_id_t  id;
    servo_source_why_t why;
    uint32_t changes;       
    servo_source_why_t dropped;  
    uint32_t dropped_at;    
    bool     up;            
    bool     good;          
    uint32_t good_ms;       
    bool     resets_known;  
    bool     reset_step;    
    uint8_t  resets;        
    uint16_t setups;        
    bool     old_told;      
    uint32_t events;                    
    bool     event_given;               
    uint32_t event_ms;                  
} servo_source_t;

void servo_source_init(servo_source_t *s);

servo_source_id_t servo_source_step(servo_source_t *s, uint32_t now_ms,
                                    bool link_up, uint16_t minor,
                                    const sense_link_meter_t *m);

servo_source_id_t servo_source_id(const servo_source_t *s);

uint32_t servo_source_changes(const servo_source_t *s);

servo_source_why_t servo_source_why(const servo_source_t *s);

servo_source_why_t servo_source_dropped(const servo_source_t *s,
                                        uint32_t *at);

uint32_t servo_source_event(servo_source_t *s, uint32_t now_ms);

void servo_source_event_back(servo_source_t *s, uint32_t ev);
 
#ifdef __cplusplus
}
#endif