bot.robot.control

Generated at from openvibe-contracts v0.97.0 and openvibe-sdk v0.26.0.

Not grantable to apps (active, first-party).

Physically control a robot with a Network service token. POST /robots/:id/estop latches the e-stop for any robot id and needs bot.robot.read as well; Bot records the service as the actor and does not check X-OV-Subject. On the operator WebSocket (/control) a token with this capability must name a person in X-OV-Subject, and Bot applies that person's role (owner, operator or queue), allowlist and limits. Clearing the e-stop is bot.robot.manage. The operator WebSocket frames are bot.command@1, answered by bot.command-result@1; a refused command is audited and emits bot.command.refused.

Owner
bot (token audience openvibe.bot)
Version
1.0
Status
active
Visibility
first-party
Resource constraints
none
Quota class
bot-control
Permissions
bot:robot:control
Input
common.no-body@1
Output
bot.robot-control-result@1
Events
bot.estop.set, bot.estop.cleared, bot.command.refused
Implemented by
  • POST /api/v1/robots/:id/estop
  • WS /control {type:"command"} (bot.command@1, answered by a command_result frame, bot.command-result@1)
  • WS /control {type:"estop"} (an owner or operator)
  • WS /control {type:"estop_clear"} (the owner only)

These routes in the API explorer