@uns-kit/cli 2.0.25 → 2.0.27

package/templates/python/gen/uns_gateway_pb2.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: uns-gateway.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'uns-gateway.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x11uns-gateway.proto\x12\x03uns\"\xda\x01\n\x0ePublishRequest\x12\r\n\x05topic\x18\x01 \x01(\t\x12\x11\n\tattribute\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x0c\n\x04tags\x18\x04 \x03(\t\x12#\n\x1b\x61ttribute_needs_persistence\x18\x05 \x01(\x08\x12\x19\n\x04\x64\x61ta\x18\x06 \x01(\x0b\x32\t.uns.DataH\x00\x12\x1b\n\x05table\x18\x07 \x01(\x0b\x32\n.uns.TableH\x00\x12\x1b\n\x13value_is_cumulative\x18\x08 \x01(\x08\x42\t\n\x07\x63ontent\"|\n\x04\x44\x61ta\x12\x0c\n\x04time\x18\x01 \x01(\t\x12\x14\n\x0cvalue_number\x18\x02 \x01(\x01\x12\x14\n\x0cvalue_string\x18\x03 \x01(\t\x12\x0b\n\x03uom\x18\x04 \x01(\t\x12\x12\n\ndata_group\x18\x05 \x01(\t\x12\x19\n\x11\x66oreign_event_key\x18\x06 \x01(\t\"E\n\nTableValue\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x14\n\x0cvalue_number\x18\x02 \x01(\x01\x12\x14\n\x0cvalue_string\x18\x03 \x01(\t\"J\n\x05Table\x12\x0c\n\x04time\x18\x01 \x01(\t\x12\x1f\n\x06values\x18\x02 \x03(\x0b\x32\x0f.uns.TableValue\x12\x12\n\ndata_group\x18\x03 \x01(\t\"\"\n\x10SubscribeRequest\x12\x0e\n\x06topics\x18\x01 \x03(\t\"-\n\x0bMqttMessage\x12\r\n\x05topic\x18\x01 \x01(\t\x12\x0f\n\x07payload\x18\x02 \x01(\t\" \n\x03\x41\x63k\x12\n\n\x02ok\x18\x01 \x01(\x08\x12\r\n\x05\x65rror\x18\x02 \x01(\t\"]\n\x0cReadyRequest\x12\x12\n\ntimeout_ms\x18\x01 \x01(\x05\x12\x13\n\x0bwait_output\x18\x02 \x01(\x08\x12\x12\n\nwait_input\x18\x03 \x01(\x08\x12\x10\n\x08wait_api\x18\x04 \x01(\x08\"R\n\rApiQueryParam\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04type\x18\x02 \x01(\t\x12\x10\n\x08required\x18\x03 \x01(\x08\x12\x13\n\x0b\x64\x65scription\x18\x04 \x01(\t\"\x8a\x01\n\x15RegisterApiGetRequest\x12\r\n\x05topic\x18\x01 \x01(\t\x12\x11\n\tattribute\x18\x02 \x01(\t\x12\x17\n\x0f\x61pi_description\x18\x03 \x01(\t\x12\x0c\n\x04tags\x18\x04 \x03(\t\x12(\n\x0cquery_params\x18\x05 \x03(\x0b\x32\x12.uns.ApiQueryParam\";\n\x17UnregisterApiGetRequest\x12\r\n\x05topic\x18\x01 \x01(\t\x12\x11\n\tattribute\x18\x02 \x01(\t\"\x9b\x01\n\x08\x41piEvent\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0e\n\x06method\x18\x02 \x01(\t\x12\x0c\n\x04path\x18\x03 \x01(\t\x12\'\n\x05query\x18\x04 \x03(\x0b\x32\x18.uns.ApiEvent.QueryEntry\x12\x0e\n\x06\x62\x65\x61rer\x18\x05 \x01(\t\x1a,\n\nQueryEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\xa1\x01\n\x10\x41piEventResponse\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0e\n\x06status\x18\x02 \x01(\x05\x12\x0c\n\x04\x62ody\x18\x03 \x01(\t\x12\x33\n\x07headers\x18\x04 \x03(\x0b\x32\".uns.ApiEventResponse.HeadersEntry\x1a.\n\x0cHeadersEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x32\xc4\x02\n\nUnsGateway\x12(\n\x07Publish\x12\x13.uns.PublishRequest\x1a\x08.uns.Ack\x12\x36\n\tSubscribe\x12\x15.uns.SubscribeRequest\x1a\x10.uns.MqttMessage0\x01\x12\x36\n\x0eRegisterApiGet\x12\x1a.uns.RegisterApiGetRequest\x1a\x08.uns.Ack\x12:\n\x10UnregisterApiGet\x12\x1c.uns.UnregisterApiGetRequest\x1a\x08.uns.Ack\x12:\n\x0e\x41piEventStream\x12\x15.uns.ApiEventResponse\x1a\r.uns.ApiEvent(\x01\x30\x01\x12$\n\x05Ready\x12\x11.uns.ReadyRequest\x1a\x08.uns.Ackb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'uns_gateway_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_APIEVENT_QUERYENTRY']._loaded_options = None
+  _globals['_APIEVENT_QUERYENTRY']._serialized_options = b'8\001'
+  _globals['_APIEVENTRESPONSE_HEADERSENTRY']._loaded_options = None
+  _globals['_APIEVENTRESPONSE_HEADERSENTRY']._serialized_options = b'8\001'
+  _globals['_PUBLISHREQUEST']._serialized_start=27
+  _globals['_PUBLISHREQUEST']._serialized_end=245
+  _globals['_DATA']._serialized_start=247
+  _globals['_DATA']._serialized_end=371
+  _globals['_TABLEVALUE']._serialized_start=373
+  _globals['_TABLEVALUE']._serialized_end=442
+  _globals['_TABLE']._serialized_start=444
+  _globals['_TABLE']._serialized_end=518
+  _globals['_SUBSCRIBEREQUEST']._serialized_start=520
+  _globals['_SUBSCRIBEREQUEST']._serialized_end=554
+  _globals['_MQTTMESSAGE']._serialized_start=556
+  _globals['_MQTTMESSAGE']._serialized_end=601
+  _globals['_ACK']._serialized_start=603
+  _globals['_ACK']._serialized_end=635
+  _globals['_READYREQUEST']._serialized_start=637
+  _globals['_READYREQUEST']._serialized_end=730
+  _globals['_APIQUERYPARAM']._serialized_start=732
+  _globals['_APIQUERYPARAM']._serialized_end=814
+  _globals['_REGISTERAPIGETREQUEST']._serialized_start=817
+  _globals['_REGISTERAPIGETREQUEST']._serialized_end=955
+  _globals['_UNREGISTERAPIGETREQUEST']._serialized_start=957
+  _globals['_UNREGISTERAPIGETREQUEST']._serialized_end=1016
+  _globals['_APIEVENT']._serialized_start=1019
+  _globals['_APIEVENT']._serialized_end=1174
+  _globals['_APIEVENT_QUERYENTRY']._serialized_start=1130
+  _globals['_APIEVENT_QUERYENTRY']._serialized_end=1174
+  _globals['_APIEVENTRESPONSE']._serialized_start=1177
+  _globals['_APIEVENTRESPONSE']._serialized_end=1338
+  _globals['_APIEVENTRESPONSE_HEADERSENTRY']._serialized_start=1292
+  _globals['_APIEVENTRESPONSE_HEADERSENTRY']._serialized_end=1338
+  _globals['_UNSGATEWAY']._serialized_start=1341
+  _globals['_UNSGATEWAY']._serialized_end=1665
+# @@protoc_insertion_point(module_scope)

package/templates/python/gen/uns_gateway_pb2_grpc.py

@@ -0,0 +1,312 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from . import uns_gateway_pb2 as uns__gateway__pb2
+
+GRPC_GENERATED_VERSION = '1.75.1'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in uns_gateway_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class UnsGatewayStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Publish = channel.unary_unary(
+                '/uns.UnsGateway/Publish',
+                request_serializer=uns__gateway__pb2.PublishRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.Subscribe = channel.unary_stream(
+                '/uns.UnsGateway/Subscribe',
+                request_serializer=uns__gateway__pb2.SubscribeRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.MqttMessage.FromString,
+                _registered_method=True)
+        self.RegisterApiGet = channel.unary_unary(
+                '/uns.UnsGateway/RegisterApiGet',
+                request_serializer=uns__gateway__pb2.RegisterApiGetRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.UnregisterApiGet = channel.unary_unary(
+                '/uns.UnsGateway/UnregisterApiGet',
+                request_serializer=uns__gateway__pb2.UnregisterApiGetRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.ApiEventStream = channel.stream_stream(
+                '/uns.UnsGateway/ApiEventStream',
+                request_serializer=uns__gateway__pb2.ApiEventResponse.SerializeToString,
+                response_deserializer=uns__gateway__pb2.ApiEvent.FromString,
+                _registered_method=True)
+        self.Ready = channel.unary_unary(
+                '/uns.UnsGateway/Ready',
+                request_serializer=uns__gateway__pb2.ReadyRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+
+
+class UnsGatewayServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Publish(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Subscribe(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def RegisterApiGet(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def UnregisterApiGet(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def ApiEventStream(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Ready(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_UnsGatewayServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Publish': grpc.unary_unary_rpc_method_handler(
+                    servicer.Publish,
+                    request_deserializer=uns__gateway__pb2.PublishRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'Subscribe': grpc.unary_stream_rpc_method_handler(
+                    servicer.Subscribe,
+                    request_deserializer=uns__gateway__pb2.SubscribeRequest.FromString,
+                    response_serializer=uns__gateway__pb2.MqttMessage.SerializeToString,
+            ),
+            'RegisterApiGet': grpc.unary_unary_rpc_method_handler(
+                    servicer.RegisterApiGet,
+                    request_deserializer=uns__gateway__pb2.RegisterApiGetRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'UnregisterApiGet': grpc.unary_unary_rpc_method_handler(
+                    servicer.UnregisterApiGet,
+                    request_deserializer=uns__gateway__pb2.UnregisterApiGetRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'ApiEventStream': grpc.stream_stream_rpc_method_handler(
+                    servicer.ApiEventStream,
+                    request_deserializer=uns__gateway__pb2.ApiEventResponse.FromString,
+                    response_serializer=uns__gateway__pb2.ApiEvent.SerializeToString,
+            ),
+            'Ready': grpc.unary_unary_rpc_method_handler(
+                    servicer.Ready,
+                    request_deserializer=uns__gateway__pb2.ReadyRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'uns.UnsGateway', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('uns.UnsGateway', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class UnsGateway(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Publish(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/Publish',
+            uns__gateway__pb2.PublishRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def Subscribe(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(
+            request,
+            target,
+            '/uns.UnsGateway/Subscribe',
+            uns__gateway__pb2.SubscribeRequest.SerializeToString,
+            uns__gateway__pb2.MqttMessage.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def RegisterApiGet(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/RegisterApiGet',
+            uns__gateway__pb2.RegisterApiGetRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def UnregisterApiGet(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/UnregisterApiGet',
+            uns__gateway__pb2.UnregisterApiGetRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def ApiEventStream(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/uns.UnsGateway/ApiEventStream',
+            uns__gateway__pb2.ApiEventResponse.SerializeToString,
+            uns__gateway__pb2.ApiEvent.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def Ready(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/Ready',
+            uns__gateway__pb2.ReadyRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

package/templates/python/gitignore

@@ -1,47 +1,47 @@
-# Python bytecode
-__pycache__/
-*.py[cod]
-*$py.class
-
-# Virtual environments
-.venv/
-venv/
-env/
-ENV/
-.venv*/
-
-# Packaging / build artifacts
-build/
-dist/
-.eggs/
-*.egg-info/
-*.egg
-pip-wheel-metadata/
-.wheels/
-
-# Tests / coverage
-.pytest_cache/
-.coverage*
-htmlcov/
-.hypothesis/
-
-# Tool caches
-.mypy_cache/
-.ruff_cache/
-
-# Logs
-*.log
-
-# Editor / OS
-.idea/
-.vscode/
-.DS_Store
-Thumbs.db
-*.swp
-
-# Local configuration
-config.json
-config-*.json
-
-# Temp
-/tmp/
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.venv*/
+
+# Packaging / build artifacts
+build/
+dist/
+.eggs/
+*.egg-info/
+*.egg
+pip-wheel-metadata/
+.wheels/
+
+# Tests / coverage
+.pytest_cache/
+.coverage*
+htmlcov/
+.hypothesis/
+
+# Tool caches
+.mypy_cache/
+.ruff_cache/
+
+# Logs
+*.log
+
+# Editor / OS
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db
+*.swp
+
+# Local configuration
+config.json
+config-*.json
+
+# Temp
+/tmp/

package/templates/python/proto/uns-gateway.proto

@@ -1,102 +1,102 @@
-syntax = "proto3";
-
-package uns;
-
-service UnsGateway {
-  rpc Publish (PublishRequest) returns (Ack);
-  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
-  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
-  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
-  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
-  rpc Ready (ReadyRequest) returns (Ack);
-}
-
-message PublishRequest {
-  string topic = 1;
-  string attribute = 2;
-  string description = 3;
-  repeated string tags = 4;
-  bool attribute_needs_persistence = 5;
-  oneof content {
-    Data data = 6;
-    Table table = 7;
-  }
-  bool value_is_cumulative = 8; // for Data: publish as delta
-}
-
-message Data {
-  string time = 1;
-  double value_number = 2;
-  string value_string = 3;
-  string uom = 4;
-  string data_group = 5;
-  string foreign_event_key = 6;
-}
-
-message TableValue {
-  string key = 1;
-  double value_number = 2;
-  string value_string = 3;
-}
-
-message Table {
-  string time = 1;
-  repeated TableValue values = 2;
-  string data_group = 3;
-}
-
-message SubscribeRequest {
-  repeated string topics = 1;
-}
-
-message MqttMessage {
-  string topic = 1;
-  string payload = 2; // UNS packet JSON
-}
-
-message Ack {
-  bool ok = 1;
-  string error = 2;
-}
-
-message ReadyRequest {
-  int32 timeout_ms = 1;              // default 15000
-  bool wait_output = 2;              // wait for publisher active (output)
-  bool wait_input = 3;               // wait for subscriber active (input)
-  bool wait_api = 4;                 // wait for API server (optional)
-}
-
-message ApiQueryParam {
-  string name = 1;
-  string type = 2; // string | number | boolean
-  bool required = 3;
-  string description = 4;
-}
-
-message RegisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-  string api_description = 3;
-  repeated string tags = 4;
-  repeated ApiQueryParam query_params = 5;
-}
-
-message UnregisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-}
-
-message ApiEvent {
-  string id = 1;
-  string method = 2; // GET only for now
-  string path = 3;   // /{topic}{attribute}
-  map<string, string> query = 4;
-  string bearer = 5; // access token (optional)
-}
-
-message ApiEventResponse {
-  string id = 1;          // correlation
-  int32 status = 2;       // HTTP status
-  string body = 3;        // response body as string (JSON string if needed)
-  map<string, string> headers = 4; // optional extra headers
-}
+syntax = "proto3";
+
+package uns;
+
+service UnsGateway {
+  rpc Publish (PublishRequest) returns (Ack);
+  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
+  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
+  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
+  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
+  rpc Ready (ReadyRequest) returns (Ack);
+}
+
+message PublishRequest {
+  string topic = 1;
+  string attribute = 2;
+  string description = 3;
+  repeated string tags = 4;
+  bool attribute_needs_persistence = 5;
+  oneof content {
+    Data data = 6;
+    Table table = 7;
+  }
+  bool value_is_cumulative = 8; // for Data: publish as delta
+}
+
+message Data {
+  string time = 1;
+  double value_number = 2;
+  string value_string = 3;
+  string uom = 4;
+  string data_group = 5;
+  string foreign_event_key = 6;
+}
+
+message TableValue {
+  string key = 1;
+  double value_number = 2;
+  string value_string = 3;
+}
+
+message Table {
+  string time = 1;
+  repeated TableValue values = 2;
+  string data_group = 3;
+}
+
+message SubscribeRequest {
+  repeated string topics = 1;
+}
+
+message MqttMessage {
+  string topic = 1;
+  string payload = 2; // UNS packet JSON
+}
+
+message Ack {
+  bool ok = 1;
+  string error = 2;
+}
+
+message ReadyRequest {
+  int32 timeout_ms = 1;              // default 15000
+  bool wait_output = 2;              // wait for publisher active (output)
+  bool wait_input = 3;               // wait for subscriber active (input)
+  bool wait_api = 4;                 // wait for API server (optional)
+}
+
+message ApiQueryParam {
+  string name = 1;
+  string type = 2; // string | number | boolean
+  bool required = 3;
+  string description = 4;
+}
+
+message RegisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+  string api_description = 3;
+  repeated string tags = 4;
+  repeated ApiQueryParam query_params = 5;
+}
+
+message UnregisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+}
+
+message ApiEvent {
+  string id = 1;
+  string method = 2; // GET only for now
+  string path = 3;   // /{topic}{attribute}
+  map<string, string> query = 4;
+  string bearer = 5; // access token (optional)
+}
+
+message ApiEventResponse {
+  string id = 1;          // correlation
+  int32 status = 2;       // HTTP status
+  string body = 3;        // response body as string (JSON string if needed)
+  map<string, string> headers = 4; // optional extra headers
+}