89 lines
4 KiB
C
89 lines
4 KiB
C
/*
|
|
* Copyright (c) 2015, Zolertia - http://www.zolertia.com
|
|
* Copyright (c) 2015, University of Bristol - http://www.bristol.ac.uk
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* \addtogroup zoul-sensors
|
|
* @{
|
|
*
|
|
* \defgroup zoul-adc-sensors Zoul adc wrapper to use analogue sensors
|
|
*
|
|
* The ADC wrapper implement analogue sensors on top of the ADC interface,
|
|
* obscuring the ADC configuration and required calculations to obtain actual
|
|
* sensor values. The driver allows to reuse the adc-wrapper implementation and
|
|
* add sensors easily, without duplicating code, providing also a simplified
|
|
* interface and exposing the available ADC assigned channels by a given
|
|
* platform.
|
|
*
|
|
* To use a given sensor simply use: adc_sensors.configure(SENSOR_NAME, pin_no),
|
|
* where pin_no is a given pin in the PA port, check out the board.h for more
|
|
* information on available pins. To read a value just use
|
|
* adc_sensors.value(SENSOR_NAME), the expected result would be the sensor value
|
|
* already converted to the sensor variable type, check the adc-wrapper file
|
|
* for more information.
|
|
*
|
|
* @{
|
|
*
|
|
* \file
|
|
* Header file for the Zoul ADC sensors API
|
|
*/
|
|
/*---------------------------------------------------------------------------*/
|
|
#ifndef ADC_SENSORS_H_
|
|
#define ADC_SENSORS_H_
|
|
/*---------------------------------------------------------------------------*/
|
|
#include "lib/sensors.h"
|
|
#include "dev/soc-adc.h"
|
|
#include "dev/adc-zoul.h"
|
|
/*---------------------------------------------------------------------------*/
|
|
#define ADC_WRAPPER_SUCCESS 0x00
|
|
#define ADC_WRAPPER_ERROR (-1)
|
|
#define ADC_WRAPPER_EXTERNAL_VREF 5000
|
|
#define ADC_WRAPPER_EXTERNAL_VREF_CROSSVAL 3300
|
|
/*---------------------------------------------------------------------------*/
|
|
#define ANALOG_GROVE_LIGHT 0x01
|
|
#define ANALOG_PHIDGET_ROTATION_1109 0x02
|
|
#define ANALOG_GROVE_LOUDNESS 0x03
|
|
#define ANALOG_VAC_SENSOR 0x04
|
|
#define ANALOG_AAC_SENSOR 0x05
|
|
#define ANALOG_PM10_SENSOR 0x06
|
|
/* -------------------------------------------------------------------------- */
|
|
#define ADC_SENSORS "ADC sensors API"
|
|
/* -------------------------------------------------------------------------- */
|
|
extern const struct sensors_sensor adc_sensors;
|
|
/*---------------------------------------------------------------------------*/
|
|
#endif /* ADC_SENSORS_H_ */
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* @}
|
|
* @}
|
|
*/
|
|
|