Skip to content

Commit 43de4f6

Browse files
committed
add note
1 parent 79fc8e4 commit 43de4f6

File tree

2 files changed

+141
-88
lines changed

2 files changed

+141
-88
lines changed

docs/README.md

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ get command refresh mode
376376

377377
- **Parameters**
378378

379-
- `id`: Joint id(`genre.Angle`) / int 1-6
379+
- `id`: Joint id(`genre.Angle`) / int 1-7
380380
- `degree`: degree value(`float`) (about -170 ~ 170)
381381
- `speed`: (`int`) 0 ~ 100
382382

@@ -399,7 +399,7 @@ get command refresh mode
399399

400400
- **Parameters**
401401

402-
- `degrees`: a list of degree value(`List[float]`), length 6.
402+
- `degrees`: a list of degree value(`List[float]`), length 7.
403403

404404
- `speed`: (`int`) 0 ~ 100
405405

@@ -586,7 +586,7 @@ get command refresh mode
586586
- **Parameters**
587587

588588
- `joint_id`: (`int`)
589-
- for mycobot: int 1-6.
589+
- for mycobot / mecharm: int 1-6.
590590
- for mypalletizer: int 1-4.
591591
- for myArm: int 1 - 7.
592592
- `direction`:
@@ -600,7 +600,10 @@ get command refresh mode
600600

601601
- **Parameters**
602602

603-
- `coord_id`: (`int`) 1 ~ 6
603+
- `coord_id`: (`int`)
604+
- for mycobot / mecharm: int 1-6.
605+
- for mypalletizer: int 1-4.
606+
- for myArm: int 1 - 7.
604607
- `direction`:
605608
- `speed`: 0 ~ 100
606609

@@ -648,7 +651,10 @@ get command refresh mode
648651

649652
- **Parameters**
650653

651-
- `joint_id`: (`int`) 1 ~ 6
654+
- `joint_id`: (`int`)
655+
- for mycobot / mecharm: int 1-6.
656+
- for mypalletizer: int 1-4.
657+
- for myArm: int 1 - 7.
652658
- `encoder`: 0 ~ 4096
653659

654660
### get_encoder
@@ -657,7 +663,11 @@ get command refresh mode
657663

658664
- **Description**:Obtain the specified joint potential value.
659665

660-
- **Parameters**: `joint_id`: (`int`) 1 ~ 6
666+
- **Parameters**:
667+
- `joint_id`: (`int`)
668+
- for mycobot / mecharm: int 1-6.
669+
- for mypalletizer: int 1-4.
670+
- for myArm: int 1 - 7.
661671

662672
- **Returns**: `encoder`: 0 ~ 4096
663673

@@ -703,7 +713,10 @@ get command refresh mode
703713
- **Description**: Sets the minimum angle for the specified joint.
704714

705715
- **Parameters**:
706-
- `id`: (`int`) joint id 1-6.
716+
- `id`: (`int`)
717+
- for mycobot / mecharm: int 1-6.
718+
- for mypalletizer: int 1-4.
719+
- for myArm: int 1 - 7.
707720
- `angle`: 0 - 180.
708721

709722
### set_joint_max
@@ -712,15 +725,22 @@ get command refresh mode
712725
- **Description**: Sets the maximum angle of the specified joint.
713726

714727
- **Parameters**:
715-
- `id`: (`int`) joint id 1-6.
728+
- `id`: (`int`) joint id
729+
- for mycobot / mecharm: int 1-6.
730+
- for mypalletizer: int 1-4.
731+
- for myArm: int 1 - 7.
716732
- `angle`: 0 - 180.
717733

718734
### get_joint_min_angle
719735

720736
- **Prototype**: `get_joint_min_angle()`
721737
- **Description**: Gets the minimum movement angle of the specified joint
722738

723-
- **Parameters**: `joint_id`: (`int`)
739+
- **Parameters**:
740+
- `joint_id`: (`int`)
741+
- for mycobot / mecharm: int 1-6.
742+
- for mypalletizer: int 1-4.
743+
- for myArm: int 1 - 7.
724744

725745
- **Returns**: angle value (`float`)
726746

@@ -730,7 +750,11 @@ get command refresh mode
730750

731751
- **Description**: Gets the maximum movement angle of the specified joint
732752

733-
- **Parameters**: `joint_id`: (`int`)
753+
- **Parameters**:
754+
- `joint_id`: (`int`)
755+
- for mycobot / mecharm: int 1-6.
756+
- for mypalletizer: int 1-4.
757+
- for myArm: int 1 - 7.
734758

735759
- **Returns**: angle value (`float`)
736760

@@ -742,7 +766,11 @@ get command refresh mode
742766

743767
- **Description**: Determine whether all steering gears are connected
744768

745-
- **Parameters**: `servo_id` (`int`) 1 ~ 6
769+
- **Parameters**:
770+
- `servo_id` (`int`)
771+
- for mycobot / mecharm: int 1-6.
772+
- for mypalletizer: int 1-4.
773+
- for myArm: int 1 - 7.
746774

747775
- **Returns**
748776

@@ -768,7 +796,10 @@ get command refresh mode
768796
- **Description**: Set the data parameters of the specified address of the steering gear.
769797

770798
- **Parameters**:
771-
- `servo_no`: Serial number of articulated steering gear, 1 - 6.
799+
- `servo_no (int)`: Serial number of articulated steering gear.
800+
- for mycobot / mecharm: int 1-6.
801+
- for mypalletizer: int 1-4.
802+
- for myArm: int 1 - 7.
772803
- `data_id`: Data address.
773804
- `value`: 0 - 4096
774805

@@ -779,7 +810,10 @@ get command refresh mode
779810

780811
- **Parameters**:
781812

782-
- `servo_no`: Serial number of articulated steering gear, 1 - 6.
813+
- `servo_no`: Serial number of articulated steering gear.
814+
- for mycobot / mecharm: int 1-6.
815+
- for mypalletizer: int 1-4.
816+
- for myArm: int 1 - 7.
783817
- `data_id`: Data address.
784818

785819
- **Returns**: `value`: 0 - 4096
@@ -794,23 +828,34 @@ get command refresh mode
794828
- **Description**: The current position of the calibration joint actuator is the angle zero point, and the corresponding potential value is 2048.
795829

796830
- **Parameters**:
797-
- `servo_no`: Serial number of articulated steering gear, 1 - 6.
831+
- `servo_no`: Serial number of articulated steering gear.
832+
- for mycobot / mecharm: int 1-6.
833+
- for mypalletizer: int 1-4.
834+
- for myArm: int 1 - 7.
798835

799836
### release_servo
800837

801838
- **Prototype**: `release_servo(servo_id)`
802839

803840
- **Description**: Power off designated servo
804841

805-
- **Parameters**: `servo_id`: 1 ~ 6
842+
- **Parameters**:
843+
- `servo_id`:
844+
- for mycobot / mecharm: int 1-6.
845+
- for mypalletizer: int 1-4.
846+
- for myArm: int 1 - 7.
806847

807848
### focus_servo
808849

809850
- **Prototype**: `focus_servo(servo_id)`
810851

811852
- **Description**: Power on designated servo
812853

813-
- **Parameters**: `servo_id`: 1 ~ 6
854+
- **Parameters**:
855+
- `servo_id`:
856+
- for mycobot / mecharm: int 1-6.
857+
- for mypalletizer: int 1-4.
858+
- for myArm: int 1 - 7.
814859

815860
## Atom IO
816861

0 commit comments

Comments
 (0)