public static void Main(string[] args)
{
Console.WriteLine("OPC UA Console Reference Subscriber");
// command line options
bool showHelp = false;
bool useMqttJson = true;
bool useUdpUadp = false;
string subscriberUrl = null;
Mono.Options.OptionSet options = new Mono.Options.OptionSet {
{ "h|help", "Show usage information", v => showHelp = v != null },
{ "m|mqtt_json", "Use MQTT with Json encoding Profile. This is the default option.", v => useMqttJson = v != null },
{ "u|udp_uadp", "Use UDP with UADP encoding Profile", v => useUdpUadp = v != null },
{ "url|subscriber_url=", "Subscriber Url Address", v => subscriberUrl = v },
};
IList <string> extraArgs = null;
try
{
extraArgs = options.Parse(args);
if (extraArgs.Count > 0)
{
foreach (string extraArg in extraArgs)
{
Console.WriteLine("Error: Unknown option: {0}", extraArg);
showHelp = true;
}
}
}
catch (OptionException e)
{
Console.WriteLine(e.Message);
showHelp = true;
}
if (showHelp)
{
Console.WriteLine("Usage: dotnet ConsoleReferenceSubscriber.dll [OPTIONS]");
Console.WriteLine();
Console.WriteLine("Options:");
options.WriteOptionDescriptions(Console.Out);
return;
}
try
{
InitializeLog();
PubSubConfigurationDataType pubSubConfiguration = null;
if (useUdpUadp)
{
// set default UDP Subscriber Url to local multicast if not sent in args.
if (string.IsNullOrEmpty(subscriberUrl))
{
subscriberUrl = "opc.udp://239.0.0.1:4840";
}
// Create configuration using UDP protocol and UADP Encoding
pubSubConfiguration = CreateSubscriberConfiguration_UdpUadp(subscriberUrl);
Console.WriteLine("The Pubsub Connection was initialized using UDP & UADP Profile.");
}
else
{
// set default MQTT Broker Url to localhost if not sent in args.
if (string.IsNullOrEmpty(subscriberUrl))
{
subscriberUrl = "mqtt://localhost:1883";
}
// Create configuration using MQTT protocol and JSON Encoding
pubSubConfiguration = CreateSubscriberConfiguration_MqttJson(subscriberUrl);
Console.WriteLine("The Pubsub Connection was initialized using MQTT & JSON Profile.");
}
// Create the UA Publisher application
using (UaPubSubApplication uaPubSubApplication = UaPubSubApplication.Create(pubSubConfiguration))
{
// Subscribte to DataReceived event
uaPubSubApplication.DataReceived += UaPubSubApplication_DataReceived;
// Start the publisher
uaPubSubApplication.Start();
Console.WriteLine("Subscriber Started. Press Ctrl-C to exit...");
ManualResetEvent quitEvent = new ManualResetEvent(false);
try
{
Console.CancelKeyPress += (sender, eArgs) => {
quitEvent.Set();
eArgs.Cancel = true;
};
}
catch
{
}
// wait for timeout or Ctrl-C
quitEvent.WaitOne();
}
Console.WriteLine("Program ended.");
Console.WriteLine("Press any key to finish...");
Console.ReadKey();
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
/// <summary>
/// Creates a Subscriber PubSubConfiguration object for UDP & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreateSubscriberConfiguration_UdpUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 1
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Subscriber Connection1 UDP UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)1;
pubSubConnection1.TransportProfileUri = Profiles.PubSubUdpUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Define "Simple" MetaData
DataSetMetaDataType simpleMetaData = CreateDataSetMetaDataSimple();
// Define "AllTypes" Metadata
DataSetMetaDataType allTypesMetaData = CreateDataSetMetaDataAllTypes();
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader 'Simple' for PublisherId = (UInt16)1, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1 UDP UADP";
dataSetReaderSimple.PublisherId = (UInt16)1;
dataSetReaderSimple.WriterGroupId = 0;
dataSetReaderSimple.DataSetWriterId = 0;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderSimple.KeyFrameCount = 1;
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
dataSetReaderSimple.TransportSettings = new ExtensionObject(new DataSetReaderTransportDataType());
UadpDataSetReaderMessageDataType uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
DataSetOffset = 15,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader 'AllTypes' for PublisherId = (UInt16)1, DataSetWriterId = 2
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2 UDP UADP";
dataSetReaderAllTypes.PublisherId = (UInt16)1;
dataSetReaderAllTypes.WriterGroupId = 0;
dataSetReaderAllTypes.DataSetWriterId = 0;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
dataSetReaderAllTypes.TransportSettings = new ExtensionObject(new DataSetReaderTransportDataType());
uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
DataSetOffset = 47,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexAllTypes),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a Subscriber PubSubConfiguration object for MQTT & Json programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreateSubscriberConfiguration_MqttJson(string urlAddress)
{
// Define a PubSub connection with PublisherId 2
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Subscriber Connection3 MQTT Json";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)2;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttJsonTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
// Define "Simple" MetaData
DataSetMetaDataType simpleMetaData = CreateDataSetMetaDataSimple();
// Define "AllTypes" Metadata
DataSetMetaDataType allTypesMetaData = CreateDataSetMetaDataAllTypes();
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader1 'Simple' for PublisherId = (UInt16)3, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1 MQTT JSON Variant Encoding";
dataSetReaderSimple.PublisherId = (UInt16)2;
dataSetReaderSimple.WriterGroupId = 1;
dataSetReaderSimple.DataSetWriterId = 1;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = 0;// Variant encoding;
dataSetReaderSimple.KeyFrameCount = 1;
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
BrokerDataSetReaderTransportDataType brokerTransportSettings = new BrokerDataSetReaderTransportDataType()
{
QueueName = "Json_WriterGroup_1",
};
dataSetReaderSimple.TransportSettings = new ExtensionObject(brokerTransportSettings);
JsonDataSetReaderMessageDataType jsonDataSetReaderMessage = new JsonDataSetReaderMessageDataType()
{
NetworkMessageContentMask = (uint)(uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo),
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(jsonDataSetReaderMessage);
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader2 'AllTypes' for PublisherId = (UInt16)2, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2 MQTT JSON RawData Encoding";
dataSetReaderAllTypes.PublisherId = (UInt16)2;
dataSetReaderAllTypes.WriterGroupId = 1;
dataSetReaderAllTypes.DataSetWriterId = 2;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
brokerTransportSettings = new BrokerDataSetReaderTransportDataType()
{
QueueName = "Json_WriterGroup_1",
};
dataSetReaderAllTypes.TransportSettings = new ExtensionObject(brokerTransportSettings);
jsonDataSetReaderMessage = new JsonDataSetReaderMessageDataType()
{
NetworkMessageContentMask = (uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo),
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(jsonDataSetReaderMessage);
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a PubSubConfiguration object for MQTT & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_MqttUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 3
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection MQTT UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)3;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
string brokerQueueName = "Uadp_WriterGroup_1";
string brokerMetaData = "$Metadata";
#region Define WriterGroup1
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
writerGroup1.HeaderLayoutUri = "UADP-Cyclic-Fixed";
UadpWriterGroupMessageDataType uadpMessageSettings = new UadpWriterGroupMessageDataType()
{
DataSetOrdering = DataSetOrderingType.AscendingWriterId,
GroupVersion = 0,
NetworkMessageContentMask = (uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.PayloadHeader
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber)
};
writerGroup1.MessageSettings = new ExtensionObject(uadpMessageSettings);
// initialize Broker transport settings
writerGroup1.TransportSettings = new ExtensionObject(new BrokerWriterGroupTransportDataType()
{
QueueName = brokerQueueName,
});
// Define DataSetWriter 'Simple'
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer 1";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
UadpDataSetWriterMessageDataType uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 15,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter1.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
BrokerDataSetWriterTransportDataType uadpDataSetWriterTransport = new BrokerDataSetWriterTransportDataType()
{
QueueName = brokerQueueName,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
MetaDataUpdateTime = 60000
};
dataSetWriter1.TransportSettings = new ExtensionObject(uadpDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'AllTypes'
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer 2";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 47,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter2.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
dataSetWriter2.TransportSettings = new ExtensionObject(uadpDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a PubSubConfiguration object for MQTT & Json programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_MqttJson(string urlAddress)
{
// Define a PubSub connection with PublisherId 2
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection MQTT Json";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)2;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttJsonTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTT broker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
string brokerQueueName = "Json_WriterGroup_1";
string brokerMetaData = "$Metadata";
#region Define WriterGroup1 - Json
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
JsonWriterGroupMessageDataType jsonMessageSettings = new JsonWriterGroupMessageDataType()
{
NetworkMessageContentMask = (uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo)
};
writerGroup1.MessageSettings = new ExtensionObject(jsonMessageSettings);
writerGroup1.TransportSettings = new ExtensionObject(new BrokerWriterGroupTransportDataType()
{
QueueName = brokerQueueName,
});
// Define DataSetWriter 'Simple' Variant encoding
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer Variant Encoding";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.None;// Variant encoding;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 3;
JsonDataSetWriterMessageDataType jsonDataSetWriterMessage = new JsonDataSetWriterMessageDataType()
{
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetWriter1.MessageSettings = new ExtensionObject(jsonDataSetWriterMessage);
BrokerDataSetWriterTransportDataType jsonDataSetWriterTransport = new BrokerDataSetWriterTransportDataType()
{
QueueName = brokerQueueName,
RequestedDeliveryGuarantee = BrokerTransportQualityOfService.BestEffort,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
MetaDataUpdateTime = 0,
};
dataSetWriter1.TransportSettings = new ExtensionObject(jsonDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'Simple' - Variant encoding
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer RawData Encoding";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
jsonDataSetWriterMessage = new JsonDataSetWriterMessageDataType()
{
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetWriter2.MessageSettings = new ExtensionObject(jsonDataSetWriterMessage);
jsonDataSetWriterTransport = new BrokerDataSetWriterTransportDataType()
{
QueueName = brokerQueueName,
RequestedDeliveryGuarantee = BrokerTransportQualityOfService.BestEffort,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
MetaDataUpdateTime = 0
};
dataSetWriter2.TransportSettings = new ExtensionObject(jsonDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a PubSubConfiguration object for UDP & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_UdpUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 1
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection UDP UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)1;
pubSubConnection1.TransportProfileUri = Profiles.PubSubUdpUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// configure custom DiscoveryAddress for Discovery messages
pubSubConnection1.TransportSettings = new ExtensionObject()
{
Body = new DatagramConnectionTransportDataType()
{
DiscoveryAddress = new ExtensionObject()
{
Body = new NetworkAddressUrlDataType()
{
Url = "opc.udp://224.0.2.15:4840"
}
}
}
};
#region Define WriterGroup1
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
writerGroup1.HeaderLayoutUri = "UADP-Cyclic-Fixed";
UadpWriterGroupMessageDataType uadpMessageSettings = new UadpWriterGroupMessageDataType()
{
DataSetOrdering = DataSetOrderingType.AscendingWriterId,
GroupVersion = 0,
NetworkMessageContentMask = (uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.PayloadHeader // needed to be able to decode the DataSetWriterId
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber)
};
writerGroup1.MessageSettings = new ExtensionObject(uadpMessageSettings);
// initialize Datagram (UDP) Transport Settings
writerGroup1.TransportSettings = new ExtensionObject(new DatagramWriterGroupTransportDataType());
// Define DataSetWriter 'Simple'
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer 1";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
UadpDataSetWriterMessageDataType uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter1.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'AllTypes'
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer 2";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter2.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
public void ValidateUdpPubSubConnectionNetworkMessagePublishUnicast()
{
//Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//create publisher configuration object with modified port
string configurationFile = Utils.GetAbsoluteFilePath(PublisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
IPAddress unicastIPAddress = localhost.Address;
Assert.IsNotNull(unicastIPAddress, "unicastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = "opc.udp://" + unicastIPAddress.ToString() + ":4840";
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
//create publisher UaPubSubApplication with changed configuration settings
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
// will signal that the uadp message was received from local ip
m_shutdownEvent = new ManualResetEvent(false);
//setup uadp client for receiving from multicast (simulate a subscriber unicast)
UdpClient udpUnicastClient = new UdpClientUnicast(localhost.Address, 4840);
Assert.IsNotNull(udpUnicastClient, "udpUnicastClient is null");
udpUnicastClient.BeginReceive(new AsyncCallback(OnReceive), udpUnicastClient);
// prepare a network message
WriterGroupDataType writerGroup0 = publisherConnection.PubSubConnectionConfiguration.WriterGroups.First();
System.Collections.Generic.IList <UaNetworkMessage> networkMessages = publisherConnection.CreateNetworkMessages(writerGroup0, new WriterGroupPublishState());
Assert.IsNotNull(networkMessages, "connection.CreateNetworkMessages shall not return null");
//Act
publisherConnection.Start();
if (networkMessages != null)
{
foreach (UaNetworkMessage uaNetworkMessage in networkMessages)
{
if (uaNetworkMessage != null)
{
publisherConnection.PublishNetworkMessage(uaNetworkMessage);
}
}
}
//Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("The UADP message was not received");
}
publisherConnection.Stop();
udpUnicastClient.Close();
udpUnicastClient.Dispose();
}
public void ValidateUadpPubSubConnectionNetworkMessageReceiveFromUnicast()
{
// Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
PubSubConfigurationDataType subscriberConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(SubscriberConfigurationFileName);
Assert.IsNotNull(subscriberConfiguration, "subscriberConfiguration is null");
NetworkAddressUrlDataType subscriberAddress = new NetworkAddressUrlDataType();
subscriberAddress.Url = "opc.udp://" + localhost.Address.ToString() + ":4840";
subscriberConfiguration.Connections[0].Address = new ExtensionObject(subscriberAddress);
UaPubSubApplication subscriberApplication = UaPubSubApplication.Create(subscriberConfiguration);
Assert.IsNotNull(subscriberApplication, "subscriberApplication is null");
UadpPubSubConnection subscriberConnection = subscriberApplication.PubSubConnections[0] as UadpPubSubConnection;
Assert.IsNotNull(subscriberConnection, "subscriberConnection is null");
subscriberConnection.UadpMessageReceived += DataReceived;
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(PublisherConfigurationFileName);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = "opc.udp://" + localhost.Address.ToString() + ":4840";
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UadpPubSubConnection publisherConnection = publisherApplication.PubSubConnections[0] as UadpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
//Act
subscriberConnection.Start();
m_shutdownEvent = new ManualResetEvent(false);
// physical network ip is mandatory on UdpClientUnicast as parameter
UdpClient udpUnicastClient = new UdpClientUnicast(localhost.Address, 4840);
Assert.IsNotNull(udpUnicastClient, "udpUnicastClient is null");
// first physical network ip = unicast address ip
IPEndPoint remoteEndPoint = new IPEndPoint(localhost.Address, 4840);
Assert.IsNotNull(remoteEndPoint, "remoteEndPoint is null");
m_sentBytes = PrepareData(publisherConnection);
int sentBytesLen = udpUnicastClient.Send(m_sentBytes, m_sentBytes.Length, remoteEndPoint);
Assert.AreEqual(sentBytesLen, m_sentBytes.Length, "Sent bytes size not equal to published bytes size!");
Thread.Sleep(EstimatedPublishingTime);
// Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("Subscriber unicast error ... published data not received");
}
subscriberConnection.Stop();
}
