Skip to content

Commit ee952b0

Browse files
Add chrome requirement to the firmware tool
1 parent f1d56df commit ee952b0

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

firmware_tool.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@ To flash it with the newest firmware, click 'Program'. To open a console click '
66

77
For either option, you'll be asked to select a serial device. Chose the option that says 'USB JTAG / serial debug unit'.
88

9-
[firmware tool](/firmware_tool.html ':include :type=iframe width=100% height=500px')
9+
> [!NOTE]
10+
> The firmware tool only works on Google Chrome.
11+
12+
[Firmware tool](/firmware_tool.html ':include :type=iframe width=100% height=500px')

software_installation.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Little Red Rover relies on several pieces of software that must be installed pri
88

99
### Docker
1010

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.
1212

1313
<!-- tabs:start -->
1414

@@ -27,7 +27,7 @@ Follow the [installation instructions](https://docs.docker.com/desktop/install/l
2727

2828
### VSCode
2929

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.
3131

3232
<!-- tabs:start -->
3333

@@ -69,7 +69,7 @@ Follow the [installation instructions](https://git-scm.com/book/en/v2/Getting-St
6969

7070
> [!INFO]
7171
> 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.
7373
7474

7575
## Setting Up Your Development Environment
@@ -102,28 +102,28 @@ git clone --recurse-submodules [email protected]:little-red-rover/lrr-template-proj
102102
> [!TIP]
103103
> ROS1 is nearing end of life. For new projects, it is highly recommended to use the most recent long term support (LTS) ROS2 distribution.
104104
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").
106106

107107
> [!INFO]
108108
> Mac and Windows users, Docker Desktop must be started before opening the container.
109109
110110
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.
111111

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.
113113

114114
## Connecting to the Robot
115115

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.
119119

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.
121121

122122
```bash
123123
lrr_connect
124124
```
125125

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.
127127

128128
> [!INFO]
129129
> **Common network pitfalls**
@@ -132,19 +132,18 @@ Follow the instructions in the terminal to connect the robot to a wifi network.
132132
> * As of now, Little Red Rover doesn't support authentication with networks that require a username (notably eduroam, used at universities across the world).
133133
> - If your network requires a username, the host will most likely provide a seperate network for IOT devices. Use that network.
134134
> - 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.
136135
> * 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.
138137
139138
> [!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.
141140
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.
144143

145144

146145
> [!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.
148147
149148
## Run Teleop
150149

@@ -155,9 +154,9 @@ lrr_run
155154
```
156155

157156
> [!INFO]
158-
> **Whats going on here?**
157+
> **What's going on here?**
159158
>
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
161160
>
162161
> ```alias lrr_run```
163162
>
@@ -179,11 +178,11 @@ Foxglove is a tool we use for visualizing and controlling the rover.
179178

180179
![](./_images/software_installation/open_connection.png)
181180

182-
In the following popup, leave 'Foxglove Websocket' selected the default value of 'ws://localhost:8765' for the url. Click 'Open'.
181+
In the following popup, leave 'Foxglove Websocket' selected the default value of 'ws://localhost:8765' for the URL. Click 'Open'.
183182

184183
![](./_images/software_installation/open_connection_popup.png)
185184

186-
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`.
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`.
187186

188187
![](./_images/software_installation/import_layout.png)
189188

@@ -199,16 +198,16 @@ Try picking up the rover and moving it around, you should see the LiDAR readings
199198

200199
> [!WARNING]
201200
> If LiDAR data doesn't appear, the robot is probably having trouble communicating with your computer.
202-
> Little Red Rover uses UDP port 8001, make sure this port is allowed through your firewall.
203-
> Instructions vary with operating system, try googling "allow UDP port through firewall".
201+
> Little Red Rover uses TCP port 8001, make sure this port is allowed through your firewall.
202+
> Instructions vary with operating system, try googling "allow TCP port through firewall".
204203
205204
Now is a great chance to play around with Foxglove.
206205
Add some panels, change some settings, plot some values, see what you can do.
207-
If you mess something up and want to return to the origional layout, just click revert:
206+
If you mess something up and want to return to the original layout, just click revert:
208207

209208
![](./_images/software_installation/revert.png)
210209

211-
## Lets Get Rolling!
210+
## Let's Get Rolling!
212211

213212
Time to get the rover driving around!
214213
Before you continue, place your rover on the ground and away from people.
@@ -227,7 +226,7 @@ rosrun teleop_twist_keyboard teleop_twist_keyboard.py _speed:=0.2 _turn:=2.0 _ke
227226

228227
#### **ROS2: Humble (Recommended)**
229228

230-
Comming soon...
229+
Coming soon...
231230

232231
#### **ROS1: Noetic**
233232

@@ -238,7 +237,7 @@ rosrun teleop_twist_keyboard teleop_twist_keyboard.py _speed:=0.2 _turn:=2.0 _ke
238237
<!-- tabs:end -->
239238

240239
> [!INFO]
241-
> **Whats going on here?**
240+
> **What's going on here?**
242241
>
243242
> 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:
244243
>

0 commit comments

Comments
 (0)