You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,7 +237,7 @@ A helper function to send a [circle move](https://doc.dorna.ai/docs/cmd/circle%2
237
237
## Stop
238
238
Series of helper function to send stop (halt) command, read and set the alarm status of the robot.
239
239
240
-
### `.halt(accel=None, **kwargs)`
240
+
### `.halt(accel=None)`
241
241
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`).
242
242
#### Parameter
243
243
- *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
365
365
## Wait
366
366
Wait for an input pins pattern, encoder indices or certain amount of time in your program.
367
367
368
-
### `probe(index=None, val=None, **kwargs)`
368
+
### `probe(index=None, val=None)`
369
369
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).
370
370
> Use this method to wait for a pattern in an input pin.
371
371
``` python
372
372
robot.probe(1, 0) # return the joint values, the moment in1 gets equal to 0
373
373
```
374
374
375
-
### `iprobe(index=None, val=None, **kwargs)`
375
+
### `iprobe(index=None, val=None)`
376
376
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.
377
377
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).
378
378
> 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.
379
379
``` python
380
380
robot.iprobe(1, 1) # return the value of the joints, the moment that index1 (encoder 1 index) gets 1
381
381
```
382
-
### `.sleep(val=None, **kwargs)`
382
+
### `.sleep(val=None)`
383
383
Sleep for `val` (float >= 0) seconds and return the status of the command.
384
384
``` python
385
385
robot.sleep(10) # the controller sleeps for 10 seconds
0 commit comments