Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
3f8a3f2
Remove not implemented topics before raph launch
jasiex01 Oct 30, 2025
58aa970
Change imu topics in ROS API
jasiex01 Oct 30, 2025
1aa8972
Add guides link to getting started
jasiex01 Oct 30, 2025
5f88c22
Create a separate page for web UI
jasiex01 Oct 30, 2025
3c60930
Add animations for led table
jasiex01 Oct 30, 2025
6fe8598
Add software part of user manual
jasiex01 Oct 30, 2025
32e7a5c
Format
jasiex01 Oct 30, 2025
6c114f3
Move wheels parameters from user manual to specification
Krzemien97 Oct 31, 2025
f786713
Move battery charging from getting started to the user manual
Krzemien97 Oct 31, 2025
6301026
User manual update
Krzemien97 Oct 31, 2025
9e4a801
Add mechanical mountings
Krzemien97 Oct 31, 2025
6d299f6
Update raph's frontmatter
Krzemien97 Oct 31, 2025
7554f36
Unify titles
Krzemien97 Oct 31, 2025
da966f8
Add partial inspection & cleaning. Add controlling the rover section
Krzemien97 Oct 31, 2025
5681f93
Break user manual into smaller parts
jasiex01 Oct 31, 2025
470f1df
Add UI picture to the manual
Krzemien97 Nov 26, 2025
8543853
Add web user interface page
Krzemien97 Nov 27, 2025
1fb5d62
Move safety guidelines
Krzemien97 Nov 27, 2025
317d9d7
Add safety guidelines
Krzemien97 Nov 28, 2025
8b7f423
Fix links
Krzemien97 Nov 28, 2025
7545b78
Reformat with correct prettier
Krzemien97 Nov 28, 2025
b46bc5e
Fix spelling
Krzemien97 Nov 28, 2025
6c96dfb
Formatting :)
Krzemien97 Nov 28, 2025
f096541
Fix typos
Krzemien97 Nov 28, 2025
3ba4519
Apply review comments
Krzemien97 Dec 10, 2025
ceb89b3
Reformat
Krzemien97 Dec 10, 2025
12b1979
Separate state actions from state descriptions
jasiex01 Dec 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
509 changes: 0 additions & 509 deletions docs/raph-rover/documentation/_user-manual.mdx

This file was deleted.

80 changes: 7 additions & 73 deletions docs/raph-rover/documentation/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import ThemedImageZoom from '@site/src/components/ThemedImageZoom';
import FlexTable from '@site/src/components/FlexTable';
import FlexTableItem from '@site/src/components/FlexTableItem';
import CenterContent from '@site/src/components/CenterContent';
import LinkButton from '@site/src/components/LinkButton';

import Support from '@site/docs/raph-rover/partial/_support.mdx';

Expand Down Expand Up @@ -260,79 +261,14 @@ driving, preview stream from on-board camera.
To access it, open your web browser and navigate to
[10.10.0.2](http://10.10.0.2).

From here, you can control the rover, access the camera feed, and configure
various settings. You can control the rover using the on-screen joystick.
From here, you can control the rover using keyboard and on-screen joystick,
access the camera feed, and configure various settings.

:::tip

You can use gamepads, including Xbox and PlayStation controllers, with the Web
UI. First, plug the controller into your device. The UI will confirm the
connection with a "Gamepad connected" notification. You can then immediately
start controlling the robot with the gamepad.

:::

_More inforation coming soon_

{/* TODO: ADD UI Pictures */}

## Maintenance

### Charging batteries

Raph Rover comes with a 4A 25,2V Li-Ion charger. It can charge 1 battery pack in
about 1.5 hour via the dedicated charging slot.

<ThemedImageZoom
alt="Raph Rover battery dock"
sources={{
light: useBaseUrl('/img/robots/raph/getting-started/Charging_black.webp'),
dark: useBaseUrl('/img/robots/raph/getting-started/Charging_white.webp'),
}}
width="3000"
height="2121"
figStyle={{
width: 600,
}}
/>

The charger (not the dock) is outfitted with an LED status indicator designed to
provide information about the charging status of the battery. A green LED
signifies that the battery has reached full charge, while a red LED indicates
that the battery is currently in the charging process.

As an alternative, the batteries can be charged via the rover, by leaving them
inside the battery ports and connecting the charger to the rover's power input
located at the back.

<ThemedImageZoom
alt="Raph Rover with power adapter"
sources={{
light: useBaseUrl(
'/img/robots/raph/getting-started/Charging_rover_black.webp',
),
dark: useBaseUrl(
'/img/robots/raph/getting-started/Charging_rover_white.webp',
),
}}
width="3000"
height="2121"
figStyle={{
width: 600,
}}
/>

This way it's possible to charge both batteries at the same time, however the
charging current will be split between them, resulting in a longer charging time
of around 2.5 h. The Rover does not need to be powered off for this process.
:::info

:::note
To find out more about using the Web UI, visit the documentation page below:

When working on the rover while charging the batteries the LED indicator of
power adapter will not transition to green when charging is complete. Power draw
of the rover will keep the charger in active (red) state. To check battery
level, press the power button once. Fully illuminated LED side panels will
indicate fully charged batteries.
<LinkButton docId="documentation/web-user-interface" />

:::

Expand All @@ -341,9 +277,7 @@ indicate fully charged batteries.
After initial testing, you can explore what else Raph Rover has to offer. Start
developing your own robotic application with help of our tutorials:

_Coming soon_

{/* TODO: Add link to guides */}
<LinkButton to="/raph-rover/guides" title="Guides" />

### Support

Expand Down
25 changes: 6 additions & 19 deletions docs/raph-rover/documentation/ros-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,6 @@ image: /img/robots/raph/raph-rover.webp

Steers the robot when operating in the Ackermann steering mode.

- `controller/cmd_turn_in_place` (?) **Not implemented yet**

Steers the robot when operating in the Turn-In-Place steering mode.

- `controller/cmd_vel` ([geometry_msgs/msg/Twist]) **Not implemented yet**

Steers the robot using `Twist` commands. More standardized way to control the
robot. \
Useful for some navigation stacks. Not recommended for manual teleoperation.

- `controller/led_strip_state` ([raph_interfaces/msg/LedStripState])

Sets a new user state for all the LEDs in the LED strip.
Expand All @@ -44,21 +34,14 @@ image: /img/robots/raph/raph-rover.webp

## Published Topics

- `controller/imu` ([sensor_msgs/msg/Imu])
- `controller/imu/data_raw` ([sensor_msgs/msg/Imu])

Current gyroscope and accelerometer readings from the onboard IMU.

- `controller/odom` ([nav_msgs/msg/Odometry])

Odometry calculated from wheel encoders and the onboard IMU.

- `controller/steering_mode` ([raph_interfaces/msg/SteeringMode]) **Not
implemented yet**

Current steering mode. Published whenever the mode changes. \
Uses transient local durability to deliver last message to joining
subscriptions.

- `controller/diagnostics/imu` ([raph_interfaces/msg/ImuDiagnostics])

Diagnostic information about the IMU module. \
Expand All @@ -73,6 +56,10 @@ image: /img/robots/raph/raph-rover.webp

Current information about the power system.

- `imu/data` ([sensor_msgs/msg/Imu])

Filtered IMU readings including orientation.

- `oak/imu/data` ([sensor_msgs/msg/Imu])

Current gyroscope and accelerometer readings from the Oak-D IMU.
Expand Down Expand Up @@ -118,7 +105,7 @@ image: /img/robots/raph/raph-rover.webp

Raw laser scans from the onboard 2D LIDAR.

- `rplidar/scan_filtered` ([sensor_msgs/msg/LaserScan]) **Not implemented yet**
- `rplidar/scan_filtered` ([sensor_msgs/msg/LaserScan])

Laser scans from the onboard 2D LIDAR with points lying on the robot's
footprint filtered out.
Expand Down
17 changes: 16 additions & 1 deletion docs/raph-rover/documentation/specification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ image: /img/robots/raph/raph-rover.webp
toc_max_heading_level: 4
---

import styles from './styles.module.css';
import useBaseUrl from '@docusaurus/useBaseUrl';
import ThemedImageZoom from '@site/src/components/ThemedImageZoom';
import CenterContent from '@site/src/components/CenterContent';
Expand Down Expand Up @@ -211,6 +210,22 @@ as:
</TabItem>
</Tabs>

#### Wheels

As standard, Raph Rover comes with rubber tires with a diameter of about 170 mm.
Whole drive assembly has following characteristics:

<CenterContent>

| Parameter | Value |
| ---------------------------- | :----------------: |
| Tire size (diameter x width) | ~ 170 mm x ~ 80 mm |
| Tire lock type | Beadlock |
| Tire insert | Hard foam |
| Wheel rim diameter | 120 mm |

</CenterContent>

### Components

<CenterContent>
Expand Down
129 changes: 0 additions & 129 deletions docs/raph-rover/documentation/styles.module.css

This file was deleted.

10 changes: 10 additions & 0 deletions docs/raph-rover/documentation/user-manual/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"label": "User Manual",
"position": 2,
"collapsible": true,
"collapsed": false,
"link": {
"type": "doc",
"id": "user-manual"
}
}
Loading