Skip to content

Commit 59fe1a3

Browse files
committed
Update README.md
1 parent e6361dd commit 59fe1a3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ A helper function to send a [circle move](https://doc.dorna.ai/docs/cmd/circle%2
237237
## Stop
238238
Series of helper function to send stop (halt) command, read and set the alarm status of the robot.
239239
240-
### `.halt(accel=None, **kwargs)`
240+
### `.halt(accel=None)`
241241
A helper function to send a [halt](https://doc.dorna.ai/docs/cmd/halt/) command to the robot, with a given acceleration ratio (`accel`), and return the final status of the command (`stat`).
242242
#### Parameter
243243
- *accel*: (float > 1, default value = `None`) The acceleration ratio parameter associated to the `halt`. Larger `accel` means faster and sharper halt (stop). When this parameter is not present, the robot stops with the default acceleration.
@@ -365,21 +365,21 @@ robot.get_adc(0) # return the value of adc0
365365
## Wait
366366
Wait for an input pins pattern, encoder indices or certain amount of time in your program.
367367
368-
### `probe(index=None, val=None, **kwargs)`
368+
### `probe(index=None, val=None)`
369369
Return the joint values of the robot in a list of size 8 ([`.get_all_joint()`](#get_all_joint)), the moment that the input pin `index` (0 <= int < 16), is equal to the `val` (0 or 1).
370370
> Use this method to wait for a pattern in an input pin.
371371
``` python
372372
robot.probe(1, 0) # return the joint values, the moment in1 gets equal to 0
373373
```
374374
375-
### `iprobe(index=None, val=None, **kwargs)`
375+
### `iprobe(index=None, val=None)`
376376
This method is similar to the `probe` function but here we are waiting for an specific pattern in the encoder indices, instead of the input pins.
377377
Return the joint values of the robot in a list of size 8 ([`.get_all_joint()`](#get_all_joint)), the moment that the encoder index `index` (0 <= int < 8), is equal to the `val` (0 or 1).
378378
> Notice that the encoder on the motors gets high (1), 8 times during one full rotation of the encoder, and we can locate these points by calling the `.iprobe` function.
379379
``` python
380380
robot.iprobe(1, 1) # return the value of the joints, the moment that index1 (encoder 1 index) gets 1
381381
```
382-
### `.sleep(val=None, **kwargs)`
382+
### `.sleep(val=None)`
383383
Sleep for `val` (float >= 0) seconds and return the status of the command.
384384
``` python
385385
robot.sleep(10) # the controller sleeps for 10 seconds

0 commit comments

Comments
 (0)