Skip to content

Commit 1382dd8

Browse files
committed
fixing issues with the titles on cheatsheet
1 parent ece425f commit 1382dd8

File tree

1 file changed

+30
-30
lines changed
  • content/hardware/08.edu/solution-and-kits/alvik/tutorials/cheat-sheet

1 file changed

+30
-30
lines changed

content/hardware/08.edu/solution-and-kits/alvik/tutorials/cheat-sheet/cheat-sheet.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ _Moves the robot by given distance_
117117
- **unit**: the distance unit. [?](#the-distance-unit)
118118
- **blocking**: _True_ or _False_, [?](#blocking-or-non-blocking)
119119

120-
### get_wheels_speed
120+
### `get_wheels_speed`
121121

122122
get_wheels_speed(unit: str = 'rpm')
123123

@@ -129,7 +129,7 @@ get_wheels_speed(unit: str = 'rpm')
129129

130130
_Returns the speed of the wheels_
131131

132-
### set_wheels_speed
132+
### `set_wheels_speed`
133133

134134
set_wheels_speed(left_speed: float, right_speed: float, unit: str = 'rpm')
135135

@@ -140,7 +140,7 @@ _Sets left/right motor speed_
140140
- **right_speed**: the speed value
141141
- **unit**: unit of rotational speed of the wheels. [?](#the-rotational-speed-unit)
142142

143-
### set_wheels_position
143+
### `set_wheels_position`
144144

145145
set_wheels_position(left_angle: float, right_angle: float, unit: str = 'deg')
146146

@@ -152,7 +152,7 @@ _Sets left/right motor angle_
152152
- **unit**: the angle unit, [?](#the-angle-unit)
153153

154154

155-
### get_wheels_position
155+
### `get_wheels_position`
156156

157157
get_wheels_position(unit: str = 'deg')
158158

@@ -163,7 +163,7 @@ _Returns the angle of the wheels_
163163
- outputs:
164164
- **angular_velocity**: speed of the wheels.
165165

166-
### drive
166+
### `drive`
167167

168168
drive(linear_velocity: float, angular_velocity: float, linear_unit: str = 'cm/
169169
s',angular_unit: str = 'deg/s')
@@ -176,7 +176,7 @@ _Drives the robot by linear and angular velocity_
176176
- **linear_unit**: unit of linear velocity. [?](#the-linear-speed-unit)
177177
- **angular_unit**: unit of rotational speed of the wheels. [?](#the-rotational-speed-unit)
178178

179-
### get_drive_speed
179+
### `get_drive_speed`
180180

181181
get_drive_speed(linear_unit: str = 'cm/s', angular_unit: str = 'deg/s')
182182

@@ -190,7 +190,7 @@ _Returns linear and angular velocity of the robot_
190190
- **angular_velocity**: speed of the wheels.
191191

192192

193-
### reset_pose
193+
### `reset_pose`
194194

195195
reset_pose(x: float, y: float, theta: float, distance_unit: str = 'cm', angle_unit:
196196
str = 'deg')
@@ -205,7 +205,7 @@ _Resets the robot pose_
205205
- **angle_unit**: unit of theta output, [?](#the-angle-unit)
206206

207207

208-
### get_pose
208+
### `get_pose`
209209

210210
get_pose(distance_unit: str = 'cm', angle_unit: str = 'deg')
211211

@@ -220,7 +220,7 @@ _Returns the current pose of the robot_
220220
- **y**
221221
- **theta**
222222

223-
### set_servo_positions
223+
### `set_servo_positions`
224224

225225
set_servo_positions(a_position: int, b_position: int)
226226

@@ -230,7 +230,7 @@ _Sets A/B servomotor angle_
230230
- **a_position**: position of A servomotor (0-180)
231231
- **b_position**: position of B servomotor (0-180)
232232

233-
### set_builtin_led
233+
### `set_builtin_led`
234234

235235
set_builtin_led(value: bool)
236236

@@ -239,7 +239,7 @@ _Turns on/off the builtin led_
239239
- inputs:
240240
- **value**: True = ON, False = OFF
241241

242-
### set_illuminator
242+
### `set_illuminator`
243243

244244
set_illuminator(value: bool)
245245

@@ -248,7 +248,7 @@ _Turns on/off the illuminator led_
248248
- inputs:
249249
- **value**: True = ON, False = OFF
250250

251-
### color_calibration
251+
### `color_calibration`
252252

253253
color_calibration(background: str = 'white')
254254

@@ -257,7 +257,7 @@ _Calibrates the color sensor_
257257
- inputs:
258258
- **background**: string "white" or "black"
259259

260-
### rgb2hsv
260+
### `rgb2hsv`
261261

262262
rgb2hsv(r: float, g: float, b: float)
263263

@@ -272,7 +272,7 @@ _Converts normalized rgb to hsv_
272272
- **s**: saturation value
273273
- **v**: brightness value
274274

275-
### get_color
275+
### `get_color`
276276

277277
get_color(color_format: str = 'rgb')
278278

@@ -285,7 +285,7 @@ _Returns the normalized color readout of the color sensor_
285285
- **g** or **s**
286286
- **b** or **v**
287287

288-
### hsv2label
288+
### `hsv2label`
289289

290290
hsv2label(h, s, v)
291291

@@ -298,7 +298,7 @@ _Returns the color label corresponding to the given normalized HSV color input_
298298
- outputs:
299299
- **color label**: like "BLACK" or "GREEN", if possible, otherwise return "UNDEFINED"
300300

301-
### get_distance
301+
### `get_distance`
302302

303303
get_distance(unit: str = 'cm')
304304

@@ -313,7 +313,7 @@ _Returns the distance readout of the TOF sensor_
313313
- **center_right_tof**: 22° to the right object distance
314314
- **right_tof**: 45° to the right object distance
315315

316-
### get_distance_top
316+
### `get_distance_top`
317317

318318
get_distance_top(unit: str = 'cm')
319319

@@ -324,7 +324,7 @@ _Returns the obstacle top distance readout_
324324
- outputs:
325325
- **top_tof**: 45° to the top object distance
326326

327-
### get_distance_bottom
327+
### `get_distance_bottom`
328328

329329
get_distance_bottom(unit: str = 'cm')
330330

@@ -335,7 +335,7 @@ _Returns the obstacle bottom distance readout_
335335
- outputs:
336336
- **bottom_tof**: 45° to the bottom object distance
337337

338-
### on_touch_ok_pressed
338+
### `on_touch_ok_pressed`
339339

340340
on_touch_ok_pressed(callback: callable, args: tuple = ())
341341

@@ -345,7 +345,7 @@ _Register callback when touch button OK is pressed_
345345
- **callback**: the name of the function to recall
346346
- **args**: optional arguments of the function
347347

348-
### on_touch_cancel_pressed
348+
### `on_touch_cancel_pressed`
349349

350350
on_touch_cancel_pressed(callback: callable, args: tuple = ())
351351

@@ -355,7 +355,7 @@ _Register callback when touch button CANCEL is pressed_
355355
- **callback**: the name of the function to recall
356356
- **args**: optional arguments of the function
357357

358-
### on_touch_center_pressed
358+
### `on_touch_center_pressed`
359359

360360
on_touch_center_pressed(callback: callable, args: tuple = ())
361361

@@ -365,7 +365,7 @@ _Register callback when touch button CENTER is pressed_
365365
- **callback**: the name of the function to recall
366366
- **args**: optional arguments of the function
367367

368-
### on_touch_up_pressed
368+
### `on_touch_up_pressed`
369369

370370
on_touch_up_pressed(callback: callable, args: tuple = ())
371371

@@ -375,7 +375,7 @@ _Register callback when touch button UP is pressed_
375375
- **callback**: the name of the function to recall
376376
- **args**: optional arguments of the function
377377

378-
### on_touch_left_pressed
378+
### `on_touch_left_pressed`
379379

380380
on_touch_left_pressed(callback: callable, args: tuple = ())
381381

@@ -385,7 +385,7 @@ _Register callback when touch button LEFT is pressed_
385385
- **callback**: the name of the function to recall
386386
- **args**: optional arguments of the function
387387

388-
### on_touch_down_pressed
388+
### `on_touch_down_pressed`
389389

390390
on_touch_down_pressed(callback: callable, args: tuple = ())
391391

@@ -395,7 +395,7 @@ _Register callback when touch button DOWN is pressed_
395395
- **callback**: the name of the function to recall
396396
- **args**: optional arguments of the function
397397

398-
### on_touch_right_pressed
398+
### `on_touch_right_pressed`
399399

400400
on_touch_right_pressed(callback: callable, args: tuple = ())
401401

@@ -409,7 +409,7 @@ _Register callback when touch button RIGHT is pressed_
409409

410410
## Extras
411411

412-
### The distance unit
412+
### The Distance Unit
413413

414414
Distance unit of measurement used in the APIs:
415415

@@ -419,7 +419,7 @@ Distance unit of measurement used in the APIs:
419419
- _inch_: inch, 2.54 cm
420420
- _in_: inch, 2.54 cm
421421

422-
### The angle unit
422+
### The Angle Unit
423423

424424
Angle unit of measurement used in the APIs:
425425

@@ -430,7 +430,7 @@ Angle unit of measurement used in the APIs:
430430
- _perc_: percentage, example 1 perc is 3.6 deg.
431431
- _%_: same as perc
432432

433-
### The linear speed unit
433+
### The Linear Speed Unit
434434

435435
Speed unit of measurement used in the APIs:
436436

@@ -440,7 +440,7 @@ Speed unit of measurement used in the APIs:
440440
- 'inch/s': inch per second
441441
- 'in/s': inch per second
442442

443-
### The rotational speed unit
443+
### The Rotational Speed Unit
444444

445445
Rotational speed unit of measurement used in the APIs:
446446

@@ -449,7 +449,7 @@ Rotational speed unit of measurement used in the APIs:
449449
- 'rad/s': radiant per second, example: 1.0 rad/s is 60.0 rad/min that is 9.55 rpm.
450450
- 'rev/s': revolution per second, example: 1.0 rev/s is 60.0 rev/min that is 60.0 rpm.
451451

452-
### Blocking or non blocking
452+
### `"blocking" or "non blocking"`
453453

454454
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.
455455

0 commit comments

Comments
 (0)