You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Install StepIt on the Microcontroller](#install-stepit-on-the-microcontroller)
14
+
-[Install StepIt on the Local Computer](#install-stepit-on-the-local-computer)
15
+
-[Setup a Project Workspace](#setup-a-project-workspace)
16
+
-[Chekout the Git Repository](#chekout-the-git-repository)
17
+
-[Pre-Commit Hooks](#pre-commit-hooks)
18
+
-[Build the Project](#build-the-project)
19
+
-[Running the Application](#running-the-application)
20
+
-[How to run GitHub Actions locally](#how-to-run-github-actions-locally)
21
+
22
+
7
23
## Introduction
8
24
9
25
StepIt is a project to control stepper motors with a Teensy microcontroller and ROS2.
@@ -24,17 +40,17 @@ For a real application, we recommend attaching the stepper motors to a Teensy mi
24
40
25
41
The Teensy is connected to a computer using a USB cable. For a portable application, we can use a [Raspberry PI 4](docs/install_ros_on_rasperry_pi/install_ros2_on_rasperry_pi.md).
26
42
27
-
## Install StepIt on the microcontroller
43
+
## Install StepIt on the Microcontroller
28
44
29
45
We developed code for the Teensy microcontroller using Visual Studio Code because it provides very good tools to format and validate the code. To achieve this goal, we must install [PlatformIO](https://platformio.org) extension which supports different microcontrollers including Arduino. Installing Arduino IDE is not required.
30
46
31
47
If PlatformIO cannot find the Python interpreter, install the following:
32
48
33
49
`sudo apt install python3-venv`
34
50
35
-
## Install StepIt on the local computer
51
+
## Install StepIt on the Local Computer
36
52
37
-
### Setup a project workspace
53
+
### Setup a Project Workspace
38
54
39
55
Open a terminal and run the following command to source the ROS 2 Humble installation.
40
56
@@ -52,7 +68,7 @@ mkdir stepit_ws
52
68
cd stepit_ws
53
69
```
54
70
55
-
### Chekout the git repository
71
+
### Chekout the Git Repository
56
72
57
73
Create a source folder and check out this git repository, including all required submodules.
58
74
@@ -75,15 +91,15 @@ Remember to enable recursion for relevant git commands, such that regular comman
75
91
git config --global submodule.recurse true
76
92
```
77
93
78
-
### Pre-commit hooks
94
+
### Pre-Commit Hooks
79
95
80
96
Additionally, you should install git pre-commit hooks using the following command:
81
97
82
98
```
83
99
pre-commit install
84
100
```
85
101
86
-
### Build the project
102
+
### Build the Project
87
103
88
104
Move into the base `<STEPIT_WS>` folder and install all required dependencies.
89
105
@@ -104,7 +120,7 @@ Execute all tests.
104
120
colcon test
105
121
```
106
122
107
-
## Running the application
123
+
## Running the Application
108
124
109
125
By default, the application runs with fake motors. Run the following commands on a terminal to start it up. This will also start up RViz.
The trajectory is a list of waypoints, each of them containing the desired position and velocity of each joint at a given time.
187
203
188
-
## How to run GitHub actions locally
204
+
## How to run GitHub Actions locally
189
205
190
206
At each commit, the GitHub repository runs all available tests using [GitHub actions](https://docs.github.com/en/actions) and [Industrial CI](https://github.com/ros-industrial/industrial_ci).
0 commit comments