ultrasonic

Documentation

Overview

Package ultrasonic implements an ultrasonic sensor based of the yahboom ultrasonic sensor

Index

• func NewSensor(ctx context.Context, deps resource.Dependencies, name resource.Name, ...) (sensor.Sensor, error)
• type Config
  • func (conf *Config) Validate(path string) ([]string, error)
• type Sensor
  • func (s *Sensor) Close(ctx context.Context) error
  • func (s *Sensor) Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)

Functions

func NewSensor

func NewSensor(ctx context.Context, deps resource.Dependencies,
	name resource.Name, config *Config, logger logging.Logger,
) (sensor.Sensor, error)

NewSensor creates and configures a new ultrasonic sensor.

Types

type Config

type Config struct {
	TriggerPin    string `json:"trigger_pin"`
	EchoInterrupt string `json:"echo_interrupt_pin"`
	Board         string `json:"board"`
	TimeoutMs     uint   `json:"timeout_ms,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.

type Sensor

type Sensor struct {
	resource.Named
	resource.AlwaysRebuild
	// contains filtered or unexported fields
}

Sensor ultrasonic sensor.

func (*Sensor) Close

func (s *Sensor) Close(ctx context.Context) error

Close remove interrupt callback of ultrasonic sensor.

func (*Sensor) Readings

func (s *Sensor) Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)

Readings returns the calculated distance.