Z-Stack ZCL API - CC2530/CC2538

Z-Stack

ZigBee Cluster Library

Application Programming Interface - CC2530/CC2538

Document Number: SWRA197 Version 1.10

Скачать оригинал (eng)

Документ API для приложений, использующих базовый стек ZigBee в качестве модели интерфейса приложения для данных и управления. Сырой перевод.

 

 

 

 

 

 

 

СОДЕРЖАНИЕ

1. ВВЕДЕНИЕ .................... 1
1.1 ЦЕЛЬ .................... 1
1.2 ВОЗМОЖНОСТИ.................... 1
1.3 СОКРАЩЕНИЯ .................... 1
1.4 ПРИЛАГАЕМЫЕ ДОКУМЕНТЫ .................... 2
2. ОБЗОР API  .................... 2
2.1 ОБЗОР .................... 2
2.2 КЛИЕНТ / СЕРВЕР МОДЕЛЬ .................... 2
2.3 ДИАГРАММА СТЕКА  .................... 3
2.5 СОЗДАНИЕ ПРИЛОЖЕНИЯ .................... 7
3. ОСНОВНОЙ СЛОЙ ........................ 9
3.1 ВВЕДЕНИЕ ........................................... 9
3.2 SEND COMMAND ....................................... 9
3.3 SEND READ .............................................. 10
3.4 SEND READ RESPONSE .................................... 10
3.5 SEND WRITE .......................................... 11
3.6 SEND WRITE UNDIVIDED ............................ 11
3.7 SEND WRITE RESPONSE ............................................ 12
3.8 SEND WRITE NO RESPONSE ....................................... 12
3.9 SEND CONFIGURE REPORTING ................................................... 13
3.10 SEND CONFIGURE REPORTING RESPONSE .......................................... 13
3.11 SEND READ REPORTING CONFIGURATION ............................................. 14
3.12 SEND READ REPORTING CONFIGURATION RESPONSE ............................ 14
3.13 SEND REPORT ............................................................... 15
3.14 SEND DEFAULT RESPONSE .................................................. 15
3.15 SEND DISCOVER................................................... 16
3.16 SEND DISCOVER RESPONSE .............................................. 16
3.17 REGISTER ATTRIBUTE LIST ...................................................... 17
3.18 REGISTER ATTRIBUTE DATA VALIDATION CALLBACK ............................ 17
3.19 REGISTER CLUSTER LIBRARY HANDLER CALLBACK ........................................ 17
3.20 CLUSTER LIBRARY HANDLER CALLBACK .......................................... 18
3.21 REGISTER CLUSTER OPTION LIST ........................................... 18
3.22 GET THE RAW AF INCOMING MESSAGE ................................... 18
4. GENERAL FUNCTIONAL DOMAIN ............................................. 19
4.1 ВВЕДЕНИЕ ................................................................ 19
4.2 SEND RESET TO FACTORY DEFAULTS (BASIC) ......................................... 19
4.3 SEND IDENTIFY (IDENTIFY) ........................................................................... 20
4.4 SEND IDENTIFY QUERY (IDENTIFY) .............................................................. 20
4.5 SEND IDENTIFY QUERY RESPONSE (IDENTIFY) .............................................. 21
4.6 SEND ADD GROUP (GROUP) ......................................................... 21
4.7 SEND VIEW GROUP (GROUP) ................................................. 22
4.8 SEND GET GROUP MEMBERSHIP (GROUP) ..................................... 22
4.9 SEND REMOVE GROUP (GROUP) ............................................. 23
4.10 SEND REMOVE ALL GROUPS (GROUP) .............................................. 23
4.11 SEND ADD GROUP IF IDENTIFYING (GROUP) ............................. 24
4.12 SEND ADD GROUP RESPONSE (GROUP) ................................................ 24
4.13 SEND VIEW GROUP RESPONSE (GROUP) ......................................... 24
4.14 SEND GET GROUP MEMBERSHIP RESPONSE (GROUP) ..................... 25
4.15 SEND REMOVE GROUP RESPONSE (GROUP) ..................................... 26
4.16 SEND ADD SCENE (SCENE) ..................................................... 26
4.17 SEND VIEW SCENE (SCENE) ............................................. 27
4.18 SEND REMOVE SCENE (SCENE) ................................... 27
4.19 SEND REMOVE ALL SCENES (SCENE) ......................... 28
4.20 SEND STORE SCENE (SCENE) ................................. 28
4.21 SEND RECALL SCENE (SCENE) ................................... 29
4.22 SEND GET SCENE MEMBERSHIP (SCENE) .................................. 29
4.23 SEND ADD SCENE RESPONSE (SCENE) ........................................ 30
4.24 SEND VIEW SCENE RESPONSE (SCENE) ....................................... 30
4.25 SEND REMOVE SCENE RESPONSE (SCENE) ........................ 31
4.26 SEND REMOVE ALL SCENES (SCENE) ........................................ 31
4.27 SEND STORE SCENE (SCENE) ..................................................... 32
4.28 SEND GET SCENE MEMBERSHIP RESPONSE (SCENE) ............................ 32
4.29 SEND OFF (ON/OFF) ............................................... 33
4.30 SEND ON (ON/OFF) ........................................................ 33
4.31 SEND TOGGLE (ON/OFF) .................................................. 34
4.32 SEND MOVE TO LEVEL (LEVEL CONTROL) ......................... 34
4.33 SEND MOVE (LEVEL CONTROL) ................................................. 35
4.34 SEND STEP (LEVEL CONTROL) .................................................. 35
4.35 SEND RESET ALARM (ALARM) ................................................ 36
4.36 SEND RESET ALL ALARMS (ALARM) ............................................ 36
4.37 SEND GET ALARM (ALARM) ..................................................... 37
4.38 SEND RESET ALARM LOG (ALARM) ................................ 37
4.39 SEND ALARM (ALARM) .................................................. 38
4.40 SEND GET ALARM RESPONSE (ALARM) .......................................... 38
4.41 SEND SET ABSOLUTE LOCATION (RSSI LOCATION) ................................... 39
4.42 SEND SET DEVICE CONFIGURATION (RSSI LOCATION) ............................ 39
4.43 SEND GET DEVICE CONFIGURATION (RSSI LOCATION) ............................. 40
4.44 SEND GET LOCATION DATA (RSSI LOCATION) ....................................... 40
4.45 SEND DEVICE CONFIGURATION RESPONSE (RSSI LOCATION) ............................... 41
4.46 SEND LOCATION DATA RESPONSE (RSSI LOCATION)............................................ 41
4.47 SEND LOCATION DATA NOTIFICATION (RSSI LOCATION) ................................ 42
4.49 SEND RSSI PING (RSSI LOCATION) ............................................................ 43
4.50 ATTRIBUTE DATA VALIDATION CALLBACK........................ 43
4.51 REGISTER APPLICATION COMMAND CALLBACK ................... 44
4.52 RESET TO FACTORY DEFAULTS CALLBACK ........................ 44
4.53 IDENTIFY CALLBACK ................................................. 44
4.54 IDENTIFY RESPONSE CALLBACK ............................ 45
4.55 ON/OFF/TOGGLE CALLBACK ................................... 45
4.56 MOVE TO LEVEL CALLBACK .................................... 45
4.57 MOVE CALLBACK ..................................................... 46
4.58 STEP CALLBACK ............................................................. 46
4.59 STEP CALLBACK ......................................................... 46
4.60 GROUP RESPONSE CALLBACK.................................. 47
4.61 STORE SCENE CALLBACK .................................................... 47
4.62 RECALL SCENE CALLBACK ...................................................... 48
4.63 SCENE RESPONSE CALLBACK ...................................... 48
4.64 ALARM CALLBACK .......................................................... 49
4.65 LOCATION CALLBACK ................................................. 49
4.66 LOCATION RESPONSE CALLBACK .................................... 50
4.67 READ SCENE COUNT CALLBACK ....................................... 50
5. CLOSURES FUNCTIONAL DOMAIN ......................................... 51
5.1 ВВЕДЕНИЕ  ............................................................... 51
5.2 LOCK DOOR COMMAND ................................................................... 51
5.3 UNLOCK DOOR COMMAND .................................................... 51
5.4 DOOR LOCK RESPONSE COMMAND............................................ 52
5.5 UNLOCK DOOR RESPONSE .............................................................. 52
5.6 UP / OPEN COMMAND (WINDOW COVERING) ................................... 53
5.7 DOWN / CLOSE COMMAND (WINDOW COVERING) ....................................... 53
5.8 STOP COMMAND (WINDOW COVERING) ..................................................... 54
5.9 GO TO LIFT SETPOINT COMMAND (WINDOW COVERING) ....................... 54
5.10 GO TO LIFT VALUE COMMAND (WINDOW COVERING) .............................. 55
5.11 GO TO LIFT PERCENTAGE COMMAND (WINDOW COVERING) ...................... 55
5.12 GO TO TILT SETPOINT COMMAND (WINDOW COVERING) .......................... 56
5.13 GO TO TILT VALUE COMMAND (WINDOW COVERING) ............................. 56
5.15 PROGRAM SETPOINT COMMAND (WINDOW COVERING) ........................... 57
5.16 DOOR LOCK CALLBACK ........................................ 58
5.17 DOOR LOCK RESPONSE CALLBACK ...................................... 58
5.18 UNLOCK WITH TIMEOUT CALLBACK ............................................ 58
5.19 GET LOG RECORD CALLBACK .............................................................. 59
5.20 SET PIN CODE CALLBACK ................................................... 59
5.21 GET PIN CODE COMMAND CALLBACK ................................. 59
5.22 CLEAR PIN CODE CALLBACK .................................................... 60
5.23 CLEAR ALL PIN CODES CALLBACK ........................................... 60
5.24 SET USER STATUS CALLBACK ...................................................... 60
5.25 GET USER STATUS CALLBACK .................................................... 61
5.26 SET WEEK DAY SCHEDULE CALLBACK ........................................ 61
5.27 GET WEEK DAY SCHEDULE CALLBACK......................................... 61
5.28 CLEAR WEEK DAY SCHEDULE CALLBACK .............................................. 62
5.29 SET YEAR DAY SCHEDULE CALLBACK .................................... 62
5.30 GET YEAR DAY SCHEDULE CALLBACK ................................ 62
5.31 CLEAR YEAR DAY SCHEDULE CALLBACK ................................... 63
5.32 SET HOLIDAY SCHEDULE CALLBACK ....................................... 63
5.33 GET HOLIDAY SCHEDULE CALLBACK .......................................... 63
5.34 CLEAR HOLIDAY SCHEDULE CALLBACK ...................... 64
5.35 SET USER TYPE CALLBACK ........................................................ 64
5.36 GET USER TYPE CALLBACK .................................................. 64
5.37 SET RFID CODE CALLBACK ............................................ 65
5.38 GET RFID CODE CALLBACK ................................................ 65
5.39 CLEAR RFID CODE CALLBACK .................................................. 65
5.40 CLEAR ALL RFID CODES CALLBACK ......................................... 66
5.41 LOCK DOOR RESPONSE CALLBACK ........................................ 66
5.42 UNLOCK WITH TIMEOUT RESPONSE CALLBACK ................................ 66
5.43 GET LOG RECORD RESPONSE CALLBACK ............................ 67
5.44 SET PIN CODE RESPONSE CALLBACK ..................................... 67
5.45 GET PIN CODE RESPONSE CALLBACK ................................ 67
5.46 CLEAR PIN CODE RESPONSE CALLBACK ................................... 68
5.47 CLEAR ALL PIN CODES RESPONSE CALLBACK .......................... 68
5.48 SET USER STATUS RESPONSE CALLBACK .......................................... 68
5.49 GET USER STATUS RESPONSE CALLBACK ................................. 69
5.50 SET WEEK DAY SCHEDULE RESPONSE CALLBACK .............................. 69
5.51 GET WEEK DAY SCHEDULE RESPONSE CALLBACK ....................... 69
5.52 CLEAR WEEK DAY SCHEDULE RESPONSE CALLBACK ................... 70
5.53 CLEAR WEEK DAY SCHEDULE RESPONSE CALLBACK .......................... 70
5.54 SET YEAR DAY SCHEDULE RESPONSE CALLBACK .............................. 70
5.55 GET YEAR DAY SCHEDULE RESPONSE CALLBACK .......................... 71
5.56 CLEAR YEAR DAY SCHEDULE RESPONSE CALLBACK ............................. 71
5.57 SET HOLIDAY SCHEDULE RESPONSE CALLBACK ........................... 71
5.58 GET HOLIDAY SCHEDULE RESPONSE CALLBACK ........................... 72
5.59 CLEAR HOLIDAY SCHEDULE RESPONSE CALLBACK ................... 72
5.60 SET USER TYPE RESPONSE CALLBACK ...................................... 72
5.61 GET USER TYPE RESPONSE CALLBACK ....................................... 73
5.62 SET RFID CODE RESPONSE CALLBACK ........................................... 73
5.63 GET RFID CODE RESPONSE CALLBACK .......................................... 73
5.64 CLEAR RFID CODE RESPONSE CALLBACK ..................................... 74
5.65 CLEAR ALL RFID CODES CALLBACK ........................................... 74
5.66 OPERATION EVENT NOTIFICATION CALLBACK .................................... 74
5.67 PROGRAMMINGEVENT NOTIFICATION CALLBACK ........................ 75
5.68 WINDOW COVERING CLUSTER BASIC CALLBACK ..................................... 75
5.69 WINDOW COVERING CLUSTER GOTO PERCENTAGE CALLBACK ...................... 75
5.70 WINDOW COVERING CLUSTER GOTO VALUE CALLBACK ...................... 76
6. PROTOCOL INTERFACES FUNCTIONAL DOMAIN ............................... 77
6.1 ВВЕДЕНИЕ ............................................................................................. 77
6.10 REGISTER APPLICATION COMMAND CALLBACKS .......................... 82
6.11 MATCH PROTOCOL ADDRESS CALLBACK ................................. 82
6.13 ADVERTISE PROTOCOL ADDRESS CALLBACK ........................ 83
6.14 BACNET TRANSFER NPDU CALLBACK ............................................. 83
6.15 11073 TRANSFER APDU CALLBACK .............................................. 84
6.16 11073 CONNECT REQUEST CALLBACK ............................... 84
6.17 11073 DISCONNECT REQUEST CALLBACK ........................................... 84
6.18 11073 CONNECT STATUS NOTIFICATION CALLBACK .................................... 85
7. TOUCHLINK COMMISSIONING ........................................................................... 86
7.2 SEND SCAN REQUEST .......................................................... 86
7.3 DEVICE INFORMATION REQUEST .................................................... 86
7.4 SEND IDENTIFY REQUEST .................................................................. 87
7.5 SEND RESET TO FACTORY NEW REQUEST ................................. 87
7.6 SEND A NETWORK START REQUEST................................................ 87
7.8 SEND NETWORK UPDATE REQUEST ................................. 88
7.9 SEND GET GROUP IDENTIFIERS REQUEST ........................... 89
7.10 SEND GET ENDPOINT LIST REQUEST .................................. 89
7.11 SEND SCAN RESPONSE ..................................................... 89
7.12 SEND DEVICE INFORMATION RESPONSE ...................... 90
7.13 SEND NETWORK START RESPONSE ........................................... 90
7.15 SEND ENDPOINT INFORMATION RESPONSE ........................ 91
7.16 SEND GET GROUP IDENTIFIERS RESPONSE ......................... 91
7.17 SEND GET ENDPOINT LIST RESPONSE ............................ 92
7.18 GET GROUP IDENTIFIERS REQUEST CALLBACK ................. 92
7.19 SET ENDPOINT LIST REQUEST CALLBACK .......................... 93
7.20 ENDPOINT INFORMATION CALLBACK .................................. 93
7.21 GET GROUP IDENTIFIERS CALLBACK .................................... 93
7.22 GET ENDPOINT LIST RESPONSE CALLBACK ................................ 94
7.23 SCAN REQUEST CALLBACK.......................................................... 94
7.24 DEVICE INFORMATION REQUEST CALLBACK ......................... 94
7.25 IDENTIFY REQUEST CALLBACK............................................... 95
7.26 RESET TO FACTORY NEW REQUEST CALLBACK........................ 95
7.27 NETWORK START REQUEST CALLBACK .............................. 95
7.28 NETWORK JOIN ROUTER REQUEST CALLBACK ........................... 96
7.29 NETWORK JOIN END DEVICE REQUEST CALLBACK ...................... 96
7.30 NETWORK UPDATE REQUEST CALLBACK .................................... 96
7.31 SCAN RESPONSE CALLBACK .......................................... 97
7.32 DEVICE INFORMATION RESPONSE CALLBACK ......................... 97
7.33 NETWORK START RESPONSE CALLBACK .................................. 97
7.34 NETWORK JOIN ROUTER RESPONSE CALLBACK ............................ 98
7.35 NETWORK JOIN END DEVICE RESPONSE CALLBACK ....................... 98
8. GREEN POWER ..................................... 99
8.2 SEND GREEN POWER NOTIFICATION .......................................................... 99
8.3 SEND GREEN POWER COMMISSIONING NOTIFICATION .......................... 99
8.4 SEND GREEN POWER PROXY TABLE REQUEST ...................................... 100
8.5 GP PAIRING CALLBACK .......................................................................... 100
8.6 GP COMMISSIONING MODE CALLBACK ................................ 100
8.7 GP RESPONSE CALLBACK ....................................................... 101
8.8 GP RESPONSE CALLBACK .................................................................. 101
9. COMPILE OPTIONS .............................................................. 102
 

1. Введение

1.1 Цель

Цель этого документа - определить API библиотеки кластеров ZigBee (ZCL). Этот API позволяет более высоким уровням (Profile and Application) получать доступ к функциональности ZCL. ZCL разделен на базовый уровень и несколько функциональных доменов, каждый из которых относится к кластерам, относящимся к определенной функциональности. Функциональные домены:
  • General Общие
  • Closures Закрывание
  • Heating, Ventilation and Air Conditioning (HVAC) Отопление, вентиляция и кондиционирование воздуха
  • Lighting Освещение
  • Measurements and Sensing Измерения и измерения
  • Security and Safety Охрана и безопасность
  • Smart Energy Умная Энергия
  • Protocol Interfaces Интерфейсы протокола
  • Touchlink Commissioning Ввод в эксплуатацию Touchlink
  • Green Power Сохранение энергии
Этот документ охватывает только базовый уровень и общие функциональные области, интерфейсы протокола, ввод в эксплуатацию сенсорной линии и Green Power.

1.2 Область применения

В этом документе перечислены все вызовы функций, предоставляемые базовым уровнем, вводом в действие Touchlink и функциональной областью Green Power General. Он также перечисляет функции обратного вызова, которые должны быть предоставлены верхними уровнями.

1.3 Сокращения

AF Application Framework
APDU Application Protocol Data Unit - Блок данных протокола приложения 
API Application Programming Interface - Интерфейс прикладного программирования
APS Application Support Sub-Layer - Подуровень поддержки приложений 
BACnet Building Automation and Control Network - Сеть автоматизации и контроля зданий 
Client Клиент - Интерфейс кластера, который указан в списке выходных кластеров простого дескриптора на конечной точке. Обычно этот интерфейс отправляет команды, которые управляют атрибутами на соответствующем сервере кластера
Cluster Кластер - Связанный набор атрибутов и команд, которые вместе определяют интерфейс связи между двумя устройствами. Устройства реализуют серверную и клиентскую стороны интерфейса соответственно
HAL Hardware Abstraction Layer - Аппаратный уровень абстракции
MAC Media Access Control
NPDU Network Protocol Data Unit - Блок данных сетевого протокола
NWK Network Layer Сетевой уровень 
PAN Personal Area Network Персональная сеть 
RSSI Receiver Signal Strength Indication Индикатор силы сигнала приемника 
Server Сервер - Интерфейс кластера, который указан в списке входных кластеров простого дескриптора на конечной точке. Обычно этот интерфейс поддерживает все или большинство атрибутов кластера.
ZCL ZigBee Cluster Library Библиотеки клатеров

1.4 Применимые документы

1. Документ ZigBee 053520r16, Профиль ZigBee: Домашняя автоматизация, Рабочая группа ZigBee Application Framework
2. Документ ZigBee 06027r04, Библиотека кластеров ZigBee, Фонд, Рабочая группа ZigBee Application Framework
3. Документ ZigBee 053936r04a, Библиотека кластеров ZigBee, Функциональный домен: общий, Рабочая группа ZigBee Application Framework
4. Документ ZigBee 075123r06ZB, Спецификация библиотеки кластеров ZigBee
5. Документ Zigbee 14-0563-16 Green Power Основные технические характеристики
6. Документ Texas Instruments SWRA216, Руководство разработчика Z-Stack Smart Energy
7. Документ Texas Instruments Интерфейс прикладного программирования Z-Stack SWRA195

2. Обзор API

2.1 Обзор

ZCL выступает в качестве хранилища для функциональности кластера, который разработан ZigBee. Уровень основания и функциональность общего функционального кластера домена описаны в этом документе.
Базовый уровень предоставляет API для более высоких уровней:
1. Генерация команд запроса и ответа
2. Зарегистрируйте список атрибутов приложения.
3. Зарегистрируйте функцию обратного вызова проверки данных атрибута приложения.
4. Зарегистрируйте функции обратного вызова обработчика библиотеки кластеров.
5. Зарегистрируйте задачу приложения для получения необработанных сообщений команды / ответа Foundation.
Функциональные домены General и Protocol Interfaces предоставляют API для верхних уровней, чтобы:
1. Генерация команд запроса и ответа
2. Зарегистрируйте функции обратного вызова команд приложения.

2.2 Модель клиент / сервер

ZCL использует модель клиент / сервер. Кластер - это связанная коллекция команд и атрибутов, которые вместе определяют интерфейс для определенной функциональности. Как правило, объект, который хранит атрибуты кластера, упоминается как сервер, а объект, который влияет или управляет этими атрибутами, упоминается как клиент. Однако, если требуется, атрибуты могут также присутствовать на клиенте кластера.
Например, команды атрибутов Read и Write, которые позволяют устройствам манипулировать атрибутами, отправляются с клиентского устройства и принимаются устройством-сервером. Любой ответ на эти команды (то есть команды ответа атрибута Read и Write) отправляется с серверного устройства и принимается клиентским устройством. И наоборот, команда атрибута отчета, которая облегчает динамический отчет об атрибутах, отправляется с устройства сервера на клиентское устройство, которое было привязано к устройству сервера.

2.3 Диаграмма стека

На рисунке 1 показаны компоненты внутри ZCL и его интерфейсы с другими уровнями.
 
 
Рисунок 1: Диаграмма стека
 
Сообщения команд ZCL, полученные AF, помещаются в очередь задачи ZCL. Задача ZCL анализирует и обрабатывает команды профиля и передает специфичные для кластера команды соответствующему кластеру с помощью функции обратного вызова обработчика библиотеки кластеров. Кластер обрабатывает команду и уведомляет, если необходимо, приложение / профиль через функцию обратного вызова Command.

2.4 Регистрация приложения / профиля

Foundation предоставляет API-интерфейсам zcl_registerAttrList (), zcl_registerValidateAttrData () и zcl_registerForMsg () приложение / профиль для регистрации списка атрибутов приложения, данных атрибутов обратный вызов проверки и идентификатор задачи соответственно. Он также предоставляет API-интерфейс zcl_registerPlugin () для функциональных доменов для регистрации их функции обратного вызова обработчика библиотеки кластеров. Прототип функции обратного вызова определен в разделе 3.20.
Входной параметр списка атрибутов для zcl_registerAttrList () содержит запись следующей информации для каждого поддерживаемого атрибута:
 
// Attribute record
typedef struct
{
  uint16 attrId; // Attribute ID
  uint8 dataType; // Data Type - defined in AF.h
  uint8 accessControl; // Read/write - bit field
  void *dataPtr; // Pointer to data field
} zclAttribute_t;
typedef struct
{
  uint16 clusterID; // Cluster ID
  zclAttribute_t attr; // Attribute record
} zclAttrRec_t;
 
Список параметров zcl_registerValidateAttrData () содержит указатели на запись атрибута приложения (zclAttrRec_t) и новые записываемые данные (zclWriteRec_t):
 
// Write Attribute record
typedef struct
{
  uint16 attrID; // attribute ID
  uint8 dataType; // attribute data type
  uint8 *attrData; // this structure is allocated, so the data is HERE
  // - the size depends on the attribute data type
} zclWriteRec_t;

Общий функциональный домен предоставляет API zclGeneral_RegisterCmdCallbacks () для регистрации функций обратного вызова команды приложения. Входной параметр обратного вызова команды для этого API имеет следующий тип:

// Register Callbacks table entry - enter function pointers for callbacks that
// the application would like to receive
typedef struct
{
  zclGCB_BasicReset_t pfnBasicReset;
  zclGCB_IdentifyTriggerEffect_t pfnIdentifyTriggerEffect;
  zclGCB_OnOff_t pfnOnOff;
  zclGCB_OnOff_OffWithEffect_t pfnOnOff_OffWithEffect;
  zclGCB_OnOff_OnWithRecallGlobalScene_t pfnOnOff_OnWithRecallGlobalScene;
  zclGCB_OnOff_OnWithTimedOff_t pfnOnOff_OnWithTimedOff;
  zclGCB_LevelControlMoveToLevel_t pfnLevelControlMoveToLevel;
  zclGCB_LevelControlMove_t pfnLevelControlMove;
  zclGCB_LevelControlStep_t pfnLevelControlStep;
  zclGCB_LevelControlStop_t pfnLevelControlStop;
  zclGCB_GroupRsp_t pfnGroupRsp;
  zclGCB_SceneStoreReq_t pfnSceneStoreReq;
  zclGCB_SceneRecallReq_t pfnSceneRecallReq;
  zclGCB_SceneRsp_t pfnSceneRsp;
  zclGCB_Alarm_t pfnAlarm;
  zclGCB_GetEventLog_t pfnGetEventLog;
  zclGCB_PublishEventLog_t pfnPublishEventLog;
  zclGCB_Location_t pfnLocation;
  zclGCB_LocationRsp_t pfnLocationRsp;
} zclGeneral_AppCallbacks_t;
 
Прототип каждой функции обратного вызова команды определен в разделе 4.
 
Примечание 1: некоторые из этих обратных вызовов определяются флагами компиляции, такими как ZCL_GROUPS, пожалуйста, обратитесь к реализации структуры в zcl_general.h
Примечание 2: Идентификационные обратные вызовы теперь обрабатываются BDB, пожалуйста, обратитесь к [7], чтобы узнать, как управлять идентифицирующим интерфейсом.
 
Функциональный домен Closures предоставляет zclClosures_RegisterDoorLockCmdCallbacks () и API-интерфейс zclClosures_RegisterWindowCoveringCmdCallbacks () для регистрации функций обратного вызова команд приложения. Входной параметр обратного вызова команды для этого API имеет следующий тип:
 
// Register Callbacks table entry - enter function pointers for callbacks that
// the application would like to receive
typedef struct
{
  zclClosures_DoorLock_t pfnDoorLock;
  zclClosures_DoorLockRsp_t pfnDoorLockRsp;
  zclClosures_DoorLockUnlockWithTimeout_t pfnDoorLockUnlockWithTimeout;
  zclClosures_DoorLockGetLogRecord_t pfnDoorLockGetLogRecord;
  zclClosures_DoorLockSetPINCode_t pfnDoorLockSetPINCode;
  zclClosures_DoorLockGetPINCode_t pfnDoorLockGetPINCode;
  zclClosures_DoorLockClearPINCode_t pfnDoorLockClearPINCode;
  zclClosures_DoorLockClearAllPINCodes_t pfnDoorLockClearAllPINCodes;
  zclClosures_DoorLockSetUserStatus_t pfnDoorLockSetUserStatus;
  zclClosures_DoorLockGetUserStatus_t pfnDoorLockGetUserStatus;
  zclClosures_DoorLockSetWeekDaySchedule_t pfnDoorLockSetWeekDaySchedule;
  zclClosures_DoorLockGetWeekDaySchedule_t pfnDoorLockGetWeekDaySchedule;
  zclClosures_DoorLockClearWeekDaySchedule_t pfnDoorLockClearWeekDaySchedule;
  zclClosures_DoorLockSetYearDaySchedule_t pfnDoorLockSetYearDaySchedule;
  zclClosures_DoorLockGetYearDaySchedule_t pfnDoorLockGetYearDaySchedule;
  zclClosures_DoorLockClearYearDaySchedule_t pfnDoorLockClearYearDaySchedule;
  zclClosures_DoorLockSetHolidaySchedule_t pfnDoorLockSetHolidaySchedule;
  zclClosures_DoorLockGetHolidaySchedule_t pfnDoorLockGetHolidaySchedule;
  zclClosures_DoorLockClearHolidaySchedule_t pfnDoorLockClearHolidaySchedule;
  zclClosures_DoorLockSetUserType_t pfnDoorLockSetUserType;
  zclClosures_DoorLockGetUserType_t pfnDoorLockGetUserType;
  zclClosures_DoorLockSetRFIDCode_t pfnDoorLockSetRFIDCode;
  zclClosures_DoorLockGetRFIDCode_t pfnDoorLockGetRFIDCode;
  zclClosures_DoorLockClearRFIDCode_t pfnDoorLockClearRFIDCode;
  zclClosures_DoorLockClearAllRFIDCodes_t pfnDoorLockClearAllRFIDCodes;
  zclClosures_DoorLockUnlockWithTimeoutRsp_t pfnDoorLockUnlockWithTimeoutRsp;
  zclClosures_DoorLockGetLogRecordRsp_t pfnDoorLockGetLogRecordRsp;
  zclClosures_DoorLockSetPINCodeRsp_t pfnDoorLockSetPINCodeRsp;
  zclClosures_DoorLockGetPINCodeRsp_t pfnDoorLockGetPINCodeRsp;
  zclClosures_DoorLockClearPINCodeRsp_t pfnDoorLockClearPINCodeRsp;
  zclClosures_DoorLockClearAllPINCodesRsp_t pfnDoorLockClearAllPINCodesRsp;
  zclClosures_DoorLockSetUserStatusRsp_t pfnDoorLockSetUserStatusRsp;
  zclClosures_DoorLockGetUserStatusRsp_t pfnDoorLockGetUserStatusRsp;
  zclClosures_DoorLockSetWeekDayScheduleRsp_t pfnDoorLockSetWeekDayScheduleRsp;
  zclClosures_DoorLockGetWeekDayScheduleRsp_t pfnDoorLockGetWeekDayScheduleRsp;
  zclClosures_DoorLockClearWeekDayScheduleRsp_t pfnDoorLockClearWeekDayScheduleRsp;
  zclClosures_DoorLockSetYearDayScheduleRsp_t pfnDoorLockSetYearDayScheduleRsp;
  zclClosures_DoorLockGetYearDayScheduleRsp_t pfnDoorLockGetYearDayScheduleRsp;
  zclClosures_DoorLockClearYearDayScheduleRsp_t pfnDoorLockClearYearDayScheduleRsp;
  zclClosures_DoorLockSetHolidayScheduleRsp_t pfnDoorLockSetHolidayScheduleRsp;
  zclClosures_DoorLockGetHolidayScheduleRsp_t pfnDoorLockGetHolidayScheduleRsp;
  zclClosures_DoorLockClearHolidayScheduleRsp_t pfnDoorLockClearHolidayScheduleRsp;
  zclClosures_DoorLockSetUserTypeRsp_t pfnDoorLockSetUserTypeRsp;
  zclClosures_DoorLockGetUserTypeRsp_t pfnDoorLockGetUserTypeRsp;
  zclClosures_DoorLockSetRFIDCodeRsp_t pfnDoorLockSetRFIDCodeRsp;
  zclClosures_DoorLockGetRFIDCodeRsp_t pfnDoorLockGetRFIDCodeRsp;
  zclClosures_DoorLockClearRFIDCodeRsp_t pfnDoorLockClearRFIDCodeRsp;
  zclClosures_DoorLockClearAllRFIDCodesRsp_t pfnDoorLockClearAllRFIDCodesRsp;
  zclClosures_DoorLockOperationEventNotification_t pfnDoorLockOperationEventNotification;
  zclClosures_DoorLockProgrammingEventNotification_t pfnDoorLockProgrammingEventNotification;
} zclClosures_DoorLockAppCallbacks_t;
 
typedef struct
{
  zclClosures_WindowCoveringSimple_t pfnWindowCoveringUpOpen;
  zclClosures_WindowCoveringSimple_t pfnWindowCoveringDownClose;
  zclClosures_WindowCoveringSimple_t pfnWindowCoveringStop;
  zclClosures_WindowCoveringGotoValue_t pfnWindowCoveringGotoLiftValue;
  zclClosures_WindowCoveringGotoPercentage_t pfnWindowCoveringGotoLiftPercentage;
  zclClosures_WindowCoveringGotoValue_t pfnWindowCoveringGotoTiltValue;
  zclClosures_WindowCoveringGotoPercentage_t pfnWindowCoveringGotoTiltPercentage;
} zclClosures_WindowCoveringAppCallbacks_t;
 
Прототип каждой функции обратного вызова команды определен в разделе 5.
Ввод в действие Touchlink предоставляет API-интерфейс clPI_RegisterCmdCallbacks () для регистрации функций обратного вызова Command в приложении. Входной параметр обратного вызова команды для этого API имеет следующий тип:
 
// Register Callbacks table entry - enter function pointers for callbacks that
// the application would like to receive
typedef struct
{
  zclPICB_MatchProtocolAddr_t pfnPI_MatchProtocolAddr;
  zclPICB_MatchProtocolAddrRsp_t pfnPI_MatchProtocolAddrRsp;
  zclPICB_AdvertiseProtocolAddr_t pfnPI_AdvertiseProtocolAddr;
  zclPICB_BACnetTransferNPDU_t pfnPI_BACnetTransferNPDU;
  zclPICB_11073TransferAPDU_t pfnPI_11073TransferAPDU;
  zclPICB_11073ConnectReq_t pfnPI_11073ConnectReq;
  zclPICB_11073DisconnectReq_t pfnPI_11073DisconnectReq;
  zclPICB_11073ConnectStatusNoti_t pfnPI_11073ConnectStatusNoti;
} zclPI_AppCallbacks_t;
 
Прототип каждой функции обратного вызова команды определен в разделе 6.
Функциональный домен Protocol Interfaces Интерфейсы протокола предоставляет API-интерфейс bdbTL_RegisterCmdCallbacks () bdbTL_RegisterInterPANCmdCallbacks () для регистрации функций обратного вызова Команды приложения.
Входной параметр обратного вызова команды для этого API имеет следующий тип:
 
// Register Callbacks table entry - enter function pointers for callbacks that
// the application would like to receive
typedef struct
{
  bdbTL_GetGrpIDsReqCB_t pfnGetGrpIDsReq;
  bdbTL_GetEPListReqCB_t pfnGetEPListReq;
  bdbTL_EndpointInfoCB_t pfnEndpointInfo;
  bdbTL_GetGrpIDsRspCB_t pfnGetGrpIDsRsp;
  bdbTL_GetEPListRspCB_t pfnGetEPListRsp;
} bdbTL_AppCallbacks_t;
typedef struct
{
  bdbTL_ScanReqCB_t pfnScanReq;
  bdbTL_DeviceInfoReqCB_t pfnDeviceInfoReq;
  bdbTL_IdentifyReqCB_t pfnIdentifyReq;
  bdbTL_ResetToFNReqCB_t pfnResetToFNReq;
  bdbTL_NwkStartReqCB_t pfnNwkStartReq;
  bdbTL_NwkJoinRtrReqCB_t pfnNwkJoinRtrReq;
  bdbTL_NwkJoinEDReqCB_t pfnNwkJoinEDReq;
  bdbTL_NwkUpdateReqCB_t pfnNwkUpdateReq;
  bdbTL_ScanRspCB_t pfnScanRsp;
  bdbTL_DeviceInfoRspCB_t pfnDeviceInfoRsp;
  bdbTL_NwkStartRspCB_t pfnNwkStartRsp;
  bdbTL_NwkJoinRtrRspCB_t pfnNwkJoinRtrRsp;
  bdbTL_NwkJoinEDRspCB_t pfnNwkJoinEDRsp;
} bdbTL_InterPANCallbacks_t;
 
Прототип каждой функции обратного вызова команды определен в разделе 7.

2.5 Создание приложения

В этом разделе описаны шаги, которые необходимо предпринять при создании нового приложения ZCL. Для нового приложения необходимо создать как минимум четыре модуля:
  • zcl_<appname> .h, который должен содержать определения, необходимые для приложения.
  • zcl_<appname> _data.c, который должен содержать определения данных и объявления, необходимые для приложения.
  • zcl_<appname> .c, который должен содержать все функции и функции обратного вызова, необходимые для приложения.
  • OSAL_<AppName> .c, где все задачи, необходимые для приложения, должны быть добавлены в список задач.
Каждый модуль подробно объясняется в следующих подразделах.

2.5.1 zcl_<appname> .h

Этот заголовочный файл должен содержать все определения, необходимые для нового приложения. Конечная точка приложения должна быть определена в этом модуле.

2.5.2 zcl_<appname> _data.c

Этот модуль должен содержать объявление:
1. Все атрибуты кластера, которые поддерживаются приложением.
2. Таблица атрибутов, содержащая одну запись типа zclAttrRec_t для каждого поддерживаемого атрибута.
3. Таблицы идентификаторов входного и выходного кластера, где эти таблицы заполнены идентификаторами входных и выходных кластеров для конкретного приложения соответственно. Эти таблицы используются с таблицей простых дескрипторов.
4. Таблица простых дескрипторов приложения типа SimpleDescriptionFormat_t, определенная в заголовке AF.h

2.5.3 zcl_<appname> .c

Этот модуль должен содержать следующие элементы:
1. Объявление таблицы конечных точек приложения типа endPointDesc_t, определенного в заголовочном файле AF.h
2. Создайте все функции обратного вызова для обработки любой входящей команды из кластеров ZCL. Эти функции обратного вызова используются с таблицами обратного вызова команды.
3. Объявление таблиц обратного вызова команд приложения для функциональных доменов ZCL. Тип этой таблицы для общего функционального домена - zclGeneral_AppCallbacks_t, который определен в заголовочном файле zcl_general.h
4. Создайте функцию void zcl<AppName>_Init (byte task_id) для задачи приложения. Обязанности этой функции перечислены ниже.
5. Создайте функцию uint16 zcl<AppName>_event_loop (uint8 task_id, uint16 events) для получения и обработки сообщений и ключевых событий, помещенных в очередь задачи приложения.
Функция инициализации приложения zcl<AppName>_Init () должна зарегистрировать:
1. Команды обратного вызова таблиц с соответствующими функциональными доменами. Функция zclGeneral_RegisterCmdCallbacks (), определенный в модуле zcl_general.c, должен использоваться для регистрации Общие обратные вызовы команд кластера
2. Список атрибутов приложения в ZCL Foundation с использованием API zcl_registerAttrList (), который определено в модуле zcl.c
3. Конечная точка приложения со слоем AF с использованием API afRegister (), определенного в модуле AF.c
4. Задача приложения с аппаратным обеспечением обрабатывать все события «нажатия клавиш» с помощью API RegisterForKeys () определено в модуле OnBoard.c (если приложение обрабатывает какое-либо ключевое событие)
5. Простой дескриптор приложения с профилем высокой доступности с использованием API bdb_RegisterSimpleDescriptor (), определенного в модуле bdb.c

2.5.4 OSAL_<AppName> .c

Этот модуль должен содержать функцию void osalInitTasks (void), в которой все задачи, необходимые для приложения, и сама задача приложения добавляются в список задач. Добавление задачи выполняется путем передачи каждому приложению идентификатора приложения, который увеличивается по сравнению с каждой инициализированной задачей (см. Любой пример приложения). Вот список задач и порядок их добавления, необходимые для простого приложения ZCL:
1. MAC
2. Network
3. Green Power (в случае устройств Маршрутизатор и Координатор)
4. HAL
5. MT (если необходимо приложением)
6. APS
7. APS Fragmentation
8. ZD Application
9. ZD Network Manager (если требуется приложением)
10. ZCL
11. BDB
12. ZCL Application

Примечание. Изменение порядка выполнения этих задач повлияет на обработку стека, что приведет к непредсказуемому поведению. Только задачи с комментариями являются необязательными при рассмотрении комментариев.

3. Базовый слой - Foundation Layer

3.1 Введение

Слой Foundation предоставляет общие команды, которые используются для управления атрибутами и другими общими задачами, которые не относятся к конкретному кластеру. Эти команды:
Уровень Foundation предоставляет общие команды, которые используются для управления атрибутами и другими общими задачами, которые не относятся к конкретному кластеру. Эти команды:
  • Read attributes Читать атрибуты
  • Read attributes response Чтение атрибутов ответа
  • Write attributes Записать атрибуты
  • Write attributes undivided Записать атрибуты неразделенными
  • Write attributes response Записать атрибуты ответа
  • Write attributes no response Записать атрибуты без ответа
  • Configure reporting Настроить отчетность
  • Configure reporting response Настроить отчетный ответ
  • Read reporting configuration Читать конфигурацию отчетов
  • Read reporting configuration response Прочитать ответ конфигурации отчета
  • Report attributes Атрибуты отчета
  • Default response Ответ по умолчанию
  • Discover attributes Откройте атрибуты
  • Discover attributes response Открой атрибуты ответа

3.2 Отправить команду - Send Command

3.2.1 Описание

Эта функция используется для отправки сообщений о профилях и командах кластера.

3.2.2 Прототип

ZStatus_t zcl_SendCommand( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, uint8 cmd, uint8 specific,
uint8 direction, uint8 disableDefaultRsp,
uint16 manuCode, uint8 seqNum, uint8 cmdFormatLen,
uint8 *cmdFormat );

3.2.3 Подробности параметров - Parameter Details

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
cmd - идентификатор команды.
specific - является ли команда специфичной для кластера.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
manuCode - код производителя для проприетарных расширений профиля.
seqNum - идентификационный номер для транзакции.
cmdFormatLen - длина команды для отправки.
cmdFormat - команда для отправки.

3.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.3 Отправить Читать - Send Read

3.3.1 Описание

Эта функция используется для отправки команды чтения атрибутов.

3.3.2 Прототип

ZStatus_t zcl_SendRead( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclReadCmd_t *readCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.3.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
readCmd - команда чтения для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.4 Отправить прочитанный ответ - Send Read Response

3.4.1 Описание

Эта функция используется для отправки команды ответа чтения атрибутов.

3.4.2 Прототип

ZStatus_t zcl_SendReadRsp( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclReadRspCmd_t *readRspCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.4.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
readRspCmd - команда чтения ответа для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.5 Отправить Записать - Send Write

3.5.1 Описание

Эта функция используется для отправки команды записи атрибутов.

3.5.2 Прототип

      ZStatus_t zcl_SendWrite( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclWriteCmd_t *writeCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.5.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
writeCmd - команда записи для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.5.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.6 Отправить Записать письмо неразделенным - Send Write Undivided

3.6.1 Описание

Эта функция используется для отправки неопределяемой команды записи атрибутов.

3.6.2 Прототип

ZStatus_t zcl_SendWriteUndivided( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclWriteCmd_t *writeCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.6.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
writeCmd - команда записи без указания имени для отправки.
direction- направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.6.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.7 Отправить Написать ответ - Send Write Response

3.7.1 Описание

Эта функция используется для отправки команды ответа на запись атрибутов.

3.7.2 Прототип

ZStatus_t zcl_SendWriteRsp( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclWriteRspCmd_t *writeRspCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.7.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
writeRspCmd - команда записи ответа для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.7.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.8 Отправить Записать нет ответа - Send Write No Response

3.8.1 Описание

Эта функция используется для отправки команды «Запись без ответа».

3.8.2 Прототип

ZStatus_t zcl_SendWriteNoRsp( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclWriteCmd_t *writeCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.8.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
writeCmd - команда «Нет ответа» для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.8.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.9 Отправить отчет о настройке - Send Configure Reporting

3.9.1 Описание

Эта функция используется для отправки команды Configure Reporting.

3.9.2 Прототип

ZStatus_t zcl_Send ConfigReportCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclCfgReportCmd_t *cfgReportCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.9.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
cfgReportCmd - команда «Настроить отчетность» для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.9.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.10 Отправить Configure Reporting Response

3.10.1 Описание

Эта функция используется для отправки команды Configure Reporting Response.

3.10.2 Прототип

ZStatus_t zcl_ SendConfigReportRspCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclCfgReportRspCmd_t *cfgReportRspCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.10.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
cfgReportRspCmd - команда «Настроить ответный отчет» для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.10.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.11 Отправить Чтения отчетов конфигурации - Send Read Reporting Configuration

3.11.1 Описание

Эта функция используется для отправки команды чтения отчетов конфигурации.

3.11.2 Прототип

ZStatus_t zcl_SendReadReportCfgCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclReadReportCfgCmd_t *readReportCfgCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.11.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
readReportCfgCmd - команда чтения конфигурации отчетов, которая будет отправлена.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.11.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.12 Отправить Ответ на чтение конфигурации отчетов - Send Read Reporting Configuration Response

3.12.1 Описание

Эта функция используется для отправки команды ответа на чтение конфигурации отчетов.

3.12.2 Прототип

ZStatus_t zcl_SendReadReportCfgRspCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclReadReportCfgRspCmd_t *readReportCfgRspCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.12.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
readReportCfgRspCmd - команда ответа конфигурации чтения отчетов, которая будет отправлена.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.12.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.13 Отправить Отчет - Send Report

3.13.1 Описание

Эта функция используется для отправки команды «Атрибуты отчета».

3.13.2 Прототип

ZStatus_t zcl_SendReportCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclReportCmd_t *reportCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.13.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
reportCmd - команда отчета для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.13.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.14 Отправить Ответ по умолчанию - Send Default Response

3.14.1 Описание

Эта функция используется для отправки команды ответа по умолчанию.

3.14.2 Прототип

ZStatus_t zcl_SendDefaultRspCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclDefaultRspCmd_t *defaultRspCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.14.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
defaultRspCmd - команда ответа по умолчанию для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.14.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.15 Отправить Обнаружить - Send Discover

3.15.1 Описание

Эта функция используется для отправки команды Discover Attributes.

3.15.2 Прототип

ZStatus_t zcl_SendDiscoverCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclDiscoverCmd_t *discoverCmd,
uint8 direction, uint8 disableDefaultRsp,
uint8 seqNum );

3.15.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
DiscoverCmd - команда Discover для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.15.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.16 Отправить Ответ обнаружения - Send Discover Response

3.16.1 Описание

Эта функция используется для отправки команды отклика Discover Attributes.

3.16.2 Прототип

ZStatus_t zcl_SendDiscoverRspCmd( uint8 srcEP, afAddrType_t *destAddr,
uint16 clusterID, zclDiscoverRspCmd_t *discoverRspCmd,
uint8 direction, uint8 disableDefaultRsp, uint8 seqNum );

3.16.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
clusterID - идентификатор кластера.
DiscoverRspCmd - команда отклика отклика для отправки.
direction - направление команды клиент / сервер.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

3.16.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.17 Регистрация Списка атрибутов  - Register Attribute List

3.17.1 Описание

Эта функция используется для регистрации списка атрибутов в ZCL Foundation.

3.17.2 Прототип

ZStatus_t zcl_registerAttrList( uint8 endpoint, uint8 numAttr,
zclAttrRec_t *newAttrList );

3.17.3 Подробности параметров

endpoint - конечная точка, к которой принадлежит список атрибутов.
numAttr - количество атрибутов в списке.
newAttrList - Массив записей атрибутов.

3.17.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.18 Регистрация обратного вызова проверки данных атрибута - Register Attribute Data Validation Callback

3.18.1 Описание

Эта функция используется для регистрации функции обратного вызова проверки данных атрибутов в ZCL Foundation.

3.18.2 Прототип

ZStatus_t zcl_registerVaildateAttrData(
zclValidateAttrData_t pfnValidateAttrData );

3.18.3 Подробности параметров

pfnValidateAttrData - указатель функции на процедуру проверки данных атрибута.

3.18.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.19 Регистрация обратного вызова обработчика библиотеки кластеров - Register Cluster Library Handler Callback

3.19.1 Описание

Эта функция используется для регистрации функции обратного вызова обработчика библиотеки кластеров на базовом уровне ZCL.

3.19.2 Прототип

ZStatus_t zcl_registerPlugin (uint16 startClusterID,
uint16 endClusterID,
zclInHdlr_t pfnIncomingHdlr);

3.19.3 Подробности параметров

startClusterID - идентификатор начального кластера.
endClusterID - Идентификатор конечного кластера.
pfnIncomingHdlr - указатель функции на обработчик входящих сообщений.

3.19.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.20 Обратный вызов обработчика библиотеки кластеров - Cluster Library Handler Callback

3.20.1 Описание

Эта функция обратного вызова вызывается для обработки входящего сообщения кластера от ZCL Foundation.

3.20.2 Прототип

typedef ZStatus_t (* zclInHdlr_t) (zclIncoming_t * msg);

3.20.3 Подробности параметров

msg - входящее сообщение

3.20.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.21 Регистрация Списка параметров кластера  - Register Cluster Option List

3.21.1 Описание

Эта функция используется для регистрации списка параметров кластера на базовом уровне ZCL. Этот API-интерфейс должен вызываться для обеспечения безопасности «Ключ ссылки приложения» и / или «APS ACK» или определенного кластера. «Ключ ссылки приложения» отбрасывается, если на устройстве не включена защита. Поведение по умолчанию - «Сетевой ключ», когда включена защита, и не «APS ACK» для сообщений ZCL.

3.21.2 Прототип

ZStatus_t zcl_registerClusterOptionList( uint8 endpoint,
uint8 numOption,
zclOptionRec_t optionList[] );

3.21.3 Подробности параметров

endpoint - конечная точка, к которой принадлежит список параметров.
numOption - количество опций в списке.
optionList - Массив записей параметров кластера.

3.21.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

3.22. Получение входящего сообщения Raw AF - Get the Raw AF Incoming Message

3.22.1 Описание

Эта функция используется во время функции обратного вызова для получения указателя на необработанное входящее сообщение AF. Эта функция может быть вызвана только во время функции обратного вызова ZCL, и вызывающая функция НЕ ДОЛЖНА изменять данные в сообщении.

3.22.2 Прототип

afIncomingMSGPacket_t * zcl_getRawAFMsg (void);

3.22.3 Подробности параметров

Нет.

3.22.4 Возврат

Возвращает указатель на исходное сообщение AF или NULL, если в данный момент не обрабатывает сообщение AF.

4. Общий функциональный домен

4.1 Введение

Общий функциональный домен содержит следующие кластеры:
  • Basic Базовый
  • Power Configuration Конфигурация питания
  • Device Temperature Configuration Конфигурация температуры устройства
  • Identity Идентификационные данные
  • Groups Группы
  • Scenes Сцены
  • On/Off Вкл / Выкл
  • On/Off Switch Configuration Включение / выключение конфигурация
  • Level Control Контроль уровня
  • Alarms Сигналы тревоги
  • Time Время
  • RSSI Indication RSSI Индикация
Кластеры «Основной», «Идентификационные данные», «Группы», «Сцены», «Вкл / Выкл», «Контроль уровня», «Тревоги» и «Индикация RSSI» обеспечивают команды, кроме конфигурации питания, настройки температуры устройства, конфигурации переключателя вкл / выкл и временные кластеры не предоставляют никаких команд.

4.2 Отправить Сброс к заводским настройкам (по умолчанию) - Send Reset to Factory Defaults (Basic)

4.2.1 Описание

Эта функция используется для отправки команды сброса к заводским настройкам.

4.2.2 Прототип

ZStatus_t zclGeneral_SendBasicResetFactoryDefaults( uint8 srcEP,
afAddrType_t *dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum );

4.2.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.3 Отправить Идентифицировать  - Send Identify

4.3.1 Описание

Эта функция используется для отправки команды идентификации.

4.3.2 Прототип

ZStatus_t zclGeneral_SendIdentify( uint8 srcEP,
afAddrType_t *dstAddr,
uint8 disableDefaultRsp, uint8 seqNum );

4.3.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.4 Отправить Запрос идентификации - Send Identify Query

4.4.1 Описание

Эта функция используется для отправки команды Identify Query.

4.4.2 Прототип

ZStatus_t zclGeneral_SendIdentifyQuery( uint8 srcEP,
afAddrType_t *dstAddr,
uint8 disableDefaultRsp, uint8 seqNum );

4.4.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.5 Отправить Ответ на запрос идентификации - Send Identify Query Response

4.5.1 Описание

Эта функция используется для отправки команды ответа на запрос идентификации.

4.5.2 Прототип

ZStatus_t zclGeneral_SendIdentifyQueryResponse( uint8 srcEP,
afAddrType_t *dstAddr, uint16 timeout,
uint8 disableDefaultRsp, uint8 seqNum );

4.5.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
timeout - как долго устройство будет продолжать идентифицировать себя (в секундах).
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.5.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.6 Отправить Добавить группу - Send Add Group

4.6.1 Описание

Эта функция используется для отправки команды добавления группы.

4.6.2 Прототип

ZStatus_t zclGeneral_SendGroupAdd( uint8 srcEP, afAddrType_t *dstAddr,
int16 groupID, uint8 *groupName,
uint8 disableDefaultRsp, uint8 seqNum );

4.6.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - ID группы, которая будет добавлена
groupName - имя группы, которая будет добавлена
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.6.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.7 Отправить Просмотр группы - Send View Group

4.7.1 Описание

Эта функция используется для отправки команды просмотра группы.

4.7.2 Прототип

ZStatus_t zclGeneral_SendGroupView (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 disableDefaultRsp,
uint8 seqNum);

4.7.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы для просмотра
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.7.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.8 Отправить Получить членство в группе - Send Get Group Membership

4.8.1 Описание

Эта функция используется для отправки команды Get Group Membership.

4.8.2 Прототип

ZStatus_t zclGeneral_ SendGroupGetMembership (uint8 srcEP,
afAddrType_t * dstAddr, uint8 grpCnt,
uint16 * grpList, uint8 disableDefaultRsp,
uint8 seqNum);

4.8.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
grpCnt - количество групп в списке групп
grpList - идентификаторы группы, членом которых является объект
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.8.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.9 Отправить Удалить группу - Send Remove Group

4.9.1 Описание

Эта функция используется для отправки команды удаления группы.

4.9.2 Прототип

ZStatus_t zclGeneral_ SendGroupRemove (uint8 srcEP, afAddrType_t * dstAddr,
uint16 * groupID, uint8 disableDefaultRsp,
uint8 seqNum);

4.9.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
grpList - идентификатор группы, которую нужно удалить.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.9.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.10 Отправить Удалить все группы - Send Remove All Groups

4.10.1 Описание

Эта функция используется для отправки команды Удалить все группы.

4.10.2 Прототип

ZStatus_t zclGeneral_ SendGroupRemoveAll (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.10.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.10.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.11 Отправить Добавить группу при идентификации - Send Add Group If Identifying

4.11.1 Описание

Эта функция используется для отправки команды «Добавить группу при идентификации».

4.11.2 Прототип

ZStatus_t zclGeneral_ SendGroupAddIfIdentifying (uint8 srcEP,
afAddrType_t * dstAddr, uint16 groupID,
uint8 * groupName, uint8 disableDefaultRsp,
uint8 seqNum);

4.11.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, которая будет добавлена.
disableDefaultRsp - отключить команду ответа по умолчанию.
groupName - имя группы, которая будет добавлена.
seqNum - идентификационный номер для транзакции.

4.11.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.12 Отправить Ответ Добавить Группу - Send Add Group Response

4.12.1 Описание

Эта функция используется для отправки команды Add Group Response.

4.12.2 Прототип

ZStatus_t zclGeneral_SendGroupAddResponse (uint8 srcEP,
afAddrType_t * dstAddr, статус uint8,
uint16 groupID, uint8 disableDefaultRsp,
uint8 seqNum);

4.12.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды добавления группы.
groupID - идентификатор группы, которая добавляется.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.12.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.13 Отправить Ответ Просмотр группы - Send Add Group Response

4.13.1 Описание

Эта функция используется для отправки команды просмотра группового ответа.

4.13.2 Прототип

ZStatus_t zclGeneral_ SendGroupViewResponse( uint8 srcEP,
afAddrType_t *dstAddr, uint8 status,
aps_Group_t *grp, uint8 disableDefaultRsp,
uint8 seqNum );

4.13.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды просмотра группы.
grp - информация о группе для просмотра.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.13.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.14 Отправить Получить Ответ о членстве в группе - Send Get Group Membership Response

4.14.1 Описание

Эта функция используется для отправки команды Get Group Membership Response.

4.14.2 Прототип

ZStatus_t zclGeneral_ SendGroupGetMembershipResponse( uint8 srcEP,
afAddrType_t *dstAddr, uint8 capacity,
uint8 grpCnt, uint16 *grpList,
uint8 disableDefaultRsp, uint8 seqNum );

4.14.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
capacity - оставшаяся емкость таблицы группы устройства.
grpCnt - количество групп, содержащихся в поле списка групп.
grpList - идентификаторы любой из групп в таблице групп (если список групп для получения членства в группе был пусто) или все группы из группы «Список» команды «Получить членство в группе», которые находятся в таблице групп.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.14.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.15 Отправить Ответ Удалить группу - Send Remove Group Response

4.15.1 Описание

Эта функция используется для отправки команды «Ответ Удалить  группу».

4.15.2 Прототип

ZStatus_t zclGeneral_ SendGroupRemoveResponse( uint8 srcEP,
afAddrType_t *dstAddr, uint8 status,
uint16 groupID, uint8 disableDefaultRsp,
uint8 seqNum );

4.15.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды «Удалить группу».
groupID - идентификатор группы, которая должна была быть удалена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.15.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.16 Отправить Добавить сцену - Send Add Scene

4.16.1 Описание

Эта функция используется для отправки команды Добавить сцену.

4.16.2 Прототип

ZStatus_t zclGeneral_SendSceneAdd( uint8 srcEP, afAddrType_t *dstAddr,
zclGeneral_Scene_t *scene,
uint8 disableDefaultRsp, uint8 seqNum );

4.16.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
scene - сцена, которая будет добавлена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.16.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.17 Отправить Просмотр сцены - Send View Scene

4.17.1 Описание

Эта функция используется для отправки команды просмотра сцены.

4.17.2 Прототип

ZStatus_t zclGeneral_SendSceneView (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum);

4.17.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, к которой принадлежит сцена.
sceneID - Идентификатор сцены для просмотра.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.17.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.18 Отправить Удалить сцену - Send Remove Scene

4.18.1 Описание

Эта функция используется для отправки команды удаления сцены.

4.18.2 Прототип

ZStatus_t zclGeneral_ SendSceneRemove (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum);

4.18.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, к которой принадлежит сцена.
sceneID - Идентификатор сцены, которая будет удалена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.18.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.19 Отправить Удалить все сцены - Send Remove All Scenes

4.19.1 Описание

Эта функция используется для отправки команды Удалить все сцены.

4.19.2 Прототип

ZStatus_t zclGeneral_ SendSceneRemoveAll (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 disableDefaultRsp,
uint8 seqNum);

4.19.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, для которой удаляются все сцены.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.19.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.20 Отправить Сохранить сцену - Send Store Scene

4.20.1 Описание

Эта функция используется для отправки команды Store Scene.

4.20.2 Прототип

ZStatus_t zclGeneral_SendSceneStore (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum);

4.20.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, к которой принадлежит сцена.
sceneID - Идентификатор сцены, которая будет сохранена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.20.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.21 Отправить Возврат сцены - Send Recall Scene

4.21.1 Описание

Эта функция используется для отправки команды Recall Scene.

4.21.2 Прототип

ZStatus_t zclGeneral_SendSceneRecall (uint8 srcEP, afAddrType_t * dstAddr,
int16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum);

4.21.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, к которой принадлежит сцена.
sceneID - Идентификатор сцены, которая будет вызвана.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.21.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.22 Отправить Получить Членство Сцены - Send Get Scene Membership

4.22.1 Описание

Эта функция используется для отправки команды Get Scene Membership.

4.22.2 Прототип

ZStatus_t zclGeneral_ SendSceneGetMembership (uint8 srcEP,
afAddrType_t * dstAddr, uint16 groupID,
uint8 disableDefaultRsp, uint8 seqNum);

4.22.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
groupID - идентификатор группы, членом которой является сцена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.22.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.23 Отпра​вить Ответ Добавить сцену - Send Add Scene Response

4.23.1 Описание

Эта функция используется для отправки команды «Ответ Добавить сцену».

4.23.2 Прототип

ZStatus_t zclGeneral_ SendSceneAddResponse( uint8 srcEP,
afAddrType_t *dstAddr, uint8 status,
uint16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum );

4.23.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды добавления сцены.
groupID - идентификатор группы сцены, которая была добавлена.
sceneID - Идентификатор сцены, которая была добавлена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.23.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.24 О​тправить Ответ Просмотр сцены - Send View Scene Response

4.24.1 Описание

Эта функция используется для отправки команды View Scene Response.

4.24.2 Прототип

ZStatus_t zclGeneral_ SendSceneViewResponse (uint8 srcEP,
afAddrType_t * dstAddr, status uint8,
zclGeneral_Scene_t * scene,
uint8 disableDefaultRsp, uint8 seqNum);

4.24.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды просмотра сцены.
scene - Информация о сцене для просмотра.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.24.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.25 Отправить Ответ Удалить Сцену - Send Remove Scene Response

4.25.1 Описание

Эта функция используется для отправки команды «Ответ Удалить сцену».

4.25.2 Прототип

ZStatus_t zclGeneral_ SendSceneRemove( uint8 srcEP, afAddrType_t *dstAddr,
uint8 status, uint16 groupID, uint8 sceneID,
uint8 disableDefaultRsp, uint8 seqNum );

4.25.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды «Удалить сцену».
groupID - идентификатор группы сцены, которая была удалена.
sceneID - Идентификатор сцены, которая была удалена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.25.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.26 Отправить Ответ Удалить все сцены - Send Remove Scene Response

4.26.1 Описание

Эта функция используется для отправки команды Ответ Удалить все группы.

4.26.2 Прототип

ZStatus_t zclGeneral_ SendSceneRemoveAll( uint8 srcEP, afAddrType_t *dstAddr,
uint8 status, uint16 groupID,
uint8 disableDefaultRsp, uint8 seqNum );

4.26.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды «Удалить все сцены».
groupID - идентификатор группы сцен, которые были удалены.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.26.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.27 Отправить Сохранить сцену - Send Store Scene

4.27.1 Описание

Эта функция используется для отправки команды Store Scene.

4.27.2 Прототип

ZStatus_t zclGeneral_ SendSceneRemove( uint8 srcEP, afAddrType_t *dstAddr,
uint8 status, uint16 groupID,
uint8 sceneID, uint8 disableDefaultRsp,
uint8 seqNum );

4.27.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды «Сцена хранилища».
groupID - Идентификатор группы сцены, которая была сохранена.
sceneID - Идентификатор сцены, которая была сохранена.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.27.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.28 ​Отправить Ответ Получить Членство Сцены - Send Get Scene Membership Response

4.28.1 Описание

Эта функция используется для отправки команды Get Scene Membership Response.

4.28.2 Прототип

ZStatus_t zclGeneral_ SendSceneGetMembershipResponse (uint8 srcEP,
afAddrType_t * dstAddr, статус uint8,
capacity uint8, uint8 sceneCnt, uint8 * sceneList,
uint16 groupID, uint8 disableDefaultRsp,
uint8 seqNum);

4.28.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды «Получить членство в сцене».
capacity - оставшаяся емкость таблицы сцен устройства.
sceneCnt - количество сцен, содержащихся в поле Scene List.
sceneList - идентификаторы всех сцен в таблице сцен с соответствующим идентификатором группы.
groupID - Идентификатор группы сцен.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.28.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.29 Отправить Выкл - Send Off (On/Off)

4.29.1 Описание

Эта функция используется для отправки команды выключения.

4.29.2 Прототип

ZStatus_t zclGeneral_SendOnOff_CmdOff (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.29.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.29.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.30 Отправить Вкл - Send On (On/Off)

4.30.1 Описание

Эта функция используется для отправки команды включения.

4.30.2 Прототип

ZStatus_t zclGeneral_SendOnOff_CmdOn (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.30.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.30.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.31 Отправить Переключить - Send Toggle (On/Off)

4.31.1 Описание

Эта функция используется для отправки команды переключения.

4.31.2 Прототип

ZStatus_t zclGeneral_SendOnOff_CmdToggle (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.31.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.31.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.32 Отправить Переместить на уровень - Send Move to Level (Level Control)

4.32.1 Описание

Эта функция используется для отправки команды «Переместить на уровень».

4.32.2 Прототип

ZStatus_t zclGeneral_SendLevelControlMoveToLevel( uint8 srcEP,
afAddrType_t *dstAddr, uint8 level, uint16 transTime,
uint8 disableDefaultRsp, uint8 seqNum );

4.32.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
level - новый уровень для перехода.
transTime - время (в секундах), необходимое для перехода на новый уровень.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.32.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.33 Отправить Перейти - Send Move (Level Control)

4.33.1 Описание

Эта функция используется для отправки команды перемещения.

4.33.2 Прототип

ZStatus_t zclGeneral_SendLevelControlMove( uint8 srcEP,
afAddrType_t *dstAddr, uint8 moveMode,
uint8 rate, uint8 disableDefaultRsp,
uint8 seqNum );

4.33.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
moveMode - режим перемещения.
скорость - скорость движения в шагах в секунду.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.33.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.34 Отправить Шаг  - Send Step (Level Control)

4.34.1 Описание

Эта функция используется для отправки команды Step.

4.34.2 Прототип

ZStatus_t zclGeneral_SendLevelControlStep( uint8 srcEP,
afAddrType_t *dstAddr, uint8 stepMode,
uint8 amount, uint16 transTime,
uint8 disableDefaultRsp, uint8 seqNum );

4.34.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
stepMode - пошаговый режим.
amount - количество уровней для шага.
transTime - время (в 1/10 секунды), которое должно быть принято для выполнения шага.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.34.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.35 Отправить Сброс тревоги - Send Reset Alarm (Alarm)

4.35.1 Описание

Эта функция используется для отправки команды сброса тревоги.

4.35.2 Прототип

ZStatus_t zclGeneral_ SendAlarmReset (uint8 srcEP, afAddrType_t * dstAddr,
uint8 alarmCode, uint16 clusterID,
uint8 disableDefaultRsp, uint8 seqNum);

4.35.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
alarmCode - Идентификационный код причины тревоги.
clusterID - Идентификатор кластера, атрибут которого сгенерировал сигнал тревоги.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.35.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.36 Отправить Сбросить все тревоги - Send Reset All Alarms (Alarm)

4.36.1 Описание

Эта функция используется для отправки команды «Сбросить все тревоги».

4.36.2 Прототип

ZStatus_t zclGeneral_ SendAlarmResetAll (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.36.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.36.4 Возврат

ZStatus_t - перечисление найдено в ZComDef.h

4.37 Отправить Получить тревоги - Send Get Alarm (Alarm)

4.37.1 Описание

Эта функция используется для отправки команды Get Alarm.

4.37.2 Прототип

ZStatus_t zclGeneral_ SendAlarmGet (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.37.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.37.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.38 Отправить Сброс журнала тревоги - Send Reset Alarm Log (Alarm)

4.38.1 Описание

Эта функция используется для отправки команды Reset Alarm Log.

4.38.2 Прототип

ZStatus_t zclGeneral_ SendAlarmResetLog (uint8 srcEP, afAddrType_t * dstAddr,
uint8 disableDefaultRsp, uint8 seqNum);

4.38.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.38.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.39 Отправить Тревога - Send Alarm (Alarm)

4.39.1 Описание

Эта функция используется для отправки команды тревоги.

4.39.2 Прототип

ZStatus_t zclGeneral_ SendAlarm (uint8 srcEP, afAddrType_t * dstAddr,
uint8 alarmCode, uint16 clusterID,
uint8 disableDefaultRsp, uint8 seqNum);

4.39.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
alarmCode - Идентификационный код причины тревоги.
clusterID - Идентификатор кластера, атрибут которого сгенерировал сигнал тревоги.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.39.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.40 Отправить Ответа о получении тревоги - Send Get Alarm Response (Alarm)

4.40.1 Описание

Эта функция используется для отправки команды Get Alarm Response.

4.40.2 Прототип

ZStatus_t zclGeneral_SendAlarmGetRespnose (uint8 srcEP,
afAddrType_t * dstAddr, status uint8,
uint8 alarmCode, uint16 clusterID,
uint32 timeStamp, uint8 disableDefaultRsp,
uint8 seqNum);

4.40.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
status - статус команды Get Alarm.
alarmCode - Идентификационный код причины тревоги.
timeStamp - время, когда произошла тревога.
clusterID - Идентификатор кластера, атрибут которого сгенерировал сигнал тревоги.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.40.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.41 Отправить Установить Абсолютное Местоположение -Send Set Absolute Location (RSSI Location)

4.41.1 Описание

Эта функция используется для отправки команды «Установить абсолютное местоположение».

4.41.2 Прототип

ZStatus_t zclGeneral_SendLocationSetAbsolute (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationAbsolute_t * absLoc,
uint8 disableDefaultRsp,
uint8 seqNum);

4.41.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
absLoc - Абсолютная информация о местоположении.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.41.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.42 Отправить Установить Конфигурацию устройства - Send Set Device Configuration (RSSI Location)

4.42.1 Описание

Эта функция используется для отправки команды Set Device Configuration.

4.42.2 Прототип

ZStatus_t zclGeneral_SendLocationSetDevCfg (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationDevCfg_t * devCfg,
uint8 disableDefaultRsp,
uint8 seqNum);

4.42.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
devCfg - Информация о конфигурации устройства.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.42.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.43 Отправить Получить конфигурацию устройства - Send Get Device Configuration (RSSI Location)

4.43.1 Описание

Эта функция используется для отправки команды Get Device Configuration.

4.43.2 Прототип

ZStatus_t zclGeneral_SendLocationGetDevCfg (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 * targetAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

4.43.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
targetAddr - 64-битный адрес IEEE устройства, для которого запрашиваются параметры местоположения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.43.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.44 Отправить Получить данные о местоположении - Send Get Location Data (RSSI Location)

4.44.1 Описание

Эта функция используется для отправки команды Get Location Data.

4.44.2 Прототип

ZStatus_t zclGeneral_ SendLocationGetData (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationGetData_t * locData,
uint8 disableDefaultRsp,
uint8 seqNum);

4.44.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
locData - информация о местоположении устройства и параметры канала, которые запрашиваются.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.44.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.45 Отправить Ответ о конфигурации устройства - Send Device Configuration Response (RSSI Location)

4.45.1 Описание

Эта функция используется для отправки команды ответа конфигурации устройства.

4.45.2 Прототип

ZStatus_t zclGeneral_SendLocationDevCfgResponse (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationDevCfgRsp_t * devCfg,
uint8 disableDefaultRsp,
uint8 seqNum);

4.45.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
devCfg - запрашиваемые параметры местоположения устройства.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.45.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.46 Отправить Ответ Данные о местоположении - Send Location Data Response (RSSI Location)

4.46.1 Описание

Эта функция используется для отправки команды ответа о местоположении.

4.46.2 Прототип

ZStatus_t zclGeneral_SendLocationDataResponse (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationDataRsp_t * locData,
uint8 disableDefaultRsp,
uint8 seqNum);

4.46.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
locData - информация о местоположении устройства и параметры канала, которые запрашиваются.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.46.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.47 Отправить Уведомление о местоположении - Send Location Data Notification (RSSI Location)

4.47.1 Описание

Эта функция используется для отправки команды уведомления о местоположении.

4.47.2 Прототип

ZStatus_t zclGeneral_SendLocationData Notif (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationData_t * locData,
uint8 disableDefaultRsp,
uint8 seqNum);

4.47.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
locData - информация о местоположении устройства и параметры канала, которые запрашиваются.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.47.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.48. Отправить Компактное уведомления о местоположении - Send Compact Location Data Notification (RSSI Location)

4.48.1 Описание

Эта функция используется для отправки команды уведомления о компактном местоположении.

4.48.2 Прототип

ZStatus_t zclGeneral_SendLocationDataCompactNotif (uint8 srcEP,
afAddrType_t * dstAddr,
zclLocationData_t * locData,
uint8 disableDefaultRsp,
uint8 seqNum);

4.48.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
locData - информация о местоположении устройства и параметры канала, которые запрашиваются.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.48.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.49 Отправить RSSI Ping - Send RSSI Ping (RSSI Location)

4.49.1 Описание

Эта функция используется для отправки команды RSSI Ping.

4.49.2 Прототип

ZStatus_t zclGeneral_ SendRSSIPing (uint8 srcEP, afAddrType_t * dstAddr,
uint8 locationType,
uint8 disableDefaultRsp, uint8 seqNum);

4.49.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
locationType - Тип местоположения устройства.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

4.49.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.50 Обратный вызов проверки данных атрибута - Attribute Data Validation Callback

4.50.1 Описание

Этот обратный вызов вызывается, чтобы увидеть, находится ли предоставленное значение для данных атрибута в пределах указанного диапазона атрибута.

4.50.2 Прототип

typedef uint8 (* zclValidateAttrData_t) (zclAttrRec_t * pAttr,
zclWriteRec_t * pAttrInfo);

4.50.3 Подробности параметров

pAttr - где данные должны быть записаны.
pAttrInfo - указатель на идентификатор атрибута, тип и данные.

4.50.4 Возврат

Uint8 - TRUE, если данные атрибута верны. FALSE в противном случае.

4.51 Регистрация обратного вызова команды приложения - Register Application Command Callback

4.51.1 Описание

Эта функция используется для регистрации обратных вызовов команд приложения в общем функциональном домене.

4.51.2 Прототип

ZStatus_t zclGeneral_RegisterCmdCallbacks (endpoint uint8,
zclGeneral_AppCallbacks_t * callbacks);

4.51.3 Подробности параметров

endpoint - конечная точка приложения.
callbacks - указатель на записи обратного вызова.

4.51.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

4.52 Обратный вызов Сброс по умолчанию - Reset to Factory Defaults Callback

4.52.1 Описание

Этот обратный вызов вызывается для обработки входящей команды сброса к заводским настройкам. После получения этой команды устройство сбрасывает все атрибуты всех своих кластеров на заводские настройки по умолчанию.

4.52.2 Прототип

typedef void (* zclGCB_BasicReset_t) (void);

4.52.3 Подробности параметров

Нет.

4.52.4 Возврат

Нет.

4.53 Обратный вызов Определить  - Identify Callback

4.53.1 Описание

Этот обратный вызов вызывается для обработки входящей команды идентификации.

4.53.2 Прототип

typedef void (* zclGCB_Identify_t) (zclIdentify_t * pCmd);

4.53.3 Подробности параметров

pCmd - полученная команда идентификации, которая имеет следующие поля:
srcAddr - адрес запрашивающего.
identifTime - количество секунд, в течение которых устройство должно продолжать идентифицировать себя.

4.53.4 Возврат

Нет.

4.54 Обратный вызов Ответ идентификации  - Identify Response Callback

4.54.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа идентификации.

4.54.2 Прототип

typedef void (* zclGCB_IdentifyRsp_t) (zclIdentifyQueryRsp_t * pRsp);

4.54.3 Подробности параметров

pRsp - полученный ответ Identify, который имеет следующие поля:
srcAddr - адрес запрашивающего.
timeout - количество секунд, в течение которых устройство будет идентифицировать себя.

4.54.4 Возврат

Нет.

4.55 Обратный вызов Вкл / Выкл / Переключить - On/Off/Toggle Callback

 

4.55.1 Описание

Этот обратный вызов вызывается для обработки входящей команды On, Off или Toggle.

4.55.2 Прототип

typedef void (* zclGCB_OnOff_t) (uint8 cmd);

4.55.3 Подробности параметров

cmd - полученная команда: COMMAND_ON, COMMAND_OFF или COMMAND_TOGGLE.

4.55.4 Возврат

Нет.

4.56 Обратный вызов Перейти к уровню - Move to Level Callback

4.56.1 Описание

Этот обратный вызов вызывается для обработки входящей команды управления уровнем - Перейти к уровню.

4.56.2 Прототип

typedef void (* zclGCB_LevelControlMoveToLevel_t) (zclLCMoveToLevel_t * pCmd);

4.56.3 Подробности параметров

pCmd - получена команда Move to Level, имеющая следующие поля:
level - новый уровень для перехода.
transitionTime - время, необходимое для перехода на новый уровень (в секундах).
withOnOff - с командой включения / выключения.

4.56.4 Возврат

Нет.

4.57 Обратный вызов Переместить - Move Callback

4.57.1 ​​Описание

Этот обратный вызов вызывается для обработки входящей команды управления уровнем - перемещение.

4.57.2 Прототип

typedef void (* zclGCB_LevelControlMove_t) (zclLCMove_t * pCmd);

4.57.3 Подробности параметров

pCmd - полученная команда Move, которая имеет следующие поля:
moveMode - режим перемещения, который является либо LEVEL_MOVE_STOP, LEVEL_MOVE_UP, LEVEL_MOVE_ON_AND_UP, LEVEL_MOVE_DOWN или LEVEL_MOVE_DOWN_AND_OFF.
rate - скорость движения в шагах в секунду.
withOnOff - с командой включения / выключения.

4.57.4 Возврат

Нет.

4.58 Обратный вызов Ш​аг - Step Callback

4.58.1 Описание

Этот обратный вызов вызывается для обработки входящей команды «Контроль уровня - шаг».

4.58.2 Прототип

typedef void (* zclGCB_LevelControlStep_t) (zclLCStep_t * pCmd);

4.58.3 Подробности параметров

pCmd - полученная команда Step, которая имеет следующие поля:
stepMode - режим шага: LEVEL_STEP_UP, LEVEL_STEP_ON_AND_UP, LEVEL_STEP_DOWN или LEVEL_STEP_DOWN_AND_OFF.
amount - количество уровней для шага.
transitionTime - время в 1/10 секунды, необходимое для выполнения шага.
withOnOff - с командой включения / выключения.

4.58.4 Возврат

Нет.

4.59 Обратный вызов Шаг - Step Callback

4.59.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Контроль уровня - Стоп.

4.59.2 Прототип

typedef void (* zclGCB_LevelControlStop_t) (void);

4.59.3 Подробности параметров

Нет.

4.59.4 Возврат

Нет.

4.60 Обратный вызов Ответ Группа - Group Response Callback

4.60.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа группы. Это означает, что это приложение отправило запросить сообщение.

4.60.2 Прототип

typedef void (* zclGCB_GroupRsp_t) (zclGroupRsp_t * pRsp);

4.60.3 Подробности параметров

pRsp - полученный ответ группы, имеющий следующие поля:
srcAddr - адрес запрашивающего.
cmdID - идентификатор сообщения: COMMAND_GROUP_ADD_RSP, COMMAND_GROUP_VIEW_RSP,COMMAND_GROUP_REMOVE_RSP или COMMAND_GROUP_GET_MEMBERSHIP_RSP.
status - статус, который является GROUP_STATUS_SUCCESS, GROUP_STATUS_TABLE_FULL, GROUP_STATUS_ALREADY_IN_TABLE или GROUP_STATUS_NOT_IN_TABLE. Не действует для COMMAND_GROUP_GET_MEMBERSHIP_RSP.
grpCnt - количество групп, содержащихся в списке групп.
grpList - идентификаторы группы, над которыми было выполнено действие.
capacity - оставшаяся емкость групповой таблицы.
grpName - Имя группы (действительно только для COMMAND_GROUP_VIEW_RSP).

4.60.4 Возврат

Нет.

4.61 Обратный вызов Сохранить Сцену - Store Scene Callback

4.61.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Store Scene. Приложение заполнит "extField" с что нужно для восстановления его текущих настроек.

4.61.2 Прототип

typedef uint8 (* zclGCB_SceneStoreReq_t) (zclSceneReq_t * pReq);

4.61.3 Подробности параметров

pReq - получен запрос Scene Store, который имеет следующие поля:
srcAddr - адрес запрашивающего.
scene- информация о сцене.

4.61.4 Возврат

TRUE, если extField заполнен, FALSE в противном случае (в этом случае нет необходимости сохранять сцену).

4.62 Обратный вызов Отзыв Сцены  - Recall Scene Callback

4.62.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Recall Scene. Приложение будет использовать то, что в "extField", чтобы восстановить эти настройки.

4.62.2 Прототип

typedef void (* zclGCB_SceneRecallReq_t) (zclSceneReq_t * pReq);

4.62.3 Подробности параметров

pReq - полученный запрос повторного вызова сцены, имеющий следующие поля:
srcAddr - адрес запрашивающего.
сцена - информация о сцене.

4.62.4 Возврат

Нет.

4.63 Обратный вызов Ответ Сцена - Scene Response Callback

4.63.1 Описание

Этот обратный вызов вызывается для обработки входящего ответного сообщения сцены. Это означает, что это приложение отправило запросить этот ответ.

4.63.2 Прототип

typedef void (* zclGCB_SceneRsp_t) (zclSceneRsp_t * pRsp);

4.63.3 Подробности параметров

pReq - полученный ответ Scene, имеющий следующие поля:
srcAddr - адрес запрашивающего.
cmdID - идентификатор сообщения, который является COMMAND_SCENE_ADD_RSP, COMMAND_SCENE_VIEW_RSP, COMMAND_SCENE_REMOVE_RSP, COMMAND_SCENE_REMOVE_ALL_RSP, COMMAND_SCENE_STORE_RSP или COMMAND_SCENE_GET_MEMBERSHIPSHIP_RSP.
status - статус команды сцены.
sceneCnt - количество сцен, содержащихся в списке сцен (действительно только для COMMAND_SCENE_GET_MEMBERSHIPSHIP_RSP)
sceneList - список идентификаторов сцены (действителен только для COMMAND_SCENE_GET_MEMBERSHIPSHIP_RSP)
capacity - оставшаяся емкость таблицы сцены (действительна только для COMMAND_SCENE_GET_MEMBERSHIPSHIP_RSP)
scene - информация о сцене.

4.63.4 Возврат

Нет.

4.64 Обратный вызов Тревога - Alarm Callback

4.64.1 Описание

Этот обратный вызов вызывается для обработки входящего запроса тревоги или ответной команды.

4.64.2 Прототип

typedef void (* zclGCB_Alarm_t) (zclAlarm_t * pAlarm);

4.64.3 Подробности параметров

pReq - получен запрос Alarm, имеющий следующие поля:
srcAddr - адрес запрашивающего.
cmdID - идентификатор сообщения, который является либо COMMAND_ALARMS_ALARM, либо COMMAND_ALARMS_GET_RSP
status - статус команды тревоги (применимо только к COMMAND_ALARMS_GET_RSP).
alarmCode - Идентификационный код причины тревоги.
clusterID - идентификатор кластера, атрибут которого сгенерировал этот сигнал
timeStamp - время, когда произошла тревога (применимо только к COMMAND_ALARMS_GET_RSP)

4.64.4 Возврат

Нет.

4.65 Обратный вызов Местоположение  - Location Callback

4.65.1 Описание

Этот обратный вызов вызывается для обработки входящей команды местоположения RSSI.

4.65.2 Прототип

typedef void (* zclGCB_Location_t) (zclLocation_t * pCmd);

4.65.3 Подробности параметров

pReq - полученная команда Location, которая имеет следующие поля:
srcAddr - адрес запрашивающего.
cmdID - идентификатор сообщения, который является COMMAND_LOCATION_SET_ABSOLUTE, COMMAND_LOCATION_SET_DEV_CFG, COMMAND_LOCATION_GET_DEV_CFG или COMMAND_LOCATION_GET_DATA.
absLoc - информация об абсолютном местоположении (действительна только для COMMAND_LOCATION_SET_ABSOLUTE).
loc - информация о местоположении (действительна только для COMMAND_LOCATION_GET_DATA).
devCfg - Информация о конфигурации устройства (действительна только для COMMAND_LOCATION_SET_DEV_CFG).
ieeeAddr - IEEE-адрес устройства (действителен только для COMMAND_LOCATION_GET_DEV_CFG).
seqNum - порядковый номер, полученный с сообщением (действителен только для команд GET).

4.65.4 Возврат

Нет.

4.66 Обратный вызов Ответ Местоположение - Location Response Callback

4.66.1 Описание

Этот обратный вызов вызывается для обработки входящего ответа местоположения RSSI. Это означает, что это приложение отправило запросить этот ответ.

4.66.2 Прототип

typedef void (* zclGCB_LocationRsp_t) (zclLocationRsp_t * pRsp);

4.66.3 Подробности параметров

pReq - полученный ответ Location, имеющий следующие поля:
srcAddr - адрес запрашивающего.
cmdID - идентификатор сообщения, который является COMMAND_LOCATION_DEV_CFG_RSP, COMMAND_LOCATION_DATA_RSP, COMMAND_LOCATION_DATA_NOTIF, COMMAND_LOCATION_COMPACT_DATA_NOTIF или COMMAND_LOCATION_RSSI_PING
locRsp - команда ответа на данные о местоположении (применима ко всем сообщениям с ответами на данные / уведомлениям).
devCfgRsp - команда ответа конфигурации устройства (применима только к COMMAND_LOCATION_DEV_CFG_RSP).
locationType - Тип местоположения (применимо только к COMMAND_LOCATION_RSSI_PING).

4.66.4 Возврат

Нет.

4.67. Обратный вызов Счение счетчика сцен - Read Scene Count Callback

4.67.1 Описание

Этот обратный вызов используется для считывания количества сцен, сохраненных в таблице сцен локального устройства (то есть, Количество сцен
атрибут). Эта функция должна быть зарегистрирована на базовом уровне ZCL (используя zcl_registerReadWriteCB () API), когда указатель данных dataPtr атрибута Scene Count установлен в NULL в базе данных атрибутов, чтобы зарегистрирован в ZCL. Эта функция обратного вызова будет использоваться задачей ZCL для обработки операции запроса чтения ZCL на атрибуте количества сцен.

4.67.2 Прототип

ZStatus_t zclGeneral_ReadSceneCountCB (uint16 clusterId, uint16 attrId,
uint8 oper, uint8 * pValue,
uint16 * pLen);

4.67.3 Подробности параметров

clusterId - кластер, которому принадлежит атрибут
attrId - атрибут для чтения
oper - ZCL_OPER_LEN для получения длины атрибута или ZCL_OPER_READ для чтения значения атрибута
pValue - указатель на значение атрибута
pLen - указатель на длину прочитанного значения атрибута

4.67.4 Возврат

ZCL_STATUS_SUCCESS - Операция чтения прошла успешно.
ZCL_STATUS_SOFTWARE_FAILURE - Операция чтения не удалась.

5. Функциональный домен Закрытие  - Closures Functional Domain

5.1 Введение

Функциональный домен Closures предоставляет следующие два кластера, определенных Home Automation Public
Профиль приложения:
  • Door Lock Cluster Дверной замок 
  • Window Covering Cluster Кластер закрывания окон 
Кластер дверных замков обеспечивает общий интерфейс для защиты двери.
Windows Covering Cluster предоставляет интерфейс для управления и настройки автоматических оконных рольставней, таких как моторы драпировки, автоматические шторы и жалюзи.

5.2 Команда блокировки дверей - Lock Door Command

5.2.1 Описание

Эта команда заставляет устройство блокировки заблокировать дверь.

5.2.2 Прототип

ZStatus_t zclClosures_SendDoorLock (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

5.2.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

5.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.3 Команда разблокировки двери - Unlock Door Command

5.3.1 Описание

Эта команда заставляет блокирующее устройство открывать дверь.

5.3.2 Прототип

ZStatus_t zclClosures_SendDoorUnlock (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

5.3.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

5.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.4 Команда Ответ блокировки дверного замка - Door Lock Response Command

5.4.1 Описание

Эта команда отправляется в ответ на команду блокировки.

5.4.2 Прототип

ZStatus_t zclClosures_SendDoorLockRes (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
status uint8);

5.4.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
status - статус команды, ZCL_SUCCESS или ZCL_FAILURE

5.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.5 Ответ Разблокировки двери - Unlock Door Response

5.5.1 Описание

Эта команда отправляется в ответ на команду разблокировки двери.

5.5.2 Прототип

ZStatus_t zclClosures_SendDoorUnlockRes (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
status uint8);

5.5.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
status - статус команды, ZCL_SUCCESS или ZCL_FAILURE

5.5.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.6 Команда Вверх/Открыть - Up / Open Command (Window Covering)

5.6.1 Описание

Эта функция используется для отправки команды Up / Open.

5.6.2 Прототип

ZStatus_t zclClosures_SendUpOpen (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

5.6.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

5.6.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.7 Команда Вниз/Закрыть - Down / Close Command (Window Covering)

5.7.1 Описание

Эта функция используется для отправки команды «Вниз / Закрыть».

5.7.2 Прототип

ZStatus_t zclClosures_SendDownClose (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

5.7.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

5.7.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.8 Команда Стоп - Stop Command (Window covering)

5.8.1 Описание

Эта функция используется для отправки команды стоп.

5.8.2 Прототип

ZStatus_t zclClosures_SendStop (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

5.8.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

5.8.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.9 Команда «Поднять на заданное значение» - Go to Lift Setpoint Command (Window Covering)

5.9.1 Описание

Эта функция используется для отправки команды «Перейти к заданному значению подъема».

5.9.2 Прототип

ZStatus_t zclClosures_SendGoToLiftSetpoint (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint8 liftSetpoint);

5.9.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
liftSetpoint - Индекс уставки подъема.

5.9.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.10 Команда Поднять на Значение - Go To Lift Value Command (Window Covering)

5.10.1 Описание

Эта функция используется для отправки команды «Перейти к заданному значению подъема».

5.10.2 Прототип

ZStatus_t zclClosures_SendGoToLiftValue (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint16 liftValue);

5.10.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
liftValue - значение Lift.

5.10.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.11 Команда «Поднять на Процент» - Go To Lift Percentage Command (Window Covering)

5.11.1 Описание

Эта функция используется для отправки команды «Поднять на процент».

5.11.2 Прототип

ZStatus_t zclClosures_SendGoToLiftPercentage (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint8 percentageLiftValue);

5.11.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
percentageLiftValue - значение процентного подъема.

5.11.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.12 Команде Наклон на заданное значение - Go to Tilt Setpoint Command (Window Covering)

5.12.1 Описание

Эта функция используется для отправки команды «Наклон на заданное значение».

5.12.2 Прототип

ZStatus_t zclClosures_SendGoToTiltSetpoint (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint8 tiltSetpoint);

5.12.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
tiltSetpoint - Индекс установленного значения наклона.

5.12.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.13 Команда Наклонить на Значение - Go To Tilt Value Command (Window Covering)

5.13.1 Описание

Эта функция используется для отправки команды «Наклонить на Значение».

5.13.2 Прототип

ZStatus_t zclClosures_SendGoToTiltValue (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint16 tiltValue);

5.13.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
tiltValue - значение подъема.

5.13.4 Возврат

ZStatus_t - перечисление найдено в ZComDef.h

5.14 Команда Наклонить на Процент - Go To Tilt Percentage (Window Covering)

5.14.1 Описание

Эта функция используется для отправки команды Go to Tilt Percentage.

5.14.2 Прототип

ZStatus_t zclClosures_SendGoToTiltPercentage (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
uint8 percentageTiltValue);

5.14.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
percentageTiltValue - значение подъема процента.

5.14.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.15 Команда Задать предуставки - Program Setpoint Command (Window Covering)

5.15.1 Описание

Эта функция используется для отправки команды задания предуставки, чтобы запрограммировать заданную уставку подъема или наклона с помощью
определенное значение (ВЕРСИЯ 1) или для программирования определенных предуставок подъема и наклона с текущими значениями подъема и наклона (ВЕРСИЯ 2).

5.15.2 Прототип

ZStatus_t zclClosures_SendProgramSetpoint (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 disableDefaultRsp,
uint8 seqNum,
programSetpointPayload_t * programSetpoint);

5.15.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.
programSetpoint - уставка для программирования, которая имеет следующие поля:
version - версия команды Уставки программы
setpointIndex - Индекс уставки
setpointValue - значение уставки (используется только в ВЕРСИИ 1)
setpointType - Тип уставки; он должен быть подъемным или наклонным (используется только в ВЕРСИИ 1)

5.15.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.16 Обратный вызов Дверной замок - Door Lock

5.16.1 Описание

Этот обратный вызов вызывается для обработки входящей команды блокировки / разблокировки дверей.

5.16.2 Прототип

typedef void (* zclClosures_DoorLock_t) (zclIncoming_t * pInMsg,
zclDoorLock_t * pInCmd)

5.16.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pInCmd - указатель на PIN / RFID код.

5.16.4 Возврат

Нет.

5.17 Обратный вызов Ответ Дверной замок - Door Lock Response Callback

5.17.1 Описание

Этот обратный вызов вызывается для обработки входящего ответа блокировки / разблокировки двери

5.17.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockRsp_t) (zclIncoming_t * pInMsg,
uint8 status);

5.17.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - статус ответа.

5.17.4 Возврат

ZCL_STATUS_SUCCESS или ZCL_STATUS_FAILURE. Байт состояния только указывает, имеет ли сообщение получил успешно.

5.18 Обратный вызов Разблокировка по тайм-ауту - Unlock With Timeout Callback

5.18.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Unlock With Timeout: эта команда вызывает блокировку устройства и разблокировку двери с параметром тайм-аута. По истечении времени в секундах, указанного в поле времени ожидания, устройство блокировки  автоматически заблокируется.

5.18.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockUnlockWithTimeout_t)
(zclIncoming_t * pInMsg, zclDoorLockUnlockTimeout_t * pCmd);

5.18.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.18.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.19 Обратный вызов Получить журнал записей - Get Log Record Callback

5.19.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Log Record.

5.19.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetLogRecord_t)
(zclIncoming_t * pInMsg, zclDoorLockGetLogRecord_t * pCmd);

5.19.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.19.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.20 Обратный вызов Установить PIN-код  - Set PIN Code Callback

5.20.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set PIN Code.

5.20.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetPINCode_t);
(zclIncoming_t * pInMsg, zclDoorLockSetPINCode_t * pCmd)

5.20.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.20.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.21 Обратный вызов Получить PIN - Get PIN Code command Callback

5.21.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get PIN Code.

5.21.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetPINCode_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.21.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.21.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.22 Обратный вызов Очистить ПИН код - Clear PIN Code Callback

5.22.1 Описание

Этот обратный вызов вызывается для обработки входящей команды очистки PIN-кода.

5.22.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearPINCode_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.22.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.22.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.23 Обратный вызов Очистить все PIN-коды - Clear All PIN Codes Callback

5.23.1 Описание

Этот обратный вызов вызывается для обработки входящей команды очистки всех PIN-кодов.

5.23.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearAllPINCodes_t)
(zclIncoming_t * pInMsg);

5.23.3 Подробности параметров

pInMsg - указатель на входящее сообщение.

5.23.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.24 Обратный вызов Установка статуса пользователя - Set User Status Callback

5.24.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set User Status.

5.24.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetUserStatus_t)
(zclIncoming_t * pInMsg, zclDoorLockSetUserStatus_t * pCmd);

5.24.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.24.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.25 Обратный вызов Получить статус пользователя  - Get User Status Callback

5.25.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get User Status.

5.25.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetUserStatus_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.25.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.25.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.26 Обратный вызов Установить день недели в расписании - Set Week Day Schedule Callback

5.26.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set Week Day Schedule.

5.26.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetWeekDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSetWeekDaySchedule_t * pCmd);

5.26.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.26.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.27 Обратный вызов Получить день недели в расписании - Get Week Day Schedule Callback

5.27.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Week Day Schedule.

5.27.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetWeekDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSchedule_t * pCmd);

5.27.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.27.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.28 Обратный вызов Очистить день недели в расписании  - Clear Week Day Schedule Callback

5.28.1 Описание

Этот обратный вызов вызывается для обработки входящей команды «Очистить расписание дня недели».

5.28.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearWeekDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSchedule_t * pCmd);

5.28.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.28.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.2​9 Обратный вызов Установить год в расписании - Set Year Day Schedule Callback

5.29.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set Year Day Schedule.

5.29.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetYearDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSchedule_t * pCmd);

5.29.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.29.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.30 Обратный вызов Получить год в расписании - Get Year Day Schedule Callback

5.30.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Year Day Schedule.

5.30.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetYearDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSchedule_t * pCmd);

5.30.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.30.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.31 Обратный вызов Очистить год в расписании - Clear Year Day Schedule Callback

5.31.1 Описание

Этот обратный вызов вызывается для обработки входящей команды «Очистить год в расписании».

5.31.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearYearDaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSchedule_t * pCmd);

5.31.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.31.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.32 Обратный вызов Установить праздничный день в расписании - Set Holiday Schedule Callback

5.32.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set Holiday Schedule.

5.32.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetHolidaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockSetHolidaySchedule_t * pCmd);

5.32.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.32.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.33. Обратный вызов Получить праздничный день в расписании - Get Holiday Schedule Callback

5.33.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Holiday Schedule.

5.33.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetHolidaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockHolidayScheduleID_t * pCmd);

5.33.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.33.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.34 Обраный вызов Очистить праздничный день в расписании - Clear Holiday Schedule Callback

5.34.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Clear Holiday Schedule.

5.34.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearHolidaySchedule_t)
(zclIncoming_t * pInMsg, zclDoorLockHolidayScheduleID_t * pCmd);

5.34.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.34.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.35 Обратный вызов Установить тип пользователя - Set User Type Callback

5.35.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set User Type.

5.35.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetUserType_t)
(zclIncoming_t * pInMsg, zclDoorLockSetUserType_t * pCmd);

5.35.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.35.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.36 Обратный вызов Получить тип пользователя - Get User Type Callback

5.36.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get User Type.

5.36.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetUserType_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.36.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.36.4 Возврат

ZStatus_t - перечисление найдено в ZComDef.h

5.37 Обратный вызов Установка кода RFID - Set RFID Code Callback

5.37.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set RFID Code.

5.37.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetRFIDCode_t)
(zclIncoming_t * pInMsg, zclDoorLockSetRFIDCode_t * pCmd);

5.37.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.37.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.38 Обратный вызов Получить код RFID - Get RFID Code Callback

5.38.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get RFID Code.

5.38.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetRFIDCode_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.38.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.38.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.39 Обратный вызов Очистить код RFID - Clear RFID Code Callback

5.39.1 Описание

Этот обратный вызов вызывается для обработки входящей команды очистки кода RFID.

5.39.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearRFIDCode_t)
(zclIncoming_t * pInMsg, zclDoorLockUserID_t * pCmd);

5.39.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.39.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.40 Обратный вызов Очистить все RFID-коды - Clear All RFID Codes Callback

5.40.1 Описание

Этот обратный вызов вызывается для обработки входящей команды очистки всех кодов RFID.

5.40.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearAllRFIDCodes_t)
(zclIncoming_t * pInMsg);

5.40.3 Подробности параметров

pInMsg - указатель на входящее сообщение.

5.40.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.41 Обратный вызов Ответ Блокировка дверного замка - Lock Door Response Callback

5.41.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа дверного замка.

5.41.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.41.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.41.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.42 Обратный вызов Ответ Разблокировки по тайм-ауту - Unlock With Timeout Response Callback

5.42.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Unlock With Timeout Response.

5.42.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockUnlockWithTimeoutRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.42.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.42.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.43. Обратный вызов Получение журнала записей - Get Log Record Response Callback

5.43.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Log Record Response.

5.43.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetLogRecordRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetLogRecordRsp_t * pCmd);

5.43.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.43.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.44 Обратный вызов Ответ Установить ПИН-код - Set PIN Code Response Callback

5.44.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set PIN Code Response.

5.44.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetPINCodeRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.44.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.44.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.45 Обратный вызов Ответ Получить ПИН код - Get PIN Code Response Callback

5.45.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на получение PIN-кода.

5.45.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetPINCodeRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetPINCodeRsp_t * pCmd);

5.45.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.45.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.46 Обратный вызов Ответ Очистить ПИН-код - Clear PIN Code Response Callback

5.46.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа очистки PIN-кода.

5.46.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearPINCodeRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.46.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.46.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.47 Обратный вызов Ответ Очистить все PIN-коды - Clear All PIN Codes Response Callback

5.47.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа Очистить все PIN-коды.

5.47.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearAllPINCodesRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.47.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.47.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.48 Обратный вызов Ответ Установить статус пользователя - Set User Status Response Callback

5.48.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set User Status Response.

5.48.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetUserStatusRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.48.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.48.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.49. Обратный вызов Ответ Получение статуса пользователя - Get User Status Response Callback

5.49.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get User Status Response.

5.49.2 Прототип

typedef (* zclClosures_DoorLockGetUserStatusRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetUserStatusRsp_t * pCmd);

5.49.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.49.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.50 Обратный вызов Ответ Установить день недели в расписании  - Set Week Day Schedule Response Callback

5.50.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на расписание Set Week Day Schedule.

5.50.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetWeekDayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.50.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.50.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.51 Обратный вызов Ответ Получить день недели в расписании - Get Week Day Schedule Response Callback

5.51.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Schedule Response Get Week Day.

5.51.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetWeekDayScheduleRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetWeekDayScheduleRsp_t * pCmd);

5.51.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.51.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.52 Обратный вызов Ответ Очистить день недели в расписании - Clear Week Day Schedule Response Callback

5.52.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на расписание очистки дня недели.

5.52.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearWeekDayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.52.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.52.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.53 Обратный вызов Ответ Очистить день недели в расписании  - Clear Week Day Schedule Response Callback

5.53.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на расписание очистки дня недели.

5.53.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearWeekDayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.53.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.53.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.54 Обратный вызов Ответ Задать год в расписании  - Set Year Day Schedule Response Callback

5.54.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на задание года в расписании.

5.54.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetYearDayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.54.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.54.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.55. Обратный вызов Ответ Получить год в расписании - Get Year Day Schedule Response Callback

5.55.1 Описание

Этот обратный вызов вызывается для обработки входящей команды «Получить ответ на расписание дня в году».

5.55.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetYearDayScheduleRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetYearDayScheduleRsp_t * pCmd);

5.55.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.55.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.56 Обратный вызов Ответ Очистить Год в расписании - Clear Year Day Schedule Response Callback

5.56.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на отчет о расписании дня в году.

5.56.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearYearDayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.56.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.56.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.57 Обрытный вызов Ответ Установить праздничный день в расписании - Set Holiday Schedule Response Callback

5.57.1 ​​Описание

Этот обратный вызов вызывается для обработки входящей команды Set Schedule Response.

5.57.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetHolidayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.57.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.57.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.58. Обратный вызов Ответ Получить праздничный день в расписании - Get Holiday Schedule Response Callback

5.58.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Schedule Response.

5.58.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetHolidayScheduleRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetHolidayScheduleRsp_t * pCmd);

5.58.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.58.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.59 Обратный вызов Ответ Очистить праздничный день в  расписании - Clear Holiday Schedule Response Callback

5.59.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа Clear Schedule Response.

5.59.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearHolidayScheduleRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.59.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.59.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.60. Обратный вызов Ответ Установка типа пользователя - Set User Type Response Callback

5.60.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set User Type Response.

5.60.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetUserTypeRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.60.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.60.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h

5.61. Обратный вызов Ответ Получить тип пользователя - Get User Type Response Callback

5.61.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get User Type Response.

5.61.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetUserTypeRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetUserTypeRsp_t * pCmd);

5.61.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.61.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.62. Обратный вызов Ответ Установка кода RFID - Set RFID Code Response Callback

5.62.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Set RFID Code Response.

5.62.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockSetRFIDCodeRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.62.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.62.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.63. Обратный вызов Ответ Получить код RFID - Get RFID Code Response Callback

5.63.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get RFID Code Response.

5.63.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockGetRFIDCodeRsp_t)
(zclIncoming_t * pInMsg, zclDoorLockGetRFIDCodeRsp_t * pCmd);

5.63.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.63.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.64 Обратный вызов Ответ Очистить код RFID - Clear RFID Code Response Callback

5.64.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на сброс кода RFID.

5.64.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearRFIDCodeRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.64.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.64.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.65 Обратный вызов Ответ Очистить все RFID-коды - Clear All RFID Codes Callback

5.65.1 Описание

Этот обратный вызов вызывается для обработки входящей команды очистки всех кодов RFID.

5.65.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockClearAllRFIDCodesRsp_t)
(zclIncoming_t * pInMsg, статус uint8);

5.65.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
status - рабочее состояние SUCCESS или FAILURE.

5.65.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.66 Обратный вызов Уведомление о событии операции- Operation Event Notification Callback 

5.66.1 Описание

Этот обратный вызов вызывается для обработки входящей команды уведомления о событии операции.

5.66.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockOperationEventNotification_t)
(zclIncoming_t * pInMsg, zclDoorLockOperationEventNotification_t * pCmd);

5.66.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.66.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.67 Программирование обратного вызова для уведомления о событиях - Programming Event Notification Callback

5.67.1 Описание

Этот обратный вызов вызывается для обработки входящей команды уведомления о событиях программирования.

5.67.2 Прототип

typedef ZStatus_t (* zclClosures_DoorLockProgrammingEventNotification_t)
(zclIncoming_t * pInMsg, zclDoorLockProgrammingEventNotification_t * pCmd);

5.67.3 Подробности параметров

pInMsg - указатель на входящее сообщение.
pCmd - указатель на полезную нагрузку команды.

5.67.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

5.68 Обратный вызов  Window Covering cluster базовый - Window Covering cluster basic Callback

5.68.1 Описание

Этот обратный вызов вызывается для обработки входящей базовой команды Window Covering cluster.

5.68.2 Прототип

typedef void (* zclClosures_WindowCoveringSimple_t) (void);

5.68.3 Подробности параметров

Нет.

5.68.4 Возврат

Нет.

5.69 Обратный вызов Window Covering cluster изменить на процент  - Window Covering cluster goto percentage Callback

5.69.1 Описание

Этот обратный вызов вызывается для обработки входящей команды закрыть окно на процент.

5.69.2 Прототип

typedef bool (* zclClosures_WindowCoveringGotoPercentage_t)
(percentageuint8);

5.69.3 Подробности параметров

percentage - процентное значение.

5.69.4 Возврат

bool - TRUE или FALSE.

5.70 Обратный вызов Window Covering cluster изменить на значение - Window Covering cluster goto value Callback

5.70.1 Описание

Этот обратный вызов вызывается для обработки входящей команды goto value кластера оконного покрытия.

5.70.2 Прототип

typedef bool (* zclClosures_WindowCoveringGotoValue_t) (value uint16);

5.70.3 Подробности параметров

value - желаемое значение ..

5.70.4 Возврат

bool - TRUE или FALSE.

5.71 Обратный вызов Window Covering cluster Перейти к заданному значению - Window Covering cluster goto setpoint Callback

5.71.1 Описание

Этот обратный вызов вызывается для обработки входящей команды перехода к кластеру покрытия окон.

5.71.2 Прототип

typedef uint8 (* zclClosures_WindowCoveringGotoSetpoint_t) ( index uint8);

5.71.3 Подробности параметров

index - значение индекса.

5.71.4 Возврат

uint8 - значение от 0 до 255.

5.72 Обратный вызов Window Covering cluster программирование предустановки - Window Covering cluster program setpoint Callback

5.72.1 Описание

Этот обратный вызов вызывается для обработки входящей команды задания программы кластера оконного покрытия.

5.72.2 Прототип

typedef bool (* zclClosures_WindowCoveringProgramSetpoint_t)
(programSetpointPayload_t * setpoint);

5.72.3 Подробности параметров

setpoint - указатель на полезную нагрузку команды.

5.72.4 Возврат

bool - TRUE или FALSE.

6. Функциональный домен Интерфейсы протокола - Protocol Interfaces Functional Domain

6.1 Введение

Функциональный домен «Интерфейсы протокола» предоставляет следующие два кластера:
  • Generic Tunnel cluster Общий туннельный кластер
  • BACnet Protocol Tunnel cluster Протокол BACnet туннельный кластер 
  • 11073 Protocol Tunnel cluster Протокол 11073 туннельный кластер 
Общего кластер туннеля используется, когда связанный с конкретным протоколом туннель желает выяснить адрес ZigBee кластера серверов общего туннеля, представляющего конкретное для протокола устройство с заданным адресом протокола.
Кластер туннеля протокола BACnet используется, когда сетевой уровень BACnet хочет передать NPDU BACnet через туннель ZigBee на другой сетевой уровень BACnet. Кластер туннеля протокола 11073 используется, когда сетевой уровень 11073 желает передать 11073 APDU и связанные метаданные через туннель ZigBee в другой 11073 сетевой уровень.
Общий туннельный кластер предоставляет минимальные общие команды и атрибуты, необходимые для туннелирования любого протокола. Поддерживаемые команды:
  • Match Protocol Address Адрес протокола совпадения
  • Match Protocol Address Response Ответ по протоколу совпадения адресов
  • Advertise Protocol Address Объявлять адрес протокола
Туннельный кластер протокола BACnet предоставляет команды и атрибуты для туннелирования протокола BACnet. Единственная поддерживаемая команда:
  • Transfer NPDU Передача NPDU
Туннельный кластер протокола 11073 предоставляет команды и атрибуты для туннелирования протокола 11073. Поддерживаемые команды:
  • Transfer APDU Передача APDU
  • Connect Request Запрос на подключение
  • Disconnect Request Запрос на отключение
  • Connect Status Notification Уведомление о статусе подключения
Для кластера туннеля протокола BACnet требуется, чтобы атрибут MaximumIncomingTransferSize и атрибут MaximumOutgoingTransferSize кластера общего туннеля были равны или превышали 504 октета, следовательно, MAX_TRANSFER_SIZE (определенный в заголовочном файле ZDConfig.h) должен быть установлен соответствующим образом, а функция фрагментации должна быть включена включая флаг компиляции ZIGBEE_FRAGMENTATION в файле проекта. По аналогии, кластер протокольного туннеля 11073 требует, чтобы эти два атрибута были равны или превышали максимальный размер APDU, указанный в соответствующем документе специализации устройства ISO / IEEE 11073.
Функциональный домен «Интерфейсы протокола» реализована в файлах zcl_pi.c и zcl_pi.h.

6.2 Команда Отправить адрес протокола соответствия  - Send Match Protocol Address Command (Generic Tunnel)

6.2.1 Описание

Эта функция используется для отправки команды Match Protocol Address. Эта команда используется, когда связанный с конкретным протоколом туннель желает выяснить адрес ZigBee кластера серверов общего туннеля, представляющего конкретное для протокола устройство с заданным адресом протокола. Команда, как правило, является многоадресной для группы взаимосвязанных кластеров общего туннеля.

6.2.2 Прототип

ZStatus_t zclPI_Send_MatchProtocolAddrCmd (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 len,
uint8 * protocolAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

6.2.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
len - длина адреса протокола.
protocolAddr - Адрес протокола.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.3 Ответ Отправить адрес протокола соответствия - Send Match Protocol Address Response (Generic Tunnel) 

6.3.1 Описание

Эта функция используется для отправки ответа адреса протокола соответствия. Этот ответ отправляется обратно после получения команды соответствия адреса протокола, чтобы указать, что адрес протокола был успешно сопоставлен.

6.3.2 Прототип

ZStatus_t zclPI_Send_MatchProtocolAddrRsp (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 * ieeeAddr,
uint8 len,
uint8 * protocolAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

6.3.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
ieeeAddr - Адрес устройства.
len - длина адреса протокола.
protocolAddr - Адрес протокола.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.4 Команда Отправить адрес протокола объявления - Send Advertise Protocol Address Command (Generic Tunnel)

6.4.1 Описание

Эта функция используется для отправки команды адреса протокола объявления. Эта команда отправляется обычно при запуске или всякий раз, когда изменяется атрибут адреса протокола. Обычно это многоадресная рассылка группе взаимосвязанных общих туннельных кластеров.

6.4.2 Прототип

ZStatus_t zclPI_Send_AdvertiseProtocolAddrCmd (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 * ieeeAddr,
uint8 len,
uint8 * protocolAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

6.4.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
ieeeAddr - Адрес устройства.
len - длина адреса протокола.
protocolAddr - Адрес протокола.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.5 Команда Отправить BACnet Transfer NPDU - Send BACnet Transfer NPDU Command (BACnet Protocol Tunnel)

6.5.1 Описание

Эта функция используется для отправки команды BACnet Transfer NPDU. Эта команда используется, когда сетевой уровень BACnet хочет передать NPDU BACnet через туннель ZigBee на другой сетевой уровень BACnet.

6.5.2 Прототип

ZStatus_t zclPI_Send_BACnetTransferNPDUCmd (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 len,
uint8 * нпду,
uint8 disableDefaultRsp,
uint8 seqNum);

6.5.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
len - длина NPDU.
npdu - NPDU для передачи.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.5.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.6 Команда Отправить 11073 Transfer APDU 11073 - Send 11073 Transfer APDU Command (11073 Protocol Tunnel)

6.6.1 Описание

Эта функция используется для отправки команды 11073 Transfer APDU. Эта команда используется, когда сетевой уровень 11073 желает передать APDU 11073 через туннель ZigBee на другой сетевой уровень 11073.

6.6.2 Прототип

ZStatus_t zclPI_Send_11073TransferAPDUCmd (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 len,
uint8 * apdu,
uint8 seqNum);

6.6.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
len - длина APDU.
apdu - APDU для передачи.
seqNum - идентификационный номер для транзакции.

6.6.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.7 Команда Отправить запрос соединения 11073 - Send 11073 Connect Request Command (11073 Protocol Tunnel)

6.7.1 Описание

Эта функция используется для отправки команды запроса соединения 11073. Эта команда генерируется, когда устройство управления данными желает подключиться к агентскому устройству 11073. Это может быть в ответ на получение команды уведомления о состоянии соединения от этого устройства агента с полем состояния соединения, установленным в RECONNECT_REQUEST.

6.7.2 Прототип

ZStatus_t zclPI_Send_11073ConnectReq (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 connectCtrl,
uint16 idleTimeout,
uint8 * managerAddr,
uint8 managerEP,
uint8 disableDefaultRsp,
uint8 seqNum);

6.7.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
connectCtrl - контроль подключения.
idleTimeout - время бездействия (в минутах), которое устройство управления данными будет ожидать без получения каких-либо данных, прежде чем оно отключится.
managerAddr - IEEE-адрес (64-разрядный) устройства управления данными, передающего этот кадр.
managerEP - конечная точка источника, из которой устройство управления данными передает этот кадр.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.7.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.8 Команда Отправить запроса на отключение 11073 - Send 11073 Disconnect Request Command (11073 Protocol Tunnel)

6.8.1 Описание

Эта функция используется для отправки команды запроса на отключение 11073. Эта команда генерируется, когда устройство управления данными хочет отключить туннельное соединение, существующее на устройстве агента.

6.8.2 Прототип

ZStatus_t zclPI_Send_11073DisconnectReq (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 * managerAddr,
uint8 disableDefaultRsp,
uint8 seqNum);

6.8.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
managerAddr - IEEE-адрес (64-разрядный) устройства управления данными, передающего этот кадр.
disableDefaultRsp - отключить команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

6.8.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.9 Команда Отправить уведомления о состоянии соединения 11073 - Send 11073 Connect Status Notification Command (11073 Protocol Tunnel)

6.9.1 Описание

Эта функция используется для отправки команды уведомления о состоянии соединения 11073. Эта команда генерируется агентским устройством в ответ на команду запроса соединения, команду разъединения или в ответ на какое-либо другое событие, которое приводит к подключению или отключению туннеля. Устройство-агент также отправляет запрос устройству управления данными на повторное подключение туннеля.

6.9.2 Прототип

ZStatus_t zclPI_Send_11073ConnectStatusNoti (uint8 srcEP,
afAddrType_t * dstAddr,
uint8 connectStatus,
uint8 disableDefaultRsp,
uint8 seqNum);

6.9.3 Подробности параметров

srcEP - конечная точка источника.
destAddr - Адрес назначения.
connectStatus - состояние подключения.
disableDefaultRsp - отключить команду ответа по умолчанию
seqNum - идентификационный номер для транзакции.

6.9.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.10 Обратный вызов Регистрация команд приложения - Register Application Command Callbacks

6.10.1 Описание

Эта функция используется для регистрации обратных вызовов Command для приложения в функциональной области Interface Interface.

6.10.2 Прототип

ZStatus_t zclPI_RegisterCmdCallbacks (endpoint uint8,
zclPI_AppCallbacks_t * callbacks);

6.10.3 Подробности параметров

endpoint - конечная точка приложения.
callbacks - указатель на записи обратного вызова.

6.10.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

6.11 Обратный вызов адрес протокола соответствия - Match Protocol Address Callback

6.11.1 Описание

Этот обратный вызов вызывается для обработки входящей команды адреса протокола соответствия.

6.11.2 Прототип

typedef void (* zclPICB_MatchProtocolAddr_t) (zclPIMatchProtocolAddr_t * pCmd);

6.11.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
seqNum - порядковый номер, полученный с помощью команды.
len - длина адреса протокола.
protocolAddr - Адрес протокола.

6.11.4 Возврат

Нет.

6.12 Обратный вызов Ответ Адрес протокола соответствия - Match Protocol Address Response Callback

6.12.1 Описание

Этот обратный вызов вызывается для обработки входящего ответа адреса протокола соответствия. , Это означает, что это приложение отправило соответствующую команду для этого ответа.

6.12.2 Прототип

typedef void (* zclPICB_MatchProtocolAddrRsp_t) (
zclPIMatchProtocolAddrRsp_t * pRsp);

6.12.3 Подробности параметров

pRsp - полученный ответ, имеющий следующие поля:
srcAddr - адрес запрашивающего.
ieeeAddr - Адрес устройства.
len - длина адреса протокола.
protocolAddr - Адрес протокола.

6.12.4 Возврат

Нет.

6.13. Обратный вызов Объявление адрес протокола - Advertise Protocol Address Callback

6.13.1 Описание

Этот обратный вызов вызывается для обработки входящей команды адреса Объявление протокола.

6.13.2 Прототип

typedef void (* zclPICB_AdvertiseProtocolAddr_t) (
zclPIAdvertiseProtocolAddr_t * pCmd);

6.13.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
len - длина адреса протокола.
protocolAddr - Адрес протокола.

6.13.4 Возврат

Никто.

6.14 Обратный вызов BACnet Transfer  NPDU - BACnet Transfer NPDU Callback

6.14.1 Описание

Этот обратный вызов вызывается для обработки входящей команды BACnet Transfer NPDU.

6.14.2 Прототип

typedef void (* zclPICB_BACnetTransferNPDU_t)
(zclBACnetTransferNPDU_t * pCmd);

6.14.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
len - длина BACnet NPDU.
npdu - полученный BACnet NPDU.

6.14.4 Возврат

Нет.

6.15 Обратный вызова 11073 Transfer APDU - 11073 Transfer APDU Callback

6.15.1 Описание

Этот обратный вызов вызывается для обработки входящей команды 11073 Transfer APDU.

6.15.2 Прототип

typedef void (* zclPICB_11073TransferAPDU_t) (zcl11073TransferAPDU_t * pCmd);

6.15.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
len - длина 11073 APDU.
apdu - полученный 11073 APDU.

6.15.4 Возврат

Нет.

6.16 Обратный вызов Запрос на соединение 11073 - 11073 Connect Request Callback

6.16.1 Описание

Этот обратный вызов вызывается для обработки входящей команды 11073 Connect Request.

6.16.2 Прототип

typedef void (* zclPICB_11073ConnectReq_t) (zcl11073ConnectReq_t * pCmd);

6.16.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
seqNum - порядковый номер, полученный с помощью команды.
connectCtrl - контроль подключения.
idleTimeout - время бездействия (в минутах), которое устройство управления данными будет ожидать без получения каких-либо данных, прежде чем оно отключится.
managerAddr - IEEE-адрес (64-разрядный) устройства управления данными, передающего этот кадр.
managerEP– конечная точка источника, с которой устройство управления данными передает этот кадр.

6.16.4 Возврат

Нет.

6.17 Обратный вызов Запрос Отключить 11073  - 11073 Disconnect Request Callback

6.17.1 Описание

Этот обратный вызов вызывается для обработки входящей команды 11073 Disconnect Request.

6.17.2 Прототип

typedef void (* zclPICB_11073DisconnectReq_t) (zcl11073DisconnectReq_t * pCmd);

6.17.3 Подробности параметров

pCmd - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
seqNum - порядковый номер, полученный с помощью команды.
managerAddr - IEEE-адрес (64-разрядный) устройства управления данными, передающего этот кадр.

6.17.4 Возврат

Нет.

6.18 Обратный вызов Уведомление о состоянии соединения 11073 - 11073 Connect Status Notification Callback

6.18.1 Описание

Этот обратный вызов вызывается для обработки входящей команды уведомления о состоянии соединения 11073.

6.18.2 Прототип

typedef void (* zclPICB_11073ConnectStatusNoti_t) (
zcl11073ConnectStatusNoti_t * pCmd);

6.18.3 Подробности параметров

pRsp - полученная команда, имеющая следующие поля:
srcAddr - адрес запрашивающего.
connectStatus– состояние подключения.

6.18.4 Возврат

Нет.

7. Ввод в эксплуатацию Touchlink  - Touchlink Commissioning

7.1 Обратные вызововы Регистрация команды Touchlink Inter-PAN - Register Touchlink Inter-PAN command callbacks.

7.1.1 Описание

Эта функция используется для обратных вызовов регистрации команд Inter-PAN.

7.1.2 Прототип

ZStatus_t bdbTL_RegisterInterPANCmdCallbacks
(bdbTL_InterPANCallbacks_t * callbacks);

7.1.3 Подробности параметров

callbacks - указатель на запись обратного вызова между панорамированием.

7.1.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.2 Отправить запрос на сканирование - Send Scan Request

7.2.1 Описание

Эта функция используется для отправки запроса сканирования.

7.2.2 Прототип

ZStatus_t bdbTL_Send_ScanReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLScanReq_t * pReq, uint8 seqNum);

7.2.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.3 Запрос информации об устройстве - Device Information Request

7.3.1 Описание

Эта функция используется для отправки запроса информации об устройстве.

7.3.2 Прототип

ZStatus_t bdbTL_Send_DeviceInfoReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLDeviceInfoReq_t * pReq, uint8 seqNum);

7.3.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.4 Отправить запрос идентификации - Send Identify Request

7.4.1 Описание

Эта функция используется для отправки запроса идентификации.

7.4.2 Прототип

ZStatus_t bdbTL_Send_IndentifyReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLIdentifyReq_t * pReq, uint8 seqNum);

7.4.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.5 Отправить сброс на новый заводской запрос - Send Reset to Factory New Request

7.5.1 Описание

Эта функция используется для отправки сброса на новый заводской запрос.

7.5.2 Прототип

ZStatus_t bdbTL_Send_ResetToFNReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLResetToFNReq_t * pReq, uint8 seqNum);

7.5.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.5.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.6 Отправить запрос на старт сети - Send a Network Start Request

7.6.1 Описание

Эта функция используется для отправки запроса на старт сети.

7.6.2 Прототип

ZStatus_t bdbTL_Send_NwkStartReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLNwkStartReq_t * pRsp, uint8 seqNum);

7.6.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.6.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.7 Отправка запроса на присоединение к сети / запрос конечного устройства - Send Network Join Router/End Device Request

7.7.1 Описание

Эта функция используется для отправки запроса сетевого маршрутизатора / конечного устройства.

7.7.2 Прототип

ZStatus_t bdbTL_Send_NwkJoinReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLNwkJoinReq_t * pReq, uint8 cmd, uint8 seqNum);

7.7.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq - указатель для запроса параметров.
cmd - присоединиться к запросу маршрутизатора или присоединиться к запросу конечного устройства.
seqNum - идентификационный номер для транзакции.

7.7.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.8 Отправить запрос на обновление сети - Send Network Update Request

7.8.1 Описание

Эта функция используется для отправки запроса на обновление сети.

7.8.2 Прототип

ZStatus_t bdbTL_Send_NwkUpdateReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLNwkUpdateReq_t * pReq, uint8 seqNum);

7.8.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.8.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.9 Отправить запрос на получение идентификаторов группы - Send Get Group Identifiers Request

7.9.1 Описание

Эта функция используется для отправки запроса получения идентификаторов группы.

7.9.2 Прототип

ZStatus_t bdbTL_Send_GetEPListReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLGetEPListReq_t * pReq, uint8 disableDefaultRsp, uint8 seqNum);

7.9.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель на параметры ответа.
disableDefaultRsp - отключить ли команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

7.9.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.10 Отправить запрос на получение списка конечных точек - Send Get Endpoint List Request

7.10.1 Описание

Эта функция используется для отправки запроса получения списка конечных точек.

7.10.2 Прототип

ZStatus_t bdbTL_Send_GetGrpIDsReq (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLGetGrpIDsReq_t * pReq, uint8 disableDefaultRsp, uint8 seqNum);

7.10.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pReq– Указатель для запроса параметров.
disableDefaultRsp - отключить ли команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

7.10.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.11 Отправить Ответ сканирования - Send Scan Response

7.11.1 Описание

Эта функция используется для отправки ответа на сканирование.

7.11.2 Прототип

ZStatus_t bdbTL_Send_ScanRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLScanRsp_t * pRsp, uint8 seqNum);

7.11.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
seqNum - идентификационный номер для транзакции.

7.11.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.12 Отправить Ответ с информацией об устройстве - Send Network Join Router/End Device Response

7.12.1 Описание

Эта функция используется для отправки ответа на информацию об устройстве.

7.12.2 Прототип

ZStatus_t bdbTL_Send_DeviceInfoRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLDeviceInfoRsp_t * pRsp, uint8 seqNum);

7.12.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
seqNum - идентификационный номер для транзакции.

7.12.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.13 Отправить Ответ старт сети - Send Network Start Response

7.13.1 Описание

Эта функция используется для отправки ответа на запуск сети.

7.13.2 Прототип

ZStatus_t bdbTL_Send_NwkStartRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLNwkStartRsp_t * pRsp, uint8 seqNum);

7.13.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
seqNum - идентификационный номер для транзакции.

7.13.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.14 Отправить Ответ присоединения сетевого маршрутизатора / конечного устройства - Send Network Join Router/End Device Response

7.14.1 Описание

Эта функция используется для отправки ответа присоединения сетевого маршрутизатора / конечного устройства.

7.14.2 Прототип

bdbTL_Send_NwkJoinRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLNwkJoinRsp_t * pRsp, uint8 cmd, uint8 seqNum);

7.14.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
cmd - присоединиться к запросу маршрутизатора или присоединиться к запросу конечного устройства.
seqNum - идентификационный номер для транзакции.

7.14.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.15 Отправить Ответа с информацией о конечной точке - Send Endpoint Information Response

7.15.1 Описание

Эта функция используется для отправки информационного ответа конечной точки.

7.15.2 Прототип

ZStatus_t bdbTL_Send_EndpointInfo (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLEndpointInfo_t * pCmd, uint8 disableDefaultRsp, uint8 seqNum);

7.15.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pCmd - параметры Pinter to cmd.
disableDefaultRsp - отключить ли команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

7.15.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.16 Отправить Ответ Получить идентификаторы группы - Send Get Group Identifiers Response

7.16.1 Описание

Эта функция используется для отправки ответа Get Group Identifiers.

7.16.2 Прототип

ZStatus_t bdbTL_Send_GetGrpIDsRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLGetGrpIDsRsp_t * pRsp, uint8 disableDefaultRsp, uint8 seqNum);

7.16.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
disableDefaultRsp - отключить ли команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

7.16.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.17 Отправить Ответ Получить список конечных точек - Send Get Endpoint List Response

7.17.1 Описание

Эта функция используется для отправки ответа получения списка конечных точек.

7.17.2 Прототип

ZStatus_t bdbTL_Send_GetEPListRsp (uint8 srcEP, afAddrType_t * dstAddr,
bdbTLGetEPListRsp_t * pRsp, uint8 disableDefaultRsp, uint8 seqNum);

7.17.3 Подробности параметров

srcEP - конечная точка источника.
dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
disableDefaultRsp - отключить ли команду ответа по умолчанию.
seqNum - идентификационный номер для транзакции.

7.17.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.18 Обратный вызов Запрос Получить идентификаторов группы - Get Group Identifiers Request Callback

7.18.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса идентификаторов групп.

7.18.2 Прототип

typedef ZStatus_t (* bdbTL_GetGrpIDsReqCB_t) (afAddrType_t * srcAddr,
bdbTLGetGrpIDsReq_t * pReq, uint8 seqNum);

7.18.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.18.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.19 Обратный вызов Запрос Установить списка конечных точек - Set Endpoint List Request Callback

7.19.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса списка конечных точек.

7.19.2 Прототип

typedef ZStatus_t (* bdbTL_GetEPListReqCB_t) (afAddrType_t * srcAddr,
bdbTLGetEPListReq_t * pReq, uint8 SeqNum);

7.19.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.19.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.20 Обратный вызов Информация о конечной точке - Endpoint Information Callback

7.20.1 Описание

Этот обратный вызов вызывается для обработки входящей информации о конечной точке.

7.20.2 Прототип

typedef ZStatus_t (* bdbTL_EndpointInfoCB_t) (afAddrType_t * srcAddr,
bdbTLEndpointInfo_t * pRsp);

7.20.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.20.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.21 Обратный вызов Получить идентификаторы группы  - Get Group Identifiers Callback

7.21.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Group Identifiers.

7.21.2 Прототип

typedef ZStatus_t (* bdbTL_GetGrpIDsRspCB_t) (afAddrType_t * srcAddr,
bdbTLGetGrpIDsRsp_t * pRsp);

7.21.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.21.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.22 Обратный вызов Ответ Получение списка конечных точек - Get Endpoint List Response Callback

7.22.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Get Endpoint List Response.

7.22.2 Прототип

typedef ZStatus_t (* bdbTL_GetEPListRspCB_t) (afAddrType_t * srcAddr,
bdbTLGetEPListRsp_t * pRsp);

7.22.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.22.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.23 Обратный вызов Запрос Сканировать - Scan Request Callback

7.23.1 Описание

Этот обратный вызов вызывается для обработки входящей команды сканирования.

7.23.2 Прототип

typedef ZStatus_t (* bdbTL_ScanReqCB_t) (afAddrType_t * srcAddr,
bdbTLScanReq_t * pReq, uint8 seqNum);

7.23.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.23.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.24 Обратный вызов Запрос информации об устройстве - Device Information Request Callback

7.24.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса информации об устройстве.

7.24.2 Прототип

typedef ZStatus_t (* bdbTL_DeviceInfoReqCB_t) (afAddrType_t * srcAddr,
bdbTLDeviceInfoReq_t * pReq, uint8 seqNum);

7.24.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.24.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.25 Обратный вызов Запрос идентификации - Identify Request Callback

7.25.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса идентификации.

7.25.2 Прототип

typedef ZStatus_t (* bdbTL_IdentifyReqCB_t) (afAddrType_t * srcAddr,
bdbTLIdentifyReq_t * pReq);

7.25.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.25.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.26 Обратный вызов Запрос Сброс к заводскому установкам - Reset to Factory New Request Callback

7.26.1 Описание

Этот обратный вызов вызывается для обработки входящей команды «Восстановить до заводских установок».

7.26.2 Прототип

typedef ZStatus_t (* bdbTL_ResetToFNReqCB_t) (afAddrType_t * srcAddr,
bdbTLResetToFNReq_t * pReq);

7.26.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.26.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.27 Обратный вызов Запрос на запуск сети - Network Start Request Callback

7.27.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса на запуск сети.

7.27.2 Прототип

typedef ZStatus_t (* bdbTL_NwkStartReqCB_t) (afAddrType_t * srcAddr,
bdbTLNwkStartReq_t * pReq, uint8 seqNum);

7.27.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.27.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.28 Обратный вызов Запроса присоединения роутера к сети - Network Join Router Request Callback

7.28.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса на присоединение роутера к сети.

7.28.2 Прототип

typedef ZStatus_t (* bdbTL_NwkJoinRtrReqCB_t) (afAddrType_t * srcAddr,
bdbTLNwkJoinReq_t * pReq, uint8 seqNum);

7.28.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.28.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.29 Обратный вызов Запроса присоединения конечного устройства  к сети - Network Join End Device Request Callback

7.29.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса конечного устройства на присоединение к сети.

7.29.2 Прототип

typedef ZStatus_t (* bdbTL_NwkJoinEDReqCB_t) (afAddrType_t * srcAddr,
bdbTLNwkJoinReq_t * pReq, uint8 seqNum);

7.29.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.
seqNum - идентификационный номер для транзакции.

7.29.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.30 Обратный вызов Запрос на обновление сети - Network Update Request Callback

7.30.1 Описание

Этот обратный вызов вызывается для обработки входящей команды запроса на обновление сети.

7.30.2 Прототип

typedef ZStatus_t (* bdbTL_NwkUpdateReqCB_t) (afAddrType_t * srcAddr,
bdbTLNwkUpdateReq_t * pReq);

7.30.3 Подробности параметров

srcAddr - адрес назначения.
pReq– Указатель для запроса параметров.

7.30.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.31 Обратный вызов Ответ Сканировать  - Scan Response Callback

7.31.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа сканирования.

7.31.2 Прототип

typedef ZStatus_t (* bdbTL_ScanRspCB_t) (afAddrType_t * srcAddr,
bdbTLScanRsp_t * pRsp);

7.31.3 Подробности параметров

srcAddr - адрес назначения.
pRsp– Указатель на параметры ответа.

7.31.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.32 Обратный вызов Ответ Информация об устройстве - Device Information Response Callback

7.32.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на информацию об устройстве.

7.32.2 Прототип

typedef ZStatus_t (* bdbTL_DeviceInfoRspCB_t) (afAddrType_t * srcAddr,
bdbTLDeviceInfoRsp_t * pRsp);

7.32.3 Подробности параметров

srcAddr - адрес назначения.
pRsp– Указатель на параметры ответа.

7.32.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.33 Обратный вызов Ответ запуска сети - Network Start Response Callback

7.33.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа на запуск сети.

7.33.2 Прототип

typedef ZStatus_t (* bdbTL_NwkStartRspCB_t) (afAddrType_t * srcAddr,
bdbTLNwkStartRsp_t * pRsp);

7.33.3 Подробности параметров

srcAddr - адрес назначения.
pRsp– Указатель на параметры ответа.

7.33.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h

7.34 Обратный вызов Ответ сетевого соединения маршрутизатора  - Network Join Router Response Callback

7.34.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа сетевого соединения маршрутизатора.

7.34.2 Прототип

typedef ZStatus_t (* bdbTL_NwkJoinRtrRspCB_t) (afAddrType_t * srcAddr,
bdbTLNwkJoinRsp_t * pRsp);

7.34.3 Подробности параметров

srcAddr - адрес назначения.
pRsp– Указатель на параметры ответа.

7.34.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

7.35 Обратный вызов Ответ Присоединение конечного устройства к сети - Network Join End Device Response Callback

7.35.1 Описание

Этот обратный вызов вызывается для обработки входящей команды ответа конечного устройства сетевого подключения.

7.35.2 Прототип

typedef ZStatus_t (* bdbTL_NwkJoinEDRspCB_t) (afAddrType_t * srcAddr,
bdbTLNwkJoinRsp_t * pRsp);

7.35.3 Подробности параметров

srcAddr - адрес назначения.
pRsp– Указатель на параметры ответа.

7.35.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

8. Green Power

Текущая реализация конечной точки Green Power заключается в предоставлении основных функций прокси-сервера, которые предназначены для ретрансляции пакетов с устройства Green Power на устройство Green Power Sink после процесса ввода в эксплуатацию, выполняемого Green Power Device и Green Power Sink. Это приложение уже управляется стеком и не требует взаимодействия с пользователем. Указанный здесь API предоставляется для таких приложений, которые стремятся расширить функциональность Green Power до своего приложения.

8.1 Обратные вызовы Регистрация команд Green Power - Register Green Power Application Command Callbacks

8.1.1 Описание

Эта функция используется для отправки уведомления о зеленой энергии.

8.1.2 Прототип

ZStatus_t zclGp_RegisterCmdCallbacks (endpoint uint8,
zclGp_AppCallbacks_t * callbacks);

8.1.3 Подробности параметров

endpoint - конечная точка целевого приложения.
callbacks - указатель на запись обратного вызова.

8.1.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

8.2 Отправить Уведомление Green Power - Send Green Power Notification

8.2.1 Описание

Эта функция используется для отправки уведомления о зеленой энергии.

8.2.2 Прототип

ZStatus_t zclGp_SendGpNotificationCommand (gpNotificationCmd_t * pCmd);

8.2.3 Подробности параметров

pCmd - указатель на данные команды уведомления зеленой мощности.

8.2.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

8.3 Отправить Уведомление о вводе в эксплуатацию Green Power - Send Green Power Commissioning Notification

8.3.1 Описание

Эта функция используется для отправки уведомления о вводе в эксплуатацию Green Power.

8.3.2 Прототип

ZStatus_t zclGp_SendGpCommissioningNotificationCommand
(gpCommissioningNotificationCmd_t * pCmd);

8.3.3 Подробности параметров

pCmd - указатель на данные команды пуска в эксплуатацию.

8.3.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

8.4 Отправить запрос таблицы прокси Green Power - Send Green Power Proxy Table Request

8.4.1 Описание

Эта функция используется для отправки запроса таблицы прокси-сервера Green Power.

8.4.2 Прототип

ZStatus_t zclGp_SendGpProxyTableResponse (afAddrType_t * dstAddr,
zclGpProxyTableResponse_t * rsp, uint8 seqNum);

8.4.3 Подробности параметров

dstAddr - адрес назначения.
pRsp– Указатель на параметры ответа.
seqNum - идентификационный номер для транзакции.

8.4.4 Возврат

ZStatus_t - перечисление, найденное в ZComDef.h.

8.5 Обратный вызов Сопряжение Gp - Gp Pairing Callback

8.5.1 Описание

Этот обратный вызов вызывается для обработки входящей команды Gp Pairing.

8.5.2 Прототип

typedef void (* zclGCB_GP_Pairing_t) (zclGpPairing_t * pCmd);

8.5.3 Подробности параметров

pCmd– указатель на параметры команды.

8.5.4 Возврат

Нет.

8.6 Обратный вызов Режим ввода в эксплуатацию Gp - Gp Commissioning Mode Callback

8.6.1 Описание

Этот обратный вызов вызывается для обработки входящей команды режима ввода в эксплуатацию Gp.

8.6.2 Прототип

typedef void (* zclGCB_GP_Proxy_Commissioning_Mode_t)
(zclGpProxyCommissioningMode_t * pCmd);

8.6.3 Подробности параметров

pCmd– указатель на параметры команды.

8.6.4 Возврат

Нет.

8.7 Обратный вызов Ответ Gp  - Gp Response Callback

8.7.1 Описание

Этот обратный вызов вызывается для обработки входящей команды режима ввода в эксплуатацию Gp.

8.7.2 Прототип

typedef void (* zclGCB_GP_Response_t) (zclGpResponse_t * pCmd);

8.7.3 Подробности параметров

pCmd– указатель на параметры команды.

8.7.4 Возврат

Нет.

8.8 Обратный вызов Ответ Gp  - Gp Response Callback

8.8.1 Описание

Этот обратный вызов вызывается для обработки входящей команды режима ввода в эксплуатацию Gp.

8.8.2 Прототип

typedef void (* zclGCB_GP_Proxy_Table_Request_t)
(zclGpProxyTableRequest_t * pReq);

8.8.3 Подробности параметров

pReq– Указатель для запроса параметров.

8.8.4 Возврат

Нет.

9. Опции компиляции

Параметры компиляции ZCL определены в файле конфигурации ZCL f8wZCL.cfg, который находится в папке «Tools» установки Z-Stack вместе с другими файлами конфигурации. Файл f8wZCL.cfg используется всеми проектами, которые включают ZCL (т.е. все проекты домашней автоматизации). Поэтому любое изменение, внесенное в этот файл, повлияет на все проекты HA. Параметры компиляции для других профилей, таких как Smart Energy [5], можно найти в их документах API. При необходимости вы можете создать приватную версию файла f8wZCL.cfg и изменить свой проект для использования новой версии. Поддерживаемые ZCL параметры компиляции и их определения перечислены в следующей таблице:
 
ZCL_READ
Enable the following commands:
1) Read Attributes
2) Read Attributes Response
ZCL_WRITE
Enable the following commands:
1) Write Attributes
2) Write Attributes Undivided
3) Write Attributes Response
4) Write Attributes No Response
ZCL_REPORTING_DEVICE
Enable the following commands:
1) Configure Reporting Response
2) Report Attributes
ZCL_REPORT_CONFIGURING_DEVICE
Enable the following commands:
1) Configure Reporting
ZCL_REPORT_DESTINATION_DEVICE
Enable reception of the following commands
1) Read Reporting Response
2) Read Reporting Configuration Response
ZCL_DISCOVER
Enable the following commands:
1) Discover Attributes
2) Discover Attributes Response
ZCL_BASIC
Enable the following command:
1) Reset to Factory Defaults
ZCL_IDENTIFY
Enable the following commands:
1) Identify
2) Identify Query
3) Identify Query Response
ZCL_GROUPS
Enable the following commands:
1) Add Group
2) View Group
3) Get Group Membership
4) Remove Group
5) Remove All Groups
6) Add Group If Identifying
7) Add Group Response
8) View Group Response
9) Get Group Membership Response
10) Remove Group Response
ZCL_SCENES
Enable the following commands:
1) Add Scene
2) View Scene
3) Remove Group
4) Remove All Groups
5) Store Scene
6) Recall Scene
7) Get Scene Membership
8) Add Scene Response
9) View Scene Response
10) Remove Scene Response
11) Remove All Scenes Response
12) Store Scene Response
13) Get Scene Membership Response
ZCL_ON_OFF
Enable the following commands:
1) On
2) Off
3) Toggle
ZCL_LEVEL_CTRL
Enable the following commands:
1) Move to Level
2) Move
3) Step
4) Stop
5) Move to Level with On/Off
6) Move with On/Off
7) Step with On/Off
8) Stop with On/Off
ZCL_ALARMS
Enable the following commands:
1) Reset Alarm
2) Reset All Alarms
3) Get Alarm
4) Reset Alarm Log
5) Alarm
6) Get Alarm Response
ZCL_LOCATION
Enable the following commands:
1) Set Absolute Location
2) Set Device Configuration
3) Get Device Configuration
4) Get Location Data
5) Device Configuration Response
6) Location Data Response
7) Location Data Notification
8) Compact Location Data Notification
9) RSSI Ping
ZCL_ZONE
Enable the following commands:
1) Zone Status Change Notification
2) Zone Enroll Request
3) Zone Enroll Response
ZCL_ACE
Enable the following commands:
1) Arm
2) Bypass
3) Emergency
4) Fire
5) Panic
6) Get Zone ID Map
7) Get Zone Information
8) Arm Response
9) Get Zone ID Map Response
10) Get Zone Information Response
ZCL_WD
Enable the following commands:
1) Start Warning
2) Squawk
ZCL_DOORLOCK
Enable the following commands:
1) Door Lock
2) Door Lock Response
3) Door Unlock
4) Door Unlock Response
5) Door Toggle
5) Door Toggle Response
ZCL_DOORLOCK_EXT
Enable the following commands and its respective responses:
1) UnlockWithTimeout
2) GetLogRecord
3) SetPINCode
4) GetPINCode
5) ClearPINCode
6) ClearAllPINCodes
7) SetUserStatus
8) GetUserStatus
9) SetWeekDaySchedule
10) GetWeekDaySchedule
11) ClearWeekDaySchedule
12) SetYearDaySchedule
13) GetYearDaySchedule
14) ClearYearDaySchedule
15) SetHolidaySchedule
16) GetHolidaySchedule
17) ClearHolidaySchedule
18) SetUserType
19) GetUserType
20) SetRFIDCode
21) GetRFIDCode
22) ClearRFIDCode
23) ClearAllRFIDCodes
24) OperationEventNotification
25) ProgrammingEventNotification
ZCL_WINDOWCOVERING
Enable the following Window Covering Cluster commands:
1) Up / Open
2) Down / Close
3) Stop
4) Go to Lift Setpoint
5) Go to Lift Value
6) Go to Lift Percentage
7) Go to Tilt Setpoint
8) Go to Tilt Value
9) Go to Tilt Percentage
10) Program Setpoint

 

Ваша оценка: None Средняя: 10 (6 votes)