Skip to content

Commit 17620ea

Browse files
Fixed linter
1 parent 3649a4d commit 17620ea

File tree

1 file changed

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

1 file changed

+24
-24
lines changed

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

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In this tutorial, you will find useful information to get started, test, and mai
2525
- [Move Your Robot!](#move-your-robot)
2626
- [Hardware Requirements](#hardware-requirements)
2727
- [Software Requirements](#software-requirements)
28-
- [What is Alvik](#what-is-alvik)
28+
- [What Is Alvik](#what-is-alvik)
2929
- [The Brain](#the-brain)
3030
- [Nano ESP32](#nano-esp32)
3131
- [The Body](#the-body)
@@ -43,7 +43,7 @@ In this tutorial, you will find useful information to get started, test, and mai
4343
- [Actuators](#actuators)
4444
- [Motors and Encoders](#motors-and-encoders)
4545
- [What the Robot Includes](#what-the-robot-includes)
46-
- [Move Alvik! (extended)](#move-alvik-extended)
46+
- [Move Alvik!](#move-alvik)
4747
- [Basic Touch Programming](#basic-touch-programming)
4848
- [Following Objects](#following-objects)
4949
- [Line Follower](#line-follower)
@@ -56,14 +56,14 @@ In this tutorial, you will find useful information to get started, test, and mai
5656
- [How to Upload Firmware](#how-to-upload-firmware)
5757
- [Program Alvik!](#program-alvik)
5858
- [Controlling the Motors](#controlling-the-motors)
59-
- [High level, fix power x amount of time or distance](#high-level-fix-power-x-amount-of-time-or-distance)
60-
- [Distance, angle, etc](#distance-angle-etc)
61-
- [Controlling power and time in degrees/s cm/s](#controlling-power-and-time-in-degreess-cms)
59+
- [Power x Distance (Or Time)](#power-x-distance-or-time)
60+
- [Distance And Angle](#distance-and-angle)
61+
- [Drive](#drive)
6262
- [Encoder’s Control](#encoders-control)
63-
- [get\_wheels\_speed](#get_wheels_speed)
64-
- [get\_wheels\_position](#get_wheels_position)
65-
- [get\_drive\_speed](#get_drive_speed)
66-
- [get\_pose](#get_pose)
63+
- [Check Wheels Speed](#check-wheels-speed)
64+
- [Check Wheels Position](#check-wheels-position)
65+
- [Check Velocity](#check-velocity)
66+
- [Check Pose](#check-pose)
6767
- [Reading Buttons](#reading-buttons)
6868
- [Example Usage](#example-usage)
6969
- [Detecting Obstacles](#detecting-obstacles)
@@ -79,7 +79,7 @@ In this tutorial, you will find useful information to get started, test, and mai
7979
- [Example Usage](#example-usage-3)
8080
- [LEDs](#leds)
8181
- [Example](#example)
82-
- [Talking with other Machines!](#talking-with-other-machines)
82+
- [Talking With Other Machines!](#talking-with-other-machines)
8383
- [WiFi](#wifi)
8484
- [Instructions](#instructions)
8585
- [Connecting to Wi-Fi](#connecting-to-wi-fi)
@@ -88,11 +88,11 @@ In this tutorial, you will find useful information to get started, test, and mai
8888
- [Handling HTTP Requests](#handling-http-requests)
8989
- [Main Loop](#main-loop)
9090
- [ESP-NOW](#esp-now)
91-
- [Device identification](#device-identification)
91+
- [Device Identification](#device-identification)
9292
- [Instructions](#instructions-1)
9393
- [Code](#code)
9494
- [Setting Up ESP-NOW on the Receiver](#setting-up-esp-now-on-the-receiver)
95-
- [Sending Commands from Another ESP32 Device](#sending-commands-from-another-esp32-device)
95+
- [Sending Commands](#sending-commands)
9696
- [Receiver](#receiver)
9797
- [Sender](#sender)
9898
- [Expanding the Robot](#expanding-the-robot)
@@ -127,7 +127,7 @@ To get started to play with Alvik you will need the following hardware and softw
127127
- Operating Systems: All the major Operating Systems are supported
128128
- [Arduino Lab for Micropython](https://labs.arduino.cc/en/labs/micropython)
129129

130-
## What is Alvik
130+
## What Is Alvik
131131

132132
Arduino® Alvik is a robot with two controllers and numerous useful sensors and actuators. It is designed for STEAM education, making it an ideal tool for learning programming, Robotics, IoT, and Artificial Intelligence.
133133

@@ -294,7 +294,7 @@ The Arduino Alvik robot package includes the following items:
294294
- Phillips screwdriver
295295
- 18650 Li-Ion battery
296296

297-
## Move Alvik! (extended)
297+
## Move Alvik!
298298

299299
### Basic Touch Programming
300300

@@ -416,7 +416,7 @@ Answer `y` to flash firmware.
416416

417417
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.
418418

419-
#### High level, fix power x amount of time or distance
419+
#### Power x Distance (Or Time)
420420

421421
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.
422422

@@ -437,7 +437,7 @@ sleep_ms(2000) # Run motors at 30 rpm for 2 seconds
437437
alvik.brake()
438438
```
439439

440-
#### Distance, angle, etc
440+
#### Distance And Angle
441441

442442
Alvik allows you to control the motors based on specific distances or angles. This method provides precise control over the robot's movements, ensuring it travels the exact distance or rotates to the exact angle specified.
443443

@@ -475,7 +475,7 @@ sleep_ms(2000) # Move forward 50 cm in 2 seconds
475475
alvik.brake()
476476
```
477477

478-
#### Controlling power and time in degrees/s cm/s
478+
#### Drive
479479

480480
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.
481481

@@ -501,7 +501,7 @@ alvik.brake()
501501

502502
The Alvik robot provides various functions to control and monitor the motors using encoders. These functions allow you to get real-time feedback on the speed, position, and pose of the robot, which is essential for precise movement and navigation.
503503

504-
#### get_wheels_speed
504+
#### Check Wheels Speed
505505

506506
The `get_wheels_speed` function returns the current speed of the wheels.
507507

@@ -518,7 +518,7 @@ left_speed, right_speed = alvik.get_wheels_speed(unit='rpm')
518518
print(f"Left Wheel Speed: {left_speed} rpm, Right Wheel Speed: {right_speed} rpm")
519519
```
520520

521-
#### get_wheels_position
521+
#### Check Wheels Position
522522

523523
The `get_wheels_position` function returns the current angle of the wheels.
524524

@@ -535,7 +535,7 @@ left_angle, right_angle = alvik.get_wheels_position(unit='deg')
535535
print(f"Left Wheel Angle: {left_angle} degrees, Right Wheel Angle: {right_angle} degrees")
536536
```
537537

538-
#### get_drive_speed
538+
#### Check Velocity
539539

540540
The `get_drive_speed` function returns the linear and angular velocity of the robot.
541541

@@ -553,7 +553,7 @@ linear_velocity, angular_velocity = alvik.get_drive_speed(linear_unit='cm/s', an
553553
print(f"Linear Velocity: {linear_velocity} cm/s, Angular Velocity: {angular_velocity} deg/s")
554554
```
555555

556-
#### get_pose
556+
#### Check Pose
557557

558558
The `get_pose` function returns the current pose of the robot.
559559

@@ -1106,7 +1106,7 @@ while True:
11061106
By following these steps, you can control the LEDs on the Arduino Alvik robot to display different colors and create various lighting effects.
11071107

11081108

1109-
## Talking with other Machines!
1109+
## Talking With Other Machines!
11101110

11111111
### WiFi
11121112

@@ -1258,7 +1258,7 @@ This section ensures the server keeps running, accepting incoming connections, a
12581258

12591259
The ESP32 on the Arduino Alvik robot also supports ESP-NOW, a fast, connectionless communication protocol that enables direct, quick, and low-power control of smart devices without the need for a router. ESP-NOW can work alongside Wi-Fi and Bluetooth LE, making it versatile for various applications. It supports the ESP8266, ESP32, ESP32-S, and ESP32-C series. In this example, we'll set up the Alvik robot to receive commands via ESP-NOW.
12601260

1261-
#### Device identification
1261+
#### Device Identification
12621262

12631263
It is important for ESP-NOW to ensure that youknow the MAC address for your device.
12641264

@@ -1349,7 +1349,7 @@ while True:
13491349
sys.exit()
13501350
```
13511351

1352-
### Sending Commands from Another ESP32 Device
1352+
### Sending Commands
13531353

13541354
The following code can be used on another Alvik to send commands to the Alvik robot.
13551355

0 commit comments

Comments
 (0)