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
Copy file name to clipboardExpand all lines: software_installation.md
+25-26Lines changed: 25 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Little Red Rover relies on several pieces of software that must be installed pri
8
8
9
9
### Docker
10
10
11
-
Little Red Rover uses Docker as a compatability layer with your host operating system.
11
+
Little Red Rover uses Docker as a compatibility layer with your host operating system.
12
12
13
13
<!-- tabs:start -->
14
14
@@ -27,7 +27,7 @@ Follow the [installation instructions](https://docs.docker.com/desktop/install/l
27
27
28
28
### VSCode
29
29
30
-
To make working with Docker painless, its recommended to use the devcontainers feature of the VSCode. First, download VSCode if you don't have it installed already.
30
+
To make working with Docker painless, it's recommended to use the devcontainers feature of the VSCode. First, download VSCode if you don't have it installed already.
31
31
32
32
<!-- tabs:start -->
33
33
@@ -69,7 +69,7 @@ Follow the [installation instructions](https://git-scm.com/book/en/v2/Getting-St
69
69
70
70
> [!INFO]
71
71
> As of now, cloning over https is not supported.
72
-
> If you haven't already, please [follow the instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=windows) for adding an SSH key to your github account.
72
+
> If you haven't already, please [follow the instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=windows) for adding an SSH key to your GitHub account.
> ROS1 is nearing end of life. For new projects, it is highly recommended to use the most recent long term support (LTS) ROS2 distribution.
104
104
105
-
Next, open the project in VSCode (File -> Open Folder -> (chose the folder you just cloned) and start the devcontainer (View -> Command Palate -> (type) "Rebuild and Reopen in Container").
105
+
Next, open the project in VSCode (File → Open Folder → (chose the folder you just cloned)) and start the devcontainer (View → Command Palate → (type) "Rebuild and Reopen in Container").
106
106
107
107
> [!INFO]
108
108
> Mac and Windows users, Docker Desktop must be started before opening the container.
109
109
110
110
The first time building the container will take some time (30+ minutes). This only has to happen once, in the future it will be much quicker.
111
111
112
-
You should now have an open VSCode window running the developement container.
112
+
You should now have an open VSCode window running the development container.
113
113
114
114
## Connecting to the Robot
115
115
116
-
Power on your rover using the switch on the left side (near the usb port).
117
-
You'll know its turned on when the LiDAR on top starts spinning.
118
-
On boot up, the robot creates a wifi hotspot. Connect your development computer to the network named `little_red_rover_xx:xx:xx`, where `xx:xx:xx`are the 24 least significant bits of your rovers MAC address.
116
+
Power on your rover using the switch on the left side (near the USB port).
117
+
You'll know it's turned on when the LiDAR on top starts spinning.
118
+
On boot up, the robot creates a Wi-Fi hotspot. Connect your development computer to the network named `little_red_rover_xx:xx:xx`, where `xx:xx:xx`is a hexadecimal string unique to your rover.
119
119
120
-
Open a terminal in your VSCode window (Terminal -> New Terminal) and enter the following command.
120
+
Open a terminal in your VSCode window (Terminal → New Terminal) and enter the following command.
121
121
122
122
```bash
123
123
lrr_connect
124
124
```
125
125
126
-
Follow the instructions in the terminal to connect the robot to a wifi network.
126
+
Follow the instructions in the terminal to connect the robot to a Wi-Fi network.
127
127
128
128
> [!INFO]
129
129
> **Common network pitfalls**
@@ -132,19 +132,18 @@ Follow the instructions in the terminal to connect the robot to a wifi network.
132
132
> * As of now, Little Red Rover doesn't support authentication with networks that require a username (notably eduroam, used at universities across the world).
133
133
> - If your network requires a username, the host will most likely provide a seperate network for IOT devices. Use that network.
134
134
> - If you can't find a suitable network, ask your university's IT department how they recommend connecting an IOT device.
135
-
They may ask for a MAC address, which is `24:0A:C4:XX:XX:XX` with `XX:XX:XX` replaced by the ending of your rover's wifi SSID.
136
135
> * If your network has a captive portal, you'll be able to authenticate through the web browser on your computer.
137
-
> While connected to the rovers wifi network, open [this link](http://example.com). You'll be redirected to the login page.
136
+
> While connected to the rovers Wi-Fi network, open [this link](http://example.com). You'll be redirected to the login page.
138
137
139
138
> [!TIP]
140
-
> Connect to the wrong network? You can restart the connection process by holding the button labeled RP and restarting your robot. RP is short for reprovision, a term for connecting IOT devices to the network.
139
+
> Connect to the wrong network? You can restart the connection process by holding the button labeled RP and restarting your robot. RP is short for re-provision, a term for connecting IOT devices to the network.
141
140
142
-
Once you connect your robot to wifi, you should be able to browse the internet on your computer while connected to the robot's network. Your rover is acting as a router, and you're accessing the internet through it.
143
-
Whenever you use your rover, stay connected to its wifi network. This is how ROS (running on your computer) communicates with the rover.
141
+
Once you connect your robot to Wi-Fi, you should be able to browse the internet on your computer while connected to the robot's network. Your rover is acting as a router, and you're accessing the internet through it.
142
+
Whenever you use your rover, stay connected to its Wi-Fi network. This is how ROS (running on your computer) communicates with the rover.
144
143
145
144
146
145
> [!WARNING]
147
-
> You'll need to reconnect your rover to wifi each time you move to a new location. You'll know the rover needs to be reconnected when the `NETWORKING` status LED turns yellow on power-on.
146
+
> You'll need to reconnect your rover to Wi-Fi each time you move to a new location. You'll know the rover needs to be reconnected when the `NETWORKING` status LED turns yellow on power-on.
148
147
149
148
## Run Teleop
150
149
@@ -155,9 +154,9 @@ lrr_run
155
154
```
156
155
157
156
> [!INFO]
158
-
> **Whats going on here?**
157
+
> **What's going on here?**
159
158
>
160
-
> Astute readers may notice that this is not a ROS command, yet it executes roslaunch to start the teleop nodes. In Linux, this is know as an *alias*, or a console command that has been defined to execute some other command. To see what this alias is actually doing, run
159
+
> Astute readers may notice that this is not a ROS command, yet it executes `roslaunch` to start the teleop nodes. This is known as an *alias*, or a console command that has been defined to execute some other command. To see what this alias is actually doing, run
161
160
>
162
161
> ```alias lrr_run```
163
162
>
@@ -179,11 +178,11 @@ Foxglove is a tool we use for visualizing and controlling the rover.
In the top right corner, find the button that says 'Layout'. In the dropdown, select 'Import From File...' then navigate to `(template project installation path)/tools/lrr_default_layout.json`.
185
+
In the top right corner, find the button that says 'Layout'. In the drop-down, select 'Import From File...' then navigate to `(template project installation path)/tools/lrr_default_layout.json`.
> This command runs a node that converts key presses into a [ROS Twist message](https://docs.ros.org/en/melodic/api/geometry_msgs/html/msg/Twist.html). This message it published on the topic `/cmd_vel`, where the rover is subscribed for teleop commands. In a third terminal, try running this command to see what the node is outputting:
0 commit comments