Skip to content

Commit

Permalink
Update to documentation for LEV type items
Browse files Browse the repository at this point in the history
  • Loading branch information
charlestytler committed Apr 13, 2020
1 parent 585a690 commit 73a78a7
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 14 deletions.
Binary file modified Release/com.ctytler.dcs.streamDeckPlugin
Binary file not shown.
4 changes: 1 addition & 3 deletions Sources/com.ctytler.dcs.sdPlugin/helpDocs/helpContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ The momentary buttons are used to send commands to clickabledata items of BTN ty

_Note: Repetition of sent value while button is held pressed is not supported at this time._

**Use with Axis (LEV) Type** -- Some of the volume knobs and comms channel selectors are designed to accept axis input, and they expect a single value to increment their value. For example a volume knob with limits 0,1 can be rotated with small rotations by setting "Send Value while Pressed" to `0.01` and disabling the release value (as the release value will just interfere). To rotate a greater amount per press, increase the send value.

### Increment Settings

Increment buttons are used for clickabledata items of TUMB type, which are rotary dials or other items that have multiple values you want to iterate through.
Expand Down Expand Up @@ -169,7 +167,7 @@ _Click Value_ -- The value sent for a left/right click of the mouse. May have di
- BTN: Click value is generally the "pressed" button value (usually 1).
- TUMB (Rotary Knobs): This is the value the knob will be incremented within the range (usually +/-0.1).
- TUMB (Switches): This is the value the switch will be incremented within the range on click (usually +/-1, but sometimes +/-0.1 also).
- LEV: Click value is the increment value within the range, however is often listed as 0 in the table. For these you will need to manually enter a Send value in Command settings that provides a desirable response. The momentary button with the "Send on Release" disabled is recommended for providing axis-like input.
- LEV: Click value is the increment value within the range, however is often listed as 0 in the table. For these you will need to manually enter a Send value in Command settings that provides a desirable response.

_Limit Min_ -- The minimum value the item can be commanded to.
_Limit Max_ -- The maximum value the item can be commanded to.
Expand Down
11 changes: 2 additions & 9 deletions Sources/com.ctytler.dcs.sdPlugin/helpDocs/helpWindow.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ <h2 id="dcs-command-on-button-press-settings">DCS Command (on Button Press) Sett
<p>The remaining settings differ according to what type of DCS Interface button is used and can be categorized into
Momentary, Increment, and Switch.</p>
<h3 id="momentary-button-settings">Momentary Button settings</h3>
<p>The momentary buttons are used to send commands to clickabledata items of BTN type, or LEV type in special cases,
see note below.</p>
<p>The momentary buttons are used to send commands to clickabledata items of BTN type.</p>
<p><strong>Send Value while Pressed</strong> -- This is the value that is sent immediately upon pressing the
Streamdeck button. By default most buttons will use <code>1</code> for a pressed value. Sometimes pairs of
buttons (such as up/down arrow buttons on a panel) will have <code>1</code> as the pressed value for the up
Expand All @@ -97,11 +96,6 @@ <h3 id="momentary-button-settings">Momentary Button settings</h3>
<p><strong>Disable (Send Release) Check</strong> -- The checkbox next to the &quot;Send Value while Released&quot;
will disable any command being sent when releasing a button.</p>
<p><em>Note: Repetition of sent value while button is held pressed is not supported at this time.</em></p>
<p><strong>Use with Axis (LEV) Type</strong> -- Some of the volume knobs and comms channel selectors are designed to
accept axis input, and they expect a single value to increment their value. For example a volume knob with
limits 0,1 can be rotated with small rotations by setting &quot;Send Value while Pressed&quot; to
<code>0.01</code> and disabling the release value (as the release value will just interfere). To rotate a
greater amount per press, increase the send value.</p>
<h3 id="increment-settings">Increment Settings</h3>
<p>Increment buttons are used for clickabledata items of TUMB type, which are rotary dials or other items that have
multiple values you want to iterate through.</p>
Expand Down Expand Up @@ -244,8 +238,7 @@ <h2 id="aircraft-module-clickabledata">Aircraft Module Clickabledata</h2>
but sometimes +/-0.1 also).</li>
<li>LEV: Click value is the increment value within the range, however is often listed as 0 in the table. For
these you will need to manually enter a Send value in Command settings that provides a desirable response.
The momentary button with the &quot;Send on Release&quot; disabled is recommended for providing axis-like
input.</li>
</li>
</ul>
<p><em>Limit Min</em> -- The minimum value the item can be commanded to.<br>
<em>Limit Max</em> -- The maximum value the item can be commanded to.<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,9 @@
<br />
<b>TUMB:</b> Rotary/Switch - use increment to advance within range, or switch to select two
values<br />
<b>LEV:</b> Axis - recommend using button with release value disabled (sent values are
additive) </p>
<b>LEV:</b> Axis - use increment to advance within range, increment value can be adjusted
for sensitivity
</p>
</div>
</div>
</div>
Expand Down

0 comments on commit 73a78a7

Please sign in to comment.