SimDeckOS
Installer soon Sign in Notify me
PluginRace ControlStudioLibraryPricingDocsFAQ Sign in Notify me

Docs

Every guide for the plugin, Race Control and Studio, in the app’s own words.

Docs › Plugin › Build

Parameters and values

Plugin

How SimDeckOS finds a value like TC or Delta in every sim, and the Parameters page, where one setting is defined once and shows on every key, dial, LED and screen.

Values are picked by name

Every sim publishes its data under its own names. SimDeckOS keeps one catalogue of values and looks each one up for whatever game is running. The catalogue has values such as engine RPM, gear, delta to best, fuel remaining, tyre temperatures, TC and ABS.

You pick Delta to best once, and it reads correctly in every supported sim. The mapping is maintained by SimDeckOS and updated for everyone; there is nothing to set up per game.

What a parameter is

A parameter is one setting you own, such as TC, brake bias, fuel or the gear. It is defined once, with its value, its states and its look, and then it can sit on several devices at the same time.

A Stream Deck key, a dial, the wheel’s LEDs and the dash can all show the same TC. When you step it on one of them, all of them move. If you rename the parameter, every control carrying it follows.

That is why Parameters is the first page in the plugin’s BUILD group: layouts, animations, messages and profiles are all made from parameters.

Plans. Parameters are free and unlimited. Only the Gradient fill on a value bar is part of Pro.

The Parameters page

The list on the left holds every parameter. Pick one to shape it on the right.

  • New creates one of three things:
    • Parameter: a car signal, either a value or a set of states.
    • Launcher: starts apps from any key.
    • Control set: named commands for your hardware, such as a funky switch’s ways or +/− keys. A control set has nothing to show.
  • Search parameters (Ctrl+F) finds a parameter by name. You can filter the list by category or by health.

The health dot

Each parameter has a dot: green when it is healthy, amber when it is worth a look, red when it needs a fix. The dot has a fix button beside it.

ProblemWhat it meansFix
No sourceIt has no telemetry source and nothing to do yet.Pick a source
Shares an output nameIt publishes to SimHub under the same name as another parameter.Give it its own
No axis to send toA pedal or axis parameter, but the virtual joystick (vJoy) isn’t available.Try again
Not placedIt isn’t on any key, dial, button or message yet.Open Layouts

Shape a parameter

The editor has three tabs: Setup, Appearance and Controls.

Setup

  • Telemetry is the source: one name for every sim.
  • Type decides how keys and dials draw the value. Auto detects it from the telemetry. You can also force one of:
    • Delta, Temperature, Gear, Position, Speed, Rpm, Bias, Pressure, Fuel
    • Force, Percent, Pedal, Time, Count, Generic
  • Kind is Value, for a continuous reading with thresholds, a bar and a format, or State, for discrete states such as ignition, flag or wiper.

States. Each state has a match, a label, a colour, an icon and a blink.

  • Starters add ready-made state sets: On / Off, Levels 0–3 or Warning + critical.
  • The first state that matches wins, from the top. The match types are:
    • On / Off: the signal is true or false.
    • Is: one exact value.
    • Range: from low to high.
    • Otherwise: the catch-all.
  • Match a different signal lets one state test another value.
  • Under Advanced:
    • Hold after match keeps a state showing a little longer.
    • Pulse once on change pulses the state once when it changes.
    • Custom press actions replace a key’s own press while a state is active. For example, an In-Pit state can fire “confirm pit”.

Values. These cards shape a value:

  • Bar & thresholds: the bar and its range.
  • Gradient fill (Pro).
  • Threshold colours: the last matching rule wins.
  • Cards for each type, such as Time format, Redline RPM, the delta Range (± s) and Low-fuel laps.

Appearance

  • Colour is one colour everywhere the parameter shows. The Keys wear setting on Themes, or a Garage car’s colour, can override it.
  • Off colour is the colour for the off state.
  • Label & icon sets the label and icon.
  • Shows as decides how it draws: everywhere, on a key, or on a dial. An LED has no display, so it takes the colour only.
  • Format sets the unit and decimals.
  • Pedal parameters have an Axis card:
    • Virtual axis feeds it to vJoy.
    • Invert travel reverses it.
    • Bite point is the fallback; a Garage car can carry its own bite point, and the car’s wins.

Controls: what it sends

Standard controls are Press, Long-press, Increase and Decrease. Each one can send:

  • a game action,
  • a keyboard Shortcut,
  • a Virtual joystick button,
  • and Also sends, for something more.

Bind in game… opens a list of the virtual buttons that stays on top of the game, so you can bind them in the sim’s own controls menu.

A dial never fires Long-press; a rotary only sends a press.

Custom controls are named actions, such as a funky switch’s seven ways.

In Assetto Corsa, iRacing and Le Mans Ultimate, SimDeckOS can also send commands straight into the game. See Notes for each sim.

Launchers

A launcher starts one app, with Also launch for more. Long press closes the extra apps. The key shows the app’s own icon unless you set a custom one. Edit the launcher once, and every key that carries it follows.

Put a value on a key or dial

  1. Open Layouts and pick the layout for your device.
  2. Right-click a key or dial and choose Change what it shows…, or click an empty one.
  3. Pick a parameter or a value. The search finds it by name.

Each value is drawn the way that fits it:

  • A delta is a plus-or-minus bar.
  • Tyres are four corners.
  • The gear is recoloured at the shift point.
  • A lap time is shown as a time, with no bar.

Layouts and pages has the rest.

Values from SimHub itself

To wire up something SimDeckOS doesn’t map, turn on Use SimHub telemetry in Settings. Every SimHub property then becomes pickable in the parameter editors. Most people never need it.

Other sims

In a sim SimDeckOS doesn’t read itself, most values still work: each one falls back to SimHub’s own telemetry on its own. Notes for each sim has the details.