BotEstopClearedPayload bot.estop.cleared@1
Generated at from
openvibe-contracts v0.97.0 and
openvibe-sdk v0.26.0.
- Version
- 1.0.0
- Owner
- bot
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Decision
- ADR-043
- Schema
https://openvibe.network/contracts/events/payloads/bot.estop.cleared.v1.json
bot.estop.cleared v1 (OpenVibe.Bot server/domain/index.js writeEstop via clearEstop). The owner cleared the latched e-stop (only the owner can); principal_kind is user, and Bot sends by as null. Envelope: subject { type: robot, id: <robot id> }, visibility internal, priority important, actor service:bot.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
robot_id | string | yes |
| |
by | string | null | yes | ||
principal_kind | enum | yes |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: owner
{
"robot_id": "rob_01J8Z4M2Q0R7T9YV3K6N8P1W2X",
"by": null,
"principal_kind": "user"
}Rejected: no-principal
{
"robot_id": "rob_01J8Z4M2Q0R7T9YV3K6N8P1W2X",
"by": null
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('bot.estop.cleared@1', value); // { valid, errors: [{ path, message }] }