Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HVAC] Thermostat XML sync with spec #34517

Closed
wants to merge 18 commits into from
Closed

[HVAC] Thermostat XML sync with spec #34517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
aae9787
Update thermostat XML to support atomic writes & sync with spec changes
hasty Jul 25, 2024
343e70f
Regenerated source files for thermostat
hasty Jul 25, 2024
ef8d4df
Remove weird submodule updates
hasty Jul 26, 2024
011bd6c
Revert ACCapacityFormat to ACCapacityformat
hasty Jul 26, 2024
261aced
Duplicate OccupancyBitmap in both Thermostat and Occupancy Sensing cl…
hasty Jul 26, 2024
d21d712
Move atomic enum and struct to global-structs.xml
hasty Jul 26, 2024
83da16e
Move atomic enum to global-enums.xml, actually
hasty Jul 26, 2024
09f3dbc
Restyle patch
hasty Jul 26, 2024
614eebc
Merge branch 'master' into granbery/atomic_write
hasty Jul 26, 2024
0ed5f6a
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
ac3fc9f
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
031d33e
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
640b8af
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
bba5072
Fix generated code.
bzbarsky-apple Jul 29, 2024
1f0370d
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
a3ec295
Update Test_TC_TSTAT_1_1 to know about AtomicResponse command.
bzbarsky-apple Jul 29, 2024
af944bd
Merge branch 'master' into granbery/atomic_write
hasty Jul 29, 2024
1ac5f63
Fix emberAfIsTypeSigned not understanding temperature type
hasty Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ jobs:
--no-print \
--log-level info \
src/app/zap-templates/zcl/data-model/chip/global-attributes.xml \
src/app/zap-templates/zcl/data-model/chip/global-bitmaps.xml \
src/app/zap-templates/zcl/data-model/chip/global-enums.xml \
src/app/zap-templates/zcl/data-model/chip/global-structs.xml \
src/app/zap-templates/zcl/data-model/chip/semantic-tag-namespace-enums.xml \
src/app/zap-templates/zcl/data-model/chip/access-control-definitions.xml \
Expand Down
87 changes: 46 additions & 41 deletions examples/air-purifier-app/air-purifier-common/air-purifier-app.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1242,7 +1242,7 @@ cluster ActivatedCarbonFilterMonitoring = 114 {

/** An interface for configuring and controlling the functionality of a thermostat. */
cluster Thermostat = 513 {
revision 6;
revision 7;

enum ACCapacityFormatEnum : enum8 {
kBTUh = 0;
Expand Down Expand Up @@ -1278,6 +1278,12 @@ cluster Thermostat = 513 {
kHeatPumpInverter = 4;
}

enum AtomicRequestTypeEnum : enum8 {
kBeginWrite = 0;
kCommitWrite = 1;
kRollbackWrite = 2;
}

enum ControlSequenceOfOperationEnum : enum8 {
kCoolingOnly = 0;
kCoolingWithReheat = 1;
Expand All @@ -1288,13 +1294,13 @@ cluster Thermostat = 513 {
}

enum PresetScenarioEnum : enum8 {
kUnspecified = 0;
kOccupied = 1;
kUnoccupied = 2;
kSleep = 3;
kWake = 4;
kVacation = 5;
kUserDefined = 6;
kGoingToSleep = 6;
kUserDefined = 254;
}

enum SetpointChangeSourceEnum : enum8 {
Expand Down Expand Up @@ -1360,7 +1366,6 @@ cluster Thermostat = 513 {
kLocalTemperatureNotExposed = 0x40;
kMatterScheduleConfiguration = 0x80;
kPresets = 0x100;
kSetpoints = 0x200;
}

bitmap HVACSystemTypeBitmap : bitmap8 {
Expand All @@ -1370,6 +1375,10 @@ cluster Thermostat = 513 {
kHeatingUsesFuel = 0x20;
}

bitmap OccupancyBitmap : bitmap8 {
kOccupied = 0x1;
}

bitmap PresetTypeFeaturesBitmap : bitmap16 {
kAutomatic = 0x1;
kSupportsNames = 0x2;
Expand Down Expand Up @@ -1420,11 +1429,6 @@ cluster Thermostat = 513 {
kSupportsOff = 0x8;
}

bitmap TemperatureSetpointHoldPolicyBitmap : bitmap8 {
kHoldDurationElapsed = 0x1;
kHoldDurationElapsedOrPresetChanged = 0x2;
}

struct ScheduleTransitionStruct {
ScheduleDayOfWeekBitmap dayOfWeek = 0;
int16u transitionTime = 1;
Expand All @@ -1440,7 +1444,12 @@ cluster Thermostat = 513 {
optional char_string<64> name = 2;
optional octet_string<16> presetHandle = 3;
ScheduleTransitionStruct transitions[] = 4;
optional nullable boolean builtIn = 5;
nullable boolean builtIn = 5;
}

struct AtomicAttributeStatusStruct {
optional attrib_id attributeID = 0;
optional status statusCode = 1;
}

struct PresetStruct {
Expand Down Expand Up @@ -1472,23 +1481,23 @@ cluster Thermostat = 513 {

readonly attribute nullable temperature localTemperature = 0;
readonly attribute optional nullable temperature outdoorTemperature = 1;
readonly attribute optional bitmap8 occupancy = 2;
readonly attribute optional OccupancyBitmap occupancy = 2;
readonly attribute optional temperature absMinHeatSetpointLimit = 3;
readonly attribute optional temperature absMaxHeatSetpointLimit = 4;
readonly attribute optional temperature absMinCoolSetpointLimit = 5;
readonly attribute optional temperature absMaxCoolSetpointLimit = 6;
readonly attribute optional int8u PICoolingDemand = 7;
readonly attribute optional int8u PIHeatingDemand = 8;
attribute access(write: manage) optional bitmap8 HVACSystemTypeConfiguration = 9;
attribute access(write: manage) optional HVACSystemTypeBitmap HVACSystemTypeConfiguration = 9;
attribute access(write: manage) optional int8s localTemperatureCalibration = 16;
attribute optional int16s occupiedCoolingSetpoint = 17;
attribute optional int16s occupiedHeatingSetpoint = 18;
attribute optional int16s unoccupiedCoolingSetpoint = 19;
attribute optional int16s unoccupiedHeatingSetpoint = 20;
attribute access(write: manage) optional int16s minHeatSetpointLimit = 21;
attribute access(write: manage) optional int16s maxHeatSetpointLimit = 22;
attribute access(write: manage) optional int16s minCoolSetpointLimit = 23;
attribute access(write: manage) optional int16s maxCoolSetpointLimit = 24;
attribute optional temperature occupiedCoolingSetpoint = 17;
attribute optional temperature occupiedHeatingSetpoint = 18;
attribute optional temperature unoccupiedCoolingSetpoint = 19;
attribute optional temperature unoccupiedHeatingSetpoint = 20;
attribute access(write: manage) optional temperature minHeatSetpointLimit = 21;
attribute access(write: manage) optional temperature maxHeatSetpointLimit = 22;
attribute access(write: manage) optional temperature minCoolSetpointLimit = 23;
attribute access(write: manage) optional temperature maxCoolSetpointLimit = 24;
attribute access(write: manage) optional int8s minSetpointDeadBand = 25;
attribute access(write: manage) optional RemoteSensingBitmap remoteSensing = 26;
attribute access(write: manage) ControlSequenceOfOperationEnum controlSequenceOfOperation = 27;
Expand Down Expand Up @@ -1529,9 +1538,7 @@ cluster Thermostat = 513 {
readonly attribute optional nullable octet_string<16> activeScheduleHandle = 79;
attribute access(write: manage) optional PresetStruct presets[] = 80;
attribute access(write: manage) optional ScheduleStruct schedules[] = 81;
readonly attribute optional boolean presetsSchedulesEditable = 82;
readonly attribute optional TemperatureSetpointHoldPolicyBitmap temperatureSetpointHoldPolicy = 83;
readonly attribute optional nullable epoch_s setpointHoldExpiryTimestamp = 84;
readonly attribute optional nullable epoch_s setpointHoldExpiryTimestamp = 82;
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute event_id eventList[] = 65530;
Expand Down Expand Up @@ -1571,34 +1578,32 @@ cluster Thermostat = 513 {
octet_string<16> presetHandle = 0;
}

request struct StartPresetsSchedulesEditRequestRequest {
int16u timeoutSeconds = 0;
response struct AtomicResponse = 253 {
status statusCode = 0;
AtomicAttributeStatusStruct attributeStatus[] = 1;
optional int16u timeout = 2;
}

request struct SetTemperatureSetpointHoldPolicyRequest {
TemperatureSetpointHoldPolicyBitmap temperatureSetpointHoldPolicy = 0;
request struct AtomicRequestRequest {
AtomicRequestTypeEnum requestType = 0;
attrib_id attributeRequests[] = 1;
optional int16u timeout = 2;
}

/** Command description for SetpointRaiseLower */
/** Upon receipt, the attributes for the indicated setpoint(s) SHALL have the amount specified in the Amount field added to them. */
command SetpointRaiseLower(SetpointRaiseLowerRequest): DefaultSuccess = 0;
/** Command description for SetWeeklySchedule */
/** Upon receipt, the weekly schedule for updating setpoints SHALL be stored in the */
command access(invoke: manage) SetWeeklySchedule(SetWeeklyScheduleRequest): DefaultSuccess = 1;
/** Command description for GetWeeklySchedule */
/** Upon receipt, the unit SHOULD send in return the Get */
command GetWeeklySchedule(GetWeeklyScheduleRequest): GetWeeklyScheduleResponse = 2;
/** This command is used to clear the weekly schedule. The ClearWeeklySchedule command has no payload. */
/** This command is used to clear the weekly schedule. */
command access(invoke: manage) ClearWeeklySchedule(): DefaultSuccess = 3;
/** This command is used to set the active schedule. */
/** Upon receipt, if the */
command SetActiveScheduleRequest(SetActiveScheduleRequestRequest): DefaultSuccess = 5;
/** This command is used to set the active preset. */
/** ID */
command SetActivePresetRequest(SetActivePresetRequestRequest): DefaultSuccess = 6;
/** This command is used to start editing the presets and schedules. */
command access(invoke: manage) StartPresetsSchedulesEditRequest(StartPresetsSchedulesEditRequestRequest): DefaultSuccess = 7;
/** This command is used to cancel editing presets and schedules. */
command access(invoke: manage) CancelPresetsSchedulesEditRequest(): DefaultSuccess = 8;
/** This command is used to notify the server that all edits are done and should be committed. */
command access(invoke: manage) CommitPresetsSchedulesRequest(): DefaultSuccess = 9;
/** This command sets the set point hold policy. */
command SetTemperatureSetpointHoldPolicy(SetTemperatureSetpointHoldPolicyRequest): DefaultSuccess = 11;
/** Begins, Commits or Cancels an atomic write */
command access(invoke: manage) AtomicRequest(AtomicRequestRequest): AtomicResponse = 254;
}

/** An interface for controlling a fan in a heating/cooling system. */
Expand Down
91 changes: 48 additions & 43 deletions examples/all-clusters-app/all-clusters-common/all-clusters-app.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5021,7 +5021,7 @@ cluster PumpConfigurationAndControl = 512 {

/** An interface for configuring and controlling the functionality of a thermostat. */
cluster Thermostat = 513 {
revision 6;
revision 7;

enum ACCapacityFormatEnum : enum8 {
kBTUh = 0;
Expand Down Expand Up @@ -5057,6 +5057,12 @@ cluster Thermostat = 513 {
kHeatPumpInverter = 4;
}

enum AtomicRequestTypeEnum : enum8 {
kBeginWrite = 0;
kCommitWrite = 1;
kRollbackWrite = 2;
}

enum ControlSequenceOfOperationEnum : enum8 {
kCoolingOnly = 0;
kCoolingWithReheat = 1;
Expand All @@ -5067,13 +5073,13 @@ cluster Thermostat = 513 {
}

enum PresetScenarioEnum : enum8 {
kUnspecified = 0;
kOccupied = 1;
kUnoccupied = 2;
kSleep = 3;
kWake = 4;
kVacation = 5;
kUserDefined = 6;
kGoingToSleep = 6;
kUserDefined = 254;
}

enum SetpointChangeSourceEnum : enum8 {
Expand Down Expand Up @@ -5139,7 +5145,6 @@ cluster Thermostat = 513 {
kLocalTemperatureNotExposed = 0x40;
kMatterScheduleConfiguration = 0x80;
kPresets = 0x100;
kSetpoints = 0x200;
}

bitmap HVACSystemTypeBitmap : bitmap8 {
Expand All @@ -5149,6 +5154,10 @@ cluster Thermostat = 513 {
kHeatingUsesFuel = 0x20;
}

bitmap OccupancyBitmap : bitmap8 {
kOccupied = 0x1;
}

bitmap PresetTypeFeaturesBitmap : bitmap16 {
kAutomatic = 0x1;
kSupportsNames = 0x2;
Expand Down Expand Up @@ -5199,11 +5208,6 @@ cluster Thermostat = 513 {
kSupportsOff = 0x8;
}

bitmap TemperatureSetpointHoldPolicyBitmap : bitmap8 {
kHoldDurationElapsed = 0x1;
kHoldDurationElapsedOrPresetChanged = 0x2;
}

struct ScheduleTransitionStruct {
ScheduleDayOfWeekBitmap dayOfWeek = 0;
int16u transitionTime = 1;
Expand All @@ -5219,7 +5223,12 @@ cluster Thermostat = 513 {
optional char_string<64> name = 2;
optional octet_string<16> presetHandle = 3;
ScheduleTransitionStruct transitions[] = 4;
optional nullable boolean builtIn = 5;
nullable boolean builtIn = 5;
}

struct AtomicAttributeStatusStruct {
optional attrib_id attributeID = 0;
optional status statusCode = 1;
}

struct PresetStruct {
Expand Down Expand Up @@ -5251,23 +5260,23 @@ cluster Thermostat = 513 {

readonly attribute nullable temperature localTemperature = 0;
readonly attribute optional nullable temperature outdoorTemperature = 1;
readonly attribute optional bitmap8 occupancy = 2;
readonly attribute optional OccupancyBitmap occupancy = 2;
readonly attribute optional temperature absMinHeatSetpointLimit = 3;
readonly attribute optional temperature absMaxHeatSetpointLimit = 4;
readonly attribute optional temperature absMinCoolSetpointLimit = 5;
readonly attribute optional temperature absMaxCoolSetpointLimit = 6;
readonly attribute optional int8u PICoolingDemand = 7;
readonly attribute optional int8u PIHeatingDemand = 8;
attribute access(write: manage) optional bitmap8 HVACSystemTypeConfiguration = 9;
attribute access(write: manage) optional HVACSystemTypeBitmap HVACSystemTypeConfiguration = 9;
attribute access(write: manage) optional int8s localTemperatureCalibration = 16;
attribute optional int16s occupiedCoolingSetpoint = 17;
attribute optional int16s occupiedHeatingSetpoint = 18;
attribute optional int16s unoccupiedCoolingSetpoint = 19;
attribute optional int16s unoccupiedHeatingSetpoint = 20;
attribute access(write: manage) optional int16s minHeatSetpointLimit = 21;
attribute access(write: manage) optional int16s maxHeatSetpointLimit = 22;
attribute access(write: manage) optional int16s minCoolSetpointLimit = 23;
attribute access(write: manage) optional int16s maxCoolSetpointLimit = 24;
attribute optional temperature occupiedCoolingSetpoint = 17;
attribute optional temperature occupiedHeatingSetpoint = 18;
attribute optional temperature unoccupiedCoolingSetpoint = 19;
attribute optional temperature unoccupiedHeatingSetpoint = 20;
attribute access(write: manage) optional temperature minHeatSetpointLimit = 21;
attribute access(write: manage) optional temperature maxHeatSetpointLimit = 22;
attribute access(write: manage) optional temperature minCoolSetpointLimit = 23;
attribute access(write: manage) optional temperature maxCoolSetpointLimit = 24;
attribute access(write: manage) optional int8s minSetpointDeadBand = 25;
attribute access(write: manage) optional RemoteSensingBitmap remoteSensing = 26;
attribute access(write: manage) ControlSequenceOfOperationEnum controlSequenceOfOperation = 27;
Expand Down Expand Up @@ -5308,9 +5317,7 @@ cluster Thermostat = 513 {
readonly attribute optional nullable octet_string<16> activeScheduleHandle = 79;
attribute access(write: manage) optional PresetStruct presets[] = 80;
attribute access(write: manage) optional ScheduleStruct schedules[] = 81;
readonly attribute optional boolean presetsSchedulesEditable = 82;
readonly attribute optional TemperatureSetpointHoldPolicyBitmap temperatureSetpointHoldPolicy = 83;
readonly attribute optional nullable epoch_s setpointHoldExpiryTimestamp = 84;
readonly attribute optional nullable epoch_s setpointHoldExpiryTimestamp = 82;
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute event_id eventList[] = 65530;
Expand Down Expand Up @@ -5350,34 +5357,32 @@ cluster Thermostat = 513 {
octet_string<16> presetHandle = 0;
}

request struct StartPresetsSchedulesEditRequestRequest {
int16u timeoutSeconds = 0;
response struct AtomicResponse = 253 {
status statusCode = 0;
AtomicAttributeStatusStruct attributeStatus[] = 1;
optional int16u timeout = 2;
}

request struct SetTemperatureSetpointHoldPolicyRequest {
TemperatureSetpointHoldPolicyBitmap temperatureSetpointHoldPolicy = 0;
request struct AtomicRequestRequest {
AtomicRequestTypeEnum requestType = 0;
attrib_id attributeRequests[] = 1;
optional int16u timeout = 2;
}

/** Command description for SetpointRaiseLower */
/** Upon receipt, the attributes for the indicated setpoint(s) SHALL have the amount specified in the Amount field added to them. */
command SetpointRaiseLower(SetpointRaiseLowerRequest): DefaultSuccess = 0;
/** Command description for SetWeeklySchedule */
/** Upon receipt, the weekly schedule for updating setpoints SHALL be stored in the */
command access(invoke: manage) SetWeeklySchedule(SetWeeklyScheduleRequest): DefaultSuccess = 1;
/** Command description for GetWeeklySchedule */
/** Upon receipt, the unit SHOULD send in return the Get */
command GetWeeklySchedule(GetWeeklyScheduleRequest): GetWeeklyScheduleResponse = 2;
/** This command is used to clear the weekly schedule. The ClearWeeklySchedule command has no payload. */
/** This command is used to clear the weekly schedule. */
command access(invoke: manage) ClearWeeklySchedule(): DefaultSuccess = 3;
/** This command is used to set the active schedule. */
/** Upon receipt, if the */
command SetActiveScheduleRequest(SetActiveScheduleRequestRequest): DefaultSuccess = 5;
/** This command is used to set the active preset. */
/** ID */
command SetActivePresetRequest(SetActivePresetRequestRequest): DefaultSuccess = 6;
/** This command is used to start editing the presets and schedules. */
command access(invoke: manage) StartPresetsSchedulesEditRequest(StartPresetsSchedulesEditRequestRequest): DefaultSuccess = 7;
/** This command is used to cancel editing presets and schedules. */
command access(invoke: manage) CancelPresetsSchedulesEditRequest(): DefaultSuccess = 8;
/** This command is used to notify the server that all edits are done and should be committed. */
command access(invoke: manage) CommitPresetsSchedulesRequest(): DefaultSuccess = 9;
/** This command sets the set point hold policy. */
command SetTemperatureSetpointHoldPolicy(SetTemperatureSetpointHoldPolicyRequest): DefaultSuccess = 11;
/** Begins, Commits or Cancels an atomic write */
command access(invoke: manage) AtomicRequest(AtomicRequestRequest): AtomicResponse = 254;
}

/** An interface for controlling a fan in a heating/cooling system. */
Expand Down Expand Up @@ -8681,8 +8686,6 @@ endpoint 1 {
ram attribute activeScheduleHandle;
callback attribute presets;
callback attribute schedules;
ram attribute presetsSchedulesEditable;
ram attribute temperatureSetpointHoldPolicy default = 0;
ram attribute setpointHoldExpiryTimestamp;
callback attribute generatedCommandList;
callback attribute acceptedCommandList;
Expand All @@ -8692,6 +8695,8 @@ endpoint 1 {
ram attribute clusterRevision default = 6;

handle command SetpointRaiseLower;
handle command AtomicResponse;
handle command AtomicRequest;
}

server cluster FanControl {
Expand Down
Loading
Loading