Skip to content

Set AwtrixIndicator

github-actions[bot] edited this page Oct 11, 2026 · 1 revision

Set-AwtrixIndicator

SYNOPSIS

Sets an AWTRIX NG colored indicator.

SYNTAX

Set-AwtrixIndicator [-Device] <Object> [-Indicator] <Int32> [-Color] <Object> [[-Blink] <Int32>]
 [[-Fade] <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets one of the three AWTRIX screen indicators using a hexadecimal color or an RGB array, with optional blink and fade intervals.

EXAMPLES

EXAMPLE 1

Set-AwtrixIndicator -Device 'clock.local' -Indicator 1 -Color '#FF0000'

EXAMPLE 2

Set-AwtrixIndicator -Device 'clock.local' -Indicator 2 -Color 0,255,0 -Blink 500

PARAMETERS

-Blink

Specifies the blink interval in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Color

Specifies a six-digit hexadecimal color or an array containing three RGB values from 0 through 255.

Type: Object
Parameter Sets: (All)
Aliases:

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

-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

-Fade

Specifies the fade interval in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Indicator

Specifies indicator 1, 2, or 3.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: 0
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.Object

NOTES

RELATED LINKS

Clone this wiki locally