am2301

Documentation

Index

• type AM2301
• type Impl
  • func New(pin gpio.Pin) *Impl
  • func (am *Impl) Check() (State, error)
  • func (am *Impl) Read() ([5]byte, error)
  • func (am *Impl) Request() error
• type State
  • func Parse(vals [5]byte) (State, error)
  • func (s State) Valid() bool

Types

type AM2301

type AM2301 interface {
	Check() (State, error)
}

AM2301 minimal interface

type Impl

type Impl struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Impl standard implementation of a Monitor

func New

func New(pin gpio.Pin) *Impl

New new am2301

func (*Impl) Check

func (am *Impl) Check() (State, error)

Check start a monitor with the given handler hook

func (*Impl) Read

func (am *Impl) Read() ([5]byte, error)

Read read a 5-byte sequence from the pin

func (*Impl) Request

func (am *Impl) Request() error

Request send the signal to request a new measurement

type State

type State struct {
	RH   float64
	Temp float64
}

State state of an AM2301 sensor

func Parse

func Parse(vals [5]byte) (State, error)

Parse parse a State from a 5-byte input stream

func (State) Valid

func (s State) Valid() bool

Valid check that values are within the specifed range