diff --git a/docs/orb-app/app-settings.md b/docs/orb-app/app-settings.md index f7f3f6e..81eebcf 100644 --- a/docs/orb-app/app-settings.md +++ b/docs/orb-app/app-settings.md @@ -19,7 +19,7 @@ The Display Language setting allows you to change the language of the Orb app in 3. Select your preferred language from the list. 4. The app will automatically update to reflect your chosen language. -Display Language +Display Language # View-Only Mode This explains the View-Only Mode setting found within the App Settings menu. @@ -31,8 +31,11 @@ View-Only Mode is a setting that disables the measurement functionality of the O 1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. 2. Toggle on the "View-Only Mode" setting. +3. When engaging View-only Mode, you will be asked if you want to unlink the device from your account. If you want to free up the space on your account when using view-only mode, choose to unlink the device. Otherwise, decline the prompt to keep this device linked to your account. -Display Language +View Only + +View Only Unlink Device # Start in background (Desktop only) This explains the Start in Background setting found within the App Settings menu on macOS and Windows. @@ -44,7 +47,7 @@ The Start in Background setting allows the Orb app to launch automatically in th 1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. 2. Toggle on the "Start in background" setting. -Display Language +Start in Background # Hide Dock Icon (macOS only) This explains the Hide Dock Icon setting found within the App Settings menu on macOS. @@ -57,7 +60,7 @@ The Hide Dock Icon setting allows you to remove the Orb app icon from the Dock o 1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. 2. Toggle on the "Hide Dock Icon" setting. -Display Language +Hide Icon Note: use the system tray icon to access the app when the Dock icon is hidden. @@ -71,23 +74,73 @@ The Launch App at Startup setting allows the Orb app to launch automatically whe 1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. 2. Toggle on the "Launch app at startup" setting. -Display Language +Launch at Startup -# Keep Awake/Sensor Mode (Mobile only) +# Live Menu Bar/System Tray (Desktop only) +This explains the Live Menu Bar/System Tray setting found within the App Settings menu on macOS and Windows. -This explains the Sensor Mode or "Keep Awake" setting found within the App Settings menu. +## What is Live Menu Bar? +The live menu bar (macOS) and System Tray (Windows) displays your current Orb Score, making it easy to keep an eye on your connectivity even when the Orb app is closed or out of view. -## What is Sensor Mode? +Live Score -Sensor Mode is an easy way to configure your Orb sensor to run continuously. Available on mobile devices, it is recommended for dedicated Orb sensors like a spare Android or spare iPhone. +## Enabling Live Menu Bar/System Tray +1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. +2. Toggle on the "Live Menu Bar" or "Live System Tray" setting. -## Engaging Sensor Mode +Live Score Setting +# Keep Awake/Sensor Mode (Mobile only) +This explains the Sensor Mode or "Keep Awake" setting found within the App Settings menu. + +## What is Keep Awake/Sensor Mode? +Sensor Mode is an easy way to configure your Orb sensor to run continuously. Available on mobile devices, it is recommended for dedicated Orb sensors like a spare Android or spare iPhone. + +## Engaging Keep Awake/Sensor Mode 1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. 2. Toggle on the "Keep Awake" setting. 3. Choose to dim your display by tapping "Dim Display" (optional). -Keep Awake +Keep Awake + +# Reduce Motion +This explains the Reduce Motion setting found within the App Settings menu. + +## What is Reduce Motion? +This setting (off by default) enables/disables the responsiveness radar ring on the Orb Score. + +## Enabling the Reduce Motion setting +1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. +2. Toggle on "Reduce Motion". + +Reduce Motion + +# Increase Contrast +This explains the Increase Contrast setting found within the App Settings Menu. + +## What is Increase Contrast +This setting (on by default) increases the contrast in the Orb app for better readability and accessibility. + +## Disabling the Increase Contrast setting +1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. +2. Togge off "Increase Contrast". + +Increase Contrast + +# Scan Hosts +This explains the Scan Hosts menu item found within the App Settings Menu. + +## What is the Scan Hosts feature? +This allows users to scan your network for devices that may not have been automatically discovered. You can scan your network for devices by searching an IP address or by an Orb Name. + +## Using the Scan Hosts feature +1. Navigate to the App Settings menu by tapping the gear icon in the top right corner of the app. +2. Navigate to the bottom of the menu. +3. Search for devices by entering a Hostname (Orb Device Name) or by IP address. +4. Select the device and click "Add" to link the Orb to your account. +5. To remove a device, tap the "Remove" button. + +Scan Hosts ## Next Steps diff --git a/images/orb-app/display-language-2.png b/images/orb-app/display-language-2.png new file mode 100644 index 0000000..81fca88 Binary files /dev/null and b/images/orb-app/display-language-2.png differ diff --git a/images/orb-app/hide-dock-icon-2.png b/images/orb-app/hide-dock-icon-2.png new file mode 100644 index 0000000..4414fb6 Binary files /dev/null and b/images/orb-app/hide-dock-icon-2.png differ diff --git a/images/orb-app/increase-contrast.png b/images/orb-app/increase-contrast.png new file mode 100644 index 0000000..dbf0610 Binary files /dev/null and b/images/orb-app/increase-contrast.png differ diff --git a/images/orb-app/keep-awake-2.png b/images/orb-app/keep-awake-2.png new file mode 100644 index 0000000..12497b4 Binary files /dev/null and b/images/orb-app/keep-awake-2.png differ diff --git a/images/orb-app/launch-startup-2.png b/images/orb-app/launch-startup-2.png new file mode 100644 index 0000000..ccf5023 Binary files /dev/null and b/images/orb-app/launch-startup-2.png differ diff --git a/images/orb-app/live-menu-setting.png b/images/orb-app/live-menu-setting.png new file mode 100644 index 0000000..83b40c2 Binary files /dev/null and b/images/orb-app/live-menu-setting.png differ diff --git a/images/orb-app/live-score.png b/images/orb-app/live-score.png new file mode 100644 index 0000000..8e882c4 Binary files /dev/null and b/images/orb-app/live-score.png differ diff --git a/images/orb-app/reduce-motion.png b/images/orb-app/reduce-motion.png new file mode 100644 index 0000000..0b41f24 Binary files /dev/null and b/images/orb-app/reduce-motion.png differ diff --git a/images/orb-app/scan-hosts.png b/images/orb-app/scan-hosts.png new file mode 100644 index 0000000..8659f01 Binary files /dev/null and b/images/orb-app/scan-hosts.png differ diff --git a/images/orb-app/start-background-2.png b/images/orb-app/start-background-2.png new file mode 100644 index 0000000..88ae396 Binary files /dev/null and b/images/orb-app/start-background-2.png differ diff --git a/images/orb-app/view-only-2.png b/images/orb-app/view-only-2.png new file mode 100644 index 0000000..5f46d25 Binary files /dev/null and b/images/orb-app/view-only-2.png differ diff --git a/images/orb-app/view-only-unlink-device.png b/images/orb-app/view-only-unlink-device.png new file mode 100644 index 0000000..83ece13 Binary files /dev/null and b/images/orb-app/view-only-unlink-device.png differ