src/app/clusters/identify/identify.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/basic-types.h>
  21
  22 /** @brief Start Feedback.
  23  *
  24  * This function is called by the Identify plugin when identification begins.
  25  * It informs the Identify Feedback plugin that it should begin providing its
  26  * implemented feedback functionality (e.g. LED blinking, buzzer sounding, etc.)
  27  * until the Identify plugin tells it to stop.
  28  * The identify time is purely a matter of informational convenience; this plugin
  29  * does not need to know how long it will identify (the Identify plugin will
  30  * perform the necessary timekeeping.)
  31  *
  32  * @param endpoint The endpoint.  Ver.: always
  33  * @param identityTime  Ver.: always
  34  */
  35 bool emberAfPluginIdentifyStartFeedbackCallback(chip::EndpointId endpoint, uint16_t identifyTime);
  36
  37 /** @brief Stop Feedback.
  38  *
  39  * This function is called by the Identify plugin when identification is finished.
  40  * It tells the Identify Feedback plugin to stop providing its implemented feedback
  41  * functionality.
  42  *
  43  * @param endpoint The endpoint.  Ver.: always
  44  */
  45 bool emberAfPluginIdentifyStopFeedbackCallback(chip::EndpointId endpoint);