Watch AwtrixScreen

Watch-AwtrixScreen

SYNOPSIS

Watches and renders an AWTRIX NG screen in the terminal.

SYNTAX

Watch-AwtrixScreen [-Device] <Object> [[-IntervalMilliseconds] <Int32>] [[-DurationSec] <Int32>]
 [[-FrameCount] <Int32>] [[-RenderingMode] <AwtrixTerminalRenderingMode>] [-ShowUnchanged] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Polls the AWTRIX screen endpoint and redraws the matrix whenever its pixels change. The watch runs until interrupted unless DurationSec or FrameCount is specified.

EXAMPLES

EXAMPLE 1

Watch-AwtrixScreen -Device 'clock.local'

EXAMPLE 2

Watch-AwtrixScreen -Device 'clock.local' -DurationSec 30 -PassThru

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: False
Accept wildcard characters: False

-DurationSec

Specifies the maximum watch duration in seconds. Zero means no time limit.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-FrameCount

Specifies the maximum number of screen polls. Zero means no frame limit.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-IntervalMilliseconds

Specifies the delay between screen polls in milliseconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PassThru

Returns each rendered frame for additional processing.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RenderingMode

Specifies automatic, ANSI true-color, or ConsoleColor rendering.

Type: AwtrixTerminalRenderingMode
Parameter Sets: (All)
Aliases:
Accepted values: Auto, Ansi, ConsoleColor

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

-ShowUnchanged

Redraws frames even when their pixel data has not changed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

NOTES

RELATED LINKS