| {{> header excludeZapComment=true}} |
| |
| #import <Foundation/Foundation.h> |
| |
| #import "MTRClusterStateCacheContainer_Internal.h" |
| #import "MTRBaseClusters_internal.h" |
| #import "MTRBaseDevice.h" |
| #import "MTRBaseDevice_Internal.h" |
| #import "MTRCallbackBridge_internal.h" |
| #import "MTRCluster_internal.h" |
| #import "MTRStructsObjc.h" |
| #import "MTRCommandPayloadsObjc.h" |
| |
| #include <lib/support/CHIPListUtils.h> |
| #include <platform/CHIPDeviceLayer.h> |
| #include <type_traits> |
| |
| using chip::Callback::Callback; |
| using chip::Callback::Cancelable; |
| using namespace chip::app::Clusters; |
| using chip::Messaging::ExchangeManager; |
| using chip::SessionHandle; |
| |
| // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks): Linter is unable to locate the delete on these objects. |
| {{#chip_client_clusters includeAll=true}} |
| @implementation MTRBaseCluster{{asUpperCamelCase name preserveAcronyms=true}} |
| |
| - (instancetype)initWithDevice:(MTRBaseDevice *)device endpoint:(NSNumber *)endpoint queue:(dispatch_queue_t)queue |
| { |
| if (self = [super initWithQueue:queue]) { |
| if (device == nil) { |
| return nil; |
| } |
| |
| _device = device; |
| {{!TODO consider range-checking the incoming number to make sure it's |
| actually in the uint16_t range}} |
| _endpoint = [endpoint unsignedShortValue]; |
| } |
| return self; |
| } |
| |
| {{#chip_cluster_commands}} |
| {{#*inline "cluster"}}{{asUpperCamelCase parent.name preserveAcronyms=true}}{{/inline}} |
| {{#*inline "command"}}{{asUpperCamelCase name preserveAcronyms=true}}{{/inline}} |
| {{#*inline "callbackName"}}{{#if hasSpecificResponse}}{{>cluster}}Cluster{{asUpperCamelCase responseName preserveAcronyms=true}}{{else}}CommandSuccess{{/if}}{{/inline}} |
| {{#unless (hasArguments)}} |
| - (void){{asLowerCamelCase name}}WithCompletion:({{>command_completion_type command=.}})completion |
| { |
| [self {{asLowerCamelCase name}}WithParams:nil completion:completion]; |
| } |
| {{/unless}} |
| - (void){{asLowerCamelCase name}}WithParams: (MTR{{>cluster}}Cluster{{>command}}Params * {{#unless (commandHasRequiredField .)}}_Nullable{{/unless}})params completion:({{>command_completion_type command=.}})completion |
| { |
| // Make a copy of params before we go async. |
| params = [params copy]; |
| new MTR{{>callbackName}}CallbackBridge(self.callbackQueue, |
| self.device, |
| {{#if hasSpecificResponse}} |
| {{! This treats completion as taking an id for the data. This is |
| not great from a type-safety perspective, of course. }} |
| completion, |
| {{else}} |
| {{! For now, don't change the bridge API; instead just use an adapter |
| to invoke our completion handler. This is not great from a |
| type-safety perspective, of course. }} |
| ^(id _Nullable value, NSError * _Nullable error) { |
| completion(error); |
| }, |
| {{/if}} |
| ^(ExchangeManager & exchangeManager, const SessionHandle & session, Cancelable * success, Cancelable * failure) { |
| chip::Optional<uint16_t> timedInvokeTimeoutMs; |
| ListFreer listFreer; |
| {{asUpperCamelCase parent.name}}::Commands::{{asUpperCamelCase name}}::Type request; |
| if (params != nil) { |
| if (params.timedInvokeTimeoutMs != nil) { |
| timedInvokeTimeoutMs.SetValue(params.timedInvokeTimeoutMs.unsignedShortValue); |
| } |
| } |
| {{#if mustUseTimedInvoke}} |
| if (!timedInvokeTimeoutMs.HasValue()) { |
| timedInvokeTimeoutMs.SetValue(10000); |
| } |
| {{/if}} |
| {{#chip_cluster_command_arguments}} |
| {{#first}} |
| {{#unless (commandHasRequiredField parent)}} |
| if (params != nil) { |
| {{/unless}} |
| {{/first}} |
| {{>encode_value target=(concat "request." (asLowerCamelCase label)) source=(concat "params." (asStructPropertyName label)) cluster=parent.parent.name errorCode="return CHIP_ERROR_INVALID_ARGUMENT;" depth=0}} |
| {{#last}} |
| {{#unless (commandHasRequiredField parent)}} |
| } |
| {{/unless}} |
| {{/last}} |
| {{/chip_cluster_command_arguments}} |
| |
| auto successFn = Callback<{{>callbackName}}CallbackType>::FromCancelable(success); |
| auto failureFn = Callback<DefaultFailureCallbackType>::FromCancelable(failure); |
| chip::Controller::{{asUpperCamelCase parent.name}}Cluster cppCluster(exchangeManager, session, self->_endpoint); |
| return cppCluster.InvokeCommand(request, successFn->mContext, successFn->mCall, failureFn->mCall, timedInvokeTimeoutMs); |
| }); |
| } |
| {{/chip_cluster_commands}} |
| |
| {{#chip_server_cluster_attributes}} |
| {{#*inline "attribute"}}Attribute{{asUpperCamelCase name preserveAcronyms=true}}{{/inline}} |
| - (void)read{{>attribute}}With |
| {{~#if_is_fabric_scoped_struct type~}} |
| Params:(MTRReadParams * _Nullable)params completion: |
| {{~else~}} |
| Completion: |
| {{~/if_is_fabric_scoped_struct~}} |
| (void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completion |
| { |
| {{~#if_is_fabric_scoped_struct type}} |
| // Make a copy of params before we go async. |
| params = [params copy]; |
| {{/if_is_fabric_scoped_struct~}} |
| new MTR{{~>attribute_data_callback_name~}}CallbackBridge(self.callbackQueue, |
| self.device, |
| {{! This treats completion as taking an id for the data. This is |
| not great from a type-safety perspective, of course. }} |
| completion, |
| ^(ExchangeManager & exchangeManager, const SessionHandle & session, Cancelable * success, Cancelable * failure) { |
| using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo; |
| auto successFn = Callback<{{>attribute_data_callback_name}}Callback>::FromCancelable(success); |
| auto failureFn = Callback<DefaultFailureCallbackType>::FromCancelable(failure); |
| chip::Controller::{{asUpperCamelCase parent.name}}Cluster cppCluster(exchangeManager, session, self->_endpoint); |
| return cppCluster.ReadAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall |
| {{~#if_is_fabric_scoped_struct type~}} |
| , params.fabricFiltered |
| {{~/if_is_fabric_scoped_struct~}} |
| ); |
| }); |
| } |
| |
| {{#if isWritableAttribute}} |
| {{#*inline "callbackName"}}DefaultSuccess{{/inline}} |
| - (void)write{{>attribute}}WithValue:({{asObjectiveCType type parent.name}})value completion:(MTRStatusCompletion)completion |
| { |
| [self write{{>attribute}}WithValue:({{asObjectiveCType type parent.name}})value params:nil completion:completion]; |
| } |
| - (void)write{{>attribute}}WithValue:({{asObjectiveCType type parent.name}})value params:(MTRWriteParams * _Nullable)params completion:(MTRStatusCompletion)completion |
| { |
| // Make a copy of params before we go async. |
| params = [params copy]; |
| value = [value copy]; |
| |
| new MTR{{>callbackName}}CallbackBridge(self.callbackQueue, |
| self.device, |
| {{! For now, don't change the bridge API; instead just use an adapter |
| to invoke our completion handler. This is not great from a |
| type-safety perspective, of course. }} |
| ^(id _Nullable ignored, NSError * _Nullable error) { |
| completion(error); |
| }, |
| ^(ExchangeManager & exchangeManager, const SessionHandle & session, Cancelable * success, Cancelable * failure) { |
| chip::Optional<uint16_t> timedWriteTimeout; |
| if (params != nil) { |
| if (params.timedWriteTimeout != nil){ |
| timedWriteTimeout.SetValue(params.timedWriteTimeout.unsignedShortValue); |
| } |
| } |
| {{#if mustUseTimedInvoke}} |
| if (!timedWriteTimeout.HasValue()) { |
| timedWriteTimeout.SetValue(10000); |
| } |
| {{/if}} |
| |
| ListFreer listFreer; |
| using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo; |
| TypeInfo::Type cppValue; |
| {{>encode_value target="cppValue" source="value" cluster=parent.name errorCode="return CHIP_ERROR_INVALID_ARGUMENT;" depth=0}} |
| auto successFn = Callback<{{>callbackName}}CallbackType>::FromCancelable(success); |
| auto failureFn = Callback<DefaultFailureCallbackType>::FromCancelable(failure); |
| |
| chip::Controller::{{asUpperCamelCase parent.name}}Cluster cppCluster(exchangeManager, session, self->_endpoint); |
| return cppCluster.WriteAttribute<TypeInfo>(cppValue, successFn->mContext, successFn->mCall, failureFn->mCall, timedWriteTimeout); |
| }); |
| |
| } |
| |
| {{/if}} |
| {{#if isReportableAttribute}} |
| - (void) subscribe{{>attribute}}WithParams:(MTRSubscribeParams * _Nonnull)params |
| subscriptionEstablished:(MTRSubscriptionEstablishedHandler _Nullable)subscriptionEstablished |
| reportHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))reportHandler |
| { |
| // Make a copy of params before we go async. |
| params = [params copy]; |
| new MTR{{>attribute_data_callback_name}}CallbackSubscriptionBridge(self.callbackQueue, |
| self.device, |
| {{! This treats reportHandler as taking an id for the data. This is |
| not great from a type-safety perspective, of course. }} |
| reportHandler, |
| ^(ExchangeManager & exchangeManager, const SessionHandle & session, Cancelable * success, Cancelable * failure) { |
| if (!params.autoResubscribe) { |
| // We don't support disabling auto-resubscribe. |
| return CHIP_ERROR_INVALID_ARGUMENT; |
| } |
| using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo; |
| auto successFn = Callback<{{>attribute_data_callback_name}}Callback>::FromCancelable(success); |
| auto failureFn = Callback<DefaultFailureCallbackType>::FromCancelable(failure); |
| |
| chip::Controller::{{asUpperCamelCase parent.name}}Cluster cppCluster(exchangeManager, session, self->_endpoint); |
| return cppCluster.SubscribeAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall, [params.minInterval unsignedShortValue], [params.maxInterval unsignedShortValue], MTR{{>attribute_data_callback_name}}CallbackSubscriptionBridge::OnSubscriptionEstablished, nil, |
| params.fabricFiltered, |
| params.keepPreviousSubscriptions |
| ); |
| }, subscriptionEstablished); |
| } |
| |
| + (void) read{{>attribute}}WithClusterStateCache:(MTRClusterStateCacheContainer *)clusterStateCacheContainer endpoint:(NSNumber *)endpoint queue:(dispatch_queue_t)queue completion:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completion |
| { |
| new MTR{{>attribute_data_callback_name}}CallbackBridge(queue, |
| completion, |
| ^(Cancelable * success, Cancelable * failure) { |
| if (clusterStateCacheContainer.cppClusterStateCache) { |
| chip::app::ConcreteAttributePath path; |
| using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo; |
| path.mEndpointId = static_cast<chip::EndpointId>([endpoint unsignedShortValue]); |
| path.mClusterId = TypeInfo::GetClusterId(); |
| path.mAttributeId = TypeInfo::GetAttributeId(); |
| TypeInfo::DecodableType value; |
| CHIP_ERROR err = clusterStateCacheContainer.cppClusterStateCache->Get<TypeInfo>(path, value); |
| auto successFn = Callback<{{>attribute_data_callback_name}}Callback>::FromCancelable(success); |
| if (err == CHIP_NO_ERROR) |
| { |
| successFn->mCall(successFn->mContext, value); |
| } |
| return err; |
| } |
| return CHIP_ERROR_NOT_FOUND; |
| }); |
| } |
| |
| {{/if}} |
| {{/chip_server_cluster_attributes}} |
| |
| @end |
| |
| {{/chip_client_clusters}} |
| // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks) |
