owwl.h

Go to the documentation of this file.

/* owwl.h */


/* Dr. Simon J. Melhuish */

/* Types for sensor data */

#ifndef OWWL_H
#define OWWL_H 1

#include <time.h>

#ifndef SOCKET
#define SOCKET int
#endif

/* #define OWWL_DEBUG 1 */
#define OWW_PROTO_VERSION 101L 
enum owwl_unit_class_enum {
  owwl_unit_class_unknown = -1,      
  owwl_unit_class_dimensionless = 0, 
  owwl_unit_class_time,              
  owwl_unit_class_count,             
  owwl_unit_class_count_rate,        
  owwl_unit_class_length,            
  owwl_unit_class_length_rate,       
  owwl_unit_class_speed,             
  owwl_unit_class_temperature,       
  owwl_unit_class_pressure,          
  owwl_unit_class_direction,         
  owwl_unit_class_humidity,          
  owwl_unit_class_voltage,           
  owwl_unit_class_muvoltage,         
  owwl_unit_class_nanocurrent,       
  owwl_unit_class_cryo,              
  owwl_unit_class_resistance,        
  OWWL_UNIT_CLASS_LIMIT
} ;
/* #defines for units */

#define OwwlUnit_Metric   0 
#define OwwlUnit_Imperial 1 
#define OwwlUnit_Alt1     2 
#define OwwlUnit_Alt2     3 
#define OwwlUnit_Celcius    OwwlUnit_Metric
#define OwwlUnit_Fahrenheit OwwlUnit_Imperial
#define OwwlUnit_Kelvin     OwwlUnit_Alt1
#define OwwlUnit_Rankine    OwwlUnit_Alt2

#define OwwlUnit_CryoKelvin     OwwlUnit_Metric
#define OwwlUnit_CryoRankine    OwwlUnit_Imperial
#define OwwlUnit_CryoCelcius    OwwlUnit_Alt1
#define OwwlUnit_CryoFahrenheit OwwlUnit_Alt2

#define OwwlUnit_Mm         OwwlUnit_Metric   
#define OwwlUnit_Inch       OwwlUnit_Imperial 
#define OwwlUnit_Kph        OwwlUnit_Metric   
#define OwwlUnit_Mph        OwwlUnit_Imperial 
#define OwwlUnit_Mps        OwwlUnit_Alt1     
#define OwwlUnit_Knot       OwwlUnit_Alt2     
#define OwwlUnit_Mbar       OwwlUnit_Metric   
#define OwwlUnit_InchHg     OwwlUnit_Imperial 
#define OwwlUnit_Kpa        OwwlUnit_Alt1     
#define OwwlUnit_Atm        OwwlUnit_Alt2     
#define OwwlUnit_Bearing OwwlUnit_Metric     
#define OwwlUnit_Point16 OwwlUnit_Imperial   
#define OwwlUnit_Name    OwwlUnit_Alt1       
#define OwwlUnit_Radians OwwlUnit_Alt2       
enum owwl_device_type_enum {
  OwwlDev_Any = -1,        
  OwwlDev_Temperature = 0, 
  OwwlDev_Barometer,       
  OwwlDev_Humidity,        
  OwwlDev_Wind,            
  OwwlDev_Rain,            
  OwwlDev_Gpc,             
  OwwlDev_Solar,           
  OwwlDev_Psb = 64,        
  OwwlDev_Diode,           
  OwwlDev_Grt,             
  OwwlDev_Cryo,            
  OwwlDev_Heater,          
  OwwlDev_Resistance,      
  OwwlDev_Invalid
} ;

#define OwwlSubtype_Any -1    
#define OwwlSubtype_Default 0 
enum owwl_temperature_subtype_enum {
  OwwlTemp_Any = OwwlSubtype_Any, 
  OwwlTemp_Thermometer = OwwlSubtype_Default, 
  OwwlTemp_Humidity, 
  OwwlTemp_Barometer 
} ;
typedef struct {
  float T ;          
  float padding[9] ;
} owwl_data_temperature ;

typedef struct {
  float bp ;          
  float padding[9] ;
} owwl_data_barometer ;

typedef struct {
  float RH ;          
  float padding[9];
} owwl_data_humidity ;

typedef struct {
  float solar ;       
  float padding[9];
} owwl_data_solar ;

typedef struct {
  float speed ;      
  float gust ;       
  float bearing ;    
  float padding[7] ;
} owwl_data_wind ;

typedef struct {
  unsigned int rain_count ; 
  time_t rain_reset_time ;  
  float  rain_since_reset ; 
  float  rain_rate ;        
  float  padding[6] ;
} owwl_data_rain ;

typedef struct {
  unsigned int gpc_count ;
  time_t gpc_reset_time ; 
  float  gpc_calibrated ; 
  float  gpc_rate ;       
  float  gpc_delta ;      
  float  padding[5] ;
} owwl_data_gpc ;

typedef struct {
  int  psb_a ;            
  int  psb_b ;            
  float  padding[8] ;
} owwl_data_psb ;

typedef struct {
  float  V ;            
  float  padding[9] ;
} owwl_data_diode ;

typedef struct {
  float  V ;             
  float  Vq ;            
  float  I ;             
  float  padding[7] ;
} owwl_data_grt ;

typedef struct {
  float T ;          
  float padding[9] ;
} owwl_data_cryo ;

typedef struct {
  float  V ;            
  float  padding[9] ;
} owwl_data_heater ;

typedef struct {
        float  R ;            
        float  padding[9] ;
} owwl_data_resistance ;

enum owwl_cryo_subtype_enum {
  OwwlCryo_Any = OwwlSubtype_Any, 
  OwwlCryo_Thermometer = OwwlSubtype_Default, 
  OwwlCryo_Diode, 
  OwwlCryo_Grt 
} ;
typedef struct {
  float floats[10] ;
} owwl_data_floats ;
typedef union {
    owwl_data_temperature temperature ; 
    owwl_data_humidity    humidity ;    
    owwl_data_wind        wind ;        
    owwl_data_rain        rain ;        
    owwl_data_gpc         gpc ;         
    owwl_data_barometer   barom ;       
    owwl_data_solar       solar ;       
    owwl_data_psb         psb ;         
    owwl_data_diode       diode ;       
    owwl_data_grt         grt ;         
    owwl_data_cryo        cryo ;        
    owwl_data_heater      heater ;      
    owwl_data_resistance  resistance ;  
    owwl_data_floats      floats ;      
} device_data_union ; 

typedef struct owwl_data_ {
  int device_type ; 
  device_data_union device_data ;   
  int device_subtype     ; 
  int index ; 
  int in_use ; 
  void *user_data ; 
  char * (*str)(struct owwl_data_ *self, char *buffer, int bufflen, int unit_type, int precision, int arg) ;
  double (*val)(struct owwl_data_ *self, int unit_type, int arg) ;
  /* char * (*unit)(struct owwl_data_ *self, int unit_type, int arg) ; */
  /* int (*next_arg)(struct owwl_data_ *self, int arg) ; */
} owwl_data ;
typedef struct owwl_client_ {
  struct owwl_client_ *prev ; 
  struct owwl_client_ *next ; 
  SOCKET socket ;                     
} owwl_client ;

typedef struct owwl_server_ {
  SOCKET socket_listen ;              
  owwl_client *first_client ;      
} owwl_server ;
struct readstr {
  int data_size ;
  int data_to_get ;
  unsigned long data_word_n[16] ;
  int state ;
} ;

typedef struct {
  SOCKET socket ;       
  int read_result ;     
  time_t data_time ;    
  long data_time_usec;  
  int interval ;        
  float longitude ;     
  float latitude ;      
  owwl_data *data ;     
  int data_count ;      
  void *user_data ;     
  owwl_server *server ; 
  int nserver ;         
  struct readstr rd ;   
} owwl_conn ;

typedef struct {
  unsigned long *buffer ; 
  int next ;       
  int size ;       
} owwl_buffer ;

#define OwwlBuffInc 16 
#define Owwl_Buffer_Init {(unsigned long *) NULL, 0, 0}

typedef int (*owwl_func) (owwl_conn *conn, owwl_data *data, void *user_data) ;

enum owwl_read_result {
  Owwl_Read_Disconnect = -2,      
  Owwl_Read_Error = -1,           
  Owwl_Read_Read_And_Decoded = 0, 
  Owwl_Read_Again                 
} ;
/* Header Word Codes */
#define OWW_TRX_END              0L 
#define OWW_TRX_TIME     0x1000000L 
#define OWW_TRX_WIND     0x2000000L 
#define OWW_TRX_RAIN     0x3000000L 
#define OWW_TRX_T        0x4000000L 
#define OWW_TRX_RH       0x6000000L 
#define OWW_TRX_BP       0x7000000L 
#define OWW_TRX_SOLAR    0xb000000L 
#define OWW_TRX_PSB     0x10000000L 
#define OWW_TRX_DIODE   0x11000000L 
#define OWW_TRX_GRT     0x12000000L 
#define OWW_TRX_CRYO    0x13000000L 
#define OWW_TRX_HEATER  0x14000000L 
#define OWW_TRX_RESISTANCE  0x15000000L 
#define OWW_TRX_UPDT    0x80000000L 
#define OWW_TRX_GPC     0x90000000L 
#define OWW_TRX_LOC     0xa0000000L 
#define OWW_TRX_HEAD    0xff000000L 
#define OWW_TRX_SUB_TRH    0x10000L 
#define OWW_TRX_SUB_TB     0x20000L 
#define OWW_TRX_SUB_TCD    0x10000L 
#define OWW_TRX_SUB_TCG    0x20000L 
#define OWW_TRX_SERIAL       0x100L 
#define OWW_TRX_SIZE             1L 
#define OWW_TRX_MSG_WSDATA 1 
#define OWW_TRX_MSG_UPDT   2 
#define OWW_TRX_MSG_MORT   3 
#define OWW_TRX_MSG_ANNOUN 4 
/* Type numbers for devices */
/* These are derived from the values used in oww_trx */

enum owwl_device_types {
  dummy = 0
} ;

/* ----------------------------------------------------------------------------- */

/* Function prototypes */

owwl_conn *
owwl_new_conn(int socket, void *user_data) ;

int
owwl_read(owwl_conn *conn) ;

int
owwl_free(owwl_conn *conn) ;

unsigned int
owwl_data_arg_to_id(owwl_data *data, int arg) ;

void
owwl_id_to_data_arg(owwl_conn *conn, unsigned int id, owwl_data **data, int *arg) ;


int
owwl_foreach(owwl_conn *conn, owwl_func func, void *user_data) ;

int
owwl_foreach_ordered(owwl_conn *conn, owwl_func func, void *user_data) ;

char *
owwl_name(owwl_data *data, char *buffer, int bufflen, int *length, int long_not_short) ;

char *
owwl_arg_stem(enum owwl_device_type_enum device_type, int device_subtype, int arg) ;

char *
owwl_arg_name(owwl_data *data, char *buffer, int bufflen, int *length, int long_not_short, int arg) ;

enum owwl_unit_class_enum owwl_unit_class(owwl_data *data, int arg) ;

char *owwl_unit_name(owwl_data *data, int unit_type, int arg) ;

char *owwl_unit_desc(owwl_data *data, int unit_type, int arg) ;

int owwl_next_arg(owwl_data *data, int arg) ;

owwl_data *
owwl_find(owwl_conn *conn, 
          enum owwl_device_type_enum device_type, 
          int device_subtype, 
          int index) ;

owwl_data *
owwl_find_first(owwl_conn *conn, 
                enum owwl_device_type_enum device_type, 
                int device_subtype) ;

int
owwl_tx_build(owwl_conn *conn, int msg_type, owwl_buffer *buff) ;
  
int
owwl_data_in(
  owwl_conn *conn, 
  enum owwl_device_type_enum device_type, 
  int device_subtype,
  int index,
  ...) ;
  
  
int
owwl_tx_new_server(owwl_conn *conn, SOCKET socket) ;

int
owwl_tx(owwl_conn *conn, owwl_buffer *buff) ;

void
owwl_tx_add_timestamp(owwl_conn *conn) ;

int
owwl_tx_poll_servers(owwl_conn *conn) ;

#endif

---