Global

Members

(constant) PATTERN_INFOS

Source:

Methods

App()

Source:
Returns:
The App UI element.

AppContent()

Source:
Returns:
The AppContent UI element.

ConfigDropDown(patternIdx, initial, structureRef, update)

Parameters:
Name Type Description
patternIdx The index of the currently selected pattern, used to choose which set of configuration options to show.
initial The initial selected configuration index.
structureRef The string reference where the selected configuration index should be stored.
update A function to update an external data structure with the new configuration index.
Source:
Returns:
The ConfigDropDown UI element.
Generates the header object for the website. This provides links to the settings and wifi pages. It also loads the CymaSpace logo for display.
Source:
Returns:
The HTML object for the header.

LabelSpinner()

Source:
Returns:
The LabelSpinner UI element.
Parameters:
Name Type Description
isOpen If the Modal should be displayed.
onClose Should the Modal close if clicked.
Source:
Returns:
The Modal HTML object.

MultiRangeSliderWrapper(tooltip, min, max, selectedLow, selectedHigh, minRef, maxRef, update)

Parameters:
Name Type Description
tooltip The optional tooltip to be displayed when hovering the element's label.
min The minimum value selectable by the slider.
max The maximum value selectable by the slider.
selectedLow The currently selected low value.
selectedHigh The currently selected high value
minRef The structure refrence for the minimum value.
maxRef The structure reference for the maximum value.
update A function which updates an external data structure.
Source:
Returns:
The UI element itself.

NumericSlider(label, tooltip, min, max, initial, structure_ref, update)

Parameters:
Name Type Description
label The label that is displayed alongside the slider.
tooltip The optional tooltip to be displayed when hovering the element's label.
min The minimum value selectable by the slider.
max The maximum value selectable by the slider.
initial The initial value shown by the slider.
structure_ref The string reference to store values at.
update A function to update an external data structure.
Source:
Returns:
The UI element itself.

Password(prompt, password, onPasswordChange)

Parameters:
Name Type Description
prompt The prompt that explains utilization to the user.
password The currently entered password.
onPasswordChange A function that updates the parent object with the new user-entered password.
Source:
Returns:
The Password UI element.

PatternModal(isOpen, onClose)

Parameters:
Name Type Description
isOpen If the modal should be shown to the user.
onClose The function to be executed when the modal is clicked.
Source:
Returns:
The PatternModal UI element if `isOpen` is true; otherwise, `null`.

Patterns(initialID, structure_ref, update, patterns)

Parameters:
Name Type Description
initialID The pattern ID to display initially.
structure_ref The string reference to store values at.
update A function to update an external data structure.
patterns A list of patterns and their IDs.
Source:
Returns:
The UI element itself.

PatternSettings(num, patterns, advanced)

Parameters:
Name Type Description
num The ID of the pattern to display.
patterns A list of patterns and their IDs.
advanced A boolean to determine whether basic or advanced pattern setting controls are displayed.
Source:
Returns:
A group of individual components that control the devices pattern settings.

Save_Entry(name, idx)

Parameters:
Name Type Description
name The displayed name of the save slot.
idx The ID of the slot to save/load to/from.
Source:
Returns:
The Save_Entry UI element.

Settings()

Source:
Returns:
The Settings UI element.

SimpleChooser(label, tooltip, options, noSelection, initial, structure_ref, update)

Parameters:
Name Type Description
label The string label to show alongside the selector.
tooltip The optional tooltip to be displayed when hovering the element's label.
options The list of options and their IDs.
noSelection If unchecking a box is allowed. Produces an ID of 0.
initial The initial ID to select.
structure_ref The string reference to store values at.
update A function to update an external data structure.
Source:
Returns:
The SimpleChooser UI element.

Spinner()

Source:
Returns:
The Spinner UI element.

StripSettings(patterns, advanced)

Parameters:
Name Type Description
patterns An array of pattern definitions passed down to PatternSettings.
advanced A boolean indicating whether advanced settings should be displayed (default: false).
Source:
Returns:
The group of StripSettings UI elements.

SystemControls()

Source:

TextInput(inputPrompt, commmitPrompt, textValue, onTextChange, onTextCommit)

Parameters:
Name Type Description
inputPrompt The label text displayed above the text input.
commmitPrompt The label for the commit button.
textValue The externally controlled text value to display.
onTextChange Callback invoked on each change to the text (receives new text).
onTextCommit Callback invoked when the commit button is clicked (receives current text).
Source:
Returns:
The TextInput UI element.

Toast(message, type)

Parameters:
Name Type Description
message The text content of the toast to display.
type The category of the toast; if 'error', styled with a red background Otherwise, styled with a green background.
Source:
Returns:
The Toast UI element.

TooltipWrapper(id, content, offset, style, label)

Parameters:
Name Type Description
id The unique identifier for this tooltip; links the span and React Tooltip component.
content The ReactNode content to render inside the tooltip popup.
offset (Optional) The pixel offset between the trigger and the tooltip (default: 10).
style (Optional) CSS styles applied to the trigger span (default: fontSize: '1.2rem', cursor: 'pointer').
label (Optional) The ReactNode to render inside the trigger span (default: '(?)').
...props Any additional props to spread onto the trigger span (e.g., event handlers, aria attributes).
Source:
Returns:
The TooltipWrapper UI element.

useInterval(callback, delay)

Parameters:
Name Type Description
callback * The function or code to run.
delay * The delay between function calls.
Source:

Wifi()

Source:
Returns:
The Wifi UI element.

WiFiModal(isOpen, onClose, ssid, audioLuxUrl)

Parameters:
Name Type Description
isOpen If the modal should be shown to the user
onClose The function to be executed when the modal is clicked.
ssid The ssid of the bridged network.
audioLuxUrl The URL of the AudioLux on the bridged network.
Source:
Returns:
The WiFiModal UI element.