Skip to content

Commit

Permalink
Remove dead links
Browse files Browse the repository at this point in the history
Signed-off-by: Alberto Tudela <ajtudela@gmail.com>
  • Loading branch information
ajtudela committed May 23, 2024
1 parent 216514c commit 0e7b11f
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/first_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you are familiar with the terminal or would like to learn to use it, here is
[Doc-Tutorial](https://github.com/robocomp/robocomp/blob/development/doc/contribute/contribute.md) or [Video-Tutorial](https://www.youtube.com/watch?v=rgbCcBNZcdQ&t=8s)

### Questions?
Don’t hesitate to ask questions or to get help if you feel like you are getting stuck. For example leave a comment below or ask in the [gitter channel](https://gitter.im/robocomp).
Don’t hesitate to ask questions or to get help if you feel like you are getting stuck.



Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/broken_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Run link check
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
Expand Down
31 changes: 14 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
[RoboComp](http://robocomp.org)
===============================

[![Join the chat at https://gitter.im/robocomp/robocomp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/robocomp/robocomp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Docs Links Checker](https://github.com/robocomp/robocomp/actions/workflows/broken_links.yml/badge.svg)](https://github.com/robocomp/robocomp/actions/workflows/broken_links.yml)
[![CodeQL Analysis](https://github.com/robocomp/robocomp/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/robocomp/robocomp/actions/workflows/codeql-analysis.yml)
[![Docs Links Checker](https://github.com/grupo-avispa/robocomp/actions/workflows/broken_links.yml/badge.svg)](https://github.com/grupo-avispa/robocomp/actions/workflows/broken_links.yml)
[![Docker Images](https://github.com/robocomp/robocomp/actions/workflows/publish_docker_images.yml/badge.svg)](https://github.com/robocomp/robocomp/actions/workflows/publish_docker_images.yml)
[![Component generation test](https://github.com/robocomp/robocomp/actions/workflows/components_generation.yml/badge.svg)](https://github.com/robocomp/robocomp/actions/workflows/components_generation.yml)
[![Component compilation test](https://github.com/robocomp/robocomp/actions/workflows/components_compilation.yml/badge.svg)](https://github.com/robocomp/robocomp/actions/workflows/components_compilation.yml)
Expand All @@ -23,14 +20,18 @@ interfaces in a seamless way. Building new components is done using two domain-s
:question: If you have a question please look for it in the [FAQ](doc/FAQ.md).
-

- [RoboComp](#robocomp)
- [About](#about)
- [:question: If you have a question please look for it in the FAQ.](#question-if-you-have-a-question-please-look-for-it-in-the-faq)
- [Installation from source](#installation-from-source)
* [Requirements](#requirements)
* [Installation](#installation)
- [Testing the installation using the RCIS robotics simulator](#testing-the-installation-using-the-rcis-robotics-simulator)
* [Installing some RoboLab's components from GitHub](#installing-some-robolab-s-components-from-github)
* [Connecting a JoyStick (if no JoyStick available skip to the next section)](#connecting-a-joystick)
* [Using the keyboard as a JoyStick](#using-the-keyboard-as-a-joystick)
- [Testing the installation using the Coppelia Simulator](#testing-the-installation-using-the--coppelia-simulator)
- [Prerequisites](#prerequisites)
- [Prerequisites for Robocomp Installation](#prerequisites-for-robocomp-installation)
- [Prerequisites for Compiling Robocomp Components](#prerequisites-for-compiling-robocomp-components)
- [Installation Steps](#installation-steps)
- [Installing some RoboLab's components from GitHub](#installing-some-robolabs-components-from-github)
- [Connecting a JoyStick (if no JoyStick available skip to the next section)](#connecting-a-joystick-if-no-joystick-available-skip-to-the-next-section)
- [Using the keyboard as a JoyStick](#using-the-keyboard-as-a-joystick)
- [Testing the installation using the Coppelia Simulator](#testing-the-installation-using-the-coppelia-simulator)
- [Next steps](#next-steps)
- [Known issues](#known-issues)

Expand Down Expand Up @@ -129,7 +130,7 @@ Done! Now let's have some fun.

To test RoboComp with Coppelia you need to:

- Install Coppelia Robotics and Pyrep. There are detailed instructions [here](https://github.com/robocomp/robocomp/blob/development/doc/DSR-start.md)
- Install Coppelia Robotics and Pyrep.
- Run the bridge, i.e. omniPyrep.py and see that Coppelia starts Ok.
- Connect your new component to the ports offered in omniPyrep.py or
- Connect a joystick or XBox pad to omniRep.py using [this component](https://github.com/robocomp/robocomp-robolab/tree/master/components/hardware/external_control/joystickpublish)
Expand Down Expand Up @@ -183,13 +184,9 @@ Follow the instructions in https://github.com/robocomp/robocomp/blob/development

You can find more tutorials on RoboComp in [tutorials](doc/README.md)

Drop comments and ask questions in:

- https://gitter.im/robocomp

Please, report any bugs with the github issue system: [Robocomp Issues](https://github.com/robocomp/robocomp/issues)

If you have any suggestions to improve the repository, like features or tutorials, please contact us on [![Join the chat at https://gitter.im/robocomp/robocomp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/robocomp/robocomp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or create a feature request [here](https://github.com/robocomp/robocomp/issues).
If you have any suggestions to improve the repository, like features or tutorials, please create a feature request [here](https://github.com/robocomp/robocomp/issues).


# Known issues
Expand Down
6 changes: 3 additions & 3 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

Robocomp is an Open-Source Robotics Framework, where you can simulate, model and program your own robots, in a C.O.P (Component Oriented Programming) enviroment. You can create components and share them with the community. Components communicate with each other via Ice [[1](https://doc.zeroc.com/ice/3.7/introduction)], a framework for building distributed applications. Simulation is done with RCIS, the built-in simulator.

Robocomp was presented with the publication of the paper: "Robocomp: A Tool-Based Robotics Framework" [[2](https://www.researchgate.net/publication/262179907_RoboComp_A_ToolBased_Robotics_Framework_Lecture_Notes_in_Computer_Science)]. You can see more projects from Robolab, the investigation team from Universidad de Extremadura that created and currently maintains Robocomp [here](https://robolab.unex.es) (some of the information is in Spanish).
Robocomp was presented with the publication of the paper: "Robocomp: A Tool-Based Robotics Framework". You can see more projects from Robolab, the investigation team from Universidad de Extremadura that created and currently maintains Robocomp [here](https://robolab.unex.es) (some of the information is in Spanish).

## What to do if you are new to the project and want to help?

Thank you for wanting to improve the project!

So you are informed, please first read [the Contributing Guide](../CONTRIBUTING.md), and the documentation for the project. [Here](https://robocomp.github.io/web/blog) you can see the list of projects for Google Summer of Code for some ideas on what is needed. If you need additional help, drop a message on [Google Groups](https://groups.google.com/forum/?hl=es#!forum/robocomp-dev) or [Gitter](https://gitter.im/robocomp).
So you are informed, please first read [the Contributing Guide](../CONTRIBUTING.md), and the documentation for the project. [Here](https://robocomp.github.io/web/blog) you can see the list of projects for Google Summer of Code for some ideas on what is needed. If you need additional help, drop a message on [Google Groups](https://groups.google.com/forum/?hl=es#!forum/robocomp-dev).

If you make your own project with Robocomp, we would love to hear about it. Tell us on [Gitter](https://gitter.im/robocomp).
If you make your own project with Robocomp, we would love to hear about it.

## What kind of work can you do to improve Robocomp?

Expand Down
6 changes: 1 addition & 5 deletions doc/How_To_Make_Chroot_Environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Another practical use for chroot is to test an especific program or library in a
- **type** The type of the chroot. Valid types are ‘plain’, ‘directory’, ‘file’, ‘block-device’ and ‘lvm-snapshot’. If empty or omitted, the default type is ‘plain’.
- **users** list of users that are allowed access to the chroot.

See [schroot.config](http://manpages.ubuntu.com/manpages/impish/en/man5/schroot.conf.5.html) for further information.
See schroot.config for further information.

4. Run Debootstrap. This step will download and unpack a basic ubuntu or debian system to the chroot directory we created in step 2.

Expand Down Expand Up @@ -124,8 +124,4 @@ If the problem persist check out this [page](http://perlgeek.de/en/article/set-u
[PerlGeek troubleshooting](http://perlgeek.de/en/article/set-up-a-clean-utf8-environment)
[Schroot conf manual](http://manpages.ubuntu.com/manpages/impish/en/man5/schroot.conf.5.html)
[Debootstap manual](http://manpages.ubuntu.com/manpages/impish/en/man8/debootstrap.8.html)
2 changes: 0 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@

[RoboComp's build tools ](buildTools.md)

[Starting with DSR](DSR-start.md)

[List of RoboComp Interfaces](interfaces/README.md)

[Introduction to InnerModel: RoboComp's internal representation of the world and itself](innermodel.md)
Expand Down
4 changes: 2 additions & 2 deletions doc/code-examples/apriltags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# aprilTagsComp: wrapping E. Olson's AprilTags in RoboComp

AprilTags is an augmented reality tag system developed by E. Olson at the U. of Michigan, USA. A complete explanation and related papers can be found [here](http://april.eecs.umich.edu/wiki/index.php/AprilTags). There is a C++ version written by Michael Kaes [here](http://people.csail.mit.edu/kaess/apriltags/) which is the one we use.
AprilTags is an augmented reality tag system developed by E. Olson at the U. of Michigan, USA. A complete explanation and related papers can be found. There is a C++ version written by Michael Kaes [here](http://people.csail.mit.edu/kaess/apriltags/) which is the one we use.

April tags are AR tags designed to be easily detected by (robot) cameras. Understand them as a visual fiducial (artificial features) system that uses a 2D bar code style “tag”, allowing full 6 DOF localization of features from a single image. It is designed to encode smaller data (between 4 and 12 bits) and also these tags can be detected by the camera even at odd conditions. When the tag is seen by the camera, the algorithm computes the tag's complete pose defining its own reference system relative to the camera (i.e Location of the tag is known with high accuracy). This reference system is defined as follows: If we look perpendicularly to a non rotated tag, The Z+ axis comes out towards us from the center of the tag plane, The X+ axis points leftwards and the Y+ axis points upwards (a left-hand reference system). The values computed by *apriltagsComp* are the translation vector from the camera to the center of the tag's reference system, and the three Euler angles that encode the relative orientation of the tag's reference system wrt to the camera reference system.

Expand Down Expand Up @@ -66,7 +66,7 @@ you can find an example of a configuration file. We can find there the following
ID:11-20 = 0.17 #tag size in meters //Tags numbers 11-20 real size in meters
ID:21-30 = 0.17 #tag size in meters //Tags numbers 21-30 real size in meters

AprilTagsFamily is a set of tags, There are different families like 36h10,25h9,16h5 however *tagCodes36h11* is recommended. Each tag has an ID that is printed inside the surrounding square using Hamming code. Instructions to print tags and other tag families can be found [here](http://april.eecs.umich.edu/wiki/index.php/AprilTags). The algorithm needs the real size of the tag to estimate its position and orientation in space. We can give the component tags of different sizes, As long as they correspond to different ranges of IDs, as specified in the configuration file above.
AprilTagsFamily is a set of tags, There are different families like 36h10,25h9,16h5 however *tagCodes36h11* is recommended. Each tag has an ID that is printed inside the surrounding square using Hamming code. The algorithm needs the real size of the tag to estimate its position and orientation in space. We can give the component tags of different sizes, As long as they correspond to different ranges of IDs, as specified in the configuration file above.

## Starting the component
To start the component we need a real camera connected to the cameraV4lComp component or the RCIS simulator started with a file that includes virtual tags, such as *simpleworld.xml*, Tutorial can be found [here](apritagstutorial.md). Once RCIS is up and running, It will provide the RGBD.idsl interface (not Camera.idsl for now) at port 10096, which is what the configuration file states. To avoid changing the *generic_config* file in the repository, We can copy it to the component's home directory, So changes will remain untouched by future git pulls:
Expand Down
4 changes: 2 additions & 2 deletions doc/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Components need a way to share information among them, and here is where communi

Putting together programs and a communication middleware, you can almost come up with a way to make more components. Except, one more thing is needed, a model for your components.

You need to define what is a generic component and consequently how its internal structure is going to be, its directory and building ecosystem, how it has to be documented, its default behavior, how it will be deployed and its modes of communicating. There are several proposals that do exactly this, one of them being the famous [CORBA](http://www.corba.org).
You need to define what is a generic component and consequently how its internal structure is going to be, its directory and building ecosystem, how it has to be documented, its default behavior, how it will be deployed and its modes of communicating. There are several proposals that do exactly this, one of them being the famous CORBA.

## Robocomp Components

In RoboComp (2005- ) we have created our own component model, inspired by the [ORCA](http://orca-robotics.sourceforge.net/) model and making it evolve to fit our needs along these years. As a middleware, RoboComp primarily uses [Ice](http://www.zeroc.com) and there is ongoing experimental work to make RoboComp middleware agnostic, so its components can be re-generated to use other middlewares such as [DDS](https://www.dds-foundation.org/).
In RoboComp (2005- ) we have created our own component model, inspired by the [ORCA](http://orca-robotics.sourceforge.net/) model and making it evolve to fit our needs along these years. As a middleware, RoboComp primarily uses [Ice](http://www.zeroc.com) and there is ongoing experimental work to make RoboComp middleware agnostic, so its components can be re-generated to use other middlewares such as DDS.

RoboComp's components model is quite simple and we always try to simplify it even more. It can be best explained through two Domain Specific Languages (DSLs) that have been created to define a component at a very high level of abstraction.

Expand Down
3 changes: 0 additions & 3 deletions doc/contribution_paths.md.md → doc/contribution_paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ In the components folder of this repository you can find some of the esential ag

Also in robots_pyrep you will find some of the virtualizations of robots created to be used with Coppelia SIM.

At this point, if you are still not involved in the DSR development, you would probably want to follow this tutorial:
https://github.com/robocomp/robocomp/blob/development/doc/DSR-start.md

> Written with [StackEdit](https://stackedit.io/).
<!--stackedit_data:
eyJoaXN0b3J5IjpbLTIxODE2MzExMCwtMTQxNDQ1NTUxOF19
Expand Down
2 changes: 1 addition & 1 deletion doc/robocomp-pyrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In this tutorial, we walk you through the setup procedure of __CoppeliaSim__ and

## CoppeliaSim Installation

- First, download __CoppeliaSim__ EDU version (compatible with your system) from [download page](https://www.coppeliarobotics.com/downloads.html).
- First, download __CoppeliaSim__ EDU version (compatible with your system) from download page.

- Extract it into your prefered directory.

Expand Down
3 changes: 0 additions & 3 deletions docker/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
In Robocomp we have created several docker files that can be used to build different images with Ubuntu versions of Robocomp.
In the subdirectories of this folder, you can find files to create Robocomp images with or without FCL on Ubuntu Bionic or Focal.
> Note: you can also find a version of Robocomp with AGM [here](https://github.com/ljmanso/AGM/tree/current/docker/bionic).

To create the Docker images, you can enter the corresponding subdirectory and run
```docker
Expand Down Expand Up @@ -38,8 +37,6 @@ We have also developed a tool on top of docker that you could be interested in:

### Other Dockerfiles related with Robocomp
These other Dockerfiles, dockercompose files, and related images in the docker hub could be of your interest if you are working with these projects.
#### AGM
https://github.com/ljmanso/AGM/tree/current/docker/bionic

#### DSR
https://github.com/robocomp/dsr-graph/tree/development/docker/focal
Expand Down

0 comments on commit 0e7b11f

Please sign in to comment.