src/app/clusters/on-off-server/on-off.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <app/util/af-types.h>
  21 #include <app/util/basic-types.h>
  22
  23 /** @brief On/off Cluster Set Value
  24  *
  25  * This function is called when the on/off value needs to be set, either through
  26  * normal channels or as a result of a level change.
  27  *
  28  * @param endpoint   Ver.: always
  29  * @param command   Ver.: always
  30  * @param initiatedByLevelChange   Ver.: always
  31  */
  32 EmberAfStatus emberAfOnOffClusterSetValueCallback(chip::EndpointId endpoint, uint8_t command, bool initiatedByLevelChange);
  33
  34 /** @brief On/off Cluster Level Control Effect
  35  *
  36  * This is called by the framework when the on/off cluster initiates a command
  37  * that must effect a level control change. The implementation assumes that the
  38  * client will handle any effect on the On/Off Cluster.
  39  *
  40  * @param endpoint   Ver.: always
  41  * @param newValue   Ver.: always
  42  */
  43 void emberAfOnOffClusterLevelControlEffectCallback(chip::EndpointId endpoint, bool newValue);
  44
  45 /** @brief On/off Cluster Server Post Init
  46  *
  47  * Following resolution of the On/Off state at startup for this endpoint,
  48  * perform any additional initialization needed; e.g., synchronize hardware
  49  * state.
  50  *
  51  * @param endpoint Endpoint that is being initialized  Ver.: always
  52  */
  53 void emberAfPluginOnOffClusterServerPostInitCallback(chip::EndpointId endpoint);