hysteresis

Documentation

Index

• Constants
• type Controller
  • func NewController(thermometer device.Thermometer, chiller, heater device.Actuator, ...) *Controller
  • func (c *Controller) Run(ctx context.Context, setPoint float64) error
• type Error
  • func (e Error) Error() string
• type OptionsFunc
  • func ChillerCooldown(chillerCooldown time.Duration) OptionsFunc
  • func CyclePeriod(cyclePeriod time.Duration) OptionsFunc

Constants

const (
	ErrAlreadyRunning   = Error("pid is already running")
	ErrThermometerIsNil = Error("thermometer is nil")
	ErrActuatorIsNil    = Error("actuator is nil")
)

Types

type Controller

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

func NewController

func NewController(thermometer device.Thermometer, chiller, heater device.Actuator,
	chillingDifferential, heatingDifferential float64,
	logger *logrus.Logger, options ...OptionsFunc,
) *Controller

func (*Controller) Run

func (c *Controller) Run(ctx context.Context, setPoint float64) error

type Error

type Error string

func (Error) Error

func (e Error) Error() string

type OptionsFunc

type OptionsFunc func(*Controller)

func ChillerCooldown

func ChillerCooldown(chillerCooldown time.Duration) OptionsFunc

func CyclePeriod

func CyclePeriod(cyclePeriod time.Duration) OptionsFunc