From 1154566be5b46f2de1df533084dc3c15ec8e15b0 Mon Sep 17 00:00:00 2001 From: Gitshaoxiang <1026025056@qq.com> Date: Fri, 6 Nov 2020 17:37:57 +0800 Subject: [PATCH] fix some mixtake --- docs/en/api/coreink/system_api.md | 10 ++++++++++ docs/en/core/coreink.md | 4 ++-- docs/zh_CN/api/coreink/system_api.md | 10 ++++++++++ docs/zh_CN/core/coreink.md | 4 ++-- 4 files changed, 24 insertions(+), 4 deletions(-) diff --git a/docs/en/api/coreink/system_api.md b/docs/en/api/coreink/system_api.md index 7dd99a89..548bfac8 100644 --- a/docs/en/api/coreink/system_api.md +++ b/docs/en/api/coreink/system_api.md @@ -58,16 +58,26 @@ M5.update(); **Description: Buzzer Drive** `void end();` + `void mute();` + `void tone(uint16_t frequency);` + `void tone(uint16_t frequency, uint32_t duration);` + `void beep();` + `void setBeep(uint16_t frequency, uint16_t duration);` + `void update();` + `void write(uint8_t value);` + `void setVolume(uint8_t volume);` + `void playMusic(const uint8_t *music_data, uint16_t sample_rate);` + ``` M5.Speaker.tone(2700); ``` diff --git a/docs/en/core/coreink.md b/docs/en/core/coreink.md index 775cfff6..e48d6acb 100644 --- a/docs/en/core/coreink.md +++ b/docs/en/core/coreink.md @@ -12,7 +12,7 @@ view the corresponding tutorial&quick-Start. ## Description -**CoreInk** is a brand new E-ink display in the M5Stack cores range. Controlled by the ESP32-PICO-D4 This new device includes a 200x200 1.54" Black and White E-Ink Display. Compared to a regular LCD,E-ink displays are easier on the eyes, which makes them a great choice for reading or viewing for longer periods. Other benefits are the low power consumption and the ability to retain the image even if power to the display is terminated。For control the CoreInk integrates an multi-function button,A physical button, integrated status LED and buzzer.The device also includes a 390mAh Lipo,RTC(BM8563)for controlling accurate timing and deep sleep funcionality. CoreInk features independent reset and power buttons,expansion ports(HY2.0-4P、M-BUS、HAT expansion)for attaching external sensors to expand functionailty,for unlimited possibilities。 +**CoreInk** is a brand new E-ink display in the M5Stack cores range. Controlled by the ESP32-PICO-D4 This new device includes a 200x200 1.54" Black and White E-Ink Display. Compared to a regular LCD,E-ink displays are easier on the eyes, which makes them a great choice for reading or viewing for longer periods. Other benefits are the low power consumption and the ability to retain the image even if power to the display is terminated。For control the CoreInk integrates an multi-function button,A physical button, integrated status LED and buzzer.The device also includes a 390mAh Lipo,RTC(BM8563)for controlling accurate timing and deep sleep funcionality. CoreInk features independent reset and power buttons,expansion ports(HY2.0-4P,M-BUS,HAT expansion)for attaching external sensors to expand functionailty,for unlimited possibilities。 ?>Warning: Please avoid using high refresh rates,reccommended refresh rate is(15s/per refresh), Do not expose to ultraviolet rays for a long time, otherwise it may cause irreversible damage to the ink screen. @@ -20,7 +20,7 @@ view the corresponding tutorial&quick-Start. ## Product Features -- ESP32 Standard wireless functions WiFi、Bluetooth +- ESP32 Standard wireless functions WiFi,Bluetooth - Internal 4M Flash - Low Power Display - 180 degree viewing angle diff --git a/docs/zh_CN/api/coreink/system_api.md b/docs/zh_CN/api/coreink/system_api.md index 33f1d886..b9b5ce25 100644 --- a/docs/zh_CN/api/coreink/system_api.md +++ b/docs/zh_CN/api/coreink/system_api.md @@ -59,16 +59,26 @@ M5.update(); **功能:蜂鸣器驱动** `void end();` + `void mute();` + `void tone(uint16_t frequency);` + `void tone(uint16_t frequency, uint32_t duration);` + `void beep();` + `void setBeep(uint16_t frequency, uint16_t duration);` + `void update();` + `void write(uint8_t value);` + `void setVolume(uint8_t volume);` + `void playMusic(const uint8_t *music_data, uint16_t sample_rate);` + ``` M5.Speaker.tone(2700); ``` diff --git a/docs/zh_CN/core/coreink.md b/docs/zh_CN/core/coreink.md index 3eaf0b44..839c8646 100644 --- a/docs/zh_CN/core/coreink.md +++ b/docs/zh_CN/core/coreink.md @@ -12,7 +12,7 @@ ## 描述 -**CoreInk** 是M5Stack推出的一款带有电子墨水屏(E-Ink)的主控设备,控制器采用ESP32-PICO-D4。正面嵌入了一块分辨率为200x200 @ 1.54"的电子墨水屏,支持黑/白显示。相对于普通的LCD的屏幕,电子墨水屏能够提供用户更好的文本阅读体验, 同时具有低功耗,掉电图像保持等特性。人机交互方面提供了拨轮开关,与物理按键, 集成LED指示灯与蜂鸣器。内置了390mAh锂电池,结合内部的RTC(BM8563)可实现定时休眠与唤醒功能,能够为设备提供较为优秀的续航能力。在机身的左侧和底部配有独立的电源按键与复位(RST)按键,方便使用与调试。开放了丰富的外设接口(HY2.0-4P、M-BUS、HAT模块接口)能够拓展各式各样的传感器设备,为后续的应用功能开发提供无限可能。 +**CoreInk** 是M5Stack推出的一款带有电子墨水屏(E-Ink)的主控设备,控制器采用ESP32-PICO-D4。正面嵌入了一块分辨率为200x200 @ 1.54"的电子墨水屏,支持黑/白显示。相对于普通的LCD的屏幕,电子墨水屏能够提供用户更好的文本阅读体验, 同时具有低功耗,掉电图像保持等特性。人机交互方面提供了拨轮开关,与物理按键, 集成LED指示灯与蜂鸣器。内置了390mAh锂电池,结合内部的RTC(BM8563)可实现定时休眠与唤醒功能,能够为设备提供较为优秀的续航能力。在机身的左侧和底部配有独立的电源按键与复位(RST)按键,方便使用与调试。开放了丰富的外设接口(HY2.0-4P,M-BUS,HAT模块接口)能够拓展各式各样的传感器设备,为后续的应用功能开发提供无限可能。 ?>注意事项: 使用时请注意避免长时间高频刷新,建议刷新间隔为(15s/次), 请勿长时间暴露在紫外线下, 否则有可能对墨水屏造成不可逆的损害。 @@ -20,7 +20,7 @@ ## 产品特性 -- 基于 ESP32 开发,支持WiFi、蓝牙 +- 基于 ESP32 开发,支持WiFi,蓝牙 - 内置4M Flash - 低功耗显示面板 - 近180度可视角