Skip to content

Commit 049017a

Browse files
committed
Format docs
1 parent 07f8a8c commit 049017a

File tree

2 files changed

+22
-26
lines changed

2 files changed

+22
-26
lines changed

docs/en/README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ void loop() {
5454

5555
## Protocol
5656

57-
Protocol CanHacker (lawicel) described in (CanHacker for Windows documentation)[http://www.mictronics.de/projects/usb-can-bus/]
57+
Protocol CanHacker (lawicel) described in [CanHacker for Windows documentation](http://www.mictronics.de/projects/usb-can-bus/)
5858

5959
Library implements it partially. Suported commands listed below.
6060

@@ -80,7 +80,7 @@ Return: [CR]
8080

8181
Set acceptance code. This command works only if controller in reset mode.
8282

83-
xxxxxxxx = Acceptance Code in hexadecimal
83+
xxxxxxxx - Acceptance Code in hexadecimal
8484

8585
Default value after power-up is 0x00000000 to receive all frames.
8686

@@ -90,7 +90,7 @@ Return: [CR] or [BEL]
9090

9191
Set acceptance mask. This command works only if controller is setup with command `S` and in reset mode.
9292

93-
xxxxxxxx = Acceptance Mask in hexadecimal
93+
xxxxxxxx - Acceptance Mask in hexadecimal
9494

9595
Default value after power-up is 0xFFFFFFFF to receive all frames.
9696

@@ -102,7 +102,7 @@ Read serial number from device.
102102

103103
Return: Nxxxx[CR]
104104

105-
xxxx = Serial number in alphanumeric characters.
105+
xxxx - Serial number in alphanumeric characters.
106106

107107
### `O[CR]`
108108

@@ -195,8 +195,8 @@ Read detailed firmware version from device.
195195
Return: vmami[CR]
196196

197197
```
198-
ma = major version number
199-
mi = minor version number
198+
ma - major version number
199+
mi - minor version number
200200
```
201201

202202
### `Zv[CR]`
@@ -213,26 +213,24 @@ Each increment time stamp indicates 1ms within the 60000ms frame.
213213

214214
All incoming frames are sent after successful receiving, optional with time stamp.
215215

216-
No polling is needed.
216+
No polling is needed. They will be sent in the following format:
217217

218-
They will be sent in the following format:
219-
220-
11 Bit ID Frame
218+
11 bit ID Frame
221219
```
222220
tiiiLDDDDDDDDDDDDDDDD[ssss][CR]
223221
```
224222

225-
11 Bit ID Remote Frame
223+
11 bit ID Remote Frame
226224
```
227225
riiiL[ssss][CR]
228226
```
229227

230-
29 Bit ID Frame
228+
29 bit ID Frame
231229
```
232230
TiiiiiiiiLDDDDDDDDDDDDDDDD[ssss][CR]
233231
```
234232

235-
29 Bit ID RemoteFrame
233+
29 bit ID Remote Frame
236234
```
237235
RiiiiiiiiL[ssss][CR]
238236
```

docs/ru/README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ void loop() {
5454

5555
## Протокол
5656

57-
Протокол CanHacker (lawicel) описан в (документации к приложению CanHacker)[http://www.mictronics.de/projects/usb-can-bus/]
57+
Протокол CanHacker (lawicel) описан в [документации к приложению CanHacker](http://www.mictronics.de/projects/usb-can-bus/)
5858

5959
Библиотека реализует его не полностью. Поддерживаемые комманды приведены ниже.
6060

@@ -78,7 +78,7 @@ void loop() {
7878

7979
Установить код фильтра. Эта комманда доступна только в режиме сброса.
8080

81-
xxxxxxxx = Код в hexadecimal
81+
xxxxxxxx - код в hexadecimal
8282

8383
Значение по-уолчанию после загузки 0x00000000 для приема всех сообщений.
8484

@@ -88,7 +88,7 @@ xxxxxxxx = Код в hexadecimal
8888

8989
Установить маску фильтра. Эта комманда доступна только в режиме сброса.
9090

91-
xxxxxxxx = Маска в hexadecimal
91+
xxxxxxxx - маска в hexadecimal
9292

9393
Значение по-уолчанию после загузки 0xFFFFFFFF для приема всех сообщений.
9494

@@ -100,7 +100,7 @@ xxxxxxxx = Маска в hexadecimal
100100

101101
Возвращает: Nxxxx[CR]
102102

103-
xxxx = Серийный номер в цифро-алфавитных символах.
103+
xxxx - серийный номер в цифро-алфавитных символах.
104104

105105
### `O[CR]`
106106

@@ -192,8 +192,8 @@ ff - версия программного обеспечения
192192
Возвращает: vmami[CR]
193193

194194
```
195-
ma = мажорный номер версии
196-
mi = минорный номер версии
195+
ma - мажорный номер версии
196+
mi - минорный номер версии
197197
```
198198

199199
### `Zv[CR]`
@@ -210,26 +210,24 @@ mi = минорный номер версии
210210

211211
Все вхоядщие фреймы передаются сразу после получения, опционально с временной меткой.
212212

213-
Опрос не требуется.
213+
Опрос не требуется. Отправляются в следующем формате:
214214

215-
Они отправляются в следующем формате:
216-
217-
11 Bit ID фрейм
215+
11 bit ID фрейм
218216
```
219217
tiiiLDDDDDDDDDDDDDDDD[ssss][CR]
220218
```
221219

222-
11 Bit ID Remote фрейм
220+
11 bit ID Remote фрейм
223221
```
224222
riiiL[ssss][CR]
225223
```
226224

227-
29 Bit ID фрейм
225+
29 bit ID фрейм
228226
```
229227
TiiiiiiiiLDDDDDDDDDDDDDDDD[ssss][CR]
230228
```
231229

232-
29 Bit ID Remote фрейм
230+
29 bit ID Remote фрейм
233231
```
234232
RiiiiiiiiL[ssss][CR]
235233
```

0 commit comments

Comments
 (0)