lightness_to_pwm.h

Go to the documentation of this file.

/************************************************************************//**
 * \file    heivs/lightness_to_pwm.h
 * \brief   Handle non-linearity in human eye brightness sensitivity
 * \author  marc dot pignat at hevs dot ch
 * \ingroup libheivs_stm32_misc
 * @{
 ***************************************************************************/
#ifndef HEIVS_PWM_LED_VALUES_H
#define HEIVS_PWM_LED_VALUES_H

#include <stdint.h>
#include "heivs/error.h"

#ifdef __cplusplus
    extern "C" {
#endif

/**
 * \brief Number a step for a pwm using lightness_to_pwm
 */
#define LIGHTNESS_PWM_STEP 255

/**
 * \brief PWM value for driving a LED expressed as perceived percentage
 *
 * \param percentage expected of luminosity (0..100)
 *
 * \return the value to be put in a 0..LIGHTNESS_PWM_STEP pwm
 */
uint8_t lightness_to_pwm(uint8_t percentage);

#ifdef __cplusplus
    }
#endif

/**
 * @}
 */
#endif /* HEIVS_PWM_LED_VALUES_H */