esc_profile.h

Go to the documentation of this file.

 
#ifndef RCBENCH_ESC_PROFILE_H
#define RCBENCH_ESC_PROFILE_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define ESC_PROFILE_SCHEMA 1u

#define ESC_PROFILE_MAX_BYTES 65536u

#define ESC_PROFILE_MAX_OVERRIDES 32u

#define ESC_MAKER_MODELS_MAX 512u

typedef enum {
    ESC_SCHEME_COUNT = 0,       
    ESC_SCHEME_SHORT_LONG,      
    ESC_SCHEME_MELODY_GROUPS,   
    ESC_SCHEME_YES_NO,          
    ESC_SCHEME_STICK_POSITION,  
    ESC_SCHEME_OTHER,
} esc_scheme_t;

typedef enum {
    ESC_ENC_COUNT = 0,
    ESC_ENC_SHORT_LONG,
    ESC_ENC_MELODY,
    ESC_ENC_YES_NO,
} esc_encoding_t;

typedef enum {
    ESC_AUTO_FULL = 0,          
    ESC_AUTO_ASSISTED,          
    ESC_AUTO_NONE,              
} esc_auto_t;

typedef enum {
    ESC_THR_MIN = 0,
    ESC_THR_MID,
    ESC_THR_MAX,
    ESC_THR_NONE,               
} esc_throttle_t;

typedef enum {
    ESC_ANNOUNCE_ITEM = 0,
    ESC_ANNOUNCE_VALUE,
    ESC_ANNOUNCE_ITEM_THEN_VALUE,
} esc_announce_t;

typedef struct {
    const char *name;
    uint8_t     cells_min;      
    uint8_t     cells_max;      
    bool        nimh;           
    uint32_t    v_max_mv;       
    uint16_t    current_a;      
    uint32_t    v_min_mv;       
} esc_model_t;

#define ESC_AFTER_MAX 4u

typedef struct {
    const char *name;
    uint8_t     number;         
    bool        is_default;             
    esc_throttle_t entry_throttle;
    uint32_t       entry_hold_ms;
    uint8_t        after_count;
    esc_throttle_t after[ESC_AFTER_MAX];
} esc_value_t;

typedef struct {
    const char        *name;
    const char        *key;     
    uint8_t            number;  
    uint8_t            value_count;     
    const esc_value_t *values;          
    uint8_t            applies_count;
    const char *const *applies_to;
    const char        *applies_when;
} esc_item_t;

typedef enum {
    ESC_MANUAL_BEFORE_POWER = 0,  
    ESC_MANUAL_AT_POWER_UP,       
    ESC_MANUAL_BEFORE_MENU,       
    ESC_MANUAL_DURING_MENU,       
    ESC_MANUAL_BEFORE_POWER_OFF,  
    ESC_MANUAL_AFTER_PROGRAMMING, 
} esc_manual_when_t;

#define ESC_MANUAL_ACTION_MAX 120u
#define ESC_MANUAL_MAX 4u

typedef struct {
    esc_manual_when_t when;
    const char       *action;
    uint32_t          hold_ms;  
    const char       *action_de;
    bool              starts_menu;
    bool              locks;
} esc_manual_t;

typedef struct {
    const char        *id;      
    const char        *brand;           
    const char        *family;          
    esc_scheme_t       scheme;          
    esc_encoding_t     encoding;        
    esc_announce_t     announce;        
    esc_auto_t         automatable;     
    const char        *automatable_note;   
    esc_throttle_t     entry_throttle;  
    bool               entry_after_power;  
    uint32_t           entry_hold_ms;      
    esc_throttle_t     select_throttle;  
    uint32_t           select_within_ms;   
    esc_throttle_t     value_select_throttle;
    uint32_t           value_select_within_ms; 
    esc_throttle_t     skip_throttle;   
    esc_throttle_t     listen_throttle;
    esc_throttle_t     store_throttle;
    uint8_t            long_equals_short;  
    uint32_t           beep_ms;            
    uint32_t           gap_ms;             
    uint32_t           group_gap_ms;       
    int16_t            repeat;             
    bool               one_change_per_entry;  
    bool               verified;           
    uint8_t            step_count;      
    const char *const *steps;              
    uint16_t           model_count;     
    const esc_model_t *models;          
    uint8_t            item_count;      
    const esc_item_t  *items;           
    uint8_t            manual_count;
    const esc_manual_t *manual;
} esc_profile_t;
 
/* ------------------------------------------------------------ built in */

extern const esc_profile_t esc_profiles_builtin[];
extern const size_t        esc_profiles_builtin_count;
 
/* ------------------------------------------------------------ the card */

bool esc_profile_parse(const char *json, size_t len, esc_profile_t *out,
                       void **block, char *err, size_t err_size);

bool esc_profile_file_is(const char *file_name, const char *id);
 
/* -------------------------------------------------------- the registry */

bool esc_profiles_override(const esc_profile_t *p, void *block);

bool esc_profiles_override_why(const esc_profile_t *p, void *block,
                               const char **why);

bool esc_brand_same(const char *a, const char *b);

void esc_profiles_clear_overrides(void);

size_t esc_profiles_override_count(void);

size_t esc_profiles_count(void);
const esc_profile_t *esc_profiles_at(size_t i);

const esc_profile_t *esc_profiles_find(const char *id);

bool esc_profiles_is_override(const esc_profile_t *p);
 
/* ------------------------------------------------------------- search */

bool esc_text_matches(const char *text, const char *pattern);

bool esc_profile_matches(const esc_profile_t *p, const char *pattern);

bool esc_model_matches(const esc_profile_t *p, unsigned model,
                       const char *pattern);

bool esc_item_applies(const esc_profile_t *p, unsigned item, int model);

unsigned esc_profile_manual_count(const esc_profile_t *p,
                                  esc_manual_when_t when);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RCBENCH_ESC_PROFILE_H */