JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

download JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

of 7

Transcript of JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    1/7

    RELEASE NOTES

    JN-SW-4042 SE Profile for ZigBee PRO

    SE1v1.5

    Related Products and VersionsThis document relates to:

    SE Profile for ZigBee PRO (JN-SW-4042) Final Release SE_1v5_RC5

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    2/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    2 NXP Laboratories UK 2011 JN-RN-0025 v1.5

    CONTENTS1. SOFTWARE COMPONENTS 32. SUPPORTED PRODUCTS 33. SOFTWARE INSTALLATION 34. INSTALLED SOFTWARE 4

    4.1 ZigBee Cluster Library (ZCL) 44.2 Clusters 44.3 Smart Energy Profile 44.4 ECC library and Certicom-to-Jennic Patch Library (SBMCE) 4

    5. RELEASE DETAILS 55.1 Smart Energy Profile for ZigBee PRO 5

    5.1.1 New Features 55.1.2 Problem Report 55.1.3 Known Issues 5

    5.1.4 Support Collateral 5

    6. Release History Version 1.2 66.1 Smart Energy Profile for ZigBee PRO 6

    6.1.1 New Features 66.1.2 Bug Fixes 66.1.3 Support Collateral 6

    7. Release History Version 1.1 67.1 Smart Energy Profile for ZigBee PRO 6

    7.1.1 New Features 67.1.2 Known Issues 7

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    3/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    JN-RN-0025 v1.5 NXP Laboratories UK 2011 3

    1. SOFTWARE COMPONENTSThis SDK update (JN-SW-4042) provides a modification to the NXP JN5148 SDK inorder to support the ZigBee PRO Smart Energy (SE) profile for the JN5148 device. JN-

    SW-4042 is installed on top of JN-SW-4040 (SDK Libraries) and JN-SW-4041 (SDKToolchain ).

    This is version 1.5 of the Smart Energy (SE) profile and includes.

    Clusters and profiles required for Smart Energy applications

    ZigBee Cluster Library (ZCL) source and include files

    The following sections provide further details of the software components in thisrelease.

    2. SUPPORTED PRODUCTSThe SDK supports the following NXP products:

    Chips Modules Evaluation Kits

    JN5148-001 JN5148-001-M00

    JN5148-001-M03

    3. SOFTWARE INSTALLATIONThe JN-SW-4042 softwarerelease is provided as a ZIP file to update:

    JN-SW-4041-SDK-Toolchain-v1.1

    JN-SW-4040-SDK-Libraries-v1.6

    Extract the contents of the ZIP file into the directory:

    \Jennic\

    where is the path in which the JN5148 SDK is installed,e.g. C:\.

    Note: -NONE-

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    4/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    4 NXP Laboratories UK 2011 JN-RN-0025 v1.5

    4. INSTALLED SOFTWARE

    4.1 ZigBee Cluster Library (ZCL)

    The ZCL is supplied as a library and header files. Functions in the ZCL do not need tobe accessed directly, but are used by the Smart Energy API. The ZCL files will beinstalled in the following locations:

    The ZCL Source files will be installed into Components\ZCL\Source

    The ZCL header files will be installed into Components\ZCL\Include

    4.2 Clusters

    The Smart Energy functionality is supplied as source code.

    The cluster definitions are installed into Components\ZCL\Clusters. An application

    will need to include the appropriate header files to access attributes of the clusters.

    4.3 Smart Energy Profile

    The Smart Energy (SE) profile is installed into Components\ZCL\Profiles\SE.

    An Energy Services Portal (ESP) or Meter application will include se.h andesp_meter.h.

    An In-Premise Display (IPD) application will include se.h and ipd.h.

    4.4 ECC library and Certicom-to-Jennic Patch Library

    (SBMCE)The Certicom ECC library libECC_JN514x.a and header file sbmce_cb.h aresupplied in the release package. This is a change from the 1.2 release, where thelibrary was not supplied due to licensing restrictions in place at the time.

    The supplied SBMCE library enables the Certicom ECC library, libECC_JN514x.a, toaccess the NXP libraries. It is supplied as a library file and a header file.

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    5/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    JN-RN-0025 v1.5 NXP Laboratories UK 2011 5

    5. RELEASE DETAILS

    5.1 Smart Energy Profile for ZigBee PRO

    5.1.1 New Features

    Artifact ID Summary

    lpsw2711 All optional attributes of simple metering cluster should be implemented

    lpsw2621 OTA Application should be aware of when a new image is received [OTA Client].

    lpsw2619 Server & Client Send commands

    lpsw2618 Client command handler for prepayment cluster

    lpsw2617 Server Command handler for Prepayment cluster.

    lpsw2616 Custom Command Handler for Prepayment Cluster

    lpsw2615 Prepayment cluster instance creation for Server & Clientlpsw2614 Add Attribute definitions for Prepayment Cluster

    lpsw2572 Generic function for read attribute response handling which should automatically request for

    any attributes that have not been returned in the response

    lpsw2571 Generic function for read all attributes which are enabled. Fucntion can be used by any

    cluster/profile

    5.1.2 Problem Report

    NONE

    5.1.3 Known Issues

    NONE

    5.1.4 Support Collateral

    User guides JN-UG-3059: ZigBee PRO Smart Energy API User Guide and JN-UG-3077: ZigBee Cluster Library User Guide.

    Smart Energy Specification Referred

    115356r16ZB_ZSE-ZSE-AMI_Profile_Specification

    Smart Energy Test Specification Referred

    095312r30ZB_ZSE-SEP_1.1_Release_Test_Specification

    Note that the above two User Guides incorporate the information from the now obsoleteZigBee PRO Smart Energy API Reference Manual (JN-RM-2046).

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    6/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    6 NXP Laboratories UK 2011 JN-RN-0025 v1.5

    6. Release History Version 1.2

    6.1 Smart Energy Profile for ZigBee PRO

    6.1.1 New Features

    ID Description

    MAR 32 Manufacturer-specific enhancements, including API change

    MAR 38 Unified ZCL/cluster error codes

    6.1.2 Bug Fixes

    ID Severity Description

    MAR 23 MinorSE verification: Bound transmission not working when route discovery occurs onthe node

    MAR 24 Minor Application Note support for Sleeping End Devices added

    MAR 39 MinorUnsupported commands should return default response ofE_ZCL_CMDS_UNSUP_CLUSTER_COMMAND

    MAR 40 Minor File libSBMCE_JN514x.a added

    6.1.3 Support Collateral

    ZigBee PRO Smart Energy API User Guide (JN-UG-3059)

    ZigBee PRO Smart Energy API Reference Manual (JN-RM-2046)

    7. Release History Version 1.1

    7.1 Smart Energy Profile for ZigBee PRO

    7.1.1 New FeaturesID Description

    MAR 4 Makefile Integration with ZBPro

    MAR 25 Price and Time Clusters

    MAR 26 Messaging cluster

    MAR 27 Key Establishment cluster

  • 7/28/2019 JN-RN-0025-JN-SW-4042-SE-Profile-for-ZBPro.pdf

    7/7

    JN-SW-4042 SE Profile for ZigBee PRORelease Notes

    JN-RN-0025 v1.5 NXP Laboratories UK 2011 7

    7.1.2 Known Issues

    ID Severity Description

    MAR 23 MinorSE Verification: Bound Transmission not working when Route discovery happenson the node

    MAR 24 Minor Application Note support for Sleeping End Devices