From c4088b38b55f3a81c51b04be1656fb3f455d0457 Mon Sep 17 00:00:00 2001 From: Steven Shamlian Date: Tue, 16 Apr 2024 17:56:55 -0400 Subject: [PATCH] Update references to iRobot Education Bluetooth Protocol --- .github/DISCUSSION_TEMPLATE/Questions.yml | 2 +- docs/hw/adapter.md | 2 +- docs/hw/face.md | 4 ++-- docs/hw/overview.md | 2 +- docs/webserver/connect.md | 5 +++-- docs/webserver/overview.md | 5 +++-- 6 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/Questions.yml b/.github/DISCUSSION_TEMPLATE/Questions.yml index 911540ce..97d75d9b 100644 --- a/.github/DISCUSSION_TEMPLATE/Questions.yml +++ b/.github/DISCUSSION_TEMPLATE/Questions.yml @@ -16,9 +16,9 @@ body: - Wi-Fi (ROS 2) - USB Ethernet (ROS 2) - Wi-Fi and USB Ethernet (ROS 2) - - Bluetooth (iRobot Coding) - Bluetooth (Python Playground) - Bluetooth (Python SDK) + - Bluetooth (Other) - I'm not sure validations: required: true diff --git a/docs/hw/adapter.md b/docs/hw/adapter.md index f111101f..11acd462 100644 --- a/docs/hw/adapter.md +++ b/docs/hw/adapter.md @@ -30,7 +30,7 @@ If power is drawn through the USB-C® connector, then less power is available th ## USB/BLE Toggle 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. -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). +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. ## Indicators ### Orange Indicator diff --git a/docs/hw/face.md b/docs/hw/face.md index 6cac95a8..82ac1404 100644 --- a/docs/hw/face.md +++ b/docs/hw/face.md @@ -10,12 +10,12 @@ Button 1 (to the left of center) is marked with a single dot (•). If held for ten seconds, the robot will go into "standby" mode, keeping its charging circuitry active, and continuing to power the payload. The robot can be placed on the dock to charge or to keep the payload alive in this mode. To wake the robot from standby, hold the center button for one second. -Button presses can be accessed by the user in both ROS 2 and iRobot Coding / Bluetooth[^1] modes. +Button presses can be accessed by the user in both ROS 2 and iRobot Education Bluetooth[^1] modes. ### Button 2 Button 2 (to the right of center) is marked with two dots (••). This button is a user button only. -Button presses can be accessed by the user in both ROS 2 and iRobot Coding / Bluetooth[^1] modes. +Button presses can be accessed by the user in both ROS 2 and iRobot Education Bluetooth[^1] modes. ### Center Button The center button is marked with a power (⏻) icon. diff --git a/docs/hw/overview.md b/docs/hw/overview.md index 62792ff8..d92e7724 100644 --- a/docs/hw/overview.md +++ b/docs/hw/overview.md @@ -5,7 +5,7 @@ The robot also ships with an iRobot® Home Base™ Charging Station. ![Create® 3 from its above-front-right, next to its dock.](data/front_iso.jpg "Robot Front")
The front of the robot features a multizone bumper with seven pairs of IR proximity sensors, which can be used to detect obstacles. -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.) +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.) The power button features a ring of six RGB LEDs for indication. ![Create® 3 from its above-rear-left, with the top cover and cargo bay removed.](data/rear_iso.jpg "Robot Rear")
diff --git a/docs/webserver/connect.md b/docs/webserver/connect.md index c219bf74..9c836642 100644 --- a/docs/webserver/connect.md +++ b/docs/webserver/connect.md @@ -5,7 +5,7 @@ The connect page of the Create® 3 webserver allows the robot's name to be chang The top of the connect page gives the robot's current IPv4 address. -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.) +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.) The "Connect to a 2.4 GHz Wi-Fi Network" box allows the user to connect to any network the robot can perceive. Clicking on the box to the right of "Type your Wi-Fi network name" should yield a drop-down of all available networks. @@ -13,4 +13,5 @@ Clicking on the box to the right of "Type your Wi-Fi network name" should yield It may be necessary to change the drop-down for additional radio bands, depending on the region in which the robot is used. 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." -[^1]: All trademarks mentioned are the property of their respective owners. \ No newline at end of file +[^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. +[^2]: All trademarks mentioned are the property of their respective owners. \ No newline at end of file diff --git a/docs/webserver/overview.md b/docs/webserver/overview.md index ca368f6d..60677cb4 100644 --- a/docs/webserver/overview.md +++ b/docs/webserver/overview.md @@ -11,7 +11,7 @@ The robot will get an IP address over DHCP as served by your network on its `wla The webserver is available over http (port 80) in a browser by navigating to its IP address on whichever interface is active. !!! attention - It is not recommended to run the robot's access point while also controlling the robot via ROS 2 or iRobot Coding. + 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. Please use the menu to navigate between sections of the webserver, or else navigate directly to the sections below: @@ -30,4 +30,5 @@ Please use the menu to navigate between sections of the webserver, or else navig - [About](../webserver/about.md) [^1]: ROS 2 is governed by Open Robotics -[^2]: All other trademarks mentioned are the property of their respective owners. +[^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. +[^3]: All other trademarks mentioned are the property of their respective owners.