Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor docs for the ROS Equipment entry #5

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

miloszlagan
Copy link
Contributor

  • Added ROS_API.md containing text from old README.md
  • Changed README.md to serve as a demo / usage guide

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ROS_API.md Outdated Show resolved Hide resolved
miloszlagan and others added 2 commits January 10, 2025 13:00
Co-authored-by: Jakub Delicat <109142865+delihus@users.noreply.github.com>
@miloszlagan miloszlagan requested a review from delihus January 14, 2025 14:08
README.md Outdated Show resolved Hide resolved

Get a reference file from for Panther:

```bash
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is overkill. Let's add the volume to the /config/crsf_teleop_panther.yaml and describe how to change it to lynx. So:

If you use Lynx change in compose.yaml /config/crsf_teleop_panther.yaml to /config/crsf_teleop_lynx.yaml it is much easier than coping the files.

@@ -10,7 +10,8 @@ services:
- RMW_IMPLEMENTATION=${RMW_IMPLEMENTATION:-rmw_cyclonedds_cpp}
- ROS_DOMAIN_ID=${ROS_DOMAIN_ID:-0}
- ROBOT_MODEL_NAME=${ROBOT_MODEL_NAME:-panther}
- ROBOT_NAMESPACE=${ROBOT_NAMESPACE:-panther}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a volume for configuration directly and create the compose.yaml for panther.
Use params_file launch argument

ROS_API.md Outdated Show resolved Hide resolved
ROS_API.md Outdated Show resolved Hide resolved
ROS_API.md Outdated Show resolved Hide resolved
/**:
crsf_teleop:
ros__parameters:
port: /dev/ttyUSB0
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
port: /dev/ttyUSB0
port: /dev/ttyUSBPAD

and let's change this file to default_params.yaml

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have commited this file by mistake, deleting it

miloszlagan and others added 2 commits January 24, 2025 14:30
Co-authored-by: Jakub Delicat <109142865+delihus@users.noreply.github.com>
Co-authored-by: Jakub Delicat <109142865+delihus@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants