Add support for Dash Server OTA and CLK features.

Author: James Boulton

dashio/device.py

@@ -171,6 +171,14 @@ def _make_cfg64(self, data):
         reply += c64_json + "\n"
         return reply
 
+    def _server_clk(self, data):
+        if self._clk_rx_callback is not None:
+            self._clk_rx_callback(data)
+
+    def _server_ota(self, data):
+        if self._ota_rx_callback is not None:
+            self._ota_rx_callback(data)
+
     def _make_cfg(self, data):
         try:
             dashboard_id = data[2]
@@ -226,6 +234,27 @@ def _send_announce(self):
         logger.debug("ANNOUNCE: %s", payload.rstrip())
         self.tx_zmq_pub.send_multipart([b"ANNOUNCE", payload.encode('utf-8')])
 
+    def request_clock(self):
+        """Requests UTC Timestamp from the Dash Server
+        """
+        payload = self._device_id_str + "\tCLK\n"
+        logger.debug("ANNOUNCE: %s", payload.rstrip())
+        self.tx_zmq_pub.send_multipart([b"ANNOUNCE", payload.encode('utf-8')])
+
+    def request_ota_build_number(self):
+        """Requests requests latest build number for over the air updates from the Dash Server
+        """
+        payload = self._device_id_str + f"\tOTA\t{self.device_type}\n"
+        logger.debug("ANNOUNCE: %s", payload.rstrip())
+        self.tx_zmq_pub.send_multipart([b"ANNOUNCE", payload.encode('utf-8')])
+
+    def request_ota(self, build_number, chunk_number):
+        """Requests requests latest ota build from the Dash Server
+        """
+        payload = self._device_id_str + f"\tOTA\t{self.device_type}\t{build_number}\t{chunk_number}\n"
+        logger.debug("ANNOUNCE: %s", payload.rstrip())
+        self.tx_zmq_pub.send_multipart([b"ANNOUNCE", payload.encode('utf-8')])
+
     def is_control_loaded(self, control_type, control_id: str) -> bool:
         """Is the control loaded in the device?"""
         key = f"{control_type}\t{control_id}"
@@ -344,6 +373,42 @@ def _add_action_device_setup(self, settable: bool):
                 pass
         self._cfg["deviceSetup"] = ','.join(self._device_setup_list)
 
+    def set_clock_callback(self, callback):
+        """
+        Specify a callback function to be called when The Dash server sends clock data.
+
+        Parameters
+        ----------
+            callback:
+                The callback function. It will be invoked with one argument, the msg from dash server.
+                The callback must return a Boolean indicating success.
+        """
+        self._clk_rx_callback = callback
+
+    def unset_clock_callback(self):
+        """
+        Unset the clock rx callback.
+        """
+        self._ota_rx_callback = None
+
+    def set_ota_callback(self, callback):
+        """
+        Specify a callback function to be called when The Dash server sends ota data.
+
+        Parameters
+        ----------
+            callback:
+                The callback function. It will be invoked with one argument, the msg from dash server.
+                The callback must return a Boolean indicating success.
+        """
+        self._clk_rx_callback = callback
+
+    def unset_ota_callback(self):
+        """
+        Unset the ota rx callback.
+        """
+        self._ota_rx_callback = None
+
     def set_wifi_callback(self, callback):
         """
         Specify a callback function to be called when IoTDashboard sets wifi parameters.
@@ -541,6 +606,8 @@ def __init__(
         self._name_rx_callback = None
         self._tcp_rx_callback = None
         self._mqtt_rx_callback = None
+        self._clk_rx_callback = None
+        self._ota_rx_callback = None
         self.device_type = device_type.translate(BAD_CHARS)
         self.device_id = device_id.translate(BAD_CHARS)
         self._b_device_id = self.device_id.encode('utf-8')
@@ -551,6 +618,8 @@ def __init__(
         self._device_commands_dict['CONNECT'] = self._make_connect
         self._device_commands_dict['STATUS'] = self._make_status
         self._device_commands_dict['CFG'] = self._make_cfg64
+        self._device_commands_dict['CLK'] = self._server_clk
+        self._device_commands_dict['OTA'] = self._server_ota
         self.controls_dict = {}
         self._cfg = {}
         self._cfg["deviceSetup"] = ''