389 lines
20 KiB
HTML
389 lines
20 KiB
HTML
|
||
<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<meta name="generator" content="Adobe RoboHelp 9">
|
||
<title>DEV Files</title>
|
||
<!--[if lt IE 5.5000]><style type="text/css">@import "/wiki/skins/monobook/IE50Fixes.css";</style><![endif]-->
|
||
<!--[if IE 5.5000]><style type="text/css">@import "/wiki/skins/monobook/IE55Fixes.css";</style><![endif]-->
|
||
<!--[if IE 6]><style type="text/css">@import "/wiki/skins/monobook/IE60Fixes.css";</style><![endif]-->
|
||
<!--[if IE 7]><style type="text/css">@import "/wiki/skins/monobook/IE70Fixes.css?1";</style><![endif]-->
|
||
<!--[if lt IE 7]><script type="text/javascript" src="/wiki/skins/common/IEFixes.js"></script>
|
||
<meta http-equiv="imagetoolbar" content="no" /><![endif]-->
|
||
<!-- Head Scripts -->
|
||
<link rel="stylesheet" href="HtmlHelp.css" type="text/css">
|
||
|
||
<style title="hcp" type="text/css">
|
||
<!--
|
||
span.hcp1 { color:#0000ff;
|
||
font-weight:bold; }
|
||
span.hcp2 { font-weight:bold;
|
||
color:#008000; }
|
||
span.hcp3 { font-weight:normal;
|
||
color:#000000; }
|
||
span.hcp4 { font-weight:bold; }
|
||
span.hcp5 { color:#008000; }
|
||
img.hcp6 { border-width:2px;
|
||
border-style:solid;
|
||
margin-top:0px;
|
||
margin-bottom:0px;
|
||
margin-left:0px;
|
||
margin-right:0px; }
|
||
span.hcp7 { color:#0000ff; }
|
||
p.hcp8 { margin-left:80px; }
|
||
span.hcp9 { font-weight:normal; }
|
||
span.hcp10 { font-weight:normal;
|
||
color:#008000; }
|
||
p.hcp11 { margin-left:40px; }
|
||
p.hcp12 { margin-bottom:0;
|
||
margin-left:80px; }
|
||
-->
|
||
</style>
|
||
</head>
|
||
|
||
<body class="ns-0 ltr">
|
||
<div id="globalWrapper">
|
||
<div id="column-content">
|
||
<div id="content">
|
||
<h1 class="firstHeading">DEV Files</h1>
|
||
<div id="bodyContent">
|
||
<h2 id="siteSub">What is a dev?</h2>
|
||
<p>DEV files are a powerful way for end users to customize
|
||
their 'device' library in <a href="MAINIntroduction.htm">London
|
||
Architect</a>; they are the representations of devices
|
||
that are created when dragged out of the <a href="Hardware Tree.html">Hardware
|
||
Tree</a> onto the <a href="Design Windows.html">Main layout</a>.
|
||
Dev files are located in the <a href="Devices.html">'Devices</a>'
|
||
directory of the London Architect program folder. User
|
||
created dev files can be organized in user created directories
|
||
under this main Devices folder, for example ... London
|
||
Architect/Devices/My Devices/MyVideoServer.dev.</p>
|
||
<p>DEV files utilize the very powerful, yet easy to use,
|
||
XML programming language. If you open up one of the dev
|
||
files in the Devices directory you will see what the XML
|
||
looks like. You may already know how to write xml, in
|
||
which case the following descriptions of the syntax should
|
||
help you easily create your own device. If not, just look
|
||
on the web for some tutorials, it's fairly easy. Most
|
||
of the xml is pretty self explanatory, and you can simply
|
||
copy an existing file and alter it to suit your purposes.</p>
|
||
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
<h2>Description of the various elements included in
|
||
this dev file:</h2>
|
||
<p><span class="hcp1"><?xml
|
||
version="1.0"?>  </span>This is
|
||
a header telling editors about the file, which may
|
||
then provide correct formatting or context sensitive
|
||
colouring. It is optional, and not needed by London
|
||
Architect.</p>
|
||
<p> <span class="hcp1"><device>...<2E></device>
|
||
 </span>This starts and ends the device definition
|
||
script.</p>
|
||
<p> <span class="hcp1"><!--</span>
|
||
<span class="hcp2">text</span>
|
||
<span class="hcp1">-->
|
||
 </span>This is a remark statement. Where text
|
||
is any string or text, this text will be ignored.
|
||
This is useful in documenting Who, What, When, Where,
|
||
or Why.</p>
|
||
<p> <span class="hcp1"><name>
|
||
... </name>  </span>This is used to set
|
||
the name of your device.</p>
|
||
<p> <span class="hcp1"><description>
|
||
... </description>  </span><span class="hcp3">A description of what it is. (Reserved
|
||
for future use)</span></p>
|
||
<p><span class="hcp1"><manufacturer>
|
||
... </manufacturer>  </span>This tells
|
||
London Architect where to place the device in the
|
||
Device tree (in the Hardware pane) and in the right
|
||
click menu. Typical values would be BSS, Crown, JBL,
|
||
Soundcraft etc. General devices such as mic are in
|
||
'Other'. London Architect will add a new heading to
|
||
these menus based on the data you have entered here.
|
||
All additional devices with the same manufacturer
|
||
will be placed under the same heading.</p>
|
||
<p><span class="hcp1"><group>
|
||
... </group>  </span>This defines the folder
|
||
in the <a href="Hardware Tree.html#Devices">Hardware
|
||
Pane</a> for the DEV file to go into</p>
|
||
<p><span class="hcp1"><size
|
||
width="</span><span class="hcp2">######</span><span class="hcp1">"
|
||
height="</span><span class="hcp2">######</span><span class="hcp1">"/>
|
||
 </span>The size of the device. This is the size
|
||
it will be when created, and it cannot be re sized
|
||
any <span class="hcp4">smaller</span>.
|
||
Where "<span class="hcp5">######</span>"
|
||
is an integer defining the size in pixels.</p>
|
||
<p><span class="hcp1"><gui
|
||
order="</span><span class="hcp2">######</span><span class="hcp1">"
|
||
showname="</span><span class="hcp2">value</span><span class="hcp1">"
|
||
showtype="</span><span class="hcp2">value</span><span class="hcp1">"
|
||
resize="</span><span class="hcp2">value</span><span class="hcp1">"
|
||
icon="</span><span class="hcp2">name</span><span class="hcp1">"
|
||
/>  </span>General GUI related information.</p>
|
||
<ul type="disc">
|
||
<li class="p"><p><span class="hcp4">showname</span> :-
|
||
Where "<span class="hcp5">value</span>"
|
||
is true or false. If showname is "<span class="hcp5">true</span>"
|
||
then the name is drawn above the object.</p></li>
|
||
<li class="p"><p><span class="hcp4">showtype</span> :-
|
||
Where "<span class="hcp5">value</span>"
|
||
is true or false. If showtype is "<span class="hcp5">true</span>"
|
||
then the type is drawn above the object.</p></li>
|
||
<li class="p"><p><span class="hcp4">resize</span> :-
|
||
Where "<span class="hcp5">value</span>"
|
||
is true or false. If resize is "<span class="hcp5">true</span>"
|
||
the device can be resized.</p></li>
|
||
<li class="p"><p><span class="hcp4">icon</span> :-
|
||
Where "<span class="hcp5">name</span>"
|
||
is the name of the icon image to use. [e.g. micicon.bmp.]
|
||
Icons are used in the various trees and menus
|
||
within London Architect. See the chart below.</p></li>
|
||
<li class="p"><p><span class="hcp4">order</span> :-
|
||
Where "<span class="hcp5">######</span>"
|
||
is an integer value used to sort the devices in
|
||
the hardware tree view, and on the right click
|
||
New menu. The higher the value, the higher up
|
||
the view/list the device will be listed.</p></li>
|
||
</ul>
|
||
<h2>Icons</h2>
|
||
<p><img src="Icons_3.png" alt="Icons" title="Icons" width="149" height="505" border="2" class="hcp6"></p>
|
||
<p> <span class="hcp1"><br>
|
||
<background image="</span><span class="hcp2">File</span><span class="hcp1">"
|
||
fill="</span><span class="hcp2">value</span><span class="hcp1">"/>
|
||
 </span>This tells London Architect how to draw
|
||
the device.</p>
|
||
<ul type="disc">
|
||
<li><span class="hcp4">Image</span> :-If
|
||
image is defined it is the name of the image file
|
||
to use. [e.g. mic.bmp]</li>
|
||
</ul>
|
||
<ul type="disc">
|
||
<li><span class="hcp4">fill</span> :-
|
||
Where "<span class="hcp5">value</span>"
|
||
is true or false. If fill is "true"
|
||
then the background is filled with the fill colour.
|
||
If you set the image, then often you don't want
|
||
the background to be drawn. London Architect will
|
||
center your bmp in the object as defined in the
|
||
size statement above. For best results resize
|
||
your bitmap to the same size that you defined
|
||
for your object. The image file must reside in
|
||
the Generic directory with the dev file.</li>
|
||
</ul>
|
||
<p> <span class="hcp1"><br>
|
||
<fillcolour red="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
blue="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
/></span> <span class="hcp3">or</span>
|
||
<span class="hcp1"><fillcolor
|
||
red="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
blue="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
/></span> <span class="hcp4"> </span>Specifies
|
||
the fill colour for the background where "<span class="hcp5">###</span>" is a number
|
||
between 0 and 255.</p>
|
||
<p> <span class="hcp1"><br>
|
||
<textcolour red="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
blue="</span><span class="hcp5">###</span><span class="hcp7">"</span> <span class="hcp1">/></span> or <span class="hcp1"><textcolor red="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
blue="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
/>  </span>Specifies the text colour for the
|
||
node text where "<span class="hcp5">###</span>"
|
||
is a number between 0 and 255.</p>
|
||
<p> <span class="hcp1"><br>
|
||
<transparentcolour red="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp5">###</span><span class="hcp1">"
|
||
blue=</span><span class="hcp7">"</span><span class="hcp5">###</span><span class="hcp7">"</span>
|
||
<span class="hcp1">/></span>
|
||
or <span class="hcp1"><transparentcolor
|
||
red="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
green="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
blue="</span><span class="hcp2">###</span><span class="hcp1">"
|
||
/>  </span>Specifies the colour which is to
|
||
be considered transparent when drawing the background
|
||
image where "<span class="hcp5">###</span>"
|
||
is a number between 0 and 255.</p>
|
||
<p> <span class="hcp7"><span class="hcp4"><br>
|
||
<input name="</span><span class="hcp5">Text</span><span class="hcp7">" type="</span><span class="hcp5">value</span><span class="hcp7">"
|
||
visible="</span> <span class="hcp5">value</span>
|
||
<span class="hcp7">"/></span></span></p>
|
||
<p><span class="hcp1"><output
|
||
name="</span><span class="hcp2">Text</span><span class="hcp1">"
|
||
type="</span><span class="hcp2">value</span><span class="hcp1">"
|
||
visible="</span> <span class="hcp2">value</span>
|
||
<span class="hcp1">"
|
||
signalfrom="</span><span class="hcp2">inputnode</span><span class="hcp1">"
|
||
format="</span> <span class="hcp2">value</span><span class="hcp1">"/>
|
||
 </span>Specifies an input or output node. Input
|
||
nodes are displayed on the left, Output nodes are
|
||
displayed on the right.</p>
|
||
<ul type="disc">
|
||
<li class="p"><p><span class="hcp4">name</span> :-
|
||
Where "<span class="hcp5">Text</span>"
|
||
is the name of the node. If not defined, the node
|
||
text is not drawn. [E.g. <span class="hcp4">name</span>=""].
|
||
This is useful for really basic objects such as
|
||
mics where you really don't want the node text
|
||
drawn.</p></li>
|
||
<li class="p"><p><span class="hcp4">type</span> :-
|
||
Where "<span class="hcp5">value</span>"
|
||
can be one of the following :-</p></li>
|
||
</ul>
|
||
<p class="hcp8"><span class="hcp4">audio</span>
|
||
:- Your basic audio node.</p>
|
||
<p class="hcp8"><span class="hcp4">digital</span>
|
||
:- A digital node.</p>
|
||
<p class="hcp8"><span class="hcp4">audio+digital</span>
|
||
:- A node that can take either analogue or digital.</p>
|
||
<p class="hcp8"><span class="hcp4">ethernet</span>
|
||
:- A generic ethernet port.</p>
|
||
<p class="hcp8"><span class="hcp4">cobranet1</span>
|
||
:- A cobraNet port.</p>
|
||
<p class="hcp8"><span class="hcp4">cobranet2</span>
|
||
:- A backup cobraNet port.</p>
|
||
<p class="hcp8"><span class="hcp4">serial</span>
|
||
:- A serial port.</p>
|
||
<p class="hcp8"><span class="hcp4">control</span>
|
||
:- A control port.</p>
|
||
<p class="hcp8"><span class="hcp4">highpower</span>
|
||
:- A high power analogue port. E.g. amp output/speaker
|
||
input.</p>
|
||
<p class="hcp8"><span class="hcp4">video</span>
|
||
:- A composite video port</p>
|
||
<p class="hcp8"><span class="hcp4">usb</span>
|
||
:- A usb port</p>
|
||
<p style="font-weight: bold; margin-left: 80px;">buddylink
|
||
<span class="hcp9">:- CobraNet buddylink
|
||
node.</span></p>
|
||
<p class="hcp8"><span class="hcp4">blulink</span>
|
||
:- BLU link ethernet port.</p>
|
||
<p class="hcp8"><span class="hcp4">blulink+ethernet</span>
|
||
:- BLU link and standard ethernet port.</p>
|
||
<p class="hcp8"><span class="hcp4">fibre</span>
|
||
:- Fibre optic port.</p>
|
||
<ul type="disc">
|
||
<li class="p" style="margin-left: -20px;"><p style="margin-left: 0px;
|
||
font-weight: bold;">visible <span class="hcp9">:-
|
||
Where "</span><span class="hcp10">value</span><span class="hcp9">" is true or
|
||
false.  If visible is "</span><span class="hcp10">true</span><span class="hcp9">" then the node
|
||
is visible on the object.</span></p></li>
|
||
<li style="margin-left: -20px;"><span class="hcp4">signalfrom</span> :-
|
||
Where "<span class="hcp5">inputnode</span>"
|
||
is the name of the name of the input node that
|
||
the signal comes from. This is used to provide
|
||
signal routing through the device. If <span class="hcp4">signalfrom</span>
|
||
is not specified, the name of the node is shown.
|
||
This is used on outputs only.</li>
|
||
<li style="list-style: none;"> </li>
|
||
</ul>
|
||
</div>
|
||
<h2>Illegal Characters in a DEV file</h2>
|
||
<p>There are four characters which are illegal in DEV files
|
||
and so must be replaced with a special sequence if you
|
||
wish to use them.  These are as follows:</p>
|
||
<p><span class="hcp4">&</span> replace
|
||
with <span class="hcp4">&amp;</span></p>
|
||
<p><span class="hcp4"><</span> replace
|
||
with <span class="hcp4">&lt;</span></p>
|
||
<p><span class="hcp4">></span> replace
|
||
with <span class="hcp4">&gt;</span></p>
|
||
<p><span class="hcp4">"</span> replace
|
||
with <span class="hcp4">&quot;</span></p>
|
||
<h2>Sample DEV file</h2>
|
||
<p>Now let's take a closer look at a sample script.</p>
|
||
<p><span class="hcp4"><?xml version="1.0"?></span></p>
|
||
<p><span class="hcp4"><device></span></p>
|
||
<dl>
|
||
<dd class="mvd-P"><span class="hcp4"><name>My
|
||
Video Server</name></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><description>Composite
|
||
Video Server</description></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><manufacturer>ACME</manufacturer></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><group>Other</group></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><size
|
||
width="110" height="80"/></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><gui
|
||
icon="ethernet" showname="true"
|
||
showtype="true" resize="false"/></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><textcolour
|
||
red="255" green="255" blue="255"/></span></dd>
|
||
</dl>
|
||
<p> </p>
|
||
<dl>
|
||
<dd class="mvd-P"><span class="hcp4"><!--
|
||
Ports--></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><output
|
||
name="Audio L" type="audio"/></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><output
|
||
name="Audio R" type="audio"/></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><output
|
||
name="Video" type="video"/></span></dd>
|
||
<dd class="mvd-P"><span class="hcp4"><input
|
||
name="Ethernet" type="ethernet"/></span></dd>
|
||
</dl>
|
||
<p><span class="hcp4"></device></span></p>
|
||
<p> <span class="hcp1"><br>
|
||
<?xml version="1.0"?>  </span>The
|
||
first line is the header.</p>
|
||
<p><span class="hcp1"><device>
|
||
 </span>This line defines the beginning of the device
|
||
script</p>
|
||
<p style="font-weight: bold; color: #0000ff; margin-left: 40px;"><name>My
|
||
Video Server</name> <span class="hcp3">This
|
||
is the name of your device.</span></p>
|
||
<p class="hcp11"><<span class="hcp1">description>Composite
|
||
Video Server</description>  </span>This is
|
||
the description of the device.</p>
|
||
<p class="hcp11"><span class="hcp1"><manufacturer>ACME</manufacturer>
|
||
 </span>This is the Manufacturer of the device.</p>
|
||
<p class="hcp11"><span class="hcp1"><group>Other</group>
|
||
 </span>This defines what group this object is part
|
||
of.</p>
|
||
<p class="hcp11"><span class="hcp1"><size
|
||
width="110" height="80"/>  </span>This
|
||
defines the size of the graphic object.</p>
|
||
<p class="hcp11"><span class="hcp1"><gui
|
||
icon="ethernet" showname="true" showtype="true"
|
||
resize="false"/>  </span>This defines
|
||
the icon that London Architect will use in the menu trees,
|
||
as well as how the graphic object will be displayed on
|
||
the desktop.</p>
|
||
<p class="hcp11"><span class="hcp1"><textcolour
|
||
red="255" green="255" blue="255"/>
|
||
 </span>This defines the color of the node text on
|
||
the graphic object.</p>
|
||
<p class="hcp11"><span class="hcp1"><!--
|
||
Ports-->  </span>This is a remark statement used
|
||
to describe the following section of code.</p>
|
||
<p class="hcp12"><span class="hcp7"><span class="hcp4"><output name="Audio
|
||
L" type="audio"/></span></span></p>
|
||
<p class="hcp12"><span class="hcp7"><span class="hcp4"><output name="Audio
|
||
L" type="audio"/></span></span></p>
|
||
<p class="hcp12"><span class="hcp7"><span class="hcp4"><output name="Video"
|
||
type="video"/></span></span></p>
|
||
<p class="hcp8"><span class="hcp1"><input
|
||
name="Ethernet" type="ethernet"/>
|
||
 </span>These define all the ports on the device.</p>
|
||
<p><span class="hcp1"></device>
|
||
 </span>This ends the device script.</p>
|
||
<p> <br>
|
||
And here is how it looks on the desktop:</p>
|
||
<p><img src="DEV_Script.jpg" alt="Video Server" title="Video Server" width="210" height="179" border="2" class="hcp6"></p>
|
||
</div>
|
||
<p style="margin-bottom: 0;"> </p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|