Fuzzy RTOS API

• Robots
  • getGet all robots
  • getGet all robot brands
  • getGet robots by brand
  • getGet robot by id
• Controllers
  • getGet all controllers
  • getGet all controller brands
  • getGet controllers by brand
  • getGet controller by id
  • postAdd or replace a user-defined controller
  • postDelete a user-defined controller
• MQTT
  • postStart MQTT connection
  • getMQTT connection state
  • postStop MQTT connection
• Drivers
  • getGet real driver status
  • getGet sim driver status
  • postStart drivers
  • getState drivers
  • postStop drivers
• Version
  • getGet the runtime version
• Date
  • postSet the runtime date
  • getGet the runtime date
• Tunables
  • getGet all available tunables
  • postGet the value of requested tunables
  • postSet the value of requested tunables
• License
  • getGet license status
  • getGet license name
  • getLicense key
  • postActivate license online
  • postRelease license
  • postGenerate an offline activation request
  • postActivate license offline
  • postOffline license release

API docs by Redocly

Fuzzy RTOS (1.0)

Download OpenAPI specification:Download

URL: https://flr.io/ License: Apache License, Version 2.0

Interface to FuzzyLogic's RTOS runtime

Robots

Get all robots

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/robots

Fuzzy RTOS

http://localhost:8000/robots

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": 4294967295,
    • "brand": "string",
    • "model": "string",
    • "path": "string"

    }

  ]

}

Get all robot brands

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/robots/brands

Fuzzy RTOS

http://localhost:8000/robots/brands

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • "string"

  ]

}

Get robots by brand

path Parameters

brand required

string

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/robots/by-brand/{brand}

Fuzzy RTOS

http://localhost:8000/robots/by-brand/{brand}

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": 4294967295,
    • "brand": "string",
    • "model": "string",
    • "path": "string"

    }

  ]

}

Get robot by id

path Parameters

id required

integer [ 0 .. 4294967295 ]

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/robots/by-id/{id}

Fuzzy RTOS

http://localhost:8000/robots/by-id/{id}

Response samples

• 200
• 500

Content type

application/json

{

• "id": 4294967295,
• "brand": "string",
• "model": "string",
• "path": "string"

}

Controllers

Get all controllers

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers

Fuzzy RTOS

http://localhost:8000/controllers

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": 4294967295,
    • "brand": "string",
    • "model": "string",
    • "custom_name": "string",
    • "path": "string",
    • "config": "string"

    }

  ]

}

Get all controller brands

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers/brands

Fuzzy RTOS

http://localhost:8000/controllers/brands

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • "string"

  ]

}

Get controllers by brand

path Parameters

brand required

string

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers/by-brand/{brand}

Fuzzy RTOS

http://localhost:8000/controllers/by-brand/{brand}

Response samples

• 200
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": 4294967295,
    • "brand": "string",
    • "model": "string",
    • "custom_name": "string",
    • "path": "string",
    • "config": "string"

    }

  ]

}

Get controller by id

path Parameters

id required

integer [ 0 .. 4294967295 ]

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers/by-id/{id}

Fuzzy RTOS

http://localhost:8000/controllers/by-id/{id}

Response samples

• 200
• 500

Content type

application/json

{

• "id": 4294967295,
• "brand": "string",
• "model": "string",
• "custom_name": "string",
• "path": "string",
• "config": "string"

}

Add or replace a user-defined controller

Request Body schema: application/json

required

id	integer [ 0 .. 4294967295 ]
brand	string
model	string
custom_name	string
path	string
config	string

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers/add

Fuzzy RTOS

http://localhost:8000/controllers/add

Request samples

• Payload

Content type

application/json

{

• "id": 4294967295,
• "brand": "string",
• "model": "string",
• "custom_name": "string",
• "path": "string",
• "config": "string"

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

Delete a user-defined controller

Request Body schema: application/json

required

id	integer [ 0 .. 4294967295 ]

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/controllers/delete

Fuzzy RTOS

http://localhost:8000/controllers/delete

Request samples

• Payload

Content type

application/json

{

• "id": 4294967295

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

MQTT

Start MQTT connection

Request Body schema: application/json

required

ca_cert	string Default: ""
hostname	string Default: "localhost"
port	integer [ 0 .. 4294967295 ] Default: 1885
bridge_hostname	string Default: ""
bridge_port	integer [ 0 .. 4294967295 ] Default: 8883

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/mqtt/start

Fuzzy RTOS

http://localhost:8000/mqtt/start

Request samples

• Payload

Content type

application/json

{

• "ca_cert": "",
• "hostname": "localhost",
• "port": 1885,
• "bridge_hostname": "",
• "bridge_port": 8883

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

MQTT connection state

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/mqtt/state

Fuzzy RTOS

http://localhost:8000/mqtt/state

Response samples

• 200
• 500

Content type

application/json

{

• "bridge_hostname": "string",
• "bridge_port": 4294967295

}

Stop MQTT connection

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/mqtt/stop

Fuzzy RTOS

http://localhost:8000/mqtt/stop

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

Drivers

Get real driver status

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/driver/real

Fuzzy RTOS

http://localhost:8000/driver/real

Response samples

• 200

Content type

application/json

{

• "robot": {

  • "id": 4294967295,
  • "brand": "string",
  • "model": "string",
  • "path": "string"

  },
• "controller": {

  • "id": 4294967295,
  • "brand": "string",
  • "model": "string",
  • "custom_name": "string",
  • "path": "string",
  • "config": "string"

  },
• "control_mode": "string",
• "joint_positions": [

  • 0.1

  ]

}

Get sim driver status

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/driver/sim

Fuzzy RTOS

http://localhost:8000/driver/sim

Response samples

• 200

Content type

application/json

{

• "robot": {

  • "id": 4294967295,
  • "brand": "string",
  • "model": "string",
  • "path": "string"

  },
• "controller": {

  • "id": 4294967295,
  • "brand": "string",
  • "model": "string",
  • "custom_name": "string",
  • "path": "string",
  • "config": "string"

  },
• "control_mode": "string",
• "joint_positions": [

  • 0.1

  ]

}

Start drivers

Request Body schema: application/json

required

controller_id	integer [ 0 .. 4294967295 ]
robot_id	integer [ 0 .. 4294967295 ]
dummy_driver	boolean

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/driver/start

Fuzzy RTOS

http://localhost:8000/driver/start

Request samples

• Payload

Content type

application/json

{

• "controller_id": 4294967295,
• "robot_id": 4294967295,
• "dummy_driver": true

}

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

State drivers

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/driver/state

Fuzzy RTOS

http://localhost:8000/driver/state

Response samples

• 200
• 500

Content type

application/json

{

• "controller_id": 4294967295,
• "robot_id": 4294967295,
• "dummy_driver": true

}

Stop drivers

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/driver/stop

Fuzzy RTOS

http://localhost:8000/driver/stop

Response samples

• 200
• 500

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

Version

Get the runtime version

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/version

Fuzzy RTOS

http://localhost:8000/version

Response samples

• 200

Content type

application/json

"string"

Date

Set the runtime date

Request Body schema: application/json

required

string

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/date/set

Fuzzy RTOS

http://localhost:8000/date/set

Request samples

• Payload

Content type

application/json

"string"

Response samples

• 200
• 400

Content type

application/json

"string"

Get the runtime date

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/date/get

Fuzzy RTOS

http://localhost:8000/date/get

Response samples

• 200

Content type

application/json

"string"

Tunables

Get all available tunables

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/tunables

Fuzzy RTOS

http://localhost:8000/tunables

Response samples

• 200

Content type

application/json

{

• "items": [

  • {

    • "name": "string",
    • "perm": "string"

    }

  ]

}

Get the value of requested tunables

Request Body schema: application/json

required

items

Array of strings

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/tunables/read

Fuzzy RTOS

http://localhost:8000/tunables/read

Request samples

• Payload

Content type

application/json

{

• "items": [

  • "string"

  ]

}

Response samples

• 200

Content type

application/json

{

• "items": [

  • {

    • "name": "string",
    • "value": "string"

    }

  ]

}

Set the value of requested tunables

Request Body schema: application/json

required

	Array of objects (TunableValueDto)
Array name string value string

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/tunables/write

Fuzzy RTOS

http://localhost:8000/tunables/write

Request samples

• Payload

Content type

application/json

{

• "items": [

  • {

    • "name": "string",
    • "value": "string"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "status": "string",
• "code": -2147483648,
• "message": "string"

}

License

Get license status

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/validity

Fuzzy RTOS

http://localhost:8000/license/validity

Response samples

• 200

Content type

application/json

{

• "is_valid": true

}

Get license name

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/name

Fuzzy RTOS

http://localhost:8000/license/name

License key

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/key

Fuzzy RTOS

http://localhost:8000/license/key

Response samples

• 200

Content type

application/json

{

• "key": "string"

}

Activate license online

Request Body schema: application/json

required

key	string License key value

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/online/activate

Fuzzy RTOS

http://localhost:8000/license/online/activate

Request samples

• Payload

Content type

application/json

{

• "key": "string"

}

Release license

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/online/release

Fuzzy RTOS

http://localhost:8000/license/online/release

Generate an offline activation request

Request Body schema: application/json

required

key	string License key value

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/offline/request-activation

Fuzzy RTOS

http://localhost:8000/license/offline/request-activation

Request samples

• Payload

Content type

application/json

{

• "key": "string"

}

Response samples

• 200

Content type

application/json

{

• "key": "string",
• "request": "string"

}

Activate license offline

Request Body schema: application/json

required

key	string License key
request	string Activation request

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/offline/activate

Fuzzy RTOS

http://localhost:8000/license/offline/activate

Request samples

• Payload

Content type

application/json

{

• "key": "string",
• "request": "string"

}

Response samples

• 200

Content type

application/json

{

• "is_valid": true

}

Offline license release

Responses

Fuzzy RTOS

http://DESKTOP-1ESBJ3A.local:8000/license/offline/request-deactivation

Fuzzy RTOS

http://localhost:8000/license/offline/request-deactivation

Response samples

• 200

Content type

application/json

{

• "key": "string",
• "request": "string"

}