Set AwtrixSetting

Set-AwtrixSetting

SYNOPSIS

Updates one or more AWTRIX NG display settings.

SYNTAX

Set-AwtrixSetting [-Device] <Object> [-Setting] <IDictionary> [-SkipVerification] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Patches selected settings through the AWTRIX NG settings endpoint and verifies that every requested value was applied by the firmware. This command does not expose Wi-Fi, authentication, or firmware settings.

EXAMPLES

EXAMPLE 1

Set-AwtrixSetting -Device 'clock.local' -Setting @{ brightness = 100 } -WhatIf

PARAMETERS

-Device

Specifies a host name, IP address, URI, or object returned by New-AwtrixDevice.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PassThru

Returns the settings object read after successful verification.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Setting

Specifies AWTRIX display setting keys and values, such as brightness, autoBrightness, or appDurationMs.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SkipVerification

Skips the follow-up settings read and returns the firmware write response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSCustomObject

System.Object

NOTES

RELATED LINKS