Please Note: This page is about the configuration page but is not a guide on how to make an advanced configuration. For guides on making configurations please check out: https://wiki.skaarhoj.com/books/blue-pill-reactor/chapter/advanced-configuration
The Configuration page is described how it appears starting with Reactor v2.0.
For a more customized configuration either self constructed or to modify a default configuration used in the Mapping section it is necessary to move off of the Home page and into the Configuration page.
There are three main parts of the Configuration page, however only two of them are directly presented, Controller section for an overall view of the panels and the Inspector where parameters and behaviors are assigned to the hardware components. The third, more advanced section, is the Tree view (not pictured) where you can see the whole mapping of the configuration and gives more advanced ways to configure the panel.
The Controller sections is full of many tools to allow for navigating through the configuration and even using a fully functional simulated version of the panels.
Please note, this section may act or look different when the Tree section is open.
Starting at the top of the page, there are a few different ways to interact with the interface.
|Arrows Icon||Toggles open/close the Tree View. (see Tree section for more information)|
|Controller Icon||Toggles on/off simulation mode. When on, the graphical view of the panels acts as a real panel. When simulation mode is not on, it is in configuration mode.|
|Fingerprint Icon||Toggles on/off listening mode. When on, interacting with a physical hardware component on the Skaarhoj panel will open that component in the Inspector.|
|ABC Icon||Toggles on/off the text labels in the graphical view of the panels.|
|Panel Names||Centers graphical view on selected panel.|
|Eye Icon||Toggles on/off the view of the specific panel in the graphical view. Button turns grey when panel is not visible.|
|Fit All||Positions graphical view to show all visible panels.|
|Back Arrow Icon||Undoes the last change made in the Inspector|
|Forward Arrow Icon||Redoes the last change made in Inspector|
|History Icon||Opens the History View. See History View page for more information.|
|Question Mark||Opens the graphical view movement and color guide. See image below.|
Graphical View Image and Color Guide:
The interactive graphical view displays the panels in the current project in their current state on a grid. The layout of the panels on the grid can be adjusted from the Panel Groups interface accessible on the Home page.
Each hardware component of each panel is selectable from the graphical view to interact with, how that behaves is dependent on which mode you have enabled at the top of the Controller section.
In configuration mode clicking on one of the hardware components will open that up in the Inspector to the exact place if that hardware component has been created in the associated section of the selected configuration. If it has not been defined in the section for the configuration it will be greyed out.
Right clicking on a hardware component will open an options menu, even if the component has not been created on the section.
|Create section||Creates a new section in the configuration.|
|Add to section||Adds the hardware component to to the current section. See expanded details below.|
|Remove from section||Removes the hardware component from the current section.|
|Copy||Copies the current configuration of the hardware component to be able to be pasted.|
|Cut||Cuts out the current configuration of the hardware component to be able to be pasted.|
|Paste||Pastes the last copied or cut configuration of a hardware component to the select component.|
|Delete Behavior(s)||Deletes the current behavior or behaviors configured on the component, plus makes it transparent if it is not currently.|
|Clear Contents||Deletes the current behavior or behaviors configured on the component.|
When adding a section a pop up window will be presented where it is possible to define certain details of the section.
|Name||User defined name for the created section.|
|Transparent section||Selecting Transparent section will allow for behaviors configured on a lower layer of the tree for that hardware component to show through.
If not transparent, the hardware component will remain blank unless configured.
|Advanced||Toggles on/off Advanced for the section creation tool.|
|Layer Selection||Allows for the selection of which layer in the tree the section is created on. Available only with Advanced toggled on. See image below.|
|Cancel||Cancels the creation of a new section.|
|Submit||Submits and saves the new section.|
Layer selection filter for the section creation tool, allows for the selection of any layer in the tree for the current project.
In simulation mode, the graphical view works actually controls the panel and all connected devices. In this mode the entire graphical view will have a yellow dotted line around it.
The individual components will also have indicators on them of their use. Below is a selection of hardware components in simulation mode.
|Button||Small triangles represent left, right, top edge presses|
|Encoder and Knobs||Triangles represent direction of turn|
|PTZ Joystick Twist, Zoom Rocker, XC8 Shuttle Wheel||Arrows represent direction of twist and number is the speed component value|
|PTZ Joystick Up/Down||Arrows represent direction of movement and numbers the component value of X,Y axis|
|RCP Joystick Up/Down||Line represents the position of the virtual position of the joystick as it is not a motorized hardware component|
Right clicking on a hardware component brings up different options then it does when in configuration mode.
|Hold down||Corresponds to pressing down the button or encoder without releasing it.|
|Release button||Corresponds to releasing the hold down of the button or encoder.|
|Long press||Corresponds to a 1 second long press.|
The bottom section of the Controller section is a navigation tool to move around the configuration of each panel.
|Configuration||Select between the configuration in the project. The graphical view of the panel associated with the selected configuration will no longer be grayed out.||
|Section||Select between the different hardware component sections in the selected configuration. These sections are tied to the configuration, the pages, and the shift levels they were created on.||
|Pages||Select between the different page layers of the configuration. Using the + symbol will add more pages. See below for more detail.||
|Shift||Select between the different shift layers of the currently selected page.||
When creating a new page a pop up prompt will low for the setting of the page name and whether or not the page will be transparent or not. A Transparent page will allow for lower pages or layers in the tree to have their hardware component settings visible or available when on the new page, unless the hardware component is configured on the current layer.
Right clicking on one of the page will also preset a number of options.
|Copy||Create a duplicate copy of the clicked upon layer.|
|Rename||Rename the clicked upon layer.|
|Disable transparency||Disable the transparency for the clicked upon layer.|
|Delete||Delete the clicked upon layer.|
The Inspector is where all the hardware components have their configurations assigned and adjusted. The Inspector section can give a very simple start to getting the configuration going or can be made more complex to create more complex workflows.
When first configuring a hardware component the Inspector interface the interface will appear as below. This is the OneClick Behavior Interface.
Looking at the top of the section:
|Create behaviors||The lighter grey section indicates which specific hardware component is going to be configured, and on which configuration page and shift level it will be on.|
|Search||Search for the specific parameter to configure on the button|
|Device Grouping Toggle||Toggle between seeing OneClick Behaviors per device or per device core.|
|Create Empty Behavior||Skip OneClick Behaviors to create an empty behavior to fully configure.|
Below the upper section, the OneClick behaviors will be available either per individual device or grouped per device core depending on how the toggle is set. Below the devices have been grouped by their device cores.
Expanding one of the cores, system, or navigation menus the individual parameters become become selectable.
Not every parameter, system setting, or navigation tool is available as a OneClick Behavior. For those that are not they will need to be self configured. To select a non OneClick Behavior parameter, select Choose other Parameter.
More information coming soon.
Raw JSON Editor (Most Advanced)
The most advanced way to build or edit configurations would be via the full JSON editor. This is technically a different page from the Configuration page, however it is only accessible via the configuration page.
For users with a background in JSON, this could be the easiest and fastest way to work with our configurations. For most users, it is best to leave this section untouched as every character can effect the functionality of a configuration.
The JSON editor can be found by clicking on the Edit Raw links in the Tree on the layers with Include Files. The JSON available via these links is the Include File layers.
The JSON editor opens on its own web browser page. From here it is possible to do a few different things.
Taking a look at the top section of the page.
|Currently Active Config:||The name of the currently configuration file selected in the package. This can be shared on multiple different projects.|
|Config Link ID:||The selected link ID selected to edit. There can be multiple available per Currently Active Configuration on different layers in the tree.|
|Save Current File:||Save the current text in the JSON editor.|
|Format Code:||Format code for better layout on the page.|
|Select File:||Allows for the selection of a different configuration file to load into the currently selected layer that has an include layer. See image below.|
|Layer Configurations||Configuration files available on the Blue Pill device|
|Library Configurations||Configuration files available from Skaarhoj|
The middle section of the page contains the available different Snippets or include files within the selected configuration.
|Snippet Name||The include file name for that specific snippet.|
|Latest||Loads the latest version of the snippet into the JSON editor|
|Delete||Deletes the snippet|
|Create new snippet||Allow for the creation of a new snippet file. See image below.|
The bottom section is the JSON editor tool. Each line is numbered for easy reference and differentiation. The right hand side of the editor is a miniature version of the editor to quickly jump down to different sections for navigation.