robotic

Documentation

Overview

Package robotic is the resource module for the Robotic control cloud — register robots, send commands, push telemetry, request motion plans, and issue fleet-wide commands.

Endpoints (all on the per-tenant node):

GET    /api/v2/robotic/info
GET    /api/v2/robotic/robots
POST   /api/v2/robotic/robots
GET    /api/v2/robotic/robots/{id}
DELETE /api/v2/robotic/robots/{id}
POST   /api/v2/robotic/robots/{id}/command
GET    /api/v2/robotic/commands/{id}
POST   /api/v2/robotic/robots/{id}/emergency-stop
POST   /api/v2/robotic/robots/{id}/telemetry
POST   /api/v2/robotic/robots/{id}/plan
POST   /api/v2/robotic/robots/{id}/approval/resolve
POST   /api/v2/robotic/fleet/command

Index

• type Client
  • func (c *Client) CommandStatus(ctx context.Context, commandID string) (Result, error)
  • func (c *Client) DeleteRobot(ctx context.Context, robotID string) (Result, error)
  • func (c *Client) EmergencyStop(ctx context.Context, robotID string) (Result, error)
  • func (c *Client) FleetCommand(ctx context.Context, payload map[string]interface{}) (Result, error)
  • func (c *Client) FleetMission(ctx context.Context, payload map[string]interface{}) (Result, error)
  • func (c *Client) GetRobot(ctx context.Context, robotID string) (Result, error)
  • func (c *Client) Info(ctx context.Context) (Result, error)
  • func (c *Client) ListRobots(ctx context.Context) (Result, error)
  • func (c *Client) Plan(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)
  • func (c *Client) RegisterRobot(ctx context.Context, spec map[string]interface{}) (Result, error)
  • func (c *Client) ResolveApproval(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)
  • func (c *Client) Schedule(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)
  • func (c *Client) SendCommand(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)
  • func (c *Client) Telemetry(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)
• type Result

Types

type Client

type Client struct {
	T       *transport.Transport
	NodeURL string
}

Client is the entry point. Construct via c.Robotic().

func (*Client) CommandStatus

func (c *Client) CommandStatus(ctx context.Context, commandID string) (Result, error)

CommandStatus returns the status of a previously-sent command.

func (*Client) DeleteRobot

func (c *Client) DeleteRobot(ctx context.Context, robotID string) (Result, error)

DeleteRobot deregisters a robot.

func (*Client) EmergencyStop

func (c *Client) EmergencyStop(ctx context.Context, robotID string) (Result, error)

EmergencyStop issues an immediate emergency stop to a robot.

func (*Client) FleetCommand

func (c *Client) FleetCommand(ctx context.Context, payload map[string]interface{}) (Result, error)

FleetCommand issues a command to every robot in the fleet.

func (*Client) FleetMission

func (c *Client) FleetMission(ctx context.Context, payload map[string]interface{}) (Result, error)

FleetMission runs a multi-robot mission through the workflow engine plus a per-robot LLM plan (payload: objective, robot_ids|robot_type|tags).

func (*Client) GetRobot

func (c *Client) GetRobot(ctx context.Context, robotID string) (Result, error)

GetRobot returns the detail record for one robot.

func (*Client) Info

func (c *Client) Info(ctx context.Context) (Result, error)

Info returns Robotic service info and capabilities.

func (*Client) ListRobots

func (c *Client) ListRobots(ctx context.Context) (Result, error)

ListRobots returns all registered robots for the tenant.

func (*Client) Plan

func (c *Client) Plan(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)

Plan requests a motion/task plan for a robot.

func (*Client) RegisterRobot

func (c *Client) RegisterRobot(ctx context.Context, spec map[string]interface{}) (Result, error)

RegisterRobot registers a new robot from an arbitrary spec.

func (*Client) ResolveApproval

func (c *Client) ResolveApproval(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)

ResolveApproval resolves a pending robot-action approval.

func (*Client) Schedule

func (c *Client) Schedule(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)

Schedule registers a recurring autonomous mission for a robot via vxchrono (payload: objective, schedule_type, cadence_minutes|cron_expr, ...).

func (*Client) SendCommand

func (c *Client) SendCommand(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)

SendCommand dispatches a command to a robot. The returned Result carries the command id — poll it with CommandStatus.

func (*Client) Telemetry

func (c *Client) Telemetry(ctx context.Context, robotID string, payload map[string]interface{}) (Result, error)

Telemetry pushes a telemetry frame for a robot.

type Result

type Result = map[string]interface{}

Result is a decoded JSON object response.