Get AvmHomeautoSpecificDeviceInfo

Get-AvmHomeautoSpecificDeviceInfo

Synopsis

Action: GetSpecificDeviceInfos
Available on: ✅ FRITZ!Box / 🚫 FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧 / 🏠

Description

This function returns values/states for action parameters for devices by AIN.
When a smart home group is requested, the DeviceName represents the name of the group. When a virtual device (groups or templates) are requested the ProductName is set to "Group" or "Template".

Input:

Data type	Variable	Example or Description
String	NewAIN	12345 1234567

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:X_AVM-DE_Homeauto:1
Ushort	NewDeviceId	22
Ushort	NewFunctionBitMask	320
String	NewFirmwareVersion	03.54
String	NewManufacturer	AVM
String	NewProductName	Comet DECT
String	NewDeviceName	Heater Livingroom
PresentEnum	NewPresent	CONNECTED
EnabledEnum	NewMultimeterIsEnabled	DISABLED
ValidEnum	NewMultimeterIsValid	INVALID
Uint	NewMultimeterPower	0
Uint	NewMultimeterEnergy	0
EnabledEnum	NewTemperatureIsEnabled	ENABLED
ValidEnum	NewTemperatureIsValid	VALID
Int	NewTemperatureCelsius	180
Int	NewTemperatureOffset	0
EnabledEnum	NewSwitchIsEnabled	DISABLED
ValidEnum	NewSwitchIsValid	INVALID
SwStateEnum	NewSwitchState	OFF
SwModeEnum	NewSwitchMode	AUTO
Boolean	NewSwitchLock	0
EnabledEnum	NewHkrIsEnabled	ENABLED
ValidEnum	NewHkrIsValid	VALID
Int	NewHkrIsTemperature	180
VentilEnum	NewHkrSetVentilStatus	CLOSED
Int	NewHkrSetTemperature	0
VentilEnum	NewHkrReduceVentilStatus	CLOSED
Int	NewHkrReduceTemperature	0
VentilEnum	NewHkrComfortVentilStatus	TEMP
Int	NewHkrComfortTemperature	175

Syntax

Get-AvmHomeautoSpecificDeviceInfo
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewAIN <String>]

Examples

Example 1

This example describes how to run the command using a valid certificate and remote access.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    RemoteAccess = $true
    Url = "https://myfritzaddress12.myfritz.net"
    Port = 443
    Credential = $Credential
    NewAIN = "12345 1234567"
}

Get-AvmHomeautoSpecificDeviceInfo @splatParameters

Example 2

This example describes how to run the command using local connection with a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Url = "https://fritz.box"
    Port = 49443
    Credential = $Credential
    NewAIN = "12345 1234567"
}

Get-AvmHomeautoSpecificDeviceInfo @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Url = "https://192.168.178.1"
    Port = 49443
    Credential = $Credential
    NewAIN = "12345 1234567"
}

Get-AvmHomeautoSpecificDeviceInfo @splatParameters

Example 3

This example describes how to run the command using local connection without a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Insecure = $true
    Url = "http://fritz.box"
    Port = 49000
    Credential = $Credential
    NewAIN = "12345 1234567"
}

Get-AvmHomeautoSpecificDeviceInfo @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Insecure = $true
    Url = "http://192.168.178.1"
    Port = 49000
    Credential = $Credential
    NewAIN = "12345 1234567"
}

Get-AvmHomeautoSpecificDeviceInfo @splatParameters