Serge NOEL
147 lines
5.5 KiB
Plaintext
147 lines
5.5 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<title>JMRI: Virtual Sound Decoder</title><!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
<!-- DecoderPro Styles -->
|
|
|
|
<style>
|
|
.dp-center {text-align: center;}
|
|
.dp-right {text-align: right;}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="Sidebar.shtml" -->
|
|
|
|
<div id="mainContent">
|
|
<h1>Virtual Sound Decoder</h1>
|
|
|
|
<div class="dp-right">
|
|
<p><a href="index.shtml">Back</a>
|
|
</p>
|
|
</div>
|
|
|
|
<hr>
|
|
|
|
<h4>VSD headless mode</h4>
|
|
|
|
<p><span id="product_desc">Since JMRI 4.15.2 you can run VSD in a so called "headless" mode,
|
|
i.e. running JMRI (and VSD) without a graphical user interface.<br>
|
|
VSD headless is tested to work with <a href=
|
|
"../../../package/jmri/jmrit/webThrottle/webThrottle.shtml">JMRI webThrottle</a>.</span></p>
|
|
|
|
<p>Please follow these setup steps for the "headless" mode:</p>
|
|
|
|
<ul>
|
|
<li>Consider the creation of a new JMRI Profile</li>
|
|
|
|
<li>Configure a throttle key for every one of the VSD files to start/stop the engine or
|
|
activate the "Auto Start Engine" option
|
|
<p>See <a href="VSDFileAndConfig.shtml#engine_startstop">the details</a>
|
|
how to do this configuration.<br>
|
|
Alternatively or additionally you can activate the VSD Preference option "Auto Start
|
|
Engine". Though, I recommend to use the "engine-startstop" option.<br>
|
|
The number of VSDecoders is limited to 8.</p>
|
|
</li>
|
|
|
|
<li>Create a Roster Entry for every one of the VSDecoders
|
|
<p>Launch PanelPro and navigate to <strong>Roster ⇒ Roster</strong>
|
|
to add the Roster Entries.</p>
|
|
</li>
|
|
|
|
<li>Create a Roster Group named <strong>VSD</strong> and assign every one of the Roster
|
|
Entries to the new Roster Group
|
|
<p>You can use <strong>Settings ⇒ Roster Group Table Association</strong> to achieve
|
|
this.</p>
|
|
|
|
<p>Then close the "Roster: All Entries" window to get back to PanelPro.</p>
|
|
</li>
|
|
|
|
<li>Save the path and the profile name of every one of the VSDecoders to their Roster
|
|
<p>Please check the path to the folder of your VSD files in VSDecoder Preferences, before
|
|
you start!</p>
|
|
|
|
<p>Navigate to <strong>Tools ⇒ Virtual Sound Decoder ⇒ VSDecoder
|
|
Manager</strong></p>
|
|
|
|
<ol>
|
|
<li>Add Decoder</li>
|
|
|
|
<li>Select a Roster Entry</li>
|
|
|
|
<li>Load a VSD File</li>
|
|
|
|
<li>Select the Profile</li>
|
|
|
|
<li>Click the "Save to Roster" button and confirm with "Yes"</li>
|
|
|
|
<li>Click the "OK" button</li>
|
|
</ol>
|
|
Repeat the above steps for every one of the VSDecoders (up to 8).
|
|
<p>It's recommended to check the path and the profile name and (as may be the case) label
|
|
the function key for Start/Stop.<br>
|
|
To do this navigate to <strong>Roster ⇒ Roster ⇒ select a Roster entry ⇒
|
|
click the "Labels & Media" button</strong>.<br>
|
|
Make your changes in the "Function Labels" tab and check the data in the "Roster Media"
|
|
tab.</p>
|
|
</li>
|
|
|
|
<li>Set the Actions at JMRI Start Up
|
|
<p>In PanelPro navigate to <strong>Edit ⇒ Preferences ⇒ Start Up</strong></p>
|
|
|
|
<p><strong>Add ⇒ Perform Action ⇒ select
|
|
"Start Virtual Sound Decoder Manager"</strong></p>
|
|
|
|
<p><em>Note:</em> Do not add the Action "Open JMRI System Console"!</p>
|
|
</li>
|
|
|
|
<li>Create a "JmriFacelessConfig3.properties" file
|
|
|
|
<pre>
|
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
|
|
<properties>
|
|
<comment>Active profile configuration (saved at Wed Jan 09 09:05:26 CET 2019)</comment>
|
|
<entry key="autoStart">true</entry>
|
|
<entry key="autoStartTimeout">10</entry>
|
|
<entry key="activeProfile">x.yyyyyyyy</entry>
|
|
</properties>
|
|
</pre>
|
|
<p>Replace the profile.id "x.yyyyyyyy" with the correct one (see
|
|
profile/profile.properties in your headless Profile).</p>
|
|
|
|
<p>Store the new file to your "Settings Location" (JMRI folder).</p>
|
|
</li>
|
|
|
|
<li>JMRI/VSD starting in headless mode
|
|
<p>The following was tested under Windows 10.</p>
|
|
|
|
<p>If you are using "Apache Ant" you can enter "ant jmrifaceless". To quit the headless
|
|
mode do Ctrl+C.</p>
|
|
|
|
<p>For Windows you can use "C:\Program Files (x86)\JMRI\LaunchJMRI.exe" /profile
|
|
x.yyyyyyyy apps.JmriFaceless.<br>
|
|
To end the headless mode I use a Jython script like ShutDownExample.py".<br>
|
|
Don't forget to include the script to your JMRI Preferences Start Up.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>For further explanations how to use web access please see
|
|
<a href="../../web/index.shtml">JMRI Web Access</a>.</p>
|
|
|
|
<div class="dp-right">
|
|
<p><a href="index.shtml">Back</a>
|
|
</p>
|
|
</div>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|