Skip to content

Start-AwtrixSleep

SYNOPSIS

Puts the AWTRIX device into deep sleep mode.

SYNTAX

Start-AwtrixSleep [-Seconds] <Int32> [-BaseUri <String>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Sends the AWTRIX 3 device into deep sleep mode for a specified duration in seconds. The device will only wake up after the timer expires or when the middle button is pressed. There is no way to wake up via API.

EXAMPLES

EXAMPLE 1

Start-AwtrixSleep -Seconds 3600

Puts the device to sleep for 1 hour.

EXAMPLE 2

Start-AwtrixSleep -Seconds 60

Puts the device to sleep for 1 minute.

PARAMETERS

-Seconds

The number of seconds the device should sleep.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

-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

-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

-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