Skip to content

Commit 4a1510a

Browse files
committed
docs: added libfranka version documentation
1 parent c5bcf27 commit 4a1510a

7 files changed

Lines changed: 37 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -122,18 +122,21 @@ if __name__ == "__main__":
122122
> **Note:** This and other examples can be found in the [`examples/`]() folder.
123123
124124
## 🛠️ Installation
125+
* *For Python >3.11: The `rcs_realsense` extension won't work due to the `pyrealsense2` version RCS utilizes.*
126+
* *For Python >3.12: The `ompl` python module is currently not available on PyPI. If OMPL is not used, it is safe to remove this dependency in `pyproject.toml`.*
127+
### Via PyPI/pip
128+
129+
```shell
130+
pip install rcs-core
131+
```
125132

126133
### From Source
127134

128135
Make sure that common build tools (i.e., `build-essential`) and a C++ compiler like `gcc` or `clang` are installed on your system/conda/docker.
129136

130137
*RCS works best in Python 3.11, and all extensions have been tested to work in 3.11.*
131138

132-
* *For Python >3.11: The `rcs_realsense` extension won't work due to the `pyrealsense2` version RCS utilizes.*
133-
* *For Python >3.12: The `ompl` python module is currently not available on PyPI. If OMPL is not used, it is safe to remove this dependency in `pyproject.toml`.*
134-
135139
```shell
136-
137140
# clone repository
138141
git clone https://github.com/RobotControlStack/robot-control-stack.git
139142
cd robot-control-stack
@@ -151,11 +154,6 @@ pip install --group build_deps
151154
pip install -ve . --no-build-isolation
152155
```
153156

154-
### Via PyPI/pip
155-
156-
```shell
157-
pip install rcs-core
158-
```
159157

160158
### RCS Asset Cache
161159

@@ -198,6 +196,7 @@ For full documentation, including advanced installation, modular usage, and API
198196
Useful quick-reference pages:
199197
- **[RCS Conventions](https://robotcontrolstack.org/user_guide/conventions)** for quaternion order, frames, Euler angles, and gripper semantics
200198
- **[Sim Scene Configuration](https://robotcontrolstack.org/user_guide/scene_configuration)** for `SimEnvCreatorConfig`, scene frames, and example setup patterns
199+
- **[libfranka Version Info](https://robotcontrolstack.org/extensions/libfranka_versions)** for the currently pinned `rcs_fr3` and `rcs_panda` `libfranka` versions and local-install guidance
201200

202201
## 🤝 Contribution
203202

‎docs/extensions/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
:maxdepth: 2
55
66
overview
7+
libfranka_versions
78
rcs_fr3
89
rcs_panda
910
rcs_xarm7
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# libfranka Versions
2+
3+
This page documents the `libfranka` version currently pinned by the RCS Franka extensions in their CMake configuration.
4+
5+
## `rcs_fr3`
6+
7+
- Current `libfranka` version: `0.20.3`
8+
- CMake source: [extensions/rcs_fr3/CMakeLists.txt](https://github.com/RobotControlStack/robot-control-stack/blob/main/extensions/rcs_fr3/CMakeLists.txt)
9+
- Note: this information reflects the current CMake pin and may become outdated if the version is bumped in a future change.
10+
11+
When installing `rcs-fr3` from PyPI, this `libfranka` version is fixed by the published package. If you need to change the `libfranka` version, use a local source install and update the CMake configuration there.
12+
13+
## `rcs_panda`
14+
15+
- Current `libfranka` version: `0.9.2`
16+
- CMake source: [extensions/rcs_panda/CMakeLists.txt](https://github.com/RobotControlStack/robot-control-stack/blob/main/extensions/rcs_panda/CMakeLists.txt)
17+
18+
When installing `rcs-panda` from PyPI, this `libfranka` version is fixed by the published package. If you need to change the `libfranka` version, use a local source install and update the CMake configuration there.

‎extensions/rcs_fr3/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ pip install -ve . --no-build-isolation
3434
pip install -ve extensions/rcs_fr3 --no-build-isolation
3535
```
3636

37+
For `libfranka` version details, see <https://robotcontrolstack.org/extensions/libfranka_versions>.
38+
3739
Add your FR3 Desk credentials to a `.env` file:
3840

3941
```env

‎extensions/rcs_fr3/pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ build-dir = "build"
3232
wheel.packages = ["src/rcs_fr3"]
3333
install.components = ["python_package"]
3434

35+
[tool.cibuildwheel]
36+
skip = ["cp314*", "*-musllinux*"]
37+
3538
[tool.black]
3639
line-length = 120
3740
target-version = ["py310"]

‎extensions/rcs_panda/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ pip install -ve . --no-build-isolation
3434
pip install -ve extensions/rcs_panda --no-build-isolation
3535
```
3636

37+
For `libfranka` version details, see <https://robotcontrolstack.org/extensions/libfranka_versions>.
38+
3739
Add your Panda Desk credentials to a `.env` file:
3840

3941
```env

‎extensions/rcs_panda/pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ build-dir = "build"
3131
wheel.packages = ["src/rcs_panda"]
3232
install.components = ["python_package"]
3333

34+
[tool.cibuildwheel]
35+
skip = ["cp314*", "*-musllinux*"]
36+
3437
[tool.black]
3538
line-length = 120
3639
target-version = ["py310"]

0 commit comments

Comments
 (0)