[WIP] Add decoder doc #119
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
saiyan86
requested changes
May 29, 2022
|
|
||
| 当前Shifu无法对设备发出的信息进行解码和分析，只能忠实地照原样呈现原始信息。这会给用户的使用带来很大不便 —— 用户需要额外再编写或购买解码服务对原始信息进行处理。 | ||
|
|
||
| Shifu应当拥有这种功能，使用户不需要借助外力就可以第一时间理解设备发出的信息。 |
There was a problem hiding this comment.
Shifu应当拥有这种功能，使用户不需要二次开发就可以在deviceShifu中将设备发出的信息解码。
| type: int | ||
| ``` | ||
|
|
||
| 这样，deviceShifu在收到信息之后，就会知道第零位的数字表达的是是否open了。 |
|
|
||
| - 序（endian）：字节序，通俗理解就是阅读顺序 | ||
|
|
||
| 也就是说，我们需要用户来定义以上两个参数、一个表示类型的参数、一个表示API的参数和一个表示意义的参数。一个简单的配置例子如下： |
There was a problem hiding this comment.
|
|
||
| responseMsgType: formattedString | ||
|
|
||
| dictionaryDilimiter: ',' |
|
|
||
| ### 字符串 | ||
|
|
||
| **通用格式的字符串** |
|
|
||
|
|
||
| **无格式字符串** | ||
|
|
| @@ -0,0 +1,161 @@ | |||
| # Shifu 解码模块（Decode Module） | |||
|
|
||
| ## 解码流程 | ||
| 一个典型的解码流程如下图： | ||
| [](/img/decoder-flow.svg) |
|
|
||
| ### 设计非目标 | ||
| 本设计并不包括对于设备物理信号的解析和处理。当前，Shifu应该专注于数字化信息。 | ||
|
|
There was a problem hiding this comment.
需要加上一个sample application，几行代码即可，但是需要让读者知道站在应用开发者角度应该怎么使用这个功能
|
@seanli33056 what's the status of this? |
|
The flow chart can be like this |
can we translated it to English? Thanks! |
|
|
Obsolete. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This introduces the design doc for deviceShifu decoder, for a better explanation.
Will this PR make the community happier?
Yes.
Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes #Special notes for your reviewer:
Release note: