@@ -117,7 +117,7 @@ _Moves the robot by given distance_
117
117
- **unit**: the distance unit. [?](#the-distance-unit)
118
118
- **blocking**: _True_ or _False_, [?](#blocking-or-non-blocking)
119
119
120
- ### get_wheels_speed
120
+ ### ` get_wheels_speed `
121
121
122
122
get_wheels_speed(unit: str = 'rpm')
123
123
@@ -129,7 +129,7 @@ get_wheels_speed(unit: str = 'rpm')
129
129
130
130
_ Returns the speed of the wheels_
131
131
132
- ### set_wheels_speed
132
+ ### ` set_wheels_speed `
133
133
134
134
set_wheels_speed(left_speed: float, right_speed: float, unit: str = 'rpm')
135
135
@@ -140,7 +140,7 @@ _Sets left/right motor speed_
140
140
- **right_speed**: the speed value
141
141
- **unit**: unit of rotational speed of the wheels. [?](#the-rotational-speed-unit)
142
142
143
- ### set_wheels_position
143
+ ### ` set_wheels_position `
144
144
145
145
set_wheels_position(left_angle: float, right_angle: float, unit: str = 'deg')
146
146
@@ -152,7 +152,7 @@ _Sets left/right motor angle_
152
152
- **unit**: the angle unit, [?](#the-angle-unit)
153
153
154
154
155
- ### get_wheels_position
155
+ ### ` get_wheels_position `
156
156
157
157
get_wheels_position(unit: str = 'deg')
158
158
@@ -163,7 +163,7 @@ _Returns the angle of the wheels_
163
163
- outputs:
164
164
- **angular_velocity**: speed of the wheels.
165
165
166
- ### drive
166
+ ### ` drive `
167
167
168
168
drive(linear_velocity: float, angular_velocity: float, linear_unit: str = 'cm/
169
169
s',angular_unit: str = 'deg/s')
@@ -176,7 +176,7 @@ _Drives the robot by linear and angular velocity_
176
176
- **linear_unit**: unit of linear velocity. [?](#the-linear-speed-unit)
177
177
- ** angular_unit** : unit of rotational speed of the wheels. [ ?] ( #the-rotational-speed-unit )
178
178
179
- ### get_drive_speed
179
+ ### ` get_drive_speed `
180
180
181
181
get_drive_speed(linear_unit: str = 'cm/s', angular_unit: str = 'deg/s')
182
182
@@ -190,7 +190,7 @@ _Returns linear and angular velocity of the robot_
190
190
- **angular_velocity**: speed of the wheels.
191
191
192
192
193
- ### reset_pose
193
+ ### ` reset_pose `
194
194
195
195
reset_pose(x: float, y: float, theta: float, distance_unit: str = 'cm', angle_unit:
196
196
str = 'deg')
@@ -205,7 +205,7 @@ _Resets the robot pose_
205
205
- ** angle_unit** : unit of theta output, [ ?] ( #the-angle-unit )
206
206
207
207
208
- ### get_pose
208
+ ### ` get_pose `
209
209
210
210
get_pose(distance_unit: str = 'cm', angle_unit: str = 'deg')
211
211
@@ -220,7 +220,7 @@ _Returns the current pose of the robot_
220
220
- **y**
221
221
- **theta**
222
222
223
- ### set_servo_positions
223
+ ### ` set_servo_positions `
224
224
225
225
set_servo_positions(a_position: int, b_position: int)
226
226
@@ -230,7 +230,7 @@ _Sets A/B servomotor angle_
230
230
- **a_position**: position of A servomotor (0-180)
231
231
- **b_position**: position of B servomotor (0-180)
232
232
233
- ### set_builtin_led
233
+ ### ` set_builtin_led `
234
234
235
235
set_builtin_led(value: bool)
236
236
@@ -239,7 +239,7 @@ _Turns on/off the builtin led_
239
239
- inputs:
240
240
- **value**: True = ON, False = OFF
241
241
242
- ### set_illuminator
242
+ ### ` set_illuminator `
243
243
244
244
set_illuminator(value: bool)
245
245
@@ -248,7 +248,7 @@ _Turns on/off the illuminator led_
248
248
- inputs:
249
249
- **value**: True = ON, False = OFF
250
250
251
- ### color_calibration
251
+ ### ` color_calibration `
252
252
253
253
color_calibration(background: str = 'white')
254
254
@@ -257,7 +257,7 @@ _Calibrates the color sensor_
257
257
- inputs:
258
258
- ** background** : string "white" or "black"
259
259
260
- ### rgb2hsv
260
+ ### ` rgb2hsv `
261
261
262
262
rgb2hsv(r: float, g: float, b: float)
263
263
@@ -272,7 +272,7 @@ _Converts normalized rgb to hsv_
272
272
- ** s** : saturation value
273
273
- ** v** : brightness value
274
274
275
- ### get_color
275
+ ### ` get_color `
276
276
277
277
get_color(color_format: str = 'rgb')
278
278
@@ -285,7 +285,7 @@ _Returns the normalized color readout of the color sensor_
285
285
- ** g** or ** s**
286
286
- ** b** or ** v**
287
287
288
- ### hsv2label
288
+ ### ` hsv2label `
289
289
290
290
hsv2label(h, s, v)
291
291
@@ -298,7 +298,7 @@ _Returns the color label corresponding to the given normalized HSV color input_
298
298
- outputs:
299
299
- ** color label** : like "BLACK" or "GREEN", if possible, otherwise return "UNDEFINED"
300
300
301
- ### get_distance
301
+ ### ` get_distance `
302
302
303
303
get_distance(unit: str = 'cm')
304
304
@@ -313,7 +313,7 @@ _Returns the distance readout of the TOF sensor_
313
313
- ** center_right_tof** : 22° to the right object distance
314
314
- ** right_tof** : 45° to the right object distance
315
315
316
- ### get_distance_top
316
+ ### ` get_distance_top `
317
317
318
318
get_distance_top(unit: str = 'cm')
319
319
@@ -324,7 +324,7 @@ _Returns the obstacle top distance readout_
324
324
- outputs:
325
325
- ** top_tof** : 45° to the top object distance
326
326
327
- ### get_distance_bottom
327
+ ### ` get_distance_bottom `
328
328
329
329
get_distance_bottom(unit: str = 'cm')
330
330
@@ -335,7 +335,7 @@ _Returns the obstacle bottom distance readout_
335
335
- outputs:
336
336
- ** bottom_tof** : 45° to the bottom object distance
337
337
338
- ### on_touch_ok_pressed
338
+ ### ` on_touch_ok_pressed `
339
339
340
340
on_touch_ok_pressed(callback: callable, args: tuple = ())
341
341
@@ -345,7 +345,7 @@ _Register callback when touch button OK is pressed_
345
345
- ** callback** : the name of the function to recall
346
346
- ** args** : optional arguments of the function
347
347
348
- ### on_touch_cancel_pressed
348
+ ### ` on_touch_cancel_pressed `
349
349
350
350
on_touch_cancel_pressed(callback: callable, args: tuple = ())
351
351
@@ -355,7 +355,7 @@ _Register callback when touch button CANCEL is pressed_
355
355
- ** callback** : the name of the function to recall
356
356
- ** args** : optional arguments of the function
357
357
358
- ### on_touch_center_pressed
358
+ ### ` on_touch_center_pressed `
359
359
360
360
on_touch_center_pressed(callback: callable, args: tuple = ())
361
361
@@ -365,7 +365,7 @@ _Register callback when touch button CENTER is pressed_
365
365
- ** callback** : the name of the function to recall
366
366
- ** args** : optional arguments of the function
367
367
368
- ### on_touch_up_pressed
368
+ ### ` on_touch_up_pressed `
369
369
370
370
on_touch_up_pressed(callback: callable, args: tuple = ())
371
371
@@ -375,7 +375,7 @@ _Register callback when touch button UP is pressed_
375
375
- ** callback** : the name of the function to recall
376
376
- ** args** : optional arguments of the function
377
377
378
- ### on_touch_left_pressed
378
+ ### ` on_touch_left_pressed `
379
379
380
380
on_touch_left_pressed(callback: callable, args: tuple = ())
381
381
@@ -385,7 +385,7 @@ _Register callback when touch button LEFT is pressed_
385
385
- ** callback** : the name of the function to recall
386
386
- ** args** : optional arguments of the function
387
387
388
- ### on_touch_down_pressed
388
+ ### ` on_touch_down_pressed `
389
389
390
390
on_touch_down_pressed(callback: callable, args: tuple = ())
391
391
@@ -395,7 +395,7 @@ _Register callback when touch button DOWN is pressed_
395
395
- ** callback** : the name of the function to recall
396
396
- ** args** : optional arguments of the function
397
397
398
- ### on_touch_right_pressed
398
+ ### ` on_touch_right_pressed `
399
399
400
400
on_touch_right_pressed(callback: callable, args: tuple = ())
401
401
@@ -409,7 +409,7 @@ _Register callback when touch button RIGHT is pressed_
409
409
410
410
## Extras
411
411
412
- ### The distance unit
412
+ ### The Distance Unit
413
413
414
414
Distance unit of measurement used in the APIs:
415
415
@@ -419,7 +419,7 @@ Distance unit of measurement used in the APIs:
419
419
- _ inch_ : inch, 2.54 cm
420
420
- _ in_ : inch, 2.54 cm
421
421
422
- ### The angle unit
422
+ ### The Angle Unit
423
423
424
424
Angle unit of measurement used in the APIs:
425
425
@@ -430,7 +430,7 @@ Angle unit of measurement used in the APIs:
430
430
- _ perc_ : percentage, example 1 perc is 3.6 deg.
431
431
- _ %_ : same as perc
432
432
433
- ### The linear speed unit
433
+ ### The Linear Speed Unit
434
434
435
435
Speed unit of measurement used in the APIs:
436
436
@@ -440,7 +440,7 @@ Speed unit of measurement used in the APIs:
440
440
- 'inch/s': inch per second
441
441
- 'in/s': inch per second
442
442
443
- ### The rotational speed unit
443
+ ### The Rotational Speed Unit
444
444
445
445
Rotational speed unit of measurement used in the APIs:
446
446
@@ -449,7 +449,7 @@ Rotational speed unit of measurement used in the APIs:
449
449
- 'rad/s': radiant per second, example: 1.0 rad/s is 60.0 rad/min that is 9.55 rpm.
450
450
- 'rev/s': revolution per second, example: 1.0 rev/s is 60.0 rev/min that is 60.0 rpm.
451
451
452
- ### Blocking or non blocking
452
+ ### ` "blocking" or " non blocking" `
453
453
454
454
While programming a microcontroller, the terms "blocking" means that ** all the resources are used only in performing a specific action, and no other things can happen at the same time** . Usually this is used when you want to be precise or you don't want anything else that could interact with the action you are performing.
455
455
0 commit comments