Adafruit_Sensor.h

/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software< /span>
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and
 * extended sensor support to include color, voltage and current */

#ifndef _ADAFRUIT_SENSOR_H
#define _ADAFRUIT_SENSOR_H

#ifndef ARDUINO
#include <stdint.h>
#elif ARDUINO >= 100
#include "Arduino.h"
#include "Print.h"
#else
#include "WProgram.h"
#endif

/* Constants */
#define SENSORS_GRAVITY_EARTH (9.80665F) 
#define SENSORS_GRAVITY_MOON (1.6F)      
#define SENSORS_GRAVITY_SUN (275.0F)     
#define SENSORS_GRAVITY_STANDARD (SENSORS_GRAVITY_EARTH)
#define SENSORS_MAGFIELD_EARTH_MAX                                             \
  (60.0F) 
#define SENSORS_MAGFIELD_EARTH_MIN                                             \
  (30.0F) 
#define SENSORS_PRESSURE_SEALEVELHPA                                           \
  (1013.25F) 
#define SENSORS_DPS_TO_RADS                                                    \
  (0.017453293F) 
#define SENSORS_RADS_TO_DPS                                                    \
  (57.29577793F) 
#define SENSORS_GAUSS_TO_MICROTESLA                                            \
  (100) 
typedef enum {
  SENSOR_TYPE_ACCELEROMETER = (1), 
  SENSOR_TYPE_MAGNETIC_FIELD = (2),
  SENSOR_TYPE_ORIENTATION = (3),
  SENSOR_TYPE_GYROSCOPE = (4),
  SENSOR_TYPE_LIGHT = (5),
  SENSOR_TYPE_PRESSURE = (6),
  SENSOR_TYPE_PROXIMITY = (8),
  SENSOR_TYPE_GRAVITY = (9),
  SENSOR_TYPE_LINEAR_ACCELERATION =
      (10), 
  SENSOR_TYPE_ROTATION_VECTOR = (11),
  SENSOR_TYPE_RELATIVE_HUMIDITY = (12),
  SENSOR_TYPE_AMBIENT_TEMPERATURE = (13),
  SENSOR_TYPE_OBJECT_TEMPERATURE = (14),
  SENSOR_TYPE_VOLTAGE = (15),
  SENSOR_TYPE_CURRENT = (16),
  SENSOR_TYPE_COLOR = (17),
  SENSOR_TYPE_TVOC = (18),
  SENSOR_TYPE_VOC_INDEX = (19),
  SENSOR_TYPE_NOX_INDEX = (20),
  SENSOR_TYPE_CO2 = (21),
  SENSOR_TYPE_ECO2 = (22),
  SENSOR_TYPE_PM10_STD = (23),
  SENSOR_TYPE_PM25_STD = (24),
  SENSOR_TYPE_PM100_STD = (25),
  SENSOR_TYPE_PM10_ENV = (26),
  SENSOR_TYPE_PM25_ENV = (27),
  SENSOR_TYPE_PM100_ENV = (28)
} sensors_type_t;

typedef struct {
  union {
    float v[3]; 
    struct {
      float x; 
      float y; 
      float z; 
    };         
    /* Orientation sensors */
    struct {
      float roll; 
      float pitch;   
      float heading; 
    };               
  };                 
  int8_t status;     
  uint8_t reserved[3]; 
} sensors_vec_t;

typedef struct {
  union {
    float c[3]; 
    /* RGB color space */
    struct {
      float r;   
      float g;   
      float b;   
    };           
  };             
  uint32_t rgba; 
} sensors_color_t;

/* Sensor event (36 bytes) */
typedef struct {
  int32_t version;   
  int32_t sensor_id; 
  int32_t type;      
  int32_t reserved0; 
  int32_t timestamp; 
  union {
    float data[4];              
    sensors_vec_t acceleration; 
    sensors_vec_t
        magnetic; 
    sensors_vec_t orientation; 
    sensors_vec_t gyro;        
    float temperature; 
    float distance;    
    float light;       
    float pressure;    
    float relative_humidity; 
    float current;           
    float voltage;           
    float tvoc;              
    float voc_index; 
    float nox_index; 
    float CO2;       
    float eCO2;      
    float pm10_std;  
    float pm25_std;  
    float pm100_std; 
    float pm10_env;  
    float pm25_env;  
    float pm100_env; 
    sensors_color_t color; 
  };                       
} sensors_event_t;

/* Sensor details (40 bytes) */
typedef struct {
  char name[12];     
  int32_t version;   
  int32_t sensor_id; 
  int32_t type;      
  float max_value;   
  float min_value;   
  float resolution; 
  int32_t min_delay; 
} sensor_t;

class Adafruit_Sensor {
public:
  // Constructor(s)
  Adafruit_Sensor() {}
  virtual ~Adafruit_Sensor() {}

  // These must be defined by the subclass

  virtual void enableAutoRange(bool enabled) {
    (void)enabled; /* suppress unused warning */
  };

  virtual bool getEvent(sensors_event_t *) = 0;
  virtual void getSensor(sensor_t *) = 0;

  void printSensorDetails(void);

private:
  bool _autoRange;
};

#endif