sksim

<!DOCTYPE html> <html> <head> <title>SKsim | Help</title>  <link rel="stylesheet" href="./css/foundation.min.css" /> <link rel="stylesheet" href="../css/foundation-icons.css" />  <link rel="stylesheet" href="../fonts/material-icons.css" /> <link rel="stylesheet" href="./css/help.css" /> <style> h4 { color: white; } </style> </head> <body style="overflow: auto">  <div class="sticky"> <nav class="top-bar" data-topbar> <ul class="title-area">  <li class="name"> <h1 style="color: white"> <img src="../img/app_logo.png" style="width: 38px" /> SKsim Help </h1> </li>  <li class="toggle-topbar menu-icon"> <a href="#">Menu</a> </li> </ul> <section class="top-bar-section">  <ul class="right"></ul> </section> </nav> </div> <div class="panel" id="top"> <h3>Welcome to SKsim</h3> SKsim is a simple and easy way to generate a data stream from your Signal K server. Without any additional configuration the following data can be generated just by clicking the start button. <ul> <li>Vessel: position, speed & heading</li> <li>GPS: hdop, vdop, pdop & quality</li> <li>Wind: speed & direction</li> <li>Water: temperature and depth</li> <li>Propulsion: Port / Starboard engine RPM and temperature</li> </ul> Additionally, you can also: <ul> <li> Manually enter Signal K attributes and values to include into the output data stream </li> <li>Follow a Track loaded from a GPX file</li> </ul> Features include: <ul> <li> Dashboard style control panel for configuring transmitted values </li> <li>Ability to mute output by value groups</li> <li> Manual override of individual values that allows you to control the transmitted values </li> <li> "Freeze" values by pausing the simulator calculation of new values </li> <li>"Walk" along a Track (from GPX file)</li> </ul> <hr /> <ul> <li> <a href="#simulator"> developer_board Simulator </a> </li> <li> <a href="#settings"> settings Settings </a> </li> <li> <a href="#track" > <img src="../img/gpx_black.png" style="width: 25px" /> Follow Track</a > </li> </ul> </div> <div class="panel" id="simulator"> <h4>developer_board Simulator</h4> <a href="#top" style="font-weight: bold" > Back to Top</a >   SKsim operation is designed to be simple and requires minimal configuration, just click the start play_arrow button to start the data stream. Once the data stream has been started, use the controls on the Simulator screen to manually override, mute or freeze output data values. You can view the output data stream by selecting Show Output from the menu. SKSim provides "visual" controls to both view and manipulate in the generated data stream. Data is generated based on seed data values entered in the settings screen. The seed data represents the starting values to which SKsim then applies a "variance" to simulate vessel movement.   <img style="max-height: 230px" src="img/helm.png" /> You can manually override an individual value by checking the checkbox associated with the value and sliding the control to the desired value. <img style="width: 200px" src="img/override.png" /> The output values for a particular group of attributes e.g. GPS can be muted (removed from the data stream) by clicking the mute power_settings_new button. <hr /> The toolbar buttons at the top right of the screen provide controls to: play_arrow Start the simulator pause Freeze the simulator output values so they are static stop Stop the Simulator The more_vert menu contains the following options: <img src="../img/gpx_black.png" style="width: 20px" /> Follow GPX Track <a href="#track">(more details)</a> refresh Reset: Reset simulator start values short_text Show Output: Display output data stream <hr /> The following data can be controlled from the Simulator screen: <ul> <li style="display: flex; flex-wrap: wrap"> GPS - Fix On / Off: Controls GPS fixing status - HDOP, PDOP & VDOP: Dilution of Precision - Vessel Position: can be set at any time by clicking on the map. Altitude, Fix Qaulity and Number of Satellites are fixed and do not vary and cannot be changed! </li> <li style="display: flex; flex-wrap: wrap"> Helm - Speed: Vessel speed - Heading: Vessel heading - Mark Position: Mark the current vessel position and output waypoint data. - Steering Mode: Click directions_boat to enter Steering Mode which allows you to alter vessel course by moving the rudder. <img style="max-height: 230px" src="img/steeringmode.png" /> </li> <li style="display: flex; flex-wrap: wrap"> Wind. - True Speed: True wind speed - True Direction: True wind direction - Apparent Wind: Calculated apparent wind speed and angle </li> <li style="display: flex; flex-wrap: wrap"> Water. - Temperature: Water temperature - Depth: Water depth </li> <li style="display: flex; flex-wrap: wrap"> Propulsion. - RPM: Port / Starboard Engine RPM - Temperature: Port / Starboard Engine temperature </li> <li style="display: flex; flex-wrap: wrap"> Destination. - Title: Destination title - Common Name:Common name for destination - ETA is not editable and defaults to today's date </li> <li style="display: flex; flex-wrap: wrap"> Signal K Atributes. Use the Attibutes button to display a panel that will allow the input of additional Signal K path and value pairs. Once you have entered a path / value pair it will be added to the output data stream.   Note: Your path / value entries are not validated against the Signal K schema and will be transitted as entered! You will need to ensure correct path names and that values are entered in the correct units! <img src="img/signalk.png" /> </li> </ul> </div> <div class="panel" id="settings"> <h4>settings Settings</h4> <a href="#top" style="font-weight: bold" > Back to Top</a >   The Settings screen enables the following features of SKsim to be configured: Output Stream: This section controls the period at which updates are output to the data stream. <ul> <li> Send Data every (m/sec): <ul> <li>1000</li> <li>2000</li> <li>3000</li> <li>5000</li> <li>10000</li> </ul> </li> </ul> <hr /> Simulator Starting Values: Configure starting values for simulator output values: <ul> GPS <li>Latitude</li> <li>Longitude</li> <li>Speed</li> <li>Heading</li> Wind <li>Speed</li> <li>Direction</li> Water <li>Depth</li> <li>Temperature</li> </ul> <hr /> </div> <div class="panel" id="track"> <h4> <img src="../img/gpx_black.png" style="width: 25px" /> Follow Track </h4> <a href="#top" style="font-weight: bold" > Back to Top</a >   SKsim can use a Track loaded from a GPX file as a source for the path of the vessel. SKsim will walk the track by moving from point to point using the output interval you have selected. To load a track: <ul> <li> Select Follow GPX Track from the more_vertmenu </li> <li>Select a GPX file containing Track data</li> <li> You will be shown a list of Tracks contained within the GPX file. Select the desired Track. </li> <li> The Track will be loaded and the vessel position set to the start of the Track </li> </ul> <img src="./img/track.png" style="width: 150px" /> Note: The heading control will be disabled as the heading will be derived from the bearing to the next point in the track. Also the vessel speed has no bearing on the pace at which the path is walked, nor is the speed value adjusted based on the distance between track points! Once a track has been loaded press the play_arrowbutton to start walking the Track. When the end of the Track is reached SKsim will automatically stop. You can reset the vessel position to the start of the Track by clicking the cancelReset to start of Track button. To clear the Track and return to normal mode click the settings_backup_restoreCancel Follow Track button. Note: If a track has multiple segments, SKsim will concatenate all the segments into one contiguous Track </div> </body> </html>