Skip to content

Commit 94cbc28

Browse files
authored
Merge pull request #579 from iRobotEducation/shamlian/fix-irobot-coding
Update references to iRobot Education Bluetooth Protocol
2 parents b00d113 + c4088b3 commit 94cbc28

File tree

6 files changed

+11
-9
lines changed

6 files changed

+11
-9
lines changed

.github/DISCUSSION_TEMPLATE/Questions.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ body:
1616
- Wi-Fi (ROS 2)
1717
- USB Ethernet (ROS 2)
1818
- Wi-Fi and USB Ethernet (ROS 2)
19-
- Bluetooth (iRobot Coding)
2019
- Bluetooth (Python Playground)
2120
- Bluetooth (Python SDK)
21+
- Bluetooth (Other)
2222
- I'm not sure
2323
validations:
2424
required: true

docs/hw/adapter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If power is drawn through the USB-C® connector, then less power is available th
3030

3131
## USB/BLE Toggle
3232
The **USB/BLE toggle** routes the robot's single USB Host connection either to the USB-C® port (useful for connecting to single-board computers with OTG or device ports) or to the on-board Bluetooth® Low Energy[^4] module.
33-
This module can be used to interact with the [iRobot Education Python Web Playground](https://python.irobot.com/) or [iRobot Coding app](https://code.irobot.com).
33+
This module can be used to interact with the [iRobot Education Python Web Playground](https://python.irobot.com/) or any other application supporting the iRobot Education Bluetooth® protocol.
3434

3535
## Indicators
3636
### Orange Indicator

docs/hw/face.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Button 1 (to the left of center) is marked with a single dot (•).
1010
If held for ten seconds, the robot will go into "standby" mode, keeping its charging circuitry active, and continuing to power the payload.
1111
The robot can be placed on the dock to charge or to keep the payload alive in this mode.
1212
To wake the robot from standby, hold the center button for one second.
13-
Button presses can be accessed by the user in both ROS 2 and iRobot Coding / Bluetooth[^1] modes.
13+
Button presses can be accessed by the user in both ROS 2 and iRobot Education Bluetooth[^1] modes.
1414

1515
### Button 2
1616
Button 2 (to the right of center) is marked with two dots (••).
1717
This button is a user button only.
18-
Button presses can be accessed by the user in both ROS 2 and iRobot Coding / Bluetooth[^1] modes.
18+
Button presses can be accessed by the user in both ROS 2 and iRobot Education Bluetooth[^1] modes.
1919

2020
### Center Button
2121
The center button is marked with a power (⏻) icon.

docs/hw/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The robot also ships with an iRobot® Home Base™ Charging Station.
55

66
![Create® 3 from its above-front-right, next to its dock.](data/front_iso.jpg "Robot Front")<br>
77
The front of the robot features a multizone bumper with seven pairs of IR proximity sensors, which can be used to detect obstacles.
8-
The top of the robot contains three buttons which can all be overloaded by a ROS 2 application (only the • and •• buttons can be overloaded in the iRobot Coding app.)
8+
The top of the robot contains three buttons which can all be overloaded by a ROS 2 application (only the • and •• buttons can be overloaded using the iRobot Education Bluetooth®[^1] protocol.)
99
The power button features a ring of six RGB LEDs for indication.
1010

1111
![Create® 3 from its above-rear-left, with the top cover and cargo bay removed.](data/rear_iso.jpg "Robot Rear")<br>

docs/webserver/connect.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ The connect page of the Create® 3 webserver allows the robot's name to be chang
55

66
The top of the connect page gives the robot's current IPv4 address.
77

8-
The "Update Robot Names" box allows the user to change the robot's hostname (which can also be used to find the robot using mDNS) and its Bluetooth name (which can be used to find it in iRobot Coding.)
8+
The "Update Robot Names" box allows the user to change the robot's hostname (which can also be used to find the robot using mDNS) and its Bluetooth name (which can be used to find it using the iRobot Education Bluetooth®[^1] protocol.)
99

1010
The "Connect to a 2.4 GHz Wi-Fi Network" box allows the user to connect to any network the robot can perceive.
1111
Clicking on the box to the right of "Type your Wi-Fi network name" should yield a drop-down of all available networks.
1212

1313
It may be necessary to change the drop-down for additional radio bands, depending on the region in which the robot is used.
1414
If you are using the robot in Japan (JP), please select "Japan;" if you are using the robot in any of (AS, CA, FM, GU, KY, MP, PR, TW, UM, US, or VI), please select "North America."
1515

16-
[^1]: All trademarks mentioned are the property of their respective owners.
16+
[^1]: The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks by iRobot is under license.
17+
[^2]: All trademarks mentioned are the property of their respective owners.

docs/webserver/overview.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The robot will get an IP address over DHCP as served by your network on its `wla
1111
The webserver is available over http (port 80) in a browser by navigating to its IP address on whichever interface is active.
1212

1313
!!! attention
14-
It is not recommended to run the robot's access point while also controlling the robot via ROS 2 or iRobot Coding.
14+
It is not recommended to run the robot's access point while also controlling the robot via ROS 2 or the iRobot Education Bluetooth®[^2] protocol.
1515

1616
Please use the menu to navigate between sections of the webserver, or else navigate directly to the sections below:
1717

@@ -30,4 +30,5 @@ Please use the menu to navigate between sections of the webserver, or else navig
3030
- [About](../webserver/about.md)
3131

3232
[^1]: ROS 2 is governed by Open Robotics
33-
[^2]: All other trademarks mentioned are the property of their respective owners.
33+
[^2]: The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks by iRobot is under license.
34+
[^3]: All other trademarks mentioned are the property of their respective owners.

0 commit comments

Comments
 (0)