339 lines
11 KiB
Plaintext
339 lines
11 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<meta name="keywords" content="JMRI help CBUS Connecting connection canusb4 network">
|
|
<title>JMRI Hardware Support - CBUS® - Tech Details</title>
|
|
<!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="Sidebar.shtml" -->
|
|
|
|
<div id="mainContent">
|
|
<h1>Hardware Support: CBUS - Connection Details</h1>
|
|
|
|
<ul class="snav">
|
|
<li>
|
|
<a href="#canid">CBUS CAN Network ID</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c1">CAN via MERG CAN-RS or CAN-USB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c2">CAN via MERG Network Interface</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c3">CAN via GridConnect adapter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c4">CAN via GridConnect Network Interface</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c5">CAN via Lawicell CANUSB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c6">CAN Simulation</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c7">Direct Serial Connection</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>This page describes technical details of JMRI's CBUS connection support.</p>
|
|
|
|
<h2>CAN Adapters</h2>
|
|
<img class="floatRight" src="images/connection/merg-system-connection-400x290.png" width=
|
|
"400" height="290" alt="JMRI MERG Connections">
|
|
<p>JMRI's general approach is to support as many hardware combinations as possible. By
|
|
supporting as many people and their hardware desires as possible, we can create a growing
|
|
community of developers, hence more code.<br>
|
|
As part of this, the JMRI CAN support is designed to use as many CAN adapter types as
|
|
possible.<br>
|
|
Not many PCs have a RS232 serial port now, however is still supported.</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<a href="#c1">CAN via MERG CAN-RS or CAN-USB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c2">CAN via MERG Network Interface</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c3">CAN via GridConnect adapter</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c4">CAN via GridConnect Network Interface</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c5">CAN via Lawicell CANUSB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c6">CAN Simulation</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#c7">Direct Serial Connection</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>Where USB interfaces are used, the Baud rate is irrelevant.</p>
|
|
|
|
<h2 id="canid">CBUS CAN Network ID</h2>
|
|
|
|
<p>All CBUS modules need a CAN ID, and JMRI is no exception.</p>
|
|
|
|
<p>Modules must not have a duplicate CAN ID</p>
|
|
|
|
<p>The CAN ID is separate to any NODE ID's used in CBUS Long Events.</p>
|
|
|
|
<p>Node numbers are for CBUS long events, CAN ID's are purely for the CAN protocol
|
|
transmission and are largely irrelevant in JMRI processing CBUS events.</p>
|
|
|
|
<p>Most MERG modules can do "enumeration" for CBUS, but some other adapters can't because of
|
|
their intrinsic latency. Their slow replies effectively make them invisible.<br>
|
|
Therefore Mike Bolton, one of the CBUS developers suggested that JMRI use a CAN ID of 126.</p>
|
|
|
|
<p>If you have multiple copies of JMRI attached to a MERG CBUS network, be sure to give these
|
|
unique CAN ID's.</p>
|
|
|
|
<h3 id="c1">CAN via MERG CAN-RS or CAN-USB</h3>
|
|
<img src="images/connection/merg-connection-canrs-canusb-350x250.jpg" width="350" height=
|
|
"250" alt="JMRI MERG Connection canrd canusb canusb4 adapter" class="floatRight">
|
|
<p>A CANUSB4 should not normally require special drivers to be installed, it should just
|
|
work.</p>
|
|
|
|
<p>If using a MacBook Pro running Mojave and are struggling with drivers for a CANUSB /
|
|
CANUSB2, the appropriate driver is available from FDTI for the UM245R, the VCP option.<br>
|
|
(Tip courtesy of John (G8GKU) via <a href=
|
|
"https://groups.io/g/jmriusers/topic/running_jmri_from_a_macbook/28888237?p=,,,50,0,0,0::recentpostdate%2Fsticky,,,50,2,0,28888237">
|
|
JMRI Users at Groups.io</a>)</p>
|
|
|
|
<p>Default setting shown on right hand side after the " : "</p>
|
|
|
|
<p>Serial Port - Select the serial or USB port that your CAN interface is plugged in to.</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Baud rate</p>
|
|
|
|
<ul>
|
|
<li>57,600 (default)</li>
|
|
|
|
<li>115,200</li>
|
|
|
|
<li>230,400</li>
|
|
|
|
<li>250,000</li>
|
|
|
|
<li>333,333</li>
|
|
|
|
<li>460,800</li>
|
|
</ul>
|
|
|
|
<p>CAN ID for JMRI : 126 ( selectable from 100-127 )</p>
|
|
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<p>Output Interval : 250 ms</p>
|
|
|
|
<h3 id="c2">CAN via MERG Network Interface</h3>
|
|
<img src="images/connection/merg-connection-network-interface-330x353.png" width="330"
|
|
height="353" alt="JMRI MERG Connection network interface" class="floatRight">
|
|
<p>Methods using this option include:</p>
|
|
|
|
<ul>
|
|
<li><a href="../../../package/jmri/jmrix/can/cbus/swing/hubpane/CbusHubPane.shtml">CBUS Hub Control</a></li>
|
|
<li>CANPiCAP - The canpi service has to be active to accept connections.</li>
|
|
<li>CANether</li>
|
|
<li><a href="https://github.com/phillipsnj/mergCbusServer">CBUS Server</a> ( Node.js )</li>
|
|
<li>CANGC1e</li>
|
|
</ul>
|
|
|
|
<p>IP Address/Host Name : (none) - enter an IP address for fully manual configuration.<br>
|
|
Optional hostname for ZeroConf / mDNS configuration does <strong>NOT</strong> currently work,
|
|
use IP or localhost.<br>
|
|
"localhost" can be used on most systems if the CAN server is running on the same machine.</p>
|
|
|
|
<p>TCP/UDP Port : 5550 - Port address setting of the TCP connection</p>
|
|
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>CAN ID for JMRI : 126 ( selectable from 100-127 )</p>
|
|
|
|
<p>Gateway : Pass All ( Filtering also selectable )</p>
|
|
|
|
<h3 id="c3">CAN via GridConnect adapter</h3>
|
|
<img src="images/connection/merg-connection-gridconnect-adapter-300x215.png" width="300"
|
|
height="215" alt="JMRI MERG GridConnect Adapter" class="floatRight">
|
|
<p>Serial Port - Select the serial or USB port that your CAN interface is plugged in to.</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Baud Rate</p>
|
|
|
|
<ul>
|
|
<li>57,600 (default)</li>
|
|
|
|
<li>115,200</li>
|
|
|
|
<li>230,400</li>
|
|
|
|
<li>250,000</li>
|
|
|
|
<li>288,000</li>
|
|
|
|
<li>333,333</li>
|
|
|
|
<li>460,800</li>
|
|
</ul>
|
|
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<p>Output Interval : 250 ms</p>
|
|
|
|
<h3 id="c4">CAN via GridConnect Network Interface</h3>
|
|
<img src="images/connection/merg-connection-gridconnect-network-interface-300x267.png" width=
|
|
"300" height="267" alt="JMRI MERG GridConnect Network Interface" class="floatRight">
|
|
<p>IP Address / Host Name : (none) - enter an IP address for fully manual configuration.
|
|
Optional hostname for ZeroConf / mDNS configuration.</p>
|
|
|
|
<p>TCP / UDP Port : 0 - Port address setting of the TCP connection</p>
|
|
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Gateway : Pass All ( Filtering also selectable )</p>
|
|
|
|
<p>Output Interval : 250 ms</p>
|
|
|
|
<h3 id="c5">CAN via Lawicell CANUSB</h3>
|
|
<img src="images/connection/merg-connection-lawicell.png" width="294" height="211" alt=
|
|
"JMRI MERG Lawicell USB Connection" class="floatRight">
|
|
<p>Serial Port - Select the serial or USB port that your CAN interface is plugged in to.</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Baud Rate</p>
|
|
|
|
<ul>
|
|
<li>57,600 (default)</li>
|
|
|
|
<li>115,200</li>
|
|
|
|
<li>230,400</li>
|
|
|
|
<li>250,000</li>
|
|
|
|
<li>333,333</li>
|
|
|
|
<li>460,800</li>
|
|
|
|
<li>500,000</li>
|
|
</ul>
|
|
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<p>Output Interval : 250 ms</p>
|
|
|
|
<h3 id="c6">CAN Simulation</h3>
|
|
<img src="images/connection/merg-connection-simulation-330x215.png" width="330" height="215"
|
|
alt="JMRI MERG CAN Simulation Connection" class="floatRight">
|
|
<p>A simulated Command Station is started for this connection, see <a href=
|
|
"../../../package/jmri/jmrix/can/cbus/swing/simulator/SimulatorPane.shtml">CBUS Simulation
|
|
Tools</a>.</p>
|
|
|
|
<p>Defaults to CAN ID 120</p>
|
|
|
|
<p>Serial port : (none)</p>
|
|
|
|
<p>Connection Prefix : "M"</p>
|
|
|
|
<p>Connection Name : "MERG"</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Connection Protocol : "CBUS" (other options are "OpenLCB", "Raw CAN" and "Test - do not
|
|
use")</p>
|
|
|
|
<h3 id="c7">Direct Serial Connection</h3>
|
|
<img src="images/connection/merg-connection-direct-serial-330x288.png" width="330" height=
|
|
"288" alt="JMRI MERG Direct Serial Connection RfID" class="floatRight">
|
|
<p>Serial Port - Choose the serial or USB port that your CAN interface is plugged in to.</p>
|
|
|
|
<p>Concentrator range Select : "A-H" , unselectable in grayed out select box</p>
|
|
|
|
<p>Device Type Select : "MOD-RFID125", unselectable in grayed out select box</p>
|
|
|
|
<p>Adapter Select : Generic Stand-alone ( MERG Concentrator alternate option, choosing this
|
|
allows the Concentrator Range select, with an additional "I-P" option )</p>
|
|
|
|
<p>Protocol Select : CORE-ID<br>
|
|
Alternate option - Olimex, enables a device type of MOD-RFID1356MIFARE in the device type
|
|
dropdown.<br>
|
|
Alternate option - Parallax<br>
|
|
Alternate option - SeeedStudio<br>
|
|
Alternate option - EM-18</p>
|
|
|
|
<p>Connection Prefix : "F"</p>
|
|
|
|
<p>Connection Name : Rfid</p>
|
|
<em>Additional Connection Settings shown when box checked</em>
|
|
<p>Baud rate : automatic ( unselectable, grayed out select box )</p>
|
|
|
|
<p>Output Interval : 250 ms</p>
|
|
|
|
<h2>JMRI Help</h2>
|
|
|
|
<p><a href="index.shtml">Main JMRI CBUS Support page</a>
|
|
</p>
|
|
|
|
<p><a href="../index.shtml">JMRI's general CAN support</a>
|
|
</p>
|
|
|
|
<p><a href="../rfid/index.shtml">JMRI RFID Support</a>
|
|
</p>
|
|
|
|
<p><a href="index.shtml#thirdparty">CBUS 3rd Party Links</a> See link for the CBUS Developers
|
|
Guide</p>
|
|
|
|
<p>CBUS® is a registered trade mark of Dr Michael Bolton</p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|