Collection message

gateway_to_backend/protocol_buffers_files/generic_message.proto

@@ -34,4 +34,13 @@ message CustomerMessage {
 message GenericMessage {
     optional WirepasMessage wirepas = 1;
     optional CustomerMessage customer = 2;
-}
+}
+
+// This Generic Message collection allows a gateway, or a backend
+// to group multiple message together to be transmitted as single mqtt
+// message.
+// It can only happen on collection topics to avoid mismatch with single
+// message topic
+message GenericMessageCollection {
+    repeated GenericMessage generic = 1;
+}

wrappers/python/tests/gateway/test_generic_collection.py

@@ -0,0 +1,44 @@
+# flake8: noqa
+
+from wirepas_messaging.gateway.api import *
+from default_value import *
+
+
+def test_generate_parse_collection():
+
+    event1 = ReceivedDataEvent(
+        GATEWAY_ID,
+        SINK_ID,
+        RX_TIME_MS_EPOCH,
+        SOURCE_ADD,
+        DESTINATION_ADD,
+        SOURCE_EP,
+        DESTINATION_EP,
+        TRAVEL_TIME_MS,
+        QOS,
+        DATA_PAYLOAD,
+        hop_count=HOP_COUNT,
+    )
+
+    event2 = ReceivedDataEvent(
+        GATEWAY_ID,
+        SINK_ID,
+        RX_TIME_MS_EPOCH + 10,
+        SOURCE_ADD,
+        DESTINATION_ADD,
+        SOURCE_EP,
+        DESTINATION_EP,
+        TRAVEL_TIME_MS,
+        QOS,
+        DATA_PAYLOAD,
+        hop_count=HOP_COUNT,
+    )
+
+    message_list = [event1, event2]
+
+    collection = GenericCollection(message_list)
+
+    collection2 = GenericCollection.from_payload(collection.payload)
+
+    for message in collection2.messages:
+        assert isinstance(message, ReceivedDataEvent)

wrappers/python/wirepas_messaging/gateway/api/__init__.py

@@ -24,3 +24,4 @@
 from .gateway_result_code import *
 from .otap_helper import *
 from .wirepas_exceptions import *
+from .generic_collection import *

wrappers/python/wirepas_messaging/gateway/api/event.py

@@ -9,8 +9,10 @@
 import random
 import wirepas_messaging
 
+from .generic_message import GenericMessage
 
-class Event(object):
+
+class Event(GenericMessage):
     """
     Event
 
@@ -30,14 +32,6 @@ def __init__(self, gw_id, sink_id=None, event_id=None, **kwargs):
             event_id = random.getrandbits(64)
         self.event_id = event_id
 
-    def __str__(self):
-        return str(self.__dict__)
-
-    @property
-    def payload(self):
-        """ Implement how to serialize child Event classes """
-        raise NotImplementedError()
-
     def _make_event_header(self):
         """ Creates the generic messaging header """
         header = wirepas_messaging.gateway.EventHeader()

wrappers/python/wirepas_messaging/gateway/api/generic_collection.py

@@ -0,0 +1,73 @@
+"""
+    Generic collection
+    =============
+
+    .. Copyright:
+        Copyright 2020 Wirepas Ltd under Apache License, Version 2.0.
+        See file LICENSE for full license details.
+"""
+# flake8: noqa
+from wirepas_messaging.gateway.api import *
+
+
+class GenericCollection(object):
+    """
+    GenericCollection: collection of Generic message
+
+    """
+
+    field_to_class = {
+        "status_event": StatusEvent,
+        "get_configs_req": GetConfigsRequest,
+        "get_configs_resp": GetConfigsResponse,
+        "set_config_req": SetConfigRequest,
+        "set_config_resp": SetConfigResponse,
+        "send_packet_req": SendDataRequest,
+        "send_packet_resp": SendDataResponse,
+        "packet_received_event": ReceivedDataEvent,
+        "get_scratchpad_status_req": GetScratchpadStatusRequest,
+        "get_scratchpad_status_resp": GetScratchpadStatusResponse,
+        "upload_scratchpad_req": UploadScratchpadRequest,
+        "upload_scratchpad_resp": UploadScratchpadResponse,
+        "process_scratchpad_req": ProcessScratchpadRequest,
+        "process_scratchpad_resp": ProcessScratchpadResponse,
+        "get_gateway_info_req": GetGatewayInfoRequest,
+        "get_gateway_info_res": GetGatewayInfoResponse,
+    }
+
+    def __init__(self, generic_messages_list, **kwargs):
+        self.generic_messages_list = generic_messages_list
+
+    @classmethod
+    def from_payload(cls, payload):
+        message_collection = wirepas_messaging.gateway.GenericMessageCollection()
+        try:
+            message_collection.ParseFromString(payload)
+        except Exception:
+            # Any Exception is promoted to Generic API exception
+            raise GatewayAPIParsingException("Cannot parse Generic payload collection")
+
+        msgs_list = []
+        for message in message_collection.generic:
+            for field, class_holder in GenericCollection.field_to_class.items():
+                if message.wirepas.HasField(field):
+                    msgs_list.append(class_holder.from_generic_message(message))
+                    break
+
+        return cls(msgs_list)
+
+    @property
+    def payload(self):
+        message_collection = wirepas_messaging.gateway.GenericMessageCollection()
+        # Add all messages one by one
+        for message in self.generic_messages_list:
+            message_collection.generic.append(message.generic_message)
+
+        return message_collection.SerializeToString()
+
+    @property
+    def messages(self):
+        return self.generic_messages_list
+
+    def add_message(self, message):
+        self.generic_messages_list.append(message)

wrappers/python/wirepas_messaging/gateway/api/generic_message.py

@@ -0,0 +1,51 @@
+"""
+    Generic message
+    ========
+
+    .. Copyright:
+        Copyright 2020 Wirepas Ltd under Apache License, Version 2.0.
+        See file LICENSE for full license details.
+"""
+
+import wirepas_messaging
+
+from .wirepas_exceptions import GatewayAPIParsingException
+
+
+class GenericMessage(object):
+    """
+    Generic message
+
+    Base class for all Events, Requests, Response
+
+    """
+
+    @classmethod
+    def from_generic_message(cls, message):
+        """ Implement how to parse message """
+        raise NotImplementedError()
+
+    @classmethod
+    def from_payload(cls, payload):
+        message = wirepas_messaging.gateway.GenericMessage()
+        try:
+            message.ParseFromString(payload)
+        except Exception:
+            # Any Exception is promoted to Generic API exception
+            raise GatewayAPIParsingException(
+                "Cannot parse payload for %s" % cls.__name__
+            )
+
+        return cls.from_generic_message(message)
+
+    @property
+    def generic_message(self):
+        """ Implement how to generate generic message"""
+        raise NotImplementedError()
+
+    @property
+    def payload(self):
+        return self.generic_message.SerializeToString()
+
+    def __str__(self):
+        return str(self.__dict__)

wrappers/python/wirepas_messaging/gateway/api/get_configs.py

@@ -18,7 +18,6 @@
     set_config_ro,
     set_config_rw,
 )
-from .wirepas_exceptions import GatewayAPIParsingException
 
 
 class GetConfigsRequest(Request):
@@ -33,25 +32,18 @@ def __init__(self, req_id=None, **kwargs):
         super(GetConfigsRequest, self).__init__(req_id=req_id, **kwargs)
 
     @classmethod
-    def from_payload(cls, payload):
-        message = wirepas_messaging.gateway.GenericMessage()
-        try:
-            message.ParseFromString(payload)
-        except Exception:
-            # Any Exception is promoted to Generic API exception
-            raise GatewayAPIParsingException("Cannot parse GetConfigsRequest payload")
-
+    def from_generic_message(cls, message):
         d = Request._parse_request_header(message.wirepas.get_configs_req.header)
         return cls(d["req_id"])
 
     @property
-    def payload(self):
+    def generic_message(self):
         message = wirepas_messaging.gateway.GenericMessage()
         # Fill the request header
         get_config = message.wirepas.get_configs_req
         get_config.header.CopyFrom(self._make_request_header())
 
-        return message.SerializeToString()
+        return message
 
 
 class GetConfigsResponse(Response):
@@ -70,14 +62,7 @@ def __init__(self, req_id, gw_id, res, configs, **kwargs):
         self.configs = configs
 
     @classmethod
-    def from_payload(cls, payload):
-        message = wirepas_messaging.gateway.GenericMessage()
-        try:
-            message.ParseFromString(payload)
-        except Exception:
-            # Any Exception is promoted to Generic API exception
-            raise GatewayAPIParsingException("Cannot parse GetConfigsResponse payload")
-
+    def from_generic_message(cls, message):
         response = message.wirepas.get_configs_resp
 
         d = Response._parse_response_header(response.header)
@@ -97,7 +82,7 @@ def from_payload(cls, payload):
         return cls(d["req_id"], d["gw_id"], d["res"], configs)
 
     @property
-    def payload(self):
+    def generic_message(self):
         message = wirepas_messaging.gateway.GenericMessage()
 
         response = message.wirepas.get_configs_resp
@@ -110,4 +95,4 @@ def payload(self):
             set_config_rw(conf, config)
             set_config_ro(conf, config)
 
-        return message.SerializeToString()
+        return message

wrappers/python/wirepas_messaging/gateway/api/get_gw_info.py

@@ -12,8 +12,6 @@
 from .request import Request
 from .response import Response
 
-from .wirepas_exceptions import GatewayAPIParsingException
-
 
 class GetGatewayInfoRequest(Request):
     """
@@ -27,27 +25,18 @@ def __init__(self, req_id=None, **kwargs):
         super(GetGatewayInfoRequest, self).__init__(req_id=req_id, **kwargs)
 
     @classmethod
-    def from_payload(cls, payload):
-        message = wirepas_messaging.gateway.GenericMessage()
-        try:
-            message.ParseFromString(payload)
-        except Exception:
-            # Any Exception is promoted to Generic API exception
-            raise GatewayAPIParsingException(
-                "Cannot parse GetGatewayInfoRequest payload"
-            )
-
+    def from_generic_message(cls, message):
         d = Request._parse_request_header(message.wirepas.get_gateway_info_req.header)
         return cls(d["req_id"])
 
     @property
-    def payload(self):
+    def generic_message(self):
         message = wirepas_messaging.gateway.GenericMessage()
         # Fill the request header
         get_gateway_info = message.wirepas.get_gateway_info_req
         get_gateway_info.header.CopyFrom(self._make_request_header())
 
-        return message.SerializeToString()
+        return message
 
 
 class GetGatewayInfoResponse(Response):
@@ -81,16 +70,7 @@ def __init__(
         self.implemented_api_version = implemented_api_version
 
     @classmethod
-    def from_payload(cls, payload):
-        message = wirepas_messaging.gateway.GenericMessage()
-        try:
-            message.ParseFromString(payload)
-        except Exception:
-            # Any Exception is promoted to Generic API exception
-            raise GatewayAPIParsingException(
-                "Cannot parse GetGatewayInfoResponse payload"
-            )
-
+    def from_generic_message(cls, message):
         response = message.wirepas.get_gateway_info_resp
 
         d = Response._parse_response_header(response.header)
@@ -106,7 +86,7 @@ def from_payload(cls, payload):
         )
 
     @property
-    def payload(self):
+    def generic_message(self):
         message = wirepas_messaging.gateway.GenericMessage()
 
         response = message.wirepas.get_gateway_info_resp
@@ -123,4 +103,4 @@ def payload(self):
         if self.implemented_api_version is not None:
             response.info.implemented_api_version = self.implemented_api_version
 
-        return message.SerializeToString()
+        return message