//****************************************************************************************************** // SELPDCConfig.cs - Gbtc // // Copyright © 2021, Grid Protection Alliance. All Rights Reserved. // // Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See // the NOTICE file distributed with this work for additional information regarding copyright ownership. // The GPA licenses this file to you under the MIT License (MIT), the "License"; you may not use this // file except in compliance with the License. You may obtain a copy of the License at: // // http://opensource.org/licenses/MIT // // Unless agreed to in writing, the subject software distributed under the License is distributed on an // "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the // License for the specific language governing permissions and limitations. // // Code Modification History: // ---------------------------------------------------------------------------------------------------- // 01/01/2021 - J. Ritchie Carroll // Generated original version of source code. // //****************************************************************************************************** using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Windows.Forms; using System.Xml.Linq; using GSF; using GSF.Communication; using GSF.FuzzyStrings; using GSF.PhasorProtocols; using GSF.Units.EE; using GSF.Xml; using ShowMessageFunc = System.Func; namespace SELPDCImporter { // By replacing this one class, a converter from any other PDC configuration can be created. The result // should always be a ConfigurationFrame that has all needed information to create an input configuration // in the host GPA synchrophasor application, e.g., openPDC. public static class SELPDCConfig { public const string IPAddressToken = "[[ipAddress]]"; public const string DefaultLineFrequency = "60"; public const string DefaultServerName = "SELPDC"; public const ushort DefaultIDCode = 1; public const ushort DefaultFrameRate = 30; public const string DefaultPhasorType = "Voltage"; public const char DefaultPhase = '+'; public const string DefaultTransportProtocol = "TCP"; public const ushort DefaultCommandPort = 4713; public const ushort DefaultDataPort = 4950; public const ushort DefaultPort = 4712; public const bool DefaultMulticastEnabled = false; public const string DefaultMulticastGroup = "224.0.1.0"; public const string DefaultGatewayIP = "192.168.1.1"; public static ConfigurationFrame Parse(string configFile, ShowMessageFunc showMessage) { XDocument config = XDocument.Load(configFile); // Load all "SettingsGroup" elements XElement[] settingsGroups = config.Descendants("SettingsGroup").ToArray(); // Load nominal frequency from "Globals" setting group string nominalFrequencySetting = settingsGroups .WhereAttribute("Type").Is("Globals") .Descendants("Setting") .WhereAttribute("Name").Is("Frequency") .GetValue(DefaultLineFrequency); LineFrequency nominalFrequency = nominalFrequencySetting.Equals("50") ? LineFrequency.Hz50 : LineFrequency.Hz60; // Get server gateway instances XElement[] serverGatewayInstances = settingsGroups .WhereAttribute("Type").Is("ServerGateway") .Descendants("Instance") .WhereAttribute("Type").Is("Server") .ToArray(); if (serverGatewayInstances.Length == 0) throw new NullReferenceException($"No server gateway instances where defined in \"{Path.GetFileName(configFile)}\"."); int enabledInstanceCount = serverGatewayInstances .Count(elem => elem.Descendants("Setting") .WhereAttribute("Name").Is("Enabled") .GetValue(false)); XElement serverGatewayInstance = null; if (enabledInstanceCount == 0) { if (showMessage($"No enabled server gateway instances where found in \"{Path.GetFileName(configFile)}\", do you want to load a disabled instance?", "No Enabled Server Gateways Found", MessageBoxButtons.YesNo, MessageBoxIcon.Question) != DialogResult.Yes) throw new NullReferenceException("Failed to load an enabled server gateway instance."); serverGatewayInstance = serverGatewayInstances.FirstOrDefault(); } else { if (enabledInstanceCount > 1 && showMessage($"Found {enabledInstanceCount:N0} enabled server gateway instances in \"{Path.GetFileName(configFile)}\", do you want to load first enabled instance?", "Multiple Enabled Server Gateways Found", MessageBoxButtons.YesNo, MessageBoxIcon.Question) != DialogResult.Yes) throw new NullReferenceException("Failed to load an enabled server gateway instance."); serverGatewayInstance = serverGatewayInstances .FirstOrDefault(elem => elem.Descendants("Setting") .WhereAttribute("Name").Is("Enabled") .GetValue(false)); } if (serverGatewayInstance is null) throw new NullReferenceException("Failed to load any server gateway instance."); // Load all "Setting" elements from server gateway instance XElement[] serverGatewaySettings = serverGatewayInstance .Descendants("Setting") .ToArray(); // Load server name setting string serverName = Path.GetFileNameWithoutExtension(configFile).GetCleanAcronym(); // Load ID code setting ushort idCode = serverGatewaySettings .WhereAttribute("Name").Is("ID") .GetValue(DefaultIDCode); // Load frame rate setting ushort frameRate = serverGatewaySettings .WhereAttribute("Name").Is("DataRate") .GetValue(DefaultFrameRate); // With an ID code, frame rate and server name, there's enough info to create a config frame ConfigurationFrame configFrame = new(idCode, frameRate, serverName); // Load all output PMUs IEnumerable pmus = serverGatewaySettings .WhereAttribute("Name").Is("OutputTags") .Descendants("PMU"); foreach (XElement pmu in pmus) { string name = pmu.Attribute("Name")?.Value; if (string.IsNullOrWhiteSpace(name)) continue; if (!ushort.TryParse(pmu.Attribute("ID")?.Value, out idCode)) continue; // With a name and an ID code, there's enough info to create a config cell representing the PMU ConfigurationCell configCell = new(configFrame, name, idCode) { NominalFrequency = nominalFrequency, }; // Load all PMU tags XElement[] tags = pmu.Descendants("Tag").ToArray(); // Load all phasor tags IEnumerable phasors = tags .WhereAttribute("Type").Is("Phasor"); foreach (XElement phasor in phasors) { name = phasor.Attribute("Name")?.Value; if (string.IsNullOrWhiteSpace(name)) continue; string description = phasor.Attribute("Description")?.Value; string quantityType = phasor.Attribute("QuantityType")?.Value ?? DefaultPhasorType; PhasorType phasorType = quantityType.Equals("Current") ? PhasorType.Current : PhasorType.Voltage; string phaseSetting = phasor.Attribute("Phase")?.Value.Trim(); if (string.IsNullOrWhiteSpace(phaseSetting)) phaseSetting = GuessPhase(phasor.Attribute("OriginalName")?.Value ?? name); char phase = string.IsNullOrWhiteSpace(phaseSetting) ? DefaultPhase : TranslatePhase(phaseSetting[0]); if (string.IsNullOrWhiteSpace(description)) description = $"{configCell.StationName} phase {phase} {phasorType.ToString().ToLowerInvariant()} phasor"; configCell.PhasorDefinitions.Add(new PhasorDefinition(configCell, name, description, phasorType, phase)); } // Load all analog tags IEnumerable analogs = tags .WhereAttribute("Type").Is("Analog"); foreach (XElement analog in analogs) { name = analog.Attribute("Name")?.Value; if (string.IsNullOrWhiteSpace(name)) continue; string description = analog.Attribute("Description")?.Value; if (string.IsNullOrWhiteSpace(description)) description = $"{configCell.StationName} {name} analog value"; configCell.AnalogDefinitions.Add(new AnalogDefinition(configCell, name, description)); } // Load all digital tags IEnumerable digitals = tags .WhereAttribute("Type").Is("Digital"); foreach (XElement digital in digitals) { name = digital.Attribute("Name")?.Value; if (string.IsNullOrWhiteSpace(name)) continue; string description = digital.Attribute("Description")?.Value; if (string.IsNullOrWhiteSpace(description)) description = $"{configCell.StationName} {name} digital value"; configCell.DigitalDefinitions.Add(new DigitalDefinition(configCell, name, description)); } configFrame.Cells.Add(configCell); } // Get connection details configured for SEL PDC string transportProtocol = serverGatewaySettings .WhereAttribute("Name").Is("TransportProtocol") .GetValue(DefaultTransportProtocol) .ToUpperInvariant(); configFrame.TransportProtocol = transportProtocol; ushort commandPort = serverGatewaySettings .WhereAttribute("Name").Is("CommandPort") .GetValue(DefaultCommandPort); ushort dataPort = serverGatewaySettings .WhereAttribute("Name").Is("DataPort") .GetValue(DefaultDataPort); ushort port = serverGatewaySettings .WhereAttribute("Name").Is("Port") .GetValue(DefaultPort); bool multicastEnabled = serverGatewaySettings .WhereAttribute("Name").Is("MulticastEnabled") .GetValue(DefaultMulticastEnabled); string multicastGroup = serverGatewaySettings .WhereAttribute("Name").Is("MulticastGroup") .GetValue(DefaultMulticastGroup); // Setup MultiProtocolFrameParser style connection string Dictionary getTcpSettings(bool commandChannel = false) { // Use of simple "protocol" key in commandChannel and separation of // server/port keys are required to create a proper "PmuConnection" // file that can be successfully parsed by the PMU Connection Tester return new Dictionary(StringComparer.OrdinalIgnoreCase) { [commandChannel ? "protocol" : nameof(TransportProtocol)] = nameof(TransportProtocol.Tcp), ["server"] = IPAddressToken, ["port"] = commandChannel ? $"{commandPort}" : $"{port}", ["isListener"] = "false", ["interface"] = "0.0.0.0" }; } Dictionary settings = configFrame.Settings; settings[nameof(PhasorProtocol)] = nameof(PhasorProtocol.IEEEC37_118V1); if (transportProtocol == "TCP") { foreach (KeyValuePair pair in getTcpSettings()) settings[pair.Key] = pair.Value; } else if (transportProtocol.StartsWith("UDP")) { settings[nameof(TransportProtocol)] = nameof(TransportProtocol.Udp); settings["localPort"] = $"{dataPort}"; settings["interface"] = "0.0.0.0"; switch (transportProtocol) { case "UDP_T": case "UDP_U": settings["commandChannel"] = getTcpSettings(true).JoinKeyValuePairs(); break; } if (multicastEnabled) { settings["server"] = multicastGroup; settings["remotePort"] = $"{commandPort}"; } } else { settings["error"] = "No valid connection protocol detected"; } // Save device IP configuration Dictionary deviceIPs = configFrame.DeviceIPs; // Load "NetworkSettingsGroup" element from settings group XElement networkSettingsGroup = settingsGroups .WhereAttribute("Type").Is("NetworkSettingsGroup") .FirstOrDefault(); if (networkSettingsGroup is null) { deviceIPs["loopback"] = "127.0.0.1"; } else { string gatewayIP = networkSettingsGroup .Descendants("Setting") .WhereAttribute("Name").Is("Gateway") .GetValue(DefaultGatewayIP); // Get array of settings for each NIC interface IEnumerable interfaceSettingsMap = networkSettingsGroup .Descendants("SettingsGroup") .WhereAttribute("Type").Is("NetworkGroup") .Descendants("Instance") .WhereAttribute("Type").Is("NetworkInterfaceCard") .Select(element => element.Descendants("Setting").ToArray()); foreach (XElement[] interfaceSettings in interfaceSettingsMap) { string name = interfaceSettings .WhereAttribute("Name").Is("Name") .GetValue(null); if (string.IsNullOrWhiteSpace(name)) continue; string ipAddress = interfaceSettings .WhereAttribute("Name").Is("IPAddress") .GetValue(null); if (string.IsNullOrWhiteSpace(ipAddress)) continue; deviceIPs[name] = ipAddress; } // Set the target device IP to the one that matches gateway IP the closest, // this is just a guess, user must select proper device IP configFrame.TargetDeviceIP = deviceIPs .ToDictionary(pair => pair.Key, pair => gatewayIP.OverlapCoefficient(pair.Value)) .Aggregate((x, y) => x.Value > y.Value ? x : y).Key; if (string.IsNullOrWhiteSpace(configFrame.TargetDeviceIP) && deviceIPs.Count > 0) configFrame.TargetDeviceIP = deviceIPs.First().Key; } return configFrame; } private static string GetValue(this IEnumerable target, string defaultValue) { string value = target .Descendants("Value") .FirstOrDefault()?.Value ?? $"{defaultValue}"; if (string.IsNullOrWhiteSpace(value)) value = defaultValue ?? ""; return value.Trim(); } private static T GetValue(this IEnumerable target, T defaultValue) where T : IConvertible { Type type = typeof(T); string result = target.GetValue($"{defaultValue}"); if (type == typeof(ushort)) { if (!ushort.TryParse(result, out ushort value)) value = defaultValue.ToUInt16(null); return (T)Convert.ChangeType(value, type); } if (type == typeof(bool)) { bool.TryParse(result, out bool value); return (T)Convert.ChangeType(value, type); } return (T)Convert.ChangeType(result, type); } private static string GuessPhase(string name) => string.IsNullOrWhiteSpace(name) || name.Length < 2 ? null : name[1].ToString(); private static char TranslatePhase(char phase) => phase switch { '1' => '+', '2' => '-', _ => phase }; } }