evend

Documentation

Overview

Package evend incapsulates common parts of MDB protocol for eVend machine devices like conveyor, hopper, cup dispenser, elevator, etc.

Index

• Constants
• func Enum(ctx context.Context) error
• type DeviceConveyor
• type DeviceCup
  • func (devCup *DeviceCup) NewDispense() engine.Doer
  • func (devCup *DeviceCup) NewDispenseProper() engine.Doer
  • func (devCup *DeviceCup) NewEnsure() engine.Doer
  • func (devCup *DeviceCup) NewLight(v bool) engine.Doer
• type DeviceElevator
• type DeviceErrorCode
  • func (c DeviceErrorCode) Error() string
• type DeviceEspresso
  • func (devEspr *DeviceEspresso) NewGrind() engine.Doer
  • func (devEspr *DeviceEspresso) NewHeat(on bool) engine.Doer
  • func (devEspr *DeviceEspresso) NewPress() engine.Doer
  • func (devEspr *DeviceEspresso) NewRelease() engine.Doer
• type DeviceHopper
• type DeviceMixer
  • func (devMix *DeviceMixer) NewFan(on bool) engine.Doer
• type DeviceMultiHopper
• type DeviceValve
  • func (self *DeviceValve) NewPump(start bool) engine.Doer
  • func (self *DeviceValve) NewPumpEspresso(start bool) engine.Doer
  • func (self *DeviceValve) NewValveBoiler(open bool) engine.Doer
  • func (self *DeviceValve) NewValveCold(open bool) engine.Doer
  • func (self *DeviceValve) NewValveHot(open bool) engine.Doer
• type ErrWaterTemperature
  • func (e *ErrWaterTemperature) Error() string
• type Generic
  • func (gen *Generic) Diagnostic() (byte, error)
  • func (gen *Generic) FIXME_initIO(ctx context.Context) error
  • func (gen *Generic) Init(ctx context.Context, address uint8, name string, proto evendProtocol)
  • func (gen *Generic) Name() string
  • func (gen *Generic) NewAction(tag string, args ...byte) engine.Doer
  • func (gen *Generic) NewErrPollProblem(p mdb.Packet) error
  • func (gen *Generic) NewErrPollUnexpected(p mdb.Packet) error
  • func (gen *Generic) NewWaitDone(tag string, timeout time.Duration) engine.Doer
  • func (gen *Generic) NewWaitReady(tag string) engine.Doer
  • func (gen *Generic) WithRestart(d engine.Doer) *engine.RestartError

Constants

const (
	DefaultReadyTimeout = 5 * time.Second
	DefaultResetDelay   = 2100 * time.Millisecond
)

const ConveyorDefaultTimeout = 30 * time.Second

const ConveyorMinTimeout = 1 * time.Second

const DefaultCupAssertBusyDelay = 30 * time.Millisecond

const DefaultCupDispenseTimeout = 10 * time.Second

const DefaultCupEnsureTimeout = 70 * time.Second

const DefaultEspressoTimeout = 30 * time.Second

const DefaultHopperRunTimeout = 200 * time.Millisecond

const DefaultShakeSpeed uint8 = 100

const HopperTimeout = 1 * time.Second

Functions

func Enum

func Enum(ctx context.Context) error

Enum Register devices

Types

type DeviceConveyor

type DeviceConveyor struct {
	Generic

	DoSetSpeed engine.FuncArg
	// contains filtered or unexported fields
}

type DeviceCup

type DeviceCup struct {
	Generic
	// contains filtered or unexported fields
}

func (*DeviceCup) NewDispense

func (devCup *DeviceCup) NewDispense() engine.Doer

func (*DeviceCup) NewDispenseProper

func (devCup *DeviceCup) NewDispenseProper() engine.Doer

func (*DeviceCup) NewEnsure

func (devCup *DeviceCup) NewEnsure() engine.Doer

func (*DeviceCup) NewLight

func (devCup *DeviceCup) NewLight(v bool) engine.Doer

type DeviceElevator

type DeviceElevator struct {
	Generic
	// contains filtered or unexported fields
}

type DeviceErrorCode

type DeviceErrorCode byte

func (DeviceErrorCode) Error

func (c DeviceErrorCode) Error() string

type DeviceEspresso

type DeviceEspresso struct {
	Generic
	// contains filtered or unexported fields
}

func (*DeviceEspresso) NewGrind

func (devEspr *DeviceEspresso) NewGrind() engine.Doer

func (*DeviceEspresso) NewHeat

func (devEspr *DeviceEspresso) NewHeat(on bool) engine.Doer

func (*DeviceEspresso) NewPress

func (devEspr *DeviceEspresso) NewPress() engine.Doer

func (*DeviceEspresso) NewRelease

func (devEspr *DeviceEspresso) NewRelease() engine.Doer

type DeviceHopper

type DeviceHopper struct {
	Generic
}

type DeviceMixer

type DeviceMixer struct {
	Generic
	// contains filtered or unexported fields
}

func (*DeviceMixer) NewFan

func (devMix *DeviceMixer) NewFan(on bool) engine.Doer

type DeviceMultiHopper

type DeviceMultiHopper struct {
	Generic
}

type DeviceValve

type DeviceValve struct {
	Generic

	DoSetTempHot   engine.FuncArg
	DoPourCold     engine.Doer
	DoPourHot      engine.Doer
	DoPourEspresso engine.Doer
	// contains filtered or unexported fields
}

func (*DeviceValve) NewPump

func (self *DeviceValve) NewPump(start bool) engine.Doer

func (*DeviceValve) NewPumpEspresso

func (self *DeviceValve) NewPumpEspresso(start bool) engine.Doer

func (*DeviceValve) NewValveBoiler

func (self *DeviceValve) NewValveBoiler(open bool) engine.Doer

func (*DeviceValve) NewValveCold

func (self *DeviceValve) NewValveCold(open bool) engine.Doer

func (*DeviceValve) NewValveHot

func (self *DeviceValve) NewValveHot(open bool) engine.Doer

type ErrWaterTemperature

type ErrWaterTemperature struct {
	Source  string
	Current int16
	Target  int16
}

func (*ErrWaterTemperature) Error

func (e *ErrWaterTemperature) Error() string

type Generic

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

func (*Generic) Diagnostic

func (gen *Generic) Diagnostic() (byte, error)

func (*Generic) FIXME_initIO

func (gen *Generic) FIXME_initIO(ctx context.Context) error

FIXME_initIO Enum, remove IO from Init

func (*Generic) Init

func (gen *Generic) Init(ctx context.Context, address uint8, name string, proto evendProtocol)

func (*Generic) Name

func (gen *Generic) Name() string

func (*Generic) NewAction

func (gen *Generic) NewAction(tag string, args ...byte) engine.Doer

func (*Generic) NewErrPollProblem

func (gen *Generic) NewErrPollProblem(p mdb.Packet) error

func (*Generic) NewErrPollUnexpected

func (gen *Generic) NewErrPollUnexpected(p mdb.Packet) error

func (*Generic) NewWaitDone

func (gen *Generic) NewWaitDone(tag string, timeout time.Duration) engine.Doer

NewWaitDone proto1/2 agnostic, use it after action

func (*Generic) NewWaitReady

func (gen *Generic) NewWaitReady(tag string) engine.Doer

NewWaitReady proto1/2 agnostic, use it before action

func (*Generic) WithRestart

func (gen *Generic) WithRestart(d engine.Doer) *engine.RestartError