Skip to content

Commit 86e12af

Browse files
committed
[rename] rename some api
1 parent 53f932e commit 86e12af

27 files changed

+1249
-879
lines changed

README.md

Lines changed: 78 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ xArm Python SDK
4242
- #### [UFACTORY ModbusTCP Manual](doc/UF_ModbusTCP_Manual.md)
4343

4444
## Update Summary
45+
- > ### 1.17.0
46+
- Change some API names
47+
4548
- > ### 1.16.0
4649
- Added parameter to support get raw data of the Six-axis Force Torque Sensor
4750
- Added an interface to control xArm Gripper G2
@@ -60,7 +63,7 @@ xArm Python SDK
6063
- Support the studio-2.5.0 blockly project conversion to python
6164

6265
- > ### 1.13.30
63-
- Supports obtaining unsaved track recording duration
66+
- Supports obtaining unsaved trajectory recording duration
6467
- Fix the abnormal path of running blockly program in some cases
6568
- Fix the return format of getting C23 and C38 errors
6669
- Supports obtaining identification status
@@ -83,7 +86,45 @@ xArm Python SDK
8386
- Add common motion api (Enabled after firmware version 1.11.100)
8487
- The Cartesian motion-related interface adds the motion_type parameter to determine the planning method (Enabled after firmware version 1.11.100)
8588

86-
- >### [More](ReleaseNotes.md)
89+
- > ### [More](ReleaseNotes.md)
90+
91+
## API Change List
92+
| OLD API NAME | NEW API NAME |
93+
| -------------- | ------------- |
94+
| set_impedance | set_ft_sensor_admittance_parameters |
95+
| set_impedance_mbk | set_ft_sensor_admittance_parameters |
96+
| set_impedance_config | set_ft_sensor_admittance_parameters |
97+
| set_force_control_pid | set_ft_sensor_force_parameters |
98+
| config_force_control | set_ft_sensor_force_parameters |
99+
| ft_sensor_set_zero | set_ft_sensor_zero |
100+
| ft_sensor_iden_load | iden_ft_sensor_load_offset |
101+
| ft_sensor_cali_load | set_ft_sensor_load_offset |
102+
| ft_sensor_enable | set_ft_sensor_enable |
103+
| ft_sensor_app_set | set_ft_sensor_mode |
104+
| ft_sensor_app_get | get_ft_sensor_mode |
105+
| get_linear_track_registers | get_linear_motor_registers |
106+
| get_linear_track_pos | get_linear_motor_pos |
107+
| get_linear_track_status | get_linear_motor_status |
108+
| get_linear_track_error | get_linear_motor_error |
109+
| get_linear_track_is_enabled | get_linear_motor_is_enabled |
110+
| get_linear_track_on_zero | get_linear_motor_on_zero |
111+
| get_linear_track_sci | get_linear_motor_sci |
112+
| get_linear_track_sco | get_linear_motor_sco |
113+
| clean_linear_track_error | clean_linear_motor_error |
114+
| set_linear_track_enable | set_linear_motor_enable |
115+
| set_linear_track_speed | set_linear_motor_speed |
116+
| set_linear_track_back_origin | set_linear_motor_back_origin |
117+
| set_linear_track_pos | set_linear_motor_pos |
118+
| set_linear_track_stop | set_linear_motor_stop |
119+
| get_suction_cup | get_vacuum_gripper |
120+
| set_suction_cup | set_vacuum_gripper |
121+
| shutdown_system | system_control |
122+
| get_ik | get_inverse_kinematics |
123+
| get_fk | get_forward_kinematics |
124+
| set_sleep_time | set_pause_time |
125+
| get_gpio_digital | get_tgpio_digital |
126+
| set_gpio_digital | set_tgpio_digital |
127+
| get_gpio_analog | get_tgpio_analog |
87128

88129

89130
## [Example](example/wrapper/)
@@ -180,7 +221,7 @@ xArm Python SDK
180221

181222
- ##### [8001-force_tech](example/wrapper/common/8001-force_tech.py)
182223

183-
- ##### [8002-impedance](example/wrapper/common/8002-impedance.py)
224+
- ##### [8002-admittance-control](example/wrapper/common/8002-admittance_control.py)
184225

185226
- ##### [8003-force_control](example/wrapper/common/8003-force_control.py)
186227

@@ -192,7 +233,7 @@ xArm Python SDK
192233

193234
- ##### [8010-get_ft_sensor_config](example/wrapper/common/8010-get_ft_sensor_config.py)
194235

195-
- ##### [9000-set_linear_track](example/wrapper/common/9000-set_linear_track.py)
236+
- ##### [9000-set_linear_motor](example/wrapper/common/9000-set_linear_motor.py)
196237

197238
- ##### [blockly_to_python](example/wrapper/tool/blockly_to_python.py)
198239

@@ -273,7 +314,7 @@ xArm Python SDK
273314
arm.save_conf()
274315
```
275316

276-
- #### Gripper
317+
- #### Gripper/Gripper G2
277318
```python
278319
arm.set_gripper_enable(...)
279320
arm.set_gripper_mode(...)
@@ -282,6 +323,10 @@ xArm Python SDK
282323
arm.get_gripper_position()
283324
arm.get_gripper_err_code()
284325
arm.clean_gripper_error()
326+
327+
# only Gripper G2
328+
arm.get_gripper_g2_position()
329+
arm.set_gripper_g2_position(...)
285330
```
286331

287332
- #### BIO Gripper
@@ -294,6 +339,10 @@ xArm Python SDK
294339
arm.get_bio_gripper_status()
295340
arm.get_bio_gripper_error()
296341
arm.clean_bio_gripper_error()
342+
343+
# only BIO Gripper G2
344+
arm.get_bio_gripper_g2_position()
345+
arm.set_bio_gripper_g2_position(...)
297346
```
298347

299348
- #### RobotIQ Gripper
@@ -311,6 +360,7 @@ xArm Python SDK
311360

312361
```python
313362
arm.set_tgpio_modbus_timeout(...)
363+
arm.get_tgpio_modbus_timeout(...)
314364
arm.set_tgpio_modbus_baudrate(...)
315365
arm.get_tgpio_modbus_baudrate(...)
316366
arm.getset_tgpio_modbus_data(...)
@@ -336,38 +386,35 @@ xArm Python SDK
336386
arm.set_cgpio_analog_with_xyz(...)
337387
```
338388

339-
- #### Linear Track
389+
- #### Linear Motor
340390

341391
```python
342-
arm.get_linear_track_pos()
343-
arm.get_linear_track_status()
344-
arm.get_linear_track_error()
345-
arm.get_linear_track_is_enabled()
346-
arm.get_linear_track_on_zero()
347-
arm.get_linear_track_sci()
348-
arm.get_linear_track_sco()
349-
350-
arm.clean_linear_track_error(...)
351-
arm.set_linear_track_enable(...)
352-
arm.set_linear_track_speed(...)
353-
arm.set_linear_track_back_origin(...)
354-
arm.set_linear_track_pos(...)
355-
arm.set_linear_track_stop(...)
392+
arm.get_linear_motor_pos()
393+
arm.get_linear_motor_status()
394+
arm.get_linear_motor_error()
395+
arm.get_linear_motor_is_enabled()
396+
arm.get_linear_motor_on_zero()
397+
arm.get_linear_motor_sci()
398+
arm.get_linear_motor_sco()
399+
400+
arm.clean_linear_motor_error(...)
401+
arm.set_linear_motor_enable(...)
402+
arm.set_linear_motor_speed(...)
403+
arm.set_linear_motor_back_origin(...)
404+
arm.set_linear_motor_pos(...)
405+
arm.set_linear_motor_stop(...)
356406
```
357407

358408
- #### FT Sensor
359409
```python
360-
arm.set_impedance(...)
361-
arm.set_impedance_mbk(...)
362-
arm.set_impedance_config(...)
363-
arm.config_force_control(...)
364-
arm.set_force_control_pid(...)
365-
arm.ft_sensor_set_zero(...)
366-
arm.ft_sensor_iden_load(...)
367-
arm.ft_sensor_cali_load(...)
368-
arm.ft_sensor_enable(...)
369-
arm.ft_sensor_app_set(...)
370-
arm.ft_sensor_app_get(...)
410+
arm.set_ft_sensor_enable(...)
411+
arm.set_ft_sensor_mode(...)
412+
arm.get_ft_sensor_mode(...)
413+
arm.set_ft_sensor_zero(...)
414+
arm.iden_ft_sensor_load_offset(...)
415+
arm.set_ft_sensor_load_offset(...)
416+
arm.set_ft_sensor_admittance_parameters(...)
417+
arm.set_ft_sensor_force_parameters(...)
371418
arm.get_ft_sensor_data(...)
372419
arm.get_ft_senfor_config(...)
373420
arm.get_ft_sensor_error(...)

ReleaseNotes.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
## Update Summary
44

5+
- > ### 1.17.0
6+
- Change some API names
7+
58
- > ### 1.16.0
69
- Added parameter to support get raw data of the Six-axis Force Torque Sensor
710
- Added an interface to control xArm Gripper G2
@@ -20,7 +23,7 @@
2023
- Support the studio-2.5.0 blockly project conversion to python
2124

2225
- > ### 1.13.30
23-
- Supports obtaining unsaved track recording duration
26+
- Supports obtaining unsaved trajectory recording duration
2427
- Fix the abnormal path of running blockly program in some cases
2528
- Fix the return format of getting C23 and C38 errors
2629
- Supports obtaining identification status
@@ -81,7 +84,7 @@
8184
- Support for blocky code conversion and operation of xArmStudio-1.8.0
8285
- The Velocity interface supports the duration parameter (requires firmware 1.8.0 or higher)
8386
- Added identification interface (current identification and torque identification)
84-
- Support linear track interface
87+
- Support linear motor interface
8588
- Support calling some studio APIs
8689

8790
- > ### 1.6.9

0 commit comments

Comments
 (0)