61 lines
2.3 KiB
Plaintext
61 lines
2.3 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 Hardware Support - xAP</title><!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="../SidebarUp.shtml" -->
|
|
|
|
<div id="mainContent">
|
|
<h1>Hardware Support: xAP</h1>
|
|
|
|
<p>xAP is a popular home-automation protocol used by do-it-yourself hobbyists through large
|
|
professional installations.</p>
|
|
|
|
<p>xAP should not be confused with the Lenz XPA, which is a device for using a portable phone
|
|
as a throttle for a Lenz DCC system.</p>
|
|
|
|
<h2 id="connecting">Connecting</h2>
|
|
|
|
<h3>Software settings</h3>
|
|
|
|
<p>xAP devices that provide either the "input" or "output" form of the <a href=
|
|
"https://en.wikipedia.org/wiki/XAP_Home_Automation_protocol">Basic Status
|
|
and Control Schema</a> (BSC devices). "Input" devices are mapped to JMRI Sensor objects, and
|
|
"Output" devices are mapped to JMRI Turnouts.</p>
|
|
|
|
<p>When JMRI sees a new BSC device, it creates the necessary Sensor or Turnout. The full
|
|
source name is used to create the system name, for example:
|
|
<code>IS:xPA:xAPBSC:mi4.homeseer.scafell.91:VIOMBoard.Input14GJDRFXEnable</code> The
|
|
xPA-defined user defined name fills in the JMRI User Name, for example:</p>
|
|
|
|
<pre>
|
|
Input 14 GJD RFX Enable
|
|
</pre>You can later change the JMRI User Name to anything you'd like via the usual tables if
|
|
desired.
|
|
<h2 id="tools">JMRI Tools</h2>
|
|
|
|
<p>JMRI's support for xAP started with a simple <strong>xAPadapter.py</strong> script
|
|
available in JMRI 2.9.5 and later releases. Eventually, a full set of JMRI xAP tools will be
|
|
available directly within the JMRI tool set.</p>
|
|
|
|
<h2 id="documentation">Documentation</h2>
|
|
|
|
<h3>Third Party info</h3>
|
|
|
|
<p>For more information on the protocol and available equipment, please see the <a href=
|
|
"https://en.wikipedia.org/wiki/XAP_Home_Automation_protocol">xAP wikiPedia page</a>,
|
|
or the http://www.xapautomation.org xAP home page</p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|