vigicrues.h

Go to the documentation of this file.

#ifndef VIGICRUES_H
#define VIGICRUES_H

#include <time.h>

#define VIGICRUES_MAJOR_VERSION 2

#define VIGICRUES_MINOR_VERSION 0

#define VIGICRUES_PATCH_VERSION 1

#define VIGICRUES_VERSION "2.0.1"

#define VIGICRUES_VERSION_HEX ((VIGICRUES_MAJOR_VERSION << 16) |  \
                               (VIGICRUES_MINOR_VERSION << 8)  |  \
                               (VIGICRUES_PATCH_VERSION << 0))

#define VIGICRUES_IGNORE_PARAM 0

#ifdef __cplusplus
extern "C" {
#endif

enum vigicrues_e {
  VIGICRUES_HEIGHT = 'H', 
  VIGICRUES_FLOW   = 'Q', 
  VIGICRUES_VIGILANCE = 'V' 
};

enum vigicrues_vigilance_e {
  VIGICRUES_VIGILANCE_GREEN, 
  VIGICRUES_VIGILANCE_YELLOW, 
  VIGICRUES_VIGILANCE_ORANGE, 
  VIGICRUES_VIGILANCE_RED 
};

typedef struct {
  enum vigicrues_e type; 
  float value; 
  enum vigicrues_vigilance_e vigilance; 
  time_t timestamp; 
} vigicrues_t;

typedef enum {
  VIGICRUES_ERROR_INVALID = 1, 
  VIGICRUES_ERROR_RANGE, 
  VIGICRUES_ERROR_OUTDATED, 
  VIGICRUES_ERROR_CANT_CONNECT, 
  VIGICRUES_ERROR_TIMEDOUT, 
  VIGICRUES_ERROR_CANCELED, 
  VIGICRUES_ERROR_OUT_OF_MEMORY, 
  VIGICRUES_ERROR_OTHER 
} vigicrues_error_t;

typedef enum {
  VIGICRUES_FAILURE = -1, 
  VIGICRUES_SUCCESS =  0 
} vigicrues_status_t;

typedef vigicrues_status_t (*vigicrues_f)(const vigicrues_t *p_data, void *param);

vigicrues_status_t vigicrues_get(unsigned ent, const char *id,
                                 enum vigicrues_e type, unsigned range,
                                 vigicrues_f func, void *param,
                                 unsigned timeout, vigicrues_error_t *p_error);

#ifdef __cplusplus
}
#endif

#endif