Espresso (#11303)

* Update README.md * Espresso (#11245) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Update Product.wxs * Update Shortcut.cpp * Update with more logging (#11332) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Fix minor issue in the module branch (#11340) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Update Product.wxs * Update Program.cs * fixing typo * removing a unneeded removal * [Espresso] More minor tweaks to logging (#11341) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Update patterns.txt * Fix binding issues (#11368) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue * Fix binding issue with the time settings Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Introduce the off mode and fix binding issues (#11385) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue * Fix binding issue with the time settings * Proper Espresso behavior for binding * Fix settings UI Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Update with missing strings. (#11386) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue * Fix binding issue with the time settings * Proper Espresso behavior for binding * Fix settings UI * Re-add missing strings Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Fix whitespace issue (#11387) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue * Fix binding issue with the time settings * Proper Espresso behavior for binding * Fix settings UI * Re-add missing strings * Fix whitespace issue Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Fix default (#11388) * Revert "Merge branch 'microsoft:master' into master" This reverts commit b080908712, reversing changes made to 8463c95a43. * Fix conversion of settings in the UX * Update terminology * Updating logging configuration * Set up how tray and setting configuration works * Adding hero images * Fix how binding works * Update OOBE string * Fix spelling error * fixing dep to include espresso, adding in yml * Update API components and fix display keep-awake bug * Adding words that the spell check is yelling about * tweak wsx * Change default setting for Espresso * Adding some extra logging * Update Shortcut.cpp * Fix log location coming from the runner * More chatty logging for console allocation * Installer config to add the missing assets * Remove unused handle codes * Update log file name for the Espresso C++ code. * Update the project configuration to fix build issue * Fix binding issue with the time settings * Proper Espresso behavior for binding * Fix settings UI * Re-add missing strings * Fix whitespace issue * Fix the default mode of operation Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> * Update Microsoft.PowerToys.Settings.UI.csproj * Localization improvements * Replaced a computer with your pc * Updated Espresso imagery * Fixed inconsistent string * Margin fix and updated images * Removed unused code Co-authored-by: Den Delimarsky <1389609+dend@users.noreply.github.com> Co-authored-by: Niels Laute <niels9001@hotmail.com> Co-authored-by: crutkas <crutkas@microsoft.com> Co-authored-by: Enrico Giordani <enrico.giordani@gmail.com>
2026-04-06 03:07:04 +02:00 · 2021-05-25 10:13:04 -07:00
parent 6821c50ffe
commit 894f469de6
53 changed files with 2399 additions and 99 deletions
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EnabledModules.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EnabledModules.cs
@@ -143,6 +143,22 @@ namespace Microsoft.PowerToys.Settings.UI.Library
            }
        }

+        private bool espresso;
+
+        [JsonPropertyName("Espresso")]
+        public bool Espresso
+        {
+            get => espresso;
+            set
+            {
+                if (espresso != value)
+                {
+                    LogTelemetryEvent(value);
+                    espresso = value;
+                }
+            }
+        }
+
        public string ToJsonString()
        {
            return JsonSerializer.Serialize(this);
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EspressoProperties.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EspressoProperties.cs
@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Text.Json.Serialization;
+
+namespace Microsoft.PowerToys.Settings.UI.Library
+{
+    public class EspressoProperties
+    {
+        public EspressoProperties()
+        {
+            KeepDisplayOn = false;
+            Mode = EspressoMode.PASSIVE;
+            Hours = 0;
+            Minutes = 0;
+        }
+
+        [JsonPropertyName("espresso_keep_display_on")]
+        public bool KeepDisplayOn { get; set; }
+
+        [JsonPropertyName("espresso_mode")]
+        public EspressoMode Mode { get; set; }
+
+        [JsonPropertyName("espresso_hours")]
+        public uint Hours { get; set; }
+
+        [JsonPropertyName("espresso_minutes")]
+        public uint Minutes { get; set; }
+    }
+
+    public enum EspressoMode
+    {
+        PASSIVE = 0,
+        INDEFINITE = 1,
+        TIMED = 2,
+    }
+}
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EspressoSettings.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/EspressoSettings.cs
@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Text.Json.Serialization;
+using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
+
+namespace Microsoft.PowerToys.Settings.UI.Library
+{
+    public class EspressoSettings : BasePTModuleSettings, ISettingsConfig
+    {
+        public const string ModuleName = "Espresso";
+        public const string ModuleVersion = "0.0.1";
+
+        public EspressoSettings()
+        {
+            Name = ModuleName;
+            Version = ModuleVersion;
+            Properties = new EspressoProperties();
+        }
+
+        [JsonPropertyName("properties")]
+        public EspressoProperties Properties { get; set; }
+
+        public string GetModuleName()
+        {
+            return Name;
+        }
+
+        public bool UpgradeSettingsConfiguration()
+        {
+            return false;
+        }
+    }
+}
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/ISettingsUtils.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/ISettingsUtils.cs
@@ -19,5 +19,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
        bool SettingsExists(string powertoy = "", string fileName = "settings.json");

        void DeleteSettings(string powertoy = "");
+
+        string GetSettingsFilePath(string powertoy = "", string fileName = "settings.json");
    }
 }
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/Microsoft.PowerToys.Settings.UI.Library.csproj
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/Microsoft.PowerToys.Settings.UI.Library.csproj
@@ -20,6 +20,9 @@

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
    <PlatformTarget>x64</PlatformTarget>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <DebugType>full</DebugType>
+    <DebugSymbols>true</DebugSymbols>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/SettingsUtils.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/SettingsUtils.cs
@@ -135,5 +135,11 @@ namespace Microsoft.PowerToys.Settings.UI.Library
 #endif
            }
        }
+
+        // Returns the file path to the settings file, that is exposed from the local ISettingsPath instance.
+        public string GetSettingsFilePath(string powertoy = "", string fileName = "settings.json")
+        {
+            return _settingsPath.GetSettingsPath(powertoy, fileName);
+        }
    }
 }
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/SndEspressoSettings.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/SndEspressoSettings.cs
@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace Microsoft.PowerToys.Settings.UI.Library
+{
+    public class SndEspressoSettings
+    {
+        [JsonPropertyName("Espresso")]
+        public EspressoSettings Settings { get; set; }
+
+        public SndEspressoSettings()
+        {
+        }
+
+        public SndEspressoSettings(EspressoSettings settings)
+        {
+            Settings = settings;
+        }
+
+        public string ToJsonString()
+        {
+            return JsonSerializer.Serialize(this);
+        }
+    }
+}
--- a/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/ViewModels/EspressoViewModel.cs
+++ b/src/settings-ui/Microsoft.PowerToys.Settings.UI.Library/ViewModels/EspressoViewModel.cs
@@ -0,0 +1,157 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Runtime.CompilerServices;
+using Microsoft.PowerToys.Settings.UI.Library.Helpers;
+using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
+
+namespace Microsoft.PowerToys.Settings.UI.Library.ViewModels
+{
+    public class EspressoViewModel : Observable
+    {
+        private GeneralSettings GeneralSettingsConfig { get; set; }
+
+        private EspressoSettings Settings { get; set; }
+
+        private Func<string, int> SendConfigMSG { get; }
+
+        public EspressoViewModel(ISettingsRepository<GeneralSettings> settingsRepository, ISettingsRepository<EspressoSettings> moduleSettingsRepository, Func<string, int> ipcMSGCallBackFunc)
+        {
+            // To obtain the general settings configurations of PowerToys Settings.
+            if (settingsRepository == null)
+            {
+                throw new ArgumentNullException(nameof(settingsRepository));
+            }
+
+            GeneralSettingsConfig = settingsRepository.SettingsConfig;
+
+            // To obtain the settings configurations of Fancy zones.
+            if (moduleSettingsRepository == null)
+            {
+                throw new ArgumentNullException(nameof(moduleSettingsRepository));
+            }
+
+            Settings = moduleSettingsRepository.SettingsConfig;
+
+            _isEnabled = GeneralSettingsConfig.Enabled.Espresso;
+            _keepDisplayOn = Settings.Properties.KeepDisplayOn;
+            _mode = Settings.Properties.Mode;
+            _hours = Settings.Properties.Hours;
+            _minutes = Settings.Properties.Minutes;
+
+            // set the callback functions value to hangle outgoing IPC message.
+            SendConfigMSG = ipcMSGCallBackFunc;
+        }
+
+        public bool IsEnabled
+        {
+            get => _isEnabled;
+            set
+            {
+                if (_isEnabled != value)
+                {
+                    _isEnabled = value;
+
+                    GeneralSettingsConfig.Enabled.Espresso = value;
+                    OnPropertyChanged(nameof(IsEnabled));
+                    OnPropertyChanged(nameof(IsTimeConfigurationEnabled));
+
+                    var outgoing = new OutGoingGeneralSettings(GeneralSettingsConfig);
+                    SendConfigMSG(outgoing.ToString());
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
+        public bool IsTimeConfigurationEnabled
+        {
+            get => _mode == EspressoMode.TIMED && _isEnabled;
+        }
+
+        public EspressoMode Mode
+        {
+            get => _mode;
+            set
+            {
+                if (_mode != value)
+                {
+                    _mode = value;
+                    OnPropertyChanged(nameof(Mode));
+                    OnPropertyChanged(nameof(IsTimeConfigurationEnabled));
+
+                    Settings.Properties.Mode = value;
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
+        public bool KeepDisplayOn
+        {
+            get => _keepDisplayOn;
+            set
+            {
+                if (_keepDisplayOn != value)
+                {
+                    _keepDisplayOn = value;
+                    OnPropertyChanged(nameof(KeepDisplayOn));
+
+                    Settings.Properties.KeepDisplayOn = value;
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
+        public uint Hours
+        {
+            get => _hours;
+            set
+            {
+                if (_hours != value)
+                {
+                    _hours = value;
+                    OnPropertyChanged(nameof(Hours));
+
+                    Settings.Properties.Hours = value;
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
+        public uint Minutes
+        {
+            get => _minutes;
+            set
+            {
+                if (_minutes != value)
+                {
+                    _minutes = value;
+                    OnPropertyChanged(nameof(Minutes));
+
+                    Settings.Properties.Minutes = value;
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
+        public void NotifyPropertyChanged([CallerMemberName] string propertyName = null)
+        {
+            OnPropertyChanged(propertyName);
+            if (SendConfigMSG != null)
+            {
+                SndEspressoSettings outsettings = new SndEspressoSettings(Settings);
+                SndModuleSettings<SndEspressoSettings> ipcMessage = new SndModuleSettings<SndEspressoSettings>(outsettings);
+
+                var targetMessage = ipcMessage.ToJsonString();
+                SendConfigMSG(targetMessage);
+            }
+        }
+
+        private bool _isEnabled;
+        private uint _hours;
+        private uint _minutes;
+        private bool _keepDisplayOn;
+        private EspressoMode _mode;
+    }
+}