Sample JSON file

This represents the sample JSON file that ships with the MQTT software.

{

"System": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"HealthEndpoints": [],

"Components": [

{

"componentId": "OmfEgress",

"componentType": "OmfEgress"

},

{

"componentId": "MQTT1",

"componentType": "MQTT"

},

{

"componentId": "MQTTSparkplugB1",

"componentType": "MQTTSparkplugB"

}

],

"Buffering": {

"bufferLocation": "C:/ProgramData/OSIsoft/Adapters/MQTT/Buffers",

"maxBufferSizeMB": 1024,

"enablePersistentBuffering": true,

"maxDataBulkTime": "00:00:01"

},

"General": {

"enableDiagnostics": true,

"metadataLevel": "Medium",

"includeSourceProperties": [

"All"

],

"healthPrefix": null

},

"ClientFailover": {}

},

"MQTT1": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"DataSource": {

"hostNameOrIpAddress": "125.0.0.0",

"port": 8883,

"protocol": "Tcp",

"tls": "Tls12",

"username": null,

"password": null,

"clientId": "Test-Client-Id",

"clientCertificateThumbprint": null,

"clientCertificatePassword": null,

"mqttVersion": "3.1.1",

"validateServerCertificate": true,

"timeZone": "UTC",

"streamIdPrefix": "MyPrefix.",

"defaultStreamIdPattern": "{Topic}.{ValueField}"

},

"DataFilters": [

{

"id": "DuplicateData",

"absoluteDeadband": 0,

"percentChange": null,

"expirationPeriod": "1:00:00"

}

],

"DataSelection": [

[

{

"selected": true,

"name": null,

"streamId": "RandomStreamId",

"dataFilterId": null,

"topic": "RandomTopic",

"uom": null,

"valueField": null,

"indexField": "$.Timestamp",

"indexFormat": null,

"dataType": "Geolocation",

"dataFields": {

"Latitude": "$.Float1",

"Longitude": "$.Float2"

}

},

{

"selected": true,

"name": null,

"streamId": "RandomStreamId",

"dataFilterId": null,

"topic": "RandomTopic",

"uom": null,

"valueField": null,

"indexField": "$.Timestamp",

"indexFormat": null,

"dataType": "Coordinates",

"dataFields": {

"x": "$.Float4",

"y": "$.Float5",

"z": "$.Float6"

}

}

]

],

"ClientSettings": {

"reconnectionWaitPeriod": "0:00:05",

"keepAlivePeriod": "0:00:30",

"qosLevel": "ExactlyOnce",

"maxClientQueueSize": 1000

}

},

"OmfEgress": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"DataEndpoints": [

{

"id": "PIWebAPI EndPoint",

"endpoint": "https://PIWEBAPIServer/piwebapi/omf",

"userName": "USERNAME",

"password": "PASSWORD"

},

{

"id": "CONNECT Endpoint",

"endpoint": "https://CONNECT Endpoint/omf",

"clientId": "CLIENTID",

"clientSecret": "CLIENTSECRET"

},

{

"id": "EDS",

"endpoint": "http://localhost:<EDSPORT>/api/v1/tenants/default/namespaces/default/omf"

}

]

}

}

Generic MQTT

{

"System": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"HealthEndpoints": [],

"Components": [

{

"componentId": "OmfEgress",

"componentType": "OmfEgress"

},

{

"componentId": "MQTT1",

"componentType": "MQTT"

]

],

"Buffering": {

"bufferLocation": "C:/ProgramData/OSIsoft/Adapters/MQTT/Buffers",

"maxBufferSizeMB": 1024,

"enablePersistentBuffering": true,

"maxDataBulkTime": "00:00:01"

},

"General": {

"enableDiagnostics": true,

"metadataLevel": "Medium",

"includeSourceProperties": [

"All"

],

"healthPrefix": null

},

"ClientFailover": {}

},

"MQTT1": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"DataSource": {

"hostNameOrIpAddress": "mqtt://broker.example.com",

"port": 1883,

"protocol": "Tcp",

"tls": "none",

"username": "mqttUser",

"password": "{{SecretPassword}}",

"clientId": "mqtt-client-01",

"mqttVersion": "3.1.1",

"streamIdPrefix": "MyPrefix.",

"defaultStreamIdPattern": "{Topic}.{ValueField}"

},

"DataFilters": [

{

"id": "DuplicateData",

"absoluteDeadband": 0,

"percentChange": null,

"expirationPeriod": "1:00:00"

}

],

"DataSelection": [

[

"topic": "sensors/temperature",

"selected": true,

"name": "TemperatureSensor",

"streamId": "sensors/temperature$.Temperature",

"dataFilterId": null,

"uom": "C",

"valueField": "$.Temperature",

"indexField": "$.Timestamp",

"indexFormat": null,

"dataType": "Float32"

},

{

"topic": "sensors/humidity",

"selected": true,

"name": "HumiditySensor",

"streamId": "sensors/humidity$.Humidity",

"dataFilterId": null,

"uom": "g/kg",

"valueField": "$.Humidity",

"indexField": "$.Timestamp",

"indexFormat": null,

"dataType": "Float32"

}

],

"ClientSettings": {

"reconnectionWaitPeriod": "0:00:05",

"keepAlivePeriod": "0:00:30",

"qosLevel": "ExactlyOnce",

"maxClientQueueSize": 1000

]

}

}

Sparkplug B MQTT

{

"System": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"HealthEndpoints": [],

"Components": [

{

"componentId": "OmfEgress",

"componentType": "OmfEgress"

},

{

"componentId": "MQTTSparkplugB1",

"componentType": "MQTTSparkplugB1"

]

],

"Buffering": {

"bufferLocation": "C:/ProgramData/OSIsoft/Adapters/MQTT/Buffers",

"maxBufferSizeMB": 1024,

"enablePersistentBuffering": true,

"maxDataBulkTime": "00:00:01"

},

"General": {

"enableDiagnostics": true,

"metadataLevel": "Medium",

"includeSourceProperties": [

"All"

],

"healthPrefix": null

},

"ClientFailover": {}

},

"MQTTSparkplugB1": {

"Logging": {

"logLevel": "Information",

"logFileSizeLimitBytes": 34636833,

"logFileCountLimit": 31

},

"DataSource": {

"hostNameOrIpAddress": "148.101.185.11",

"port": 1883,

"primaryHostId": "Optimus",

"protocol": "Tcp",

"tls": "Tls12",

"userName": "SampleUser",

"passWord": "SamplePassword",

"clientId": "734029baf8f04bb2be99750381d6602a",

"mqttVersion": "3.1.1",

"validateServerCertificate": true,

"streamIdPrefix": null,

"defaultStreamIdPattern": "{Topic}.{MetricName}"

},

"DataFilters": [

{

"id": "DuplicateData",

"absoluteDeadband": 0,

"percentChange": null,

"expirationPeriod": "1:00:00"

}

],

"DataSelection": [

[

"selected": true,

"name": "Temperature",

"topic": "spBv1.0/group1/DDATA/edgeNode1/device1",

"metricName": "Device1 Temperature",

"streamId": "Device1.Temperature.Stream",

"dataFilterId": null,

"uom": "Celsius"

}

],

"ClientSettings": {

"reconnectionWaitPeriod": "0:00:05",

"keepAlivePeriod": "0:00:30",

"qosLevel": "ExactlyOnce",

"maxClientQueueSize": 1000

]

}

}