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

Jump to bottom

Update the preset handle field in the SetActivePresetRequest c… #35105

Merged
merged 5 commits into from
Aug 21, 2024
Merged

Update the preset handle field in the SetActivePresetRequest c… #35105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c39518
Update the preset handle field in the SetActivePresetRequestRequest c…
nivi-apple Aug 20, 2024
fc04bb3
Merge remote-tracking branch 'upstream/master' into make_set_active_p…
nivi-apple Aug 20, 2024
f6f131e
Return error if CopySpanToMutableSpan fails
nivi-apple Aug 20, 2024
e14bf1d
Restyled by clang-format
restyled-commits Aug 20, 2024
8370468
Apply suggestions from code review
nivi-apple Aug 20, 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: 1 addition & 1 deletion 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 @@ -1856,7 +1856,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -5696,7 +5696,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4130,7 +4130,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion ...irpurifier_airqualitysensor_temperaturesensor_humiditysensor_thermostat_56de3d5f45.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1779,7 +1779,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/chef/devices/rootnode_heatingcoolingunit_ncdGai1E5a.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2136,7 +2136,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/chef/devices/rootnode_roomairconditioner_9cf3607804.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1719,7 +1719,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/chef/devices/rootnode_thermostat_bm3fb8dhYi.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1939,7 +1939,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
4 changes: 2 additions & 2 deletions examples/placeholder/linux/apps/app1/config.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5414,7 +5414,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down Expand Up @@ -5769,7 +5769,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
4 changes: 2 additions & 2 deletions examples/placeholder/linux/apps/app2/config.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5371,7 +5371,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down Expand Up @@ -5726,7 +5726,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/thermostat/linux/include/thermostat-delegate-impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class ThermostatDelegate : public Delegate

CHIP_ERROR GetPresetAtIndex(size_t index, PresetStructWithOwnedMembers & preset) override;

CHIP_ERROR GetActivePresetHandle(MutableByteSpan & activePresetHandle) override;
CHIP_ERROR GetActivePresetHandle(DataModel::Nullable<MutableByteSpan> & activePresetHandle) override;

CHIP_ERROR SetActivePresetHandle(const DataModel::Nullable<ByteSpan> & newActivePresetHandle) override;

Expand Down
14 changes: 12 additions & 2 deletions examples/thermostat/linux/thermostat-delegate-impl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,19 @@ CHIP_ERROR ThermostatDelegate::GetPresetAtIndex(size_t index, PresetStructWithOw
return CHIP_ERROR_PROVIDER_LIST_EXHAUSTED;
}

CHIP_ERROR ThermostatDelegate::GetActivePresetHandle(MutableByteSpan & activePresetHandle)
CHIP_ERROR ThermostatDelegate::GetActivePresetHandle(DataModel::Nullable<MutableByteSpan> & activePresetHandle)
{
return CopySpanToMutableSpan(ByteSpan(mActivePresetHandleData, mActivePresetHandleDataSize), activePresetHandle);
if (mActivePresetHandleDataSize != 0)
{
ReturnErrorOnFailure(
CopySpanToMutableSpan(ByteSpan(mActivePresetHandleData, mActivePresetHandleDataSize), activePresetHandle.Value()));
activePresetHandle.Value().reduce_size(mActivePresetHandleDataSize);
}
else
{
activePresetHandle.SetNull();
}
return CHIP_NO_ERROR;
}

CHIP_ERROR ThermostatDelegate::SetActivePresetHandle(const DataModel::Nullable<ByteSpan> & newActivePresetHandle)
Expand Down
2 changes: 1 addition & 1 deletion examples/thermostat/nxp/zap/thermostat_matter_thread.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2530,7 +2530,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/thermostat/nxp/zap/thermostat_matter_wifi.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2441,7 +2441,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/thermostat/qpg/zap/thermostaticRadiatorValve.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2138,7 +2138,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
2 changes: 1 addition & 1 deletion examples/thermostat/thermostat-common/thermostat.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2318,7 +2318,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
7 changes: 3 additions & 4 deletions src/app/clusters/thermostat-server/thermostat-delegate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,10 @@ class Delegate
/**
* @brief Get the ActivePresetHandle attribute value.
*
* @param[out] activePresetHandle The MutableByteSpan to copy the active preset handle into. On success,
* the callee must update the length to the length of the copied data. If the value of
* the attribute is null, the callee must set the MutableByteSpan to empty.
* @param[out] activePresetHandle The nullable MutableByteSpan to copy the active preset handle into. On success,
* the size of the activePresetHandle is updated to the length of the copied data.
*/
virtual CHIP_ERROR GetActivePresetHandle(MutableByteSpan & activePresetHandle) = 0;
virtual CHIP_ERROR GetActivePresetHandle(DataModel::Nullable<MutableByteSpan> & activePresetHandle) = 0;
nivi-apple marked this conversation as resolved.
Show resolved Hide resolved

/**
* @brief Set the ActivePresetHandle attribute value.
Expand Down
25 changes: 10 additions & 15 deletions src/app/clusters/thermostat-server/thermostat-server.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -761,19 +761,13 @@ CHIP_ERROR ThermostatAttrAccess::Read(const ConcreteReadAttributePath & aPath, A
VerifyOrReturnError(delegate != nullptr, CHIP_ERROR_INCORRECT_STATE, ChipLogError(Zcl, "Delegate is null"));

uint8_t buffer[kPresetHandleSize];
MutableByteSpan activePresetHandle(buffer);
MutableByteSpan activePresetHandleSpan(buffer);
auto activePresetHandle = DataModel::MakeNullable(activePresetHandleSpan);

CHIP_ERROR err = delegate->GetActivePresetHandle(activePresetHandle);
ReturnErrorOnFailure(err);

if (activePresetHandle.empty())
{
ReturnErrorOnFailure(aEncoder.EncodeNull());
}
else
{
ReturnErrorOnFailure(aEncoder.Encode(activePresetHandle));
}
ReturnErrorOnFailure(aEncoder.Encode(activePresetHandle));
}
break;
case ScheduleTypes::Id: {
Expand Down Expand Up @@ -1299,16 +1293,16 @@ bool emberAfThermostatClusterSetActivePresetRequestCallback(
return true;
}

ByteSpan newPresetHandle = commandData.presetHandle;
DataModel::Nullable<ByteSpan> newPresetHandle = commandData.presetHandle;

// If the preset handle passed in the command is not present in the Presets attribute, return INVALID_COMMAND.
if (!IsPresetHandlePresentInPresets(delegate, newPresetHandle))
if (!newPresetHandle.IsNull() && !IsPresetHandlePresentInPresets(delegate, newPresetHandle.Value()))
{
commandObj->AddStatus(commandPath, imcode::InvalidCommand);
return true;
}

CHIP_ERROR err = delegate->SetActivePresetHandle(DataModel::MakeNullable(newPresetHandle));
CHIP_ERROR err = delegate->SetActivePresetHandle(newPresetHandle);

if (err != CHIP_NO_ERROR)
{
Expand Down Expand Up @@ -1470,7 +1464,8 @@ imcode commitPresets(Delegate * delegate, EndpointId endpoint)
// attribute. If a preset is not found with the same presetHandle, return INVALID_IN_STATE. If there is no ActivePresetHandle
// attribute set, continue with other checks.
uint8_t buffer[kPresetHandleSize];
MutableByteSpan activePresetHandle(buffer);
MutableByteSpan activePresetHandleSpan(buffer);
auto activePresetHandle = DataModel::MakeNullable(activePresetHandleSpan);

err = delegate->GetActivePresetHandle(activePresetHandle);

Expand All @@ -1479,9 +1474,9 @@ imcode commitPresets(Delegate * delegate, EndpointId endpoint)
return imcode::InvalidInState;
}

if (!activePresetHandle.empty())
if (!activePresetHandle.IsNull())
{
uint8_t count = CountPresetsInPendingListWithPresetHandle(delegate, activePresetHandle);
uint8_t count = CountPresetsInPendingListWithPresetHandle(delegate, activePresetHandle.Value());
if (count == 0)
{
return imcode::InvalidInState;
Expand Down
2 changes: 1 addition & 1 deletion src/app/zap-templates/zcl/data-model/chip/thermostat-cluster.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ limitations under the License.

<command source="client" code="0x06" name="SetActivePresetRequest" optional="true">
<description>ID</description>
<arg id="0" name="PresetHandle" type="octet_string" length="16"/>
<arg id="0" name="PresetHandle" type="octet_string" length="16" isNullable="true"/>
</command>

<!-- Server Commands/Responses -->
Expand Down
2 changes: 1 addition & 1 deletion src/controller/data_model/controller-clusters.matter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6994,7 +6994,7 @@ cluster Thermostat = 513 {
}

request struct SetActivePresetRequestRequest {
octet_string<16> presetHandle = 0;
nullable octet_string<16> presetHandle = 0;
}

response struct AtomicResponse = 253 {
Expand Down
6 changes: 3 additions & 3 deletions src/controller/java/generated/java/chip/devicecontroller/ChipClusters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40637,16 +40637,16 @@ public void onResponse(StructType invokeStructValue) {
}}, commandId, commandArgs, timedInvokeTimeoutMs);
}

public void setActivePresetRequest(DefaultClusterCallback callback, byte[] presetHandle) {
public void setActivePresetRequest(DefaultClusterCallback callback, @Nullable byte[] presetHandle) {
setActivePresetRequest(callback, presetHandle, 0);
}

public void setActivePresetRequest(DefaultClusterCallback callback, byte[] presetHandle, int timedInvokeTimeoutMs) {
public void setActivePresetRequest(DefaultClusterCallback callback, @Nullable byte[] presetHandle, int timedInvokeTimeoutMs) {
final long commandId = 6L;

ArrayList<StructElement> elements = new ArrayList<>();
final long presetHandleFieldID = 0L;
BaseTLVType presetHandletlvValue = new ByteArrayType(presetHandle);
BaseTLVType presetHandletlvValue = presetHandle != null ? new ByteArrayType(presetHandle) : new NullType();
elements.add(new StructElement(presetHandleFieldID, presetHandletlvValue));

StructType commandArgs = new StructType(elements);
Expand Down
4 changes: 2 additions & 2 deletions src/controller/java/generated/java/matter/controller/cluster/clusters/ThermostatCluster.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ class ThermostatCluster(private val controller: MatterController, private val en
}

suspend fun setActivePresetRequest(
presetHandle: ByteArray,
presetHandle: ByteArray?,
timedInvokeTimeout: Duration? = null,
) {
val commandId: UInt = 6u
Expand All @@ -513,7 +513,7 @@ class ThermostatCluster(private val controller: MatterController, private val en
tlvWriter.startStructure(AnonymousTag)

val TAG_PRESET_HANDLE_REQ: Int = 0
tlvWriter.put(ContextSpecificTag(TAG_PRESET_HANDLE_REQ), presetHandle)
presetHandle?.let { tlvWriter.put(ContextSpecificTag(TAG_PRESET_HANDLE_REQ), presetHandle) }
tlvWriter.endStructure()

val request: InvokeRequest =
Expand Down
4 changes: 2 additions & 2 deletions src/controller/python/chip/clusters/Objects.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/darwin/Framework/CHIP/zap-generated/MTRCommandPayloadsObjc.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions src/darwin/Framework/CHIP/zap-generated/MTRCommandPayloadsObjc.mm
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions zzz_generated/app-common/app-common/zap-generated/cluster-objects.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion zzz_generated/darwin-framework-tool/zap-generated/cluster/Commands.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading