resources/protocols/protobuf/sparkplug_b.proto

   1 syntax = "proto2";
   2
   3 //
   4 // To compile:
   5 // cd client_libraries/java
   6 // protoc --proto_path=../../ --java_out=src/main/java ../../sparkplug_b.proto
   7 //
   8 package com.cirruslink.sparkplug.protobuf;
   9
  10 option java_package         = "com.cirruslink.sparkplug.protobuf";
  11 option java_outer_classname = "SparkplugBProto";
  12
  13 message Payload {
  14     /*
  15         // Indexes of Data Types
  16
  17         // Unknown placeholder for future expansion.
  18         Unknown         = 0;
  19
  20         // Basic Types
  21         Int8            = 1;
  22         Int16           = 2;
  23         Int32           = 3;
  24         Int64           = 4;
  25         UInt8           = 5;
  26         UInt16          = 6;
  27         UInt32          = 7;
  28         UInt64          = 8;
  29         Float           = 9;
  30         Double          = 10;
  31         Boolean         = 11;
  32         String          = 12;
  33         DateTime        = 13;
  34         Text            = 14;
  35
  36         // Additional Metric Types
  37         UUID            = 15;
  38         DataSet         = 16;
  39         Bytes           = 17;
  40         File            = 18;
  41         Template        = 19;
  42
  43         // Additional PropertyValue Types
  44         PropertySet     = 20;
  45         PropertySetList = 21;
  46
  47     */
  48
  49     message Template {
  50
  51         message Parameter {
  52             optional string name        = 1;
  53             optional uint32 type        = 2;
  54
  55             oneof value {
  56                 uint32 int_value        = 3;
  57                 uint64 long_value       = 4;
  58                 float  float_value      = 5;
  59                 double double_value     = 6;
  60                 bool   boolean_value    = 7;
  61                 string string_value     = 8;
  62                 ParameterValueExtension extension_value = 9;
  63             }
  64
  65             message ParameterValueExtension {
  66                 extensions              1 to max;
  67             }
  68         }
  69
  70         optional string version         = 1;          // The version of the Template to prevent mismatches
  71         repeated Metric metrics         = 2;          // Each metric is the name of the metric and the datatype of the member but does not contain a value
  72         repeated Parameter parameters   = 3;
  73         optional string template_ref    = 4;          // Reference to a template if this is extending a Template or an instance - must exist if an instance
  74         optional bool is_definition     = 5;
  75         extensions                      6 to max;
  76     }
  77
  78     message DataSet {
  79
  80         message DataSetValue {
  81
  82             oneof value {
  83                 uint32 int_value                        = 1;
  84                 uint64 long_value                       = 2;
  85                 float  float_value                      = 3;
  86                 double double_value                     = 4;
  87                 bool   boolean_value                    = 5;
  88                 string string_value                     = 6;
  89                 DataSetValueExtension extension_value   = 7;
  90             }
  91
  92             message DataSetValueExtension {
  93                 extensions  1 to max;
  94             }
  95         }
  96
  97         message Row {
  98             repeated DataSetValue elements  = 1;
  99             extensions                      2 to max;   // For third party extensions
 100         }
 101
 102         optional uint64   num_of_columns    = 1;
 103         repeated string   columns           = 2;
 104         repeated uint32   types             = 3;
 105         repeated Row      rows              = 4;
 106         extensions                          5 to max;   // For third party extensions
 107     }
 108
 109     message PropertyValue {
 110
 111         optional uint32     type                    = 1;
 112         optional bool       is_null                 = 2;
 113
 114         oneof value {
 115             uint32          int_value               = 3;
 116             uint64          long_value              = 4;
 117             float           float_value             = 5;
 118             double          double_value            = 6;
 119             bool            boolean_value           = 7;
 120             string          string_value            = 8;
 121             PropertySet     propertyset_value       = 9;
 122             PropertySetList propertysets_value      = 10;      // List of Property Values
 123             PropertyValueExtension extension_value  = 11;
 124         }
 125
 126         message PropertyValueExtension {
 127             extensions                             1 to max;
 128         }
 129     }
 130
 131     message PropertySet {
 132         repeated string        keys     = 1;         // Names of the properties
 133         repeated PropertyValue values   = 2;
 134         extensions                      3 to max;
 135     }
 136
 137     message PropertySetList {
 138         repeated PropertySet propertyset = 1;
 139         extensions                       2 to max;
 140     }
 141
 142     message MetaData {
 143         // Bytes specific metadata
 144         optional bool   is_multi_part   = 1;
 145
 146         // General metadata
 147         optional string content_type    = 2;        // Content/Media type
 148         optional uint64 size            = 3;        // File size, String size, Multi-part size, etc
 149         optional uint64 seq             = 4;        // Sequence number for multi-part messages
 150
 151         // File metadata
 152         optional string file_name       = 5;        // File name
 153         optional string file_type       = 6;        // File type (i.e. xml, json, txt, cpp, etc)
 154         optional string md5             = 7;        // md5 of data
 155
 156         // Catchalls and future expansion
 157         optional string description     = 8;        // Could be anything such as json or xml of custom properties
 158         extensions                      9 to max;
 159     }
 160
 161     message Metric {
 162
 163         optional string   name          = 1;        // Metric name - should only be included on birth
 164         optional uint64   alias         = 2;        // Metric alias - tied to name on birth and included in all later DATA messages
 165         optional uint64   timestamp     = 3;        // Timestamp associated with data acquisition time
 166         optional uint32   datatype      = 4;        // DataType of the metric/tag value
 167         optional bool     is_historical = 5;        // If this is historical data and should not update real time tag
 168         optional bool     is_transient  = 6;        // Tells consuming clients such as MQTT Engine to not store this as a tag
 169         optional bool     is_null       = 7;        // If this is null - explicitly say so rather than using -1, false, etc for some datatypes.
 170         optional MetaData metadata      = 8;        // Metadata for the payload
 171         optional PropertySet properties = 9;
 172
 173         oneof value {
 174             uint32   int_value                      = 10;
 175             uint64   long_value                     = 11;
 176             float    float_value                    = 12;
 177             double   double_value                   = 13;
 178             bool     boolean_value                  = 14;
 179             string   string_value                   = 15;
 180             bytes    bytes_value                    = 16;       // Bytes, File
 181             DataSet  dataset_value                  = 17;
 182             Template template_value                 = 18;
 183             MetricValueExtension extension_value    = 19;
 184         }
 185
 186         message MetricValueExtension {
 187             extensions  1 to max;
 188         }
 189     }
 190
 191     optional uint64   timestamp     = 1;        // Timestamp at message sending time
 192     repeated Metric   metrics       = 2;        // Repeated forever - no limit in Google Protobufs
 193     optional uint64   seq           = 3;        // Sequence number
 194     optional string   uuid          = 4;        // UUID to track message type in terms of schema definitions
 195     optional bytes    body          = 5;        // To optionally bypass the whole definition above
 196     extensions                      6 to max;   // For third party extensions
 197 }