From a435964d2e17bcd779c27493c5765d59850b4976 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=AF=BA=E9=B8=A1=E9=B8=AD?= <1932263796@qq.com> Date: Tue, 9 Jul 2024 12:10:10 +0800 Subject: [PATCH] Update README --- README.md | 11 ++++++----- README_English.md | 27 ++++++++++++++------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0f6dc9e4..95282aef 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ AIO意为All in one，目的将尽可能多的功能集成进Holocubic AIO固件 ### 开发人员 * AIO框架开发和部分APP编写：[ClimbSnail](https://github.com/ClimbSnail) * 2048游戏应用开发：[AndyXFuture](https://github.com/AndyXFuture) -* 新版天气时钟应用开发：[PuYuuu](https://github.com/PuYuuu) -* BiliBili粉丝应用开发：[cnzxo](https://github.com/cnzxo/) +* 新版天气时钟应用开发：[PuYuuu](https://github.com/PuYuuu) & [chase535](https://github.com/chase535) +* BiliBili粉丝应用开发：[cnzxo](https://github.com/cnzxo) * 纪念日、心跳应用开发：[WoodwindHu](https://github.com/WoodwindHu) * PC资源监控应用开发：[Jumping99](https://github.com/Jumping99) * 多功能动画应用开发：[LHYHHD](https://github.com/LHYHHD) @@ -125,9 +125,10 @@ B站功能操作演示视频链接 https://www.bilibili.com/video/BV1wS4y1R7YF/ ##### 天气、时钟（Weather） 一共有两款天气时钟APP ###### 新版 weather -1. 新版由`PuYuuu`模仿了`misaka`的时钟界面。使用https://www.tianqiapi.com 天气API。 -2. 运行APP条件：必须是已经联网状态，且设置好`tianqi_appid`、`tianqi_appsecret`、`tianqi 城市名（中文）`。 -2. 使用新版天气时钟，需要再"Web Server"网页服务中修改`tianqi_appid`、`tianqi_appsecret`。（申请地址 https://www.yiketianqi.com/user/login ） +1. 新版由`PuYuuu`模仿了`misaka`的时钟界面。由`chase535`进行二次修改，使用和风天气API。 +2. 运行APP必要条件：必须是已经联网状态，且通过`Web Server`网页服务设置好了`和风天气KEY`。[点击这里申请和风天气KEY](https://console.qweather.com/#/apps)。 +3. 可设置通过IP地址自动获取地理位置，默认开启。如需手动设置地理位置，`国家`一栏请填写[ISO 3166](https://www.iso.org/iso-3166-country-codes.html)所定义的二位字母代码，其余三栏可写中文。 +4. 可设置自动更新周期，不可禁用自动更新，设置为0时会强制更正为默认值。***注意：和风天气免费订阅的KEY每日最多可请求1000次，而程序每次更新天气时需要请求5次，请在设置更新周期前提前计算理论的每日最少请数，否则当请求超过1000次后将会请求失败。以默认每10分钟更新一次为例，每日最少请求数=24×60÷10×5=720次。*** ###### 旧版 weather old 1. 旧版UI设计模仿了[CWEIB](https://github.com/CWEIB) 2. 运行APP条件：必须是已经联网状态，且设置好地点、weather_key。不插内存卡大多数情况能正常工作。 diff --git a/README_English.md b/README_English.md index ec090697..148a6c45 100644 --- a/README_English.md +++ b/README_English.md @@ -8,11 +8,11 @@ * Or https://gitee.com/ClimbSnailQ/HoloCubic_AIO ### Developer -* AIO Framework Development and Some APP Writing: [ClimbSnail] (https://github.com/ClimbSnail) -* 2048 Game Application Development: [AndyXFuture] (https://github.com/AndyXFuture) -* New Weather Clock Application Development: [PuYuuu] (https://github.com/PuYuuu) -* BiliBili fan application development: [cnzxo] (https://github.com/cnzxo/) -* Memorial Day, Heartbeat App Development: [WoodwindHu] (https://github.com/WoodwindHu) +* AIO Framework Development and Some APP Writing: [ClimbSnail](https://github.com/ClimbSnail) +* 2048 Game Application Development: [AndyXFuture](https://github.com/AndyXFuture) +* New Weather Clock Application Development: [PuYuuu](https://github.com/PuYuuu) & [chase535](https://github.com/chase535) +* BiliBili fan application development: [cnzxo](https://github.com/cnzxo/) +* Memorial Day, Heartbeat App Development: [WoodwindHu](https://github.com/WoodwindHu) * Developers continue to join. . . . _**Welcome to AIO internal test QQ discussion group**_ @@ -111,17 +111,18 @@ About picture conversion: Use the attached upper computer conversion (resolution ##### Screen share, screen share 1. Conditions for running the app: No memory card is required, but you need to use the ` Web Server Service ` app to set your wifi password (make sure you can connect to the router). To avoid restarting due to insufficient power during WiFi connection, please ensure that the USB port is fully powered. 2. At present, the upper computer uses third-party software, and will independently write the projection upper computer in the later stage to improve the performance. -3. The upper computer of this screen projection is the upper computer of [Daguai] (https://gitee.com/superddg123/esp32-TFT/tree/master). +3. The upper computer of this screen projection is the upper computer of [Daguai](https://gitee.com/superddg123/esp32-TFT/tree/master). 4. The web page side of ` WebServer ` can set additional functions. ##### Weather (Weather) There are two weather clock apps ###### New version of weather -1. PuYuuu ` mimics Misaka ` s clock interface in the new edition. Use the https://www.tianqiapi.com Weather API. -2. Conditions for running APP: It must be networked and set ` tianqi_appid `, ` tianqi_appsecret `, ` tianqi city name (Chinese) `. -2. To use the new weather clock, you need to modify ` tianqi_appid `, ` tianqi_appsecret ` in the "Web Server" web service. (Application address https://www.yiketianqi.com/user/login) +1. The new version by `PuYuuu` imitates the `misaka` clock interface. Secondary modification by `chase535`, using qweather API. +2. Required condition for running APP: It must be networked and set `QWEATHER KEY` through the `Web Server`. [CLICK HERE TO APPLICATION QWEATHER KEY](https://console.qweather.com/#/apps). +3. Can be set to automatically obtain geographical location through IP address, which is turned on by default. If you need to manually set the geographical location, please fill in the two-digit letter code defined in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) in the `country` column, and the rest of the 3 columns can be written in Chinese. +4. Automatic update cycle can be set, automatic update can not be disabled, set to 0 will be forced to correct to the default value. ***Note: KEY subscribed for free in wind weather can request up to 1000 times a day, while the program needs to request 5 times each time it updates the weather. Please calculate the theoretical minimum number of daily requests in advance before setting the update cycle, otherwise the request will fail when the request exceeds 1000 times. Take the default update every 10 minutes as an example, the minimum number of requests per day=24×60÷10×5=720times.*** ###### Old version of weather old -1. The old UI design mimics [CWEIB] (https://github.com/CWEIB) +1. The old UI design mimics [CWEIB](https://github.com/CWEIB) 2. Conditions for running APP: It must be networked and set the location, weather_key. It works normally in most cases without inserting a memory card. 3. Generally, it can work without inserting a memory card, but some weather icons are stored in the memory card (because the internal flash is not enough), so it is necessary to copy the ` weather/` folder attached to the firmware to the root directory of the tf card. 4. To use the old weather clock, you need to modify the "intimate weather city name" and "key" of intimate weather in the "Web Server" web service. (The application address is https://seniverse.com. The program uses the v3 version of api by default.) @@ -150,7 +151,7 @@ Note: The program is written by ` cnzxo `. 1. Run APP condition: Networking status 2. Before using it for the first time, you should fill in the name and date of the anniversary on the webpage of ` WebServer App `. At present, you can set up two anniversaries. The words supported by anniversaries are ` birthday and graduation, raising small dinosaurs, planting potatoes, wife, girlfriend, parents, milk, siblings, brothers and sisters, wedding anniversary '. If the words contained in the anniversaries name are not within this range, please generate your own font file and replace the ` src\ app\ anniversaries\ msyhbd_24. c ` file. Date format such as ` 2022.5.8 ', if the year is set to 0, it is considered to be a repetitive anniversary (such as birthday) every year. -Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic] (https://github.com/qingehao/LizCubic) project. The program is written by ` WoodwindHu ` +Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic](https://github.com/qingehao/LizCubic) project. The program is written by ` WoodwindHu ` ##### Heartbeat (Heartbeat) 1. Conditions for running APP: networked status (performance mode needs to be turned on), an mqtt server with open port 1883, and two HoloCubic. @@ -158,7 +159,7 @@ Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic] (https:// 3. After setting up the heartbeat APP, turn on the automatic networking and open the mqtt client. Automatically enter the APP after receiving another HoloCubic message. Entering the APP in the normal way automatically sends a message to another HoloCubic. 4. Update free services from time to time in the group. You can ask the management or group friends for specific configuration parameters. -Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic] (https://github.com/qingehao/LizCubic) project. The program is written by ` WoodwindHu ` +Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic](https://github.com/qingehao/LizCubic) project. The program is written by ` WoodwindHu ` ##### Stock quotes in real time (Stock) 1. Run APP condition: WiFi must be configured normally. To avoid restarting due to insufficient power during WiFi connection, please ensure that the USB port is fully powered. @@ -167,7 +168,7 @@ Note: Remembrance Day and Heartbeat are reproduced from the [LizCubic] (https:// Note: The program is written by ` redwolf ` ### About compiling engineering code -1. This project code is based on the ESP32-Pico Arduino platform of PlatformIO plug-in on vcode. Specific tutorials can be found in Bilibili. Recommended Tutorial [https://b23.tv/kibhGD] (https://b23.tv/kibhGD) +1. This project code is based on the ESP32-Pico Arduino platform of PlatformIO plug-in on vcode. Specific tutorials can be found in Bilibili. Recommended Tutorial [https://b23.tv/kibhGD](https://b23.tv/kibhGD) 2. Remember to modify the ` upload_port 'field in the ` platformio.ini' file under the project to correspond to its own COMM port. 3. At present, the latest version does not need to modify the SPI pins in the SPI library. A SPI library with modified SPI pins is placed separately under the ` lib ` of this project. The following are the actions of previous versions (negligible)