Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
istnv committed Mar 11, 2023
1 parent 8db6939 commit 486f182
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions companion/HELP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ to get additional information about the consoles and their capabilities.
## Configuration
**Target IP:** Enter the IP address of the Mixer

**Scan for XAir Mixers?** Module will scan for XAir mixers on the network

**Select mixer by Name** Choose a mixer from those located on the network

**Note* Once a mixer (name) is chosen, the module will attempt to re-locate it if the IP changes. This feature can be disabled by un-checking the *Scan for Mixers* option

## Supported Actions
Console Function | What it does
-----------------|---------------
Expand Down Expand Up @@ -53,6 +59,8 @@ Variable | Description
**$(INSTANCENAME:m_fw)** | Mixer Firmware
**$(INSTANCENAME:s_name)** | Current Snapshot Name
**$(INSTANCENAME:s_index)** | Current Snapshot Number
**$(INSTANCENAME:s_name_n)** | Next Snapshot Name
**$(INSTANCENAME:s_name_p)** | Prior Snapshot Name
**$(INSTANCENAME:s_name_{num})** | Name of Snapshot {num} **see notes*
**$(INSTANCENAME:l_lr)** | Label on LR/Main
**$(INSTANCENAME:l_rtn_aux)** | Label on USB/Aux return
Expand Down

0 comments on commit 486f182

Please sign in to comment.