Raritan PX2/PX3 JSON-RPC API
ZigbeeDevice.idl
1 #ifndef __ZIGBEEDEVICE_IDL__
2 #define __ZIGBEEDEVICE_IDL__
3 
4 #include <Event.idl>
5 
6 /** Zigbee */
7 module zigbee {
8  /** Zigbee Device */
9  interface ZigbeeDevice {
10 
11  /**
12  * Supported Cluster Types
13  * defined by zigbee alliance in the zigbee cluster library specification
14  */
15  constant int CLUSTER_BASIC = 0x0000;
16  constant int CLUSTER_POWER_CONFIGURATION = 0x0001;
17  constant int CLUSTER_RSSI = 0x000B;
18  constant int CLUSTER_CONTACT_CLOSURE = 0x000F;
19  constant int CLUSTER_TEMPERATURE = 0x0402;
20  constant int CLUSTER_HUMIDITY = 0x0405;
21 
22  /** Device MetaData*/
23  structure MetaData {
24  int sourceId; ///< the device source ID
25  vector<int> clusters; ///< the clusters which are reporting to this device
26  int preferredSlot; ///< the slot which should be assigned to the first sensor
27  };
28 
29  /** Cluster Value */
30  structure ClusterValue {
31  int id; ///< the cluster ID
32  int endpoint; ///< the endpoint ID
33  int attribute; ///< the reported attribute. some clusters have multiple reporting attributes
34  time timestamp; ///< the time when the cluster value was updated. UNIX timestamp (UTC)
35  string value; ///< the value which was reported.
36  };
37 
38  /** Cluster Value Changed Event*/
39  valueobject ClusterDataEvent extends idl.Event {
40  ClusterValue value; ///< the cluster value
41  };
42 
43  /**
44  * Retrieve Dongle MetaData
45  *
46  * @return MetaData
47  */
49 
50  /**
51  * Retrieve the last cluster values
52  * Needed for battery voltage (only reported all 12h)
53  *
54  * @return list of all cluster values currently reported
55  */
56  vector<ClusterValue> getClusterValues();
57  };
58 
59 }
60 
61 #endif /* __ZIGBEEDEVICE_IDL__ */
62 
zigbee::ZigbeeDevice::MetaData
Device MetaData.
Definition: ZigbeeDevice.idl:23
zigbee::ZigbeeDevice::ClusterValue::value
string value
the value which was reported.
Definition: ZigbeeDevice.idl:35
zigbee::ZigbeeDevice
Zigbee Device.
Definition: ZigbeeDevice.idl:9
zigbee::ZigbeeDevice::ClusterValue
Cluster Value.
Definition: ZigbeeDevice.idl:30
zigbee::ZigbeeDevice::MetaData::sourceId
int sourceId
the device source ID
Definition: ZigbeeDevice.idl:24
zigbee::ZigbeeDevice::ClusterValue::timestamp
time timestamp
the time when the cluster value was updated. UNIX timestamp (UTC)
Definition: ZigbeeDevice.idl:34
zigbee::ZigbeeDevice::ClusterValue::id
int id
the cluster ID
Definition: ZigbeeDevice.idl:31
idl
Basic IDL definitions.
Definition: Event.idl:10
zigbee::ZigbeeDevice::ClusterValue::endpoint
int endpoint
the endpoint ID
Definition: ZigbeeDevice.idl:32
zigbee::ZigbeeDevice::MetaData::preferredSlot
int preferredSlot
the slot which should be assigned to the first sensor
Definition: ZigbeeDevice.idl:26
zigbee
Zigbee.
Definition: ZigbeeDevice.idl:7
zigbee::ZigbeeDevice::MetaData::clusters
vector< int > clusters
the clusters which are reporting to this device
Definition: ZigbeeDevice.idl:25
zigbee::ZigbeeDevice::getMetaData
MetaData getMetaData()
Retrieve Dongle MetaData.
zigbee::ZigbeeDevice::ClusterValue::attribute
int attribute
the reported attribute. some clusters have multiple reporting attributes
Definition: ZigbeeDevice.idl:33
zigbee::ZigbeeDevice::getClusterValues
vector< ClusterValue > getClusterValues()
Retrieve the last cluster values Needed for battery voltage (only reported all 12h)