Changeset 40:ec5dde8a6ff6 in xplra for src/client/python/xplra.py

Timestamp:

02/14/13 18:21:47 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Implemented the client support for the new commands and updated the basic test programs with tests showing messages

File:

• src/client/python/xplra.py (modified) (12 diffs)

src/client/python/xplra.py

@@ -30 +30 @@
 COMMAND_GET_VERSIONS = 0x31
 
+COMMAND_RELOAD_PLUGINS = 0x32
+
+COMMAND_SHOW_MESSAGE = 0x41
+
 TYPE_INT = 0x01
 
@@ -57 +61 @@
 
 RESULT_INVALID_ID = 0x07
+
+RESULT_INVALID_DURATION = 0x08
 
 RESULT_OTHER_ERROR = 0xff
@@ -71 +77 @@
                  RESULT_INVALID_COUNT : "invalid count",
                  RESULT_INVALID_ID : "invalid ID",
+                 RESULT_INVALID_DURATION : "invalid duration",
                  RESULT_OTHER_ERROR : "other error" }
 
@@ -81 +88 @@
             return "unknown error code " + `resultCode`
 
-    def __init__(self, resultCode):
-        super(ProtocolException, self).__init__("xplra.ProtocolException: " +
-                                                self.getMessage(resultCode))
+    def __init__(self, resultCode, parameter = None):
+        message = "xplra.ProtocolException: " + self.getMessage(resultCode)
+        if parameter is not None:
+            if resultCode==RESULT_UNKNOWN_DATAREF:
+                message += " (# %d)" % (parameter,)
+
+        super(ProtocolException, self).__init__(message)
         self.resultCode = resultCode
+        self.parameter = parameter
 
 #-------------------------------------------------------------------------------
@@ -145 +157 @@
         return (self._readS32(), self._readS32(), self._readS32())
 
+    def reloadPlugins(self):
+        """Reload the plugins in X-Plane.
+
+        After this, this connection becomes invalid."""
+        self._writeU8(COMMAND_RELOAD_PLUGINS)
+        self._flush()
+        self._checkResult();
+
     def getInt(self, name):
         """Get the value of the integer dataref with the given name."""
@@ -212 +232 @@
         self.setByteArray(name, value, offset)
 
+    def showMessage(self, message, duration):
+        """Show a message in the simulator window for the given duration.
+
+        The duration is a floating-point number denoting seconds."""
+        self._writeU8(COMMAND_SHOW_MESSAGE)
+        self._writeString(message)
+        self._writeFloat(duration)
+        self._flush()
+        self._checkResult()
+
     def disconnect(self):
         """Disconnect from X-Plane."""
@@ -218 +248 @@
             self._stream = None
 
-    def _checkResult(self, resultCode = None):
+    def _checkResult(self, resultCode = None, parameter = None, multi = False):
         """Check the given result code.
 
@@ -227 +257 @@
         if resultCode is None:
             resultCode = self._readU8()
+            if multi and resultCode==RESULT_UNKNOWN_DATAREF:
+                parameter = self._readU32()
+
         if resultCode!=RESULT_OK:
-            raise ProtocolException(resultCode)
+            raise ProtocolException(resultCode, parameter)
 
     def _getSingle(self, name, type, length = None, offset = None):
@@ -525 +558 @@
 
         self._xplane._flush()
-        self._xplane._checkResult()
+        self._xplane._checkResult(multi = True)
 
     def __len__(self):
@@ -591 +624 @@
         self._xplane._flush()
 
-        self._xplane._checkResult()
+        self._xplane._checkResult(multi = True)
 
         self._readValues()
@@ -623 +656 @@
         self._xplane._flush()
 
-        self._xplane._checkResult()
+        self._xplane._checkResult(multi = True)
 
     def _executeUnregistered(self):
@@ -644 +677 @@
 
         self._xplane._flush()
-        self._xplane._checkResult()
-
-#-------------------------------------------------------------------------------
+        self._xplane._checkResult(multi = True)
+
+#-------------------------------------------------------------------------------