Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new bluetooth module #147

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion .github/actions/spelling/allow.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,24 @@ websites
wekyb
Hmmss
MMdd
MMdd
GETTOUCHPADPARAMETERS
lpv
PInvoke
Ptr
Segeo
Segoe
touchpad
Usb
vparam
WFingertip
WFingertip
anner
desktopappxcontent
Devicetatus
dsd
eksajf
gypaqjh
jykhws
nyek
showpicturesonarrival
showshowpicturesonarrival
37 changes: 37 additions & 0 deletions resources/Help/Microsoft.Windows.Setting.Bluetooth/AutoPlay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: AutoPlay
---

# MobileDevice

## SYNOPSIS

The `AutoPlay` class is a DSC resource that allows you to manage the AutoPlay settings on your Windows device.

## DESCRIPTION

The `AutoPlay` class is a DSC resource that allows you to manage the AutoPlay settings on your Windows device.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| ----------------------- | ------------- | ------------ | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | |
| `AutoPlay` | Optional | Boolean | Enable or disable AutoPlay. | `$true`, `$false` |
| `RemovableDriveDefault` | Optional | String | The default auto play action for removable drives. | Either any of the following values: `KeepCurrentValue`, `MSStorageSense`, `MSTakeNoAction`, `MSOpenFolder`, `MSPromptEachTime` |
| `MemoryCardDefault` | Optional | String | The default auto play action for memory cards. | Either any of the following values: `KeepCurrentValue`, `MSPlayMediaOnArrival`, `MSTakeNoAction`, `MSOpenFolder`, `MSPromptEachTime`, `OneDriveAutoPlay`, `ImportPhotosAndVideos` |

## EXAMPLES

### EXAMPLE 1 - Disable auto play for all media and devices

```powershell
Invoke-DscResource -Name AutoPlay -Method Set -Property @{ AutoPlay = $false }

# This example disables the AutoPlay feature.
```
37 changes: 37 additions & 0 deletions resources/Help/Microsoft.Windows.Setting.Bluetooth/MobileDevice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: MobileDevice
---

# MobileDevice

## SYNOPSIS

The `MobileDevice` class is a DSC resource that allows you to manage the mobile devices settings on your Windows device.

## DESCRIPTION

The `MobileDevice` class is a DSC resource that allows you to manage the mobile devices settings on your Windows device.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| -------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------- | ------------------ |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | |
| `AccessMobileDevice` | Optional | Boolean | Allow this PC to access the mobile device. | `$true`, `$false` |
| `PhoneLinkAccess` | Optional | Boolean | Allow access to Phone Link. For more information: https://support.microsoft.com/en-us/phone-link | `$true`, `$false` |
| `ShowMobileDeviceSuggestions` | Optional | Boolean | Show mobile device suggestions. | `$true`, `$false` |

## EXAMPLES

### EXAMPLE 1 - Allow your PC to access your mobile device

```powershell
Invoke-DscResource -Name MobileDevice -Method Set -Property @{ AccessMobileDevice = $true }

# This example allows your mobile devices to be accessed by your PC.
```
57 changes: 57 additions & 0 deletions resources/Help/Microsoft.Windows.Setting.Bluetooth/Mouse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: Mouse
---

# Mouse

## SYNOPSIS

The `Mouse` class is a DSC resource that allows you to manage the mouse settings on your Windows device.

## DESCRIPTION

The `Mouse` class is a DSC resource that allows you to manage the mouse settings on your Windows device.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| ----------------------- | ------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | |
| `PrimaryButton` | Optional | PrimaryButton | The primary button of the mouse. This can be either `Left` or `Right`. | `Left` or `Right` |
| `CursorSpeed` | Optional | Integer | The cursor speed of the mouse. | Between `1` and `20`. |
| `PointerPrecision` | Optional | Boolean | The pointer precision of the mouse. | `$true`, `$false` |
| `RollMouseScroll` | Optional | Boolean | The roll mouse scroll of the mouse. When using in combination with `LinesToScroll`, this will enable or disable the lines to scroll at a time. | `$true`, `$false` |
| `LinesToScroll` | Optional | Integer | The number of lines to scroll. This value should be between `1` and `100`. | Between `1` and `100` |
| `ScrollInactiveWindows` | Optional | Boolean | The scroll inactive windows when hovering over them. | `$true`, `$false` |
| `ScrollDirection` | Optional | Boolean | The motion to scroll down or up. | `$true`, `$false` |

## EXAMPLES

### EXAMPLE 1 - Set the mouse button to right

```powershell
Invoke-DscResource -Name Mouse -Method Set -Property @{ PrimaryButton = 'Right' }

# This example sets the `PrimaryButton` property to `Right`.
```

### EXAMPLE 2 - Enable the pointer precision

```powershell
Invoke-DscResource -Name Mouse -Method Set -Property @{ PointerPrecision = $true }

# This example sets the `PointerPrecision` property to `$true`.
```

### EXAMPLE 3 - Set the lines to scroll to 3

```powershell
Invoke-DscResource -Name Mouse -Method Set -Property @{ RollMouseScroll = $true; LinesToScroll = 3 }

# This example sets the `RollMouseScroll` property to `$true` and the `LinesToScroll` property to `3`.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: PenWindowsInk
---

# PenWindowsInk

## SYNOPSIS

The `PenWindowsInk` class is a DSC resource that allows you to manage the Pen and Windows Ink settings on your Windows device.

## DESCRIPTION

The `PenWindowsInk` class is a DSC resource that allows you to manage the Pen and Windows Ink settings on your Windows device.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| ---------------- | ------------- | ------------ | --------------------------------- | ---------------------- |
| `FingerTipFont` | Key | String | The font used for the finger tip. | `InkFree` or `SegeoUI` |
| `WriteFingerTip` | Optional | Boolean | Enable inking with touch. | `$true`, `$false` |

## EXAMPLES

### EXAMPLE 1 - Sets the finger tip font to Segeo UI

```powershell
Invoke-DscResource -Name PenWindowsInk -Method Set -Property @{ FingerTipFont = 'SegoeUI' }

# This example sets the `FingerTipFont` property to `SegoeUI`.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: PrinterAndScanne
---

# PrinterAndScanne

## SYNOPSIS

The `PrinterAndScanner` class is a DSC resource that allows you to manage the printer and scanner settings on your Windows device.

## DESCRIPTION

The `PrinterAndScanner` class is a DSC resource that allows you to manage the printer and scanner settings on your Windows device.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| ------------------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------- | ------------------ |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | N/A |
| `LetWindowsManageDefaultPrinter` | Optional | Boolean | Let Windows manage the default printer. | `$true`, `$false` |
| `DriverDownloadOverMeteredConnection` | Optional | Boolean | Download drivers over a metered connection. | `$true`, `$false` |

.PARAMETER SID
The security identifier. This is a key property and should not be set manually.

.PARAMETER LetWindowsManageDefaultPrinter
Let Windows manage the default printer.

.PARAMETER DriverDownloadOverMeteredConnection
Download drivers over a metered connection.

## EXAMPLES

### EXAMPLE 1 - Disable Windows from managing the default printer

```powershell
Invoke-DscResource -Name PrinterAndScanner -Method Set -Property @{ LetWindowsManageDefaultPrinter = $false }

# This example disables Windows from managing the default printer.
```
37 changes: 37 additions & 0 deletions resources/Help/Microsoft.Windows.Setting.Bluetooth/USB.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
external help file: Microsoft.Windows.Setting.Bluetooth-Help.xml
Module Name: Microsoft.Windows.Setting.Bluetooth
ms.date: 01/19/2025
online version:
schema: 2.0.0
title: USB
---

# USB

## SYNOPSIS

The `USB` DSC Resource allows you to manage USB settings on Windows.

## DESCRIPTION

The `USB` DSC Resource allows you to manage USB settings on Windows.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| -------------------------- | ------------- | ------------ | ------------------------------------------------------------------------------- | ------------------ |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | |
| `ConnectionNotifications` | Optional | Boolean | Show a notification if there are issues connection to a USB device. | `$true`, `$false` |
| `SlowChargingNotification` | Optional | Boolean | Will show a notification if the PC is charging slowly over USB. | `$true`, `$false` |
| `BatterySaver` | Optional | Boolean | Stops USB devices from draining power when the screen is off. | `$true`, `$false` |

## EXAMPLES

### EXAMPLE 1 - Disable notification when there are issues connection a USB device

```powershell
Invoke-DscResource -Name USB -Method Set -Property @{ ConnectionNotifications = $false }

# This example sets the `ConnectionNotifications` property to `$false`.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
@{
RootModule = 'Microsoft.Windows.Setting.Bluetooth.psm1'
ModuleVersion = '0.1.0'
GUID = '65990ca0-278d-47b4-bc00-8fe47567e42d'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'DSC Resource for Windows Setting Bluetooth'
PowerShellVersion = '7.2'
DscResourcesToExport = @(
'USB',
'PenWindowsInk',
'Mouse',
'MobileDevice',
'AutoPlay',
'PrinterAndScanner'
)
PrivateData = @{
PSData = @{
# Tags applied to this module. These help with module discovery in online galleries.
Tags = @(
'PSDscResource_USB',
'PSDscResource_PenWindowsInk',
'PSDscResource_Mouse',
'PSDscResource_MobileDevice',
'PSDscResource_AutoPlay',
'PSDscResource_PrinterAndScanner'
)

# Prerelease string of this module
Prerelease = 'alpha'

# A URL to the license for this module.
LicenseUri = 'https://github.com/microsoft/winget-dsc/blob/main/LICENSE'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/microsoft/winget-dsc'
}
}
}
Loading
Loading