Skip to content

Commit 9a22d59

Browse files
Suggested changes
Fixed name of article and API Overview structure
1 parent 0314cbf commit 9a22d59

File tree

9 files changed

+49
-52
lines changed

9 files changed

+49
-52
lines changed

content/hardware/08.edu/solution-and-kits/alvik/tutorials/api-overview/api-overview.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,53 @@ _Register callback when touch button RIGHT is pressed_
633633
- **callback**: the name of the function to recall
634634
- **args**: optional arguments of the function
635635

636+
## Function Parameters
637+
638+
### The Distance Unit
639+
640+
Distance unit of measurement used in the APIs:
641+
642+
- _cm_: centimeters
643+
- _mm_: millimeters
644+
- _m_: meters
645+
- _inch_: inch, 2.54 cm
646+
- _in_: inch, 2.54 cm
647+
648+
### The Angle Unit
649+
650+
Angle unit of measurement used in the APIs:
651+
652+
- _deg_: degrees, example: 1.0 as reference for the other unit. 1 degree is 1/360 of a circle.
653+
- _rad_: radiant, example: 1 radiant is 180/pi deg.
654+
- _rev_: revolution, example: 1 rev is 360 deg.
655+
- _revolution_: same as rev
656+
- _perc_: percentage, example 1 perc is 3.6 deg.
657+
- _%_: same as perc
658+
659+
### The Linear Speed Unit
660+
661+
Speed unit of measurement used in the APIs:
662+
663+
- 'cm/s': centimeters per second
664+
- 'mm/s': millimeters per second
665+
- 'm/s': meters per second
666+
- 'inch/s': inch per second
667+
- 'in/s': inch per second
668+
669+
### The Rotational Speed Unit
670+
671+
Rotational speed unit of measurement used in the APIs:
672+
673+
- 'rpm': revolutions per minute, example: 1.0 as reference for the other unit.
674+
- 'deg/s': degrees per second, example: 1.0 deg/s is 60.0 deg/min that is 1/6 rpm.
675+
- 'rad/s': radiant per second, example: 1.0 rad/s is 60.0 rad/min that is 9.55 rpm.
676+
- 'rev/s': revolution per second, example: 1.0 rev/s is 60.0 rev/min that is 60.0 rpm.
677+
678+
### `"blocking" or "non blocking"`
679+
680+
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.
681+
682+
On the other hand, "Non blocking", means that the microcontroller is free to do other thing while the action is been performed.
636683

637684
## Examples
638685
These examples demonstrate practical implementations on how to use the Arduino Alvik API. Whether you're working with MicroPython or C++, these simple examples will help you understand how to implement various features in your projects, making it easy to get started with the Alvik in the language you're most comfortable with.
@@ -925,50 +972,3 @@ float calculate_center(const int left, const int center, const int right){
925972
926973
927974
928-
## Extras
929-
930-
### The Distance Unit
931-
932-
Distance unit of measurement used in the APIs:
933-
934-
- _cm_: centimeters
935-
- _mm_: millimeters
936-
- _m_: meters
937-
- _inch_: inch, 2.54 cm
938-
- _in_: inch, 2.54 cm
939-
940-
### The Angle Unit
941-
942-
Angle unit of measurement used in the APIs:
943-
944-
- _deg_: degrees, example: 1.0 as reference for the other unit. 1 degree is 1/360 of a circle.
945-
- _rad_: radiant, example: 1 radiant is 180/pi deg.
946-
- _rev_: revolution, example: 1 rev is 360 deg.
947-
- _revolution_: same as rev
948-
- _perc_: percentage, example 1 perc is 3.6 deg.
949-
- _%_: same as perc
950-
951-
### The Linear Speed Unit
952-
953-
Speed unit of measurement used in the APIs:
954-
955-
- 'cm/s': centimeters per second
956-
- 'mm/s': millimeters per second
957-
- 'm/s': meters per second
958-
- 'inch/s': inch per second
959-
- 'in/s': inch per second
960-
961-
### The Rotational Speed Unit
962-
963-
Rotational speed unit of measurement used in the APIs:
964-
965-
- 'rpm': revolutions per minute, example: 1.0 as reference for the other unit.
966-
- 'deg/s': degrees per second, example: 1.0 deg/s is 60.0 deg/min that is 1/6 rpm.
967-
- 'rad/s': radiant per second, example: 1.0 rad/s is 60.0 rad/min that is 9.55 rpm.
968-
- 'rev/s': revolution per second, example: 1.0 rev/s is 60.0 rev/min that is 60.0 rpm.
969-
970-
### `"blocking" or "non blocking"`
971-
972-
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.
973-
974-
On the other hand, "Non blocking", means that the microcontroller is free to do other thing while the action is been performed.

content/hardware/08.edu/solution-and-kits/alvik/tutorials/getting-startedc/getting-startedc.md renamed to content/hardware/08.edu/solution-and-kits/alvik/tutorials/setting-alvik-arduino-ide/setting-alvik-arduino-ide.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
---
2-
title: "Getting Started with Alvik"
2+
title: "Setting up Alvik on Arduino IDE"
33
difficulty: beginner
4-
description: "Take your first steps with Arduino® Alvik on Arduino IDE"
4+
description: "Learn how to configure your Alvik for Arduino IDE"
55
tags:
66
- Robot, MicroPython, Education
77
author: "Pedro Sousa Lima"
88
---
9-
10-
# Getting Started with Alvik on Arduino IDE
11-
129
The Arduino® Alvik robot was designed to be compatible with both C++ and MicroPython. To ensure a smooth experience, functions have the same structure and parameters across all environments. This means the [Alvik's API reference](https://docs.arduino.cc/tutorials/alvik/api-overview/) can be used as a resource regardless of which environment you choose. In this guide, we will prepare the board to be programmed using the Arduino IDE.
1310

1411
## Requirements

0 commit comments

Comments
 (0)