# BG_Oled_N64

**Repository Path**: fish_five/bg_oled_n64

## Basic Information

- **Project Name**: BG_Oled_N64
- **Description**: 北寒余工作室开源Arduino OLED库。基于部分U8g2库开发而成，支持字符自动换行，可以直接解析MQTT库PubSubClient.h的订阅回调，可以清屏，清屏换行区，按行清除字符，按坐标清除字符。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-03-29
- **Last Updated**: 2024-02-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BG_Oled_N64

#### 介绍
 **原北寒余工作室开源Arduino OLED库。支持字符自动换行，可以直接解析MQTT库PubSubClient.h的订阅回调，可以清屏，清屏换行区，按行清除字符，按坐标清除字符。** 

#### 运行条件
1. 下载项目，将项目正确地添加到Arduino IDE的库文件夹。
2.  **确保你的Arduino IDE已经安装了u8g2库。** 


#### 安装教程
1. 下载项目并解压，将项目中的BG_Oled_N64文件夹复制到Arduino IDE的库文件夹内（一般在项目文件夹的libraries内）。
2. 或者在Arduino IDE中以添加Zip库的方式添加。

#### 使用说明
项目文件夹有两个demo示例程序，均以NodeMCU开发板为例，可以参考使用，如是其他开发板修改BG_Oled_Choose.h即可。  
#### 函数功能说明
```c
    void beginOLED();       //初始化
    void cleanOLED(uint8_t i); //清除某行显示
    void cleanAllOLED();    //清除换行区显示
    lenStrOLED(const char* payload) //字符和换行区内容长度计算，推荐使用。
    void setcOLED(const char* payload, uint8_t length); //设置换行区内容，length>64时，不显示内容。
    void setbOLED(byte* payload, uint8_t length);//接解析MQTT库PubSubClient.h的订阅回调，length>64时，不显示内容。
    void setStr(uint8_t x,uint8_t y,const char* msg);//按坐标显示
    useString(String str)  //将String类型转化为本库使用的const char*。
    xyNum(uint8_t  num) //将从0开始的坐标转化为从1开始，即1由原来的第2行转化为第1行。
    void cleanStr(uint8_t x,uint8_t y);//按坐标清除
    void cleanAll();//清屏
```
#### 扩展说明
- (1) **默认接线: IIC通信，SCK=D1，SDA=D2。** 
- (2)切换开发板或接线，修改BG_Oled_Choose.h的U8X8_SSD1306_128X64_NONAME_SW_I2C。
- (3)屏幕说明:8行（0-7）,每行可写16个字符(0-15)，共可操作128个英文字符。第5行（程序为4）开始支持自动换行。
- (4)库特点
    1. setcOLED支持字符自动换行,共可解析64个英文字符
    2. setbOLED可以直接解析MQTT库PubSubClient.h的订阅回调，并支持自动换行，共可解析64个英文字符。
    3. 可以清屏，清屏换行区，按行清除字符，按坐标清除字符。