Add new bluetooth module #147

Gijsreyn · 2025-01-19T13:49:23Z

I have signed the Contributor License Agreement.
This pull request is related to an issue.

This PR addresses starts to address issue #94. The following DSC resources are introduced:

USB
PenWindowsInk
Mouse
AutoPlay
PrinterAndScanner
MobileDevice

Microsoft Reviewers: Open in CodeFlow

Gijsreyn · 2025-01-19T13:53:01Z

Hi @denelon. I started working on this module with quite some hiccups. Despite the hiccups, working with the low-level APIs was an interesting learning curve, and I guess the engineers in your team will like it as well. I aimed to address the logoff/login for users when applying a DSC resource. There might only be 1 or 2 at the moment because it didn't have a clear function to call (it's in a TODO).

Unfortunately, I couldn't finish the Touchpad class. I already constructed the function with the C/C++ code, but somehow, I cannot get it to work. Hopefully, someone on the team can help me with it.

stephengillie

Hi @Gijsreyn,

Apologies for experimenting with your module instead of one of my own. In reviewing your very well-formatted code, I kept seeing the code patterns stand out and wanted to express them in a more compact way. Please let me know what you think.

stephengillie · 2025-02-05T15:38:33Z

resources/Microsoft.Windows.Setting.Bluetooth/Microsoft.Windows.Setting.Bluetooth.psm1

+        # TODO: There is no refresh win32_api, so users have to logout and login to see the changes.
+    }
+}
+#endregion Functions


Suggested change

#endregion Functions

#endregion Functions

#Region CommonFunctions

function Set-RegistryKey {

param(

$NewValue,

$RegistryPath,

$RegistryKey,

$KeyType = "DWORD"

)

if ($null -ne $NewValue) {

if (-not (DoesRegistryKeyPropertyExist -Path $RegistryPath -Name $RegistryKey)) {

New-ItemProperty -Path $RegistryPath -Name $RegistryKey -Value $NewValue -PropertyType $KeyType | Out-Null

}

Set-ItemProperty -Path $RegistryPath -Name $RegistryKey -Value $NewValue

}

}

function Get-RegistryKey {

param(

$RegistryPath,

$RegistryKey,

$KeyParameter,

$ReturnValue = 1

)

if (-not (DoesRegistryKeyPropertyExist -Path $RegistryPath -Name $RegistryKey)) {

return $true

} else {

$KeyValue = (Get-ItemProperty -Path $RegistryPath -Name $RegistryKey).$KeyName

return ($KeyValue -eq $ReturnValue)

}

}

#endregion CommonFunctions

stephengillie · 2025-02-05T15:39:46Z

resources/Microsoft.Windows.Setting.Bluetooth/Microsoft.Windows.Setting.Bluetooth.psm1

+    [void] Set() {
+        if (-not ($this.Test())) {
+            if ($null -ne $this.ConnectionNotifications) {
+                if (-not (DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty))) {
+                    New-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty) -Value ([int]$this.ConnectionNotifications) -PropertyType DWord | Out-Null
+                }
+                Set-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty) -Value ([int]$this.ConnectionNotifications)
+            }
+
+            if ($null -ne $this.SlowChargingNotification) {
+                if (-not (DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty))) {
+                    New-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty) -Value ([int]$this.SlowChargingNotification) -PropertyType DWord | Out-Null
+                }
+                Set-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty) -Value ([int]$this.SlowChargingNotification)
+            }
+
+            if ($null -ne $this.BatterySaver) {
+                if (-not (DoesRegistryKeyPropertyExist -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty))) {
+                    New-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty) -Value ([int]$this.BatterySaver) -PropertyType DWord | Out-Null
+                }
+                Set-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty) -Value ([int]$this.BatterySaver)
+            }
+        }
+    }


Suggested change

[void] Set() {

if (-not ($this.Test())) {

if ($null -ne $this.ConnectionNotifications) {

if (-not (DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty))) {

New-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty) -Value ([int]$this.ConnectionNotifications) -PropertyType DWord | Out-Null

}

Set-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty) -Value ([int]$this.ConnectionNotifications)

}

if ($null -ne $this.SlowChargingNotification) {

if (-not (DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty))) {

New-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty) -Value ([int]$this.SlowChargingNotification) -PropertyType DWord | Out-Null

}

Set-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty) -Value ([int]$this.SlowChargingNotification)

}

if ($null -ne $this.BatterySaver) {

if (-not (DoesRegistryKeyPropertyExist -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty))) {

New-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty) -Value ([int]$this.BatterySaver) -PropertyType DWord | Out-Null

}

Set-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty) -Value ([int]$this.BatterySaver)

}

}

}

[void] Set() {

if (-not ($this.Test())) {

Set-RegistryKey -NewValue [int]$this.ConnectionNotifications -RegistryPath $global:USBShellPath -RegistryKey ([USB]::ConnectionNotificationsProperty)

Set-RegistryKey -NewValue [int]$this.SlowChargingNotification -RegistryPath $global:USBShellPath -RegistryKey ([USB]::SlowChargingNotificationProperty)

Set-RegistryKey -NewValue [int]$this.BatterySaver -RegistryPath $global:USBMachinePath -RegistryKey ([USB]::BatterySaverProperty)

}

}```

stephengillie · 2025-02-05T15:40:38Z

resources/Microsoft.Windows.Setting.Bluetooth/Microsoft.Windows.Setting.Bluetooth.psm1

+    #region USB helper functions
+    static [bool] GetConnectionNotificationStatus() {
+        if (-not(DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty))) {
+            return $true
+        } else {
+            $ConnectionNotificationsValue = (Get-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty)).NotifyOnUsbErrors
+            return ($ConnectionNotificationsValue -eq 1)
+        }
+    }
+
+    static [bool] GetSlowChargingNotificationStatus() {
+        if (-not(DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty))) {
+            return $true
+        } else {
+            $SlowChargingNotificationValue = (Get-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty)).NotifyOnWeakCharger
+            return ($SlowChargingNotificationValue -eq 1)
+        }
+    }
+
+    static [bool] GetBatterySaverStatus() {
+        if (-not(DoesRegistryKeyPropertyExist -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty))) {
+            return $false # It is not enabled by default if the registry key does not exist.
+        } else {
+            $BatterySaverValue = (Get-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty)).AttemptRecoveryFromUsbPowerDrain
+            return ($BatterySaverValue -eq 1)
+        }
+    }
+    #endregion USB helper functions
+}


Suggested change

#region USB helper functions

static [bool] GetConnectionNotificationStatus() {

if (-not(DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty))) {

return $true

} else {

$ConnectionNotificationsValue = (Get-ItemProperty -Path $global:USBShellPath -Name ([USB]::ConnectionNotificationsProperty)).NotifyOnUsbErrors

return ($ConnectionNotificationsValue -eq 1)

}

}

static [bool] GetSlowChargingNotificationStatus() {

if (-not(DoesRegistryKeyPropertyExist -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty))) {

return $true

} else {

$SlowChargingNotificationValue = (Get-ItemProperty -Path $global:USBShellPath -Name ([USB]::SlowChargingNotificationProperty)).NotifyOnWeakCharger

return ($SlowChargingNotificationValue -eq 1)

}

}

static [bool] GetBatterySaverStatus() {

if (-not(DoesRegistryKeyPropertyExist -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty))) {

return $false # It is not enabled by default if the registry key does not exist.

} else {

$BatterySaverValue = (Get-ItemProperty -Path $global:USBMachinePath -Name ([USB]::BatterySaverProperty)).AttemptRecoveryFromUsbPowerDrain

return ($BatterySaverValue -eq 1)

}

}

#endregion USB helper functions

}

}

stephengillie · 2025-02-05T15:48:15Z

resources/Microsoft.Windows.Setting.Bluetooth/Microsoft.Windows.Setting.Bluetooth.psm1

+        $currentState.ConnectionNotifications = [USB]::GetConnectionNotificationStatus()
+        $currentState.SlowChargingNotification = [USB]::GetSlowChargingNotificationStatus()
+        $currentState.BatterySaver = [USB]::GetBatterySaverStatus()


Suggested change

$currentState.ConnectionNotifications = [USB]::GetConnectionNotificationStatus()

$currentState.SlowChargingNotification = [USB]::GetSlowChargingNotificationStatus()

$currentState.BatterySaver = [USB]::GetBatterySaverStatus()

$currentState.ConnectionNotifications = Get-RegistryKey -RegistryPath $global:USBShellPath -RegistryKey ([USB]::ConnectionNotificationsProperty) -KeyParameter "NotifyOnUsbErrors"

$currentState.SlowChargingNotification = Get-RegistryKey -RegistryPath $global:USBShellPath -RegistryKey ([USB]::SlowChargingNotificationProperty) -KeyParameter "NotifyOnWeakCharger"

$currentState.BatterySaver = Get-RegistryKey -RegistryPath $global:USBMachinePath -RegistryKey ([USB]::BatterySaverProperty) -KeyParameter "AttemptRecoveryFromUsbPowerDrain"

stephengillie · 2025-02-06T15:37:12Z

resources/Microsoft.Windows.Setting.Bluetooth/Microsoft.Windows.Setting.Bluetooth.psm1

+    # TODO: Does not work, error code 87. See: https://learn.microsoft.com/en-us/windows/win32/debug/system-error-codes--0-499-
+    # TODO: Might also require checking if touchpad is present on machine, and if result can be captured as C++ acts different
+    $result = [Touchpad32Functions]::SystemParametersInfo(0x00AE, 0, [ref]$touchpad, 0) # SPI_GETTOUCHPADPARAMETERS
+    $err = [System.Runtime.InteropServices.Marshal]::GetLastWin32Error()
+    if ($err -ne 0) {
+        throw [System.ComponentModel.Win32Exception]::new($err)
+    }


...error code 87.

From the website:

ERROR_INVALID_PARAMETER: The parameter is incorrect.

On my laptop, which has a touchpad, I get code 203: The system could not find the environment option that was entered. I'm having difficulty finding documentation of the Touchpad32Functions assembly, which complicates troubleshooting.

I did locate another set of Touchpad settings, under HKCU:\Software\Microsoft\Windows\CurrentVersion\PrecisionTouchPad:

First, the enabled/disabled switch is in a subfolder:

PS C:\ManVal> Get-ItemProperty -Path HKCU:\Software\Microsoft\Windows\CurrentVersion\PrecisionTouchPad\Status\ Enabled : 1

And the rest of the settings are in the main folder:

PS C:\ManVal> Get-ItemProperty -Path HKCU:\Software\Microsoft\Windows\CurrentVersion\PrecisionTouchPad AAPThreshold : 2 CursorSpeed : 10 ScrollDirection : 0 EnableEdgy : 4294967295 LeaveOnWithMouse : 0 PanEnabled : 4294967295 RightClickZoneEnabled : 0 TapAndDrag : 0 TapsEnabled : 4294967295 TwoFingerTapEnabled : 0 ZoomEnabled : 4294967295 HonorMouseAccelSetting : 0 FeedbackIntensity : 50 FeedbackEnabled : 4294967295 ThreeFingerSlideEnabled : 0 ThreeFingerTapEnabled : 0 FourFingerSlideEnabled : 0 FourFingerTapEnabled : 0 PSPath : Microsoft.PowerShell.Core\Registry::HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\PrecisionTouchPad

Gijsreyn · 2025-02-08T04:30:04Z

Hi @Gijsreyn,

Apologies for experimenting with your module instead of one of my own. In reviewing your very well-formatted code, I kept seeing the code patterns stand out and wanted to express them in a more compact way. Please let me know what you think.

Hey @stephengillie, thanks for hopping in. Yes, that's what I noticed as well, and I didn't really like it. There's so much overlap in each module, and Demitrius mentioned one sentence back about having the modules move toward the DSC community. That sentence remained with me.

Having said that, I had some time spent investigating the class-based development within the DSC community. It was a bit tough to get started, but I finally managed to get a mock setup, and I feel it's a way better approach with modularity included. I demoed this during the last community call as a sneak peek, and I intend to move most of the content that I have PRed here to that module.

Basically, the 010.SettingsBase.ps1 contains a class that can be inherited across (nearly) all settings unless they don't contain 0 or 1 values as DWORDS (still thinking about it to expand). Others can be more self-contained.

The repository is still private, but if you and @denelon want access to it, just give me a heads-up. I'm just letting you know that I'll not spend much time around this repository, and I guess most PRs can be abandoned.

Lastly, on the touchpad settings. Thanks for the deep dive and yes, I think I noticed these settings also. The thing is, you can change them in the registry, but the user would still have to log out and log back in. That's why I wanted to use the API to get the values and set it using that. Anyway, if you've someone internal who might be able to help out, that would be pretty cool :)

Gijsreyn and others added 12 commits January 17, 2025 10:46

Init bluetooth module

fbd69e2

New Set-MouseScrollLines function

0a40c01

Create tests for mouse

5d6cad2

Add first synopsis

a3e09d7

Markdown file USB

f3afed4

Markdown file PenWindowsInk

20b27ab

Markdown file Mouse

fdbe2f3

Typo

ab7570a

Remove line end

a725f3f

Resolve spelling

0816f3a

Resolve spelling

5420a14

Remove unnecessary file

7718edc

Gijsreyn added 8 commits January 20, 2025 11:56

New MobileDevices class

9802b45

Rename MobileDevices to MobileDevice

c4cbce7

New AutoPlay class

95254ac

Add synopsis

9a8bca2

Add help file

81357fc

Class for printers and scanners section

9e74c30

Add synopsis

c37e813

Add Pester test

7d0aadb

This comment has been minimized.

Sign in to view

Spelling

b889a49

stephengillie reviewed Feb 5, 2025

View reviewed changes

stephengillie reviewed Feb 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new bluetooth module #147

Add new bluetooth module #147

Gijsreyn commented Jan 19, 2025 •

edited

Loading

Gijsreyn commented Jan 19, 2025

This comment has been minimized.

stephengillie left a comment

stephengillie Feb 5, 2025 •

edited

Loading

stephengillie Feb 5, 2025

stephengillie Feb 5, 2025

stephengillie Feb 5, 2025

stephengillie Feb 6, 2025

Gijsreyn commented Feb 8, 2025

-#endregion Functions
+#endregion Functions
+#Region CommonFunctions
+function Set-RegistryKey {
+	param(
+		$NewValue,
+		$RegistryPath,
+		$RegistryKey,
+		$KeyType = "DWORD"
+	)
+	if ($null -ne $NewValue) {
+		if (-not (DoesRegistryKeyPropertyExist -Path $RegistryPath -Name $RegistryKey)) {
+			New-ItemProperty -Path $RegistryPath -Name $RegistryKey -Value $NewValue -PropertyType $KeyType | Out-Null
+		}
+		Set-ItemProperty -Path $RegistryPath -Name $RegistryKey -Value $NewValue
+	}
+}
+function Get-RegistryKey {
+	param(
+		$RegistryPath,
+		$RegistryKey,
+		$KeyParameter,
+		$ReturnValue = 1
+	)
+	if (-not (DoesRegistryKeyPropertyExist -Path $RegistryPath -Name $RegistryKey)) {
+            return $true
+        } else {
+            $KeyValue = (Get-ItemProperty -Path $RegistryPath -Name $RegistryKey).$KeyName
+            return ($KeyValue -eq $ReturnValue)
+	}
+}
+#endregion CommonFunctions

Add new bluetooth module #147

Are you sure you want to change the base?

Add new bluetooth module #147

Conversation

Gijsreyn commented Jan 19, 2025 • edited Loading

Microsoft Reviewers: Open in CodeFlow

Gijsreyn commented Jan 19, 2025

This comment has been minimized.

stephengillie left a comment

Choose a reason for hiding this comment

stephengillie Feb 5, 2025 • edited Loading

Choose a reason for hiding this comment

stephengillie Feb 5, 2025

Choose a reason for hiding this comment

stephengillie Feb 5, 2025

Choose a reason for hiding this comment

stephengillie Feb 5, 2025

Choose a reason for hiding this comment

stephengillie Feb 6, 2025

Choose a reason for hiding this comment

Gijsreyn commented Feb 8, 2025

Gijsreyn commented Jan 19, 2025 •

edited

Loading

stephengillie Feb 5, 2025 •

edited

Loading