docs: Update README and add Configuration Updates document to reflect new app-based settings management

Clon1998 · Clon1998 · commit 431204e3bf54 · 2025-04-27T12:37:13.000+02:00
diff --git a/README.md b/README.md
@@ -176,34 +176,35 @@ The Mobileraker Companion is designed to support multiple printers. If you are u
 Alternatively, you can manually edit the `mobileraker.conf` file to add a new `[printer <Name>]` section for each printer. Refer to the following section for detailed information about the configuration format.
 
 # Companion - Config
-By default, you don't need to create a config file. However, if you want to use multiple printers with a single Companion instance, enforce logins via Moonraker, or modify the notification behavior, you can customize the configuration. Below is an overview of the available sections and configurations
+
+The Companion is designed to work with minimal configuration, prioritizing settings from the Mobileraker app when available. For a detailed guide on the new configuration system, please see [Configuration Updates](docs/Configuration_Updates.md).
+
+## Configuration Sources
+
+Settings are now applied in the following order of priority:
+
+1. **Device-specific settings** from the Mobileraker app
+2. **Global app settings** (if device inherits global settings)
+3. **Configuration file** (fallback for older app versions)
+4. **Default values**
+
+## Configuration File
+
+While most settings can now be managed through the app, you can still use the configuration file for basic setup. The configuration file supports the following sections and options:
 
 ```properties
 [general]
-language: en 
-# !!! DEPRECATED. The app now syncs the app's language to the companion
-# one of the supported languages defined in i18n.py#languages (de,en,...)
-# !!! For users from the UK: entering 'uk' will resolve to Ukrainian language, not English. Use 'en' for English!
-# Default: en
 timezone: Europe/Berlin 
 # correct timezone e.g. Europe/Berlin for Berlin time or US/Central. 
 # For more values see https://gist.github.com/heyalexej/8bf688fd67d7199be4a1682b3eec7568
 # Default: Tries to use system timezone
 # Optional
-eta_format: %%d.%%m.%%Y, %%H:%%M:%%S
-# Format used for eta and adaptive_eta placeholder variables
-# For available options see https://strftime.org/
-# Note that you will have to escape the % char by using a 2nd one e.g.: %d/%m/%Y -> %%d/%%m/%%Y
-# Default: %%d.%%m.%%Y, %%H:%%M:%%S
-# Optional
 include_snapshot: True
-# !! SUPPORTER ONLY - This feature requires beeing a supporter of Mobileraker as of now!
+# !! SUPPORTER ONLY - This feature requires being a supporter of Mobileraker as of now!
 # Include a snapshot of the webcam in any print status/progress update notifications
 # Default: True
 # Optional
 
-
-
 # Add a [printer ...] section for every printer you want to add
 [printer <NAME OF YOUR PRINTER: optional>]
 moonraker_uri: ws://127.0.0.1:7125/websocket
@@ -214,63 +215,61 @@ moonraker_api_key: False
 # Moonraker API key if force_logins or trusted clients is active!
 # Default value: False
 # Optional
-snapshot_uri: http://127.0.0.1/webcam/?action=snapshot
-# !! SUPPORTER ONLY - This feature requires beeing a supporter of Mobileraker as of now!
-# The ABSOLUT url to the webcam, the companion should make a screenshot of. 
-# Default: 
-# Optional
-snapshot_rotation: 0
-# The rotation applied to the image. Valid values : 0, 90, 180, 270
-# Default: 0
-# Optional
-ignore_filament_sensors:
-# Comma separated list of filament sensors to ignore, ignored filament sensors do not trigger 
-# a notification if they are triggered. This is useful if you have a filament sensor that is used
-# in a MMU setup like ERCF.
-# IMPORTANT, do not include the sensor type. E.g. if your sensor is configured
-# like: [filament_switch_sensor printhead_sensor] add `printhead_sensor` to the list.
-# Default: empty
-# Optional
-
 ```
-> [!IMPORTANT]
-> Please note that the configuration entry for the printer's Moonraker endpoint is `moonraker_uri`, not `moonraker_url`. It's a common mistake to confuse these two. Ensure you're using the correct key in your configuration.
 
+## Settings Managed in the App
 
-The Companion searches for a `Mobileraker.conf` file in the following locations (in order of precedence):
-1. `~/Mobileraker.conf`
-2. `<mobileraker_companion DIR>/mobileraker.conf`
-3. `~/printer_data/config/mobileraker.conf`
-4. `~/klipper_config/mobileraker.conf`
+The following settings are now managed through the Mobileraker app (v2.8.8+) rather than the configuration file:
+
+- **Language**: Set in app Settings > App > Language
+- **Time Format**: Choose between 12h and 24h formats
+- **Webcam Selection**: Select from webcams configured in Moonraker
+- **Filament Sensor Exclusions**: Configure which sensors to ignore per device
 
+## Backward Compatibility
+
+For compatibility with older app versions, the following configuration options are still supported in the configuration file, but will be overridden by app settings when available:
 
-A single Companion instance can support multiple printers. To configure multiple printers, add more `[printer ...]` sections to your config. Here's an example of a multi-printer config:
-Example multi-printer config: 
 ```properties
-[printer V2.1111]
-moonraker_uri: ws://127.0.0.1:7125/websocket
-# Define the uri to the moonraker instance.
-# Default value: ws://127.0.0.1:7125/websocket
-moonraker_api_key: False
-# Moonraker API key if force_logins or trusted clients is active!
+[general]
+language: en 
+# !!! DEPRECATED. The app now syncs the app's language to the companion
+# For users from the UK: entering 'uk' will resolve to Ukrainian language, not English. Use 'en' for English!
+# Default: en
+eta_format: %%d.%%m.%%Y, %%H:%%M:%%S
+# !!! DEPRECATED. Now derived from the time format preference in the app
+# Format used for eta and adaptive_eta placeholder variables
+# Default: %%d.%%m.%%Y, %%H:%%M:%%S
 
-[printer Ratty]
-moonraker_uri: ws://ratrig.home:7125/websocket
-# Define the uri to the moonraker instance.
-# Default value: ws://127.0.0.1:7125/websocket
-moonraker_api_key: False
-# Moonraker API key if force_logins is active!
-ignore_filament_sensors: printhead_sensor, sensor_name2
+[printer <NAME>]
+snapshot_uri: http://127.0.0.1/webcam/?action=snapshot
+# !!! DEPRECATED. Now uses webcam selection from app with Moonraker webcam API
+# The ABSOLUTE url to the webcam for snapshots
+snapshot_rotation: 0
+# !!! DEPRECATED. Now uses rotation from webcam configuration in Moonraker
+# Valid values: 0, 90, 180, 270
+# Default: 0
+ignore_filament_sensors:
+# !!! DEPRECATED. Now configured per device in the Mobileraker app
+# Comma separated list of filament sensors to ignore
 ```
 
+The Companion searches for a `Mobileraker.conf` file in the following locations (in order of precedence):
+1. Path provided via `-c` parameter
+2. `~/Mobileraker.conf`
+3. `<mobileraker_companion DIR>/mobileraker.conf`
+4. `~/printer_data/config/mobileraker.conf`
+5. `~/klipper_config/mobileraker.conf`
+
+> [!IMPORTANT]
+> Please note that the configuration entry for the printer's Moonraker endpoint is `moonraker_uri`, not `moonraker_url`. It's a common mistake to confuse these two. Ensure you're using the correct key in your configuration.
+
 > [!NOTE]
->   Please restart the system service to ensure the new config values are used. 
-> You can do this by running the following terminal command:  
+> Please restart the system service after editing the configuration file:  
 > ```bash
 > sudo systemctl restart mobileraker.service
 > ```
 
-
 # Moonraker - Update manager
 In order to get moonrakers update manager working with the companion add the following section to your `moonraker.conf`. 
 ```
diff --git a/docs/Configuration_Updates.md b/docs/Configuration_Updates.md
@@ -0,0 +1,113 @@
+# Mobileraker Configuration Updates
+
+The v0.5.0 version of Mobileraker Companion introduces significant improvements to how configuration is managed, moving away from relying on the configuration file and instead using settings from the Mobileraker app. This document explains these changes and how they affect your setup.
+
+## Table of Contents
+- [Mobileraker Configuration Updates](#mobileraker-configuration-updates)
+  - [Table of Contents](#table-of-contents)
+  - [Overview of Changes](#overview-of-changes)
+  - [New Settings in the App](#new-settings-in-the-app)
+  - [Configuration Priority](#configuration-priority)
+  - [Simplified Configuration File](#simplified-configuration-file)
+  - [Migration Guide](#migration-guide)
+  - [Webcam Integration](#webcam-integration)
+  - [Frequently Asked Questions](#frequently-asked-questions)
+
+## Overview of Changes
+
+Mobileraker Companion now prioritizes settings from the app over the `Mobileraker.conf` file, providing a more streamlined user experience. The following settings have been moved from the configuration file to the app:
+
+1. **Language**: Set in the app and synced to the companion
+2. **Time Format**: Choose between 12h and 24h formats in the app
+3. **Webcam Selection**: Select from configured webcams in Moonraker
+4. **Filament Sensor Exclusions**: Configure which sensors to ignore per device
+
+This change enables device-specific configurations, allowing different devices to have different settings for the same printer.
+
+## New Settings in the App
+
+The following settings are now managed through the Mobileraker app:
+
+| Setting | Description | Location in App |
+|---------|-------------|----------------|
+| Language | Interface language | Settings > App > Language |
+| Time Format | 12h or 24h time display | Settings > App > Time Format |
+| Webcam Selection | Choose specific webcam for notifications | Settings > Printer > Notifications > Webcam |
+| Filament Sensor Exclusions | Ignore specific filament sensors | Settings > Printer > Notifications > Excluded Sensors |
+
+## Configuration Priority
+
+Settings are now applied in the following order of priority:
+
+1. **Device-specific settings** from the app
+2. **Global app settings** (if device is set to inherit global settings)
+3. **Configuration file** (as fallback for older app versions)
+4. **Default values**
+
+This ensures backward compatibility while providing the benefits of device-specific settings.
+
+## Simplified Configuration File
+
+With many settings now managed in the app, your `Mobileraker.conf` file can be simplified to include only necessary information. Here's an example of a minimal configuration:
+
+```ini
+[general]
+timezone: Europe/Berlin
+include_snapshot: True
+
+[printer My Printer]
+moonraker_uri: ws://192.168.1.10:7125/websocket
+moonraker_api_key: False
+```
+
+The following settings can now be removed from your configuration file as they're managed in the app:
+
+- `language`
+- `eta_format` (derived from time format preference)
+- `snapshot_uri` (derived from webcam selection)
+- `snapshot_rotation` (derived from webcam configuration)
+- `ignore_filament_sensors` (managed per device in app)
+
+## Migration Guide
+
+To migrate to the new configuration system:
+
+1. **Update Mobileraker Companion** to the latest version
+2. **Update the Mobileraker App** to version 2.8.8 or later
+3. **Configure your webcams** in Mainsail or Fluidd
+4. **Set your preferences** in the Mobileraker app
+5. (Optional) **Simplify your configuration file** by removing settings now managed in the app
+
+Your existing configuration file will continue to work as a fallback, so this migration doesn't require immediate changes.
+
+## Webcam Integration
+
+The companion now integrates directly with Moonraker's webcam API, providing several advantages:
+
+- **Configuration Sync**: Webcam settings (rotation, flipping) are automatically synced from Mainsail/Fluidd
+- **Multiple Webcams**: Different devices can use different webcams for the same printer
+- **No URI Management**: No need to manually specify webcam URIs - just select from configured webcams
+
+To use this feature:
+
+1. Configure your webcams in Mainsail or Fluidd
+2. In the Mobileraker app, go to Settings > Printer > Notifications
+3. Select your preferred webcam from the dropdown list
+4. The companion will automatically use the selected webcam for notifications
+
+## Frequently Asked Questions
+
+**Q: Do I need to update my configuration file?**  
+A: No, your existing configuration file will continue to work. The new settings in the app will take precedence when available.
+
+**Q: Will my device-specific settings affect other devices?**  
+A: No, each device can have its own settings for the same printer.
+
+**Q: What happens if I use an older version of the app?**  
+A: The companion will fall back to the configuration file for any settings not available in the app JSON.
+
+**Q: Do I need to restart the companion after changing settings in the app?**  
+A: No, the companion will automatically detect and apply changes from the app within 2 hours (the cache expiration time).
+
+**Q: Can I still use the configuration file for some settings?**  
+A: Yes, the timezone and general configuration options are still managed through the configuration file.
