update directory structure

This commit is contained in:
Donggang Cao 2020-10-24 16:59:49 +08:00
parent 40d0a07254
commit 543e2c59d0
14 changed files with 122 additions and 31 deletions

View File

@ -45,15 +45,23 @@ module.exports = {
}, },
{ {
text: '内核', text: '内核',
link: '/doc/kernel.html', link: '/doc/kernel/',
}, },
{ {
text: '驱动', text: '硬件支持',
link: '/doc/driver.html', link: '/doc/hwsupport/',
},
{
text: '通信协议',
link: '/doc/communication/',
},
{
text: '传感器',
link: '/doc/sensor/',
}, },
{ {
text: '应用开发', text: '应用开发',
link: '/doc/appdev.html', link: '/doc/appdev/',
} }
] ]
}, },
@ -99,7 +107,7 @@ module.exports = {
}, },
{ {
title: '硬件支持', title: '硬件支持',
children: getSidebarByCategory('framework','en') children: getSidebarByCategory('hwsupport','en')
}, },
{ {
title: '通信协议', title: '通信协议',
@ -108,6 +116,10 @@ module.exports = {
{ {
title: '传感器', title: '传感器',
children: getSidebarByCategory('sensor','en') children: getSidebarByCategory('sensor','en')
},
{
title: '应用开发',
children: getSidebarByCategory('appdev','en')
} }
], ],
} }

View File

@ -1,23 +1,20 @@
const sidebar = { const sidebar = {
'intro': [ 'intro': [
'/doc/intro', '/doc/intro',
'/doc/constructenv/bianyi',
'/doc/constructenv/debug',
'/doc/constructenv/goujian'
], ],
'kernel': [ 'kernel': [
'/doc/kernel/mm', '/doc/kernel/mm',
'/doc/kernel/task', '/doc/kernel/task',
'/doc/kernel/synchron', '/doc/kernel/synchron',
'/doc/kernel/threadcommunication' '/doc/kernel/threadcommunication'
], ],
'framework': [ 'hwsupport': [
'/doc/hwsupport/aiit-arm32', '/doc/hwsupport/aiit-arm32',
'/doc/hwsupport/stm32f407-st-discovery', '/doc/hwsupport/stm32f407-st-discovery',
'/doc/hwsupport/stm32f407zgt6', '/doc/hwsupport/stm32f407zgt6',
'/doc/hwsupport/hifive1-rev', '/doc/hwsupport/hifive1-rev',
'/doc/hwsupport/maxgo', '/doc/hwsupport/maxgo',
'/doc/hwsupport/kd233' '/doc/hwsupport/kd233'
], ],
'communication': [ 'communication': [
'/doc/communication/4G', '/doc/communication/4G',
@ -42,6 +39,11 @@ const sidebar = {
'/doc/sensor/photoelec_sensor', '/doc/sensor/photoelec_sensor',
'/doc/sensor/pressure_sensor', '/doc/sensor/pressure_sensor',
'/doc/sensor/voice_sensor' '/doc/sensor/voice_sensor'
],
'appdev': [
'/doc/appdev/env',
'/doc/appdev/debug',
'/doc/appdev/dev'
] ]
} }
@ -58,4 +60,4 @@ function getSidebarByCategory(category, lang = 'en') {
module.exports = { module.exports = {
getSidebarByCategory getSidebarByCategory
} }

View File

@ -1 +0,0 @@
# API

View File

@ -1 +0,0 @@
# 应用开发

View File

@ -0,0 +1,7 @@
# 应用开发
* [开发环境](/doc/appdev/env)
* [调试工具](/doc/appdev/debug)
* [开发过程](/doc/appdev/dev)

View File

@ -1,4 +1,4 @@
# 编译步骤 # 用Jlink调试
## 前言 ## 前言
@ -84,4 +84,4 @@
display: table-cell; display: table-cell;
text-align: center; text-align: center;
} }
</style> </style>

View File

@ -1,4 +1,4 @@
# 编译步骤 # 开发步骤
## 前言 ## 前言
<p style="text-indent:2em">本文档将介绍<B>XiUOS</B>分别在基于ARM和RISC-V架构的开发板上的编译、烧录和运行的过程。包括开发板选择及配置初始化、编译命令等信息。 <p style="text-indent:2em">本文档将介绍<B>XiUOS</B>分别在基于ARM和RISC-V架构的开发板上的编译、烧录和运行的过程。包括开发板选择及配置初始化、编译命令等信息。
@ -53,4 +53,4 @@
+ <B>XiUOS</B>运行在RISC-V开发板 + <B>XiUOS</B>运行在RISC-V开发板
<img src="https://raw.githubusercontent.com/yanyannew/images/branch/riscv_run_gui.png" /> <img src="https://raw.githubusercontent.com/yanyannew/images/branch/riscv_run_gui.png" />
## FAQ ## FAQ

View File

@ -1,4 +1,4 @@
# 编译环境 # 开发环境
## 前言 ## 前言
<p style="text-indent:2em">本文档将介绍如何在个人pc设备上构建编译环境来编译 <B>XiUOS</B> <p style="text-indent:2em">本文档将介绍如何在个人pc设备上构建编译环境来编译 <B>XiUOS</B>

View File

@ -24,7 +24,9 @@
</div> </div>
<br/> <br/>
产品描述EC20 Mini PCIe内嵌丰富的网络协议集成多个工业标准接口并支持多种软件功能(Windows XP, Windows Vista, Windows 7/8/8.1/10, Windows CE, Linux 和 Android 系统下的USB驱动,eCall*等)极大地拓展了其在M2M 领域的应用范围如CPE、路由器、数据卡、平板电脑、车载、安防以及工业级PDA等</br></br>
产品描述EC20 Mini PCIe内嵌丰富的网络协议集成多个工业标准接口并支持多种软件功能(Windows XP, Windows Vista, Windows 7/8/8.1/10, Windows CE, Linux 和 Android 系统下的USB驱动,eCall\*等)极大地拓展了其在M2M 领域的应用范围如CPE、路由器、数据卡、平板电脑、车载、安防以及工业级PDA等</br></br>
EC20 Mini PCIe是采用 PCI Express® Mini Card标准接口的LTE模块采用LTE 3GPP Rel.9技术支持最大下行速率100Mbps和最大上行速率50Mbps。EC20 Mini PCIe系列模块包含EC20-E Mini PCIe、EC20-A Mini PCIe和EC20-C Mini PCIe三个版本使其能够向后兼容现存的EDGE和GSM/GPRS网络以确保在缺乏3G和4G网络的偏远地区也能正常工作。</br> EC20 Mini PCIe是采用 PCI Express® Mini Card标准接口的LTE模块采用LTE 3GPP Rel.9技术支持最大下行速率100Mbps和最大上行速率50Mbps。EC20 Mini PCIe系列模块包含EC20-E Mini PCIe、EC20-A Mini PCIe和EC20-C Mini PCIe三个版本使其能够向后兼容现存的EDGE和GSM/GPRS网络以确保在缺乏3G和4G网络的偏远地区也能正常工作。</br>
</br> </br>
@ -255,4 +257,4 @@ EC200T 内置丰富的网络协议,集成多个工业标准接口,并支持
&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;(1024) The maximum length of receive line buffer ---> 缓存大小建议在1K以上</br> &ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;(1024) The maximum length of receive line buffer ---> 缓存大小建议在1K以上</br>
<div> <div>
<img src = "./imagesrc/ec20_CodeTree.png" alt="ec20_CodeTree" width =300 > <img src = "./imagesrc/ec20_CodeTree.png" alt="ec20_CodeTree" width =300 >
</div> </div>

View File

@ -0,0 +1,26 @@
# 通信协议
- [4G](/doc/communication/4G)
- [5G](/doc/communication/5G)
- [at](/doc/communication/at)
- [Bluetooth](/doc/communication/Bluetooth)
- [CAN](/doc/communication/CAN)
- [Ethernet](/doc/communication/ethernet)
- [LoRa](/doc/communication/LORA)
- [MQTT](/doc/communication/mymqtt)
- [NB-IOT](/doc/communication/NB-IOT)
- [rs485](/doc/communication/rs485)
- [WiFi](/doc/communication/WiFi)
- [Zibgee](/doc/communication/Zigbee)

View File

@ -1 +0,0 @@
# 驱动

View File

@ -0,0 +1,17 @@
# 硬件支持
## ARM
* [aiit-arm32](/doc/hwsupport/aiit-arm32)
* [stm32f407-st-discovery](/doc/hwsupport/stm32f407-st-discovery)
* [stm32f407zgt6](/doc/hwsupport/stm32f407zgt6)
## RISC-V
* [hifive1-re](/doc/hwsupport/hifive1-rev)
* [maxgo](/doc/hwsupport/maxg)
* [kd233](/doc/hwsupport/kd233)

10
docs/doc/kernel/README.md Normal file
View File

@ -0,0 +1,10 @@
# 内核
- [内存管理](/doc/kernel/mm)
- [线程管理](/doc/kernel/task)
- [资源管理](/doc/kernel/synchron)
- [线程间通信](/doc/kernel/threadcommunication)

18
docs/doc/sensor/README.md Normal file
View File

@ -0,0 +1,18 @@
# 传感器
- [力敏传感器](/doc/sensor/force_sensor)
- [气敏传感器](/doc/sensor/gas_sensor)
- [热敏传感器](/doc/sensor/heat_sensor)
- [湿敏传感器](/doc/sensor/humidity_sensor)
- [磁敏传感器](/doc/sensor/magneto_sensor)
- [光电传感器](/doc/sensor/photoelec_sensor)
- [压强传感器](/doc/sensor/pressure_sensor)
- [声音传感器](/doc/sensor/voice_sensor)