VictronEnergy

0.2.0.0

Get-VEMeasurementAttributes.ps1

function Get-VEMeasurementAttributes {
    <#
        .SYNOPSIS
            Return measurement attributes
        .DESCRIPTION
            Return all measurement attributes or only measurement attributes for specific code or a device
        .INPUTS
            The VE device object or the code can be piped to the function
        .EXAMPLE
            $Device | Get-VEMeasurementAttributes
            Example of how to get measurement attributes from a device using the VRM API
        .NOTES
            Author: Decembry Quentin
    #>
    [CmdletBinding(DefaultParameterSetName='All')]
    [OutputType([PSCustomObject])]
    [Alias()]
    param(
        # The VE device
        [Parameter(Mandatory=$false,ValueFromPipeline=$true,ParameterSetName='Device')] [PSTypeName('VictronEnergy.Device')] $Device,
        
        # The VE device name
        [Parameter(Mandatory=$false,ParameterSetName='DeviceName')] [string] $DeviceName,
        
        # The attribute code (case sensitive)
        [Parameter(Mandatory=$false,ValueFromPipeline=$true,ParameterSetName='Code')] [string] $Code
    )

    begin {
        if ($PSBoundParameters['Debug']) {
            $DebugPreference = 'Continue'
        }
        
        if ($MyInvocation.MyCommand.ModuleName) { 
            $Private:ThisFunction = '{0}::{1}' -f $MyInvocation.MyCommand.ModuleName, $MyInvocation.MyCommand.Name
        } else {
            $Private:ThisFunction = '{0}::{1}' -f (Get-PSCallStack)[0].ScriptName, $MyInvocation.MyCommand.Name
        }
        
        Write-Debug "[$Private:ThisFunction] Begin"
    }
    
    process {
        Write-Debug "[$Private:ThisFunction] Process"
        switch ($PSCmdlet.ParameterSetName) {
            'All' {
                Write-Debug "[$Private:ThisFunction] Return all objects"
                $Script:VE_MeasurementAttributes
            }
            'Code' {
                Write-Debug "[$Private:ThisFunction] Process code $Code"
                $Script:VE_MeasurementAttributes | Where-Object { $_.Code -ceq $Code }
            }
            'Device' {
                Write-Debug "[$Private:ThisFunction] Process device $Device"
                
                if (!$Device.Name) {
                    throw 'Unable to return measurement attributes for device (missing name)'
                }
                
                $Script:VE_MeasurementAttributes | Where-Object { $_.Device -eq $Device.Name }
            }
            'DeviceName' {
                Write-Debug "[$Private:ThisFunction] Process device $DeviceName"
                $Script:VE_MeasurementAttributes | Where-Object { $_.Device -eq $DeviceName }
            }
            default {
                Write-Error "Unsupported parameter set name '$_'"
            }
        }
    }
    
    end {
        Write-Debug "[$Private:ThisFunction] End"
    }
}

# SIG # Begin signature block
# MIIIbQYJKoZIhvcNAQcCoIIIXjCCCFoCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUPVR+HKbsYRVEF6q5jVzK0Fer
# TAygggX4MIICYjCCAgigAwIBAgITXwAAAAITcsrrTJecaQAAAAAAAjAKBggqhkjO
# PQQDAjAkMQswCQYDVQQGEwJCRTEVMBMGA1UEAxMMSG9tZSBSb290IENBMB4XDTIy
# MDUwNTE0MDMxOFoXDTMyMDUwNTE0MTMxOFowJzELMAkGA1UEBhMCQkUxGDAWBgNV
# BAMTD0hvbWUgSXNzdWluZyBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABDOT
# aIIU+QU7LfsmyPqGkCf53SrJuaBPpb5iVILCvG3cQxL6vgIZaGRaKlzYO+lq3CnN
# b4rtJW2d7rlTeehXtpWjggEUMIIBEDAQBgkrBgEEAYI3FQEEAwIBADAdBgNVHQ4E
# FgQUYf1/nMEp3Df+Nzi+Hvk7FymPsrMwGQYJKwYBBAGCNxQCBAweCgBTAHUAYgBD
# AEEwCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUfSS6
# P6qin/3ibmvelGJQhV1r1VgwOwYDVR0fBDQwMjAwoC6gLIYqaHR0cDovL3BraS5x
# ZWRpbnV4LmJlL0hvbWUlMjBSb290JTIwQ0EuY3JsMEYGCCsGAQUFBwEBBDowODA2
# BggrBgEFBQcwAoYqaHR0cDovL3BraS5xZWRpbnV4LmJlL0hvbWUlMjBSb290JTIw
# Q0EuY3J0MAoGCCqGSM49BAMCA0gAMEUCIERRzfMu3vx9vb+Apud4sDkOEKhKrCEl
# gSsedbjZRJ+YAiEA8BBaOqhnbnsUBIX2nty77euunwoAHrCuWzab5xJiy0UwggOO
# MIIDM6ADAgECAhNRAAAAMJpCm89a8zgYAAAAAAAwMAoGCCqGSM49BAMCMCcxCzAJ
# BgNVBAYTAkJFMRgwFgYDVQQDEw9Ib21lIElzc3VpbmcgQ0EwHhcNMjIwNzExMDc0
# NzQ3WhcNMjQwNzExMDc1NzQ3WjAbMRkwFwYDVQQDExBEZWNlbWJyeSBRdWVudGlu
# MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAjALWtmJ1AQG77y9rUBbT
# HXR9FZokTP01bBWfNzk4Kenr/Xpm7Jt09PqLoNS8ToWWKRz9EkM+jg7lnLljWKcO
# G+fT1TbaEwxOpncugnbrioQQonbdWpyn0P7PxlqjUQdWd5Z7xQ0Z8RO3vvERWtDA
# L9QH0VBHNK4WqdWh3ElV6ogJUsy5hYxVTIU0K5VEYkIT4qvqq0RdajKavGWIr57R
# EsYv52Jcyh9FNgZKGdu9NwSKZUvkwHxGsI8zmwfP1I6QRkzsqPXlpk7A8NTD3+h+
# 4Y5AprRFyAWrVNYH+UQQe2D/PjjbKtfsU9xzG9EnqJF09pVRchapis+8DbfWnoC8
# iQIDAQABo4IBfTCCAXkwOgYJKwYBBAGCNxUHBC0wKwYjKwYBBAGCNxUIhorlOcPr
# DIadiwndkzuHjPAAPqb1CYWVxXgCAWQCAQowEwYDVR0lBAwwCgYIKwYBBQUHAwMw
# DgYDVR0PAQH/BAQDAgeAMBsGCSsGAQQBgjcVCgQOMAwwCgYIKwYBBQUHAwMwHQYD
# VR0OBBYEFAkUh200U2U2epAoy2ZvT7nwAYGBMB8GA1UdIwQYMBaAFGH9f5zBKdw3
# /jc4vh75Oxcpj7KzMD4GA1UdHwQ3MDUwM6AxoC+GLWh0dHA6Ly9wa2kucWVkaW51
# eC5iZS9Ib21lJTIwSXNzdWluZyUyMENBLmNybDBJBggrBgEFBQcBAQQ9MDswOQYI
# KwYBBQUHMAKGLWh0dHA6Ly9wa2kucWVkaW51eC5iZS9Ib21lJTIwSXNzdWluZyUy
# MENBLmNydDAuBgNVHREEJzAloCMGCisGAQQBgjcUAgOgFQwTRGVjZW1icnkuUUBo
# b21lLmxhbjAKBggqhkjOPQQDAgNJADBGAiEAh39vHCgqIDL4XazyHPiChMbu0by+
# aFP7rdzlJmM0K6ACIQCaP4CXolxlzdfkJsoIoDIJUrunYIlZ0yxs9OSnG1qmCjGC
# Ad8wggHbAgEBMD4wJzELMAkGA1UEBhMCQkUxGDAWBgNVBAMTD0hvbWUgSXNzdWlu
# ZyBDQQITUQAAADCaQpvPWvM4GAAAAAAAMDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGC
# NwIBDDEKMAigAoAAoQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgor
# BgEEAYI3AgELMQ4wDAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUQ31BCQmK
# 8qzm+NH7FEzSErPW+oIwDQYJKoZIhvcNAQEBBQAEggEAQphbLuaZaGvTeCIWZgXI
# An+y9GFueQ/aYd0rt2cm7f6R9ZOh1MvprzSOYpQQdQ6OHkBaz4HOCicdivxtCDpV
# K1dIT/8Ss8ssOlVJYG5Mx6EfDOUxKmcv6aLy9Skl0X5ubpLkbPpoZwyx2dvO6D0w
# QTVXbpSIDg/mNGfqrm5RYwq4C3UjGRtDG1SyUIK55n3NgSJTeHEzl3JO1T2iIJuW
# e0BIbKtul5n1EN8YEQX8T5TWBzwc4LsTzSdpWakKsJGoxcXqsI4tYGxk+v+OVZwj
# POxc6zypjI2EWX0cumoPdgl1KI5OcaEk6+BdVj9pLZcDkcpC8XyC8i0MnzWxqPw9
# SQ==
# SIG # End signature block