zigbee-daemon/zigbee-lib/include/zblib_driver.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_H__
  20 #define __ZIGBEE_LIB_DRIVER_H__
  21
  22 /**< ZigBee driver dispatcher function pointer */
  23 typedef gboolean (*ZblibDriverDispatcher_t)(ZigBeeDriver *driver);
  24
  25 /**< ZigBee driver free hook function pointer */
  26 typedef void (*ZblibDriverFreeHook_t)(ZigBeeDriver *driver);
  27
  28 /**< ZigBee driver types */
  29 typedef enum {
  30         ZBLIB_DRIVER_TYPE_NONE, /**< None */
  31         ZBLIB_DRIVER_TYPE_ALARM, /**< Alarm */
  32         ZBLIB_DRIVER_TYPE_CUSTOM, /**< Custom */
  33         ZBLIB_DRIVER_TYPE_DOOR_LOCK, /**< Door lock */
  34         ZBLIB_DRIVER_TYPE_FAN_CONTROL, /**< Fan control */
  35         ZBLIB_DRIVER_TYPE_LEVEL_CONTROL, /**< Level control */
  36         ZBLIB_DRIVER_TYPE_MFGLIB_CONTROL, /**< Mfglib control */
  37         ZBLIB_DRIVER_TYPE_ON_OFF, /**< On Off */
  38         ZBLIB_DRIVER_TYPE_SERVICE, /**< Service */
  39         ZBLIB_DRIVER_TYPE_THERMOSTAT, /**< Thermostat */
  40         ZBLIB_DRIVER_TYPE_ZCLBASIC_CONTROL, /**< Zclbasic control */
  41         ZBLIB_DRIVER_TYPE_ZCLGLOBAL_CONTROL, /**< Zclglobal control */
  42         ZBLIB_DRIVER_TYPE_ZCLIAS_CONTROL, /**< Zclias control */
  43         ZBLIB_DRIVER_TYPE_ZCLIDENTIFY_CONTROL, /**< Zclidentify control */
  44         ZBLIB_DRIVER_TYPE_ZCL_COLOR, /**< Zcl color */
  45         ZBLIB_DRIVER_TYPE_ZCL_GROUP, /**< Zcl group */
  46         ZBLIB_DRIVER_TYPE_ZCL_POLL_CONTROL, /**< Zcl poll control */
  47         ZBLIB_DRIVER_TYPE_ZCL_SCENE, /**< Zcl scene */
  48         ZBLIB_DRIVER_TYPE_ZDODEV_CONTROL, /**< Zdodev control */
  49         ZBLIB_DRIVER_TYPE_ZDO_BIND, /**< Zdo bind */
  50 } ZblibDriverType_e;
  51
  52 /**< Driver APIs */
  53 ZigBeeDriver *zblib_driver_new(ZigBeePlugin *plugin,
  54         const gchar *driver_name,
  55         ZblibDriverType_e driver_type);
  56 void zblib_driver_free(ZigBeeDriver *driver);
  57
  58 gboolean zblib_driver_link_object(ZigBeeDriver *driver, gpointer object);
  59 gpointer zblib_driver_ref_object(ZigBeeDriver *driver);
  60
  61 gboolean zblib_driver_set_dispatcher(ZigBeeDriver *driver, ZblibDriverDispatcher_t dispatcher_fn);
  62 gboolean zblib_driver_set_free_hook(ZigBeeDriver *driver, ZblibDriverFreeHook_t free_hook_fn);
  63
  64 ZblibDriverType_e zblib_driver_ref_driver_type(ZigBeeDriver *driver);
  65
  66 #endif /* __ZIGBEE_LIB_DRIVER_H__ */