PathfinderPrototyping · St. Paul MN

Corsair XENEON EDGE · iCUE widget companion

XENEON EDGE Companion

The ObsidianEdge widget puts your Obsidian vault on the XENEON EDGE touchscreen. A widget package can only carry web files, so the part that talks to Obsidian is this small plugin. It runs inside Obsidian on your own PC and answers the widget over a loopback address. No internet, no account, no telemetry.

Coming soon. The ObsidianEdge widget is not on the Elgato Marketplace yet. If you want it sooner as a standalone install, email [email protected]. Every XENEON EDGE widget and where it stands: the XENEON EDGE page.

Download the companion (28 KB)

Version 0.2.0 · Obsidian 1.5 or newer on Windows · free

SHA-256 edd8427aae8859ccf9355ff818de399518ad7d71ff957043cc86db901f931238 · 28,788 bytes · all releases

Install in three steps

This page covers the companion. The ObsidianEdge widget itself is installed in iCUE (Home, then XENEON EDGE, then Widgets). It is not on the Elgato Marketplace yet. Give it a page of its own at Extra Large: the Reader page and the Navigator page want the whole panel.

  1. Install the companion in Obsidian

    The quickest path today is BRAT, the community "Beta Reviewers Auto-update Tool": install BRAT from Community plugins, open its settings, choose "Add beta plugin", paste https://github.com/YnotLiveLyfe/edge-companion and add it. BRAT installs the companion and keeps it current. Once the companion is listed in Obsidian's community directory it will be one search away under Community plugins, Browse.

    By hand instead: unzip the download above and copy the edge-companion folder into <your vault>\.obsidian\plugins\. The folder holds main.js, manifest.json, styles.css and a README; the code is plain JavaScript you can read, and the source lives at github.com/YnotLiveLyfe/edge-companion.

  2. Enable it in Obsidian

    Settings, then Community plugins, then turn on XENEON EDGE Companion. It listens on 127.0.0.1:47610 while Obsidian runs. Change the port in the plugin's settings if something else uses it, and set the widget's Helper port setting in iCUE to the same number.

  3. Allow localhost once when iCUE asks

    The first time the widget reaches the companion, iCUE shows a permission request for a localhost address. That address is the companion on your own PC. Allow it; iCUE asks only once. The panel says "Companion connected" and follows whatever note is open in Obsidian.

The ObsidianEdge widget's setup screen on the XENEON EDGE: this page's address and the three companion setup steps

Turn the XENEON EDGE's pages from the panel

iCUE turns the XENEON EDGE's pages with two keystrokes you record once in iCUE: hover the XENEON EDGE, open Screen Setup, set Previous Display Screen to Ctrl+Alt+Shift+PageUp and Next Display Screen to Ctrl+Alt+Shift+PageDown.

With those recorded, the chevrons in the widget's header turn the pages, and the companion brings the ObsidianEdge page up whenever Obsidian comes to the front while the XENEON EDGE shows another page (setting "Jump to the ObsidianEdge page when Obsidian comes forward", on by default). The keys fire only while Obsidian is the active window, so a chevron tap from another app brings Obsidian forward first. If you recorded other keys, type them into the plugin's two settings.

What the companion does, and does not do

If the panel says "Companion not running"

Still stuck? Email [email protected] with the widget version from iCUE and the companion version from Obsidian's plugin list.