okolib.h

 
#ifndef _OKOLIB_H_
#define _OKOLIB_H_
 
#ifdef _MSC_VER
    #if _MSC_VER >= 1600
        #include <stdint.h>
    #else
        typedef __int8              int8_t;
        typedef __int16             int16_t;
        typedef __int32             int32_t;
        typedef __int64             int64_t;
        typedef unsigned __int8     uint8_t;
        typedef unsigned __int16    uint16_t;
        typedef unsigned __int32    uint32_t;
        typedef unsigned __int64    uint64_t;
    #endif
#elif __GNUC__ >= 3
    #include <stdint.h>
#endif
 
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef _WIN32
 
#if defined(OKO_NO_DLL)             /* Static import */
#  define OKO_API
#elif defined(OKO_BUILDING_DLL)     /* DLL export    */
#  define OKO_API __declspec (dllexport)
#else                               /* DLL import    */
#  define OKO_API __declspec (dllimport)
#endif /* Not BUILDING_DLL */
 
/* Define calling convention in one place, for convenience. */
#define OKO_EXPORT __cdecl
 
/* Microsoft VBA */
#ifdef OKO_VBA
#undef OKO_EXPORT
#define OKO_EXPORT __stdcall
#endif
 
#else /* _WIN32 not defined. */
 
/* Define with no value on non-Windows OSes. */
#define OKO_API
#define OKO_EXPORT
 
#endif
 
typedef enum _oko_res_type
{
    OKO_OK                  =  0,   
    OKO_ERR_UNINIT          = -1,   
    OKO_ERR_ARG             = -2,   
    OKO_ERR_FAIL            = -3,   
    OKO_ERR_NOTSUPP         = -4,   
    OKO_ERR_CLOSED          = -5,   
    OKO_ERR_UNCONN          = -6,   
    OKO_ERR_PORT_BUSY       = -7,   
    OKO_ERR_PORT_CFG        = -8,   
    OKO_ERR_PORT_NOTVALID   = -9,   
    OKO_ERR_DB_OPEN         = -10,  
    OKO_ERR_PROP_NOTFOUND   = -11,  
    OKO_ERR_DEV_NOTFOUND    = -12,  
    OKO_ERR_COMM            = -13,  
    OKO_ERR_ENUM_NOTFOUND   = -14,  
    OKO_ERR_MODULE_NOTFOUND = -15,  
    OKO_ERR_DEV_SLAVE       = -16,  
    OKO_ERR_DEV_NOTRUNNING  = -17,  
    OKO_ERR_MEMORY          = -18,  
    OKO_ERR_TIMEOUT         = -19,  
    OKO_ERR_UNDEF           = -999, 
} oko_res_type;
 
OKO_API oko_res_type OKO_EXPORT
#ifdef __LINUX__
oko_LibInit(char *db_path);
#else
oko_LibInit(const char *db_path);
#endif
 
OKO_API oko_res_type OKO_EXPORT
oko_LibShutDown();
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetVersion(char *version);
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetLastError(char *errmsg, unsigned int maxsize);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_LibSetSuggestedUSBOnly(bool use);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetSuggestedUSBOnly(bool *use);
 
 
 
 
typedef enum _oko_module_type
{
    OKO_MODULE_TEMP     = 0,    
    OKO_MODULE_CO2      = 1,    
    OKO_MODULE_O2       = 2,    
    OKO_MODULE_HMD      = 3,    
    OKO_MODULE_MAXNUM           
} oko_module_type;
 
 
OKO_API oko_res_type OKO_EXPORT
oko_ModulesDetect(uint32_t max_num, oko_module_type *modules, uint32_t *detected_num);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModulesDetectSelected(const oko_module_type *selected_modules,
        uint32_t selected_modules_num, oko_module_type *modules, uint32_t *detected_num);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleGetDetails(oko_module_type module, char *name, char *dim_unit, bool *can_disable);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleGetCurrentValue(oko_module_type module, double *current_value);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleGetSetpointValue(oko_module_type module, double *setpoint_value);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleGetLimits(oko_module_type module, double *min_value, double *max_value);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleSetSetpointValue(oko_module_type module, double setpoint_value);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleGetEnabled(oko_module_type module, bool *enabled);
 
OKO_API oko_res_type OKO_EXPORT
oko_ModuleSetEnabled(oko_module_type module, bool enabled);
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetNumberOfPorts(uint32_t *count);
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetPortNames(char **names);
 
OKO_API oko_res_type OKO_EXPORT
oko_LibGetPortName(uint32_t portidx, char *portname);
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceOpen(const char *port, uint32_t *deviceh);
 
OKO_API oko_res_type OKO_EXPORT
oko_DevicesDetect(uint32_t max_num,  uint32_t *devicesh, uint32_t *detected_num);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DevicesDetectByName(uint32_t max_num,  uint32_t *devicesh, char *name_filter, uint32_t *detected_num);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceDetectSingle(uint32_t *deviceh);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceDetectSingleByName(uint32_t *deviceh, char *name_filter);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceClose(uint32_t deviceh);
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceGetLastError(uint32_t deviceh, char *errmsg, unsigned int maxsize);
 
OKO_API oko_res_type OKO_EXPORT
oko_DevicesCloseAll(void);
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceGetPortName(uint32_t deviceh, char *port);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceConnectionStatus(uint32_t deviceh, uint32_t *conn);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceSetChecksumUsage(uint32_t deviceh, bool use_checksum);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceGetChecksumUsage(uint32_t deviceh, bool *use_checksum);
 
OKO_API oko_res_type OKO_EXPORT
oko_DeviceGetChecksumAvailable(uint32_t deviceh, bool *checksum);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertiesGetNumber(uint32_t deviceh, uint32_t *num);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetName(uint32_t deviceh, uint32_t index, char *name);
 
typedef enum _oko_prop_type
{
    OKO_PROP_UNDEF  = 0,    
    OKO_PROP_STRING = 1,    
    OKO_PROP_INT    = 2,    
    OKO_PROP_DOUBLE = 3,    
    OKO_PROP_ENUM   = 4,    
} oko_prop_type;
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetType(uint32_t deviceh, const char *name, oko_prop_type *prop_type);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetEnumNumber(uint32_t deviceh, const char *name, unsigned int *num);
 
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetEnumName(uint32_t deviceh, const char *name, uint32_t enum_val, char *enum_name);
 
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetUnit(uint32_t deviceh, const char *name, char *unit);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetDescription(uint32_t deviceh, const char *name, char *desc);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetReadOnly(uint32_t deviceh, const char *name, bool *read_only);
 
typedef enum _oko_write_type
{
    OKO_WRITE_NONE      = 0,    
    OKO_WRITE_EEPROM    = 1,    
    OKO_WRITE_VOLATILE  = 2,    
    OKO_WRITE_BOTH      = 3,    
} oko_write_type;
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetWriteOnly(uint32_t deviceh, const char *name, bool *write_only);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetWriteType(uint32_t deviceh, const char *name, oko_write_type *write_type);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyHasLimits(uint32_t deviceh, const char *name, bool *has_limits);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyGetLimits(uint32_t deviceh, const char *name, double *min, double *max);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyIsMain(uint32_t deviceh, const char *name, bool *is_main);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyIsAdvanced(uint32_t deviceh, const char *name, bool *is_adv);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyReadString(uint32_t deviceh, const char *name, char *val);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyReadInt(uint32_t deviceh, const char *name, int32_t *val);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyReadDouble(uint32_t deviceh, const char *name, double *val);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyUpdate(uint32_t deviceh, const char *name);  // refresh, read ?
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteString(uint32_t deviceh, const char *name, const char *val, bool async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteInt(uint32_t deviceh, const char *name, int32_t val, char async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteDouble(uint32_t deviceh, const char *name, double val, char async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteVolatileString(uint32_t deviceh, const char *name, const char *val, bool async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteVolatileInt(uint32_t deviceh, const char *name, int32_t val, char async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyWriteVolatileDouble(uint32_t deviceh, const char *name, double val, char async);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyAutoUpdate(uint32_t deviceh, const char *name, uint32_t freq_ms);
 
OKO_API oko_res_type OKO_EXPORT
oko_StartPropertyLogging(uint32_t deviceh, const char *filename, uint32_t freq_ms);
 
OKO_API oko_res_type OKO_EXPORT
oko_StopPropertyLogging(uint32_t deviceh);
 
OKO_API oko_res_type OKO_EXPORT
oko_PropertyLoggingGetFileName(uint32_t deviceh, char *filename);
 
OKO_API oko_res_type OKO_EXPORT
oko_StartPlayback(uint32_t deviceh, const char *filename);
 
OKO_API oko_res_type OKO_EXPORT
oko_StopPlayback(uint32_t deviceh);
 
OKO_API oko_res_type OKO_EXPORT
oko_PlaybakGetFileName(uint32_t deviceh, char *filename);
 
OKO_API oko_res_type OKO_EXPORT
oko_CommandExecute(uint32_t deviceh, const char *name);
 
 
OKO_API oko_res_type OKO_EXPORT
oko_OkolabSetDebugPropertiesUsage(bool debug_properties);
 
OKO_API oko_res_type OKO_EXPORT
oko_OkolabGetLastProtocolError(uint32_t deviceh, const char *name, int *err);
#ifdef __cplusplus
}
#endif
 
#endif /* _OKOLIB_H_ */