mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
95 lines
2.6 KiB
C
95 lines
2.6 KiB
C
/*
|
|
* Copyright (C) 2015 Freie Universität Berlin
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup sys_analog_util Analog data conversion utilities
|
|
* @ingroup sys
|
|
* @brief Utility functions for converting analog data samples
|
|
*
|
|
* @{
|
|
* @file
|
|
* @brief Analog utility function interfaces
|
|
*
|
|
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
|
|
*/
|
|
|
|
#ifndef ANALOG_UTIL_H
|
|
#define ANALOG_UTIL_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "periph/adc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Map a sampled ADC value to a given range
|
|
*
|
|
* This function is useful for converting sampled ADC values into their physical
|
|
* representation.
|
|
*
|
|
* @param[in] sample sampled ADC value
|
|
* @param[in] res ADC resolution
|
|
* @param[in] min the lower bound of the target interval
|
|
* @param[in] max the upper bound of the target interval
|
|
*
|
|
* @return the mapped value
|
|
*/
|
|
int32_t adc_util_map(int sample, adc_res_t res, int32_t min, int32_t max);
|
|
|
|
/**
|
|
* @brief Map a sampled ADC value to a given range (using floating point
|
|
* arithmetic)
|
|
*
|
|
* @see adc_util_map
|
|
*
|
|
* @param[in] sample sampled ADC value
|
|
* @param[in] res ADC resolution
|
|
* @param[in] min the lower bound of the target interval
|
|
* @param[in] max the upper bound of the target interval
|
|
*
|
|
* @return the mapped value
|
|
*/
|
|
float adc_util_mapf(int sample, adc_res_t res, float min, float max);
|
|
|
|
/**
|
|
* @brief Map a value out of the given range to a 16-bit unsigned int
|
|
*
|
|
* The min value is assumed to be smaller than max value and value is assumed
|
|
* to be between min and max.
|
|
*
|
|
* @param[in] value value to map to a DAC set value
|
|
* @param[in] min the lower bound of the source interval
|
|
* @param[in] max the upper bound of the source interval
|
|
*
|
|
* @return the mapped value
|
|
*/
|
|
uint16_t dac_util_map(int value, int min, int max);
|
|
|
|
/**
|
|
* @brief Helper function to map a given float value range to a valid DAC value.
|
|
*
|
|
* @see dac_util_map
|
|
*
|
|
* @param[in] value value to map to a DAC set value
|
|
* @param[in] min the lower bound of the source interval
|
|
* @param[in] max the upper bound of the source interval
|
|
*
|
|
* @return the mapped value
|
|
*/
|
|
uint16_t dac_util_mapf(float value, float min, float max);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ANALOG_UTIL_H */
|
|
/** @} */
|