web

Documentation

Overview

Package web provides gRPC/REST/GUI APIs to control and monitor a robot.

Index

• Constants
• Variables
• func RunWeb(ctx context.Context, r robot.LocalRobot, o weboptions.Options, ...) (err error)
• func RunWebWithConfig(ctx context.Context, r robot.LocalRobot, cfg *config.Config, ...) error
• type Option
  • func WithStreamConfig(config gostream.StreamConfig) Option
• type RestartStatusResponse
• type Service
  • func New(r robot.Robot, logger logging.Logger, opts ...Option) Service

Constants

const SubtypeName = "web"

SubtypeName is a constant that identifies the internal web resource subtype string.

Variables

var API = resource.APINamespaceRDKInternal.WithServiceType(SubtypeName)

API is the fully qualified API for the internal web service.

var InternalServiceName = resource.NewName(API, "builtin")

InternalServiceName is used to refer to/depend on this service internally.

Functions

func RunWeb

func RunWeb(ctx context.Context, r robot.LocalRobot, o weboptions.Options, logger logging.Logger) (err error)

RunWeb starts the web server on the robot with web options and blocks until we cancel the context.

func RunWebWithConfig

func RunWebWithConfig(ctx context.Context, r robot.LocalRobot, cfg *config.Config, logger logging.Logger) error

RunWebWithConfig starts the web server on the robot with a robot config and blocks until we cancel the context.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures how we set up the web service. Cribbed from https://github.com/grpc/grpc-go/blob/aff571cc86e6e7e740130dbbb32a9741558db805/dialoptions.go#L41

func WithStreamConfig

func WithStreamConfig(config gostream.StreamConfig) Option

WithStreamConfig returns an Option which sets the streamConfig used to enable audio/video streaming over WebRTC.

type RestartStatusResponse

type RestartStatusResponse struct {
	// RestartAllowed represents whether this instance of the viam-server can be
	// safely restarted.
	RestartAllowed bool `json:"restart_allowed"`
}

RestartStatusResponse is the JSON response of the `restart_status` HTTP endpoint.

type Service

type Service interface {
	resource.Resource

	// Start starts the web server
	Start(context.Context, weboptions.Options) error

	// Stop stops the main web service (but leaves module server socket running.)
	Stop()

	// StartModule starts the module server socket.
	StartModule(context.Context) error

	// Returns the address and port the web service listens on.
	Address() string

	// Returns the unix socket path the module server listens on.
	ModuleAddress() string

	Stats() any
}

A Service controls the web server for a robot.

func New

func New(r robot.Robot, logger logging.Logger, opts ...Option) Service

New returns a new web service for the given robot.