Timestamps added and min/max removed from templates (#18)

* Removed minimum and maximum from device asset templates

* Ignore coverage report directory

* Add timestamps if none provided

* pass changed to NotImpementedError

* Wolk init tests

* Updated example

* Removed mention of min and max in descriptions

* Updated version

* Updated package classifiers

* Readme update

* Fixed mqtt tests

* MQTT connectivity service update

* Revert Client.is_connected() changes

Author: djesic

.gitignore

@@ -46,6 +46,7 @@ coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
+coverage_html_directory/
 
 # Translations
 *.mo

README.md

@@ -11,11 +11,11 @@ This package is meant to be used for developing WolkGateway modules that enable
 
 The user is responsible for providing the custom implementation that usually contains the device’s network communication protocol, as well as for providing the business logic and everything related to the used hardware and the specifics of their particular use case.
 
-However, all the communication that is directed towards the gateway through WolkConnect - BUS Handler is already provided with this package, an open source implementation written in Python 3.7 that uses the MQTT protocol over TCP/IP to communicate with [WolkGateway](https://github.com/Wolkabout/WolkGateway).
+However, all the communication that is directed towards the gateway through WolkConnect - BUS Handler is already provided with this package, an open source implementation written in Python 3 that uses the MQTT protocol over TCP/IP to communicate with [WolkGateway](https://github.com/Wolkabout/WolkGateway).
 
 ## Requirements
 
-* Python 3.7
+* Python 3.7+
 
 All requirements for this project can be installed on Debian based systems by invoking:
 ```console
@@ -51,18 +51,14 @@ generic_sensor = wolk.SensorTemplate(
     name="Generic sensor",
     reference="G",  # References must be unique per device
     data_type=wolk.DataType.NUMERIC,
-    description="Optional description",
-    minimum=0,  # Optional minimum value
-    maximum=100,  # Optional maximum value
+    description="Optional description"
 )
 temperature_sensor = wolk.SensorTemplate(
     name="Temperature",
     reference="T",
     reading_type_name=wolk.ReadingTypeName.TEMPERATURE,
     unit=wolk.ReadingTypeMeasurementUnit.CELSIUS,
-    minimum=-20,
-    maximum=85,
-    description="Temperature sensor with range -20 to 85 Celsius",
+    description="Temperature sensor",
 )
 # Create a device template used to register the device
 device_template = wolk.DeviceTemplate(
@@ -130,8 +126,8 @@ wolk_module.publish_device_status("DEVICE_KEY")
 wolk_module.add_sensor_reading("DEVICE_KEY", "REFERENCE", "value")
 # For reading with data size > 1, like location or acceleration use tuples
 wolk_module.add_sensor_reading("DEVICE_KEY", "LOC", (24.534, -34.325))
-# Add timestamps to store when reading occurred to preserve history, otherwise
-# Platform will assign timestamp when it receives the reading
+# Add timestamps to reading occurred to preserve history, otherwise
+# module will assign timestamp when adding it to storage
 wolk_module.add_sensor_reading("KEY", "R", 12, int(round(time.time() * 1000)))
 
 # Add multiple sensor reading for a device
@@ -177,8 +173,6 @@ slider_actuator = wolk.ActuatorTemplate(
     name="Slider",
     reference="SL",
     data_type=wolk.DataType.NUMERIC,
-    minimum=0,
-    maximum=100,
     description="Light dimmer",
 )
 device_template = wolk.DeviceTemplate(

example/main.py

@@ -23,7 +23,7 @@
 import wolk_gateway_module as wolk
 
 # # uncomment to enable debug logging to file
-# wolk.logging_config("debug", "wolk_gateway_module.log")
+wolk.logging_config("debug", "wolk_gateway_module.log")
 
 with open("configuration.json", encoding="utf-8") as file:
     configuration = json.load(file)
@@ -42,37 +42,29 @@
     reference="T",
     reading_type_name=wolk.ReadingTypeName.TEMPERATURE,
     unit=wolk.ReadingTypeMeasurementUnit.CELSIUS,
-    minimum=-20,
-    maximum=85,
-    description="Temperature sensor with range -20 to 85 Celsius",
+    description="Temperature sensor",
 )
 
 pressure_sensor = wolk.SensorTemplate(
     name="Pressure",
     reference="P",
     reading_type_name=wolk.ReadingTypeName.PRESSURE,
     unit=wolk.ReadingTypeMeasurementUnit.MILLIBAR,
-    minimum=300,
-    maximum=1100,
-    description="Pressure sensor with range 300 to 1100 milibars",
+    description="Pressure sensor",
 )
 
 humidity_sensor = wolk.SensorTemplate(
     name="Humidity",
     reference="H",
     reading_type_name=wolk.ReadingTypeName.HUMIDITY,
     unit=wolk.ReadingTypeMeasurementUnit.HUMIDITY_PERCENT,
-    minimum=0,
-    maximum=100,
 )
 
 acceleration_sensor = wolk.SensorTemplate(
     name="Accelerometer",
     reference="ACCL",
     reading_type_name=wolk.ReadingTypeName.ACCELEROMETER,
     unit=wolk.ReadingTypeMeasurementUnit.METRES_PER_SQUARE_SECOND,
-    minimum=0,
-    maximum=1000,
 )
 
 humidity_alarm = wolk.AlarmTemplate(
@@ -92,8 +84,6 @@
     name="Slider",
     reference="SL",
     data_type=wolk.DataType.NUMERIC,
-    minimum=0,
-    maximum=100,
     description="Light dimmer",
 )
 

setup.py

@@ -48,6 +48,8 @@
         "Natural Language :: English",
         "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
         "Operating System :: OS Independent",
         "Topic :: Internet",
         "Topic :: Communications",

test/test_json_registration_protocol.py

@@ -146,8 +146,6 @@ def test_simple_device_registration_request(self):
             "T",
             reading_type_name=ReadingTypeName.TEMPERATURE,
             unit=ReadingTypeMeasurementUnit.CELSIUS,
-            minimum=0,
-            maximum=100,
             description="A temperature sensor",
         )
 
@@ -168,9 +166,7 @@ def test_simple_device_registration_request(self):
             + '{"name": "Temperature", '
             + '"reference": "T", '
             + '"unit": {"readingTypeName": "TEMPERATURE", "symbol": "℃"}, '
-            + '"description": "A temperature sensor", '
-            + '"minimum": 0, '
-            + '"maximum": 100}],'
+            + '"description": "A temperature sensor"}],'
             + '"actuators": [],'
             + '"alarms": [],'
             + '"configurations": [],'
@@ -198,8 +194,6 @@ def test_full_device_registration_request(self):
             "T",
             reading_type_name=ReadingTypeName.TEMPERATURE,
             unit=ReadingTypeMeasurementUnit.CELSIUS,
-            minimum=0,
-            maximum=100,
             description="A temperature sensor",
         )
         pressure_sensor = SensorTemplate(
@@ -208,17 +202,13 @@ def test_full_device_registration_request(self):
             reading_type_name=ReadingTypeName.PRESSURE,
             unit=ReadingTypeMeasurementUnit.MILLIBAR,
             description="A pressure sensor",
-            minimum=300,
-            maximum=1200,
         )
         humidity_sensor = SensorTemplate(
             "Humidity",
             "H",
             reading_type_name=ReadingTypeName.HUMIDITY,
             unit=ReadingTypeMeasurementUnit.PERCENT,
             description="A humidity sensor",
-            minimum=0,
-            maximum=100,
         )
 
         accelerometer_sensor = SensorTemplate(
@@ -227,8 +217,6 @@ def test_full_device_registration_request(self):
             reading_type_name=ReadingTypeName.ACCELEROMETER,
             unit=ReadingTypeMeasurementUnit.METRES_PER_SQUARE_SECOND,
             description="An accelerometer sensor",
-            minimum=0,
-            maximum=100,
         )
 
         sensors = [
@@ -245,7 +233,7 @@ def test_full_device_registration_request(self):
         alarms = [high_humidity_alarm]
 
         slider_actuator = ActuatorTemplate(
-            "Slider", "SL", data_type=DataType.NUMERIC, minimum=0, maximum=100
+            "Slider", "SL", data_type=DataType.NUMERIC
         )
 
         switch_actuator = ActuatorTemplate(
@@ -258,8 +246,6 @@ def test_full_device_registration_request(self):
             "configuration_1",
             "config_1",
             DataType.NUMERIC,
-            minimum=0,
-            maximum=100,
         )
         configuration_2 = ConfigurationTemplate(
             "configuration_2", "config_2", DataType.BOOLEAN
@@ -306,9 +292,7 @@ def test_full_device_registration_request(self):
             + '    "unit": {'
             + '      "readingTypeName": "TEMPERATURE",'
             + '      "symbol": "℃"'
-            + "    },"
-            + '    "minimum": 0,'
-            + '    "maximum": 100'
+            + "    }"
             + "  },"
             + "  {"
             + '    "name": "Pressure",'
@@ -317,9 +301,7 @@ def test_full_device_registration_request(self):
             + '    "unit": {'
             + '      "readingTypeName": "PRESSURE",'
             + '      "symbol": "mb"'
-            + "    },"
-            + '    "minimum": 300,'
-            + '    "maximum": 1200'
+            + "    }"
             + "  },"
             + "  {"
             + '    "name": "Humidity",'
@@ -328,9 +310,7 @@ def test_full_device_registration_request(self):
             + '    "unit": {'
             + '      "readingTypeName": "HUMIDITY",'
             + '      "symbol": "%"'
-            + "    },"
-            + '    "minimum": 0,'
-            + '    "maximum": 100'
+            + "    }"
             + "  },"
             + "  {"
             + '    "name": "Accelerometer",'
@@ -339,9 +319,7 @@ def test_full_device_registration_request(self):
             + '    "unit": {'
             + '      "readingTypeName": "ACCELEROMETER",'
             + '      "symbol": "m/s²"'
-            + "    },"
-            + '    "minimum": 0,'
-            + '    "maximum": 100'
+            + "    }"
             + "  }"
             + "],"
             + '"actuators": ['
@@ -358,12 +336,10 @@ def test_full_device_registration_request(self):
             + '    "name": "Slider",'
             + '    "reference": "SL",'
             + '    "unit": {'
-            + '      "readingTypeName": "RANGE (ACTUATOR)",'
+            + '      "readingTypeName": "COUNT(ACTUATOR)",'
             + '      "symbol": "count"'
             + "    },"
-            + '    "description": "",'
-            + '    "minimum": 0,'
-            + '    "maximum": 100'
+            + '    "description": ""'
             + "  }"
             + "],"
             + '"alarms": ['
@@ -378,9 +354,7 @@ def test_full_device_registration_request(self):
             + '    "name": "configuration_1",'
             + '    "reference": "config_1",'
             + '    "dataType": "NUMERIC",'
-            + '    "labels": [],'
-            + '    "minimum": 0,'
-            + '    "maximum": 100'
+            + '    "labels": []'
             + "  },"
             + "  {"
             + '    "name": "configuration_2",'