Get-HomebridgeAccessory

SYNOPSIS

Gets Homebridge accessories.

SYNTAX

Named (Default)

Get-HomebridgeAccessory [-InstanceName <string>] [-UniqueId <string>]

ExplicitNoAuthentication

Get-HomebridgeAccessory -Url <string> -NoAuthentication [-UniqueId <string>]

ExplicitCredential

Get-HomebridgeAccessory -Url <string> -Credential <pscredential> [-UniqueId <string>]

DESCRIPTION

This function returns all accessories or one accessory selected by UniqueId. It preserves every property returned by Homebridge.

A request for one accessory refreshes its characteristics. That request can contact or wake the physical device and can fail when the device is unavailable.

EXAMPLES

EXAMPLE 1

Get-HomebridgeAccessory -InstanceName home

Returns all accessories from the saved instance.

EXAMPLE 2

Get-HomebridgeAccessory -InstanceName home -UniqueId 'accessory-id'

Refreshes and returns the accessory with the specified unique identifier.

PARAMETERS

-Credential

Explicit credentials.

Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InstanceName

The saved connection name.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Named
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-NoAuthentication

Indicates that the server does not require authentication.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitNoAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-UniqueId

The unique accessory identifier. When omitted, the function returns all accessories.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Url

An explicit Homebridge URL.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitNoAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None.

You cannot pipe objects to this function.

OUTPUTS

PSHomebridge.Accessory.

This function returns complete accessory objects.

NOTES

https://pshomebridge.xyz/command-reference/commands/Get-HomebridgeAccessory/

https://github.com/angrycuban13/PSHomebridge/blob/main/PSHomebridge/Source/Public/Get-HomebridgeAccessory.ps1