rrh46410.h

Go to the documentation of this file.

#ifndef RRH46410_H
#define RRH46410_H

#include <stdint.h>
#include "hal/hal.h"

typedef enum {
  omSuspend    = 0x00,   
  omIAQ2       = 0x01,   
  omIAQ2_ULP   = 0x02,   
  omPBAQ       = 0x05,   
  omCleaning   = 0x80,   
  omUnknown    = 0xff    
} RRH46410_OperatingMode_t;


typedef enum {
  cmdGetSensorInfo     = 0x00,   
  cmdGetTrackingNumber = 0x01,   
  cmdGetOperatingMode  = 0x10,   
  cmdSetOperatingMode  = 0x11,   
  cmdSetHumidity       = 0x12,   
  cmdGetResults        = 0x18,   
  cmdSetGPIOConfig     = 0x20,   
  cmdGetGPIOState      = 0x21,   
  cmdSetOutputHigh     = 0x22,   
  cmdSetOutputLow      = 0x23,   
  cmdGetDebugData      = 0x31,   
  cmdSoftwareReset     = 0x8f    
} RRH46410_Commands_t;

typedef struct {
  uint8_t  sampleID;    
} RRH46410_Common_Results_t;


typedef struct {
  uint8_t   sampleID;   
  uint8_t   iaq;        
  uint16_t  tvoc;       
  uint16_t  etoh;       
  uint16_t  eco2;       
  uint8_t   rel_IAQ;    
} RRH46410_IAQ2_Results_t;


typedef struct {
  uint8_t   sampleID;   
  uint16_t  tvoc;       
  uint16_t  etoh;       
} RRH46410_PBAQ_Results_t;



typedef union {
  RRH46410_Common_Results_t     common; 
  RRH46410_IAQ2_Results_t       iaq2;   
  RRH46410_PBAQ_Results_t       pbaq;   
} RRH46410_Results_t;


typedef union {
  uint8_t  sampleID;         
  uint8_t  raw [ 100 ];      
} RRH46410_Debug_t;


typedef enum {
  /* sensor generated  errors */
  ecWarmup                = 0x01,   
  ecCleaningCountExceeded = 0x08,   
  ecPOR                   = 0x09,   
  ecDamage                = 0x0a,   
  ecDataNotReady          = 0x10,   
  ecInternalComm          = 0x20,   
  ecHostToSensorCheckusm  = 0x40,   
  ecInvalidCommand        = 0x80,   
  /* locally generated errors */
  ecSampleNotNew          = 0x100,  
  ecSensorToHostChecksum  = 0x101,  
  ecCleaningTimeout       = 0x102,  
  ecGPIOConfigInvalid     = 0x103   
} RRH46410_ErrorCodes_t;


typedef struct {
  Interface_t*              hal;                  
  uint8_t                   i2cAddress;           
  RRH46410_OperatingMode_t  operatingMode;        
  uint8_t                   resultsLength;        
  uint8_t                   debugLength;          
  uint32_t                  measurementInterval;  
  uint8_t                   recentsampleID;       
  uint8_t                   remainingWarmup;      
} RRH46410_t;


typedef struct {
  uint16_t                  productId;            
  uint8_t                   trackingNumber [ 6 ]; 
  struct {
    uint8_t  major;
    uint8_t  minor;
    uint8_t  patch;
  }                         fwVersion;            
} RRH46410_SensorInfo_t;


int  RRH46410_Init ( RRH46410_t*  sensor, Interface_t*  hal );

int  RRH46410_GetSensorInfo ( RRH46410_t*  sensor, RRH46410_SensorInfo_t*  info );

int  RRH46410_ReadOperatingMode ( RRH46410_t*  sensor );


int  RRH46410_SetOperatingMode  ( RRH46410_t*  sensor, RRH46410_OperatingMode_t  mode );


int  RRH46410_SetHumidity ( RRH46410_t*  sensor, float  humidity );


int  RRH46410_ReadResults ( RRH46410_t*  sensor, void*  result );


int  RRH46410_ReadDebug ( RRH46410_t*  sensor, void*  result );


int  RRH46410_PerformCleaning ( RRH46410_t*  sensor );


int  RRH46410_Reset ( RRH46410_t*  sensor );


int  RRH46410_SoftReset ( RRH46410_t*  sensor );


int  RRH46410_ConfigureGPIO     ( RRH46410_t*  sensor, uint8_t   outputMask );


int  RRH46410_WriteGPIO         ( RRH46410_t*  sensor, uint8_t   mask,  uint8_t  state );


int  RRH46410_ReadGPIO          ( RRH46410_t*  sensor, uint8_t*  state );


#endif /* RRH46410_H */