Differences

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

@@ Line 1: / Line 1: @@
+====== CANBUS FLiM Node Setup ======
+[[:english#command_stations|{{  :interface.png}}]][[:english|{{  :rocrail-logo-35.png}}]]
+[[:english|Content]] -> [[:english#command_stations|Command Stations]] ->  **[[:cbus-en|CANBUS]]**
+  * **[[:cbus:flim-en|FLiM Node Setup]]**
+ \\
+ \\
+===== Introduction =====
+For the CANBUS two models were developed for the setting of the module interfaces:
+=== SLiM  ===
+**S**imple **L**ayout **i**nterface **M**odel.\\
+The node address of the module is set using DIP switches. Additional settings are not possible.\\
+**The CAN-GCA modules do not support this !!**.\\
+=== FLiM  ===
+**F**ull **L**ayout **i**nterface **M**odel.\\
+All settings of the modules made with programming commands over the CANBUS. \\
+In Rocrail the CANBUS programming dialog is implemented on multiple tabs for general and modules-specific properties. \\
+ \\
+==== Features ====
+  * The node configuration is saved in the Rocrail server setup; rocrail.ini.
+  * After setting a node in FLiM setup this dialog will pop up automatically with the node number tab selected.
+  * Node type recognition.
+  * Bit pattern help for node and event variables.
+  * All read nodes, variables and events are saved in the rocrail.ini after closing the dialog with the **OK** button.
+ \\
+=====The push button=====
+The push button is __only needed__ in case the __node number__ has to be __changed__.\\
+In all other cases Rocrail will put the module in learn mode by command when needed.\\
+ \\
+<html><a name="nodenumber"/></html>
+===== Node number =====
+{{:cbus:cbus-nodesetup-node.png}}\\
+====IID====
+The IID is needed, if the CANBUS, is not the only defined command station in the Rocrail server.\\
+====Type====
+This is a read only field which is automatically set after a node is selected from the index or was set in the FLiM setup mode.\\
+====Number/Set====
+The target node must be set manually in learn mode, after its powered on, by pushing short the button on the board before setting a new node number.\\
+If there are nodes in the same CANBUS in SLiM mode it is recommended to choose a node number higher than 255 to avoid conflicts. All CAN-GCA nodes are FLiM only.\\
+ \\
+<html><a name="index"/></html>
+===== Index =====
+{{:cbus:cbus-nodesetup-index.png}}\\
+A double click selects the related Tab for the module and will activate the "**Get all**" command.\\
+====Interface ID====
+The IID must be set if the CBUS is not the first one in the **[[:rocrailini-controller-en|Rocrail command stations]]** list.\\
+==== Query ====
+Query all connected nodes.\\
+The query CANBUS OPC_QNN is used. The CAN-GC2 reports with an OPC_PNN which contains node number, manufacturer and product ID.\\
+> **Tip:** Single node read/write: enter the node number in the 'Node' tab, change the tab (e.g. GC2) and select 'Get all' to read the node.
+ \\
+==== Report ====
+| Use only with the __**[[:can-gca1-en|CAN-GC1]]**__. |
+Before reporting the Query button must have been pressed to fill up the list.\\
+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 CAN-GC2 and CAN-GC6 modules are subsequently selected, read and port by port reported. The ID will be also reported if a Rocrail object is linked to the port address.\\
+===Example===
+| The CSV file imported and exported as PDF with **[[http://www.libreoffice.org|LibreOffice]]**. |
+| {{:cbus:cbus-report-libreoffice.png}} |\\
+ \\
+=====CAN-ID=====
+__To avoid bus conflicts, each node requires a unique CAN-ID.__\\
+A node should ensure that the CAN-ID is in the range of 1 to 99. CAN-ID values in the range 100 to 127 have been reserved for modules with a fixed CAN-ID.\\
+CAN-ID 0 + 11 are reserved for the interface like CANGC1(e).\\
+| //A standard CAN frame has 11 bits for the CAN-ID. CBUS uses the 4 MSB for priority(arbitration), the rest 7 bits are used for the ID. \\ Extended CAN frames are reserved for the Bootloader.// |
+{{:cbus:can-extframe.jpeg?400}}\\
+ \\
+<html><a name="variables"/></html>
+===== Variables =====
+{{:cbus:cbus-nodesetup-vars.png}}\\
+Some nodes have variables for setup the behaviour of I/O or other features.\\
+Check the node documentation which variable(s) are available.\\
+ \\
+<html><a name="events"/></html>
+===== Events =====
+{{:cbus:cbus-nodesetup-events.png}}\\
+The node must be in **learning** mode before the editting of events is possible with exception of the **Get all** request.\\
+==== Get all ====
+Request all node events. An event definition is added to the list if its unknown.\\
+==== Add ====
+Leave the **Node#** empty for defining a __Short Event__. \\
+==== Delete ====
+Delete the selected event from the node and from the list.\\
+==== Clear all ====
+Delete all the event from the node and from the list.\\
+==== Variable/Get ====
+The event variable must be requested separately for each event listed after a **Get all** request and is __only possible in learn mode__.\\
+ \\
+<html><a name="firmware"/></html>
+===== Firmware =====
+{{:cbus:cbus-nodesetup-firmware.png}}\\
+  * {{:cbus:cbus-bootloader.pdf}}
+  * {{:cbus:bootloader.pdf}}
+  * http://en.wikipedia.org/wiki/Intel_HEX
+==== HEX File... ====
+Opens the file picker dialog for selecting the HEX file to be send to the node.\\
+:!: The file must be accessible by the Rocrail server.\\
+==== Boot mode ====
+Put the selected node into boot mode. \\
+==== Send ====
+Send the new firmware to the node.\\
+The HEX file must be selected and the node should be set in boot mode.\\
+==== Reset ====
+Reset the node back to normal mode.\\
+After sending the HEX file a reset is issued automatically.\\