BaroSensor.hpp

/****************************************************************************
 *
 *   Copyright (C) 2015 Mark Charlebois. 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 PX4 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 OWNER 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.
 *
 ****************************************************************************/

#pragma once

#include <stdint.h>
#include "SyncObj.hpp"

#if defined(__DF_OCPOC)
#define __BARO_USE_SPI
#endif

#if defined(__BARO_USE_SPI)
#include "SPIDevObj.hpp"
#else
#include "I2CDevObj.hpp"
#endif

#define BARO_CLASS_PATH  "/dev/baro"

namespace DriverFramework
{

/**
 * The sensor independent data structure containing pressure values.
 */
struct baro_sensor_data {
	int32_t  t_fine; 		/*! used internally to calculate a temperature compensated pressure value. */
	float    pressure_pa; 		/*! current pressure in Pascals */
	float    temperature_c;		/*! current temperature in C at which the pressure was read */
	uint64_t read_counter;		/*! the total number of pressure sensor readings since the system was started */
	uint64_t last_read_time_usec; 	/*! time stamp indicating the time at which the pressure in this data structure was read */
	uint64_t error_counter;		/*! the total number of errors detected when reading the pressure, since the system was started */
#if defined(__DF_BBBLUE_USE_RC_BMP280_IMP)
	float    altitude_m;        /*! current altitude in meter at which the pressure was read */
#endif
};

void printPressureValues(struct baro_sensor_data &data);

#if defined(__BARO_USE_SPI)
class BaroSensor : public SPIDevObj
#else
class BaroSensor : public I2CDevObj
#endif
{
public:
	BaroSensor(const char *device_path, unsigned int sample_interval_usec) :
#if defined(__BARO_USE_SPI)
		SPIDevObj("BaroSensor", device_path, BARO_CLASS_PATH, sample_interval_usec)
#else
		I2CDevObj("BaroSensor", device_path, BARO_CLASS_PATH, sample_interval_usec)
#endif
	{}

	virtual ~BaroSensor() = default;

	void setAltimeter(float altimeter_setting_in_mbars)
	{
		m_altimeter_mbars = altimeter_setting_in_mbars;
	}

protected:
	virtual void _measure() = 0;

	struct baro_sensor_data	m_sensor_data {};
	float 				m_altimeter_mbars{0.0f};
};

}; // namespace DriverFramework