Added UDP connection statuses

Author: devleaks

examples/simple_upd.py

@@ -1,7 +1,6 @@
 import os
 import sys
 import logging
-import time
 from typing import Any
 
 sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
@@ -19,9 +18,8 @@ def dataref_monitor(dataref: str, value: Any):
 # UDP API
 beacon = xpwebapi.beacon()
 beacon.start_monitor()
-while not beacon.receiving_beacon:
-    print("waiting for beacon")
-    time.sleep(2)
+beacon.wait_for_beacon(report=True)  # blocks until beacon is detected
+
 xp = xpwebapi.udp_api(beacon=beacon)
 
 xp.add_callback(callback=dataref_monitor)

xpwebapi/__init__.py

@@ -22,4 +22,4 @@ def udp_api(**kwargs):
     return XPUDPAPI(**kwargs)
 
 
-version = "3.2.1"
+version = "3.2.2"

xpwebapi/api.py

@@ -51,6 +51,7 @@ class CONNECTION_STATUS(IntEnum):
     REST_API_NOT_REACHABLE = 8
     WEBSOCKET_CONNNECTED = 3
     WEBSOCKET_DISCONNNECTED = 9
+    UDP_LISTENER_RUNNING = 6
     LISTENING_FOR_DATA = 4
     RECEIVING_DATA = 5
 

xpwebapi/beacon.py

@@ -16,6 +16,7 @@
 import struct
 import binascii
 import platform
+import time
 from typing import Callable, List, Set
 from enum import Enum, IntEnum
 from datetime import datetime
@@ -444,6 +445,12 @@ def stop_monitor(self):
                 logger.debug("..monitor not running")
         self.status = BEACON_MONITOR_STATUS.NOT_RUNNING
 
+    def wait_for_beacon(self, report: bool = False, retry: int = 2):
+        while not self.receiving_beacon:
+            if report:
+                logger.info("waiting for beacon..")
+            time.sleep(retry)
+
 
 # ######################################
 # Demo and Usage

xpwebapi/udp.py

@@ -14,7 +14,7 @@
 from time import sleep
 from typing import Tuple, Dict, Callable
 
-from .api import API, DatarefValueType, Dataref, Command
+from .api import API, CONNECTION_STATUS, DatarefValueType, Dataref, Command
 
 # local logging
 logger = logging.getLogger(__name__)
@@ -218,9 +218,13 @@ def read_monitored_dataref_values(self):
         Raises:
             XPlaneTimeout: [description]
         """
+        if self.status not in [CONNECTION_STATUS.LISTENING_FOR_DATA, CONNECTION_STATUS.RECEIVING_DATA]:
+            self.status = CONNECTION_STATUS.LISTENING_FOR_DATA
         try:
             # Receive packet
             data, addr = self.socket.recvfrom(1472)  # maximum bytes of an RREF answer X-Plane will send (Ethernet MTU - IP hdr - UDP hdr)
+            if self.status != CONNECTION_STATUS.RECEIVING_DATA:
+                self.status = CONNECTION_STATUS.RECEIVING_DATA
             # Decode Packet
             retvalues = {}
             # * Read the Header "RREFO".
@@ -244,6 +248,8 @@ def read_monitored_dataref_values(self):
                         self.execute_callbacks(dataref=self.datarefs[idx], value=value)
             self.xplaneValues.update(retvalues)
         except:
+            if self.status != CONNECTION_STATUS.LISTENING_FOR_DATA:
+                self.status = CONNECTION_STATUS.LISTENING_FOR_DATA
             raise XPlaneTimeout
         return self.xplaneValues
 
@@ -254,6 +260,7 @@ def udp_listener_running(self) -> bool:
     def udp_listener(self):
         logger.info("starting udp listener..")
 
+        self.status = CONNECTION_STATUS.UDP_LISTENER_RUNNING
         while self.udp_listener_running:
             try:
                 data = self.read_monitored_dataref_values()