Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
btalb committed Apr 15, 2021
2 parents d94fc78 + 963c30c commit cc95cae
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

# BenchBot Supervisor

[![BenchBot project](https://img.shields.io/badge/collection-BenchBot-%231a2857)](http://benchbot.org)
[![QUT Centre for Robotics Open Source](https://github.com/qcr/qcr.github.io/raw/master/misc/badge.svg)](https://qcr.github.io)
![Primary language](https://img.shields.io/github/languages/top/qcr/benchbot_supervisor)
[![License](https://img.shields.io/github/license/qcr/benchbot_supervisor)](./LICENSE.txt)

<p align="center"><img alt="benchbot_supervisor" src="./docs/benchbot_supervisor.jpg" width="60%"/></p>

The BenchBot Supervisor is a HTTP server facilitating communication between user-facing interfaces like the [BenchBot API](https://github.com/qcr/benchbot_api), and the low-level robot components like [BenchBot Simulator](https://github.com/qcr/benchbot_simulator) or real robots. Communication is typically routed through a [BenchBot Robot Controller](https://github.com/qcr/benchbot_robot_controller), which provides automated process management for low-level components and wraps all ROS communications.
Expand Down Expand Up @@ -65,4 +70,4 @@ The supervisor includes a RESTful HTTP API for all interaction with a user-facin
| `/results_functions/` | `list` | Returns a list of the results function names that can be remotely executed via the route below. |
| `/results_functions/<function>` | `dict` | Calls results function with name `'function'`, and returns the result of the function call in the response's JSON body. |
| `/robot/` | <pre>Hello, I am the BenchBot robot controller</pre> | Arbitrary response confirming a robot controller is available. |
| `/robot/<command>` | `dict` | Passes the command `command` down to a running robot controller manager. See [BenchBot Robot Controller](https://github.com/qcr/benchbot_robot_controller) for documentation of supported commands & expected responses. |
| `/robot/<command>` | `dict` | Passes the command `command` down to a running robot controller manager. See [BenchBot Robot Controller](https://github.com/qcr/benchbot_robot_controller) for documentation of supported commands & expected responses. |
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='benchbot_supervisor',
version='2.1.1',
version='2.1.2',
author='Ben Talbot',
author_email='[email protected]',
description='The BenchBot Supervisor, used in the BenchBot Software Stack',
Expand Down

0 comments on commit cc95cae

Please sign in to comment.