HOW TO: Configure Smart Energy Reporting Intervals for Digi ConnectPort X2 Smart Energy Gateways

HOW TO: Configure  Smart Energy Reporting Intervals for Digi ConnectPort X2 Smart Energy Gateways

 

These values can be changed using the demonstration application by navigating to:  digi-se.appspot.com.  Select the applicable Device Cloud entry from the Server drop down.  Login using your Digi Device Cloud username and password credentials.

Once logged in, select the desired gateway ID in the Gateway drop down box near the top of the screen.  Next, select Debug Console.  From the menus to the left, select RPC_ZCL_Interface followed by start_receiving_reports.

Start Reporting:

Modify the fields in bold in the following example for your specific gateway:

<start_receiving_reports synchronous="true">
  <cluster_id>0x0702</cluster_id>
  <server_or_client>0</server_or_client>
  <source_endpoint_id>0x5E</source_endpoint_id>
  <destination_endpoint_id>0x1</destination_endpoint_id>
  <destination_address type="MAC">11:22:33:44:55:66:77:88</destination_address>
  <record_list type="list">
    <item type="AttributeReportingConfigurationRecord">
      <attribute_id>0x0000</attribute_id>
      <attribute_type>0x25</attribute_type>
      <min_interval>120</min_interval>
      <max_interval>480</max_interval>
      <reportable_change>1</reportable_change>
      <timeout>960</timeout>
    </item>
  </record_list>
</start_receiving_reports>

The above example shows reports in 2 minute intervals when the attribute value has changed, if the attribute value has not changed report the value in 8 minutes.  The various intervals in the configuration have been converted to seconds. We recommend the timeout value is double the max_interval.


Stop Reporting:

Modify the fields in bold in the following example for your specific gateway:

<stop_receiving_reports synchronous="true">
  <cluster_id>0x0702</cluster_id>
  <server_or_client>0</server_or_client>
  <source_endpoint_id>0x5E</source_endpoint_id>
  <destination_endpoint_id>0x1</destination_endpoint_id>
  <destination_address type="MAC">11:22:33:44:55:66:77:88</destination_address>
  <record_list type="list">
    <item type="StopReportingRecord">
      <attribute_id>0x0000</attribute_id>
    </item>
  </record_list>
</stop_receiving_reports>

View Reporting:

Under the RPC_ZCL_Interface menu on the left, select get_local_reporting_configurations, click Execute.

Field definitions:
  • destination_address - 64-bit extended address of the device to which the ZCL command will be sent. 
  • destination_endpoint_id - Zigbee endpoint this attribute resides on
  • cluster_id - Associated Zigbee cluster
  • server_or_client - Kind of associated Zigbee cluster (0=server or 1=client)
  • attribute_id - Zigbee attribute id
  • min_interval - Minimum interval, in seconds, between issuing reports of the attribute
  • max_interval - Maximum interval, in seconds, between issuing reports of the attribute
  • reportable_change - Minimum change to the attribute that will result in a report being issued. 
  • timeout - Maximum expected time, in seconds, between received reports for the attribute - typically 2 x max_interval
  • source_endpointId -  Local endpoint (optional)
  • record_list - List of configurations which will make up the payload of the ZCL command
Last updated: Aug 08, 2017

Recently Viewed Articles

No recently viewed articles
Contact a Digi expert and get started today! Contact Us