rocweb:rocweb-en
Differences
This shows you the differences between two versions of the page.
Previous revision | |||
— | rocweb:rocweb-en [2023/08/29 11:01] (current) – rjversluis | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Rocweb====== | ||
+ | [[: | ||
+ | [[: | ||
+ | [[: | ||
+ | * [[: | ||
+ | * [[: | ||
+ | \\ | ||
+ | =====The Browser solution for mobile and stationary Rocrail clients.===== | ||
+ | {{: | ||
+ | One for all...\\ | ||
+ | \\ | ||
+ | | [[: | ||
+ | \\ | ||
+ | |||
+ | ===== Overview ===== | ||
+ | Rocweb is a WEB Browser based Rocrail client for all platforms including mobile devices.\\ | ||
+ | The [[http:// | ||
+ | |||
+ | \\ | ||
+ | |||
+ | {{: | ||
+ | * Rocweb supersedes all other Mobile Rocrail Clients. | ||
+ | * Rocweb needs zero install; Just connect to the Rocrail server and go. | ||
+ | \\ | ||
+ | |||
+ | ====Features==== | ||
+ | * Operating System independent | ||
+ | * Zero installation | ||
+ | * Multiple SVG theme support | ||
+ | * Train management | ||
+ | * Consist/ | ||
+ | * Fast clock support | ||
+ | * On the fly guest loco creation | ||
+ | * Many actions for running automatically | ||
+ | * Zoomable layout | ||
+ | * System actions | ||
+ | * Binary state control | ||
+ | * Optional speed buttons for shunting | ||
+ | * Many options to modify Rocweb as needed | ||
+ | * Control and slave codes to reduce control for guests | ||
+ | * Loco list categories | ||
+ | * Save the options on the Rocrail server in case the browser will delete all data on close | ||
+ | |||
+ | | ||
+ | \\ | ||
+ | |||
+ | ===== Browser Requirements ===== | ||
+ | An up to date browser is needed which supports: | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | |||
+ | ====Tested browsers==== | ||
+ | ^ Browser ^ Version ^ Remark ^ OS ^ | ||
+ | | [[http:// | ||
+ | | [[http:// | ||
+ | | [[http:// | ||
+ | | [[http:// | ||
+ | | [[http:// | ||
+ | A complete list of supported browsers is found on the __**[[http:// | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Prerequisites ===== | ||
+ | * An up to date **[[: | ||
+ | * WLAN (WiFi) in case of mobile devices. The quality of the signal should be at least 50%. | ||
+ | * The mobile device should not be older then 2016, especially in case of Android devices. (Android before 2016 have generally poor JavaScript performance.) | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Setup ===== | ||
+ | In the Rocrail properties dialog there is a __**[[: rocrailini-rocweb-en |RocWeb Tab]]**__ on which the needed port and directories can be set. This must be done for every individual Workspace.\\ | ||
+ | The SVG Theme paths are identically interpreted as by __**[[: | ||
+ | |||
+ | The images of locs, wagons etc. are only displayed in rocweb, if the image path in __**[[: rocrailini-gen-en# | ||
+ | |||
+ | ====Windows==== | ||
+ | | {{: | ||
+ | | Install directory. | ||
+ | In the install directory of Rocrail a directory named **web** should exist; If not the the Rocrail install must be updated.\\ | ||
+ | This directory contains the HTML and JavaScript files needed for Rocweb.\\ | ||
+ | ====macOS==== | ||
+ | If Rocrail was installed in the Applications directory the web is found here: | ||
+ | < | ||
+ | / | ||
+ | </ | ||
+ | ====Linux/ | ||
+ | The web directory is found here: | ||
+ | < | ||
+ | ~/ | ||
+ | </ | ||
+ | |||
+ | ===Chromium Browser=== | ||
+ | {{ : | ||
+ | The most easy way to launch Rocweb under Linux/ | ||
+ | Raspbian comes with Chromium pre installed, and on other Linux distributions the following command will install it:\\ | ||
+ | < | ||
+ | sudo apt-get install chromium-browser | ||
+ | </ | ||
+ | The shortcut starts Rocweb without any menu and navigation bar like this: | ||
+ | < | ||
+ | chromium --app=http:// | ||
+ | </ | ||
+ | The **localhost** parameter can be replaced with any computer name or IP address.\\ | ||
+ | \\ | ||
+ | |||
+ | =====Browser URL===== | ||
+ | RocrailServer-IP: | ||
+ | Example:\\ | ||
+ | | **http:// | ||
+ | {{: | ||
+ | Notes: | ||
+ | * //This is only an example IP address which should be replaced with the IP address of the Rocrail Server computer.// | ||
+ | * //Do __not__ use to same port number as used for the __**[[: | ||
+ | The " | ||
+ | |||
+ | ====Parameters==== | ||
+ | Needs Rocrail revision 11.200+\\ | ||
+ | ===ZLevel=== | ||
+ | With the optional parameter **z** a ZLevel can be preselected.\\ | ||
+ | Example of selecting ZLevel 1:\\ | ||
+ | | **http:// | ||
+ | |||
+ | \\ | ||
+ | =====RocwebXS===== | ||
+ | | Does not work with Modular Layouts. |\\ | ||
+ | {{ : | ||
+ | RocwebXS is a lightweight HTML client with only the throttle as main page. It is for devices with a small display.\\ | ||
+ | RocrailServer-IP: | ||
+ | Example:\\ | ||
+ | | **< | ||
+ | |||
+ | ====Parameters==== | ||
+ | ===Speed buttons=== | ||
+ | Speed buttons can be activated with the optional parameter **speedbuttons**.\\ | ||
+ | Example:\\ | ||
+ | | **< | ||
+ | |||
+ | ===Bin State Control=== | ||
+ | The Bin State Control can be activated with the optional parameter ** binstate**.\\ | ||
+ | Example:\\ | ||
+ | | **< | ||
+ | |||
+ | ===Language=== | ||
+ | The language can be selected with the optional parameter **lang**.\\ | ||
+ | Example:\\ | ||
+ | | **< | ||
+ | or | ||
+ | | **< | ||
+ | |||
+ | Supported translations: | ||
+ | ^ Value ^ Language ^ | ||
+ | | de | German | | ||
+ | | en | English (default) | | ||
+ | | es | Spanish | | ||
+ | | fr | France | | ||
+ | | it | Italian | | ||
+ | | nl | Dutch | | ||
+ | |||
+ | \\ | ||
+ | |||
+ | =====The header icons===== | ||
+ | The header icons are short cuts for commonly used Rocrail functions as listed below:\\ | ||
+ | {{: | ||
+ | Source for translations: | ||
+ | |||
+ | The following buttons are hidden in case the display width <= 640: | ||
+ | * Zoom | ||
+ | * Stop all locs | ||
+ | Both actions can also be accessed via the menu and automatic popup.\\ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Menu===== | ||
+ | {{: | ||
+ | ====Information==== | ||
+ | Information about Rocrail and the connected Server.\\ | ||
+ | {{: | ||
+ | \\ | ||
+ | |||
+ | ====System==== | ||
+ | This will pop up the system dialog for some common actions:\\ | ||
+ | {{: | ||
+ | ===Init field=== | ||
+ | See: __**[[: | ||
+ | ===Start of day=== | ||
+ | See: __**[[: | ||
+ | ===Emergency break=== | ||
+ | See: __**[[: | ||
+ | ===Shutdown server=== | ||
+ | Shutdown the Rocrail Server if its not in console mode and Rocweb is not in slave mode.\\ | ||
+ | This action needs a confirmation.\\ | ||
+ | \\ | ||
+ | |||
+ | ====Automatic==== | ||
+ | This will pop up the automatic dialog:\\ | ||
+ | {{: | ||
+ | ===Start all locs==== | ||
+ | Start all locos in auto mode.\\ | ||
+ | This action needs a confirmation.\\ | ||
+ | ===Stopt all locs==== | ||
+ | Stop all locs in auto mode.\\ | ||
+ | ===Soft reset==== | ||
+ | Reset all except for block reservations.\\ | ||
+ | ===Reset all=== | ||
+ | Reset all including block reservations.\\ | ||
+ | This action needs a confirmation: | ||
+ | {{: | ||
+ | |||
+ | ====Options==== | ||
+ | This will pop up the options dialog for setting individual options:\\ | ||
+ | {{: | ||
+ | |||
+ | ===Debug=== | ||
+ | If the developer tool JavaScript/ | ||
+ | This is for tracing issues with Rocweb. Normally this option should be disabled to avoid using too much system resources.\\ | ||
+ | |||
+ | ===Simulate sensors=== | ||
+ | Enable a click on a sensor symbol to simulate a sensor event.\\ | ||
+ | |||
+ | ===Show all schedules=== | ||
+ | To list up schedule which contains a block but its not at the first entry.\\ | ||
+ | This option is used in the __**[[# | ||
+ | |||
+ | ===Module view=== | ||
+ | Switch directly to module view in case the loaded plan is modular.\\ | ||
+ | |||
+ | ===Block occupancy=== | ||
+ | Show the occupancy in tracks, signals and sensors related to a block.\\ | ||
+ | Disable to increase performance.\\ | ||
+ | |||
+ | ===Show routes=== | ||
+ | Show routes over tracks, sensors and signals.\\ | ||
+ | Disable to increase performance.\\ | ||
+ | |||
+ | ===Show routes on switches=== | ||
+ | See: __**[[: | ||
+ | Disable to increase performance.\\ | ||
+ | |||
+ | ===Use all speed steps=== | ||
+ | Send new speed commands wenn moving the speed slider.\\ | ||
+ | The delta is 3 to avoid too much commands.\\ | ||
+ | In the mode the slider will not be updated by loco events.\\ | ||
+ | |||
+ | ===Speed buttons=== | ||
+ | Replaces the slider with __**[[# | ||
+ | |||
+ | ===Binary State Control=== | ||
+ | An extra control field, in the **[[# | ||
+ | | {{: | ||
+ | | Register | ||
+ | |||
+ | ===Speed preset buttons=== | ||
+ | Buttons for Vmin, Vmid, Vcru and Vmax.\\ | ||
+ | > A long click is needed to activate Vmax. (This is introduced for smartphone users.)\\ | ||
+ | |||
+ | ===Show block IDs=== | ||
+ | Show block the ID in front of the Loco ID in occupied normal blocks.\\ | ||
+ | |||
+ | ===Show train IDs=== | ||
+ | Show __**[[: | ||
+ | |||
+ | ===Show loco image in block=== | ||
+ | Show __**[[: | ||
+ | |||
+ | ===Fast clock=== | ||
+ | Add an extra panel with an __**[[# | ||
+ | |||
+ | ===Second hand=== | ||
+ | Shows the second hand in the fast clock.\\ | ||
+ | |||
+ | ===Trace=== | ||
+ | Activates __**[[# | ||
+ | This option needs extra CPU resources depending on the amount of traffic.\\ | ||
+ | |||
+ | ====SLIM==== | ||
+ | This option is for rendering the turntable conform the SLIM/ | ||
+ | Rocweb is not aware of which theme is active, and must be informed by option.\\ | ||
+ | |||
+ | ===Loco selection category=== | ||
+ | The loco selection popup can be ordered by these three categories: | ||
+ | * Engine | ||
+ | * Era | ||
+ | * Roadname | ||
+ | * All -> All locos sorted in just one list. | ||
+ | |||
+ | ===Loco sorting order=== | ||
+ | The loco selection popup can be sorted by these two attributes: | ||
+ | * ID | ||
+ | * Decoder Address | ||
+ | |||
+ | ===Background color=== | ||
+ | A user defined background color in RGB format.\\ | ||
+ | The check button must be clicked to take over the new values.\\ | ||
+ | |||
+ | ===Slider delta=== | ||
+ | In case of " | ||
+ | |||
+ | ===Control code=== | ||
+ | See: __**[[: | ||
+ | ===Slave code=== | ||
+ | See: __**[[: | ||
+ | |||
+ | ===Save on server=== | ||
+ | Save the Rocweb options on the Rocrail Server.\\ | ||
+ | If the used browser deletes all data after closing it the options will be requested from the server at Rocweb start .\\ | ||
+ | ==For experts== | ||
+ | The Rocweb options are saved in the rocrail.ini in the node **http-> | ||
+ | <code xml> | ||
+ | <http port=" | ||
+ | < | ||
+ | <rocweb binstate=" | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | ====Guest loco==== | ||
+ | {{: | ||
+ | To add a loco on the fly a guest loco can be added.\\ | ||
+ | At least the address must be set before add.\\ | ||
+ | See for more information: | ||
+ | |||
+ | \\ | ||
+ | ====Zoom==== | ||
+ | {{: | ||
+ | The zoom range is from 50% to 200% and in steps of 10%. | ||
+ | * Zoom in **plus** | ||
+ | * Zoom 100% **home** | ||
+ | * Zoom Out **minus** | ||
+ | |||
+ | \\ | ||
+ | ====Help==== | ||
+ | Throttle long click functions: | ||
+ | {{: | ||
+ | \\ | ||
+ | ====Trace==== | ||
+ | If the Trace option is activated this popup shows the last trace lines in reverse chronological order without time stamp:\\ | ||
+ | {{: | ||
+ | This popup will be updated, when visible or not, if new lines come in.\\ | ||
+ | Lines are starting with the trace level in brackets.\\ | ||
+ | The **Clear messages** button removes all trace lines.\\ | ||
+ | \\ | ||
+ | |||
+ | ====Level==== | ||
+ | With the level selector another level can be activated.\\ | ||
+ | |||
+ | ====Background color==== | ||
+ | Select a background color.\\ | ||
+ | The user defined color can be set in the Options Popup.\\ | ||
+ | A reload of the page is needed and will be automatically requested.\\ | ||
+ | |||
+ | |||
+ | ====Language==== | ||
+ | Select the wanted language to use with Rocweb: | ||
+ | * Deutsch | ||
+ | * English | ||
+ | * Nederlands | ||
+ | * Français | ||
+ | * Italiano | ||
+ | * Español | ||
+ | Missing your language, or if you wish a change of translations? | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Throttle===== | ||
+ | | {{: | ||
+ | | Speed slider | ||
+ | Click on the image to select another loco. If no loco is selected click on the image place holder:\\ | ||
+ | {{: | ||
+ | |||
+ | The lines under the loco image are: | ||
+ | - Loco ID, train ID(length, | ||
+ | - Loco description. | ||
+ | - Slave locos of the consist. If the selected loco is self a slave, the master will be listed as first. A click on the master ID will select the master loco in the throttle. | ||
+ | |||
+ | ==== Normal clicks ==== | ||
+ | ^ Button ^ Function ^ | ||
+ | | ST | Start/stop loco automode | | ||
+ | | RE | Release loco | | ||
+ | | FG | Select function group in the throttle | | ||
+ | |||
+ | ==== Long clicks ==== | ||
+ | ^ Button ^ Function ^ | ||
+ | | Loco image | Opens the **Block** popup if the selected loco is in a block, or if not the **Select Block** popup.((12.490+)) | | ||
+ | | RE | Power OFF | | ||
+ | | FG | Emergency Break | | ||
+ | | F1-F4 | Throttle selection | | ||
+ | | F5 | __**[[: | ||
+ | | F6 | __**[[: | ||
+ | | F7 | __**[[: | ||
+ | | F8 | __**[[: | ||
+ | | F9 | Add a consist loco | | ||
+ | | F10 | Delete a consist loco | | ||
+ | | F11 | Show the complete consist including the master loco | | ||
+ | | F13 | Manual mode ON/OFF (Zimo MX10) | | ||
+ | | F14 | Shunting ON/OFF (Zimo MX10) | | ||
+ | | Lights | Dispatch | | ||
+ | | Direction | Stop (V=0) | | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Select Block===== | ||
+ | {{: | ||
+ | With a long click on the throttle loco image click, this popup will be visible if the loco is __not__ in a block.\\ | ||
+ | After selecting a block from the list the loco will be put in the block after a click on the select button.\\ | ||
+ | \\ | ||
+ | |||
+ | =====Turntable & FiddleYard===== | ||
+ | A click/push on a turntable or fiddleyard in the layout will open following popup:\\ | ||
+ | {{: | ||
+ | |||
+ | ====Next==== | ||
+ | Go to the next track.\\ | ||
+ | ====Previous==== | ||
+ | Go to the previous track.\\ | ||
+ | ====Go==== | ||
+ | Go to the selected track from the list.\\ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | =====Block===== | ||
+ | A click/push on a block in the layout will open following popup:\\ | ||
+ | {{: | ||
+ | |||
+ | ==== Long clicks ==== | ||
+ | ^ Button ^ Function ^ | ||
+ | | Half automatic | [[: | ||
+ | | Soft reset | [[: | ||
+ | |||
+ | ====Loco image==== | ||
+ | Select another loco from the list to set in this block.\\ | ||
+ | If no loco is in this block one can be selected after clicking on the dummy loco image:\\ | ||
+ | {{: | ||
+ | With a long click the loco will be removed from this block.\\ | ||
+ | |||
+ | ====Reset Locomotive assignment==== | ||
+ | Use a long click on the loco image.\\ | ||
+ | |||
+ | ====Schedule==== | ||
+ | Select a schedule or tour from this drop down list to use with "Start train" | ||
+ | Default only schedules and tours are listed which starts in this block. In the options menu this can be changed.\\ | ||
+ | ====Block==== | ||
+ | Select a destination block from this drop down list to use with "Start train" | ||
+ | If a schedule is also selected the block destination will be ignored.\\ | ||
+ | |||
+ | ====Assign train==== | ||
+ | Assign a train selected from the list.\\ | ||
+ | To release a train if the first item, " | ||
+ | |||
+ | ====Start train==== | ||
+ | Start the train in this block in automatic mode with the optional selected schedule or tour.\\ | ||
+ | ====Stop train==== | ||
+ | Stops the train in this block running in automatic mode.\\ | ||
+ | ====Half automatic==== | ||
+ | Start the train in this block in half automatic mode with the optional selected schedule or tour.\\ | ||
+ | ====Soft reset==== | ||
+ | Reset the loco in this block without removing it from the block.\\ | ||
+ | ====Swap placing/ | ||
+ | See: __**[[: | ||
+ | ====Open/ | ||
+ | Open or close this block.\\ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Loco selection===== | ||
+ | The loco selection is used in the throttle and block popup by clicking on the loco image.\\ | ||
+ | {{: | ||
+ | The categorie type can be changed in the __**[[# | ||
+ | |||
+ | |||
+ | \\ | ||
+ | =====Consist management===== | ||
+ | A loco consist can be managed using the following long clicks in the throttle: | ||
+ | ^ Button ^ Function ^ Description ^ | ||
+ | | F9 | Add a consist loco | Opens al loco selection list without the already existing members. | | ||
+ | | F10 | Delete a consist loco | Opens al loco selection list with all existing members. | | ||
+ | | F11 | Show the complete consist including the master loco. | | | ||
+ | |||
+ | |||
+ | \\ | ||
+ | =====Fast clock===== | ||
+ | {{: | ||
+ | A click/touch on the level title will open the fast clock popup:\\ | ||
+ | {{: | ||
+ | The **Set**, **Freeze** and **Resume** commands can be used.\\ | ||
+ | See for more information: | ||
+ | > Note: On small devices the title is probably hidden; Landscape could help out.\\ | ||
+ | If a text field has set the option " | ||
+ | {{: | ||
+ | |||
+ | ====Analog clock==== | ||
+ | | The clock is __not__ available in module view. | \\ | ||
+ | An extra level is generated for the analog clock:\\ | ||
+ | {{: | ||
+ | A click/touch on the clock will open the Fast Clock popup.\\ | ||
+ | The used SVG is based on the __**[[http:// | ||
+ | |||
+ | vielen Dank für Deine Mail. Die Verlinkung so ist prima, auch dafür vielen Dank. | ||
+ | |||
+ | Eine schönes Programm - rocrail - hast Du da geschrieben. | ||
+ | |||
+ | Viel Erfolg damit und viele Grüße aus Hamburg | ||
+ | Rüdiger))\\ | ||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Layout===== | ||
+ | ====Tooltips==== | ||
+ | Tooltips are available for all layout objects except for tracks.\\ | ||
+ | {{: | ||
+ | |||
+ | ====Touch feedback==== | ||
+ | To show feedback if an object was really touched the background will get a red color until an event came in for this object from the Rocrail server.\\ | ||
+ | |{{: | ||
+ | | Touch red background. | ||
+ | \\ | ||
+ | |||
+ | |||
+ | ====Module layout==== | ||
+ | Rocweb can show the module layout in one level:\\ | ||
+ | {{: | ||
+ | This example shows 6 modules.\\ | ||
+ | See for more information about this layout: __**[[: | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ====Block labels==== | ||
+ | < | ||
+ | BlockID : LocoID _ TrainID BlockEnterSide | ||
+ | </ | ||
+ | ===Default placing=== | ||
+ | {{: | ||
+ | ===Reverse placing=== | ||
+ | {{: | ||
+ | The loco ID is __underlined__.\\ | ||
+ | |||
+ | \\ | ||
+ | =====Small devices===== | ||
+ | On small devices, like smart-phones, | ||
+ | * On iOS with Safari | ||
+ | * On Android with Chrome | ||
+ | |||
+ | \\ | ||
+ | =====Desktop shortcut===== | ||
+ | Some browsers offer to create a shortcut on the Desktop for a Web-App like Chrome: | ||
+ | * https:// | ||
+ | |||
+ | |||
+ | ===== Trouble Shooting ===== | ||
+ | ==== Plan does (partial) not load ==== | ||
+ | Check the plan if it is XML **well formed** with a tool like [[http:// | ||
+ | Or use the W3C service: http:// | ||
+ | Rocrail and Rocview are using the Rocs parser which is not so strict as the JavaScript one.\\ | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | =====Links and Files===== | ||
+ | * {{: | ||
+ | * https:// | ||
+ | |||
+ | |||
+ | \\ | ||
+ | |||
+ | ===== Video demonstrating the handling of Rocweb ===== | ||
+ | This video explains the operation of a layout by Rocweb (in German). | ||
+ | It includes the following chapters: | ||
+ | |||
+ | - Installation and setup\\ | ||
+ | - Starting Rocweb in a web browser [03:40]\\ | ||
+ | - Operating Rocweb part 1 (basic configuration, | ||
+ | - Operating Rocweb part 2 (layers, zoom, track power, automatic mode) [11:46]\\ | ||
+ | - Operating Rocweb part 3 (loco functions) [13:36]\\ | ||
+ | - Operating Rocweb part 4 (switches, signals, block functions and a concluding demo) [18:40]\\ | ||
+ | |||
+ | < | ||
+ | <object width=" | ||
+ | version=3& | ||
+ | </ | ||
+ | |||
+ | \\ |