Skip to content

Commit

Permalink
📄 Docs: Updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dynesshely committed Mar 5, 2024
1 parent 7efcfd8 commit bde9ffe
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 35 deletions.
10 changes: 10 additions & 0 deletions KitX Docs.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"folders": [
{
"path": "."
}
],
"settings": {
"git.autorefresh": true
}
}
4 changes: 2 additions & 2 deletions docs/en/mobile/guide/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const L = (props, _) => h(
<L n="crypto" v="^3.0.3" u="Implementations of SHA, MD5, and HMAC cryptographic functions." />
<L n="device_info_plus" v="^9.1.1" u="Flutter plugin providing detailed information about the device (make, model, etc.), and Android or iOS version the app is running on." />
<L n="f_logs" v="^2.0.1" u="FLog provides quick &amp; simple logging solution. All logs are saved to the DB which can then be exported in files." />
<L n="flutter" v="^3.0.0" u="Visit flutter.io to get started." />
<L n="flutter" v="^3.3.0" u="Visit flutter.io to get started." />
<L n="flutter_blue_plus" v="^1.31.15" u="Flutter plugin for connecting and communicationg with Bluetooth Low Energy devices, on Android, iOS, and MacOS." />
<L n="flutter_chat_ui" v="^1.6.12" u="Actively maintained, community-driven chat UI implementation with an optional Firebase BaaS.
" />
Expand All @@ -65,7 +65,7 @@ const L = (props, _) => h(
<L n="sensors_plus" v="^4.0.2" u="Flutter plugin for accessing accelerometer, gyroscope, and magnetometer sensors." />
<L n="shared_preferences" v="^2.2.2" u="Flutter plugin for reading and writing simple key-value pairs. Wraps NSUserDefaults on iOS and SharedPreferences on Android." />
<L n="sliding_up_panel" v="^2.0.0+1" u="A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!" />
<L n="url_launcher" v="^6.2.4" u="Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes." />
<L n="url_launcher" v="^6.2.5" u="Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes." />
<L n="vibration" v="^1.8.4" u="A plugin for handling Vibration API on iOS, Android, and web." />
<L n="wakelock_plus" v="^1.1.4" u="Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on Android, iOS, macOS, Windows, Linux, and web." />
<!--End PackagesTable-->
Expand Down
4 changes: 2 additions & 2 deletions docs/mobile/guide/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const L = (props, _) => h(
<L n="crypto" v="^3.0.3" u="Implementations of SHA, MD5, and HMAC cryptographic functions." />
<L n="device_info_plus" v="^9.1.1" u="Flutter plugin providing detailed information about the device (make, model, etc.), and Android or iOS version the app is running on." />
<L n="f_logs" v="^2.0.1" u="FLog provides quick &amp; simple logging solution. All logs are saved to the DB which can then be exported in files." />
<L n="flutter" v="^3.0.0" u="Visit flutter.io to get started." />
<L n="flutter" v="^3.3.0" u="Visit flutter.io to get started." />
<L n="flutter_blue_plus" v="^1.31.15" u="Flutter plugin for connecting and communicationg with Bluetooth Low Energy devices, on Android, iOS, and MacOS." />
<L n="flutter_chat_ui" v="^1.6.12" u="Actively maintained, community-driven chat UI implementation with an optional Firebase BaaS.
" />
Expand All @@ -65,7 +65,7 @@ const L = (props, _) => h(
<L n="sensors_plus" v="^4.0.2" u="Flutter plugin for accessing accelerometer, gyroscope, and magnetometer sensors." />
<L n="shared_preferences" v="^2.2.2" u="Flutter plugin for reading and writing simple key-value pairs. Wraps NSUserDefaults on iOS and SharedPreferences on Android." />
<L n="sliding_up_panel" v="^2.0.0+1" u="A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!" />
<L n="url_launcher" v="^6.2.4" u="Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes." />
<L n="url_launcher" v="^6.2.5" u="Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes." />
<L n="vibration" v="^1.8.4" u="A plugin for handling Vibration API on iOS, Android, and web." />
<L n="wakelock_plus" v="^1.1.4" u="Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on Android, iOS, macOS, Windows, Linux, and web." />
<!--End PackagesTable-->
Expand Down
33 changes: 2 additions & 31 deletions docs/rules/network/kitx-dashboard-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,35 +36,6 @@ description: 这篇文章是有关 KitX Dashboard 网络
>
> 报文协议: [KWC](kitx-web-command.md)
暴露如下 APIs
在本地访问 `http://localhost:<devicesServerPort>/swagger` 可以打开 Swagger

### /Device

- `[GET]` /
- `[FromQuery]` Token // 访问令牌
- 获取设备信息
- `[POST]` /ExchangeKey
- `[FromQuery]` Key // 密钥
- `[FromQuery]` KeyId // 密钥标识
- `[FromQuery]` DecryptionVerifyCode // 密钥解密验证码
- 发起密钥交换流程
- `[POST]` /ExchangeKeyBack
- `[FromQuery]` Key // 本机密钥
- `[FromQuery]` KeyId // 密钥标识
- 返回本机密钥 (由被调用 /ExchangeKey 的设备向发起方调用该 API 来完成密钥交换过程)
- `[POST]` /Swap
- `[FromQuery]` Token // 访问令牌
- // ToDo
- 移交主控 (由主控向从控发起)
- `[GET]` /Connect
- `[FromQuery]` KeyId // 密钥标识
- `[FromQuery]` VerifyCode // 验证码
- `[FromQuery]` VerifyAnwser // 验证答案
- `[FromQuery]` GivenToken // 加密的 Client Token
- Host 根据 KeyId 使用对应的 Key 解密 VerifyCode, 若结果与 VerifyAnwser 一致, 则身份验证通过, 解密并存储 Client Token, 返回 Host Token

### /Plugin

- `[GET]` /Request
- `[FromQuery]` Token // 访问令牌
- `[FromQuery]` Request // 请求报文 ([KWC](kitx-web-command.md) 格式)
在线 Api 文档我们正在开发, 请稍安勿躁 ~

0 comments on commit bde9ffe

Please sign in to comment.