Skip to main content

On-Deck Tools Menu

The most important device settings are available directly on the Stream Deck, with no browser and no network access. That helps when there is no computer within reach or the FrenschPress is not reachable on the network.

Opening and closing​

The tools key sits in the lower-right corner by default and is always reserved. It shows the white FrenschConnection logo on black. In the web interface you can drag it to another position, see Mapping keys.

ActionEffect
Hold for 2 secondsOpens the tools menu
Tap (EXIT)Closes the menu and restores the normal view
Short tap (menu closed)Depending on Tools button short press: nothing, one page forward, or the next button set
Hold an unassigned key for 2 secondsOpens the macro list for that key straight away, see Quick mapping

While the menu is open, the key turns red and reads EXIT.


Top level​

The menu starts with category keys only. Every setting sits one level down. That keeps the entry point the same on every deck size and leaves room for categories added later.

NET TIME CTRL DISP BRT+
CODE MODE
MIDI OSC . . BRT-
MAP . . . EXIT
KeyContents
NETNetwork: Ethernet and Wi-Fi, each with DHCP/static and its own address editor, address readout, Access Point
TIME CODEArt-Net TC, timelines
CTRL MODEControl mode and whatever that mode brings with it: button set and preset recall, QLab transport, or the Companion host
DISPEverything that only decides what the deck shows: timecode row, transport row, QLab row, logo backdrop
MIDIRTP-MIDI (network MIDI)
OSCOSC listen port, plus the network scan in QLab OSC mode
MAPMap a macro to deck keys and, in Custom Mode, to the device's own buttons, or clear them; see MAP
BRT+ / BRT-Brightness in steps of 10, minimum 10 %

The category keys fill the top row from left to right and then wrap into the next row. A deck with more columns fits more categories on the first row.

MAP has a fixed place: third row, first column (bottom left on a Stream Deck MK.2). On a deck without that cell, MAP takes its place in reading order.

Category keys carry their category's hue but no state. Each one holds several settings, so a single "on" tint would tell you nothing.

Brightness​

Both brightness keys show the current value (BRT+ 70%). The change applies immediately and is saved 1.5 s after the last tap. The keys sit in the last column, above the reserved EXIT key. On a two-row deck, BRT- moves into the cell to its left so the pair stays together.

Decks with encoders

On a deck with encoders, brightness moves to the last knob and the two keys are dropped. The categories can then use the full width. From three encoders upwards, the third knob also pages through lists, which frees the two PREV/NEXT cells for entries.


Colours​

The hue shows the category, the brightness shows the state. One key reads as "network, currently off" without two separate colour scales. All tones are deliberately muted: the menu sits next to the operating keys and should not draw the eye.

CategoryColour
Timecode and MIDITeal
Network and OSCSteel blue
Network scan while it runsBrighter steel blue
ControlAmber
Preset recallViolet
Active preset / active button setTeal
Display (DISP) and brightnessNeutral grey
Readout-only keys (address octets, interface tag, Companion host)Black
A key that exists but is currently locked outVery dark grey
Navigation (BACK, PREV, NEXT)Slate
EXITRed

Paging​

A submenu is a flat list in reading order, with BACK on the last slot. When a list does not fit on one page, the two slots before BACK become PREV and NEXT. EXIT stays on the reserved key everywhere.

The NET and CTRL MODE pages use a fixed grid instead, as long as the deck has every cell they need free. There, each key always sits in the same place. Where the grid does not fit (Stream Deck +), the page falls back to the paged list in reading order.


NET​

KeyFunction
Address keysFour keys, one octet each, with the matching subnet octet below. On black: a readout, not a control. With no address they read NO IP.
ON ETH / ON WIFI / NO LINKShows which interface the octet keys are reading from. The address alone does not tell you whether the FrenschPress is on the cable or on Wi-Fi.
ETH DHCP / ETH STATSwitches Ethernet between DHCP and a static IP
ETH ADDROpens the editor for the static Ethernet address
WIFI ON / WIFI OFFThe Wi-Fi setting, not the radio itself. With Ethernet up, Wi-Fi stays off regardless, exactly as the checkbox in the web interface shows.
WIFI DHCP / WIFI STATDHCP or a static IP for Wi-Fi
WIFI ADDROpens the editor for the static Wi-Fi address
AP ON / AP OFFTurns the configuration Access Point on or off
USB NET ON / USB NET OFFTurns USB Network on or off, the network adapter on the USB port

Each toggle has its address key immediately to its right, so you always read both halves of a setting together.

If a new DHCP lease arrives while the page is open, only the address keys are redrawn.

ETH ADDR and WIFI ADDR are visible but greyed out and inactive while DHCP is on. A static value would be overwritten at the next lease renewal anyway.

USB Network restarts the FrenschPress

The USB description is fixed once the USB stack is running, so the switch only takes effect after a restart. The key asks once and reads REBOOT?. Only a second press within a few seconds writes the setting and restarts.

Do not turn USB Network on in passing. A computer connected at the same time through its own network port and through USB, in the same IP range, can make a show network unusable. The conditions are under USB Network.

Stream Deck +

On a deck with a touch strip, this page keeps only ETH DHCP/STAT, WIFI ON/OFF, WIFI DHCP/STAT, WIFI ADDR and AP ON/OFF. The full Ethernet address is shown in one piece on the window. You open its editor by touching the value or pressing the encoder below it. The Wi-Fi address has no field of its own on the window, so its key stays.

Static address editor​

The same editor serves both interfaces. The key on the far right shows what you are editing (ETH ADDR, WIFI ADDR, COMP HOST). When the editor opens, it reloads the values of that interface, so switching does not carry the other interface's octets across.

You edit address, mask and gateway together and write them with one APPLY. Applied one at a time, they would pass through states such as "new address, old gateway" that cut off everything outside the subnet.

  • The field keys show the pending values, so you can read the whole configuration without opening each field. An empty gateway reads GW OFF.
  • On a field page the selected octet is highlighted. There are coarse and fine steps, because 0–255 in single steps would take far too many taps. Values wrap at the ends: one step down from 0 lands on 255 and vice versa. This applies to every step size, on the encoder too.
  • On a deck without four free cells in the second row (Stream Deck +), only -1/+1 remain and the coarse steps are dropped.
  • The mask cycles through /24, /16 and /8 on its own key. Set any other mask in the web interface.

APPLY rejects mistakes that are easy to make on a deck and hard to track down later:

  • an unusable address (0.x, 224.x and up)
  • a mask that is not a continuous run of ones
  • the network or broadcast address itself
  • a gateway outside the subnet or equal to the address

0.0.0.0 counts as "no gateway". The key confirms with OK or ERR.

APPLY is amber while your input differs from what is applied. BACK keeps your input; closing the menu discards it.


TIME CODE​

KeyFunction
ART TC ON / ART TC OFFArt-Net timecode
TIME LINEOpens the timeline list. Teal while at least one timeline is armed.

Whether the timecode display appears on the deck is set under DISP. That page holds everything that only concerns what is shown.

Timeline list​

TIME LINE opens a paged list of the configured timelines, with BACK on the last slot. Each key shows the timeline name on two lines of five characters. Armed timelines are teal; disarmed ones carry the recall hue.

A tap arms or disarms that timeline, using the same call and the same storage as the web interface and OSC. Only that one key is redrawn.

note

The list is read once when the page opens. If someone arms a timeline elsewhere while the page is open, you see it after leaving and reopening the page.


DISP​

This page holds every setting that only decides what the deck shows. A row is offered only where the deck can actually display it, so the page never shows a switch without effect.

KeyFunction
TC DISP ON / TC DISP OFFTimecode display on the deck
TRANS ON / TRANS OFFTransport row (STOP/GO/PAUSE)
QLAB ON / QLAB OFFQLab standby row
LOGO ON / LOGO OFFLogo backdrop on unmapped keys
LOAD LAYOpens the list of stored layouts

The logo backdrop is only available on key-only decks. On a deck with a touch strip, this key is absent.

LOAD LAY sits last on purpose. It is the only key on the page that does not toggle something but leaves the page.

Layout list​

A paged list of the layouts that fit the attached deck, with BACK on the last slot. Names are shown on two lines of five characters. The layout currently loaded is teal. While the list loads, the key reads LOAD WAIT; with no layouts stored, NO LAYS.

One tap loads

There is no confirmation. A layout replaces the whole deck configuration: mappings, labels, colours, display rows, pages. You only get the previous state back if you stored it first. The list sits two menu levels deep so this does not happen by accident.

The key confirms with OK or ERR. The menu stays open and is redrawn. The new mapping is underneath and appears when you close the menu.


MIDI​

KeyFunction
RTP ON / RTP OFFRTP-MIDI (network MIDI)

OSC​

KeyFunction
OSC 53001Shows the current OSC listen port and opens its editor
SCAN NETBackground mDNS scan for QLab, GoButton and FrenschPress peers. QLab Mode with OSC transport only.

The scan finds QLab's OSC targets and binds them, so it sits next to the port it shares an interface with. It is available here under the same condition as its second key on the CTRL MODE page: in any other mode it would overwrite QLab targets nobody meant to change.

While the scan runs, the key reads SCAN WAIT and the FrenschPress LEDs play the same blue chase as the QLab scan. The three result counts then appear on the scan key (Q1G2 F3).

OSC listen port editor​

Tapping the OSC key opens the editor for the OSC listen port. This is the UDP port on which the FrenschPress receives incoming OSC commands. It is the same value as OSC Input Port in the web interface.

note

This is not a target or output port. Where the FrenschPress sends OSC is set per network target; this editor does not change it.

  1. Change the value in steps of 1, 10, 100 or 1000. The range is 1024–65535.
  2. Press APPLY. The FrenschPress now receives OSC on the new port and rebuilds QLab feedback if needed.
  3. Change your sending devices to the new port.

BACK keeps the value you have not applied yet; closing the menu discards it.


CTRL MODE​

The page consists of MODE plus the keys the active mode brings with it. MODE keeps the same cell in every mode, so the key under your finger does not move when the mode changes.

KeyFunction
DECK COMP ON / DECK COMP OFFHands only the deck to Companion, or back to local macros, independently of the FrenschPress mode. The tools menu stays available.
MODE QLAB / MODE CUSTOM / MODE COMPANIONCycles the control mode in the same order as the PUSH+GO combination: QLab → Custom → Companion. Unlike there, Companion is never skipped. Here you can select Companion even without a host and set up the host afterwards.

Custom Mode​

KeyFunction
SET A / SET B / SET CActive button set, one key per set. The active set is teal.
LOAD PRESPreset picker, see Preset recall

Each set has its own key instead of one key that cycles. You see the active set without pressing anything, and every set is one press away.

QLab Mode​

KeyFunction
QLAB MSC / QLAB OSCSwitches the transport between MSC over MIDI and OSC over the network. The key carries the network hue because it sets the network side of QLab Mode.
SCAN NETThe same scan as on the OSC page, here next to the transport choice. Under MSC there is nothing to find, because that path runs over MIDI, so the key is absent.

MODE and the transport key keep their cells whether the scan key is shown or not.

Companion Mode​

KeyFunction
Host keysThe Bitfocus Companion host on four keys, like every other address on the deck. Companion can set the host itself through the discovery endpoint, so the readout can change while the menu is open.
SET HOSTOpens the address editor, here without mask and gateway

The host is free text and may be a name instead of an address. A name does not fit on four octet keys, so the first key then reads BY NAME. With no entry, it reads NO HOST.

Stream Deck +

With a window, you read and edit the host there, exactly as the address on the NET page. The keys are dropped.

Preset recall​

LOAD PRES lists the same presets as the web interface: the built-in empty and TC Master Clock entries, user presets and plugin presets. Names are shown on two lines of five characters (TC Master Clock becomes TC MASTE). The active preset is teal. While the list loads, the key reads LOAD WAIT; with an empty list, NO PRES.

  1. Pick a preset. It is not recalled yet.
  2. Pick the target button set: SET A, SET B, SET C or ALL SETS. BACK cancels.
  3. The key confirms with OK or ERR.

After a successful recall, the FrenschPress is in Custom Mode with the chosen set active. You can use the new mappings straight from the deck.


MAP​

MAP lets you map keys right on the deck, without a browser. You can pick any macro stored on the FrenschPress. New macros are still created in the web interface.

  1. Choose the target: tap a deck key, or use a device button or the encoder.
  2. Choose the action: ASSIGN or CLEAR.
  3. For ASSIGN, pick a macro from the macro list.
  4. Confirm with CONFIRM.

Choosing the target​

MAP shows the normal mapping of the active page, so you recognise the key by its usual label, position or image. Title: MAP: SELECT.

ActionTarget
Tap a deck keyThat key on the active page
Press STOP, GO or PAUSE on the FrenschPressThat device button, in the currently active button set. Custom Mode only.
Turn the encoder on the FrenschPressENC LEFT or ENC RIGHT. Custom Mode only.
Push the encoderENC PUSH. Custom Mode only.
Turn the encoder while pushedPUSH LEFT or PUSH RIGHT. Custom Mode only.
EXITCancels

The reserved tools key itself is not a target.

Action​

The next page (MAP: ACTION) shows:

KeyContents
TargetThe chosen control, e.g. KEY 3 PG 1 or GO SET B
ASSIGNOpens the macro list
CLEAREmpties the target. Greyed out when nothing is on it.
Macro nameThe current mapping, on black, readout only
BACKBack to choosing the target

Macro list​

ASSIGN lists every macro alphabetically, names on two lines of five characters. When the list does not fit on one page, page through it with PREV and NEXT. While it loads, the key reads LOAD WAIT; with no macros at all, NO MACROS.

Confirming​

After your choice, MAP: CONFIRM asks once. The page shows the target, the macro (or CLEAR), CONFIRM and CANCEL. Only CONFIRM writes and saves the mapping. The menu closes and the new mapping is live at once. If saving fails, the key shows ERR.

TargetASSIGNCLEAR
Deck keySets the macro and uses its name as the label. Colours and images stay.Empties the key completely: macro, text, colours and images. It is then like a key that was never set. Image files that a saved layout still uses stay in storage.
Device button / encoderSets the macro in the button set that was active when you chose the targetRemoves the macro from that set

The change shows up in the web interface straight away: on the Streamdeck page or in the Custom Mode controller view.

CLEAR also removes grandMA3 images

Keys that carry only an image, for example one sent by grandMA3, can be emptied with CLEAR as well.

Quick mapping​

The shortest route for an unassigned key: with the menu closed, hold the key for 2 seconds. The menu opens straight in the macro list for that key. From there, continue with Confirming. BACK in the list closes the menu again.

"Unassigned" means no macro. A key that only carries text, a colour or an image counts as unassigned. A key with a macro fires its macro as usual when held; change it via MAP. Quick mapping is blocked in lock mode.


Troubleshooting​

SymptomCauseFix
Holding a key does not open the macro listThe key already has a macro, or lock mode is onChange mapped keys via MAP. Leave lock mode.
ETH ADDR / WIFI ADDR is greyed outDHCP is on for that interfaceSwitch to ETH STAT or WIFI STAT first
APPLY shows ERRAddress, mask and gateway do not fit togetherCheck the values against the list under Static address editor
WIFI ON is selected but Wi-Fi stays offEthernet is upIntended: with Ethernet up, Wi-Fi stays off
SCAN NET is missingThe FrenschPress is not in QLab Mode with OSC transportUnder CTRL MODE, select QLab Mode and QLAB OSC
The timeline list shows an old stateThe list is only read when the page opensLeave the page and reopen it