Skip to content

Set-AwtrixIndicator

SYNOPSIS

Sets a colored indicator on the AWTRIX display.

SYNTAX

Set-AwtrixIndicator [-Position] <AwtrixIndicatorPosition> [-Color] <Object> [-BlinkMilliseconds <Int32>]
 [-FadeMilliseconds <Int32>] [-BaseUri <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Configures one of three colored indicators on the AWTRIX 3 display: - Indicator 1: Upper right corner - Indicator 2: Right side - Indicator 3: Lower right corner

Indicators can optionally blink or fade at a specified interval.

EXAMPLES

EXAMPLE 1

Set-AwtrixIndicator -Id 1 -Color '#FF0000'

Sets indicator 1 (upper right) to red.

EXAMPLE 2

Set-AwtrixIndicator -Id 2 -Color @(0, 255, 0) -Blink 500

Sets indicator 2 to green, blinking every 500ms.

EXAMPLE 3

Set-AwtrixIndicator -Id 3 -Color '#0000FF' -Fade 1000

Sets indicator 3 to blue, fading every 1000ms.

PARAMETERS

-Position

The indicator position on the display: Top (upper right), Middle (right side), or Bottom (lower right).

Type: AwtrixIndicatorPosition
Parameter Sets: (All)
Aliases:
Accepted values: Top, Middle, Bottom

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

-Color

The color for the indicator. Accepts a hex string (e.g., '#FF0000') or an RGB array (e.g., @(255, 0, 0)).

Type: Object
Parameter Sets: (All)
Aliases:

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

-BlinkMilliseconds

Makes the indicator blink at the specified interval in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases: BlinkMs

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

-FadeMilliseconds

Makes the indicator fade on and off at the specified interval in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases: FadeMs

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

-BaseUri

The base URI of the AWTRIX device. If not specified, uses the connection from Connect-Awtrix.

Type: String
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

NOTES