refactor: modify api README.

* Rename _process_bool() -> _process_single()
* Fix spelling mistakes.

Author: zlj-zz

pymycobot/README.md

@@ -48,13 +48,13 @@ from pymycobot.mycobot import MyCobot
 
 - **Description**
 
-  Adjust robot arm wether power on.
+  Adjust robot arm whether power on.
 
 - **Returns**
 
-  - 1: power on
-  - 0: power off
-  - -1: error
+  - `1`: power on
+  - `0`: power off
+  - `-1`: error
 
 ### set_free_mode()
 
@@ -82,11 +82,11 @@ from pymycobot.mycobot import MyCobot
 
 - **Parameters**
 
-  id: Joint id(common.Angle)
+  id: Joint id(`genre.Angle`)
 
-  degree: degree value(float)
+  degree: degree value(`float`)
 
-  speed: (int)
+  speed: (`int`)
 
 - **Example**
 
@@ -107,9 +107,9 @@ from pymycobot.mycobot import MyCobot
 
 - **Parameters**
 
-  degrees: a list of degree value(List[float])
+  degrees: a list of degree value(`List[float]`)
 
-  speed: (int)
+  speed: (`int`)
 
 - **Example**
 
@@ -140,9 +140,9 @@ from pymycobot.mycobot import MyCobot
 
 - **Parameters**
 
-  degrees: a list of radian value(List[float])
+  degrees: a list of radian value(`List[float]`)
 
-  speed: (int)
+  speed: (`int`)
 
 - **Example**
 
@@ -173,11 +173,11 @@ from pymycobot.mycobot import MyCobot
 
 - **Parameters**
 
-  id: coord name(common.Coord)
+  id: coord id(`genre.Coord`)
 
-  coord: coord value(float)
+  coord: coord value(`float`)
 
-  speed: (int)
+  speed: (`int`)
 
 - **Example**
 
@@ -198,9 +198,9 @@ from pymycobot.mycobot import MyCobot
 
 - **Parameters**
 
-  coords: a list of coords value(List[float])
+  coords: a list of coords value(`List[float]`)
 
-  speed: (int)
+  speed: (`int`)
 
 - **Example**
 
@@ -239,7 +239,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  bool:
+  `bool`:
 
   - `1` - paused
   - `0` - not paused
@@ -253,7 +253,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  bool:
+  `bool`:
 
   - `1` - true
   - `0` - false
@@ -267,7 +267,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  bool: `True` - moving, `False` - not moving.
+  `bool`: `True` - moving, `False` - not moving.
 
 ## JOG mode and operation
 
@@ -307,7 +307,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  speed: (int)
+  speed: (`int`)
 
 ### set_speed()
 
@@ -331,7 +331,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  angle: (int)
+  angle: (`float`)
 
 ### get_joint_max_angle()
 
@@ -345,7 +345,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  angle: (int)
+  angle: (`float`)
 
 ## Servo control
 
@@ -361,7 +361,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  speed: (int)
+  flag: (`int`)
 
   - `0`: disable
   - `1`: enbale
@@ -375,7 +375,7 @@ from pymycobot.mycobot import MyCobot
 
 - **Returns**
 
-  flag: (int)
+  flag: (`int`)
 
   - `0`: disable
   - `1`: enbale

pymycobot/common.py

@@ -126,20 +126,20 @@ def _process_recived(self, data, genre):
         if cmd_id != genre:
             return []
         data_pos = idx + 4
-        avild_data = (data[data_pos:data_pos + data_len])
+        valid_data = (data[data_pos:data_pos + data_len])
 
         res = []
         if data_len == 12:
-            for idx in range(0, len(avild_data), 2):
-                a = avild_data[idx:idx + 2]
-                res.append(self._decode_int16(a))
+            for idx in range(0, len(valid_data), 2):
+                one = valid_data[idx:idx + 2]
+                res.append(self._decode_int16(one))
         elif data_len == 2:
-            res.append(self._decode_int16(avild_data))
+            res.append(self._decode_int16(valid_data))
         else:
-            res.append(self._decode_int8(avild_data))
+            res.append(self._decode_int8(valid_data))
         return res
 
-    def _process_bool(self, data):
+    def _process_single(self, data):
         return data[0] if data else -1
 
 

pymycobot/mycobot.py

@@ -110,7 +110,7 @@ def is_power_on(self):
             -1: error data
 
         '''
-        return self._process_bool(
+        return self._process_single(
             self.__mesg(Command.IS_POWER_ON, has_reply=True))
 
     def set_free_mode(self):
@@ -236,7 +236,7 @@ def pause(self):
         self.__mesg(Command.PAUSE)
 
     def is_paused(self):
-        return self._process_bool(self.__mesg(Command.IS_PAUSED,
+        return self._process_single(self.__mesg(Command.IS_PAUSED,
                                              has_reply=True))
 
     def resume(self):
@@ -273,7 +273,7 @@ def is_in_position(self, data, id):
         received = self.__mesg(Command.IS_IN_POSITION,
                               data=data_list,
                               has_reply=True)
-        return self._process_bool(received)
+        return self._process_single(received)
 
     def is_moving(self):
         '''
@@ -283,7 +283,7 @@ def is_moving(self):
             1 : is moving
             -1: error data
         '''
-        return self._process_bool(self.__mesg(Command.IS_MOVING,
+        return self._process_single(self.__mesg(Command.IS_MOVING,
                                              has_reply=True))
 
     # JOG mode and operation
@@ -314,7 +314,7 @@ def jog_stop(self):
 
     # Running status and Settings
     def get_speed(self):
-        return self._process_bool(self.__mesg(Command.GET_SPEED,
+        return self._process_single(self.__mesg(Command.GET_SPEED,
                                              has_reply=True))
 
     def set_speed(self, speed):
@@ -346,11 +346,11 @@ def get_joint_max_angle(self, joint_id):
     # Servo control
     @check_id
     def is_servo_enable(self, servo_id):
-        return self._process_bool(
+        return self._process_single(
             self.__mesg(Command.IS_SERVO_ENABLE, data=[servo_id]))
 
     def is_all_servo_enable(self):
-        return self._process_bool(
+        return self._process_single(
             self.__mesg(Command.IS_ALL_SERVO_ENABLE, has_reply=True))
 
     # Atom IO