Skip to content

Commit

Permalink
SDk in good order
Browse files Browse the repository at this point in the history
  • Loading branch information
glannuzel committed Apr 8, 2024
1 parent c99a569 commit fd76d26
Show file tree
Hide file tree
Showing 30 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/docs/advanced/access-computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:43:24+02:00
draft: false
images: []
toc: true
weight: "90"
---
There are several ways to connect to your robot.

Expand Down
1 change: 1 addition & 0 deletions content/docs/advanced/calibrate-cameras.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:43:31+02:00
draft: false
images: []
toc: true
weight: "100"
---
## 0. Dependencies

Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:43:48+02:00
draft: false
images: []
toc: true
weight: "40"
---
The dashboard is here to give you an overview of the robot's state (what services are running, is there an error on a motor,...) and give you the possibility to access quickly some features (changing a robot's part compliance for example).

Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:44:11+02:00
draft: false
images: []
toc: true
weight: "50"
---
## 1. Check services are running

Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:44:05+02:00
draft: false
images: []
toc: true
weight: "30"
---
> On the **first connection, connect Reachy 2 to your network using an ethernet cable**. You will then be able to choose another network using the dashboard.
Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/turn-off.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:44:11+02:00
draft: false
images: []
toc: true
weight: "60"
---
## Power off your robot

Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/turn-on.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:44:11+02:00
draft: false
images: []
toc: true
weight: "20"
---
<!-- ## On first start
To facilitate the next step ([Connect your robot to the network]({{< ref "/docs/getting-started/network" >}})), plug the LCD screen on the last free USB port of the hub. This must be done before turning on the robot. -->
Expand Down
1 change: 1 addition & 0 deletions content/docs/getting-started/unpack.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:43:24+02:00
draft: false
images: []
toc: true
weight: "10"
---

## Your robot is nearly already assembled!
Expand Down
1 change: 1 addition & 0 deletions content/docs/simulation/simulation-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-08-09T14:45:14+02:00
draft: false
images: []
toc: true
weight: "70"
---
If you want to try movements on the robot without using the real robot, you can install a simulated Reachy 2 on your computer, and run it the same way the real robot is run.

Expand Down
1 change: 1 addition & 0 deletions content/docs/update/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ lastmod: 2023-07-25T15:15:22+02:00
draft: false
images: []
toc: true
weight: "80"
---

## Use the dashboard
Expand Down
1 change: 1 addition & 0 deletions content/sdk/appendix/APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "190"
---

The full APIs generated by [Sphinx](https://www.sphinx-doc.org/) is available at [https://pollen-robotics.github.io/reachy-sdk/](https://pollen-robotics.github.io/reachy-sdk/).
1 change: 1 addition & 0 deletions content/sdk/appendix/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "200"
---

## Discord
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/arm.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "90"
---
> Note : Make sure you checked the [safety page]({{< ref "sdk/getting-started/safety" >}}) before controlling the arm.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/cameras.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
type: docs
images: []
toc: true
weight: "120"
---
This section assumes that you went through the [Hello World]({{< ref "sdk/getting-started/hello-world" >}}) so that you know how to connect to the robot.

Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/head.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
type: docs
images: []
toc: true
weight: "110"
---

## Head presentation
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "70"
---

## Enable teleop cameras for the SDK
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/kinematics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
type: docs
images: []
toc: true
weight: "100"
---

> Note : Make sure you checked the [safety page]({{< ref "sdk/getting-started/safety" >}}) before controlling the arm.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/moves.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
type: docs
images: []
toc: true
weight: "80"
---

## Moves methods
Expand Down
1 change: 1 addition & 0 deletions content/sdk/first-moves/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
type: docs
images: []
toc: true
weight: "130"
---

You can easily record joint trajectories directly on Reachy, store and replay them later. This page will show you how to implement such mechanisms.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/getting-started/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "30"
---

The last required step before being able to use your Reachy 2 is to find its IP address.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/getting-started/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "40"
---

## Enable cameras for the SDK
Expand Down
1 change: 1 addition & 0 deletions content/sdk/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "20"
---

## How to install the Python SDK
Expand Down
1 change: 1 addition & 0 deletions content/sdk/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "50"
---

## Understand the SDK structure
Expand Down
1 change: 1 addition & 0 deletions content/sdk/getting-started/safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: false
images: []
type: docs
toc: true
weight: "60"
---

Especially, the screws in the Reachy's back and the ones fixatings its metal support should be well tightened.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/introduction/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "10"
---

## The SDK in a nutshell
Expand Down
1 change: 1 addition & 0 deletions content/sdk/mobile-base/drive-control-modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "160"
---
## Drive modes
### Overview
Expand Down
1 change: 1 addition & 0 deletions content/sdk/mobile-base/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "140"
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions content/sdk/mobile-base/mobile-base-alone.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "180"
---

There is no need to instanciate the entire Reachy stack to interact with the mobile base.
Expand Down
1 change: 1 addition & 0 deletions content/sdk/mobile-base/moving-the-base.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "150"
---

## Frame conventions
Expand Down
1 change: 1 addition & 0 deletions content/sdk/mobile-base/safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ draft: false
images: []
type: docs
toc: true
weight: "170"
---
## Overview
The basic idea is that the LIDAR is used to detect surrounding obstacles and reduce or nullify speed commands that would create a collision with the mobile base.
Expand Down

0 comments on commit fd76d26

Please sign in to comment.