refrig

Documentation

Index

• type Pin
• type Refrig
  • func New(name string, control Pin, recovery time.Duration) *Refrig
  • func (r *Refrig) IsStarted() bool
  • func (r *Refrig) IsStopped() bool
  • func (r *Refrig) SetRecovery()
  • func (r *Refrig) Start() error
  • func (r *Refrig) Stop() error
  • func (r *Refrig) String() string
• type RunState

Types

type Pin

type Pin interface {
	High()
	Low()
	// TODO: it'd be better if refrig didn't depend on rpio
	Read() rpio.State
}

type Refrig

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

Refrig is an on/off controller with a recovery period between turning off and turning back on again. It is intended to be a failsafe module, but it's just plain funky. This needs to be in thermo.Stat

func New

func New(name string, control Pin, recovery time.Duration) *Refrig

New makes a Refrig on the given pin. State is Run/Stop depending on state of pin.

func (*Refrig) IsStarted

func (r *Refrig) IsStarted() bool

func (*Refrig) IsStopped

func (r *Refrig) IsStopped() bool

func (*Refrig) SetRecovery

func (r *Refrig) SetRecovery()

SetRecovery sets the pin low and starts the Recover state.

func (*Refrig) Start

func (r *Refrig) Start() error

func (*Refrig) Stop

func (r *Refrig) Stop() error

func (*Refrig) String

func (r *Refrig) String() string

type RunState

type RunState int

const (
	Unknown RunState = iota
	Stop
	Run
	Recover
)