ultrasonic

Documentation

Overview

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

Index

• type AttrConfig
  • func (config *AttrConfig) Validate(path string) ([]string, error)
• type Sensor
  • func (s *Sensor) Close() error
  • func (s *Sensor) Readings(ctx context.Context, extra map[string]interface{}) (map[string]interface{}, error)

Types

type AttrConfig

type AttrConfig struct {
	TriggerPin    string `json:"trigger_pin"`
	EchoInterrupt string `json:"echo_interrupt_pin"`
	Board         string `json:"board"`
	TimeoutMs     uint   `json:"timeout_ms,omitempty"`
}

AttrConfig is used for converting config attributes.

func (*AttrConfig) Validate

func (config *AttrConfig) Validate(path string) ([]string, error)

Validate ensures all parts of the config are valid.

type Sensor

type Sensor struct {
	Name string

	generic.Unimplemented
	// contains filtered or unexported fields
}

Sensor ultrasonic sensor.

func (*Sensor) Close

func (s *Sensor) Close() 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.