DEVBEE Kit de développement Zig Bee TM

hoggrapeSecurity

Jun 20, 2012 (5 years and 1 month ago)

552 views


Ce document est la propriété exclusive de CLEODE SA.
Toute reproduction complète ou partielle doit faire l’objet d’un accord écrit de CLEODE SA.


S.A. au capital de 167 200 €
R.C.S. Saint Brieuc TGI 450 570 767
Siège social : 8 rue Bourseul 22300 Lannion France
Tel : +33 (0) 2 96 48 68 18 - Fax : +33 (0) 2 96 48 19 11




DEVBEE

Kit de développement ZigBee
TM



Manuel Utilisateur



Révision 7.0
Document : MU_DEVBEE_20080122_001_07_00
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 2 sur 18

GARANTIE

Le matériel fourni à l’acquéreur et/ou au destinataire est garanti par la société CLEODE
contre tout défaut de fonctionnement provenant d’un risque de conception et/ou de
fabrication, pendant une période de douze (12) mois après la livraison, à charge pour
l’acquéreur et/ou le destinataire de prouver lesdits défauts ou vices. Cette garantie est
appliquée conformément aux articles 1641 à 1648 du Code Civil et en respect de la garantie
légale. La garantie couvre le remplacement gratuit des appareils et des pièces affectés d’un
vice de conception ou d’un défaut de fabrication à l’exception des vices apparents du matériel
couverts par l’acquéreur et/ou le destinataire.

Pour pouvoir invoquer le bénéfice de la garantie, l’acheteur doit aviser la société CLEODE
par écrit et sans retard, des vices qu’il impute au matériel. Il doit donner à la société CLEODE
toute facilité pour procéder à la constatation de ces vices et pour y porter remède. Les
garanties de la société CLEODE sont strictement limitées au matériel fourni et ne doivent
avoir pour effet que le remplacement ou la réparation à ses frais, dans ses ateliers, de toutes
les pièces mises hors service par suite de défauts ou vices, la société CLEODE se réservant de
modifier les dispositifs en vue de satisfaire à ces garanties.

La garantie ne s’applique pas aux remplacements ni aux réparations qui résulteraient de
l’usure normale des appareils et machines, matériels et produits, de détériorations ou
accidents provenant de négligence, défaut de surveillance ou d’entretien, ou d’utilisation
défectueuse des appareils, machines, matériels et/ou produits.

Le service de maintenance est fourni par la société CLEODE avec tout le soin
raisonnablement possible en l’état de la technique.

Les échanges de pièces ou réparations faites au titre de la garantie ne peuvent pas avoir pour
effet d’en prolonger la durée. En aucun cas, l’immobilisation d’un appareil ne pourra donner
droit à une indemnité pour quelque cause que ce soit. Le vendeur est dégagé de toute
obligation relative à la garantie si des modifications sont apportées à la fourniture sans son
consentement exprès, ou si des pièces étrangères à sa fabrication ont été substituées à son insu
à des pièces d’origine. En cas de dommage imprévisible causé par le matériel vendu par le
vendeur, il est expressément convenu que le vendeur ne pourra être tenu au maximum qu’au
remboursement du prix perçu pour l’achat du matériel dans le cas où il serait détruit. En aucun
cas le vendeur ne pourra être tenu pour responsable du préjudice indirect ou éventuel. Le
vendeur se dégage de toute responsabilité et l’acheteur renonce à tout recours contre lui si un
accident ou des dommages directs ou indirects sont causés à l’acheteur, suite à un défaut, à un
mauvais usage, à un mauvais entretien ou à une usure normale du matériel vendu.

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 3 sur 18
SOMMAIRE

I. Introduction.....................................................................................................................................................8
I.1 Présentation de DEVBEE.........................................................................................................................8
I.2 Copyright..................................................................................................................................................8
II. Introduction au protocole ZigBee
TM
.........................................................................................................9
II.1 L’Alliance ZigBee
TM
et le protocole ZigBee
TM
...................................................................................9
II.2 Description succincte de la pile protocolaire ZigBee
TM
.....................................................................10
II.3 Sémantique liée au protocole ZigBee
TM
.............................................................................................12
II.4 Texas Instrument Z-Stack..................................................................................................................12
III. Présentation générale de DEVBEE.........................................................................................................13
III.1 Contenu..............................................................................................................................................13
III.2 Présentation du matériel.....................................................................................................................13
III.2.1 Architecture matérielle..................................................................................................................13
III.2.2 Clé UBEE......................................................................................................................................13
III.2.3 Prise de courant ZPLUG...............................................................................................................14
III.2.4 Télécommande ZRC.....................................................................................................................14
III.3 Présentation du logiciel......................................................................................................................15
III.3.1 Architecture Logicielle..................................................................................................................15
III.3.2 Serial API de Texas Instrument.....................................................................................................15
III.3.3 Librairie ZCL CLEODE................................................................................................................16
IV. Support Technique..................................................................................................................................17
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 4 sur 18
TABLE DES FIGURES
Figure 1 : Pile protocolaire ZigBee
TM
...................................................................................................................10
Figure 2 : Clé UBEE.............................................................................................................................................14
Figure 3 : ZPLUG.................................................................................................................................................14
Figure 4 : ZRC......................................................................................................................................................15
Figure 5 : Architecture logicielle..........................................................................................................................15
Figure 6 : Extrait du sommaire du Manuel Utilisateur de la librairie ZCL...........................................................16

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 5 sur 18
TABLEAU DES REVISIONS
Version
Auteur(s)
Description de la version
Date
0.1 CLEODE Version initiale
22/01/2008
1.0 CLEODE Version validée
24/01/2008
1.1 CLEODE - Modifications de l’API CLEODE
- Changements des exemples d’application
07/02/2008
2.0 CLEODE Validation du document
08/02/2008
2.1 CLEODE - Modification figure 3
- Modifications chapître IV.1 :
￿ Modification des types de message KVP en
MSG
￿ Modification pour supporter la ZCL
22/04/08
3.0 CLEODE Validation du document
23/04/08
3.1 CLEODE Intégration API ZCL Cleode
23/06/09
4.0 CLEODE Validation du document
23/06/09
5.0 CLEODE Validation du document
24/11/09
5.1 CLEODE Modification chapitre III.1
29/03/10
6.0 CLEODE Validation du document
29/03/10
6.1 CLEODE Modification chapitre III.3.3
30/08/11
7.0 CLEODE Validation du document
30/08/11

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 6 sur 18
GLOSSAIRE
AF Application Framework
API
Application Programming Interface
APL Application Layer
APS Application Support Sub-Layer
BSP
Board Support Package
EEPROM

Erasable Electrically Programable Read Only Memory
ESD Electrostatic Discharge
GHz GigaHertz
ID Identifier
IEEE Institute of Electrical and Electronic Entity
IHM Interface Homme Machine
KVP
Key Value Pair Service Type
LED Light Emitting Diode
LSB Less Signficant Bit
MAC
Medium Access Control
MHz MegaHertz
MSB Most Signficant Bit
MSG
Message Service Type
NWK Network
OEM Original Equipment Manufacturer
OS
Operating System
PC Personal Computer
PHY Physical Layer
PID
Product Identifier
SOAP Simple Object Access Protocol
SSP Security Services Provider
UART
Universal Asynchronous Receiver-Transmitter
USB Universal Serial Bus
VID Vendor Identifier
WSDL Web Service Data Langage
ZCL ZigBee Cluster Library
ZDO Zigbee Device Objects

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 7 sur 18
DOCUMENTS DE REFERENCE

Document
Description
[1]
Z-Stack Monitor and Test API.pdf
Description de l’API Texas Instrument
[2]
MU_UBEE_20090811_001_01_00
Manuel utilisateur de la clé UBEE
[3]
MU_ZRC_20090304_001_03_00
Manuel utilisateur de la Télécommande Zigbee
[4]
MU_ZPLUG_20071206_001_05_00
Manuel utilisateur de la prise de courant Zigbee
[5]
MU_LIBZCL_20091002_001_01_00
Manuel utilisateur de la librairie ZCL Cleode
[6]
ZigBee_Cluster_Library_Public
Specification ZigBee Cluster Library
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 8 sur 18
I. INTRODUCTION
I.1 PRESENTATION DE DEVBEE
Le Kit de développement ZigBee
TM
de CLEODE, appelé DEVBEE dans la suite du
document, est destiné aux développeurs et aux utilisateurs de réseau ZigBee
TM
.
Il a pour but la mise en œuvre et la prise en main rapide d’un réseau ZigBee
TM
sans
connaissance approfondie de la norme.
Il est constitué de deux parties :
• Une partie matérielle constituée d’un coordinateur et de 2 objets
• Une partie logicielle fournie sous la forme de fichiers binaires pour la librairie, ainsi
que de l’ensemble des fichiers « *.h » nécessaire à la compilation. Le Logiciel
CleoBee est fourni pour vous permettre de piloter sans programmation necessaire les
différents objets du Kit de développement.
Les photos du présent document sont non contractuelles.
I.2 COPYRIGHT
La marque CLEODE et le logo CLEODE sont la propriété de CLEODE SA, France. Ce
document fait aussi référence à des marques et noms de produits qui sont des marques
déposées de leurs propriétaires respectifs.
Copyright © 2007-2009 CLEODE SA. Tous droits réservés.
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 9 sur 18
II. INTRODUCTION AU PROTOCOLE ZIGBEE
TM

Cette introduction a pour but de donner les bases du protocole ZigBee
TM
pour permettre à
l’utilisateur de développer ses propres applications.
Elle présente :
1. L’Alliance ZigBee™ et le protocole ZigBee
TM
.
2. L’architecture du protocole ZigBee
TM
et le rôle des différentes couches logicielles de
la pile protocolaire.
3. La sémantique liée au protocole ZigBee
TM
.

L’ensemble des notions abordées ici sont définies dans les documents de spécifications
disponibles sur le site officiel de l’alliance ZigBee
TM
:
http://www.zigbee.org


II.1 L’ALLIANCE ZIGBEE
TM
ET LE PROTOCOLE ZIGBEE
TM


L’Alliance ZigBee™ est un groupement international d’entreprises dédié au développement
de solutions sans fil à usage domestique, commercial et industriel. Elle a annoncé le 27
septembre 2006 la finalisation et la mise à disposition immédiate auprès de ses membres de la
version avancée de ZigBee
TM
– seul standard mondial de communication sans fil autorisant le
développement d’équipements de contrôle et de surveillance faciles à mettre en œuvre,
rentables et à faible consommation d’énergie pour les bâtiments résidentiels, commerciaux et
industriels.
Cette nouvelle version devrait être proposée au grand public au premier trimestre 2007.
La version avancée de ZigBee
TM
utilise un réseau maillé pour communiquer sur les
fréquences 2,4 GHz (disponible dans le monde entier) et 868/915 MHz (dans certains pays).
Grâce à la technologie d’étalement de spectre et à un nombre optimal de canaux, les réseaux
ZigBee
TM
assurent une excellente immunité au bruit. Le protocole ZigBee
TM
a été conçu pour
prendre en charge plus de 65 000 équipements sur un seul et unique réseau, offrant aux
concepteurs une opportunité sans précédent d’automatiser les tâches et les opérations
manuelles et de commander les équipements à l’aide de solutions sans fil. La simplicité de
l’architecture et la facilité d’utilisation permettent à tous les usagers d’installer les produits et
d’administrer le réseau en un temps record.
Grâce à une technologie unique en son genre, un équipement ZigBee
TM
type à faible
consommation d’énergie fonctionne pendant des années avec des piles classiques sans avoir
besoin d’être raccordé au réseau électrique, d’où une praticité et une flexibilité hors pair.

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 10 sur 18

II.2 DESCRIPTION SUCCINCTE DE LA PILE PROTOCOLAIRE ZIGBEE
TM


La pile protocolaire ZigBee
TM
est constituée de 3 couches basses et d’1 couche haute (voir
Figure 1). Les 3 couches basses sont :
1. La couche ‘Physique’ (PHY) définie par le standard IEEE 802.15.4 qui définit les
caractéristiques de l’interface physique. Pour le protocole ZigBee
TM
, l’interface
physique est une interface radio à 2.4GHz ou 868MHz ou 915MHz.
2. La couche ‘Liaison’ (MAC) définie par le standard IEEE 802.15.4 et contenant
l’adresse MAC.
3. La couche ‘Réseau’ (NWK) qui permet de reconnaître automatiquement le réseau
ZigBee
TM
et de créer les connexions entre les objets ZigBee
TM
constituant le réseau et
le coordinateur du réseau.

La couche haute est :
1. La couche ‘Application’ (APL) définissant les profiles des objets ainsi que les
messages d’échange entre les objets et le coordinateur.


Figure 1 : Pile protocolaire ZigBee
TM


DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 11 sur 18
La couche ‘Application’ (APL) est elle-même constituée de 3 sous-couches :
a. La sous-couche ‘Application Support Sub-Layer’ (APS) qui supporte les
fonctions suivantes :
i. La définition de la trame des paquets de données échangées entre les
nœuds du réseau.
ii. Le démultiplexage des données entrantes et le routage vers l’‘endpoint’
(interface) de destination.
iii. La gestion de la sécurité de la couche ‘Application’.
iv. La maintenance des tables de routage et des redirections des messages
non adressés directement.
v. La communication des données et des commandes avec le bloc
fonctionnel SSP qui fournit le service ‘Sécurité’.
b. La sous-couche ‘Application Framework’ (AF) qui supporte les fonctions
suivantes :
i. La définition de la trame des paquets employant 2 formats de trames :
KVP et MSG.
ii. La fourniture de la sémantique pour ces 2 formats en termes de type et
format.
c. La sous-couche ‘ZigBee
TM
Device Objects’ (ZDO) qui assure les fonctions
suivantes :
i. Agit comme une application à travers l’‘endpoint’ 0, utilisant le service
message (MSG) de l’AF pour supporter diverses fonctions telles que la
découverte des systèmes et des services, la gestion du routage, de la
sécurité et du nœud.
ii. Fournit, par le biais du bloc fonctionnel ‘ZDO Management Plane’, les
renseignements de la couche ‘Application’ aux entités de gestion
fournies par les couches NWK et APS.

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 12 sur 18

II.3 SEMANTIQUE LIEE AU PROTOCOLE ZIGBEE
TM


Dans la suite du document, plusieurs termes liés au protocole ZigBee
TM
seront fréquemment
utilisés et apparaîtront notamment dans l’IHM. Ces termes ont les styles de police italique et
gras dans ce paragraphe.
Dans un réseau ZigBee
TM
défini par une adresse réseau, les objets radio sont appelés des
nœuds et possèdent chacun une adresse MAC unique ou adresse IEEE.
La gestion de chacun des nœuds (communication, échange de données, commandes, …) est
assurée par sa couche applicative de sa pile protocolaire ZigBee
TM
qui est constituée de
plusieurs entités appelées endpoints adressées par des numéros de port. Chaque nœud possède
donc ses propres endpoints.
Chaque endpoint contient un descripteur. Le descripteur décrit l’application située sur
l’endpoint et contient :
1. la structure de données utilisée par l’application,
2. le numéro de profil de l’application qui est normalisé par le protocole ZigBee
TM
(ex :
le profil ‘Home Lighting’ qui est un profil dédié à tous les objets radio de type
luminaire, alarme lumineuse, …),
3. le numéro de l’application,
4. la version de l’application,
5. les clusters qui sont des groupes d’attributs normalisés dédiés à un profil
d’application, ces clusters étant orientés IN ou OUT.
En d’autres termes, un nœud porte une ou plusieurs applications (embarquées dans les
interfaces endpoints) et chaque application est identifiée par un descripteur et un numéro
d’endpoint.
II.4 TEXAS INSTRUMENT Z-STACK

Tous les matériels ZigBee
TM
livrés dans le Kit sont basés sur les solutions microcontrôleur et
radio de Texas Instrument. Ce composant permet l’intégration d’une couche logicielle
ZigBee
TM
conforme à la norme, nommée ZStack.

Cette couche logicielle est donc programmée dans les matériels livrés dans le Kit.
L’ensemble de la ZStack (sources + documentation) est téléchargeable sur le site Texas
Instrument à l’adresse suivante :
http://focus.ti.com/docs/toolsw/folders/print/z-stack.html


DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 13 sur 18
III. PRESENTATION GENERALE DE DEVBEE
III.1 CONTENU

Le Kit comprend :
￿ 1 Clé UBEE
￿ 1 prise de courant 220V ZPLUG
￿ 1 télécommande ZRC
￿ 1 CD-ROM contenant les ressources logicielles et documentaires nécessaires (BSP) :
o 1 Manuel utilisateur du Kit
o L’API ZCL (binaire et *.h)
o Les exemples d’application (binaires et sources)
o Les manuels utilisateurs (UBEE, ZRC, ZPLUG, ZCL)
o 1 Driver Windows XP de la clé UBEE
o 1 logiciel CleoBee
TM
et sa documentation

III.2 PRESENTATION DU MATERIEL

III.2.1 Architecture matérielle
L’ensemble des matériels présents dans le kit sont programmés avec un firmware spécifique
CLEODE mais peuvent être reprogrammés, selon le besoin, avec les outils adéquats (se
référer au manuel utilisateur de chaque matériel).
III.2.2 Clé UBEE
Cette clé UBEE est le coordinateur du réseau ZigBee
TM
. Elle est livrée avec un firmware
permettant la supervision du réseau ZigBee
TM
sur un PC. Elle transmet l’ensemble des
événements nécessaires au fonctionnement des APIs logicielles livrées dans le kit.

DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 15 sur 18

Figure 4 : ZRC

III.3 PRESENTATION DU LOGICIEL
III.3.1 Architecture Logicielle
PC
Exemple
d’application 1
Librairie ZCL Cleode
UBEE
Serial API Texas
Stack Zigbee
USB
Exemple
d’application 2
ZigBee
ZigBee
ZPLUG
Stack Zigbee
Gestion E/S
ZRC
Stack Zigbee
Gestion E/S

Figure 5 : Architecture logicielle

La Figure 5 ci-dessus montre l’ensemble des parties logicielles mises en œuvre dans le kit.
Les parties logicielles intégrées dans les objets ZigBee
TM
(UBEE, ZRC et ZPLUG) ne sont
pas détaillées dans ce manuel.
III.3.2 Serial API de Texas Instrument
Une API de Texas Instrument est livrée sur la clé UBEE et permet de dialoguer par le bus
USB avec le coordinateur pour transmettre des ordres ou récupérer des événements sur le
réseau ZigBee
TM
. La clé UBEE étant vue comme un port de communication série, le
développeur peut développer son application directement au-dessus de l’API série de Texas
Instrument décrite dans le document [1].
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 16 sur 18
III.3.3 Librairie ZCL CLEODE
La librairie ZCL est une librairie dynamique écrite en C++. Elle est utilisable dans un
environnement multi-thread.
Elle fonctionne actuellement sous les systèmes d’exploitation suivants :
• Windows NT et plus
• Windows CE 6.0 et plus
• Linux 2.6.19 et plus
et fournit au développeur une API permettant de :
• Découvrir le réseau Zigbee
• Emettre des messages
• Recevoir des événements
• Interroger les nœuds présents sur le réseau
• Réaliser des liens (binding) entre les objets

Ci-dessous, un extrait du sommaire du manuel utilisateur de la librairie ZCL.
DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 17 sur 18
IV. SUPPORT TECHNIQUE

Les éléments matériels défectueux seront retournés dans les locaux de la société CLEODE
accompagnés de :
• une copie du bon de livraison
• une description du disfonctionnement observé et du contexte de son apparition

Le délai de maintenance moyen est de quatre (4) semaines à compter du retour en nos locaux.
La réparation est assurée par les fabricants des éléments matériels pour ne pas annuler la
garantie de l’élément.
Le numéro de série pourra vous être demandé par la société CLEODE pour identifier votre
matériel.
Remarque
: Une foire aux questions (FAQ) est consultable sur le site web
www.cleode.com
.


DEVBEE – Manuel Utilisateur

MU_DEVBEE_20080122_001_07_00 CLEODE Page 18 sur 18
Toute demande de support doit être adressée à l’adresse postale suivante ou par courrier
électronique à
support@cleode.com
:



CLEODE S.A.
Service Support et Maintenance

8, rue Bourseul
22300 Lannion
Tél : +33 (0) 2 96 48 68 18
Fax : +33 (0) 2 96 48 19 11

E-mail :
support@cleode.com

Web :
http://www.cleode.com