@libertas-ai/types 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +42 -266
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -47,7 +47,7 @@ declare type LibertasLanDevice = number;
|
|
|
47
47
|
/**
|
|
48
48
|
* A virtual device. The behaviors of the device are managed by application code.
|
|
49
49
|
*
|
|
50
|
-
* Virtual devices interact with the user during the runtime of
|
|
50
|
+
* Virtual devices interact with the user during the runtime of Libertas App tasks.
|
|
51
51
|
*
|
|
52
52
|
* @see [Virtual Device API](/doc/developers_doc/virtual_device_api/)
|
|
53
53
|
* @see {@link libertasVirtualDeviceCommandRsp}
|
|
@@ -79,10 +79,10 @@ declare type LibertasUser = number;
|
|
|
79
79
|
declare type LibertasAction = number;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
|
-
* Specialized virtual device for
|
|
82
|
+
* Specialized virtual device for endpoint interactions.
|
|
83
83
|
* Data schema must be predefined and published by the server developer.
|
|
84
84
|
*/
|
|
85
|
-
declare type
|
|
85
|
+
declare type LibertasEndpoint = LibertasVirtualDevice;
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
88
|
* A handle to an indexed database table.
|
|
@@ -90,7 +90,7 @@ declare type LibertasAgentTool = LibertasVirtualDevice;
|
|
|
90
90
|
declare type LibertasDataStore = number;
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
|
-
* Used to send broadcast data report in {@link
|
|
93
|
+
* Used to send broadcast data report in {@link libertasEndpointSendResponse}. It should be 0xffffffff.
|
|
94
94
|
*/
|
|
95
95
|
declare const enum LibertasPeer {
|
|
96
96
|
Broadcast = 0xffffffff,
|
|
@@ -234,7 +234,7 @@ declare type LibertasCommand = [cluster: number, id: number, data?: LibertasStru
|
|
|
234
234
|
declare type LibertasClusterAttributes = [cluster: number, attributes: LibertasAttributes];
|
|
235
235
|
|
|
236
236
|
/**
|
|
237
|
-
* A tuple representing a read request from a
|
|
237
|
+
* A tuple representing a read request from a Libertas App task.
|
|
238
238
|
*
|
|
239
239
|
* @see {@link LibertasVirtualDeviceReq}
|
|
240
240
|
* @see {@link libertasDeviceReadReq}
|
|
@@ -261,7 +261,7 @@ declare type LibertasClusterReadReq = [cluster: number, attributes: number[], ev
|
|
|
261
261
|
*
|
|
262
262
|
* The effective minInterval and maxInterval may differ due to the varying requirements of multiple agents and device settings.
|
|
263
263
|
*
|
|
264
|
-
* The maxInterval affects the report timeout. The underlying Libertas OS performs timeout detection. The
|
|
264
|
+
* The maxInterval affects the report timeout. The underlying Libertas OS performs timeout detection. The Libertas App task can keep idling until a report or error occurs.
|
|
265
265
|
*/
|
|
266
266
|
declare type LibertasClusterSubscribeReq = [cluster: number, minInterval: number, maxInterval: number, attributes: number[], events?: LibertasClusterEventSubscription ];
|
|
267
267
|
|
|
@@ -350,18 +350,18 @@ declare type LibertasDeviceRsp = LibertasCommandRsp | LibertasClusterWriteRsp[]
|
|
|
350
350
|
declare type LibertasDeviceCallback = (device: LibertasDevice, action: LibertasDeviceAction, data: LibertasDeviceRsp, tag?: any, ref?: number) => void;
|
|
351
351
|
|
|
352
352
|
/**
|
|
353
|
-
* Possible interactions of an
|
|
353
|
+
* Possible interactions of an endpoint connection.
|
|
354
354
|
*/
|
|
355
|
-
declare const enum
|
|
356
|
-
///
|
|
355
|
+
declare const enum LibertasEndpointAction {
|
|
356
|
+
/// endpoint subscription request opcode.
|
|
357
357
|
SubscriptionRequest = 3,
|
|
358
|
-
///
|
|
358
|
+
/// endpoint data message opcode.
|
|
359
359
|
ReportData = 5,
|
|
360
|
-
///
|
|
360
|
+
/// endpoint request opcode (expects response).
|
|
361
361
|
Request = 8,
|
|
362
|
-
///
|
|
362
|
+
/// endpoint response opcode.
|
|
363
363
|
Response = 9,
|
|
364
|
-
///
|
|
364
|
+
/// endpoint peer down notification opcode.
|
|
365
365
|
PeerDown = 20,
|
|
366
366
|
}
|
|
367
367
|
|
|
@@ -383,22 +383,22 @@ declare const enum LibertasAgentToolAction {
|
|
|
383
383
|
* Valid actions:
|
|
384
384
|
* {@link LibertasDeviceAction.ReadRequest}, {@link LibertasDeviceAction.SubscribeRequest}, and {@link LibertasDeviceAction.ReportData} all request attribute data. {@link LibertasDeviceAction.ReadRequest}
|
|
385
385
|
* is a one-time read. {@link LibertasDeviceAction.SubscribeRequest} is an initial subscribe request. {@link LibertasDeviceAction.ReportData} is for
|
|
386
|
-
* continuous subscription data report. Combined with `peer`, the
|
|
386
|
+
* continuous subscription data report. Combined with `peer`, the Libertas App can keep track of current subscribers. The Libertas App can also keep the last subscription related request time to
|
|
387
387
|
* calculate interval duration for more flexible subscrption delivery. A virtual device may even respond more data than requested if the common dirty-marking algorithm is not adequate.
|
|
388
388
|
*/
|
|
389
389
|
|
|
390
390
|
declare type LibertasVirtualDeviceCallback = (device: LibertasVirtualDevice, ref: number, action: LibertasDeviceAction, data: LibertasVirtualDeviceReq, tag?: any, peer?: number) => void;
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
|
-
* Callback of an
|
|
394
|
-
* @param device A
|
|
393
|
+
* Callback of an endpoint connection.
|
|
394
|
+
* @param device A LibertasEndpoint client or server.
|
|
395
395
|
* @param action interaction action.
|
|
396
396
|
* @param peer The peer that protocol from which message comes.
|
|
397
|
-
* @param tag The arbitrary data passed to {@link
|
|
397
|
+
* @param tag The arbitrary data passed to {@link libertasSetOnEndpoint} with the callback instance.
|
|
398
398
|
* @param data The protocol message, or undefined if `action` is `PeerDown`.
|
|
399
399
|
* @param ref The transaction Id. May be undefined if this is unsolicited `ReportData`.
|
|
400
400
|
*/
|
|
401
|
-
declare type
|
|
401
|
+
declare type LibertasEndpointCallback<T> = (device: LibertasEndpoint, action: LibertasEndpointAction, peer: number, tag: any, data?: T, ref?: number) => void;
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* Set a callback function to receive responses and reports to a device.
|
|
@@ -475,7 +475,7 @@ declare function libertasDeviceReadReq(device: LibertasDevice, requests: Liberta
|
|
|
475
475
|
* {@link LibertasDeviceAction.StatusResponse} with a {@link Matter.Status.Timeout} will be received from the callback registered with
|
|
476
476
|
* {@link libertasSetOnDevice}.
|
|
477
477
|
*
|
|
478
|
-
* The
|
|
478
|
+
* The Libertas App task shall not assume that it is the only process that sends requests. Other agents
|
|
479
479
|
* may also send requests. A task can only receive {@link LibertasClusterWriteRsp} to its written requests.
|
|
480
480
|
*
|
|
481
481
|
* To receive all changes to an attribute, use {@link libertasAppSubscribeReq}.
|
|
@@ -510,7 +510,7 @@ declare function libertasDeviceWriteReq(device: LibertasDevice, requests: Libert
|
|
|
510
510
|
* {@link LibertasDeviceAction.StatusResponse} with a {@link Matter.Status.Timeout} will be received from the callback registered with
|
|
511
511
|
* {@link libertasSetOnDevice}.
|
|
512
512
|
*
|
|
513
|
-
* The
|
|
513
|
+
* The Libertas App task shall not assume that it is the only process that sends requests. Other agents
|
|
514
514
|
* may also send requests. A task can only receive the {@link LibertasCommandRsp} to its command requests.
|
|
515
515
|
*
|
|
516
516
|
* To receive all changes to an attribute, use {@link libertasAppSubscribeReq}.
|
|
@@ -531,10 +531,10 @@ declare function libertasDeviceCommandReq(device: LibertasDevice, request: Liber
|
|
|
531
531
|
* @remarks
|
|
532
532
|
* An app only sends out one subscription request. The App must collect the list of all devices that require subscriptions and send them out all at once.
|
|
533
533
|
*
|
|
534
|
-
* Because the
|
|
534
|
+
* Because the Libertas App shares subscriptions with the host and possibly other Libertas Apps, the following behaviors may be observed:
|
|
535
535
|
*
|
|
536
536
|
* 1. The first few data reports may be in response to ReadRequest.
|
|
537
|
-
* 2. The data reports may contain attributes and events that are not subscribed to by this
|
|
537
|
+
* 2. The data reports may contain attributes and events that are not subscribed to by this Libertas App.
|
|
538
538
|
* 3. Libertas-OS will handle errors, including timeout. A StatusResponse report will be generated in case of errors.
|
|
539
539
|
*
|
|
540
540
|
* The report data will be passed to the callback function {@link LibertasDeviceCallback} registered with {@link libertasSetOnDevice}.
|
|
@@ -542,16 +542,16 @@ declare function libertasDeviceCommandReq(device: LibertasDevice, request: Liber
|
|
|
542
542
|
declare function libertasAppSubscribeReq(requests: LibertasDeviceSubscribeReq[]) : void;
|
|
543
543
|
|
|
544
544
|
/**
|
|
545
|
-
* Notify the Libertas
|
|
545
|
+
* Notify the Libertas Libertas App engine that some attributes have changed values.
|
|
546
546
|
* @param device A {@link LibertasVirtualDevice}.
|
|
547
547
|
* @param attributes The list of cluster attribute IDs. We reuse the {@link LibertasClusterReadReq} structure to hold the required data.
|
|
548
548
|
* Note that the event field is always undefined because Libertas OS handles the event reports.
|
|
549
549
|
* @param peer The subscription ID, which can be inferred from the peer in earlier {@link LibertasVirtualDeviceCallback}. Usually it should be undefined, unless
|
|
550
|
-
* the
|
|
550
|
+
* the Libertas App needs to manage data report for each individual subscriber.
|
|
551
551
|
*
|
|
552
|
-
* @remarks The
|
|
552
|
+
* @remarks The Libertas App engine is responsible for reporting each subscription based on the subscribed attributes, events, and minimum/maximum intervals.
|
|
553
553
|
* Even if the virtual device reported the changes, the report may not be generated immediately if the minimum interval has not been reached.
|
|
554
|
-
* Also, when the Libertas
|
|
554
|
+
* Also, when the Libertas Libertas App engine decides to generate a report, it will send a {@link LibertasDeviceAction.ReadRequest} or
|
|
555
555
|
* {@link LibertasDeviceAction.SubscribeRequest} with an array of {@link LibertasClusterReadReq} for the up-to-date values of the specified
|
|
556
556
|
* attributes and expect a response from {@link libertasVirtualDeviceAttributesRsp} call. If this value is defined, the notification will
|
|
557
557
|
* only be delivered to a single subscriber.
|
|
@@ -614,34 +614,34 @@ declare function libertasVirtualDeviceStatusRsp(device: LibertasVirtualDevice, r
|
|
|
614
614
|
declare function libertasSetOnVirtualDevice(device: LibertasVirtualDevice, func: LibertasVirtualDeviceCallback, tag?: any): void;
|
|
615
615
|
|
|
616
616
|
/**
|
|
617
|
-
* Sends a request or subscribeRequest message to an
|
|
617
|
+
* Sends a request or subscribeRequest message to an endpoint.
|
|
618
618
|
*
|
|
619
|
-
* @param device The target {@link
|
|
620
|
-
* @param action The interaction action, such as {@link
|
|
619
|
+
* @param device The target {@link LibertasEndpoint}.
|
|
620
|
+
* @param action The interaction action, such as {@link LibertasEndpointAction.Request} or {@link LibertasEndpointAction.SubscriptionRequest}.
|
|
621
621
|
* @param message The message payload to send.
|
|
622
622
|
*
|
|
623
623
|
* @returns A transaction ID that can be used to track the request and match it with a future response.
|
|
624
624
|
*/
|
|
625
|
-
declare function
|
|
625
|
+
declare function libertasEndpointSendRequest<T>(device: LibertasEndpoint, action: LibertasEndpointAction, message: T): number;
|
|
626
626
|
|
|
627
627
|
/**
|
|
628
|
-
* Sends a response to an
|
|
628
|
+
* Sends a response to an endpoint for a previously received request.
|
|
629
629
|
*
|
|
630
|
-
* @param device The target {@link
|
|
631
|
-
* @param action The interaction action, typically {@link
|
|
630
|
+
* @param device The target {@link LibertasEndpoint}.
|
|
631
|
+
* @param action The interaction action, typically {@link LibertasEndpointAction.Response} or {@link LibertasEndpointAction.ReportData}.
|
|
632
632
|
* @param message The message payload containing the response data.
|
|
633
|
-
* @param dest The request peer Id. It could be {@link LibertasPeer.Broadcast} for {@link
|
|
633
|
+
* @param dest The request peer Id. It could be {@link LibertasPeer.Broadcast} for {@link LibertasEndpointAction.ReportData}.
|
|
634
634
|
* @param transId The transaction ID (ref) from the original request being responded to.
|
|
635
635
|
*/
|
|
636
|
-
declare function
|
|
636
|
+
declare function libertasEndpointSendResponse<T>(device: LibertasEndpoint, action: LibertasEndpointAction, message: T, dest: number, transId: number): void;
|
|
637
637
|
|
|
638
638
|
/**
|
|
639
|
-
*
|
|
640
|
-
* @param device A {@link
|
|
639
|
+
* Endpoint message callback.
|
|
640
|
+
* @param device A {@link LibertasEndpoint}.
|
|
641
641
|
* @param func Callback function.
|
|
642
642
|
* @param tag Developer defined data that will be passed to callback function.
|
|
643
643
|
*/
|
|
644
|
-
declare function
|
|
644
|
+
declare function libertasSetOnEndpoint<T>(device: LibertasEndpoint, func: LibertasEndpointCallback<T>, tag?: any): void;
|
|
645
645
|
|
|
646
646
|
/**
|
|
647
647
|
* The signature of timer callback function.
|
|
@@ -756,7 +756,7 @@ declare function libertasTimerDestroy(timer: LibertasTimer): void;
|
|
|
756
756
|
declare function libertasTimerUpdate(timer: LibertasTimer, timeout: number, func?: LibertasTimerCallback, tag?: any): void
|
|
757
757
|
|
|
758
758
|
/**
|
|
759
|
-
* Trigger a user defined action. Users can define action with a client UI tool during
|
|
759
|
+
* Trigger a user defined action. Users can define action with a client UI tool during Libertas App task creation.
|
|
760
760
|
* @param action A {@link LibertasAction}.
|
|
761
761
|
*/
|
|
762
762
|
declare function libertasTriggerAction(action: LibertasAction): void;
|
|
@@ -912,7 +912,7 @@ declare type NotificationArgument =
|
|
|
912
912
|
*
|
|
913
913
|
* @throws On size limits or permission violations.
|
|
914
914
|
*/
|
|
915
|
-
declare function
|
|
915
|
+
declare function libertasNotificationSend(recipients: number[], level: NotificationImportance, resource_name: string, args: NotificationArgument[], source?: number): void;
|
|
916
916
|
|
|
917
917
|
/**
|
|
918
918
|
* Sends a literal text notification.
|
|
@@ -924,7 +924,7 @@ declare function libertas_NotificationSend(recipients: number[], level: Notifica
|
|
|
924
924
|
*
|
|
925
925
|
* @throws On size limits or permission violations.
|
|
926
926
|
*/
|
|
927
|
-
declare function
|
|
927
|
+
declare function libertasNotificationSendLiteral(recipients: number[], level: NotificationImportance, text: string, source?: number): void;
|
|
928
928
|
|
|
929
929
|
/**
|
|
930
930
|
* Data name with resource and arguments.
|
|
@@ -1151,230 +1151,6 @@ declare const enum LibertasLogLevel {
|
|
|
1151
1151
|
* @param level Log level.
|
|
1152
1152
|
* @param message A text message.
|
|
1153
1153
|
*
|
|
1154
|
-
* @remarks The log source is the name of the
|
|
1154
|
+
* @remarks The log source is the name of the Libertas App task.
|
|
1155
1155
|
*/
|
|
1156
1156
|
declare function libertasLog(level: LibertasLogLevel, message: string): void;
|
|
1157
|
-
|
|
1158
|
-
declare namespace Libertas {
|
|
1159
|
-
/**
|
|
1160
|
-
* The device type constants. Compatible with the Zigbee protocol with Libertas-specific additions.
|
|
1161
|
-
*/
|
|
1162
|
-
export enum DeviceType {
|
|
1163
|
-
NA = 0xFFFF,
|
|
1164
|
-
ANY = 0xFFFF,
|
|
1165
|
-
// LIBERTAS
|
|
1166
|
-
TASK = 0xF000,
|
|
1167
|
-
PROXIMITY_SENSOR = 0xF001,
|
|
1168
|
-
GEN_MULTISTATE = 0xF002,
|
|
1169
|
-
SPRINKLER_CONTROLLER = 0xF003,
|
|
1170
|
-
}
|
|
1171
|
-
|
|
1172
|
-
/**
|
|
1173
|
-
* The Libertas cluster constants. Compatible with the Zigbee protocol with Libertas-specific additions.
|
|
1174
|
-
*
|
|
1175
|
-
* Clusters are a group of commands and attributes that define what a device can do. Think of clusters as a group of actions by function. A device can support multiple clusters to do a whole variety of tasks.
|
|
1176
|
-
*
|
|
1177
|
-
* In another word, Clusters specify the capabilities of a device.
|
|
1178
|
-
*
|
|
1179
|
-
*/
|
|
1180
|
-
export enum LibertasClusterId {
|
|
1181
|
-
// General Clusters
|
|
1182
|
-
INVALID = 0xFFFF,
|
|
1183
|
-
// Clusters
|
|
1184
|
-
LIBERTAS_SWITCH_CONFIG = 0xFC00,
|
|
1185
|
-
LIBERTAS_SWITCH_LINKABLE = 0xFC01,
|
|
1186
|
-
LIBERTAS_LEVEL_CONFIG = 0xFC02,
|
|
1187
|
-
LIBERTAS_LEVEL_DISPLAY = 0xFC03,
|
|
1188
|
-
LIBERTAS_BACKLIGHT_LEVEL = 0xFC04,
|
|
1189
|
-
LIBERTAS_BACKLIGHT_CONFIG = 0xFC05,
|
|
1190
|
-
LIBERTAS_ONOFF_CONFIG = 0xFC06,
|
|
1191
|
-
LIBERTAS_GEN_SENSOR = 0xFC07,
|
|
1192
|
-
LIBERTAS_FLASH_MEMORY = 0xFC10,
|
|
1193
|
-
LIBERTAS_UI = 0xFC20,
|
|
1194
|
-
LIBERTAS_REMOTE = 0xFC30,
|
|
1195
|
-
LIBERTAS_THERMOSTAT = 0xFC40,
|
|
1196
|
-
LIBERTAS_THERMOSTAT_HEAT = 0xFC41,
|
|
1197
|
-
LIBERTAS_THERMOSTAT_COOL = 0xFC42,
|
|
1198
|
-
LIBERTAS_THERMOSTAT_AUX = 0xFC43,
|
|
1199
|
-
LIBERTAS_PROXIMITY = 0xFC50,
|
|
1200
|
-
LIBERTAS_SPRINKLER_CONFIG = 0xFC60,
|
|
1201
|
-
LIBERTAS_HUB = 0xFC70,
|
|
1202
|
-
LIBERTAS_APP = 0xFC80,
|
|
1203
|
-
}
|
|
1204
|
-
|
|
1205
|
-
/**
|
|
1206
|
-
* Attributes are a set of properties within a Cluster.
|
|
1207
|
-
*
|
|
1208
|
-
* Each attribute is identified by an ID (16-bit integer), along with a predefined data type.
|
|
1209
|
-
*
|
|
1210
|
-
*/
|
|
1211
|
-
export enum LibertasAttrId {
|
|
1212
|
-
LIBERTAS_HVAC_THERMOSTAT_LOCAL_HUMIDITY = 0x8000,
|
|
1213
|
-
LIBERTAS_HVAC_THERMOSTAT_LOCAL_HUMIDITY_CALIBRATION = 0x8001,
|
|
1214
|
-
LIBERTAS_HVAC_THERMOSTAT_HUMIDITY_LOW = 0x8002,
|
|
1215
|
-
LIBERTAS_HVAC_THERMOSTAT_HUMIDITY_HIGH = 0x8003,
|
|
1216
|
-
LIBERTAS_HVAC_THERMOSTAT_HEAT_USES_AUX = 0x8004,
|
|
1217
|
-
|
|
1218
|
-
// Power CFG
|
|
1219
|
-
LIBERTAS_POWER_CFG_BATTERY_VOLTAGE = 0x8020,
|
|
1220
|
-
|
|
1221
|
-
// Required
|
|
1222
|
-
LIBERTAS_SWITCH_LINKED_TO = 0x0000,
|
|
1223
|
-
|
|
1224
|
-
// In qwha_switch.h
|
|
1225
|
-
// qwha_switch_type_t
|
|
1226
|
-
LIBERTAS_SWITCH_TYPE = 0x0000,
|
|
1227
|
-
LIBERTAS_SWITCH_CLUSTER = 0x0001,
|
|
1228
|
-
LIBERTAS_SWITCH_PRESS_DELAY = 0x0002,
|
|
1229
|
-
LIBERTAS_SWITCH_ACTION_COMMANDS_1 = 0x0003,
|
|
1230
|
-
LIBERTAS_SWITCH_ACTION_COMMANDS_2 = 0x0004,
|
|
1231
|
-
LIBERTAS_SWITCH_LOAD_DEVICE = 0x0005,
|
|
1232
|
-
|
|
1233
|
-
// ZCL_CLUSTER_ID_LIBERTAS_LEVEL_CONFIG
|
|
1234
|
-
LIBERTAS_LEVEL_MAX = 0x0000,
|
|
1235
|
-
LIBERTAS_LEVEL_MIN = 0x0001,
|
|
1236
|
-
LIBERTAS_LEVEL_STEP_ONLY = 0x0002,
|
|
1237
|
-
LIBERTAS_LEVEL_STEP_SINGLE = 0x0003,
|
|
1238
|
-
LIBERTAS_LEVEL_STEP_REPEAT = 0x0004,
|
|
1239
|
-
LIBERTAS_LEVEL_STEP_INTERVAL = 0x0005,
|
|
1240
|
-
// ZCL_CLUSTER_ID_LIBERTAS_LEVEL_DISPLAY
|
|
1241
|
-
LIBERTAS_LEVEL_DISPLAY_OFFSET = 0x0000,
|
|
1242
|
-
LIBERTAS_LEVEL_DISPLAY_SCALE = 0x0001,
|
|
1243
|
-
LIBERTAS_LEVEL_DISPLAY_DIGITS = 0x0002,
|
|
1244
|
-
LIBERTAS_LEVEL_DISPLAY_FLAGS = 0x0003,
|
|
1245
|
-
// ZCL_CLUSTER_ID_LIBERTAS_BACKLIGHT
|
|
1246
|
-
LIBERTAS_BACKLIGHT_LEVEL = 0x0000,
|
|
1247
|
-
LIBERTAS_BACKLIGHT_ON_PATTERN = 0x0001,
|
|
1248
|
-
LIBERTAS_BACKLIGHT_OFF_PATTERN = 0x0002,
|
|
1249
|
-
LIBERTAS_BACKLIGHT_ANI_PATTERN = 0x0003,
|
|
1250
|
-
// ZCL_CLUSTER_ID_LIBERTAS_REMOTE
|
|
1251
|
-
LIBERTAS_REMOTE_BUTTON_CONFIG = 0x0000,
|
|
1252
|
-
// ZCL_CLUSTER_ID_LIBERTAS_ONOFF_CONFIG
|
|
1253
|
-
LIBERTAS_ONOFF_DEFAULT_ON_TIME = 0x0000,
|
|
1254
|
-
LIBERTAS_ONOFF_DEFAULT_OFF_WAIT_TIME = 0x0001,
|
|
1255
|
-
LIBERTAS_ONOFF_TIME_INTERVAL = 0x0002,
|
|
1256
|
-
|
|
1257
|
-
// ZCL_CLUSTER_ID_LIBERTAS_THERMOSTAT
|
|
1258
|
-
LIBERTAS_THERMOSTAT_COOL_HVAC_UNIT_ID = 0x0000,
|
|
1259
|
-
LIBERTAS_THERMOSTAT_HEAT_HVAC_UNIT_ID = 0x0001,
|
|
1260
|
-
LIBERTAS_THERMOSTAT_COOL_TYPE = 0x0002,
|
|
1261
|
-
LIBERTAS_THERMOSTAT_HEAT_TYPE = 0x0003,
|
|
1262
|
-
LIBERTAS_THERMOSTAT_AUX_HEAT_TYPE = 0x0004,
|
|
1263
|
-
LIBERTAS_THERMOSTAT_COOL_STAGES = 0x0005,
|
|
1264
|
-
LIBERTAS_THERMOSTAT_HEAT_STAGES = 0x0006,
|
|
1265
|
-
LIBERTAS_THERMOSTAT_AUX_HEAT_STAGES = 0x0007,
|
|
1266
|
-
LIBERTAS_THERMOSTAT_FAN_STAGES = 0x0008,
|
|
1267
|
-
LIBERTAS_THERMOSTAT_HEAT_PUMP_OB_ON_COOL = 0x0009,
|
|
1268
|
-
LIBERTAS_THERMOSTAT_FAN_USAGE = 0x000A,
|
|
1269
|
-
LIBERTAS_THERMOSTAT_ACC_TYPE = 0x000B,
|
|
1270
|
-
LIBERTAS_THERMOSTAT_ACC_EXT_POWER = 0x000C,
|
|
1271
|
-
|
|
1272
|
-
// Cool or heat parameters
|
|
1273
|
-
LIBERTAS_THERMOSTAT_MIN_OFF_TIME = 0x0010,
|
|
1274
|
-
LIBERTAS_THERMOSTAT_MIN_ON_TIME = 0x0011,
|
|
1275
|
-
LIBERTAS_THERMOSTAT_MAINTENANCE_BAND = 0x0012,
|
|
1276
|
-
LIBERTAS_THERMOSTAT_DISSIPATION_TIME = 0x0013,
|
|
1277
|
-
LIBERTAS_THERMOSTAT_STAGE1_TEMP_DELTA = 0x0014,
|
|
1278
|
-
LIBERTAS_THERMOSTAT_STAGE1_MAX_RUNTIME = 0x0015,
|
|
1279
|
-
LIBERTAS_THERMOSTAT_STAGE2_TEMP_DELTA = 0x0016,
|
|
1280
|
-
LIBERTAS_THERMOSTAT_STAGE2_MAX_RUNTIME = 0x0017,
|
|
1281
|
-
LIBERTAS_THERMOSTAT_STAGE3_TEMP_DELTA = 0x0018,
|
|
1282
|
-
|
|
1283
|
-
//LIBERTAS_HUB
|
|
1284
|
-
|
|
1285
|
-
/**
|
|
1286
|
-
* Minimum state of a multi-state device, for {@link LibertasClusterId.LIBERTAS_HUB}.
|
|
1287
|
-
*
|
|
1288
|
-
* @remarks This attribute can be generated by a virtual device driver App. Date type is int16.
|
|
1289
|
-
*/
|
|
1290
|
-
LIBERTAS_MULTISTATE_MIN = 0x0004, // int16
|
|
1291
|
-
/**
|
|
1292
|
-
* Maximum state of a multi-state device, for {@link LibertasClusterId.LIBERTAS_HUB}.
|
|
1293
|
-
*
|
|
1294
|
-
* @remarks This attribute can be generated by a virtual device driver App. Date type is int16.
|
|
1295
|
-
*/
|
|
1296
|
-
LIBERTAS_MULTISTATE_MAX = 0x0005, // int16
|
|
1297
|
-
/**
|
|
1298
|
-
* Constrains valid values of a multi-state device, for {@link LibertasClusterId.LIBERTAS_HUB}.
|
|
1299
|
-
*/
|
|
1300
|
-
LIBERTAS_MULTISTATE_VALUES = 0x0006, // int16 array
|
|
1301
|
-
/**
|
|
1302
|
-
* Name of states of a multi-state device, for {@link LibertasClusterId.LIBERTAS_HUB}.
|
|
1303
|
-
*/
|
|
1304
|
-
LIBERTAS_MULTISTATE_NAMES = 0x0007, // string array
|
|
1305
|
-
}
|
|
1306
|
-
|
|
1307
|
-
/**
|
|
1308
|
-
* A logical device can be either load or non-load device.
|
|
1309
|
-
*
|
|
1310
|
-
* For example, a "dummy" button is a non-load device because it can only be used to control other devices by sending control signals.
|
|
1311
|
-
*
|
|
1312
|
-
* Sensors are considered "load" devices.
|
|
1313
|
-
*
|
|
1314
|
-
* @remarks
|
|
1315
|
-
* Only load devices are allowed within an IoT App. Non-load buttons are managed internally by the system through end-user device group linking.
|
|
1316
|
-
*
|
|
1317
|
-
* As an exception, virtual devices can be either load or non-load type because it makes sense to emulate a non-load device (such as a button) with app code and expose the virtual device to the system.
|
|
1318
|
-
*
|
|
1319
|
-
*/
|
|
1320
|
-
export enum LibertasDeviceLoadType {
|
|
1321
|
-
LOAD_NON = 0,
|
|
1322
|
-
LOAD = 1,
|
|
1323
|
-
LOAD_ANY = 2,
|
|
1324
|
-
}
|
|
1325
|
-
}
|
|
1326
|
-
|
|
1327
|
-
declare namespace Matter {
|
|
1328
|
-
/**
|
|
1329
|
-
* Interaction model status codes.
|
|
1330
|
-
*/
|
|
1331
|
-
export enum Status {
|
|
1332
|
-
Success = 0x0,
|
|
1333
|
-
Failure = 0x01,
|
|
1334
|
-
InvalidSubscription = 0x7d,
|
|
1335
|
-
UnsupportedAccess = 0x7e,
|
|
1336
|
-
UnsupportedEndpoint = 0x7f,
|
|
1337
|
-
InvalidAction = 0x80,
|
|
1338
|
-
UnsupportedCommand = 0x81,
|
|
1339
|
-
Deprecated82 = 0x82,
|
|
1340
|
-
Deprecated83 = 0x83,
|
|
1341
|
-
Deprecated84 = 0x84,
|
|
1342
|
-
InvalidCommand = 0x85,
|
|
1343
|
-
UnsupportedAttribute = 0x86,
|
|
1344
|
-
ConstraintError = 0x87,
|
|
1345
|
-
UnsupportedWrite = 0x88,
|
|
1346
|
-
ResourceExhausted = 0x89,
|
|
1347
|
-
Deprecated8a = 0x8a,
|
|
1348
|
-
NotFound = 0x8b,
|
|
1349
|
-
UnreportableAttribute = 0x8c,
|
|
1350
|
-
InvalidDataType = 0x8d,
|
|
1351
|
-
Deprecated8e = 0x8e,
|
|
1352
|
-
UnsupportedRead = 0x8f,
|
|
1353
|
-
Deprecated90 = 0x90,
|
|
1354
|
-
Deprecated91 = 0x91,
|
|
1355
|
-
DataVersionMismatch = 0x92,
|
|
1356
|
-
Deprecated93 = 0x93,
|
|
1357
|
-
Timeout = 0x94,
|
|
1358
|
-
Reserved95 = 0x95,
|
|
1359
|
-
Reserved96 = 0x96,
|
|
1360
|
-
Reserved97 = 0x97,
|
|
1361
|
-
Reserved98 = 0x98,
|
|
1362
|
-
Reserved99 = 0x99,
|
|
1363
|
-
Reserved9a = 0x9a,
|
|
1364
|
-
Busy = 0x9c,
|
|
1365
|
-
Deprecatedc0 = 0xc0,
|
|
1366
|
-
Deprecatedc1 = 0xc1,
|
|
1367
|
-
Deprecatedc2 = 0xc2,
|
|
1368
|
-
UnsupportedCluster = 0xc3,
|
|
1369
|
-
Deprecatedc4 = 0xc4,
|
|
1370
|
-
NoUpstreamSubscription = 0xc5,
|
|
1371
|
-
NeedsTimedInteraction = 0xc6,
|
|
1372
|
-
UnsupportedEvent = 0xc7,
|
|
1373
|
-
PathsExhausted = 0xc8,
|
|
1374
|
-
TimedRequestMismatch = 0xc9,
|
|
1375
|
-
FailsafeRequired = 0xca,
|
|
1376
|
-
InvalidInState = 0xcb,
|
|
1377
|
-
NoCommandResponse = 0xcc,
|
|
1378
|
-
WriteIgnored = 0xF0, // non-spec error code and use only internally
|
|
1379
|
-
}
|
|
1380
|
-
}
|