RFP ZigBee API

Transcription

1 RFP ZigBee API Draft 12 Pages Abstract This document describes needs and requirements of Java API to control and manage ZigBee devices on an OSGi platform according to OSGi best practices.. All company, brand and product names contained within this document may be trademarks that are the sole property of the respective owners. The above notice must be included on all copies of this document that are made.

2 RFP 142- ZigBee API Page 2 of Document Information 0.1 Table of Contents 0 Document Information Table of Contents Terminology and Document Conventions Revision History Introduction Application Domain System Architecture ZigBee Stack Application Profile and ZigBee Cluster Library (ZCL) Problem Description Use Cases ZigBee Device Control by locally installed OSGi applications ZigBee Device Control through USB Dongle ZigBee Device Control through standard ZigBee Gateway Devices ZigBee Gateway with IP networks Network Refreshment Requirements Document Support References Author s Address End of Document Terminology and Document Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interpreted as described in 6.1. Source code is shown in this typeface.

3 0.3 Revision History The last named individual in this history is currently responsible for this document. Revision Date Comments Initial Feb Initial version. Masayoshi Shimizu, NEC Europe Ltd, 0.1 May Reflect comments on the requirements from the workshop in West Yorkshire. Masayoshi Shimizu, NEC Corporation, m- 0.2 Oct Made the use case more generic. Masayoshi Shimizu, NEC Corporation, m- 0.3 Apr Removed the high-level API requirement and added new requirements related to Device Access specification. 0.4 Jun Main changes are: Masayoshi Shimizu, NEC Corporation, m- Split the use case of USB dongle between a common one and dongle-specific one. Added three use cases: ZigBee gateway with IP networks, ZigBee Gateway Device, network refreshment. Specify APSDE-SAP in the requirement R1 as a required functionality of the API. Generalized the description of the section 2 to synchronize with the ZigBee chip use case Andre Bottaro, France Telecom Orange, andre.bottaro@orange.com Arnaud Rinquin, France Telecom Orange, arnaud.rinquin@orange.com Francesco Furfari, CNR ISTI, francesco.furfari@isti.cnr.it Masayoshi Shimizu, NEC Corporation, m-shimizu@ij.jp.nec.com

4 1 Introduction ZigBee is a standard wireless communication protocol designed for low-cost and low-power devices by ZigBee Alliance. One of the main target areas for ZigBee is Home Automation. In fact ZigBee is widely supported by various types of devices such as smart meters, lights and many kinds of sensors in the residential area. Some OSGi applications need to communicate with those ZigBee devices. However there is no standard way of communicating with the ZigBee devices for OSGi applications. This RFP describes needs and requirements of ZigBee API on OSGi.

5 2 Application Domain 2.1 System Architecture When installing a new ZigBee network into a residential network with a home gateway, there are 2 options. One is to add ZigBee communication capability to your home gateway with an additional hardware such as a USB device called "dongle". The other one is to replace the current home gateway with one which has ZigBee communication capability. In the both cases OSGi applications call the ZigBee driver API to communicate with the ZigBee devices as shown in Figure 1. Figure 1: Communication with ZigBee devices through a ZigBee driver The ZigBee specification defines three types of ZigBee devices: ZigBee Coordinator (ZC), ZigBee Router (ZR) and ZigBee End Device (ZED). In the above case the ZigBee hardware works as the ZigBee Coordinator and the other ZigBee device are attached to the ZigBee network as ZigBee End Device or ZigBee Router. ZigBee Coordinator (ZC) is responsible for managing a ZigBee network and ZigBee devices on the network. One ZigBee Coordinator is in each ZigBee network. ZigBee Router (ZR) is capable of extending a ZigBee network by relaying messages from other ZigBee devices. ZigBee End Device (ZED) has functionality to communicate with either ZigBee

6 RFP 142- ZigBee API Page 6 of 12 Coordinator or ZigBee Router ZigBee Stack The ZigBee stack is shown in Figure 2. The two bottom layers, the PHY layer and the MAC layer, are defined by IEEE standard. The ZigBee standard only defines network (NWK) layer, application (APL) layer and security layer on top of it. The NWK layer is responsible for managing the network formation and routing. The APL layer hosts application objects developed by manufactures. The security service provider is responsible for encryption and authentication. The application layer consists of three functional blocks: application support sub-layer, ZigBee Device Object (ZDO) and application framework. The application support sub-layer provides the transmission capability of data and management messages. The ZDO provides common functionality used by all applications. The application framework is the environment where application objects are hosted to control and manage the protocol layers. There are two interfaces available to applications: APSDE-SAP and ZDO public interface. The APSDE-SAP provides data transmission functionality between ZigBee devices. The ZDO public interface provides applications with management functionality such as device discovery, service discovery and network management.

7 RFP 142- ZigBee API Page 7 of Figure 2: ZigBee Stack 2.3 Application Profile and ZigBee Cluster Library (ZCL) The application profiles allow interoperability between products developed by different vendors for a specific application. For example, in a light control scenario, switches developed by a vendor can turn on and turn off lights developed by another vendor if the both vendors take the same application profile. The ZigBee Alliance has defined nine public application profiles such as Home Automation (HA) and ZigBee Smart Energy (ZSE). An application profile defines its application domain, a list of specific devices supported in the profile and a list of clusters supported by the devices. A cluster is a relevant collection of commands and attributes which together define an interface to specific functionality. The clusters used in public application profiles are defined in the ZigBee Cluster Library (ZCL) specification. The ZCL specification defines a number of clusters and categories them into groups by their functionality.

8 3 Problem Description As described in the section 2, OSGi applications which communicate with ZigBee devices are supposed to call the API of the driver provided by the vendor. The API is proprietary and different vendor by vendor since it is not standardized in the ZigBee specification. This causes the following problems: 1) Application developers need to know which vendor's ZigBee hardware is used with the target residential gateway in advance before developing their applications. 2) An application which was developed for a certain environment may not work in other environments. Those problems make it difficult for third parties to develop portable OSGi applications communicating with ZigBee devices. The standard ZigBee API demanded in this RFP would give developers a unified way of communicating with ZigBee devices. The developers do not need to care the proprietary API of drivers but simply use the standard one. 4 Use Cases 4.1 ZigBee Device Control by locally installed OSGi applications Locally installed OSGi applications interacting with ZigBee devices will ideally use the same driver. The driver initializes the available ZigBee local hosts e.g., USB dongles, built-in chips, ZigBee Gateways and allows to do management operations on these hosts such as network selection and device discovery. The driver also registers Device services which provide OSGi applications with an interface for communication with the discovered ZigBee devices. The user controls the ZigBee devices on the OSGi application. 4.2 ZigBee Device Control through USB Dongle A user who would like to control ZigBee devices in home attaches a ZigBee USB dongle to the residential gateway. OSGi Device Manager running on the residential gateway identifies the dongle and installs a suitable driver for it. The driver enables locally installed applications to

9 RFP 142- ZigBee API Page 9 of 12 control and manage ZigBee devices like in the above use case ZigBee Device Control through standard ZigBee Gateway Devices The ACME company has to develop a ZigBee application based on the OSGi ZigBee Device Service specification. The application is developed for one hospital; it has to control a large sensor network with devices belonging to home building and healthcare profiles. The company installs a sensor network prototype for testing the application before the real deployment. Two developer teams, belonging to different departments, collaborate to this project. The prototype network is not reachable from all the ACME's buildings and not all the developers have got a USB ZigBee dongle. The company includes in the network prototype one ZigBee Gateway Device (ZGD) acting as ZigBee Router device and connected to the IP network. In this way the two teams can configure the ZigBee Base Driver to work with either a ZigBee USB Dongle or a Zigbee Gateway Device. One or more ZGDs will be deployed in the hospital network to provide remote assistance and maintenance. Every ZGD is associated to a different ZigBee network. 4.4 ZigBee Gateway with IP networks Several Home Automation applications are composed of an application that is deployed in the Cloud and that communicate with ZigBee devices through a gateway. This gateway acts as a simple bridge between the Home ZigBee network and an IP network protocol, e.g., Web Services, RESTful protocols, UPnP. 4.5 Network Refreshment The ACME developers team provides remote assistance for end user terminal equipments based on the OSGi platform. A user experiences problems with some ZigBee devices which are not recognised, or properly discovered by the terminal. For instance, a ZigBee device working on batteries dies because of running out of electricity. In such a case there is an inconsistency between the state the OSGi platform has and actual one. The remote operator connects to the terminal, by means of a software agent interfaced with the ZigBee Base Driver API, forces the re-execution of a network scan and discovery of the available devices. 5 Requirements R1: The solution MUST provide an API for data transmission supported by APSDE-SAP. R2: The solution MUST provide a base driver interface as an OSGi service for management operations supported by ZDO: device and service discovery, security management, network

10 RFP 142- ZigBee API Page 10 of 12 management, binding management, node management and group management R3: The solution should enable applications to trigger a re-scan of the network to refresh the registry with actual ZigBee device services. R4: The solution MUST provide API for switching the type of the local ZigBee device among ZC, ZR and ZED. R5: The solution MUST provide a mechanism which notifies OSGi applications of events occurred in the ZigBee network and devices. R6: The solution MUST provide an installation capability of cluster libraries within OSGi service-oriented architecture. R7: The solution MUST register a Device Service object representing each found ZigBee device into Service Registry and unregister the Device Service object when the ZigBee device is unavailable. R8: The solution MAY define the driver provisioning process in accordance with the OSGi Device Access specification. R9: The solution MUST be independent from the interface used to control the ZigBee network. The solution MUST likewise work with network controllers based on ZigBee built-in chips, ZigBee USB dongles and high level protocols offered by ZigBee Gateway Devices compliant with the ZigBee Alliance specification. 6 Document Support 6.1 References [1]. Bradner, S., Key words for use in RFCs to Indicate Requirement Levels, RFC2119, March [2]. Software Requirements & Specifications. Michael Jackson. ISBN [3]. ZigBee Specification 2007, ZigBee Alliance, January [4]. ZigBee Cluster Library Specification, ZigBee Alliance, May 2008.

11 6.2 Author s Address Name Compan y Address Masayoshi Shimizu NEC Corporation Shimonumabe 1753, Nakahara-ku, Kawasaki, Kanagawa , Japan Voice m-shimizu@ij.jp.nec.com Name Compan y Address Takaaki Suzuki NEC Corporation Shimonumabe 1753, Nakahara-ku, Kawasaki, Kanagawa , Japan Voice suzuki-takaaki@bu.jp.nec.com Name Company Address Andre Bottaro France Telecom Orange 28 Chemin du Vieux Chêne, Meylan, France Voice andre.bottaro@orange.com Name Company Address Arnaud Rinquin France Telecom Orange 28 Chemin du Vieux Chêne, Meylan, France Voice arnaud.rinquin@orange.com

12 6.3 End of Document