battery-sensor.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012, TU Braunschweig.
 * 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 Institute 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 INSTITUTE 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 INSTITUTE 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.
 */

/**
 * \file
 *      Battery sensor definition
 * \author
 *      Enrico Joerns <e.joerns@tu-bs.de>
 */

/**
 * \addtogroup inga_sensors
 * @{
 */

/**
 * \defgroup inga_battery_driver Battery Sensor
 *
 * This sensor interface allows to monitor the supply voltage and current
 * of the INGA sensor platform.
 *
 * \section query_measure Query measurements
 * <code>acc_sensor.value(channel)</code>
 *
 * The sensor provides 2 data channels.
 * - One provides battery voltage level
 * - One provides battery current
 * A detailed list can be found at \ref batt_out_channels "Data Output Channels"
 *
 * \section usage Example Usage
 *
\code
#include <sensors.h>
[...]
struct sensors_sensor batterysensor = find_sensor("Batt");
ACTIVATE_SENSOR(batterysensor);
[...]
int v = batterysensor.value(BATTERY_VOLTAGE);
int i = batterysensor.value(BATTERY_CURRENT);
\endcode
 * @{ */

#ifndef BATTERY_SENSOR_H
#define BATTERY_SENSOR_H

#include "lib/sensors.h"

extern const struct sensors_sensor battery_sensor;

#define BATTERY_SENSOR "Batt"

/**
 * \name Data Output Channels
 * \anchor batt_out_channels
 * 
 * @{ */
/** Returns battery voltage im mV */
#define BATTERY_VOLTAGE   2
/** Returns battery current im mA */
#define BATTERY_CURRENT   3
/** @} */

#endif  /* BATTERY_SENSOR_H */

/** @} */
/** @} */