Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
antbono committed Apr 11, 2024
1 parent 2f57ba7 commit d0edd51
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 11 deletions.
11 changes: 9 additions & 2 deletions .github/workflows/build_and_test_humble.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
container:
image: ubuntu:jammy

Expand All @@ -32,4 +32,11 @@ jobs:
use-ros2-testing: true
- uses: ros-tooling/action-ros-ci@v0.3
with:
target-ros2-distro: humble
target-ros2-distro: humble
colcon-defaults: |
{
"build": {
"symlink-install": false
}
}
vcs-repo-file-url: dependencies.repos
9 changes: 8 additions & 1 deletion .github/workflows/build_and_test_iron.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
container:
image: ubuntu:jammy

Expand All @@ -33,3 +33,10 @@ jobs:
- uses: ros-tooling/action-ros-ci@v0.3
with:
target-ros2-distro: iron
colcon-defaults: |
{
"build": {
"symlink-install": false
}
}
vcs-repo-file-url: dependencies.repos
18 changes: 13 additions & 5 deletions .github/workflows/build_and_test_rolling.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,23 @@ jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
container:
image: ubuntu:jammy
image: ubuntu:noble

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/checkout@v4
- uses: ros-tooling/setup-ros@v0.7
- uses: ros-tooling/action-ros-ci@v0.3
- uses: ros-tooling/setup-ros@master
with:
use-ros2-testing: true
- uses: ros-tooling/action-ros-ci@master
with:
target-ros2-distro: rolling
skip-tests: true
colcon-defaults: |
{
"build": {
"symlink-install": false
}
}
vcs-repo-file-url: dependencies.repos
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
[![Build and Test (humble)](../../actions/workflows/build_and_test_humble.yaml/badge.svg?branch=iron)](../../actions/workflows/build_and_test_humble.yaml?query=branch:iron)
[![Build and Test (iron)](../../actions/workflows/build_and_test_iron.yaml/badge.svg?branch=iron)](../../actions/workflows/build_and_test_iron.yaml?query=branch:iron)
[![Build and Test (rolling)](../../actions/workflows/build_and_test_rolling.yaml/badge.svg?branch=rolling)](../../actions/workflows/build_and_test_rolling.yaml?query=branch:rolling)
[![Build (humble)](https://github.com/antbono/hni/actions/workflows/build_and_test_humble.yaml/badge.svg)](https://github.com/antbono/hni/actions/workflows/build_and_test_humble.yaml)
[![Build (iron)](https://github.com/antbono/hni/actions/workflows/build_and_test_iron.yaml/badge.svg)](https://github.com/antbono/hni/actions/workflows/build_and_test_iron.yaml)
[![Build (rolling)](https://github.com/antbono/hni/actions/workflows/build_and_test_rolling.yaml/badge.svg)](https://github.com/antbono/hni/actions/workflows/build_and_test_rolling.yaml)

# Human NAO Interaction (HNI)

This package is part of the [Open Access NAO](https://github.com/antbono/OAN) framework.

It provides the user with some very useful capabilities for HRI experimentation.


## Main features

At the moment, you can exploit ithe package for the following activities:

- *Teach by demonstration*: The `joints_record` node allows to record the movements of the joints you are interested in. In this way,
you need only move the limbs of interest in the desired manner and the robot will learn the movement. The smooth reproduction of the movement is then handled by the `joints_play_action_server` node.

- *Face/object detection and tracking*: Thanks to the Yolov8 model, the robot can detect faces and objects in a real time video stream. This info is then exploited to move the head in order to mantain eye contact with the face/object.

- *Speech recognition and synthesis*: Using the APIs offered by the Google Cloud Platform, we implemented Speech-To-Text and Text-To-Speech Services.

- *Conversational ability*: We leverage on the ChatGPT model to implement NLP on the NAO. It is possible, indeed, to modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation.


For more info, please refer to the related [paper](https://arxiv.org/abs/2403.13960).


### Note on CI

The failing status is due to the colcon `--symlink-install` option that [action-ros-ci](https://github.com/ros-tooling/action-ros-ci) uses. At the moment the symlinking cannot be disabled but we are actively working with action-ros-ci maintainers (see issue [815](https://github.com/ros-tooling/action-ros-ci/issues/815)).
13 changes: 13 additions & 0 deletions dependencies.repos
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
repositories:
nao_led:
type: git
url: https://github.com/antbono/nao_led.git
version: main
nao_lola:
type: git
url: https://github.com/ros-sports/nao_lola.git
version: rolling
nao_pos:
type: git
url: https://github.com/antbono/nao_pos.git
version: main

0 comments on commit d0edd51

Please sign in to comment.