Skip to content

Commit 390bfc5

Browse files
BlueAndiBlueAndi
committed
MDF template added, as well as the readme updated.
1 parent bf1a4d4 commit 390bfc5

File tree

2 files changed

+227
-4
lines changed

2 files changed

+227
-4
lines changed

‎README.md‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
1. [VSCP](https://github.com/BlueAndi/vscp-arduino#vscp)
77
2. [Library](https://github.com/BlueAndi/vscp-arduino#library)
88
3. [How to send a VSCP event?](https://github.com/BlueAndi/vscp-arduino#how-to-send-a-vscp-event)
9-
4. [Examples](https://github.com/BlueAndi/vscp-arduino#examples)
10-
5. [FAQ](https://github.com/BlueAndi/vscp-arduino#faq)
11-
6. [Issues, Ideas and bugs](https://github.com/BlueAndi/vscp-arduino#issues-ideas-and-bugs)
12-
7. [License](https://github.com/BlueAndi/vscp-arduino#license)
9+
4. [MDF](https://github.com/BlueAndi/vscp-arduino#mdf)
10+
5. [Decision Matrix](https://github.com/BlueAndi/vscp-arduino#decision-matrix)
11+
6. [Examples](https://github.com/BlueAndi/vscp-arduino#examples)
12+
7. [FAQ](https://github.com/BlueAndi/vscp-arduino#faq)
13+
8. [Issues, Ideas and bugs](https://github.com/BlueAndi/vscp-arduino#issues-ideas-and-bugs)
14+
9. [License](https://github.com/BlueAndi/vscp-arduino#license)
1315

1416
##VSCP
1517

@@ -57,6 +59,24 @@ txMsg.dataNum = 3;
5759
vscp.write(txMsg);
5860
```
5961

62+
##MDF
63+
64+
You will find a template for the module description file here: https://github.com/BlueAndi/vscp-arduino/mdf_template.xml
65+
How to use it, please take a look to the [VSCP specification](http://www.vscp.org/docs/vscpspec/doku.php?id=module_description_file).
66+
67+
##Decision Matrix
68+
69+
By default the decision matrix is enabled at page 1, offset 0 and provides about 10 rows.
70+
If you need more rows, please change them in the
71+
```
72+
vscp_config_overwrite.h
73+
```
74+
by defining
75+
```
76+
#define VSCP_CONFIG_DM_ROWS 20
77+
```
78+
with the number of rows at the end.
79+
6080
##Examples
6181

6282
###Generic

‎mdf_template.xml‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
3+
<!--
4+
5+
The MIT License (MIT)
6+
7+
Copyright (c) 2014 - 2015, Andreas Merkle
8+
http://www.blue-andi.de
9+
vscp@blue-andi.de
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy
12+
of this software and associated documentation files (the "Software"), to deal
13+
in the Software without restriction, including without limitation the rights
14+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15+
copies of the Software, and to permit persons to whom the Software is
16+
furnished to do so, subject to the following conditions:
17+
18+
The above copyright notice and this permission notice shall be included in all
19+
copies or substantial portions of the Software.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+
SOFTWARE.
28+
29+
********************************************************************************
30+
Module description file (MDF) template
31+
32+
********************************************************************************
33+
-->
34+
35+
<vscp xmlns="http://www.blue-andi.de/vscp/mdf/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blue-andi.de/vscp/mdf/1.0 mdf.xsd ">
36+
37+
<module>
38+
39+
<name>Arduino board</name>
40+
<model>A</model>
41+
<version>0.1.0</version>
42+
<changed>2015-11-16</changed>
43+
<description lang="en">The arduino board ...</description>
44+
<infourl></infourl>
45+
46+
<!-- Max package size a node can receive -->
47+
<buffersize>8</buffersize>
48+
49+
<!-- Manufacturer -->
50+
<manufacturer>
51+
<name>Peter Parker</name>
52+
<address>
53+
<street>Chrystie Street 187</street>
54+
<city>Manhattan</city>
55+
<postcode></postcode>
56+
<country>USA</country>
57+
</address>
58+
<telephone>
59+
<number>...</number>
60+
<description lang="en" >...</description>
61+
</telephone>
62+
<email>
63+
<address>.../address>
64+
<description lang="en">Support email</description>
65+
</email>
66+
<web>
67+
<address>http://</address>
68+
<description lang="en">Main web address</description>
69+
</web>
70+
</manufacturer>
71+
72+
<!-- Boot loader information -->
73+
<boot>
74+
<algorithm>255</algorithm>
75+
<blocksize>0</blocksize>
76+
<blockcount>0</blockcount>
77+
</boot>
78+
79+
<!-- Register space -->
80+
<registers>
81+
82+
<!-- ********** Page 0 ********** -->
83+
84+
<!-- ********** Page 1 ********** -->
85+
86+
<!-- Used by decision matrix (standard) -->
87+
88+
<!-- ********** Page 2 ********** -->
89+
90+
<!-- If enabled, used by decision matrix NG -->
91+
92+
</registers>
93+
94+
<abstractions>
95+
96+
<!-- ********** Page 0 ********** -->
97+
98+
<abstraction id="0" type="uint8_t" default="0" page="0" offset="0">
99+
100+
<!-- ********** Page 1 ********** -->
101+
102+
<!-- Used by decision matrix (standard) -->
103+
104+
<!-- ********** Page 2 ********** -->
105+
106+
<!-- If enabled, used by decision matrix NG -->
107+
108+
</abstractions>
109+
110+
<alarm>
111+
112+
<bit pos="7">
113+
<name lang="en">Not used</name>
114+
<description lang="en">Not used.</description>
115+
</bit>
116+
117+
<bit pos="6">
118+
<name lang="en">Not used</name>
119+
<description lang="en">Not used.</description>
120+
</bit>
121+
122+
<bit pos="5">
123+
<name lang="en">Not used</name>
124+
<description lang="en">Not used.</description>
125+
</bit>
126+
127+
<bit pos="4">
128+
<name lang="en">Not used</name>
129+
<description lang="en">Not used.</description>
130+
</bit>
131+
132+
<bit pos="3">
133+
<name lang="en">Not used</name>
134+
<description lang="en">Not used.</description>
135+
</bit>
136+
137+
<bit pos="2">
138+
<name lang="en">Not used</name>
139+
<description lang="en">Not used.</description>
140+
</bit>
141+
142+
<bit pos="1">
143+
<name lang="en">Not used</name>
144+
<description lang="en">Not used.</description>
145+
</bit>
146+
147+
<bit pos="0">
148+
<name lang="en">Not used</name>
149+
<description lang="en">Not used.</description>
150+
</bit>
151+
152+
</alarm>
153+
154+
<!-- Decison matrix -->
155+
<dmatrix>
156+
157+
<level>1</level>
158+
<start page="1" offset="0" indexed="false" />
159+
<rowcnt>10</rowcnt>
160+
161+
<action code="0x00">
162+
<name lang="en">No operation</name>
163+
<description lang="en">This action does nothing.</description>
164+
<param>
165+
<name></name>
166+
<description lang="en"></description>
167+
<data offset="1">
168+
<name></name>
169+
<description lang="en"></description>
170+
</data>
171+
</param>
172+
</action>
173+
174+
</dmatrix>
175+
176+
<events>
177+
178+
<event class="20" type="9">
179+
<name lang="en">Node heartbeat</name>
180+
<description lang="en">The node sends every second a heartbeat.</description>
181+
<priority>7</priority>
182+
<data offset="0">
183+
<name lang="en">Not used</name>
184+
<description lang="en">Not used</description>
185+
</data>
186+
<data offset="1" >
187+
<name lang="en">Zone</name>
188+
<description lang="en">Zone of the node.</description>
189+
</data>
190+
<data offset="2" >
191+
<name lang="en">Sub-zone</name>
192+
<description lang="en">Sub-zone of the node.</description>
193+
</data>
194+
</event>
195+
196+
</events>
197+
198+
<setup>
199+
</setup>
200+
201+
</module>
202+
203+
</vscp>

0 commit comments

Comments
 (0)