hal_thermometer.h

Go to the documentation of this file.

/*
    ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio

    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
    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.
*/

/**
 * @file    hal_thermometer.h
 * @brief   Generic thermometer interface header.
 *
 * @addtogroup HAL_THERMOMETER
 * @{
 */

#ifndef HAL_THERMOMETER_H
#define HAL_THERMOMETER_H

#include "hal_sensors.h"

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   BaseThermometer specific methods.
 */
#define _base_thermometer_methods_alone                                     \
  /* Invoke the set bias procedure.*/                                       \
  msg_t (*set_bias)(void *instance, float biases[]);                        \
  /* Remove bias stored data.*/                                             \
  msg_t (*reset_bias)(void *instance);                                      \
  /* Invoke the set sensitivity procedure.*/                                \
  msg_t (*set_sensitivity)(void *instance, float sensitivities[]);          \
  /* Restore sensitivity stored data to default.*/                          \
  msg_t (*reset_sensitivity)(void *instance);


/**
 * @brief   BaseThermometer specific methods with inherited ones.
 */
#define _base_thermometer_methods                                           \
  _base_sensor_methods                                                      \
  _base_thermometer_methods_alone

/**
 * @brief   @p BaseThermometer virtual methods table.
 */
struct BaseThermometerVMT {
  _base_thermometer_methods
};

/**
 * @brief   @p BaseThermometer specific data.
 */
#define _base_thermometer_data                                              \
  _base_sensor_data
  
/**
 * @extends BaseSensor
 *
 * @brief   Base thermometer class.
 * @details This class represents a generic thermometer.
 */
typedef struct {
  /** @brief Virtual Methods Table.*/
  const struct BaseThermometerVMT *vmt;
  _base_thermometer_data
} BaseThermometer;

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/
/**
 * @name    Macro Functions (BaseThermometer)
 * @{
 */
/**
 * @brief   Thermometer get channels number.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 * @return              The number of channels of the BaseThermometer
 *
 * @api
 */
#define thermometerGetChannelsNumber(ip)                                    \
        (ip)->vmt->get_channels_number(ip)

/**
 * @brief   Thermometer read raw data.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 * @param[in] dp        pointer to a data array.
 * 
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerReadRaw(ip, dp)                                          \
        (ip)->vmt->read_raw(ip, dp)

/**
 * @brief   Thermometer read cooked data.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 * @param[in] dp        pointer to a data array.
 * 
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerReadCooked(ip, dp)                                       \
        (ip)->vmt->read_cooked(ip, dp)

/**
 * @brief   Updates thermometer bias data from received buffer.
 * @note    The bias buffer must have the same length of the
 *          the thermometer channels number.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 * @param[in] bp        pointer to a buffer of bias values.
 *
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerSetBias(ip, bp)                                          \
        (ip)->vmt->set_bias(ip, bp)

/**
 * @brief   Reset thermometer bias data restoring it to zero.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 *
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerResetBias(ip)                                            \
        (ip)->vmt->reset_bias(ip)

/**
 * @brief   Updates thermometer sensitivity data from received buffer.
 * @note    The sensitivity buffer must have the same length of the
 *          the thermometer channels number.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 * @param[in] sp        pointer to a buffer of sensitivity values.
 *
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerSetSensitivity(ip, sp)                                   \
        (ip)->vmt->set_sensitivity(ip, sp)

/**
 * @brief   Reset thermometer sensitivity data restoring it to its typical
 *          value.
 *
 * @param[in] ip        pointer to a @p BaseThermometer class.
 *
 * @return              The operation status.
 * @retval MSG_OK       if the function succeeded.
 * @retval MSG_RESET    if one or more errors occurred.
 *
 * @api
 */
#define thermometerResetSensitivity(ip)                                     \
        (ip)->vmt->reset_sensitivity(ip)
/** @} */

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
}
#endif

#endif /* HAL_THERMOMETER_H */

/** @} */