esp-who/components/screen/controller_driver/ssd1307/ssd1307.h

191 lines
4.0 KiB
C

// Copyright 2020 Espressif Systems (Shanghai) Co. 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_LCD_SSD1307_H__
#define __IOT_LCD_SSD1307_H__
#ifdef __cplusplus
extern "C"
{
#endif
#include "screen_driver.h"
/**
* @brief screen initial
*
* @param lcd_conf configuration struct of ssd1306
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_init(const scr_controller_config_t *lcd_conf);
/**
* @brief Deinitial screen
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_deinit(void);
/**
* @brief Get screen information
*
* @param info Pointer to a scr_info_t structure.
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_get_info(scr_info_t *info);
/**
* @brief Set screen direction of rotation
*
* @param dir Pointer to a scr_dir_t structure.
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_set_rotate(scr_dir_t dir);
/**
* @brief Set screen window
*
* @param x0 Starting point in X direction
* @param y0 Starting point in Y direction
* @param x1 End point in X direction
* @param y1 End point in Y direction
*
* @return
* - ESP_OK on success
* - ESP_FAIL Failed
*/
esp_err_t lcd_ssd1307_set_window(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1);
/**
* @brief Draw one pixel in screen with color
*
* @param x X co-ordinate of set orientation
* @param y Y co-ordinate of set orientation
* @param color New color of the pixel
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_draw_pixel(uint16_t x, uint16_t y, uint16_t color);
/**
* @brief Fill the pixels on LCD screen with bitmap
*
* @param x Starting point in X direction
* @param y Starting point in Y direction
* @param w width of image in bitmap array
* @param h height of image in bitmap array
* @param bitmap pointer to bitmap array
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_draw_bitmap(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t *bitmap);
/**
* @brief Set the contrast of screen
*
* @param contrast Contrast to set
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_set_contrast(uint8_t contrast);
/**
* @brief Turn on the screen
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_display_on(void);
/**
* @brief Turn off the screen
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_display_off(void);
/**
* @brief Start horizontal scroll
*
* @param dir Direction of horizontal scroll
* @param start start page
* @param stop end page
* @param interval time interval of scroll
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_start_horizontal_scroll(uint8_t dir, uint8_t start, uint8_t stop, uint8_t interval);
/**
* @brief
*
* @param start
* @param stop
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_start_vertical_scroll(uint8_t start, uint8_t stop);
/**
* @brief
*
* @param start
* @param stop
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_start_scroll_diagRight(uint8_t start, uint8_t stop);
/**
* @brief Stop screen scroll
*
* @return
* - ESP_OK Success
* - ESP_FAIL Fail
*/
esp_err_t lcd_ssd1307_stop_scroll(void);
#ifdef __cplusplus
}
#endif
#endif