Tenth\MyTotalComfort\Zone

Class Zone Represents a single Zone, which generally means a single thermostat.

• Class name: Zone
• Namespace: Tenth\MyTotalComfort

Constants

WRITABLE_ATTRIBUTES

const WRITABLE_ATTRIBUTES = array('coolSetpoint', 'heatSetpoint', 'coolNextPeriod', 'heatNextPeriod', 'hold')

Properties

$isDirty

protected boolean $isDirty = false

• Visibility: protected

$context

public \Tenth\MyTotalComfort $context

• Visibility: public

$id

public integer $id

The id number of the zone

• Visibility: public

$locationId

protected integer $locationId

• Visibility: protected

$name

public string $name

The name of the zone.

• Visibility: public

$gatewayIsLost

public boolean $gatewayIsLost

Whether the connection to the gateway has been lost.

• Visibility: public

$dispTemperatureAvailable

public boolean $dispTemperatureAvailable

Whether the indoor temperature is available.

• Visibility: public

$displayUnits

public string $displayUnits

The units used for temperature. Values are "F" or "C"

• Visibility: public

$dispTemperature

public integer $dispTemperature

The indoor temperature.

• Visibility: public

$indoorHumiditySensorAvailable

public boolean $indoorHumiditySensorAvailable

Whether an indoor humidity sensor is present and available.

• Visibility: public

$indoorHumiditySensorNotFault

public boolean $indoorHumiditySensorNotFault

Whether an indoor humidity sensor is working properly.

• Visibility: public

$indoorHumidity

public integer $indoorHumidity

Indoor relative humidity.

• Visibility: public

$indoorHumidStatus

public integer $indoorHumidStatus

UNKNOWN

• Visibility: public

$equipmentOutputStatus

public integer $equipmentOutputStatus

UNKNOWN

• Visibility: public

$outdoorHumidStatus

public integer $outdoorHumidStatus

UNKNOWN

• Visibility: public

$outdoorHumidity

public integer $outdoorHumidity

Outdoor relative humidity

• Visibility: public

$outdoorHumidityAvailable

public boolean $outdoorHumidityAvailable

Whether outdoor humidity information is available

• Visibility: public

$outdoorSensorNotFault

public integer $outdoorSensorNotFault

True if the outdoor humidity sensor is not in a fault state

• Visibility: public

$outdoorTempStatus

public integer $outdoorTempStatus

UNKNOWN

• Visibility: public

$outdoorTemperature

public integer $outdoorTemperature

Outdoor temperature

• Visibility: public

$outdoorTemperatureAvailable

public integer $outdoorTemperatureAvailable

Whether the outdoor temperature is available

• Visibility: public

$outdoorTemperatureSensorNotFault

public integer $outdoorTemperatureSensorNotFault

True of the outdoor temperature sensor is not in a fault state

• Visibility: public

$coolSetpoint

public integer $coolSetpoint

Cooling Setpoint

• Visibility: public

$coolLowerSetptLimit

public integer $coolLowerSetptLimit

Cool Lower Setpoint Limit.

• Visibility: public

$coolUpperSetptLimit

public integer $coolUpperSetptLimit

Cool Upper Setpoint Limit. It is not clear if this can be changed.

• Visibility: public

$scheduleCoolSp

public integer $scheduleCoolSp

Cool setpoint, according to the current period in the schedule.

• Visibility: public

$statusCool

public integer $statusCool

UNKNOWN

• Visibility: public

$heatSetpoint

public integer $heatSetpoint

Heat Setpoint

• Visibility: public

$heatLowerSetptLimit

public integer $heatLowerSetptLimit

Heat Lower Setpoint Limit. It is not clear if this can be changed.

• Visibility: public

$heatUpperSetptLimit

public integer $heatUpperSetptLimit

Heat Upper Setpoint Limit.

• Visibility: public

$scheduleHeatSp

public integer $scheduleHeatSp

Heat setpoint, according to the current period in the schedule.

• Visibility: public

$statusHeat

public integer $statusHeat

UNKNOWN

• Visibility: public

$currentSetpointStatus

public integer $currentSetpointStatus

UNKNOWN

• Visibility: public

$deadband

public integer $deadband

The minimum difference between the heat and cool setpoints.

• Visibility: public

$dualSetpointStatus

public boolean $dualSetpointStatus

UNKNOWN

• Visibility: public

$setpointChangeAllowed

public boolean $setpointChangeAllowed

Whether the setpoint can be changed. It is unclear if this is ever false.

• Visibility: public

$coolNextPeriod

public integer|null $coolNextPeriod

When the hold if there is one, should end for cooling. Counted as 15-minute blocks from midnight. e.g. 8:15am = 8 * 4 + 1 = 33

• Visibility: public

$heatNextPeriod

public integer|null $heatNextPeriod

When the hold if there is one, should end for heating. Counted as 15-minute blocks from midnight. e.g. 8:15am = 8 * 4 + 1 = 33

• Visibility: public

$hold

public boolean $hold

Whether a temporary hold is in place on the zone.

• Visibility: public

$holdUntilCapable

public boolean $holdUntilCapable

Whether the thermostat is capable of being set to hold until a particular time.

• Visibility: public

$isInVacationHoldMode

public boolean $isInVacationHoldMode

Whether the thermostat is in a vacation hold.

• Visibility: public

$temporaryHoldUntilTime

public integer $temporaryHoldUntilTime

UNKNOWN

• Visibility: public

$vacationHold

public integer $vacationHold

UNKNOWN

• Visibility: public

$vacationHoldCancelable

public boolean $vacationHoldCancelable

UNKNOWN

• Visibility: public

$vacationHoldUntilTime

public integer $vacationHoldUntilTime

UNKNOWN

• Visibility: public

$commercial

public boolean $commercial

Whether the application is commercial.

• Visibility: public

$scheduleCapable

public boolean $scheduleCapable

Whether the thermostat is capable of running a schedule.

• Visibility: public

$switchAutoAllowed

public boolean $switchAutoAllowed

Whether the system can be turned to Auto mode.

• Visibility: public

$switchCoolAllowed

public boolean $switchCoolAllowed

Whether the system can be turned to Cool mode.

• Visibility: public

$switchHeatAllowed

public boolean $switchHeatAllowed

Whether the system can be turned to Heat mode.

• Visibility: public

$switchEmergencyHeatAllowed

public boolean $switchEmergencyHeatAllowed

Whether the system can be turned to Emergency Heat mode. (Heat Pumps)

• Visibility: public

$switchOffAllowed

public boolean $switchOffAllowed

Whether the system can be turned to Off mode. Possibly always true.

• Visibility: public

$systemSwitchPosition

public integer $systemSwitchPosition

Current position of the system switch. Values not entirely known.

• Visibility: public

$alerts

public array<mixed,\Tenth\MyTotalComfort\Alert> $alerts

An array of alert objects that may be present in the Zone.

• Visibility: public

$hasAlerts

public boolean $hasAlerts

Whether there are active alerts

• Visibility: public

$runStatus

protected integer $runStatus

• Visibility: protected

$fanStatus

public integer $fanStatus

UNKNOWN

• Visibility: public

$loadedValues

protected array<mixed,string> $loadedValues = array()

• Visibility: protected

Methods

getLocationId

integer Tenth\MyTotalComfort\Zone::getLocationId()

Gets the Location ID that contains the Zone.

• Visibility: public

Returns

• integer - Location ID

__construct

void Tenth\MyTotalComfort\Zone::__construct(\Tenth\MyTotalComfort $tccObject, integer $id, array $data)

Zone constructor.

• Visibility: public

Arguments

• $tccObject Tenth\MyTotalComfort - Provide the user context through which this information is gleaned.
• $id integer - The location ID number
• $data array - Data to be inserted into the Location at construction.

setMultiple

mixed Tenth\MyTotalComfort\Zone::setMultiple(array<mixed,mixed> $dataArray)

Intended for pulling in data from other classes in this package.

• Visibility: public

Arguments

• $dataArray array<mixed,mixed>

Returns

• mixed

validateDetailValues

void Tenth\MyTotalComfort\Zone::validateDetailValues()

Cleans up data to keep API results consistent and logical.

• Visibility: protected

__get

mixed Tenth\MyTotalComfort\Zone::__get(string $what)

Getter. For the many, many readable parameters. The purpose of this function is to avoid API calls until needed.

• Visibility: public

Arguments

• $what string - The parameter to get

Returns

• mixed - The requested parameter

submitChanges

boolean Tenth\MyTotalComfort\Zone::submitChanges()

Submits any changes that may be necessary.

• Visibility: public

Returns

• boolean - True on success, false on failure. Will return true if there are no changes to submit.

__destruct

void Tenth\MyTotalComfort\Zone::__destruct()

Submits any pending changes before the object is destroyed.

• Visibility: public

__set

void Tenth\MyTotalComfort\Zone::__set(string $what, mixed $value)

Setter for the writable properties.

• Visibility: public

Arguments

• $what string - The parameter to set
• $value mixed - The value to set the parameter to