hvac

type Blower struct {
	CurrentStartTime time.Time
	LastStartTime    time.Time
	LastStopTime     time.Time
	Name             string
	Runtime          time.Duration
	FilterTime       uint64
	ID               BlowerID
	HotLoop          LoopID
	ColdLoop         LoopID
	Zone             ZoneID
	Running          bool
}

type BlowerID uint8

type Chiller struct {
	CurrentStartTime time.Time
	LastStartTime    time.Time
	LastStopTime     time.Time
	Name             string
	Loops            []LoopID
	Runtime          time.Duration
	ID               ChillerID
	Running          bool
}

type ChillerID uint8

type Command struct {
	Source      string        // a string describing the reasonx:, manual, schedule, auto
	RunTime     time.Duration // the time to run the device/zone
	TargetState bool
}

type Config struct {
	StateStore        string       // the directory in which to store running state
	SystemMode        SystemModeT  // heating/cooling
	ControlMode       ControlModeT // off/manual/schedule/temp
	MQTT              *MQTTConfig  // config for the mqtt server
	HTTPaddr          string       // the address on which to listen :8080
	HTTPStaticDir     string       // the directory that contains the built webui
	HTTPAuthData      string       // the file that contains the HTTP authentication creds
	DataLogFile       string       // the name of the datalog files
	OpenWeatherMapKey string       // API key from OpenWeatherMap
	OpenWeatherMapID  int          // locaiton ID in OpenWeatherMap
	ChillerLockout    bool         // is the chiller locked-out due to being too cold?
	// BoilerLockout     bool         // is the boiler locked-out due to being to warm? // move to per-zone check
	Blowers          []*Blower
	Chillers         []*Chiller
	Dampers          []*Damper
	Loops            []*Loop
	Pumps            []*Pump
	Rooms            []*Room
	Valves           []*Valve
	Zones            []*Zone
	TimeZoneLocation string
}

type ControlMode struct {
	ControlMode ControlModeT
}

type ControlModeT uint8

type Damper struct {
	Name  string
	ID    damperID
	State int8
	Min   int8
	Max   int8
}

type DegF float32 // uint8

type DeviceID interface {
	Start(time.Duration, string) error
	Stop(string)
	// contains filtered or unexported methods
}

type Loop struct {
	Name        string
	ID          LoopID
	RadiantZone ZoneID
}

type LoopID uint8

type MQTTConfig struct {
	ID         string // something randomish (fumcg-hvac-server)
	Auth       string // filename (/etc/hvac-mqtt-auth.json)
	Root       string // base mqtt path component(s) (fumcg)
	ListenAddr string // (":1883")
}

type MQTTRequest struct {
	DeviceID DeviceID
	Command  Command
}

type OccupancyNextRunReport struct {
	Name    string
	NextRun time.Time
}

type OccupancyOneTimeEntry struct {
	Start time.Time
	End   time.Time
	Name  string
	Rooms []RoomID
	ID    OccupancyOneTimeID
}

type OccupancyOneTimeID uint8

type OccupancyRecurringEntry struct {
	Name      string
	StartTime string // "6:30"
	EndTime   string // "15:30"
	Weekdays  []time.Weekday
	Rooms     []RoomID
	ID        OccupancyRecurringID
}

type OccupancyRecurringID uint8

type OccupancySchedule struct {
	Recurring []*OccupancyRecurringEntry
	OneTime   []*OccupancyOneTimeEntry
}

type Pump struct {
	CurrentStartTime time.Time
	LastStartTime    time.Time
	LastStopTime     time.Time
	Name             string
	Runtime          time.Duration
	ID               PumpID
	Loop             LoopID
	SystemMode       SystemModeT
	Running          bool
}

type PumpID uint8

type Relay struct {
	StartTime time.Time     // time of current start
	StopTime  time.Time     // time to stop running
	RunTime   time.Duration // total run-time of the device
	Pin       uint8         // gpio pin on relay control board
	PumpID    PumpID        // non-zero if devices is a pump
	BlowerID  BlowerID      // non-zero if device is a blower
	ChillerID ChillerID     // non-zero if the device is a chiller
	Running   bool          // is the device currently running
}

type Response struct {
	CurrentState  bool
	RanTime       time.Duration // time actually ran (when task completed)
	TimeRemaining time.Duration // time left on the clock (for periodic check-ins)
}

type Room struct {
	LastUpdate  time.Time
	Name        string
	ShellyID    string
	Temperature DegF
	ID          RoomID
	CoolZone    ZoneID
	HeatZone    ZoneID
	Humidity    uint8
	Battery     uint8
	Occupied    bool
}

type RoomID uint16

type ScheduleEntry struct {
	Name      string
	StartTime string // "10:30" "18:00;22:30;24:00""
	Weekdays  []time.Weekday
	Zones     []ZoneID
	RunTime   time.Duration
	ID        uint8
	Mode      SystemModeT
}

type ScheduleList struct {
	List []*ScheduleEntry
}

type SystemMode struct {
	Mode SystemModeT
}

type SystemModeT uint8

type Valve struct {
	Name  string
	ID    ValveID
	State int8
	Min   int8
	Max   int8
}

type ValveID uint8

type Zone struct {
	Name             string
	OneDegreeAdjTime time.Duration // how long does it take the zone to move by 1 degF
	Targets          ZoneTargets
	AverageTemp      DegF
	ID               ZoneID
}

type ZoneID uint8

type ZoneTargets struct {
	HeatingOccupiedTemp   DegF // 68 -- heat to 68 if someone is schedule to be in the zone
	HeatingUnoccupiedTemp DegF // 60 -- let it get down to 60 if no one is schedule to be in the zone
	CoolingOccupiedTemp   DegF // 74 -- cool to 74 if someone is sheduled to be in the zone
	CoolingUnoccupiedTemp DegF // 80 -- let it get up to 80 if no one is scheduled to be in the zone
}