Skip to content

Commit 1977a12

Browse files
abetomoabetomo
authored
website: Add USB-CAN conversion software user manual (enactic#26)
1 parent bcbc5ca commit 1977a12

File tree

30 files changed

+245
-28
lines changed

30 files changed

+245
-28
lines changed

‎website/docs/index.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ DAMIAO モーター - 高精度・高安定性のロボットジョイント用
1010
import DocCardList from '@theme/DocCardList';
1111
import {useDocById} from '@docusaurus/plugin-content-docs/client';
1212
13-
export const ProductsList = () => {
14-
const productDocIds = [
15-
'products/dm-j4310-2ec-v1.1',
16-
'products/dm-j4340-2ec-v1.0',
17-
'products/dm-j4340p-2ec-v1.0',
18-
'products/dm-j8009p-2ec-v1.0',
19-
'products/dm-usbcu1',
13+
export const HardwareList = () => {
14+
const hardwareDocIds = [
15+
'products/hardware/dm-j4310-2ec-v1.1',
16+
'products/hardware/dm-j4340-2ec-v1.0',
17+
'products/hardware/dm-j4340p-2ec-v1.0',
18+
'products/hardware/dm-j8009p-2ec-v1.0',
19+
'products/hardware/dm-usbcu1',
2020
];
21-
const items = productDocIds.map((id) => {
21+
const items = hardwareDocIds.map((id) => {
2222
const doc = useDocById(id);
2323
return {
2424
type: 'link',
@@ -31,5 +31,5 @@ export const ProductsList = () => {
3131
return <DocCardList items={items} />;
3232
};
3333
34-
<ProductsList />
34+
<HardwareList />
3535
```

website/docs/products/dm-j4310-2ec-v1.1.mdx renamed to website/docs/products/hardware/dm-j4310-2ec-v1.1.mdx

File renamed without changes.

website/docs/products/dm-j4340-2ec-v1.0.mdx renamed to website/docs/products/hardware/dm-j4340-2ec-v1.0.mdx

File renamed without changes.

website/docs/products/dm-j4340p-2ec-v1.0.mdx renamed to website/docs/products/hardware/dm-j4340p-2ec-v1.0.mdx

File renamed without changes.

website/docs/products/dm-j8009p-2ec-v1.0.mdx renamed to website/docs/products/hardware/dm-j8009p-2ec-v1.0.mdx

File renamed without changes.

website/docs/products/dm-usbcu1.mdx renamed to website/docs/products/hardware/dm-usbcu1.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ import BlockImage from '@site/src/components/BlockImage';
1212

1313
本サイト全体のライセンスはApache License 2.0ですが、本資料および原文の資料にはライセンスを設定しません。
1414

15+
## USB-CAN変換ソフトウェア
16+
17+
USB-CAN変換ソフトウェアの使用マニュアルは<u>[こちら](/products/software/usb-can-conversion-software)</u>をご覧ください。
18+
1519
## 仕様情報
1620

1721
<table>

website/docs/products/index.mdx renamed to website/docs/products/hardware/index.mdx

File renamed without changes.

‎website/docs/products/software/index.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# ソフトウェア
6+
7+
```mdx-code-block
8+
import DocCardList from '@theme/DocCardList';
9+
10+
<DocCardList />
11+
```

‎website/docs/products/software/usb-can-conversion-software.mdx‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
---
2+
title: USB-CAN変換ソフトウェア
3+
description: USB-CAN変換ソフトウェアの日本語のマニュアルです。
4+
---
5+
6+
```mdx-code-block
7+
import BlockImage from '@site/src/components/BlockImage';
8+
```
9+
10+
[原文の使用マニュアル（中国語）](/pdf/products/usb-can-conversion-software.pdf)
11+
12+
本サイト全体のライセンスはApache License 2.0ですが、本資料および原文の資料にはライセンスを設定しません。
13+
14+
# USB-CAN変換ソフトウェア使用マニュアル
15+
16+
USB-CAN変換ソフトウェアは達妙科技が開発したソフトウェアで、デバッグモジュールを接続することでCANプロトコルパケットを可視化送信できます。
17+
本ソフトウェアとデバッグモジュールを併用することで、CANプロトコルデバイス（モーター、ジャイロスコープなど）のデバッグが非常に容易になります。
18+
19+
## 1. ソフトウェアのダウンロード
20+
21+
https://gitee.com/kit-miao/dm-tools/blob/master/USB%E8%BD%ACCAN/%E4%B8%8A%E4%BD%8D%E6%9C%BA/USB2CAN_2.0.0.3.exe
22+
23+
こちらのURLから「USB2CAN_2.0.0.3.exe」をダウンロードしてください。
24+
25+
<BlockImage src="products/usb-can-conversion-software/image1.png" />
26+
27+
「Download」をクリックし、ダウンロードが完了するまでお待ちください。
28+
29+
<BlockImage src="products/usb-can-conversion-software/image2.jpeg" />
30+
31+
`USB2CAN_2.0.0.3.exe`を実行すると次の画面が表示されます。
32+
33+
<BlockImage src="products/usb-can-conversion-software/image3.jpeg" />
34+
35+
## 2. デバッグモジュール（ハードウェア）
36+
37+
USBからCANへの変換でCANプロトコルパケットを送信するには、達妙科技公式のUSB-CAN変換モジュールとの併用が必要です。
38+
39+
購入リンク: https://www.switch-science.com/products/10933
40+
41+
デバッグモジュールはデータ転送機能付きType-C to USB-AケーブルでPCに接続する必要があります。
42+
USB-CAN変換ソフトウェアはUSBシリアルポートを使用します。
43+
**PCにCH340/CH341ドライバがインストールされていることを確認してください。**
44+
45+
<BlockImage src="products/usb-can-conversion-software/image4.jpeg" />
46+
47+
デバッグモジュールのCANインターフェースモデルはGH1.25-2pinです。
48+
受信機器のインターフェースに応じて配線を変更するか、変換基板を追加できます。
49+
50+
CAN配線順序に注意してください。
51+
**CAN_LはCAN_Lに、CAN_HはCAN_Hに接続してください。**
52+
53+
<BlockImage src="products/usb-can-conversion-software/image5.jpeg" />
54+
55+
デバッグモジュールを機器に接続した後、USB-CAN変換ソフトウェアを起動します。
56+
57+
## 3. USB-CAN変換ソフトウェアの使用
58+
59+
### 3.1. 基本機能の使用
60+
61+
<BlockImage src="products/usb-can-conversion-software/image6.jpeg" />
62+
63+
1. ファイルを開く
64+
2. 現在の送受信データを保存
65+
3. 現在のすべての送受信データをクリア
66+
4. カウンター
67+
5. ファームウェア更新
68+
6. バージョン情報と交流グループ
69+
70+
### 3.2. シリアルポート設定
71+
72+
シリアルポート番号は、デバッグモジュールに接続されているCOMポートを選択してください。
73+
74+
見つからない場合は、左下の「更新」をクリックするか、ドライバがインストールされているか確認してください。
75+
76+
* ボーレート：921600
77+
* データビット：8
78+
* チェックビット：None
79+
* ストップビット：One
80+
81+
これらのパラメータはデフォルトのままにしておいてください。
82+
83+
設定が完了したら、左下の赤枠内のリンクをクリックしてシリアルポートを開きます。
84+
85+
<BlockImage src="products/usb-can-conversion-software/image7.jpeg" />
86+
87+
接続が成功すると、左下の「切断」ボタンが赤と緑で点滅します。
88+
89+
<BlockImage src="products/usb-can-conversion-software/image8.jpeg" />
90+
91+
### 3.3. CAN通信設定
92+
93+
<BlockImage src="products/usb-can-conversion-software/image9.jpeg" />
94+
95+
#### 1
96+
97+
機器との通信に使用するボーレートを指定します。
98+
デフォルトは1000kbpsです。
99+
機器の設定ボーレートに合わせて設定してください。
100+
101+
現在以下のボーレートに対応しています。
102+
103+
<BlockImage src="products/usb-can-conversion-software/image10.jpeg" />
104+
105+
対応するボーレートを選択後、「设置（設定）」をクリックして更新を完了してください。
106+
107+
#### 2
108+
109+
フレームID（送信ID）：デバイスに送信するIDを指定します。
110+
ユーザーが自由に変更可能で、単位は16進数です。
111+
112+
#### 3
113+
114+
送信データ：デバイスに送信する8バイトのデータです。
115+
ユーザーが自由に変更可能で、単位は16進数です。
116+
117+
<BlockImage src="products/usb-can-conversion-software/image11.jpeg" />
118+
119+
#### 4
120+
121+
DATA递增（DATA増分）：チェックすると、送信回数が1回を超える場合、毎回送信されるデータが自動的に+1されます。
122+
123+
例：送信データが `01 00 00 00 00 00 00 00` で送信回数が2回の場合、送信されるデータは次のとおりです。
124+
125+
```
126+
01 00 00 00 00 00 00 00
127+
02 00 00 00 00 00 00 00
128+
```
129+
130+
データが `FF` になると繰り上がります。
131+
132+
例：送信データが `FF 00 00 00 00 00 00 00` の場合、次の送信データは `00 01 00 00 00 00 00 00`、さらに次は `01 01 00 00 00 00 00 00` になります。
133+
134+
ID递增（ID増分）：チェックすると、送信回数が1回を超える場合、各送信フレームのIDが自動的に+1されます。
135+
136+
#### 5
137+
138+
发送次数（送信回数）：クリック送信後にデバイスへ送信するデータ回数を設定できます。
139+
定时发送（定期送信）：送信回数が1を超える場合、各送信の間隔時間を設定します。
140+
141+
#### 6
142+
143+
帧格式（フレームフォーマット）：標準フレームと拡張フレームから選択できます。デバイスのフレームIDに基づいて選択します。
144+
帧类型（フレームタイプ）：データフレームとリモートフレームから選択できます。デバイスのCANプロトコルに基づいて選択します。
145+
146+
#### 7
147+
148+
发送（送信）：クリックするとCANデータを送信します。
149+
停止：クリックすると送信を一時停止します。
150+
151+
### 3.4. CAN送受信インターフェース
152+
153+
クリック後、CANデータの送信が成功した場合、状態は「发送成功（送信成功）」と表示されます。
154+
「发送失败（送信失敗）」と表示された場合は、シリアル通信、CANケーブルの配線、受信デバイスの正常性を確認してください。
155+
デバイスがCANデータを返す場合、インターフェースに受信データと各種パラメータが表示されます。
156+
157+
<BlockImage src="products/usb-can-conversion-software/image12.jpeg" />
158+
159+
### 3.5. シリアルポート
160+
161+
USBからCANへの変換もシリアルポート経由で送信可能で、デバッグモジュールのGH-1.25-3ピンインターフェースを介してデバイスを接続します。
162+
配線順序に注意し、GNDはGNDに、RXDはTXDに、TXDはRXDに接続してください。
163+
164+
<BlockImage src="products/usb-can-conversion-software/image13.jpeg" />
165+
166+
### 3.6. CAN負荷
167+
168+
USBからCANへの変換により、CANバスの負荷状況をリアルタイムで確認できます。
169+
170+
<BlockImage src="products/usb-can-conversion-software/image14.jpeg" />

‎website/docusaurus.config.ts‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,14 @@ const config: Config = {
9696
},
9797
items: [
9898
{
99-
to: 'products',
99+
to: 'products/hardware',
100100
position: 'left',
101-
label: 'Products',
101+
label: 'Hardware',
102+
},
103+
{
104+
to: 'products/software',
105+
position: 'left',
106+
label: 'Software',
102107
},
103108
{
104109
type: 'docSidebar',
@@ -119,7 +124,7 @@ const config: Config = {
119124
items: [
120125
{
121126
label: 'Products',
122-
to: '/products',
127+
to: '/products/hardware',
123128
},
124129
],
125130
},

0 commit comments

Comments
 (0)