Skip to content

Commit 76c8800

Browse files
committed
[fix] fix doc error and doc tool
1 parent e8e49ad commit 76c8800

10 files changed

Lines changed: 1016 additions & 97 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ xArm Python SDK
1111
- Protect the arm before unlocking the joint.
1212

1313
## Installation
14-
  you can run examples without installation.Only Python3 is supported.
14+
  you can run examples without installation. Only Python 3 is supported.
1515
- Install from source code
1616
- download
1717
```bash
@@ -42,11 +42,11 @@ xArm Python SDK
4242
- #### [UFACTORY ModbusTCP Manual](doc/UF_ModbusTCP_Manual.md)
4343

4444
## Update Summary
45-
- > ### 1.18.3
45+
- > ### 1.18.3/1.18.4
4646
- Added BytesData for data conversion
4747
- Added data structure for report data
4848
- Update the reported data for port 30002
49-
- Increase execution speed by adding paramster to reduce the number of checks performed by the gripper apis
49+
- Increase execution speed by adding parameter to reduce the number of checks performed by the gripper APIs
5050

5151
- > ### 1.17.0/1.17.1
5252
- Change some API names
@@ -321,7 +321,7 @@ xArm Python SDK
321321
```python
322322
arm.set_bio_gripper_enable(...)
323323
arm.set_bio_gripper_speed(...)
324-
arm.open_bio_grippe(...)
324+
arm.open_bio_gripper(...)
325325
arm.close_bio_gripper(...)
326326
arm.get_bio_gripper_status()
327327
arm.get_bio_gripper_error()
@@ -403,7 +403,7 @@ xArm Python SDK
403403
arm.set_ft_sensor_admittance_parameters(...)
404404
arm.set_ft_sensor_force_parameters(...)
405405
arm.get_ft_sensor_data(...)
406-
arm.get_ft_senfor_config(...)
406+
arm.get_ft_sensor_config(...)
407407
arm.get_ft_sensor_error(...)
408408
```
409409

ReleaseNotes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# xArm-Python-SDK Release Notes
22

33
## Update Summary
4-
- > ### 1.18.3
4+
- > ### 1.18.3/1.18.4
55
- Added BytesData for data conversion
66
- Added data structure for report data
77
- Update the reported data for port 30002
8-
- Increase execution speed by adding paramster to reduce the number of checks performed by the gripper apis
8+
- Increase execution speed by adding parameter to reduce the number of checks performed by the gripper APIs
99

10-
- > ### 1.17.0/1.7.1
10+
- > ### 1.17.0/1.17.1
1111
- Change some API names
1212

1313
- > ### 1.16.0
@@ -98,7 +98,7 @@
9898
- Support velocity control
9999
- Support calibrate tcp offset and user offset
100100

101-
- - > ### 1.6.5
101+
- > ### 1.6.5
102102
103103
- Support for blocky code conversion and operation of xArmStudio1.6.5
104104

@@ -115,7 +115,7 @@
115115

116116
- > ### 1.5.0
117117
118-
- The new parameter of `set_servo_cartisian` interface is used to support servo cartisian movement of tool coordinate system
118+
- The new parameter of `set_servo_cartesian` interface is used to support servo cartesian movement of tool coordinate system
119119
- Support delayed trigger digital IO
120120
- Support position detection trigger digital IO
121121
- Support configure the stop state to automatically reset IO signal

doc/UF_ModbusTCP_Manual.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
// Exception: XX is the exception code
1919
00 01 00 00 00 03 01 81 XX
2020
```
21-
- __0x05__: Write single coil, according to Modbus protocol, specified data can only be 0xFF00 or 0x0000,for wriring 1 or 0 to the register.
21+
- __0x05__: Write single coil, according to Modbus protocol, specified data can only be 0xFF00 or 0x0000,for writing 1 or 0 to the register.
2222
```C++
2323
// sample request and response / exception
2424
// Request: Write 1 to register address 0x0002 (0xFF00 for writing 1, 0x0000 for writing 0)
@@ -44,7 +44,7 @@
4444
// sample request and response / exception
4545
// Request: Read 16 consecutive registers from address 0x0000
4646
00 01 00 00 00 06 01 02 00 00 00 10
47-
// Response:: every bit in the Received data (0xFF 0x00 here as an example) represents the corresponding register value in order
47+
// Response: every bit in the Received data (0xFF 0x00 here as an example) represents the corresponding register value in order
4848
00 01 00 00 00 05 01 02 02 FF 00
4949
// Exception: XX is the exception code
5050
00 01 00 00 00 03 01 82 XX
@@ -55,7 +55,7 @@
5555
// sample request and response / exception
5656
// Request: read 2 consecutive holding registers starting from address 0x0003
5757
00 01 00 00 00 06 01 03 00 03 00 02
58-
// Response:: Received values of the two registers are (00 05) and (00 06) as an example here
58+
// Response: Received values of the two registers are (00 05) and (00 06) as an example here
5959
00 01 00 00 00 07 01 03 04 00 05 00 06
6060
// Exception: XX is the exception code
6161
00 01 00 00 00 03 01 83 XX
@@ -86,7 +86,7 @@
8686
// sample request and response / exception
8787
// Request: write to register address of 0x0000 with mask.
8888
// "AND" operation mask is (00 0F),"OR" operation mask is (0F 00)
89-
// If the value before this operation is "val", then after the mask opeation it becomes: (val & 0x000F) | (0x0F00 & ~0x000F)
89+
// If the value before this operation is "val", then after the mask operation it becomes: (val & 0x000F) | (0x0F00 & ~0x000F)
9090
00 04 00 00 00 08 01 16 00 00 00 0F 0F 00
9191
// Response:
9292
00 04 00 00 00 08 01 16 00 00 00 0F 0F 00
@@ -108,7 +108,7 @@
108108
- 0x04: Read multiple input registers
109109
```C++
110110
// sample request and response / exception
111-
// Request: read 2 consecutive holding registers from address 0x0003
111+
// Request: read 2 consecutive input registers from address 0x0003
112112
00 01 00 00 00 06 01 04 00 03 00 02
113113
// Response: Received 2 values are (00 0E) and (00 13) as an example
114114
00 01 00 00 00 07 01 04 04 00 0E 00 13
@@ -117,7 +117,7 @@
117117
```
118118

119119
# Exception code explanation
120-
- __0x01__: Illegal/Unsuppported function code
120+
- __0x01__: Illegal/Unsupported function code
121121
- __0x02__: Illegal target address
122122
- __0x03__: Exception of requested data
123123

@@ -171,13 +171,13 @@
171171
| 32 | 0x20 | Robot Error code |
172172
| 33 | 0x21 | Robot Warning code |
173173
| 34 ~ 35 | 0x22 ~ 0x23 | Counter value (0x22 stores the higher 16-bit, 0x23 stores the lower 16-bit) |
174-
| 36 ~ 63 | 0x23 ~ 0x3F | Reserved |
174+
| 36 ~ 63 | 0x24 ~ 0x3F | Reserved |
175175
| 64 ~ 72 | 0x40 ~ 0x48 | Current TCP coordinate of x/y/z/roll/pitch/yaw/rx/ry/rz values, register values are 10 times the real numbers (unit: mm, degree) |
176176
| 73 ~ 76 | 0x49 ~ 0x4C | TCP payload mass(1000x)/center_x(10x)/center_y(10x)/center_z(10x) (unit: kg, mm) |
177177
| 77 ~ 82 | 0x4D ~ 0x52 | TCP Offset, register values are 10 times the real numbers(unit: mm, degree) |
178178
| 83 ~ 88 | 0x53 ~ 0x58 | User/world coordinate offset, register values are 10 times the real numbers(unit: mm, degree) |
179179
| 89 ~ 95 | 0x59 ~ 0x5F | joint (J1-J7) angles, register values are 10 times the real numbers(unit: degree) |
180-
| 86 ~ 102 | 0x60 ~ 0x66 | joint (J1-J7) temperature (unit: degree Celsius) |
180+
| 96 ~ 102 | 0x60 ~ 0x66 | joint (J1-J7) temperature (unit: degree Celsius) |
181181
| 103 ~ 109 | 0x67 ~ 0x6D | joint (J1-J7) speed, register values are 10 times the real numbers(unit: degree/s) |
182182
| 110 | 0x6E | Robot TCP linear speed, register values are 10 times the real numbers(unit: mm/s) |
183183
| 111 ~ 127 | 0x6F ~ 0x7F | Reserved |

0 commit comments

Comments
 (0)