Fix doc.

doc/_ext/sphinx-ext-button.py

@@ -7,9 +7,11 @@
 
 VERSION = '0.1'
 
+BOOTSTRAP_COLORS = ('primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark')
+
 
 def _color_choice(arg: str):
-    return directives.choice(arg, ('primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'))
+    return directives.choice(arg, (*BOOTSTRAP_COLORS, *[f'outline-{color}' for color in BOOTSTRAP_COLORS]))
 
 
 class Button(Directive):
@@ -36,7 +38,7 @@ def run(self) -> Sequence[nodes.Node]:
                 child.replace_self(inline)
 
         # Apply styles.
-        button_node['classes'].extend(('btn', 'color-{}'.format(self.options['color'])))
+        button_node['classes'].extend(('btn', f'btn-{self.options["color"]}'))
 
         return [button_node]
 

doc/_style/style.scss

@@ -28,45 +28,12 @@ img {
     max-height: max-content;
   }
 }
-
-kbd:not(.compound) {
-  font-family: sans-serif;
-  color: #000000;
-  background-color: #dee2e6;
-  border: #dee2e6 1px solid;
-  border-radius: 4px;
-  padding: 0 0.25em;
-  margin: 0;
-}
-
 .btn {
-  display: inline-block;
-  font-family: sans-serif;
-  color: $body-color;
-  border-style: solid;
-  border-width: 1px;
-  border-radius: 4px;
-  padding: 0.25em;
-  margin: 0;
-  height: 1.25em;
-
-  @each $color_name, $color in $colors {
-    &.color-#{$color_name} {
-      color: map-get($body-colors, $color_name);
-      background-color: $color;
-      border-color: $color;
-    }
-  }
-
   img {
-    height: 0.75em;
+    height: 1em;
 
     &.line-height {
       vertical-align: text-bottom;
     }
   }
 }
-
-.line-height {
-  height: 1em !important;
-}

doc/usage/chancheck/index.rst

@@ -93,44 +93,10 @@ Use Per-Address-Priority
    as it is a proprietary extension to the sACN standard. Receivers that do not understand per-address-priority will
    behave as if the priority setting is applied to the entire universe.
 
-.. index:: Effects
-
-.. _chancheck-effect:
-
-Effect
-------
-
-.. _chancheck-effect-none:
-
-None
-^^^^
-
-No effect will be applied to the output. The address will be set to the configured level and will return to zero when a
-different address is selected.
-
-.. index:: Blink
-
-.. _chancheck-effect-blink:
-
 Blink
-^^^^^
-
-The address will flash at the selected rate.
-
-.. figure:: screenshots/blink.png
-   :class: screenshot
-
-   Blink configuration menu
-
-Duration
-   .. _chancheck-effect-blink-duration:
-
-   The amount of time to wait before turning on/off.
-
-Level
-   .. _chancheck-effect-blink-level:
+   .. _chancheck-effect-blink:
 
-   The *on* level. The *off* level comes from the main level fader outside the effect configuration.
+   When checked, the selected address will flash between the chosen level and 0% every half-second.
 
 Tips
 ----
@@ -143,8 +109,7 @@ per-address-priority option and Blink effect:
 
 1. Set the priority to ``200``.
 2. Enable :ref:`per-address-priority <chancheck-config-pap>`.
-3. Set the level to ``20%`` (or some other low level).
-4. Enable the :ref:`chancheck-effect-blink` effect. Set the blink level to ``100%``
-5. Press |btn_start|.
+3. Enable the :ref:`Blink <chancheck-effect-blink>` effect.
+4. Press |btn_start|.
 
 The address currently being checked will blink, while all others will remain at their previous level.

doc/usage/control/index.rst

@@ -18,86 +18,6 @@
 
    .. image:: /img/icons/keyboard-solid.svg
 
-.. |btn_0| button::
-   :color: light
-
-   0
-
-.. |btn_1| button::
-   :color: light
-
-   1
-
-.. |btn_2| button::
-   :color: light
-
-   2
-
-.. |btn_3| button::
-   :color: light
-
-   3
-
-.. |btn_4| button::
-   :color: light
-
-   4
-
-.. |btn_5| button::
-   :color: light
-
-   5
-
-.. |btn_6| button::
-   :color: light
-
-   6
-
-.. |btn_7| button::
-   :color: light
-
-   7
-
-.. |btn_8| button::
-   :color: light
-
-   8
-
-.. |btn_9| button::
-   :color: light
-
-   9
-
-.. |btn_clear| button::
-   :color: light
-
-   Clear
-
-.. |btn_at| button::
-   :color: light
-
-   At
-
-.. |btn_enter| button::
-   :color: light
-
-   Enter
-
-.. |btn_plus| button::
-   :color: light
-
-   +
-
-.. |btn_thru| button::
-   :color: light
-
-   Thru
-
-.. |btn_minus| button::
-   :color: light
-
-   −
-
 .. index:: Control
 
 .. _control:
@@ -148,6 +68,14 @@ Priority
    sources are broadcasting with the same priority, the highest level will take precedence. The default priority on most
    sACN sources, including this program, is ``100``.
 
+Use Per-Address-Priority
+   .. _control-config-pap:
+
+   When enabled, the priority setting will be applied to only address with levels above 0%. This mode is generally only
+   compatible with sACN receivers designed by ETC (including dimmers and gateways), as it is a proprietary extension to
+   the sACN standard. Receivers that do not understand per-address-priority will behave as if the priority setting is
+   applied to the entire universe.
+
 .. _control-modes:
 
 Modes
@@ -191,19 +119,23 @@ lighting console, like the ETC Eos family.
 To assist entering correct commands, buttons that are not allowed for the current command line are shaded a darker color
 and cannot be pressed.
 
-All commands must be committed by pressing |btn_enter|.  Press |btn_clear| to backspace.  If the current command line
-has been committed (i.e. the last button pressed was |btn_enter|), pressing any button will begin a new command line.
+All commands must be committed by pressing :kbd:`Enter`.  Press :kbd:`Clear` to backspace.  If the current command line
+has been committed (i.e. the last button pressed was :kbd:`Enter`), pressing any button will begin a new command line.
+
+.. note:: Levels are always entered in the display format selected in the settings. This means if you have chosen to
+   display levels as hex, you must enter levels as hex (e.g. full is :kbd:`F` :kbd:`F`) or if you have chosen to display
+   levels as decimal (full is :kbd:`2` :kbd:`5` :kbd:`5`).
 
 Some example command lines:
 
-* |btn_1| |btn_at| |btn_1| |btn_0| |btn_0| |btn_enter| sets address 1 to full.
-* |btn_1| |btn_thru| |btn_5| |btn_at| |btn_5| |btn_0| |btn_enter| sets addresses 1, 2, 3, 4, and 5 to 50.
-* |btn_1| |btn_plus| |btn_3| |btn_at| |btn_5| |btn_0| |btn_enter| sets addresses 1 and 3 to 50.
-* |btn_1| |btn_thru| |btn_5| |btn_minus| |btn_3| |btn_at| |btn_5| |btn_0| |btn_enter| sets addresses 1, 2, 4, and 5
+* :kbd:`1` :kbd:`At` :kbd:`1` :kbd:`0` :kbd:`0` :kbd:`Enter` sets address 1 to full.
+* :kbd:`1` :kbd:`Thru` :kbd:`5` :kbd:`At` :kbd:`5` :kbd:`0` :kbd:`Enter` sets addresses 1, 2, 3, 4, and 5 to 50.
+* :kbd:`1` :kbd:`+` :kbd:`3` :kbd:`At` :kbd:`5` :kbd:`0` :kbd:`Enter` sets addresses 1 and 3 to 50.
+* :kbd:`1` :kbd:`Thru` :kbd:`5` :kbd:`-` :kbd:`3` :kbd:`At` :kbd:`5` :kbd:`0` :kbd:`Enter` sets addresses 1, 2, 4, and 5
   to 50.
-* |btn_1| |btn_thru| |btn_5| |btn_plus| |btn_1| |btn_0| |btn_at| |btn_5| |btn_0| |btn_enter| sets addresses 1, 2,
+* :kbd:`1` :kbd:`Thru` :kbd:`5` :kbd:`+` :kbd:`1` :kbd:`0` :kbd:`At` :kbd:`5` :kbd:`0` :kbd:`Enter` sets addresses 1, 2,
   3, 4, 5, and 10 to 50.
-* |btn_1| |btn_at| |btn_plus| |btn_1| |btn_0| |btn_enter| sets address 1 to 10 points above its current level.
-* |btn_1| |btn_at| |btn_minus| |btn_5| |btn_enter| sets address 1 to 5 points below its current level.
-* |btn_1| |btn_thru| |btn_5| |btn_at| |btn_1| |btn_0| |btn_thru| |btn_5| |btn_0| |btn_enter| sets address 1 to
+* :kbd:`1` :kbd:`At` :kbd:`+` :kbd:`1` :kbd:`0` :kbd:`Enter` sets address 1 to 10 points above its current level.
+* :kbd:`1` :kbd:`At` :kbd:`-` :kbd:`5` :kbd:`Enter` sets address 1 to 5 points below its current level.
+* :kbd:`1` :kbd:`Thru` :kbd:`5` :kbd:`At` :kbd:`1` :kbd:`0` :kbd:`Thru` :kbd:`5` :kbd:`0` :kbd:`Enter` sets address 1 to
   10, 2 to 20, 3 to 30, 4 to 40, and 5 to 50.

doc/usage/view_levels/index.rst

@@ -1,3 +1,8 @@
+.. |btn_univ| button::
+   :color: outline-secondary
+
+   Choose Universe...
+
 .. |btn_list| button::
    :color: secondary
 
@@ -32,29 +37,35 @@ If any sACN sources are active on the network, their levels are shown for the gi
 source is active, the levels from all sources is merged following the standard sACN merge rules.  Each source is
 assigned a different color; the color legend is shown by opening the "Sources" dropdown.
 
-.. note:: Per-address-priority is not currently supported in the View Levels screen.
+Universe Discovery
+^^^^^^^^^^^^^^^^^^
+
+Discovered sACN universes are shown as buttons. There is a small delay (usually around 10 seconds, but depends on the
+transmitters) from entering View Levels mode and universe discovery. Additionally, not all sACN transmitters make their
+transmitted universes discoverable. To select a universe that has not been discovered, press |btn_univ|.
 
 .. _viewlevels-modes:
 
 Modes
 -----
 
-Multiple display modes are available.
+Multiple display modes are available:
 
 .. _viewlevels-modes-list:
 
-List
+Bars
 ^^^^
 
-Press |btn_list| to show list mode.
+Press |btn_list| to show bars mode.
 
 .. figure:: screenshots/viewlevels_list.png
    :class: screenshot
 
-   List mode
+   Bars mode
 
 The given universe is shown as a list of bars, where each address has a bar showing its current level.  The color of the
-bar corresponds to the color of the winning source.
+bar corresponds to the color of the winning source. The address is shown on the left of the bar. The level and priority
+are shown on the right.
 
 
 .. _viewlevels-modes-grid:
@@ -69,6 +80,6 @@ Press |btn_grid| to show grid mode.
 
    Grid mode
 
-The given universe is shown as a grid with the first address in each row shown on the left.  The number of columns in
-each row is configurable.  Much like :ref:`List mode <viewlevels-modes-list>`, the color of the bar corresponds to the
-color of the winning source.
+The given universe is shown as a grid with the first address in each row shown on the left. Much like
+:ref:`Bars mode <viewlevels-modes-list>`, the color of the box corresponds to the color of the winning source. In each
+box, the level is shown above the priority.

mobile_sacn_webui/src/transmit/TransmitTitle.tsx

@@ -4,7 +4,7 @@ import {faBolt, faCheck, faKeyboard} from "@fortawesome/free-solid-svg-icons";
 export function TransmitLevelsTitle() {
     return (
         <span>
-            <FontAwesomeIcon icon={faKeyboard}/> Levels
+            <FontAwesomeIcon icon={faKeyboard}/> Send Levels
         </span>
     );
 }