zigbee-daemon/zigbee-lib/include/zblib_driver_zcl_scene.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
   3  *
   4  * Contact: Suresh Kumar N (suresh.n@samsung.com)
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #ifndef __ZIGBEE_LIB_DRIVER_ZCL_SCENE_H__
  20 #define __ZIGBEE_LIB_DRIVER_ZCL_SCENE_H__
  21
  22 /**< ZigBee 'ZCL scene' driver operations */
  23 typedef struct {
  24         gboolean (*add_scene)(ZigBeeDriver *driver, guint request_id);
  25         gboolean (*view_scene)(ZigBeeDriver *driver, guint request_id);
  26         gboolean (*remove_scene)(ZigBeeDriver *driver, guint request_id);
  27         gboolean (*store_scene)(ZigBeeDriver *driver, guint request_id);
  28         gboolean (*recall_scene)(ZigBeeDriver *driver, guint request_id);
  29         gboolean (*remove_all_scene)(ZigBeeDriver *driver, guint request_id);
  30         gboolean (*get_scene_membership)(ZigBeeDriver *driver, guint request_id);
  31 } ZblibDriverZclSceneOps_t;
  32
  33 /**< ZigBee 'ZCL scene' ops IDs */
  34 typedef enum {
  35         ZBLIB_ZCL_SCENE_OPS_ADD_SCENE = 1, /**< Add scene */
  36         ZBLIB_ZCL_SCENE_OPS_VIEW_SCENE, /**< View scene */
  37         ZBLIB_ZCL_SCENE_OPS_REMOVE_SCENE, /**< Remove scene */
  38         ZBLIB_ZCL_SCENE_OPS_STORE_SCENE, /**< Store scene */
  39         ZBLIB_ZCL_SCENE_OPS_RECALL_SCENE, /**< Recall scene */
  40         ZBLIB_ZCL_SCENE_OPS_REMOVE_ALL_SCENE, /**< Remove all scene */
  41         ZBLIB_ZCL_SCENE_OPS_GET_SCENE_MEMBERSHIP, /**< Get scene membership */
  42 } ZblibZclSceneOps_e;
  43
  44 /* ZigBee 'ZCL scene' driver APIs */
  45 ZigBeeDriver *zblib_driver_zcl_scene_new(ZigBeePlugin *plugin,
  46         const gchar *driver_name,
  47         ZblibDriverZclSceneOps_t *ops);
  48 void zblib_driver_zcl_scene_free(ZigBeeDriver *driver);
  49
  50 #endif /* __ZIGBEE_LIB_DRIVER_ZCL_SCENE_H__ */