Innovative Model Railroad Control System

User Tools

Site Tools

Trace:
rocrailini-service-en

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
rocrailini-service-en [2019/04/19 14:36] – [MQTT Service] rjversluisrocrailini-service-en [2020/04/12 14:59] – [WIO Watchdog] rjversluis
Line 2: Line 2:
 [[:english#rocrail|{{  :server.png}}]][[:english|{{  :rocrail-logo-35.png}}]] [[:english#rocrail|{{  :server.png}}]][[:english|{{  :rocrail-logo-35.png}}]]
 [[english | Content ]] -> [[english#rocrail|Rocrail Server]] -> [[rocrailini-en | Configuration]]  [[english | Content ]] -> [[english#rocrail|Rocrail Server]] -> [[rocrailini-en | Configuration]] 
-  * [[rocrailini-gen-en|General]] | [[rocrailini-trace-en|Trace]] | **Service**  | [[rocrailini-automode-en|Automatic]] | [[rocrailini-controller-en|Controller]] | [[:networking-en|R2Rnet]] | [[:rocrailini-analyser-en|Analyzer]] | [[:rocrailini-rocweb-en|RocWeb]] | [[:finder:finder-en|Finder]] | [[:rocrailini-cmdmapping-en|Command Mapping]]+  * [[rocrailini-gen-en|General]] | [[rocrailini-trace-en|Trace]] | **Service**  | [[rocrailini-automode-en|Automatic]] | [[rocrailini-controller-en|Controller]] | [[:networking-en|R2Rnet]] | [[:rocrailini-router-en|Router]] | [[:rocrailini-rocweb-en|RocWeb]] | [[:finder:finder-en|Finder]] | [[:rocrailini-cmdmapping-en|Command Mapping]]
     * [[clockservice-en|Clock Service]]      * [[clockservice-en|Clock Service]] 
 // \\ // \\ // \\ // \\
  
-==== Rocrail Service tab. ====+===== Rocrail Service tab. =====
  
 {{rocrailini-service-en.png}}\\ {{rocrailini-service-en.png}}\\
Line 22: Line 22:
 Use this service if a faster clock is wanted and/or all clients must be synchronized.  Use this service if a faster clock is wanted and/or all clients must be synchronized. 
 ====Divider==== ====Divider====
-The time divider is used to setup the clock speed: 1...100\\ +The time divider is used to setup the clock speed: 1...100. (Example: A divider of 10 will run the model time 10 times faster than real time.)\\ 
-The next field is the update frequency in model minutes: 1...60\\+The next field is the Client update frequency in model minutes: 1...60. Default is every model minute.\\
 ====Hour/Minute==== ====Hour/Minute====
 This is the start time for the clock service.\\ This is the start time for the clock service.\\
Line 41: Line 41:
 The official assigned port by IANA is **[[iana-rcs|8051]]**. \\ The official assigned port by IANA is **[[iana-rcs|8051]]**. \\
  
-==== Max. number of clients ==== 
-Default 10 clients are allowed to connect concurrently to the Rocrail server. 
  
 ==== Only first can control ==== ==== Only first can control ====
 Prevent secondary clients controlling the Rocrail server; only the first one connected has control.\\ Prevent secondary clients controlling the Rocrail server; only the first one connected has control.\\
-A better solution is the use of Control or Slave Code.\\ +A better solution is the use of Control or Slave Code. 
 + \\ 
 +====WIO Watchdog==== 
 +Enables monitoring of WIO reachability. The timeout ist defined in units of 10 ms.\\ 
 +Default: 700 x 10 ms = 7 seconds.\\ 
 +WIOs are sending every 4 seconds an alive message.\\
 ==== Control code ==== ==== Control code ====
 The client must provide this control code to get write access if set.\\ The client must provide this control code to get write access if set.\\
Line 55: Line 57:
     * Rocweb     * Rocweb
     * andRoc     * andRoc
-    * iRoc 
     * padRoc     * padRoc
  
Line 155: Line 156:
 ^ MQTT Topic ^ Description ^ ^ MQTT Topic ^ Description ^
 | ''rocrail/service/info'' | All server broadcasts are published with this topic name. | | ''rocrail/service/info'' | All server broadcasts are published with this topic name. |
-| ''rocrail/service/client'' | Clients can publish commands with this topic. |+| ''rocrail/service/client'' | Clients can publish commands with this topic. \\ :!: //A valid support key is necessary; Without key only 5 demo minutes. // |
 | ''rocrail/service/field'' | Clients can publish hardware events with this topic. | | ''rocrail/service/field'' | Clients can publish hardware events with this topic. |
-| ''rocrail/service/command'' | Command station commands for user libraries. |+| ''rocrail/service/command'' | Command station commands for __**[[:digint:user-en|User Libraries]]**__. |
 \\ \\
 The payload of the MQTT messages are in __**[[:rocrail-server-scripting-en|RCP Format]]**__.\\ The payload of the MQTT messages are in __**[[:rocrail-server-scripting-en|RCP Format]]**__.\\
 The Rocrail Server uses the __**[[http://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html|MQTT V3.1 Protocol]]**__.\\ The Rocrail Server uses the __**[[http://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html|MQTT V3.1 Protocol]]**__.\\
- 
 ====Hostname==== ====Hostname====
 The DNS name or TCPIP address of the MQTT Broker.\\ The DNS name or TCPIP address of the MQTT Broker.\\
Line 171: Line 171:
 //Topic grouping//\\ //Topic grouping//\\
 Use the Item Names in the Broadcast Topic.\\ Use the Item Names in the Broadcast Topic.\\
 +
 +====User CS Libraries====
 +With both topics, //field// and //command//, it is possible to implement a user defined CS library without Rocrail Source dependencies.\\ 
  
 ====Clients==== ====Clients====
Line 209: Line 212:
 Both lines ends with a linefeed: ''\n''\\ Both lines ends with a linefeed: ''\n''\\
  
 + \\ 
 +====Last Will==== 
 +If the Rocrail MQTT-Broker connection get lost, the //Last Will// can be observed in topic ''rocrail/service/info'': 
 +<code xml> 
 +<exception text="abend"/> 
 +</code>
  
  
rocrailini-service-en.txt · Last modified: 2024/04/01 16:05 by rjversluis