diff --git a/README_zh.md b/README_zh.md index d567b4a..88c7315 100644 --- a/README_zh.md +++ b/README_zh.md @@ -83,7 +83,7 @@ FlashDB 提供了全面的文档说明，详见：http://armink.gitee.io/flashdb ## 支持 - ![support](docs/_media/wechat_support.png) + ![support](docs/zh-cn/_media/wechat_support.png) 如果 FlashDB 解决了你的问题，不妨扫描上面二维码请我 **喝杯咖啡**~ diff --git a/docs/_coverpage.md b/docs/_coverpage.md index f2973f6..22c9336 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -11,5 +11,5 @@ - Key-Value database - Time series database -[GitHub](https://github.com/armink/FlashDB/) +[Introduction](/README.md) [Getting started](/quick-started) \ No newline at end of file diff --git a/docs/_media/wechat_support.png b/docs/_media/wechat_support.png deleted file mode 100644 index 03dfe0a..0000000 Binary files a/docs/_media/wechat_support.png and /dev/null differ diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 959cac8..becd83a 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -4,6 +4,7 @@ - [stm32f103ve](demo-stm32f103ve.md) - [stm32f405rg](demo-stm32f405rg.md) - [stm32f405rg-spi-flash](demo-stm32f405rg-spi-flash.md) + - [esp8266-spi-flash](demo-esp8266-spi-flash.md) - [Demo details](demo-details.md) - Samples - KV database diff --git a/docs/demo-esp8266-spi-flash.md b/docs/demo-esp8266-spi-flash.md new file mode 100644 index 0000000..0433aab --- /dev/null +++ b/docs/demo-esp8266-spi-flash.md @@ -0,0 +1,22 @@ +# Based on ESP8266 off-chip SPI-Flash demo + +Start a freertos task to run the flashDB routine, and then restart after 1000 seconds. Run log, please see the ESP8266_flashDB_log.rtf log in the current directory + +# ESP8266 Development Environment + +- Ubuntu 16.04 64-bit +- Use Espressif IDF: ESP8266_RTOS_SDK (version: ESP-IDF v3.2-252-g73bf28b-dirty), download: https://github.com/espressif/ESP8266_RTOS_SDK.git +- Install the cross-compilation tool chain, download: https://dl.espressif.com/dl/xtensa-lx106-elf-linux64-1.22.0-100-ge567ec7-5.2.0.tar.gz + +# ESP8266 Development Guide + +- For detailed installation and development tutorials, please refer to: https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/get-started/index.html + +# Compile and download + +- cd into the esp8266_spi_flash directory +- make all +- Use serial cable to connect 8266 development board to PC +- Enable the serial port, execute the command: sudo chmod 777 /dev/ttyUSB* +- make flash +- make monitor \ No newline at end of file diff --git a/docs/quick-started.md b/docs/quick-started.md index 85b4bc8..05eb99b 100644 --- a/docs/quick-started.md +++ b/docs/quick-started.md @@ -43,11 +43,12 @@ In the `demos` directory of the project, the following hardware demonstration pl For more detailed introduction, click on the **instructions** in the table below to view. -| Hardware Platform | Path | Flash Type | Instructions | -| --------------------- | ----------------------------- | :------------ | ---------------------------------------------------- | +| Hardware Platform | Path | Flash Type | Instructions | +| --------------------- | ----------------------------- | :------------ | ---------------------------------------------- | | stm32f10x | `demos/stm32f103ve` | stm32 on-chip | [click to view](demo-stm32f103ve.md) | | stm32f40x | `demos/stm32f405rg` | stm32 on-chip | [click to view](demo-stm32f405rg.md) | | stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [click to view](demo-stm32f405rg-spi-flash.md) | +| esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [click to view](demo-esp8266-spi-flash.md) | ## View sample description diff --git a/docs/zh-cn/_coverpage.md b/docs/zh-cn/_coverpage.md index 20aeb29..1767223 100644 --- a/docs/zh-cn/_coverpage.md +++ b/docs/zh-cn/_coverpage.md @@ -11,5 +11,5 @@ - 键值数据库 - 时序数据库 -[GitHub](https://github.com/armink/FlashDB/) +[介绍](zh-cn/README.md) [开始使用](zh-cn/quick-started) \ No newline at end of file diff --git a/docs/zh-cn/_media/wechat_support.png b/docs/zh-cn/_media/wechat_support.png index 03dfe0a..b8617da 100644 Binary files a/docs/zh-cn/_media/wechat_support.png and b/docs/zh-cn/_media/wechat_support.png differ diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md index 2a27d1f..7fd0983 100644 --- a/docs/zh-cn/_sidebar.md +++ b/docs/zh-cn/_sidebar.md @@ -4,6 +4,7 @@ - [stm32f103ve](zh-cn/demo-stm32f103ve.md) - [stm32f405rg](zh-cn/demo-stm32f405rg.md) - [stm32f405rg-spi-flash](zh-cn/demo-stm32f405rg-spi-flash.md) + - [esp8266-spi-flash](zh-cn/demo-esp8266-spi-flash.md) - [演示说明](zh-cn/demo-details.md) - 示例 - 键值数据库 diff --git a/docs/zh-cn/demo-esp8266-spi-flash.md b/docs/zh-cn/demo-esp8266-spi-flash.md new file mode 100644 index 0000000..9bc9376 --- /dev/null +++ b/docs/zh-cn/demo-esp8266-spi-flash.md @@ -0,0 +1,23 @@ +# 基于 ESP8266 片外 SPI-Flash 的演示 + +启动一个freertos任务运行flashDB的例程，然后倒计时1000秒后重启。运行log，请看当前目录下的ESP8266_flashDB_log.rtf 日志 + +# ESP8266开发环境 + +- Ubuntu 16.04 64位 +- 用乐鑫IDF:ESP8266_RTOS_SDK(版本:ESP-IDF v3.2-252-g73bf28b-dirty),下载:https://github.com/espressif/ESP8266_RTOS_SDK.git +- 安装交叉编译工具链，下载:https://dl.espressif.com/dl/xtensa-lx106-elf-linux64-1.22.0-100-ge567ec7-5.2.0.tar.gz + +# ESP8266开发指南 + +- 详细的安装开发教程，请参考:https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/get-started/index.html + +# 编译和下载 + +- cd进入esp8266_spi_flash目录 +- make all +- 使用串口线把8266开发板连接到PC +- 使能串口，执行命令：sudo chmod 777 /dev/ttyUSB* +- make flash +- make monitor + diff --git a/docs/zh-cn/quick-started.md b/docs/zh-cn/quick-started.md index ccec088..681f955 100644 --- a/docs/zh-cn/quick-started.md +++ b/docs/zh-cn/quick-started.md @@ -49,6 +49,7 @@ FlashDB 提供的演示工程默认支持两种工程： | stm32f10x | `demos/stm32f103ve` | stm32 on-chip | [点击查看](zh-cn/demo-stm32f103ve.md) | | stm32f40x | `demos/stm32f405rg` | stm32 on-chip | [点击查看](zh-cn/demo-stm32f405rg.md) | | stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [点击查看](zh-cn/demo-stm32f405rg-spi-flash.md) | +| esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [点击查看](zh-cn/demo-esp8266-spi-flash.md) | ## 查看示例说明