@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias ThermostatsCreateClimatePresetParameters

    type ThermostatsCreateClimatePresetParameters = {
        climate_preset_key: string;
        climate_preset_mode?:
            | "home"
            | "away"
            | "wake"
            | "sleep"
            | "occupied"
            | "unoccupied";
        cooling_set_point_celsius?: number;
        cooling_set_point_fahrenheit?: number;
        device_id: string;
        ecobee_metadata?: {
            climate_ref?: string;
            is_optimized?: boolean;
            owner?: "user"
            | "system";
        };
        fan_mode_setting?: "auto"
        | "on"
        | "circulate";
        heating_set_point_celsius?: number;
        heating_set_point_fahrenheit?: number;
        hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | "eco";
        manual_override_allowed?: boolean;
        name?: string;
    }
    Index
    climate_preset_key climate_preset_mode? cooling_set_point_celsius? cooling_set_point_fahrenheit? device_id ecobee_metadata? fan_mode_setting? heating_set_point_celsius? heating_set_point_fahrenheit? hvac_mode_setting? manual_override_allowed? name?
    climate_preset_key: string

    Unique key to identify the climate preset.

    climate_preset_mode?:
        | "home"
        | "away"
        | "wake"
        | "sleep"
        | "occupied"
        | "unoccupied"

    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

    cooling_set_point_celsius?: number

    Temperature to which the thermostat should cool (in °C). See also Set Points.

    cooling_set_point_fahrenheit?: number

    Temperature to which the thermostat should cool (in °F). See also Set Points.

    device_id: string

    ID of the thermostat device for which you want create a climate preset.

    ecobee_metadata?: {
        climate_ref?: string;
        is_optimized?: boolean;
        owner?: "user" | "system";
    }

    Metadata specific to the Ecobee climate, if applicable.

    Type Declaration

    • Optionalclimate_ref?: string

      Reference to the Ecobee climate, if applicable.

    • Optionalis_optimized?: boolean

      Indicates if the climate preset is optimized by Ecobee.

    • Optionalowner?: "user" | "system"

      Indicates whether the climate preset is owned by the user or the system.

    fan_mode_setting?: "auto" | "on" | "circulate"

    Desired fan mode setting, such as on, auto, or circulate.

    heating_set_point_celsius?: number

    Temperature to which the thermostat should heat (in °C). See also Set Points.

    heating_set_point_fahrenheit?: number

    Temperature to which the thermostat should heat (in °F). See also Set Points.

    hvac_mode_setting?: "off" | "heat" | "cool" | "heat_cool" | "eco"

    Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

    manual_override_allowed?: boolean

    Indicates whether a person at the thermostat or using the API can change the thermostat's settings.

    Use 'thermostat_schedule.is_override_allowed'

    name?: string

    User-friendly name to identify the climate preset.

    Settings
    Member Visibility

    On This Page
    Properties