├── .gitignore
├── LICENSE
├── ReadMe.md
├── css
└── style.css
├── imgs
├── logo.svg
└── main.png
├── index.html
└── js
├── ansi_up.min.js
└── common.js
/.gitignore:
--------------------------------------------------------------------------------
1 | /.vscode
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/ReadMe.md:
--------------------------------------------------------------------------------
1 | # Web Serial Debug
2 |
3 | 浏览器串口调试工具
4 |
5 | 仅测试了 Edge 和 Chrome 浏览器,其他浏览器未测试是否可用
6 |
7 | 在线体验: [https://itldg.github.io/web-serial-debug/](https://itldg.github.io/web-serial-debug/)
8 |
9 | 国内体验: [https://www.itldg.com/web_serial_debug/](https://www.itldg.com/web_serial_debug/)
10 |
11 | ## 界面预览
12 |
13 | 
14 |
15 | ## 实现功能
16 |
17 | - 自动重连,设备插拔自动重连
18 | - 所有串口参数可设置更改,配置自动保存
19 | - 串口日志支持 HEX, TEXT 和 彩色ANSI,自动滚动
20 | - 分包合并,设定超时时间
21 | - 快捷发送列表,自定义分组,快捷导入导出
22 | - 配置文件导入导出,方便迁移
23 | - 自定义脚本,支持发送和接收数据处理
24 |
25 | ## 使用方法
26 |
27 | 先选择一个电脑连接的串口
28 |
29 | 调整串口参数后打开串口即可开始通讯
30 |
31 | 中间区域是串口日志,可以选择 HEX ,TEXT 或者 彩色ANSI 显示
32 |
33 | 下方是发送区域,可以选择 HEX 或者 TEXT 发送,定时循环发送
34 |
35 | 右侧可以自己添加一些常用指令,快捷发送
36 |
37 | ## 自定义脚本
38 |
39 | 自定义脚本可以在发送和接收数据时进行处理
40 |
41 | 脚本支持 JavaScript 语法,通过`postMessage`和`onmessage`进行通讯
42 |
43 | 如下是一个简单的脚本示例
44 |
45 | ```javascript
46 | addEventListener('message', function ({data}) {
47 | if(data.type=='uart_receive')
48 | {
49 | postMessage({type:'log',data:'消息长度:'+data.data.length});
50 | //原文答复
51 | postMessage({type:'uart_send',data:data.data});
52 | }
53 | })
54 | setInterval(function(){
55 | //定时发送
56 | postMessage({type:'uart_send_txt',data:'hello world'});
57 | },1000);
58 | ```
59 |
60 | `onmessage`接收到的数据格式如下
61 |
62 | ```js
63 | {
64 | "type":"uart_receive", //消息类型 String,目前仅支持 uart_receive
65 | "data":[0,1] //消息内容 Uint8Array
66 | }
67 | ```
68 |
69 | `postMessage`发送的数据格式如下
70 |
71 | ```js
72 | {
73 | "type":"uart_send",
74 | "data":[0,1]
75 | }
76 | ```
77 |
78 | | TYPE 类型 | DATA 数据格式 | 说明 |
79 | | ------------- | ------------- | ------------------ |
80 | | uart_send | Uint8Array | 发送字节数据 |
81 | | uart_send_txt | String | 发送文本数据 |
82 | | uart_send_hex | String | 发送十六进制字符串 |
83 | | log | String | 打印日志 |
84 |
85 |
86 | ## 开源
87 |
88 | 代码凌乱不堪,无学习价值
89 |
90 | 希望各位大佬可以协助添砖加瓦,让其更加完善
91 |
92 | 常用的朋友也可以提交一些常用的指令集,后续做一下常用指令集的整理
93 |
94 | 开源地址:[GitHub](https://github.com/itldg/web-serial-debug) | [Gitee](https://gitee.com/itldg/web-serial-debug)
95 |
--------------------------------------------------------------------------------
/css/style.css:
--------------------------------------------------------------------------------
1 | :root {
2 | --top-height: 63px;
3 | }
4 | html,
5 | body {
6 | height: 100%;
7 | }
8 | body {
9 | font-size: 0.875rem;
10 | }
11 | #main {
12 | height: calc(100% - var(--top-height));
13 | }
14 |
15 | #log-main {
16 | display: flex;
17 | flex-direction: column;
18 | height: 100%;
19 | }
20 | #serial-logs {
21 | overflow-y: scroll;
22 | white-space: pre-wrap;
23 | word-break: break-all;
24 | }
25 | #serial-logs.ansi {
26 | background-color: #000;
27 | color: #fff;
28 | }
29 | #serial-options,
30 | #serial-tools {
31 | position: relative;
32 | }
33 | .toggle-button {
34 | align-items: center;
35 | background: none;
36 | border: 0;
37 | display: flex;
38 | flex: none;
39 | font-size: 20px;
40 | height: 100%;
41 | justify-content: center;
42 | width: 20px;
43 | z-index: 1;
44 | background-color: #f8f9fa;
45 | }
46 | .toggle-button:hover {
47 | background: rgba(228, 231, 242, 0.4);
48 | }
49 |
50 | #serial-tools {
51 | height: 100%;
52 | }
53 | #nav-tabContent {
54 | overflow: hidden;
55 | }
56 | #serial-tools .collapse.show,
57 | #nav-quick-send.show {
58 | height: 100%;
59 | display: flex;
60 | flex-direction: column;
61 | }
62 | #nav-code {
63 | height: 100%;
64 | }
65 | #serial-code-editor .CodeMirror {
66 | height: 100%;
67 | }
68 | .CodeMirror-readonly {
69 | background-color: var(--bs-light-rgb);
70 | cursor: not-allowed;
71 | }
72 |
--------------------------------------------------------------------------------
/imgs/logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/imgs/main.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/itldg/web-serial-debug/c0fc58b9fe9f197f1b660e207c2af237c4cbdc47/imgs/main.png
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |