BiDiB Configuration

General

The BiDiB system works with Unique-IDs and local addressing (Path).
The local addressing can change after every startup of the system.
At startup Rocrail creates a mapping between local address and Unique-ID.


BiDiB Programming Dialog

Menu: Rocview → Programming → BiDiB


Index


All BiDiB hardware modules have an identify button. If this button has been pushed the this dialog will pop up.
After closing this dialog with the OK button the decimal UID number will be copied to the clip board to make it possible to paste this value into the Bus field(s).

Vendor

The left value is the hexadecimal and the middle value the decimal representation of the Vendor ID.

Product

The left value is the hexadecimal and the middle value the decimal representation of the Product ID.

Class

Classification of the node.

Username

User defined string for identifying this node.
This name can be used as alternative to the bus value. (UID-Name)
MSG_STRING_GET: STRING_ID = 1: Username, read/write

Set

Program the modified Username string.

Identifiant Unique

In Rocrail the decimal Unique-ID, or UID, must be set in the Bus field of the sensor or accessory interface tab.
This UID is long and the one to choose is not always an easy job.
The left value is the hexadecimal and the right value the decimal representation of the UID number.
The decimal representation is used as bus value for objects. (The decimal representation can and may be a negative number.)


Serial number

The printed board serial number should read V 0D P 67002900 in this example.

Class mnemonic

In the tree view every node is prefixed with its class mnemonic(s) between brackets.
Note: A node can provide more then one class.

Mnemonic Class Implementation(s)
L Link (Bridge) GBMBoost Master, OneHUB
O Occupancy GBM16T, S88-BiDiB
S Switch LightControl, MobaList
B Booster GBMBoost
M Command Station GBMBoost Master
A Accessory LightControl, MobaList
U User Interface External throttle
P Programming GBMBoost

Image

If an image is found with a file name formatted as “bidib-vid-pid.png” it will be shown on the index page.
For example: “bidib-13-103.png”
The image file size must be less then 50k in PNG format.

Report

The Reporting option requires a file name which must be specified by dialog. The file format is CSV and can be read and manipulated by most spreadsheet programs.
All listed modules are port by port reported. The RocrailID will be also reported if an object is linked to the uid:port:type.

Example

The CSV file imported and exported as PDF with LibreOffice.


Tree menu


Information

Opens the WEB site of the selected node. (In the default WEB Browser.)

Identify

Sends an Identify message to the selected node which will accomplish flashing the LED on the module.

Ping

Check if the selected node is still alive. A pong response will be listed in the controller pane. (Monitor trace level.)

Get last error

Get the last error from the selected node. An error report will be listed in the server pane. (Exception trace level.)

D&D

With Drag&Drop the UID can easily be set on all objects which have an interface Tab:


Features

Rocrail provide a basic implementation for reading and writing features.

Feature

Get

Reads all features of the selected node.
:!: This action is required to enable some other tabs in this dialog.

Set

Writes the selected feature with its new value; Check the documentation for writable features.

Vendor CV

Enable/Disable

Put the node in vendor CV mode.

Get/Set

Read or modify a vendor CV value.


Accessory


Read and write accessory options.
See: http://www.bidib.org/protokoll/bidib_control.html#T463

Switch Time

The 7 lower bits of the remaining term indicate the run until reaching the end-state of the requested switching action (predicted turnaround time.
The time will depend on the MSB in units of:

  • 1/10 Seconds (MSB = 0)
  • 1 Second (MSB = 1)


Port Setup


Type

The port type to be configured; Check the documentation.
Only some port types have configuration parameters:

Type L R V S
Servo Left adj. Right adj. Velocity -
Light brightness on brightness off dim on dim off
Backlight dim off dim on channel mapping -

Port Get

Read the actual configuration settings of the selected port and type.

Port Set

Write the actual configuration values to the selected port and type.

Test

Use ON/OFF to see if the configured port is behaving as wanted.

Sliders

After releasing the thumb of one of the sliders the values are send to the module.

Properties

The port properties can only be set for port type output and if the selected module supports port configuration like OneControl.

  • Timer: Used for I/O type pulse.


Macro


The Macro Tab is only available after a macro count feature has been read. → Features Get
See 4.6.9. Lokale Makros(DE) for more information about BiDiB Macros.

Apply line

Write the selected macro line to the BiDiB module. (A line must be selected before using this Apply button.)
The values are used from the controls under the grid; The grid will be updated.


Time

Format: Hours:Minutes-Weekday

Read/Write

Read/Write all the command lines of the selected Macro in the left pane.
If the module supports Macro Level 2 the extra parameters, (slowdown, cycles and start time), are also read/written.

Export/Import

Export/Import all macro lines incl. the Level 2 parameters to/from an XML file.

Export format
<macro uid="536871020" nr="1" slowdown="0" repeat="0" minutes="255" hours="255" wday="255">
  <macroline nr="1" delay="6" porttype="1" port="0" status="3"/>
  ...
  <macroline nr="18" delay="255" porttype="255" port="0" status="0"/>
</macro>


Save

Save the macro in nonvolatile storage.

Restore

Restore the macro from nonvolatile storage.
The “Read” button must be used to load the result.

Delete

Delete the macro. (Reset all macro lines to value of 255 for delay and port type.)
The “Read” button must be used to load the result.


Test

Activate the selected macro.


Firmware Update


The Rocrail server only starts a firmware update if the target node has the feature for updating over BiDiB set.

  • Tip: Read all features on the Features tab before trying to update.
  • Warning: Make sure the firmware update process is not canceled.
  • Tip: Read the documentation first before updating firmware; Do not update on any doubt.

File

The selected HEX file must be accessible by the server.

Preview

The first 50 lines of the selected file will be listed up.

Start

Starts the update process.
The button will be disabled and the text of the button changes to “Wait…” until a program event arrives from the server.
The progress bar range is set to the number of lines in the hex file. The server reports progress every 10th line processed.

Fichier produit

Un fichier produit BiDiB, bidib.xml, est située dans le Répertoire du Décodeur.
La feuille de style de montage est située dans le Répertoire XSL.
Ce fichier est utilisé pour montrer la description du produit et le site WEB.

Links

Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml-stylesheet type="text/xsl" href="bidib_products_en.xsl"?>
<bidib version="1.0" date="16-08-2013">
  <productlist>
    <product vid="13" pid="101" cid="146" desc="GBM16TC Stand-Alone" url="http://www.opendcc.de/s88/gbm_bidi/gbm_bidi_en.html">
      <description lang="de" text="GBM16TC Eigenständig" url="http://www.opendcc.de/s88/gbm_bidi/gbm_bidi_de.html"/>
      <description lang="nl" text="GBM16TC Zelfstandig" url="http://www.opendcc.de/s88/gbm_bidi/gbm_bidi_nl.html"/>
    </product>
  <productlist>
</bidib>
Attribute Wert Range
vid Vendor ID (NMRA) 0…255
pid Product ID 0…65535
cid Class ID 0…255
cidext Class ID extension (reserved) 0
desc Description (EN) *
url WEB Site URL of documentation. (EN) *

Description sub-nodes are optional and can be used to add a language dependent text and URL.


Links


Personal Tools