hcsr04

Documentation

Overview

Package hcsr04 provides a driver for the HC-SR04 ultrasonic distance sensor

Datasheet: https://cdn.sparkfun.com/datasheets/Sensors/Proximity/HCSR04.pdf

Index

• Constants
• type Device
  • func New(trigger, echo machine.Pin) Device
  • func (d *Device) Configure()
  • func (d *Device) ReadDistance() int32
  • func (d *Device) ReadPulse() int32

Constants

const TIMEOUT = 23324 // max sensing distance (4m)

Types

type Device

type Device struct {
	// contains filtered or unexported fields
}

Device holds the pins

func New

func New(trigger, echo machine.Pin) Device

New returns a new ultrasonic driver given 2 pins

func (*Device) Configure

func (d *Device) Configure()

Configure configures the pins of the Device

func (*Device) ReadDistance

func (d *Device) ReadDistance() int32

ReadDistance returns the distance of the object in mm

func (*Device) ReadPulse

func (d *Device) ReadPulse() int32

ReadPulse returns the time of the pulse (roundtrip) in microseconds