VictronEnergy

0.1.1.0

Set-VEValueFormatting.ps1

function Set-VEValueFormatting {
    <#
        .SYNOPSIS
            Ult
        .DESCRIPTION
            Ult
        .INPUTS
            No object can be piped to the function
        .EXAMPLE
            Set-VEValueFormatting
            Example of how to set value formatting object
        .NOTES
            Author: Decembry Quentin
    #>
    [CmdletBinding(DefaultParameterSetName='Diagnostic')]
    [OutputType([PSCustomObject])]
    [Alias()]
    param(
        # The VE diagnostics
        [Parameter(Mandatory=$true,ParameterSetName='Diagnostic')] [PSTypeName('VictronEnergy.Diagnostic')] $Diagnostic,
        
        # The VE meta
        [Parameter(Mandatory=$true,ParameterSetName='Meta')] [Object] $Meta,
        
        # The site id
        [Parameter(Mandatory=$true,ParameterSetName='Meta')] [string] $SiteId
    )

    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 code $Code"
        
        [string] $Code = ''
        [string] $FormatWithUnit = ''
        
        $Hashtable = @{
            PSTypeName = 'VictronEnergy.ValueFormatting'
            Source = ''
            BitMask = $false
            EnumValues = @{}
        }
        
        switch ($PSCmdlet.ParameterSetName) {
            #
            # Diagnostic is the best source but not always available
            #
            'Diagnostic' {
                $SiteId = $Diagnostic.idSite
                $Code = $Diagnostic.Code

                if ($Script:VE_ValueFormatting.$SiteId.$Code.Source -eq $_) {
                    # Object already exists from Diagnostic
                    return
                }
                
                $Hashtable.BitMask = [Bool] $Diagnostic.Bitmask
                $Diagnostic.dataAttributeEnumValues | ForEach-Object { $Hashtable.EnumValues.([string]$_.ValueEnum) = $_.NameEnum }
                $FormatWithUnit = $Diagnostic.formatWithUnit
                $Hashtable.Source = $_
            }
            #
            # Meta is not the best source because it laks enum values and bitmask information
            #
            'Meta' {
                $Code = $Meta.code
                
                if ($Script:VE_ValueFormatting.$SiteId.$Code.Source) {
                    # Object already exists from Meta or Diagnostic
                    return
                }
                
                $FormatWithUnit = $Meta.formatWithUnit
                $Hashtable.Source = $_
            }
            default {
                throw "Unsupported parameter set name '$_'"
            }
        }
        
        if (!$Script:VE_ValueFormatting.$SiteId) {
            Write-Debug "[$Private:ThisFunction] Create the hastable for site $SiteId"
            # Use 'New-Object System.Collections.Hashtable' instead of '@{}' to get a hashtable case sensitive
            $Script:VE_ValueFormatting.$SiteId = New-Object System.Collections.Hashtable
        }
        
        Write-Debug "[$Private:ThisFunction] Fill the hashtable properties"
        $Hashtable.SiteId = $SiteId
        $Hashtable.Code = $Code
        $FormatValue, $Unit = $FormatWithUnit -split ' ',2
        
        #Bugs from VE
        switch ($VEObject.Code) {
            { $_ -in 'AI','Af' } { $FormatValue = '%s' }
            { $_ -in 'TO' } { $FormatValue = '%d' }
        }
        
        $Hashtable.TargetType, $Hashtable.Pattern = switch -Regex ($FormatValue) {
            '^%d$' {
                @([int], '{0:D}')
            }
            '^%s$' {
                @([string], '{0}')
            }
            '^%\.[0-9]+F$' {
                $N = $_ -replace '^%.([0-9]+)F$', '$1'
                @([double], "{0:F$N}")
            }
            default {
                Write-Warning "[$Private:ThisFunction] Unsupported format '$_' for code '$($VEObject.Code)'"
                @([string], '{0}')
            }
        }
        if ($Unit) { $Hashtable.Pattern += ' {0}' -f ($Unit -replace '%%','%') }
        
        Write-Debug "[$Private:ThisFunction] Add formatting object for code $Code from site $SiteId"
        $Script:VE_ValueFormatting.$SiteId.$Code = [PSCustomObject] $Hashtable
    }
    
    end {
        Write-Debug "[$Private:ThisFunction] End"
    }
}

# SIG # Begin signature block
# MIIIbQYJKoZIhvcNAQcCoIIIXjCCCFoCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQULX5m5EGeFbwxhvW9SvuwAM1R
# NmqgggX4MIICYjCCAgigAwIBAgITXwAAAAITcsrrTJecaQAAAAAAAjAKBggqhkjO
# 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
# BgEEAYI3AgELMQ4wDAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQU0CQUkOGi
# H1FJPSbXKk7Vg8TE6QQwDQYJKoZIhvcNAQEBBQAEggEATdPzzqrRewYol1IVKjX/
# n667ISQgfIKgiGVPuLPyCrNekqT2NYyBWSRXkCR+/qJIOZoms/zGbKQm1MnG15YA
# aPUqs98+OroCROyZl5s3QaMMPUJFEYke1bZZEv5xQkTqKXTSnA3MCRl7JctjBsRk
# kZsGY5rOyqkshh0X63RAEXgTy4GSXqgeYBLmnXLSWtZl7Pb/HT8SLeYbah3imsyC
# OwRDaFUtDxQZbZDwQ2Ug0Z9otPhqbC0TOOit25eLYzBUfJtDtpUmW/5mGEDGin2v
# FSR4x/+U5lbzB5U9kB+GpxK/LptETsa3QV760VhuPRo3pPQTmBtxpvw8LLsU1sum
# pA==
# SIG # End signature block