models_overlay.go

package tado

import (
	"fmt"
	"net/http"
	"time"
)

// TerminationType is an enum type for overlay termination types
type TerminationType string

const (
	//TerminationTypeManual is used for manual termination
	TerminationTypeManual TerminationType = "MANUAL"

	// TerminationTypeTimer is used for automation termination, use property DurationInSeconds to set the timer duration
	TerminationTypeTimer TerminationType = "TIMER"

	// TerminationTypeTadoMode is used to terminate this setting by Tado, the overlay ends when the schema changes
	TerminationTypeTadoMode TerminationType = "TADO_MODE"
)

// OverlayInput is the main input for an overlay
type OverlayInput struct {
	Setting     OverlayInputSetting     `json:"setting"`
	Termination OverlayInputTermination `json:"termination"`
}

// OverlayInputSetting contains the settings for the overlay
type OverlayInputSetting struct {
	Type        string                  `json:"type"`
	Power       string                  `json:"power"`
	Temperature OverlayInputTemperature `json:"temperature"`
}

// OverlayInputTermination contains the termination settings for the overlay
type OverlayInputTermination struct {
	Type              TerminationType `json:"type"`
	DurationInSeconds int             `json:"durationInSeconds,omitempty"`
}

// OverlayInputTemperature contains the temperature settings for the overlay
type OverlayInputTemperature struct {
	Celsius    float64 `json:"celsius,omitempty"`
	Fahrenheit float64 `json:"fahrenheit,omitempty"`
}

// OverlayOutput is the output for a successful overlay update
type OverlayOutput struct {
	Type    string `json:"type"`
	Setting struct {
		Type        string `json:"type"`
		Power       string `json:"power"`
		Temperature struct {
			Celsius    float64 `json:"celsius"`
			Fahrenheit float64 `json:"fahrenheit"`
		} `json:"temperature"`
	} `json:"setting"`
	Termination struct {
		Type                   string    `json:"type"`
		TypeSkillBasedApp      string    `json:"typeSkillBasedApp"`
		DurationInSeconds      int       `json:"durationInSeconds"`
		Expiry                 time.Time `json:"expiry"`
		RemainingTimeInSeconds int       `json:"remainingTimeInSeconds"`
		ProjectedExpiry        time.Time `json:"projectedExpiry"`
	} `json:"termination"`
}

// PutOverlayInput is the input for PutOverlay
type PutOverlayInput struct {
	HomeID int
	ZoneID int
	OverlayInput
}

func (poi *PutOverlayInput) method() string {
	return http.MethodPut
}

func (poi *PutOverlayInput) path() string {
	return fmt.Sprintf("/v2/homes/%d/zones/%d/overlay", poi.HomeID, poi.ZoneID)
}

func (poi *PutOverlayInput) body() interface{} {
	return poi.OverlayInput
}

// PutOverlayOutput is the output for PutOverlay
type PutOverlayOutput struct {
	OverlayOutput
}

// DeleteOverlayInput is the input for DeleteOverlay
type DeleteOverlayInput struct {
	HomeID int
	ZoneID int
}

func (poi *DeleteOverlayInput) method() string {
	return http.MethodDelete
}

func (poi *DeleteOverlayInput) path() string {
	return fmt.Sprintf("/v2/homes/%d/zones/%d/overlay", poi.HomeID, poi.ZoneID)
}

func (poi *DeleteOverlayInput) body() interface{} {
	return nil
}

// DeleteOverlayOutput is the output for DeleteOverlay
type DeleteOverlayOutput struct{}