iot_light.h

// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
//
// 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.

#ifndef __IOT_LIGHT_H__
#define __IOT_LIGHT_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "driver/ledc.h"

/********************************** NOTE *********************************/
/* When we create a light object, a hardware timer will be enabled, this */
/* timer is used to realize fade and blink operation. The default timer  */
/* occupied is timer 0 of timer group 0, user can change this config in  */
/* menuconfig.                                                           */
/*************************************************************************/

#define LIGHTS_LED_NUM                     (3)
#define LIGHTS_GPIO_LED_RED                GPIO_NUM_25
#define LIGHTS_GPIO_LED_GREEN              GPIO_NUM_19
#define LIGHTS_GPIO_LED_BLUE               GPIO_NUM_5

typedef void *light_handle_t;

#define HW_TIMER_GROUP         (0)   /**< Hardware timer group */
#define HW_TIMER_ID            (0)   /**< Hardware timer number */
#define HW_TIMER_DIVIDER       (16)  /**< Hardware timer clock divider */
#define HW_TIMER_SCALE         (TIMER_BASE_CLK / HW_TIMER_DIVIDER)  /**< Convert counter value to seconds */

#define DUTY_SET_CYCLE         (20)  /**< Set duty cycle */
#define DUTY_SET_GAMMA         (0.6) /**< Set the Gamma value for the fade curve, default value is 0.6 */

#define LIGHT_MAX_CHANNEL_NUM  (5)


#define MDF_LOG_LEVEL ESP_LOG_DEBUG
#define MDF_LOG_FORMAT(letter, format)  LOG_COLOR_ ## letter #letter " (%u) [%s, %d]: " format LOG_RESET_COLOR "\n"
#define MDF_LOGW( format, ... ) do { \
        if (MDF_LOG_LEVEL >= ESP_LOG_WARN) { \
            esp_log_write(ESP_LOG_WARN, TAG, MDF_LOG_FORMAT(W, format), esp_log_timestamp(), TAG, __LINE__, ##__VA_ARGS__); \
        } \
    } while(0)
/**
 * Macro which can be used to check the error code,
 * and terminate the program in case the code is not MDF_OK.
 * Prints the error code, error location, and the failed statement to serial output.
 *
 * Disabled if assertions are disabled.
 */
#define MDF_ERROR_CHECK(con, err, format, ...) do { \
        if (con) { \
            if(*format != '\0') \
                MDF_LOGW("<%s> " format, esp_err_to_name(err), ##__VA_ARGS__); \
            return err; \
        } \
    } while(0)



/**
  * @brief  light initialize
  *
  * @param  timer the LEDC timer used by light
  * @param  speed_mode speed mode of LEDC timer
  * @param  freq_hz frequency of LEDC timer
  * @param  channel_num decide how many channels the light contains
  * @param  timer_bit LEDC PWM duty resolution
  *
  * @return  the handle of light
  */
light_handle_t iot_light_create(ledc_timer_t timer, ledc_mode_t speed_mode, uint32_t freq_hz, uint8_t channel_num, ledc_timer_bit_t timer_bit);

/**
  * @brief  add an output channel to light
  *
  * @param  light_handle light handle
  * @param  channel_idx the id of channel (0 ~ channel_num-1)
  * @param  io_num the IO number use to output LEDC PWM
  * @param  channel the ledc channel you want to use
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_channel_regist(light_handle_t light_handle, uint8_t channel_idx, gpio_num_t io_num, ledc_channel_t channel);

/**
  * @brief  free the memory of light
  *
  * @param  light_handle light handle
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_delete(light_handle_t light_handle);

/**
  * @brief  get channel duty
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  *
  * @return
  *     - LEDC_ERR_DUTY if parameter error
  *     - Others Current LEDC duty
  */
uint32_t iot_light_duty_get(light_handle_t light_handle, uint8_t channel_id);

/**
  * @brief  set light fade with time. if set fade_period_ms as 0, set the duty directly.
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  * @param  duty target duty
  * @param  fade_period_ms fade time (uint: ms)
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_fade_with_time(light_handle_t light_handle, uint8_t channel_id, uint32_t duty, uint32_t fade_period_ms);

/**
  * @brief  set breath config of a light channel, call `iot_light_operate_start` to start breath operation
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  * @param  duty the maximum duty when breath
  * @param  breath_period_ms breath period (uint: ms)
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_breath_config(light_handle_t light_handle, uint8_t channel_id, uint32_t duty, uint32_t breath_period_ms);

/**
  * @brief  set blink config of a light channel, call `iot_light_operate_start` to start blink operation
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  * @param  blink_period_ms blink period (uint: ms)
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_blink_config(light_handle_t light_handle, uint8_t channel_id, uint32_t blink_period_ms);

/**
  * @brief  start breath or blink operation, user need to set breath or blink config before call this API
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_operate_start(light_handle_t light_handle, uint8_t channel_id);

/**
  * @brief  stop breath or blink operation
  *
  * @param  light_handle light handle
  * @param  channel_id the id of channel (0 ~ channel_num-1)
  *
  * @return
  *     - ESP_OK: succeed
  *     - others: fail
  */
esp_err_t iot_light_operate_stop(light_handle_t light_handle, uint8_t channel_id);

// user functions

/**
 * @brief Set the color of the light
 *
 * @param  red   Red led brightness, the range is: 0 ~ 255
 * @param  green Green led brightness, the range is: 0 ~ 255
 * @param  blue  Blue led brightness, the range is: 0 ~ 255
 *
 * @return
 *     - ESP_OK
 *     - ESP_FAIL
 */
esp_err_t led_set_rgb(uint8_t red, uint8_t green, uint8_t blue);

/**
 * [led_blink_start description]
 *
 * @param  red   Red led brightness, the range is: 0 ~ 255
 * @param  green Green led brightness, the range is: 0 ~ 255
 * @param  blue  Blue led brightness, the range is: 0 ~ 255
 * @param  period_ms breath period (uint: ms)
 *
 * @return
 *     - ESP_OK
 *     - ESP_FAIL
 */
esp_err_t led_blink_start(uint8_t red, uint8_t green, uint8_t blue, uint32_t period_ms);

/**
 * @brief Stop the blink of led
 *
 * @return
 *     - ESP_OK
 *     - ESP_FAIL
 */
esp_err_t led_blink_stop();

void lights_init( void );


#ifdef __cplusplus
}
#endif

#endif /**< __IOT_LIGHT_H__ */