Skip to main content
Version: 4.1.0

REST API

What is a REST API

From https://www.redhat.com/en/topics/api/what-is-a-rest-api

A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding.

Purpose

You may want to use this API to query the state of the system (robot, driver…), supported hardware (robots, controllers, …).

Available resources

This is a non-exhaustive list of the resources we provide over this API:

  • Robots: query the list of available robots in this version of Fuzzy RTOS.
  • Controllers: query the list of available controllers in this version of Fuzzy RTOS.
  • MQTT: {start/stop/query the state of} a connection between Fuzzy RTOS and its MQTT broker. Optionally connect to another broker via the bridging feature of MQTT.
  • Drivers: {start/stop/query the state of} real-time robot control drivers.
  • Version: get the current version of Fuzzy RTOS.
  • License: {activate/query the state of} the Fuzzy RTOS license.

User-friendly interface

We provide a webpage with the full list of services and pre-filled queries over at:

http://fuzzy-rtos-address:8000/swagger/ui