fake

Documentation

Overview

Package fake implements a fake arm.

Index

• Variables
• func NewArm(ctx context.Context, deps resource.Dependencies, conf resource.Config, ...) (arm.Arm, error)
• type Arm
  • func (a *Arm) Close(ctx context.Context) error
  • func (a *Arm) CurrentInputs(ctx context.Context) ([]referenceframe.Input, error)
  • func (a *Arm) EndPosition(ctx context.Context, extra map[string]interface{}) (spatialmath.Pose, error)
  • func (a *Arm) Geometries(ctx context.Context, extra map[string]interface{}) ([]spatialmath.Geometry, error)
  • func (a *Arm) GoToInputs(ctx context.Context, inputSteps ...[]referenceframe.Input) error
  • func (a *Arm) IsMoving(ctx context.Context) (bool, error)
  • func (a *Arm) JointPositions(ctx context.Context, extra map[string]interface{}) ([]referenceframe.Input, error)
  • func (a *Arm) ModelFrame() referenceframe.Model
  • func (a *Arm) MoveThroughJointPositions(ctx context.Context, positions [][]referenceframe.Input, _ *arm.MoveOptions, ...) error
  • func (a *Arm) MoveToJointPositions(ctx context.Context, joints []referenceframe.Input, ...) error
  • func (a *Arm) MoveToPosition(ctx context.Context, pose spatialmath.Pose, extra map[string]interface{}) error
  • func (a *Arm) Reconfigure(ctx context.Context, deps resource.Dependencies, conf resource.Config) error
  • func (a *Arm) Stop(ctx context.Context, extra map[string]interface{}) error
• type Config
  • func (conf *Config) Validate(path string) ([]string, error)

Variables

var Model = resource.DefaultModelFamily.WithModel("fake")

Model is the name used to refer to the fake arm model.

Functions

func NewArm

func NewArm(ctx context.Context, deps resource.Dependencies, conf resource.Config, logger logging.Logger) (arm.Arm, error)

NewArm returns a new fake arm.

Types

type Arm

type Arm struct {
	resource.Named
	CloseCount int
	// contains filtered or unexported fields
}

Arm is a fake arm that can simply read and set properties.

func (*Arm) Close

func (a *Arm) Close(ctx context.Context) error

Close does nothing.

func (*Arm) CurrentInputs

func (a *Arm) CurrentInputs(ctx context.Context) ([]referenceframe.Input, error)

CurrentInputs returns the current inputs of the fake arm.

func (*Arm) EndPosition

func (a *Arm) EndPosition(ctx context.Context, extra map[string]interface{}) (spatialmath.Pose, error)

EndPosition returns the set position.

func (*Arm) Geometries

func (a *Arm) Geometries(ctx context.Context, extra map[string]interface{}) ([]spatialmath.Geometry, error)

Geometries returns the list of geometries associated with the resource, in any order. The poses of the geometries reflect their current location relative to the frame of the resource.

func (*Arm) GoToInputs

func (a *Arm) GoToInputs(ctx context.Context, inputSteps ...[]referenceframe.Input) error

GoToInputs moves the fake arm to the given inputs.

func (*Arm) IsMoving

func (a *Arm) IsMoving(ctx context.Context) (bool, error)

IsMoving is always false for a fake arm.

func (*Arm) JointPositions

func (a *Arm) JointPositions(ctx context.Context, extra map[string]interface{}) ([]referenceframe.Input, error)

JointPositions returns joints.

func (*Arm) ModelFrame

func (a *Arm) ModelFrame() referenceframe.Model

ModelFrame returns the dynamic frame of the model.

func (*Arm) MoveThroughJointPositions

func (a *Arm) MoveThroughJointPositions(
	ctx context.Context,
	positions [][]referenceframe.Input,
	_ *arm.MoveOptions,
	_ map[string]interface{},
) error

MoveThroughJointPositions moves the fake arm through the given inputs.

func (*Arm) MoveToJointPositions

func (a *Arm) MoveToJointPositions(ctx context.Context, joints []referenceframe.Input, extra map[string]interface{}) error

MoveToJointPositions sets the joints.

func (*Arm) MoveToPosition

func (a *Arm) MoveToPosition(ctx context.Context, pose spatialmath.Pose, extra map[string]interface{}) error

MoveToPosition sets the position.

func (*Arm) Reconfigure

func (a *Arm) Reconfigure(ctx context.Context, deps resource.Dependencies, conf resource.Config) error

Reconfigure atomically reconfigures this arm in place based on the new config.

func (*Arm) Stop

func (a *Arm) Stop(ctx context.Context, extra map[string]interface{}) error

Stop doesn't do anything for a fake arm.

type Config

type Config struct {
	ArmModel      string `json:"arm-model,omitempty"`
	ModelFilePath string `json:"model-path,omitempty"`
}

Config is used for converting config attributes.

func (*Config) Validate

func (conf *Config) Validate(path string) ([]string, error)

Validate ensures all parts of the config are valid.