1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Introduction</title>
<link href="images+css/OpenZWave.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#FFFFFF">
<div class=Section1>
<div id="Main">
<table width="700" height="100" border=0 cellpadding=0 cellspacing=0>
<tr>
<td class=Heading1 width=250 valign=top><img src="images+css/image003.gif" alt=Logo width=134 height=55> </td>
<td class=Heading1 width=445 valign=top> Introduction </td>
</tr>
</table>
<table width="700" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><p class="Heading2"><strong>Purpose</strong></p>
<p class=BodyText>OpenZWave is a library which provides an API for applications to access and control a Z-Wave controller connected to the PC via a serial or HID connection.<br />
<br />
</p></td>
</tr>
</table>
<table width="700" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><p class="Heading2">Documentation</p>
<p class="BodyText">Although the project is still in too early a stage to produce user documentation, the source code for OpenZWave and OpenZWaveDotNet contains comments that can be converted into HTML documentation.</p>
<p class="BodyText">Instructions for how to generate this documentation, as well as other links to information that may be useful to developers using OpenZWave may be found here: <a href="general/Index.htm">OpenZWave Documents</a><br />
<br />
</p>
</td>
</tr>
</table>
<table width="700" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><p class="Heading2">Project Directory Structure</p></td>
</tr>
</table>
<table width="700" border=0 cellpadding=0 cellspacing=0>
<tr>
<td valign=top class="TableText"> </td>
<td valign=top class="TableText"> </td>
</tr>
<tr>
<td width=151 valign=top class="TableText">config</td>
<td width=432 valign=top class="TableText">XML files that provide device- and manufacturer-specific information, as well as the Z-Wave command class codes.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText">cpp</td>
<td width=432 valign=top class="TableText">The OpenZWave library project.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/build</td>
<td width=432 valign=top class="TableText">Makefiles and Visual Studio project/solution files for building the library under linux, Mac and Windows (VS2008 and VS2010).</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/examples</td>
<td width=432 valign=top class="TableText">A minimal console application (MinOZW) that can be built under linux, Mac and Windows. It is a useful example of how to start up the library and can be used to generate a log file (OZWlog.txt) to diagnose startup or other problems with the library and/or Z-Wave devices.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/hidapi</td>
<td width=432 valign=top class="TableText">Files related to implementation of a "Human Interface Device" (HID) connection between the PC and the Z-Wave controller. While many controllers use a serial interface, others (the ThinkStick, for example) use HID via USB.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/lib</td>
<td width=432 valign=top class="TableText">Essentially empty.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/src</td>
<td width=432 valign=top class="TableText">The source code for the OpenZWave Library. The top-level code is in this directory; subdirectories contain files to implement the command classes, the value classes and platform-specific code (linux, Mac and Windows).</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> cpp/tinyxml</td>
<td width=432 valign=top class="TableText">The TinyXML class code. TinyXML is used to read and write XML files for persistent storage.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText">documents</td>
<td width=432 valign=top class="TableText">Draft documentation for the library and example applications.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText">dotnet</td>
<td width=432 valign=top class="TableText">A .NET wrapper for the OpenZWave library.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> dotnet/build</td>
<td width=432 valign=top class="TableText">Project/Solution files for building OpenZWaveDotNet under VS2008 and VS2010.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> dotnet/examples</td>
<td width=432 valign=top class="TableText">Code for OZWForm, a .NET application that demonstrates use of OpenZWaveDotNet to connect to a controller, read information about nodes, process notifications, etc.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText"> dotnet/src</td>
<td width=432 valign=top class="TableText">The OpenZWaveDotNet wrapper code.</td>
</tr>
<tr>
<td width=151 valign=top class="TableText">license</td>
<td width=432 valign=top class="TableText">License documents.</td>
</tr>
</table>
</div><!--Main -->
<div id="Footer" class="FooterText"><br />
<br />
DRAFT Last updated 2011/02/17
</div><!--footer -->
</div>
</body>
</html>
|
