Skip to content

Clear-AwtrixIndicator

SYNOPSIS

Clears a colored indicator on the AWTRIX display.

SYNTAX

Clear-AwtrixIndicator [-Position] <AwtrixIndicatorPosition> [-BaseUri <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Hides one of the three colored indicators on the AWTRIX 3 display by sending an empty payload to the indicator endpoint.

EXAMPLES

EXAMPLE 1

Clear-AwtrixIndicator -Id 1

Clears indicator 1 (upper right corner).

EXAMPLE 2

1..3 | ForEach-Object { Clear-AwtrixIndicator -Id $_ }

Clears all three indicators.

PARAMETERS

-Position

The indicator position to clear: 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

-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