Skip to content

Commit

Permalink
remove user / workspace setup
Browse files Browse the repository at this point in the history
  • Loading branch information
dave992 committed Nov 22, 2024
1 parent 83203d2 commit b14d8e3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 92 deletions.
23 changes: 0 additions & 23 deletions .devcontainer/scancontrol/devcontainer.json

This file was deleted.

43 changes: 0 additions & 43 deletions .docker/docker-compose.yml

This file was deleted.

38 changes: 12 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,29 @@ Maintainers:
## Installation

#### Dependencies
It is assumed the following dependencies are installed on your systems already.
- [Aravis 0.8.x](https://github.com/AravisProject/aravis/releases) [[docs]](https://aravisproject.github.io/aravis/)
- [scanCONTROL Linux C++ SDK 1.0.x](https://www.micro-epsilon.com/2D_3D/laser-scanner/Software/downloads/)

Alternatively, a `Dockerfile` is provided to build a ROS image with the dependencies installed.

#### Building
To build from source, clone the latest version from this repository into your workspace and compile the package:
To build from source, clone the latest version from this repository into your workspace:

```bash
mkdir -p ros2_ws/src && cd ros2_ws
git clone git@github.com:sam-xl/scancontrol.git -b ros2-devel src
cd ros_ws
git clone https://github.com/sam-xl/scancontrol.git
```
To build locally, after installing Aravis and the SDK:

Install the dependencies of the cloned packages using `rosdep`:
```bash
sudo apt-get update
rosdep update
rosdep install --from-paths src --ignore-src -y
colcon build --merge-install --symlink-install --cmake-args "-DCMAKE_BUILD_TYPE=RelWithDebInfo" "-DCMAKE_EXPORT_COMPILE_COMMANDS=On" -Wall -Wextra -Wpedantic
```
And source the installation

Finally, build all packages in the workspace:
```bash
. install/setup.bash
colcon build
```
## Development setup
For anyone having access to scanCONTROL hardware and not wanting to install dependencies locally, follow the setup below to work with docker compose or in a devcontainer environment.

#### Docker compose:
- `cd src/scancontrol/.docker`
- `docker compose up -d --build`
- If using VSCode, you can attach a shell or VSCode and work from there.
- Or you can use other dev IDEs? **TODO**:
- Add [watch](https://docs.docker.com/compose/file-watch/) sections to one or more services in compose.yaml
- Run docker compose watch to build and launch a Compose project and start the file watch mode.
- Edit service source files using your preferred IDE or editor
#### devcontainer:
- Link the `.devcontainer` folder
- cd to your `ros2_ws`
- `cp src/scancontrol/.devcontainer/ .`
- Hit `F1` in VSCode and select `build and reaopen in container`

## Nodes
### scancontrol_description_node
Expand Down Expand Up @@ -176,4 +162,4 @@ Please report bugs and request features using the [Issue Tracker](https://github
[micro_epsilon_scancontrol_msgs/GetResolution]: https://github.com/sam-xl/scancontrol/blob/master/micro_epsilon_scancontrol_msgs/srv/GetResolution.srv
[micro_epsilon_scancontrol_msgs/SetFeature]: https://github.com/sam-xl/scancontrol/blob/master/micro_epsilon_scancontrol_msgs/srv/SetFeature.srv
[micro_epsilon_scancontrol_msgs/SetResolution]: https://github.com/sam-xl/scancontrol/blob/master/micro_epsilon_scancontrol_msgs/srv/SetResolution.srv
[std_srvs/SetBool]: http://docs.ros.org/api/std_srvs/html/srv/SetBool.html
[std_srvs/SetBool]: http://docs.ros.org/api/std_srvs/html/srv/SetBool.html

0 comments on commit b14d8e3

Please sign in to comment.