113 lines
4.5 KiB
C
113 lines
4.5 KiB
C
/*
|
|
MIT License
|
|
|
|
Copyright (c) 2016-2018, Alexey Dynda
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
*/
|
|
/**
|
|
* @file ssd1306_i2c.h SSD1306 i2c communication functions
|
|
*/
|
|
|
|
|
|
#ifndef _SSD1306_I2C_H_
|
|
#define _SSD1306_I2C_H_
|
|
|
|
#include "ssd1306_i2c_conf.h"
|
|
#include "ssd1306_i2c_embedded.h"
|
|
#include "ssd1306_i2c_twi.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @ingroup LCD_HW_INTERFACE_API
|
|
*
|
|
* Inits display interface to use i2c bus.
|
|
* The function automatically selects available type of i2c implementation
|
|
* 1. Wire library
|
|
* 2. sw i2c implementation
|
|
* In case of using Wire library this function calls Wire.begin() and
|
|
* sets speed to fast i2c (400kHz). If you prefer to use your own Wire settings
|
|
* or avoid reinitializing of Wire library, please use ssd1306_i2cInit_Wire().
|
|
* If you want to use embedded i2c (if it is supported), use ssd1306_i2cInit_Embedded().
|
|
*
|
|
* @note: after call to this function you need to initialize lcd display.
|
|
*/
|
|
void ssd1306_i2cInit(void);
|
|
|
|
/**
|
|
* @ingroup LCD_HW_INTERFACE_API
|
|
*
|
|
* Inits display interface to use i2c bus.
|
|
* The function automatically selects available type of i2c implementation
|
|
* 1. Wire library
|
|
* 2. sw i2c implementation
|
|
* In case of using Wire library this function calls Wire.begin() and
|
|
* sets speed to fast i2c (400kHz). If you prefer to use your own Wire settings
|
|
* or avoid reinitializing of Wire library, please use ssd1306_i2cInit_Wire().
|
|
* If you want to use embedded i2c (if it is supported), use ssd1306_i2cInit_Embedded().
|
|
*
|
|
* @param scl - i2c clock pin. Use -1 if you don't need to change default pin number
|
|
* @param sda - i2c data pin. Use -1 if you don't need to change default pin number
|
|
* @param sa - i2c address of lcd display. Use 0 to leave default
|
|
*
|
|
* @note scl and sda parameters depend on used hardware. For many hardware boards these
|
|
* parameters do not have any effect. ESP8266 allows to specify these parameters
|
|
*
|
|
* @note scl and sda for Linux systems should be the same, and should contain i2c bus id.
|
|
*
|
|
* @note: after call to this function you need to initialize lcd display.
|
|
*/
|
|
void ssd1306_i2cInitEx(int8_t scl, int8_t sda, int8_t sa);
|
|
|
|
/**
|
|
* @ingroup LCD_HW_INTERFACE_API
|
|
*
|
|
* Inits display interface to use i2c bus.
|
|
* The function automatically selects available type of i2c implementation
|
|
* 1. Wire library
|
|
* 2. sw i2c implementation
|
|
* In case of using Wire library this function calls Wire.begin() and
|
|
* sets speed to fast i2c (400kHz). If you prefer to use your own Wire settings
|
|
* or avoid reinitializing of Wire library, please use ssd1306_i2cInit_Wire().
|
|
* If you want to use embedded i2c (if it is supported), use ssd1306_i2cInit_Embedded().
|
|
*
|
|
* @param busId - number of i2c bus if there are multiple hw blocks avialable.
|
|
* @param scl - i2c clock pin. Use -1 if you don't need to change default pin number
|
|
* @param sda - i2c data pin. Use -1 if you don't need to change default pin number
|
|
* @param sa - i2c address of lcd display. Use 0 to leave default
|
|
*
|
|
* @note scl and sda parameters depend on used hardware. For many hardware boards these
|
|
* parameters do not have any effect. ESP8266 allows to specify these parameters
|
|
*
|
|
* @note scl and sda for Linux systems should be the same, and should contain i2c bus id.
|
|
*
|
|
* @note: after call to this function you need to initialize lcd display.
|
|
*/
|
|
void ssd1306_i2cInitEx2(int8_t busId, int8_t scl, int8_t sda, int8_t sa);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
// ----------------------------------------------------------------------------
|
|
#endif // _SSD1306_I2C_H_
|