Skip to content

Commit

Permalink
Updated basic usage to reflect new devices
Browse files Browse the repository at this point in the history
  • Loading branch information
LivingSynthesis committed Jan 16, 2025
1 parent 786ce59 commit 870bc91
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 8 deletions.
43 changes: 37 additions & 6 deletions docs/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,57 @@ parent: Vortex Engine
---

# Basic Usage
When a Vortex device is first turned on it will always start on the first [Mode](modes.html).
While all Vortex devices work nearly indentically, each device has slightly different features. Check a devices page to better understand it's unique features.

You can think of a _mode_ as the colorful blinking pattern that is playing on the leds.
- [Spark Orbit](Spark_Orbit_guide)
- [Spark Handle](Spark_Handle_guide)
- [Chromadeck](Chromadeck_guide.html)
- [Duo](duo_guide)
- [Vortex Orbit](orbit_guide)
- [Omega Handle](handles_guide)
- [Vortex Glove](gloves_guide)

Some devices have more _modes_ than others, but each device is able to access all the modes and enter menus using the _navigation buttons_.
# Inputs

Menus allow you to program your device, such as changing the colors, blinking patterns, brightness, or even transferring modes to other devices.
## Power Switch
Most devices can be powered on or off by toggling the power switch. The Duo is powered on and off with its navigation button.

## Buttons
Each device has at least 1 button.

## Navigating
There are three ways to use the _navigation buttons_ on your device: **short clicks**, **long clicks**, and **holds**

1. A **short click** is like saying '_next please_', to cycle through options
2. A **long click** is like saying '_this one please_', to select an option
3. And finally, **holds** are primarily used to open the menus

Some devices have 2 buttons. A **long click** on the second button is like saying '_nevermind_', or '_back_', and returns to displaying modes.
Some devices have 2 or 3 buttons. These allow for more options while navigating the menus.

Almost everything can be achieved with only **short** and **long** clicks.

Those are the basics of controlling a Vortex Device.

Next, try opening the menus by **holding** the navigation button till the leds blink white, then continue reading more over at [The Menus](menus.html)

# Key Terminology

## Mode

You can think of a [_Mode_](modes.html) as the colorful blinking pattern that is playing on the leds.

## Menu

[_Menus_](menus.html) allow you to program your device, such as changing the colors, blinking patterns, brightness, or even transferring modes to other devices.

## Pattern

A [_Pattern_]() is one of the two main components of a mode. The pattern determines the way in which a mode will blink. This can affect the frequency and duration of strobes as well as the order in which colors are displayed.

## Colorset

A [_Colorset_](colorsets.html) is the other main component of a mode. This is a set of up to 8 colors which a pattern will use. A single colorset and pattern together are the simplest version of a mode.

## LED

All Vortex devices are comprised of at least 2 LEDs and some have over 20. In a single mode, each LED on the device can have its own Colorset and Pattern. The simplest modes will have the same pattern and colorset on each LED, while the most complex will have a unique pattern and colorset on every LED.

4 changes: 2 additions & 2 deletions docs/getting_started_classic_devices.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: default
title: Getting Started
title: Getting Started (Classic)
nav_order: 0
parent: Vortex Engine
parent: Getting Started
has_children: true
---
<style>
Expand Down

0 comments on commit 870bc91

Please sign in to comment.