Skip to content

Commit c40254f

Browse files
committed
doc: update README for Atom2.5
1 parent aa26577 commit c40254f

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
# This is Python API for myCobot
22

3-
If you want to install it separately.
3+
This is a python API for serial communication with mycobot and controlling it.
4+
5+
<!--![](./f3-min2.jpg)-->
46

57
## Installation
68

79
**Notes**:
810

911
<!-- This is the mycobot Python API package designed by Zhang Lijun([lijun.zhang@elephantrobotics.com]()) -->
1012

11-
> Make sure that `Atom` is flashed into the top Atom, `Transponder` is flashed into the base Basic <br>
13+
> Make sure that `Atom` is flashed into the top Atom, `Transponder` is flashed into the base Basic. <br>
1214
> The firmware `Atom` and `Transponder` download address: [https://github.com/elephantrobotics/myCobot/tree/main/Software](https://github.com/elephantrobotics/myCobot/tree/main/Software)<br>
15+
> You also can use myStudio to flash them, myStudio address: [https://github.com/elephantrobotics/myStudio/releases](https://github.com/elephantrobotics/myStudio/releases)
1316
1417
### Pip
1518

@@ -19,6 +22,7 @@ pip install pymycobot --upgrade --user
1922

2023
**Notes:**
2124

25+
> If you want to use Gripper and IO, you should update your Atom to 2.5<br>
2226
> Now only the version is `Atom2.4` or later is supported. If you use an earlier version, please install `pymycobot 1.0.7`.
2327
2428
```bash
@@ -36,8 +40,10 @@ python2 setup.py install
3640
python3 setup.py install
3741
```
3842

39-
**_`test/test.py` is a test file, you can find out which interfaces pymycobot provides in `pymycobot/README.md`._**
40-
4143
## Usage:
4244

45+
The `tests` directory stores some test case files.
46+
47+
You can find out which interfaces pymycobot provides in `pymycobot/README.md`.
48+
4349
Please go to [here](./pymycobot/README.md).

f3-min2.jpg

59.9 KB
Loading

pymycobot/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,11 @@ from pymycobot.mycobot import MyCobot
159159

160160
- **Description**
161161

162-
Get the Coords from robot arm.
162+
Get the Coords from robot arm, coordinate system based on base.
163163

164164
- **Returns**
165165

166-
`list`: A float list of coord.
166+
`list`: A float list of coord - `[x, y, z, rx, ry, rz]`
167167

168168
### send_coord()
169169

@@ -201,7 +201,7 @@ from pymycobot.mycobot import MyCobot
201201
coords: a list of coords value(`List[float]`)
202202

203203
speed: (`int`)
204-
204+
205205
mode: (`int`): `0` - angluar, `1` - linear
206206

207207
- **Example**

0 commit comments

Comments
 (0)