User Tools

Site Tools


bidib:bidib-config-en

Differences

This shows you the differences between two versions of the page.


bidib:bidib-config-en [2023/12/19 07:37] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== BiDiB Configuration ======
 +[[:english#command_stations|{{  :interface.png}}]][[:english|{{  :rocrail-logo-35.png}}]][[http://www.bidib.org/|{{ http://www.bidib.org/pics/bidib_logo.png?100|BiDiB, ein universelles Steuerprotokoll für Modellbahnen}}]]
 +[[:english|Content]] -> [[:english#command_stations|Command Stations]] ->  **[[:bidib-en|BiDiB]]** 
 +  * **[[:bidib:bidib-config-en|Configuration]]** | [[:bidib-examples-en|Setup examples]] | [[:bidib-usb-en|USB Mapping]]
  
 + \\
 +
 +| This is a simple dialog for doing simple configuration jobs. \\ For more sophisticated programming the __**[[https://forum.opendcc.de/wiki/doku.php?id=wizard|BiDiB Wizard]]**__ is recommended. | \\
 + \\
 +===== 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**\\
 +
 + \\
 +<html><a name="index"/></html>
 +===== Index =====
 +{{:bidib:bidib-index-en.png}}\\
 +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).\\
 + \\
 +| The GMB16T has also a button, but this is not implemented as an identify button because its not connected to the BiDiB bus. \\ Pushing this button will set the GBM16T in test mode and will post continuously occupancy messages.  |
 +
 + \\
 +
 +====Vendor====
 +The left value is the hexadecimal and the middle value the decimal representation of the **[[http://www.bidib.org/support/product_id.html|Vendor ID]]**.\\
 +====Product====
 +The left value is the hexadecimal and the middle value the decimal representation of the **[[http://www.bidib.org/support/product_id.html|Product ID]]**.\\
 +
 +====Class====
 +Classification of the node.\\
 +
 +====Username====
 +|< >|
 +| __In Rocrail this is the UID-Name value.__ This field is case sensitive! |
 +User defined string for identifying this node.\\
 +This name can be used as alternative to the bus value. (**[[:switch-int-en#uid-name|UID-Name]]**)\\
 +//MSG_STRING_GET: STRING_ID = 1: Username, read/write//\\
 +===Set===
 +Program the modified Username string.\\
 +
 +====UniqueID (Node-ID)====
 +|< >|
 +| __In Rocrail this is the Node-ID value.__ |
 +In Rocrail the decimal __**[[http://www.bidib.org/protokoll/bidib_general.html#T33|Unique-ID]]**__, must be set in the **Bus field** of the sensor or accessory interface tab.\\
 +This UniqueID(Bus) 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 UniqueID(Bus) number.\\
 +{{ :bidib:negative-uid.png}}
 +__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) | [[http://opendcc.de/elektronik/gbmboost/gbmboost.html|GBMBoost Master]], [[http://www.opendcc.de/elektronik/bidibone/onehub.html|OneHUB]] |
 +| **O** | Occupancy | [[http://opendcc.de/s88/gbm_bidi/gbm_bidi.html|GBM16T]], [[http://opendcc.de/s88/s88_bidib/s88_bidib.html|S88-BiDiB]] |
 +| **S** | Switch | [[http://opendcc.de/elektronik/lightcontrol1/lightcontrol.html|LightControl]], [[http://opendcc.de/elektronik/lightcontrol1/mobalist.html|MobaList]] |
 +| **B**| Booster | [[http://opendcc.de/elektronik/gbmboost/gbmboost.html|GBMBoost]] |
 +| **M**| Command Station | [[http://opendcc.de/elektronik/gbmboost/gbmboost.html|GBMBoost Master]] |
 +| **A**| Accessory | [[http://opendcc.de/elektronik/lightcontrol1/lightcontrol.html|LightControl]], [[http://opendcc.de/elektronik/lightcontrol1/mobalist.html|MobaList]] |
 +| **U**| User Interface | External throttle |
 +| **P**| Programming | [[http://opendcc.de/elektronik/gbmboost/gbmboost.html|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"\\
 +**[[:rocrailini-gen-en#image_path|The image file size must be less then 50k]]** in [[http://en.wikipedia.org/wiki/Portable_Network_Graphics|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 **[[http://www.libreoffice.org|LibreOffice]]**. |
 +| {{:bidib:bidib-report-libreoffice.png}} |\\
 + \\
 +
 +
 +====Tree menu====
 +{{:bidib:bidibnode-tree-menu.png}}\\
 +===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 Unique-ID can easily be set on all objects which have an interface Tab:\\
 +{{:bidib:bidib-dd-en.png}}\\
 + \\
 +
 +<html><a name="features"/></html>
 +===== Features =====
 +Rocrail provide a basic implementation for reading and writing __**[[http://www.bidib.org/protokoll/bidib_general.html#T42|features]]**__.\\
 +{{:bidib:bidib-features-en.png}}\\
 +
 +====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.\\
 +
 +===Special Features===
 +==DCC Watchdog==
 +Use this GBMBoost-Master option with care and use a high interval time like 20. (20 x 100ms = 2 seconds)\\
 +Set this value to zero to disable this feature.\\
 +| A value of 1 will send every 80ms a message to the GBMBoost-Master. |
 +
 + \\
 +
 +<html><a name="portsetup"/></html>
 +=====Port Setup=====
 +{{:bidib:bidib-portconfig-en.png}}\\
 +
 +====Type====
 +The port type to be configured; __**[[http://www.bidib.org/protokoll/bidib_control.html#T463|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 |  -  |\\
 +
 +====Number====
 +BiDiB Ports are zero offset based.\\
 +
 +====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.
 + \\
 +<html><a name="macro"/></html>
 +
 + \\
 +
 +=====Links=====
 +  * http://www.bidib.org/protokoll/bidib_fw_update.html
 +  * http://www.opendcc.de/elektronik/lightcontrol1/lightcontrol.html
 +  * [[http://freeware.the-meiers.org|CoolTerm]]