Skip to content

Commit e4f8789

Browse files
Fixes nested lists
1 parent 3dcd8de commit e4f8789

File tree

1 file changed

+19
-40
lines changed
  • content/hardware/08.edu/solution-and-kits/alvik/tutorials/user-manual

1 file changed

+19
-40
lines changed

content/hardware/08.edu/solution-and-kits/alvik/tutorials/user-manual/user-manual.md

+19-40
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ difficulty: beginner
44
description: "Discover how to use and program Arduino® Alvik's robot"
55
tags:
66
- Robot
7-
author: "Paolo Cavagnolo"
7+
author: "Paolo Cavagnolo Pedro Miguel"
88
---
9-
# Arduino® Alvik User Manual
109

1110
## Introduction
1211
Arduino® Alvik is a powerful and versatile robot specifically designed for programming and STEAM education.
@@ -303,7 +302,6 @@ Open **Arduino Lab for MicroPython** and **connect** Alvik. Then:
303302
Depending on how you configure Python on your machine.
304303

305304
4. Install library
306-
307305
Run the following line to upload all files and download the dependencies needed to run the Arduino Alvik MicroPython library.
308306

309307
Linux
@@ -314,9 +312,9 @@ Windows
314312

315313

316314
The `install.*` script will copy all the needed files into your Alvik.
315+
The `<device port>` is the name of the USB port that your computer assigned to the Nano ESP32.
317316

318-
The `<device port>` is the name of the USB port that your computer assigned to the Nano ESP32. There are several ways to find it, depending on your OS, for example:
319-
317+
There are several ways to find it, depending on your OS, for example:
320318
- You can use the Arduino IDE to discover the port, [follow this guide to know more](https://support.arduino.cc/hc/en-us/articles/4406856349970-Select-board-and-port-in-Arduino-IDE).
321319
- You can check it by using the Arduino Lab for MicroPython by clicking `Connect` after connecting Alvik with the USB cable.
322320
- You can check the list of the USB devices attached to your PC.
@@ -365,7 +363,7 @@ Alvik comes with a preinstalled version of libraries and firmware, but in case y
365363

366364
Movement is one of Alvik's main features, making it essential to have a variety of methods to control Alvik's motors. This flexibility allows you to use different control methods depending on your needs, whether it's for precise movement or simple speed control.
367365

368-
** Power Over Distance/Time **
366+
**Power Over Distance/Time**
369367

370368
You can set the speed of Alvik's motors directly and let it run for a specific amount of time or distance. This method is straightforward and useful for simple tasks where precise control isn't necessary.
371369

@@ -407,7 +405,7 @@ sleep_ms(2000) # Rotate wheels 360 degrees in 2 seconds
407405
alvik.brake()
408406
```
409407

410-
**`move`** method
408+
**Using Move**
411409

412410
The `move` function moves the robot by a given distance.
413411

@@ -424,7 +422,7 @@ sleep_ms(2000) # Move forward 50 cm in 2 seconds
424422
alvik.brake()
425423
```
426424

427-
**Drive**
425+
**Using Drive**
428426

429427
You can also specify the power and time for Alvik's motors in terms of degrees per second or centimeters per second. This method is useful for tasks requiring fine-tuned control of the robot's speed and direction.
430428

@@ -433,10 +431,10 @@ You can also specify the power and time for Alvik's motors in terms of degrees p
433431
The `drive` function drives the robot by setting the linear and angular velocity.
434432

435433
**Inputs:**
436-
- `linear_velocity`: Speed of the robot.
437-
- `angular_velocity`: Speed of the wheels.
438-
- `linear_unit`: Unit of linear velocity (default is 'cm/s').
439-
- `angular_unit`: Unit of rotational speed of the wheels (default is 'deg/s').
434+
`linear_velocity`: Speed of the robot.
435+
`angular_velocity`: Speed of the wheels.
436+
`linear_unit`: Unit of linear velocity (default is 'cm/s').
437+
`angular_unit`: Unit of rotational speed of the wheels (default is 'deg/s').
440438

441439
**Example Usage:**
442440

@@ -532,60 +530,43 @@ The Arduino Alvik robot is equipped with several touch buttons that can be used
532530

533531
The `[get_touch_any](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_any)` function returns true if any of the buttons is pressed.
534532

535-
**Outputs:**
536-
`touch_any`: true if any button is pressed, false otherwise.
537533

538534
- Detect the **OK** button pressed.
539535

540536
The `[get_touch_ok](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_ok)` function returns true if the OK button is pressed.
541537

542-
**Outputs:**
543-
`touch_ok`: true if OK button is pressed, false otherwise.
544538

545539
- Detect the **Cancel** button pressed.
546540

547541
The `[get_touch_cancel](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_cancel)` function returns true if the Cancel button is pressed.
548542

549-
**Outputs:**
550-
`touch_cancel`: true if Cancel button is pressed, false otherwise.
551543

552544
- Detect the **Center** button pressed.
553545

554546
The `[get_touch_center](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_center)` function returns true if the Center button is pressed.
555547

556-
**Outputs:**
557-
`touch_center`: true if Center button is pressed, false otherwise.
558548

559549
- Detect the **Up** button pressed.
560550

561551
The `[get_touch_up](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_up)` function returns true if the Up button is pressed.
562552

563-
**Outputs:**
564-
`touch_up`: true if Up button is pressed, false otherwise.
565553

566554
- Detect the **Left** button pressed.
567555

568556
The `[get_touch_left](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_left)` function returns true if the Left button is pressed.
569557

570-
**Outputs:**
571-
`touch_left`: true if Left button is pressed, false otherwise.
572558

573559
- Detect the **Down** button pressed.
574560

575561
The `[get_touch_down](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_down)` function returns true if the Down button is pressed.
576562

577-
**Outputs:**
578-
`touch_down`: true if Down button is pressed, false otherwise.
579563

580564
- Detect the **Right** button pressed.
581565

582566
The `[get_touch_right](https://docs.arduino.cc/tutorials/alvik/api-overview/#get_touch_right)` function returns true if the Right button is pressed.
583567

584-
**Outputs:**
585-
`touch_right`: true if Right button is pressed, false otherwise.
586568

587569
**Example**
588-
589570
The following example demonstrates how to read the state of each button and print its name when pressed:
590571

591572
```python
@@ -638,11 +619,11 @@ The distance sensor array is divided into five distinct zones: left, center-left
638619
The `get_distance` function returns the distance readouts from the left, center-left, center, center-right, and right sensors.
639620

640621
**Outputs:**
641-
- `L`: Left sensor readout.
642-
- `CL`: Center-left sensor readout.
643-
- `C`: Center sensor readout.
644-
- `CR`: Center-right sensor readout.
645-
- `R`: Right sensor readout.
622+
`L`: Left sensor readout.
623+
`CL`: Center-left sensor readout.
624+
`C`: Center sensor readout.
625+
`CR`: Center-right sensor readout.
626+
`R`: Right sensor readout.
646627

647628
**Example Usage**
648629

@@ -789,8 +770,8 @@ In this example, the robot uses its line follower sensor array to navigate along
789770
```
790771

791772
**Outputs:**
792-
- `color`: The label of the color as recognized by the sensor. These can be:
793-
- `'BLACK'`, `'GREY'`, `'BLACK'`, `'LIGHT GREY'`, `'WHITE'`, `'YELLOW'`, `'LIGHT GREEN'`, `'BLUE'`, `'VIOLET'`, `'BROWN'`, `'ORANGE'`, `'RED'`.
773+
- `color`: The label of the color as recognized by the sensor. These can be:
774+
`'BLACK'`, `'GREY'`, `'BLACK'`, `'LIGHT GREY'`, `'WHITE'`, `'YELLOW'`, `'LIGHT GREEN'`, `'BLUE'`, `'VIOLET'`, `'BROWN'`, `'ORANGE'`, `'RED'`.
794775

795776
**Example Usage**
796777

@@ -857,7 +838,6 @@ In this example, the robot uses its line follower sensor array to navigate along
857838
`b` or `v`: The blue component in RGB format or the value in HSV format.
858839

859840
You can use these functions depending on your needs:
860-
861841
- Use `color_calibration` to calibrate the sensor for accurate readings.
862842
- Use `get_color_raw` to get the raw sensor data.
863843
- Use `get_color_label` to get a human-readable label of the detected color.
@@ -1007,7 +987,7 @@ And let's be honest, there's a certain satisfaction in programming your robot to
1007987

1008988
The Arduino Alvik robot comes equipped with two RGB LEDs that can be controlled to display various colors. These LEDs can be used for signaling, indicating status, or just for fun. The following functions are available for controlling the LEDs:
1009989

1010-
1. **Set color** of the Alvik's RGB LEDs
990+
**Set color** of the Alvik's RGB LEDs
1011991

1012992
The `set_color` function sets the color of the LED by specifying the intensity of red, green, and blue components.
1013993

@@ -1488,8 +1468,7 @@ The servo motors connectors are placed at the back of Alvik, in this tutorial we
14881468
***The port provides 5 Volt to the motor, so be sure to connect a servo that runs with 5V.***
14891469

14901470
1. Connect the servo motor to the upper port
1491-
1492-
![Servo connected](assets/servo_connection.png)
1471+
![Servo connected](assets/servo_connection.png)
14931472

14941473
2. Open the Arduino Lab for MicroPython
14951474

0 commit comments

Comments
 (0)