-
Notifications
You must be signed in to change notification settings - Fork 16
/
mkdocs.yml
167 lines (157 loc) · 5.86 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
site_name: Create® 3 Docs
site_description: 'Documentation for the iRobot® Create® 3 robot'
site_author: 'iRobot'
#site_url: http://edu.irobot.com/create3/
repo_name: 'iRobotEducation/create3_docs'
repo_url: 'https://github.com/iRobotEducation/create3_docs'
edit_uri: 'edit/main/docs/'
docs_dir: docs/
theme:
name: material
custom_dir: theme_overrides
logo: assets/irobot_symbol_white.png
favicon: assets/irobot_symbol_green.png
extra_css:
- stylesheets/irobot-palette.css
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/iRobotEducation
- icon: fontawesome/brands/github
link: https://github.com/iRobotEducation
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/iRobotEducation
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/irobot/
analytics:
provider: google
property: G-9QX6GHMSD7
copyright: Copyright © 2021-2024 iRobot Corporation. All Rights Reserved.
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- footnotes
- attr_list
plugins:
- search
- macros
nav:
- Home: index.md
- Hardware:
- Overview: hw/overview.md
- Mechanical: hw/mechanical.md
- Electrical:
- Electrical Overview: hw/electrical.md
- Buttons and Light Ring: hw/face.md
- Adapter Board: hw/adapter.md
- Printable Accessories:
- Compute Boards: hw/print_compute.md
- Create® 3 Caster: hw/print_casters.md
- Generic Mounts: hw/print_generic.md
- Sensor Mounts: hw/print_sensor_mounts.md
- Webserver:
- Overview: webserver/overview.md
- Home: webserver/home.md
- Connect: webserver/connect.md
- Update: webserver/update.md
- Logs: webserver/logs.md
- Application: webserver/application.md
- Beta Features:
- Serial Port Forward: webserver/serial-config.md
- Set Date and Time: webserver/set-datetime.md
- Edit ntp.conf: webserver/edit-ntp-conf.md
- Restart ntpd: webserver/restart-ntpd.md
- Set Wired Subnet: webserver/set-wired-subnet.md
- Override RMW Profile: webserver/rmw-profile-override.md
- Forget Wi-Fi Network: webserver/forget-wifi.md
- Override wpa_supplicant: webserver/wpa-supp-override.md
- About: webserver/about.md
- Setup:
- Connect to Wi-Fi: setup/provision.md
- Multi-Robot Setup: setup/multi-robot.md
- ROS 2 Setup:
- Galactic on Ubuntu 20: setup/ubuntu2004.md
- Humble on Ubuntu 22: setup/ubuntu2204.md
- Run with Docker: setup/docker.md
- Middleware Config: setup/xml-config.md
- Network Recommendations: setup/network-config.md
- Add a Compute Board:
- NavQPlus by NXP®:
- Hookup Guide: hw/navqplus_hookup.md
- Software Config: setup/navqplus.md
- NVIDIA® Jetson™:
- Hookup Guide: hw/jetson_hookup.md
- Software Config: setup/jetson.md
- Raspberry Pi®:
- Hookup Guide: hw/rpi_hookup.md
- Galactic Config: setup/pi4galactic.md
- Humble Config: setup/pi4humble.md
- Network Time Protocol: setup/compute-ntp.md
- Fast DDS Discovery Server: setup/discovery-server.md
- APIs:
- ROS 2 Interface: api/ros2.md
- Moving the Robot: api/moving-the-robot.md
- Docking: api/docking.md
- Drive Goals: api/drive-goals.md
- Hazards: api/hazards.md
- Odometry: api/odometry.md
- Reflexes: api/reflexes.md
- Safety: api/safety.md
- User Interface: api/ui.md
- Wall Follow: api/wall-follow.md
- Simulator:
- Using the Simulator: sim/setup.md
- Lessons:
- Create 3 Basics: lessons/getting-started.md
- Getting started with ROS 2:
- Overview: lessons/ros2/overview.md
- Intro to ROS 2:
- Working with the CLI: lessons/ros2/intro/working-with-the-cli.md
- Writing Pubs and Subs: lessons/ros2/intro/writing-pubs-and-subs.md
- Writing Action Clients: lessons/ros2/intro/writing-action-clients.md
- Creating Packages: lessons/ros2/intro/creating-packages.md
- Serial Communication: lessons/ros2/intro/serial-communication.md
- Teleop Twist: lessons/ros2/teleop-twist.md
- Using BLE with Python:
- Python Web Playground: lessons/pwp/web-playground.md
- Robot Dance Recital: lessons/pwp/robot-dance-recital.md
- Light Painting: lessons/pwp/light-painting.md
- Sound Off, 1-2: lessons/pwp/sound-off-1-2.md
- C3, Phone Home: lessons/pwp/c3-phone-home.md
- Integrating AirTable: lessons/pwp/integrating-airtable.md
- Python Cheat Sheets: lessons/pwp/cheat-sheets.md
- Software Examples:
- Actuators via CLI: examples/actuators-cli.md
- Sensors via CLI: examples/sensors-cli.md
- Navigation Apps: examples/create3_examples.md
- Firmware Releases:
- Overview: releases/overview.md
- Galactic:
- G.5.4: releases/g_5_4.md
- Older:
- G.1.1: releases/g_1_1.md
- G.2.2: releases/g_2_2.md
- G.3.1: releases/g_3_1.md
- G.4.1: releases/g_4_1.md
- G.4.3: releases/g_4_3.md
- G.4.4: releases/g_4_4.md
- G.4.5: releases/g_4_5.md
- G.5.1: releases/g_5_1.md
- G.5.2: releases/g_5_2.md
- G.5.3: releases/g_5_3.md
- Humble:
- H.2.6: releases/h_2_6.md
- Older:
- H.0.0: releases/h_0_0.md
- H.1.0: releases/h_1_0.md
- H.1.1: releases/h_1_1.md
- H.1.2: releases/h_1_2.md
- H.2.1: releases/h_2_1.md
- H.2.2: releases/h_2_2.md
- H.2.3: releases/h_2_3.md
- H.2.4: releases/h_2_4.md
- H.2.5: releases/h_2_5.md
- Iron:
- I.0.0: releases/i_0_0.md
- FAQ: faq/faq.md