types.go

package sensonet

import (
	"time"
)

const (
	CLIENT_ID    = "myvaillant"
	REDIRECT_URL = "enduservaillant.page.link://login"

	AUTH_BASE_URL     = "https://identity.vaillant-group.com/auth/realms"
	LOGIN_URL         = AUTH_BASE_URL + "/%s/login-actions/authenticate"
	TOKEN_URL         = AUTH_BASE_URL + "/%s/protocol/openid-connect/token"
	AUTH_URL          = AUTH_BASE_URL + "/%s/protocol/openid-connect/auth"
	API_URL_BASE      = "https://api.vaillant-group.com/service-connected-control/end-user-app-api/v1"
	HOTWATERBOOST_URL = "/systems/%s/tli/domestic-hot-water/%01d/boost"
	ZONEQUICKVETO_URL = "/systems/%s/tli/zones/%01d/quick-veto"
	SYSTEMS_URL       = "/systems/%s/tli"
	DEVICES_URL       = "/emf/v2/%s/currentSystem"
	ENERGY_URL        = "/emf/v2/%s/devices/%s/buckets?"
	MPC_URL           = "/hem/%s/mpc"
)

const (
	HOTWATERINDEX_DEFAULT                = 255
	ZONEINDEX_DEFAULT                    = 0
	ZONEVETOSETPOINT_DEFAULT             = 20.0
	ZONEVETODURATION_DEFAULT             = 3.0 // 3 hours as default
	OPERATIONMODE_TIME_CONTROLLED string = "TIME_CONTROLLED"
	QUICKMODE_HOTWATER            string = "Hotwater Boost"
	QUICKMODE_HEATING             string = "Heating Quick Veto"
	QUICKMODE_NOTHING             string = "Charger running idle"
	QUICKMODE_ERROR_ALREADYON     string = "Error. A quickmode is already running"

	SPECIAL_FUNCTION_QUICK_VETO     = "QUICK_VETO"
	SPECIAL_FUNCTION_HOTWATER_BOOST = "CYLINDER_BOOST"
)

const (
	STRATEGY_NONE                  = 0
	STRATEGY_HOTWATER              = 1
	STRATEGY_HEATING               = 2
	STRATEGY_HOTWATER_THEN_HEATING = 3
)

const (
	DEVICES_ALL              = 0
	DEVICES_PRIMARY_HEATER   = 1
	DEVICES_SECONDARY_HEATER = 2
	DEVICES_BACKUP_HEATER    = 3
)

const (
	RESOLUTION_HOUR  = "HOUR"
	RESOLUTION_DAY   = "DAY"
	RESOLUTION_MONTH = "MONTH"
)

type Logger interface {
	Printf(msg string, arg ...any)
}

type CredentialsStruct struct {
	User     string `json:"user"`
	Password string `json:"password"`
	Realm    string `json:"realm"`
}

type HeatingParStruct struct {
	ZoneIndex    int
	VetoSetpoint float32
	VetoDuration float32
}

type HotwaterParStruct struct {
	Index int
}

type Homes []struct {
	HomeName string `json:"homeName"`
	Address  struct {
		Street      string `json:"street"`
		Extension   any    `json:"extension"`
		City        string `json:"city"`
		PostalCode  string `json:"postalCode"`
		CountryCode string `json:"countryCode"`
	} `json:"address"`
	SerialNumber    string `json:"serialNumber"`
	SystemID        string `json:"systemId"`
	ProductMetadata struct {
		ProductType    string `json:"productType"`
		ProductionYear string `json:"productionYear"`
		ProductionWeek string `json:"productionWeek"`
		ArticleNumber  string `json:"articleNumber"`
	} `json:"productMetadata"`
	State               string    `json:"state"`
	MigrationState      string    `json:"migrationState"`
	MigrationFinishedAt time.Time `json:"migrationFinishedAt"`
	OnlineState         string    `json:"onlineState"`
	Firmware            struct {
		Version        string `json:"version"`
		UpdateEnabled  bool   `json:"updateEnabled"`
		UpdateRequired bool   `json:"updateRequired"`
	} `json:"firmware"`
	Nomenclature       string `json:"nomenclature"`
	Cag                bool   `json:"cag"`
	CountryCode        string `json:"countryCode"`
	ProductInformation string `json:"productInformation"`
	FirmwareVersion    string `json:"firmwareVersion"`
}

type SystemStatus struct {
	State struct {
		System struct {
			OutdoorTemperature           float64 `json:"outdoorTemperature"`
			OutdoorTemperatureAverage24H float64 `json:"outdoorTemperatureAverage24h"`
			SystemFlowTemperature        float64 `json:"systemFlowTemperature"`
			SystemWaterPressure          float64 `json:"systemWaterPressure"`
			EnergyManagerState           string  `json:"energyManagerState"`
			SystemOff                    bool    `json:"systemOff"`
		} `json:"system"`
		Zones            []StateZone             `json:"zones"`
		Circuits         []StateCircuit          `json:"circuits"`
		Dhw              []StateDhw              `json:"dhw"`
		DomesticHotWater []StateDomesticHotWater `json:"domesticHotWater"`
		// Ventilations
	} `json:"state"`
	Properties struct {
		System struct {
			ControllerType                     string  `json:"controllerType"`
			SystemScheme                       int     `json:"systemScheme"`
			BackupHeaterType                   string  `json:"backupHeaterType"`
			BackupHeaterAllowedFor             string  `json:"backupHeaterAllowedFor"`
			ModuleConfigurationVR71            int     `json:"moduleConfigurationVR71"`
			EnergyProvidePowerCutBehavior      string  `json:"energyProvidePowerCutBehavior"`
			SmartPhotovoltaicBufferOffset      float64 `json:"smartPhotovoltaicBufferOffset"`
			ExternalEnergyManagementActivation bool    `json:"externalEnergyManagementActivation"`
		} `json:"system"`
		Zones            []PropertiesZone             `json:"zones"`
		Circuits         []PropertiesCircuit          `json:"circuits"`
		Dhw              []PropertiesDhw              `json:"dhw"`
		DomesticHotWater []PropertiesDomesticHotWater `json:"domesticHotWater"`
		// Ventilations
	} `json:"properties"`
	Configuration struct {
		System struct {
			ContinuousHeatingStartSetpoint float64 `json:"continuousHeatingStartSetpoint"`
			AlternativePoint               float64 `json:"alternativePoint"`
			HeatingCircuitBivalencePoint   float64 `json:"heatingCircuitBivalencePoint"`
			DhwBivalencePoint              float64 `json:"dhwBivalencePoint"`
			AdaptiveHeatingCurve           bool    `json:"adaptiveHeatingCurve"`
			DhwMaximumLoadingTime          int     `json:"dhwMaximumLoadingTime"`
			DhwHysteresis                  float64 `json:"dhwHysteresis"`
			DhwFlowSetpointOffset          float64 `json:"dhwFlowSetpointOffset"`
			ContinuousHeatingRoomSetpoint  float64 `json:"continuousHeatingRoomSetpoint"`
			HybridControlStrategy          string  `json:"hybridControlStrategy"`
			MaxFlowSetpointHpError         float64 `json:"maxFlowSetpointHpError"`
			DhwMaximumTemperature          float64 `json:"dhwMaximumTemperature"`
			MaximumPreheatingTime          int     `json:"maximumPreheatingTime"`
			ParalellTankLoadingAllowed     bool    `json:"paralellTankLoadingAllowed"`
		} `json:"system"`
		Zones            []ConfigurationZone             `json:"zones"`
		Circuits         []ConfigurationCircuit          `json:"circuits"`
		Dhw              []ConfigurationDhw              `json:"dhw"`
		DomesticHotWater []ConfigurationDomesticHotWater `json:"domesticHotWater"`
		// Ventilations
	} `json:"configuration"`
}

type DhwData struct {
	State         StateDhw
	Properties    PropertiesDhw
	Configuration ConfigurationDhw
}

type DomesticHotWaterData struct {
	State         StateDomesticHotWater
	Properties    PropertiesDomesticHotWater
	Configuration ConfigurationDomesticHotWater
}

type ZoneData struct {
	State         StateZone
	Properties    PropertiesZone
	Configuration ConfigurationZone
}

type SystemAndStatus struct {
	SystemId     string
	SystemStatus SystemStatus
}

type AllSystems struct {
	SystemsAndStatus []SystemAndStatus
}

type StateZone struct {
	Index                                 int     `json:"index"`
	DesiredRoomTemperatureSetpointHeating float64 `json:"desiredRoomTemperatureSetpointHeating"`
	DesiredRoomTemperatureSetpoint        float64 `json:"desiredRoomTemperatureSetpoint"`
	CurrentRoomTemperature                float64 `json:"currentRoomTemperature,omitempty"`
	CurrentRoomHumidity                   float64 `json:"currentRoomHumidity,omitempty"`
	CurrentSpecialFunction                string  `json:"currentSpecialFunction"`
	HeatingState                          string  `json:"heatingState"`
}

type StateCircuit struct {
	Index                         int     `json:"index"`
	CircuitState                  string  `json:"circuitState"`
	CurrentCircuitFlowTemperature float64 `json:"currentCircuitFlowTemperature,omitempty"`
	HeatingCircuitFlowSetpoint    float64 `json:"heatingCircuitFlowSetpoint"`
	CalculatedEnergyManagerState  string  `json:"calculatedEnergyManagerState"`
}

type StateDhw struct {
	Index                  int     `json:"index"`
	CurrentSpecialFunction string  `json:"currentSpecialFunction"`
	CurrentDhwTemperature  float64 `json:"currentDhwTemperature"`
}

type StateDomesticHotWater struct {
	Index                              int     `json:"index"`
	CurrentSpecialFunction             string  `json:"currentSpecialFunction"`
	CurrentDomesticHotWaterTemperature float64 `json:"currentDomesticHotWaterTemperature"`
}

type PropertiesZone struct {
	Index                  int    `json:"index"`
	IsActive               bool   `json:"isActive"`
	ZoneBinding            string `json:"zoneBinding"`
	IsCoolingAllowed       bool   `json:"isCoolingAllowed"`
	AssociatedCircuitIndex int    `json:"associatedCircuitIndex"`
}

type PropertiesCircuit struct {
	Index                    int    `json:"index"`
	MixerCircuitTypeExternal string `json:"mixerCircuitTypeExternal"`
	HeatingCircuitType       string `json:"heatingCircuitType"`
}

type PropertiesDhw struct {
	Index       int     `json:"index"`
	MinSetpoint float64 `json:"minSetpoint"`
	MaxSetpoint float64 `json:"maxSetpoint"`
}

type PropertiesDomesticHotWater struct {
	Index       int     `json:"index"`
	MinSetpoint float64 `json:"minSetpoint"`
	MaxSetpoint float64 `json:"maxSetpoint"`
}

type TimeSlot struct {
	StartTime int `json:"startTime"`
	EndTime   int `json:"endTime"`
}

type Setpoint struct {
	StartTime int     `json:"startTime"`
	EndTime   int     `json:"endTime"`
	Setpoint  float64 `json:"setpoint"`
}

type MetaInfo struct {
	MinSlotsPerDay          int  `json:"minSlotsPerDay"`
	MaxSlotsPerDay          int  `json:"maxSlotsPerDay"`
	SetpointRequiredPerSlot bool `json:"setpointRequiredPerSlot"`
}

type TimeProgram struct {
	MetaInfo  MetaInfo   `json:"metaInfo"`
	Monday    []Setpoint `json:"monday"`
	Tuesday   []Setpoint `json:"tuesday"`
	Wednesday []Setpoint `json:"wednesday"`
	Thursday  []Setpoint `json:"thursday"`
	Friday    []Setpoint `json:"friday"`
	Saturday  []Setpoint `json:"saturday"`
	Sunday    []Setpoint `json:"sunday"`
}

type ConfigurationZone struct {
	Index   int `json:"index"`
	General struct {
		Name                 string    `json:"name"`
		HolidayStartDateTime time.Time `json:"holidayStartDateTime"`
		HolidayEndDateTime   time.Time `json:"holidayEndDateTime"`
		HolidaySetpoint      float64   `json:"holidaySetpoint"`
	} `json:"general"`
	Heating struct {
		OperationModeHeating      string      `json:"operationModeHeating"`
		SetBackTemperature        float64     `json:"setBackTemperature"`
		ManualModeSetpointHeating float64     `json:"manualModeSetpointHeating"`
		TimeProgramHeating        TimeProgram `json:"timeProgramHeating"`
	} `json:"heating"`
}

type ConfigurationCircuit struct {
	Index                                  int     `json:"index"`
	HeatingCurve                           float64 `json:"heatingCurve"`
	HeatingFlowTemperatureMinimumSetpoint  float64 `json:"heatingFlowTemperatureMinimumSetpoint"`
	HeatingFlowTemperatureMaximumSetpoint  float64 `json:"heatingFlowTemperatureMaximumSetpoint"`
	HeatDemandLimitedByOutsideTemperature  float64 `json:"heatDemandLimitedByOutsideTemperature"`
	HeatingCircuitFlowSetpointExcessOffset float64 `json:"heatingCircuitFlowSetpointExcessOffset"`
	SetBackModeEnabled                     bool    `json:"setBackModeEnabled"`
	RoomTemperatureControlMode             string  `json:"roomTemperatureControlMode"`
}

type ConfigurationDhw struct {
	Index                      int         `json:"index"`
	OperationModeDhw           string      `json:"operationModeDhw"`
	TappingSetpoint            float64     `json:"tappingSetpoint"`
	HolidayStartDateTime       time.Time   `json:"holidayStartDateTime"`
	HolidayEndDateTime         time.Time   `json:"holidayEndDateTime"`
	TimeProgramDhw             TimeProgram `json:"timeProgramDhw"`
	TimeProgramCirculationPump TimeProgram `json:"timeProgramCirculationPump"`
}

type ConfigurationDomesticHotWater struct {
	Index                         int         `json:"index"`
	OperationModeDomesticHotWater string      `json:"operationModeDomesticHotWater"`
	TappingSetpoint               float64     `json:"tappingSetpoint"`
	HolidayStartDateTime          time.Time   `json:"holidayStartDateTime"`
	HolidayEndDateTime            time.Time   `json:"holidayEndDateTime"`
	TimeProgramDomesticHotWater   TimeProgram `json:"timeProgramDomesticHotWater"`
	TimeProgramCirculationPump    TimeProgram `json:"timeProgramCirculationPump"`
}

type EnergyData struct {
	ExtraFields struct {
		Timezone string `json:"timezone"`
	} `json:"extra_fields"`
	OperationMode string `json:"operationMode"`
	//	SkipDataUpdate   bool    `json:"skip_data_update"`
	//	DataFrom         any     `json:"data_from"`
	//	DataTo           any     `json:"data_to"`
	StartDate  time.Time `json:"startDate"`
	EndDate    time.Time `json:"endDate"`
	Resolution string    `json:"resolution"`
	EnergyType string    `json:"energyType"`
	//	ValueType        any     `json:"valueType"`
	//	Calculated       any     `json:"calculated"`
	TotalConsumption float64 `json:"totalConsumption"`
	Data             []struct {
		ExtraFields struct {
			Timezone string `json:"timezone"`
		} `json:"extra_fields"`
		StartDate time.Time `json:"startDate"`
		EndDate   time.Time `json:"endDate"`
		Value     float64   `json:"value"`
	} `json:"data"`
}

type Device struct {
	DeviceUUID         string    `json:"device_uuid"`
	EbusID             string    `json:"ebus_id"`
	Spn                int       `json:"spn"`
	BusCouplerAddress  int       `json:"bus_coupler_address"`
	ArticleNumber      string    `json:"article_number"`
	EmfValid           bool      `json:"emfValid"`
	DeviceSerialNumber string    `json:"device_serial_number"`
	DeviceType         string    `json:"device_type"`
	FirstData          time.Time `json:"first_data"`
	LastData           time.Time `json:"last_data"`
	Data               []struct {
		OperationMode string    `json:"operation_mode"`
		ValueType     string    `json:"value_type"`
		Calculated    bool      `json:"calculated"`
		From          time.Time `json:"from"`
		To            time.Time `json:"to"`
	} `json:"data"`
	ProductName string `json:"product_name"`
}

type SystemDevices struct {
	SystemType              string   `json:"system_type"`
	HasEmfCapableDevices    bool     `json:"has_emf_capable_devices"`
	PrimaryHeatGenerator    Device   `json:"primary_heat_generator"`
	SecondaryHeatGenerators []Device `json:"secondary_heat_generators"`
	ElectricBackupHeater    Device   `json:"electric_backup_heater"`
	SolarStation            any      `json:"solar_station"`
	Ventilation             any      `json:"ventilation"`
	Gateway                 any      `json:"gateway"`
}

type DeviceAndInfo struct {
	Device Device
	Info   string
}

type SystemDevicesAndSystemId struct {
	SystemId      string
	SystemDevices SystemDevices
}

type AllSystemDevices struct {
	SystemDevicesAndSystemId []SystemDevicesAndSystemId
}

type MpcData struct {
	Devices []MpcDevice `json:"devices"`
}

type MpcDevice struct {
	DeviceID     string  `json:"deviceId"`
	CurrentPower float64 `json:"currentPower"`
}

type SystemMpcData struct {
	SystemId string
	MpcData  MpcData
}

type AllSystemMpcData struct {
	SystemMpcData []SystemMpcData
}

type DevicePower struct {
	CurrentPower float64
	ProductName  string
}

type DevicePowerMap map[string]DevicePower