import fs import const import util import acft import threading import os import time import calendar import sys import codecs import math if os.name == "nt" and "FORCE_PYUIPC_SIM" not in os.environ: import pyuipc else: import pyuipc_sim as pyuipc #------------------------------------------------------------------------------ ## @package mlx.fsuipc # # The module towards FSUIPC. # # This module implements the simulator interface to FSUIPC. # # The \ref Handler class is thread handling the FSUIPC requests. It can be # given read, periodic read and write, requests, that are executed # asynchronously, and a callback function is called with the result. This class # is used internally within the module. # # The \ref Simulator class is the actual interface to the flight simulator, and # an instance of it is returned by \ref mlx.fs.createSimulator. This object can # be used to connect to the simulator and disconnect from it, to query various # data and to start and stop the monitoring of the data. # # \ref AircraftModel is the base class of the aircraft models. A "model" is a # particular implementation of an aircraft, such as the PMDG Boeing 737NG in # Flight Simulator 2004. Since each type and each model has its peculiarities # (e.g. the different engine and fuel tank configurations), each aircraft type # has a generic model, that should work for most of the time. However, certain # models may implement various controls, gauges, etc. differently, and such # peculiarites can be handled in a specific subclass of \ref # AircraftModel. These subclasses should be registered as special ones, and if # the simulator detects that the aircraft's model became known or has changed, # it will check these special models before resorting to the generic ones. # # The models are responsible also for querying certain parameters, such as the # fuel tank configuration. While ideally it should be specific to a type only, # it is possible that the model contains different tanks, in which case some # tricks may be needed. See the \ref DC3Model "DC-3 (Li-2)" aircraft as an # example. #------------------------------------------------------------------------------ ## The mapping of tank types to FSUIPC offsets _tank2offset = { const.FUELTANK_CENTRE : 0x0b74, const.FUELTANK_LEFT : 0x0b7c, const.FUELTANK_RIGHT : 0x0b94, const.FUELTANK_LEFT_AUX : 0x0b84, const.FUELTANK_RIGHT_AUX : 0x0b9c, const.FUELTANK_LEFT_TIP : 0x0b8c, const.FUELTANK_RIGHT_TIP : 0x0ba4, const.FUELTANK_EXTERNAL1 : 0x1254, const.FUELTANK_EXTERNAL2 : 0x125c, const.FUELTANK_CENTRE2 : 0x1244 } #------------------------------------------------------------------------------ class Handler(threading.Thread): """The thread to handle the FSUIPC requests.""" @staticmethod def fsuipc2VS(data): """Convert the given vertical speed data read from FSUIPC into feet/min.""" return data*60.0/const.FEETTOMETRES/256.0 @staticmethod def fsuipc2radioAltitude(data): """Convert the given radio altitude data read from FSUIPC into feet.""" return data/const.FEETTOMETRES/65536.0 @staticmethod def fsuipc2Degrees(data): """Convert the given data into degrees.""" return data * 360.0 / 65536.0 / 65536.0 @staticmethod def fsuipc2PositiveDegrees(data): """Convert the given data into positive degrees.""" degrees = Handler.fsuipc2Degrees(data) if degrees<0.0: degrees += 360.0 return degrees @staticmethod def fsuipc2IAS(data): """Convert the given data into indicated airspeed.""" return data / 128.0 @staticmethod def _callSafe(fun): """Call the given function and swallow any exceptions.""" try: return fun() except Exception, e: print >> sys.stderr, util.utf2unicode(str(e)) return None # The number of times a read is attempted NUM_READATTEMPTS = 3 # The number of connection attempts NUM_CONNECTATTEMPTS = 3 # The interval between successive connect attempts CONNECT_INTERVAL = 0.25 @staticmethod def _performRead(data, callback, extra, validator): """Perform a read request. If there is a validator, that will be called with the return values, and if the values are wrong, the request is retried at most a certain number of times. Return True if the request has succeeded, False if validation has failed during all attempts. An exception may also be thrown if there is some lower-level communication problem.""" attemptsLeft = Handler.NUM_READATTEMPTS while attemptsLeft>0: values = pyuipc.read(data) if validator is None or \ Handler._callSafe(lambda: validator(values, extra)): Handler._callSafe(lambda: callback(values, extra)) return True else: attemptsLeft -= 1 return False class Request(object): """A simple, one-shot request.""" def __init__(self, forWrite, data, callback, extra, validator = None): """Construct the request.""" self._forWrite = forWrite self._data = data self._callback = callback self._extra = extra self._validator = validator def process(self, time): """Process the request. Return True if the request has succeeded, False if data validation has failed for a reading request. An exception may also be thrown if there is some lower-level communication problem.""" if self._forWrite: pyuipc.write(self._data) Handler._callSafe(lambda: self._callback(True, self._extra)) return True else: return Handler._performRead(self._data, self._callback, self._extra, self._validator) def fail(self): """Handle the failure of this request.""" if self._forWrite: Handler._callSafe(lambda: self._callback(False, self._extra)) else: Handler._callSafe(lambda: self._callback(None, self._extra)) class PeriodicRequest(object): """A periodic request.""" def __init__(self, id, period, data, callback, extra, validator): """Construct the periodic request.""" self._id = id self._period = period self._nextFire = time.time() self._data = data self._preparedData = None self._callback = callback self._extra = extra self._validator = validator @property def id(self): """Get the ID of this periodic request.""" return self._id @property def nextFire(self): """Get the next firing time.""" return self._nextFire def process(self, time): """Check if this request should be executed, and if so, do so. time is the time at which the request is being executed. If this function is called too early, nothing is done, and True is returned. Return True if the request has succeeded, False if data validation has failed. An exception may also be thrown if there is some lower-level communication problem.""" if time0: self._handleConnection() self._disconnect() def _waitConnectionRequest(self): """Wait for a connection request to arrive.""" with self._requestCondition: while not self._connectionRequested: self._requestCondition.wait() def _connect(self, autoReconnection = False, attempts = 0): """Try to connect to the flight simulator via FSUIPC Returns True if the connection has been established, False if it was not due to no longer requested. """ while self._connectionRequested: if attempts>=self.NUM_CONNECTATTEMPTS: self._connectionRequested = False if autoReconnection: Handler._callSafe(lambda: self._connectionListener.disconnected()) else: Handler._callSafe(lambda: self._connectionListener.connectionFailed()) return 0 try: attempts += 1 pyuipc.open(pyuipc.SIM_ANY) description = "(FSUIPC version: 0x%04x, library version: 0x%04x, FS version: %d)" % \ (pyuipc.fsuipc_version, pyuipc.lib_version, pyuipc.fs_version) if not autoReconnection: fsType = const.SIM_MSFSX \ if pyuipc.fs_version == pyuipc.SIM_FSX \ else const.SIM_MSFS9 Handler._callSafe(lambda: self._connectionListener.connected(fsType, description)) self._connected = True return attempts except Exception, e: print "fsuipc.Handler._connect: connection failed: " + \ util.utf2unicode(str(e)) + \ " (attempts: %d)" % (attempts,) if attemptst: break attempts = self._processRequest(request, t, attempts) while self._connectionRequested and self._requests: request = self._requests[0] del self._requests[0] attempts = self._processRequest(request, None, attempts) return self._connectionRequested #------------------------------------------------------------------------------ class Simulator(object): """The simulator class representing the interface to the flight simulator via FSUIPC.""" # The basic data that should be queried all the time once we are connected timeData = [ (0x0240, "H"), # Year (0x023e, "H"), # Number of day in year (0x023b, "b"), # UTC hour (0x023c, "b"), # UTC minute (0x023a, "b") ] # seconds normalData = timeData + \ [ (0x3d00, -256), # The name of the current aircraft (0x3c00, -256), # The path of the current AIR file (0x1274, "h") ] # Text display mode flareData1 = [ (0x023a, "b"), # Seconds of time (0x31e4, "d"), # Radio altitude (0x02c8, "d") ] # Vertical speed flareStartData = [ (0x0e90, "H"), # Ambient wind speed (0x0e92, "H"), # Ambient wind direction (0x0e8a, "H") ] # Visibility flareData2 = [ (0x023a, "b"), # Seconds of time (0x0366, "H"), # On the ground (0x02c8, "d"), # Vertical speed (0x030c, "d"), # Touch-down rate (0x02bc, "d"), # IAS (0x0578, "d"), # Pitch (0x057c, "d"), # Bank (0x0580, "d") ] # Heading TIME_SYNC_INTERVAL = 3.0 @staticmethod def _getTimestamp(data): """Convert the given data into a timestamp.""" timestamp = calendar.timegm(time.struct_time([data[0], 1, 1, 0, 0, 0, -1, 1, 0])) timestamp += data[1] * 24 * 3600 timestamp += data[2] * 3600 timestamp += data[3] * 60 timestamp += data[4] return timestamp @staticmethod def _appendHotkeyData(data, offset, hotkey): """Append the data for the given hotkey to the given array, that is intended to be passed to requestWrite call on the handler.""" data.append((offset + 0, "b", ord(hotkey.key))) modifiers = 0 if hotkey.ctrl: modifiers |= 0x02 if hotkey.shift: modifiers |= 0x01 data.append((offset + 1, "b", modifiers)) data.append((offset + 2, "b", 0)) data.append((offset + 3, "b", 0)) def __init__(self, connectionListener, connectAttempts = -1, connectInterval = 0.2): """Construct the simulator. The aircraft object passed must provide the following members: - type: one of the AIRCRAFT_XXX constants from const.py - modelChanged(aircraftName, modelName): called when the model handling the aircraft has changed. - handleState(aircraftState): handle the given state. - flareStarted(windSpeed, windDirection, visibility, flareStart, flareStartFS): called when the flare has started. windSpeed is in knots, windDirection is in degrees and visibility is in metres. flareStart and flareStartFS are two time values expressed in seconds that can be used to calculate the flare time. - flareFinished(flareEnd, flareEndFS, tdRate, tdRateCalculatedByFS, ias, pitch, bank, heading): called when the flare has finished, i.e. the aircraft is on the ground. flareEnd and flareEndFS are the two time values corresponding to the touchdown time. tdRate is the touch-down rate, tdRateCalculatedBySim indicates if the data comes from the simulator or was calculated by the adapter. The other data are self-explanatory and expressed in their 'natural' units.""" self._fsType = None self._aircraft = None self._handler = Handler(self, connectAttempts = connectAttempts, connectInterval = connectInterval) self._connectionListener = connectionListener self._handler.start() self._scroll = False self._syncTime = False self._nextSyncTime = -1 self._normalRequestID = None self._monitoringRequested = False self._monitoring = False self._aircraftName = None self._aircraftModel = None self._flareRequestID = None self._flareRates = [] self._flareStart = None self._flareStartFS = None self._hotkeyLock = threading.Lock() self._hotkeys = None self._hotkeySetID = 0 self._hotkeySetGeneration = 0 self._hotkeyOffets = None self._hotkeyRequestID = None self._hotkeyCallback = None self._latin1decoder = codecs.getdecoder("iso-8859-1") self._fuelCallback = None def connect(self, aircraft): """Initiate a connection to the simulator.""" self._aircraft = aircraft self._aircraftName = None self._aircraftModel = None self._handler.connect() if self._normalRequestID is None: self._nextSyncTime = -1 self._startDefaultNormal() def reconnect(self): """Initiate a reconnection to the simulator. It does not reset already set up data, just calls connect() on the handler.""" self._handler.connect() def requestZFW(self, callback): """Send a request for the ZFW.""" self._handler.requestRead([(0x3bfc, "d")], self._handleZFW, extra = callback) def requestWeights(self, callback): """Request the following weights: DOW, ZFW, payload. These values will be passed to the callback function in this order, as separate arguments.""" self._handler.requestRead([(0x13fc, "d")], self._handlePayloadCount, extra = callback) def requestTime(self, callback): """Request the time from the simulator.""" self._handler.requestRead(Simulator.timeData, self._handleTime, extra = callback) def startMonitoring(self): """Start the periodic monitoring of the aircraft and pass the resulting state to the aircraft object periodically.""" assert not self._monitoringRequested self._monitoringRequested = True def stopMonitoring(self): """Stop the periodic monitoring of the aircraft.""" assert self._monitoringRequested self._monitoringRequested = False def startFlare(self): """Start monitoring the flare time. At present it is assumed to be called from the FSUIPC thread, hence no protection.""" #self._aircraft.logger.debug("startFlare") if self._flareRequestID is None: self._flareRates = [] self._flareRequestID = self._handler.requestPeriodicRead(0.1, Simulator.flareData1, self._handleFlare1) def cancelFlare(self): """Cancel monitoring the flare time. At present it is assumed to be called from the FSUIPC thread, hence no protection.""" if self._flareRequestID is not None: self._handler.clearPeriodic(self._flareRequestID) self._flareRequestID = None def sendMessage(self, message, duration = 3, _disconnect = False): """Send a message to the pilot via the simulator. duration is the number of seconds to keep the message displayed.""" print "fsuipc.Simulator.sendMessage:", message if self._scroll: if duration==0: duration = -1 elif duration == 1: duration = -2 else: duration = -duration data = [(0x3380, -1 - len(message), message), (0x32fa, 'h', duration)] #if _disconnect: # print "fsuipc.Simulator.sendMessage(disconnect)", message self._handler.requestWrite(data, self._handleMessageSent, extra = _disconnect) def getFuel(self, callback): """Get the fuel information for the current model. The callback will be called with a list of triplets with the following items: - the fuel tank identifier - the current weight of the fuel in the tank (in kgs) - the current total capacity of the tank (in kgs).""" if self._aircraftModel is None: self._fuelCallback = callback else: self._aircraftModel.getFuel(self._handler, callback) def setFuelLevel(self, levels): """Set the fuel level to the given ones. levels is an array of two-tuples, where each tuple consists of the following: - the const.FUELTANK_XXX constant denoting the tank that must be set, - the requested level of the fuel as a floating-point value between 0.0 and 1.0.""" if self._aircraftModel is not None: self._aircraftModel.setFuelLevel(self._handler, levels) def enableTimeSync(self): """Enable the time synchronization.""" self._nextSyncTime = -1 self._syncTime = True def disableTimeSync(self): """Enable the time synchronization.""" self._syncTime = False self._nextSyncTime = -1 def listenHotkeys(self, hotkeys, callback): """Start listening to the given hotkeys. callback is function expecting two arguments: - the ID of the hotkey set as returned by this function, - the list of the indexes of the hotkeys that were pressed.""" with self._hotkeyLock: assert self._hotkeys is None self._hotkeys = hotkeys self._hotkeySetID += 1 self._hotkeySetGeneration = 0 self._hotkeyCallback = callback self._handler.requestRead([(0x320c, "u")], self._handleNumHotkeys, (self._hotkeySetID, self._hotkeySetGeneration)) return self._hotkeySetID def clearHotkeys(self): """Clear the current hotkey set. Note that it is possible, that the callback function set either previously or after calling this function by listenHotkeys() will be called with data from the previous hotkey set. Therefore it is recommended to store the hotkey set ID somewhere and check that in the callback function. Right before calling clearHotkeys(), this stored ID should be cleared so that the check fails for sure.""" with self._hotkeyLock: if self._hotkeys is not None: self._hotkeys = None self._hotkeySetID += 1 self._hotkeyCallback = None self._clearHotkeyRequest() def disconnect(self, closingMessage = None, duration = 3): """Disconnect from the simulator.""" assert not self._monitoringRequested print "fsuipc.Simulator.disconnect", closingMessage, duration self._stopNormal() self.clearHotkeys() if closingMessage is None: self._handler.disconnect() else: self.sendMessage(closingMessage, duration = duration, _disconnect = True) def connected(self, fsType, descriptor): """Called when a connection has been established to the flight simulator of the given type.""" self._fsType = fsType with self._hotkeyLock: if self._hotkeys is not None: self._hotkeySetGeneration += 1 self._handler.requestRead([(0x320c, "u")], self._handleNumHotkeys, (self._hotkeySetID, self._hotkeySetGeneration)) self._connectionListener.connected(fsType, descriptor) def connectionFailed(self): """Called when the connection could not be established.""" with self._hotkeyLock: self._clearHotkeyRequest() self._connectionListener.connectionFailed() def disconnected(self): """Called when a connection to the flight simulator has been broken.""" with self._hotkeyLock: self._clearHotkeyRequest() self._connectionListener.disconnected() def _startDefaultNormal(self): """Start the default normal periodic request.""" assert self._normalRequestID is None self._normalRequestID = \ self._handler.requestPeriodicRead(1.0, Simulator.normalData, self._handleNormal, validator = self._validateNormal) def _stopNormal(self): """Stop the normal period request.""" assert self._normalRequestID is not None self._handler.clearPeriodic(self._normalRequestID) self._normalRequestID = None self._monitoring = False def _validateNormal(self, data, extra): """Validate the normal data.""" return data[0]!=0 and data[1]!=0 and len(data[5])>0 and len(data[6])>0 def _handleNormal(self, data, extra): """Handle the reply to the normal request. At the beginning the result consists the data for normalData. When monitoring is started, it contains the result also for the aircraft-specific values. """ timestamp = Simulator._getTimestamp(data) createdNewModel = self._setAircraftName(timestamp, data[5], data[6]) if self._fuelCallback is not None: self._aircraftModel.getFuel(self._handler, self._fuelCallback) self._fuelCallback = None self._scroll = data[7]!=0 if self._monitoringRequested and not self._monitoring: self._stopNormal() self._startMonitoring() elif self._monitoring and not self._monitoringRequested: self._stopNormal() self._startDefaultNormal() elif self._monitoring and self._aircraftModel is not None and \ not createdNewModel: aircraftState = self._aircraftModel.getAircraftState(self._aircraft, timestamp, data) self._checkTimeSync(aircraftState) self._aircraft.handleState(aircraftState) def _checkTimeSync(self, aircraftState): """Check if we need to synchronize the FS time.""" if not self._syncTime or aircraftState.paused or \ self._flareRequestID is not None: self._nextSyncTime = -1 return now = time.time() seconds = time.gmtime(now).tm_sec if seconds>30 and seconds<59: if self._nextSyncTime > (now - 0.49): return self._handler.requestWrite([(0x023a, "b", int(seconds))], self._handleTimeSynced) #print "Set the seconds to ", seconds if self._nextSyncTime<0: self._nextSyncTime = now self._nextSyncTime += Simulator.TIME_SYNC_INTERVAL else: self._nextSyncTime = -1 def _handleTimeSynced(self, success, extra): """Callback for the time sync result.""" pass def _setAircraftName(self, timestamp, name, airPath): """Set the name of the aicraft and if it is different from the previous, create a new model for it. If so, also notifty the aircraft about the change. Return if a new model was created.""" name = self._latin1decoder(name)[0] airPath = self._latin1decoder(airPath)[0] aircraftName = (name, airPath) if aircraftName==self._aircraftName: return False print "fsuipc.Simulator: new aircraft name and air file path: %s, %s" % \ (name, airPath) self._aircraftName = aircraftName needNew = self._aircraftModel is None needNew = needNew or\ not self._aircraftModel.doesHandle(self._aircraft, aircraftName) if not needNew: specialModel = AircraftModel.findSpecial(self._aircraft, aircraftName) needNew = specialModel is not None and \ specialModel is not self._aircraftModel.__class__ if needNew: self._setAircraftModel(AircraftModel.create(self._aircraft, aircraftName)) self._aircraft.modelChanged(timestamp, name, self._aircraftModel.name) return needNew def _setAircraftModel(self, model): """Set a new aircraft model. It will be queried for the data to monitor and the monitoring request will be replaced by a new one.""" self._aircraftModel = model if self._monitoring: self._stopNormal() self._startMonitoring() def _startMonitoring(self): """Start monitoring with the current aircraft model.""" data = Simulator.normalData[:] self._aircraftModel.addMonitoringData(data, self._fsType) self._normalRequestID = \ self._handler.requestPeriodicRead(1.0, data, self._handleNormal, validator = self._validateNormal) self._monitoring = True def _addFlareRate(self, data): """Append a flare rate to the list of last rates.""" if len(self._flareRates)>=3: del self._flareRates[0] self._flareRates.append(Handler.fsuipc2VS(data)) def _handleFlare1(self, data, normal): """Handle the first stage of flare monitoring.""" #self._aircraft.logger.debug("handleFlare1: " + str(data)) if Handler.fsuipc2radioAltitude(data[1])<=50.0: self._flareStart = time.time() self._flareStartFS = data[0] self._handler.clearPeriodic(self._flareRequestID) self._flareRequestID = \ self._handler.requestPeriodicRead(0.1, Simulator.flareData2, self._handleFlare2) self._handler.requestRead(Simulator.flareStartData, self._handleFlareStart) self._addFlareRate(data[2]) def _handleFlareStart(self, data, extra): """Handle the data need to notify the aircraft about the starting of the flare.""" #self._aircraft.logger.debug("handleFlareStart: " + str(data)) if data is not None: windDirection = data[1]*360.0/65536.0 if windDirection<0.0: windDirection += 360.0 self._aircraft.flareStarted(data[0], windDirection, data[2]*1609.344/100.0, self._flareStart, self._flareStartFS) def _handleFlare2(self, data, normal): """Handle the first stage of flare monitoring.""" #self._aircraft.logger.debug("handleFlare2: " + str(data)) if data[1]!=0: flareEnd = time.time() self._handler.clearPeriodic(self._flareRequestID) self._flareRequestID = None flareEndFS = data[0] if flareEndFS1000.0 or tdRate<-1000.0: tdRate = min(self._flareRates) tdRateCalculatedByFS = False self._aircraft.flareFinished(flareEnd, flareEndFS, tdRate, tdRateCalculatedByFS, Handler.fsuipc2IAS(data[4]), Handler.fsuipc2Degrees(data[5]), Handler.fsuipc2Degrees(data[6]), Handler.fsuipc2PositiveDegrees(data[7])) else: self._addFlareRate(data[2]) def _handleZFW(self, data, callback): """Callback for a ZFW retrieval request.""" zfw = data[0] * const.LBSTOKG / 256.0 callback(zfw) def _handleTime(self, data, callback): """Callback for a time retrieval request.""" callback(Simulator._getTimestamp(data)) def _handlePayloadCount(self, data, callback): """Callback for the payload count retrieval request.""" payloadCount = data[0] data = [(0x3bfc, "d"), (0x30c0, "f")] for i in range(0, payloadCount): data.append((0x1400 + i*48, "f")) self._handler.requestRead(data, self._handleWeights, extra = callback) def _handleWeights(self, data, callback): """Callback for the weights retrieval request.""" zfw = data[0] * const.LBSTOKG / 256.0 grossWeight = data[1] * const.LBSTOKG payload = sum(data[2:]) * const.LBSTOKG dow = zfw - payload callback(dow, payload, zfw, grossWeight) def _handleMessageSent(self, success, disconnect): """Callback for a message sending request.""" #print "fsuipc.Simulator._handleMessageSent", disconnect if disconnect: self._handler.disconnect() def _handleNumHotkeys(self, data, (id, generation)): """Handle the result of the query of the number of hotkeys""" with self._hotkeyLock: if id==self._hotkeySetID and generation==self._hotkeySetGeneration: numHotkeys = data[0] print "fsuipc.Simulator._handleNumHotkeys: numHotkeys:", numHotkeys data = [(0x3210 + i*4, "d") for i in range(0, numHotkeys)] self._handler.requestRead(data, self._handleHotkeyTable, (id, generation)) def _setupHotkeys(self, data): """Setup the hiven hotkeys and return the data to be written. If there were hotkeys set previously, they are reused as much as possible. Any of them not reused will be cleared.""" hotkeys = self._hotkeys numHotkeys = len(hotkeys) oldHotkeyOffsets = set([] if self._hotkeyOffets is None else self._hotkeyOffets) self._hotkeyOffets = [] numOffsets = 0 while oldHotkeyOffsets: offset = oldHotkeyOffsets.pop() self._hotkeyOffets.append(offset) numOffsets += 1 if numOffsets>=numHotkeys: break for i in range(0, len(data)): if numOffsets>=numHotkeys: break if data[i]==0: self._hotkeyOffets.append(0x3210 + i*4) numOffsets += 1 writeData = [] for i in range(0, numOffsets): Simulator._appendHotkeyData(writeData, self._hotkeyOffets[i], hotkeys[i]) for offset in oldHotkeyOffsets: writeData.append((offset, "u", long(0))) return writeData def _handleHotkeyTable(self, data, (id, generation)): """Handle the result of the query of the hotkey table.""" with self._hotkeyLock: if id==self._hotkeySetID and generation==self._hotkeySetGeneration: writeData = self._setupHotkeys(data) self._handler.requestWrite(writeData, self._handleHotkeysWritten, (id, generation)) def _handleHotkeysWritten(self, success, (id, generation)): """Handle the result of the hotkeys having been written.""" with self._hotkeyLock: if success and id==self._hotkeySetID and \ generation==self._hotkeySetGeneration: data = [(offset + 3, "b") for offset in self._hotkeyOffets] self._hotkeyRequestID = \ self._handler.requestPeriodicRead(0.5, data, self._handleHotkeys, (id, generation)) def _handleHotkeys(self, data, (id, generation)): """Handle the hotkeys.""" with self._hotkeyLock: if id!=self._hotkeySetID or generation!=self._hotkeySetGeneration: return callback = self._hotkeyCallback offsets = self._hotkeyOffets hotkeysPressed = [] for i in range(0, len(data)): if data[i]!=0: hotkeysPressed.append(i) if hotkeysPressed: data = [] for index in hotkeysPressed: data.append((offsets[index]+3, "b", int(0))) self._handler.requestWrite(data, self._handleHotkeysCleared) callback(id, hotkeysPressed) def _handleHotkeysCleared(self, sucess, extra): """Callback for the hotkey-clearing write request.""" def _clearHotkeyRequest(self): """Clear the hotkey request in the handler if there is any.""" if self._hotkeyRequestID is not None: self._handler.clearPeriodic(self._hotkeyRequestID) self._hotkeyRequestID = None #------------------------------------------------------------------------------ class AircraftModel(object): """Base class for the aircraft models. Aircraft models handle the data arriving from FSUIPC and turn it into an object describing the aircraft's state.""" monitoringData = [("paused", 0x0264, "H"), ("latitude", 0x0560, "l"), ("longitude", 0x0568, "l"), ("frozen", 0x3364, "H"), ("replay", 0x0628, "d"), ("slew", 0x05dc, "H"), ("overspeed", 0x036d, "b"), ("stalled", 0x036c, "b"), ("onTheGround", 0x0366, "H"), ("zfw", 0x3bfc, "d"), ("grossWeight", 0x30c0, "f"), ("heading", 0x0580, "d"), ("pitch", 0x0578, "d"), ("bank", 0x057c, "d"), ("ias", 0x02bc, "d"), ("mach", 0x11c6, "H"), ("groundSpeed", 0x02b4, "d"), ("vs", 0x02c8, "d"), ("radioAltitude", 0x31e4, "d"), ("altitude", 0x0570, "l"), ("gLoad", 0x11ba, "H"), ("flapsControl", 0x0bdc, "d"), ("flapsLeft", 0x0be0, "d"), ("flapsRight", 0x0be4, "d"), ("lights", 0x0d0c, "H"), ("pitot", 0x029c, "b"), ("parking", 0x0bc8, "H"), ("gearControl", 0x0be8, "d"), ("noseGear", 0x0bec, "d"), ("spoilersArmed", 0x0bcc, "d"), ("spoilers", 0x0bd0, "d"), ("altimeter", 0x0330, "H"), ("qnh", 0x0ec6, "H"), ("nav1", 0x0350, "H"), ("nav1_obs", 0x0c4e, "H"), ("nav2", 0x0352, "H"), ("nav2_obs", 0x0c5e, "H"), ("adf1_main", 0x034c, "H"), ("adf1_ext", 0x0356, "H"), ("adf2_main", 0x02d4, "H"), ("adf2_ext", 0x02d6, "H"), ("squawk", 0x0354, "H"), ("windSpeed", 0x0e90, "H"), ("windDirection", 0x0e92, "H"), ("visibility", 0x0e8a, "H"), ("cog", 0x2ef8, "f"), ("xpdrC", 0x7b91, "b"), ("apMaster", 0x07bc, "d"), ("apHeadingHold", 0x07c8, "d"), ("apHeading", 0x07cc, "H"), ("apAltitudeHold", 0x07d0, "d"), ("apAltitude", 0x07d4, "u"), ("elevatorTrim", 0x2ea0, "f"), ("eng1DeIce", 0x08b2, "H"), ("eng2DeIce", 0x094a, "H"), ("propDeIce", 0x337c, "b"), ("structDeIce", 0x337d, "b")] specialModels = [] @staticmethod def registerSpecial(clazz): """Register the given class as a special model.""" AircraftModel.specialModels.append(clazz) @staticmethod def findSpecial(aircraft, aircraftName): for specialModel in AircraftModel.specialModels: if specialModel.doesHandle(aircraft, aircraftName): return specialModel return None @staticmethod def create(aircraft, aircraftName): """Create the model for the given aircraft name, and notify the aircraft about it.""" specialModel = AircraftModel.findSpecial(aircraft, aircraftName) if specialModel is not None: return specialModel() if aircraft.type in _genericModels: return _genericModels[aircraft.type]() else: return GenericModel() @staticmethod def convertBCD(data, length): """Convert a data item encoded as BCD into a string of the given number of digits.""" bcd = "" for i in range(0, length): digit = chr(ord('0') + (data&0x0f)) data >>= 4 bcd = digit + bcd return bcd @staticmethod def convertFrequency(data): """Convert the given frequency data to a string.""" bcd = AircraftModel.convertBCD(data, 4) return "1" + bcd[0:2] + "." + bcd[2:4] @staticmethod def convertADFFrequency(main, ext): """Convert the given ADF frequency data to a string.""" mainBCD = AircraftModel.convertBCD(main, 4) extBCD = AircraftModel.convertBCD(ext, 4) return (extBCD[1] if extBCD[1]!="0" else "") + \ mainBCD[1:] + "." + extBCD[3] def __init__(self, flapsNotches): """Construct the aircraft model. flapsNotches is a list of degrees of flaps that are available on the aircraft.""" self._flapsNotches = flapsNotches self._xpdrReliable = False @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic" def doesHandle(self, aircraft, aircraftName): """Determine if the model handles the given aircraft name. This default implementation returns False.""" return False def _addOffsetWithIndexMember(self, dest, offset, type, attrName = None): """Add the given FSUIPC offset and type to the given array and a member attribute with the given name.""" dest.append((offset, type)) if attrName is not None: setattr(self, attrName, len(dest)-1) def _addDataWithIndexMembers(self, dest, prefix, data): """Add FSUIPC data to the given array and also corresponding index member variables with the given prefix. data is a list of triplets of the following items: - the name of the data item. The index member variable will have a name created by prepending the given prefix to this name. - the FSUIPC offset - the FSUIPC type The latter two items will be appended to dest.""" for (name, offset, type) in data: self._addOffsetWithIndexMember(dest, offset, type, prefix + name) def addMonitoringData(self, data, fsType): """Add the model-specific monitoring data to the given array.""" self._addDataWithIndexMembers(data, "_monidx_", AircraftModel.monitoringData) def getAircraftState(self, aircraft, timestamp, data): """Get an aircraft state object for the given monitoring data.""" state = fs.AircraftState() state.timestamp = timestamp state.latitude = data[self._monidx_latitude] * \ 90.0 / 10001750.0 / 65536.0 / 65536.0 state.longitude = data[self._monidx_longitude] * \ 360.0 / 65536.0 / 65536.0 / 65536.0 / 65536.0 if state.longitude>180.0: state.longitude = 360.0 - state.longitude state.paused = data[self._monidx_paused]!=0 or \ data[self._monidx_frozen]!=0 or \ data[self._monidx_replay]!=0 state.trickMode = data[self._monidx_slew]!=0 state.overspeed = data[self._monidx_overspeed]!=0 state.stalled = data[self._monidx_stalled]!=0 state.onTheGround = data[self._monidx_onTheGround]!=0 state.zfw = data[self._monidx_zfw] * const.LBSTOKG / 256.0 state.grossWeight = data[self._monidx_grossWeight] * const.LBSTOKG state.heading = Handler.fsuipc2PositiveDegrees(data[self._monidx_heading]) state.pitch = Handler.fsuipc2Degrees(data[self._monidx_pitch]) state.bank = Handler.fsuipc2Degrees(data[self._monidx_bank]) state.ias = Handler.fsuipc2IAS(data[self._monidx_ias]) state.mach = data[self._monidx_mach] / 20480.0 state.groundSpeed = data[self._monidx_groundSpeed]* 3600.0/65536.0/1852.0 state.vs = Handler.fsuipc2VS(data[self._monidx_vs]) state.radioAltitude = \ Handler.fsuipc2radioAltitude(data[self._monidx_radioAltitude]) state.altitude = data[self._monidx_altitude]/const.FEETTOMETRES/65536.0/65536.0 state.gLoad = data[self._monidx_gLoad] / 625.0 numNotchesM1 = len(self._flapsNotches) - 1 flapsIncrement = 16383 / numNotchesM1 flapsControl = data[self._monidx_flapsControl] flapsIndex = flapsControl / flapsIncrement if flapsIndex < numNotchesM1: if (flapsControl - (flapsIndex*flapsIncrement) > (flapsIndex+1)*flapsIncrement - flapsControl): flapsIndex += 1 state.flapsSet = self._flapsNotches[flapsIndex] flapsLeft = data[self._monidx_flapsLeft] state.flaps = self._flapsNotches[-1]*flapsLeft/16383.0 lights = data[self._monidx_lights] state.navLightsOn = (lights&0x01) != 0 state.antiCollisionLightsOn = (lights&0x02) != 0 state.landingLightsOn = (lights&0x04) != 0 state.strobeLightsOn = (lights&0x10) != 0 state.pitotHeatOn = data[self._monidx_pitot]!=0 state.parking = data[self._monidx_parking]!=0 state.gearControlDown = data[self._monidx_gearControl]==16383 state.gearsDown = data[self._monidx_noseGear]==16383 state.spoilersArmed = data[self._monidx_spoilersArmed]!=0 spoilers = data[self._monidx_spoilers] if spoilers<=4800: state.spoilersExtension = 0.0 else: state.spoilersExtension = (spoilers - 4800) * 100.0 / (16383 - 4800) state.altimeter = data[self._monidx_altimeter] / 16.0 state.altimeterReliable = True state.qnh = data[self._monidx_qnh] / 16.0 state.ils = None state.ils_obs = None state.ils_manual = False state.nav1 = AircraftModel.convertFrequency(data[self._monidx_nav1]) state.nav1_obs = data[self._monidx_nav1_obs] state.nav1_manual = True state.nav2 = AircraftModel.convertFrequency(data[self._monidx_nav2]) state.nav2_obs = data[self._monidx_nav2_obs] state.nav2_manual = True state.adf1 = \ AircraftModel.convertADFFrequency(data[self._monidx_adf1_main], data[self._monidx_adf1_ext]) state.adf2 = \ AircraftModel.convertADFFrequency(data[self._monidx_adf2_main], data[self._monidx_adf2_ext]) state.squawk = AircraftModel.convertBCD(data[self._monidx_squawk], 4) state.windSpeed = data[self._monidx_windSpeed] state.windDirection = data[self._monidx_windDirection]*360.0/65536.0 if state.windDirection<0.0: state.windDirection += 360.0 state.visibility = data[self._monidx_visibility]*1609.344/100.0 state.cog = data[self._monidx_cog] if not self._xpdrReliable: self._xpdrReliable = data[self._monidx_xpdrC]!=0 state.xpdrC = data[self._monidx_xpdrC]!=1 \ if self._xpdrReliable else None state.autoXPDR = False state.apMaster = data[self._monidx_apMaster]!=0 state.apHeadingHold = data[self._monidx_apHeadingHold]!=0 state.apHeading = data[self._monidx_apHeading] * 360.0 / 65536.0 state.apAltitudeHold = data[self._monidx_apAltitudeHold]!=0 state.apAltitude = data[self._monidx_apAltitude] / \ const.FEETTOMETRES / 65536.0 state.elevatorTrim = data[self._monidx_elevatorTrim] * 180.0 / math.pi state.antiIceOn = data[self._monidx_eng1DeIce]!=0 or \ data[self._monidx_eng2DeIce]!=0 or \ data[self._monidx_propDeIce]!=0 or \ data[self._monidx_structDeIce]!=0 return state #------------------------------------------------------------------------------ class GenericAircraftModel(AircraftModel): """A generic aircraft model that can handle the fuel levels, the N1 or RPM values and some other common parameters in a generic way.""" def __init__(self, flapsNotches, fuelTanks, numEngines, isN1 = True): """Construct the generic aircraft model with the given data. flapsNotches is an array of how much degrees the individual flaps notches mean. fuelTanks is an array of const.FUELTANK_XXX constants about the aircraft's fuel tanks. They will be converted to offsets. numEngines is the number of engines the aircraft has. isN1 determines if the engines have an N1 value or an RPM value (e.g. pistons).""" super(GenericAircraftModel, self).__init__(flapsNotches = flapsNotches) self._fuelTanks = fuelTanks self._fuelStartIndex = None self._numEngines = numEngines self._engineStartIndex = None self._isN1 = isN1 def doesHandle(self, aircraft, aircraftName): """Determine if the model handles the given aircraft name. This implementation returns True.""" return True def addMonitoringData(self, data, fsType): """Add the model-specific monitoring data to the given array.""" super(GenericAircraftModel, self).addMonitoringData(data, fsType) self._fuelStartIndex = self._addFuelOffsets(data, "_monidx_fuelWeight") self._engineStartIndex = len(data) for i in range(0, self._numEngines): self._addOffsetWithIndexMember(data, 0x088c + i * 0x98, "h") # throttle lever if self._isN1: self._addOffsetWithIndexMember(data, 0x2000 + i * 0x100, "f") # N1 else: self._addOffsetWithIndexMember(data, 0x0898 + i * 0x98, "H") # RPM self._addOffsetWithIndexMember(data, 0x08c8 + i * 0x98, "H") # RPM scaler def getAircraftState(self, aircraft, timestamp, data): """Get the aircraft state. Get it from the parent, and then add the data about the fuel levels and the engine parameters.""" state = super(GenericAircraftModel, self).getAircraftState(aircraft, timestamp, data) (state.fuel, state.totalFuel) = \ self._convertFuelData(data, index = self._monidx_fuelWeight) state.n1 = [] if self._isN1 else None state.rpm = None if self._isN1 else [] itemsPerEngine = 2 if self._isN1 else 3 state.reverser = [] for i in range(self._engineStartIndex, self._engineStartIndex + itemsPerEngine*self._numEngines, itemsPerEngine): state.reverser.append(data[i]<0) if self._isN1: state.n1.append(data[i+1]) else: state.rpm.append(data[i+1] * data[i+2]/65536.0) return state def getFuel(self, handler, callback): """Get the fuel information for this model. See Simulator.getFuel for more information. This implementation simply queries the fuel tanks given to the constructor.""" data = [] self._addFuelOffsets(data) handler.requestRead(data, self._handleFuelRetrieved, extra = callback) def setFuelLevel(self, handler, levels): """Set the fuel level. See the description of Simulator.setFuelLevel. This implementation simply sets the fuel tanks as given.""" data = [] for (tank, level) in levels: offset = _tank2offset[tank] value = long(level * 128.0 * 65536.0) data.append( (offset, "u", value) ) handler.requestWrite(data, self._handleFuelWritten) def _addFuelOffsets(self, data, weightIndexName = None): """Add the fuel offsets to the given data array. If weightIndexName is not None, it will be the name of the fuel weight index. Returns the index of the first fuel tank's data.""" self._addOffsetWithIndexMember(data, 0x0af4, "H", weightIndexName) fuelStartIndex = len(data) for tank in self._fuelTanks: offset = _tank2offset[tank] self._addOffsetWithIndexMember(data, offset, "u") # tank level self._addOffsetWithIndexMember(data, offset+4, "u") # tank capacity return fuelStartIndex def _convertFuelData(self, data, index = 0, addCapacities = False): """Convert the given data into a fuel info list. The list consists of two or three-tuples of the following items: - the fuel tank ID, - the amount of the fuel in kg, - if addCapacities is True, the total capacity of the tank.""" fuelWeight = data[index] / 256.0 index += 1 result = [] totalFuel = 0 for fuelTank in self._fuelTanks: capacity = data[index+1] * fuelWeight * const.LBSTOKG if capacity>=1.0: amount = data[index] * capacity / 128.0 / 65536.0 result.append( (fuelTank, amount, capacity) if addCapacities else (fuelTank, amount)) totalFuel += amount index += 2 return (result, totalFuel) def _handleFuelRetrieved(self, data, callback): """Callback for a fuel retrieval request.""" (fuelData, _totalFuel) = self._convertFuelData(data, addCapacities = True) callback(fuelData) def _handleFuelWritten(self, success, extra): """Callback for a fuel setting request.""" pass #------------------------------------------------------------------------------ class GenericModel(GenericAircraftModel): """Generic aircraft model for an unknown type.""" def __init__(self): """Construct the model.""" super(GenericModel, self). \ __init__(flapsNotches = [0, 10, 20, 30], fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_RIGHT], numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic" #------------------------------------------------------------------------------ class B737Model(GenericAircraftModel): """Generic model for the Boeing 737 Classing and NG aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(B737Model, self). \ __init__(flapsNotches = [0, 1, 2, 5, 10, 15, 25, 30, 40], fuelTanks = B737Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Boeing 737" #------------------------------------------------------------------------------ class PMDGBoeing737NGModel(B737Model): """A model handler for the PMDG Boeing 737NG model.""" @staticmethod def doesHandle(aircraft, (name, airPath)): """Determine if this model handler handles the aircraft with the given name.""" return aircraft.type in [const.AIRCRAFT_B736, const.AIRCRAFT_B737, const.AIRCRAFT_B738, const.AIRCRAFT_B738C] and \ (name.find("PMDG")!=-1 or airPath.find("PMDG")!=-1) and \ (name.find("737")!=-1 or airPath.find("737")!=-1) and \ (name.find("600")!=-1 or airPath.find("600")!=-1 or \ name.find("700")!=-1 or airPath.find("700")!=-1 or \ name.find("800")!=-1 or airPath.find("800")!=-1 or \ name.find("900")!=-1 or airPath.find("900")!=-1) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/PMDG Boeing 737NG(X)" def addMonitoringData(self, data, fsType): """Add the model-specific monitoring data to the given array.""" self._fsType = fsType super(PMDGBoeing737NGModel, self).addMonitoringData(data, fsType) if fsType==const.SIM_MSFSX: print "FSX detected, adding PMDG 737 NGX-specific offsets" self._addOffsetWithIndexMember(data, 0x6500, "b", "_pmdgidx_lts_positionsw") self._addOffsetWithIndexMember(data, 0x6545, "b", "_pmdgidx_cmda") self._addOffsetWithIndexMember(data, 0x653f, "b", "_pmdgidx_aphdgsel") self._addOffsetWithIndexMember(data, 0x6543, "b", "_pmdgidx_apalthold") self._addOffsetWithIndexMember(data, 0x652c, "H", "_pmdgidx_aphdg") self._addOffsetWithIndexMember(data, 0x652e, "H", "_pmdgidx_apalt") self._addOffsetWithIndexMember(data, 0x65cd, "b", "_pmdgidx_xpdr") else: print "FS9 detected, adding PMDG 737 NG-specific offsets" self._addOffsetWithIndexMember(data, 0x6202, "b", "_pmdgidx_switches") self._addOffsetWithIndexMember(data, 0x6216, "b", "_pmdgidx_xpdr") self._addOffsetWithIndexMember(data, 0x6227, "b", "_pmdgidx_ap") self._addOffsetWithIndexMember(data, 0x6228, "b", "_pmdgidx_aphdgsel") self._addOffsetWithIndexMember(data, 0x622a, "b", "_pmdgidx_apalthold") self._addOffsetWithIndexMember(data, 0x622c, "H", "_pmdgidx_aphdg") self._addOffsetWithIndexMember(data, 0x622e, "H", "_pmdgidx_apalt") def getAircraftState(self, aircraft, timestamp, data): """Get the aircraft state. Get it from the parent, and then check some PMDG-specific stuff.""" state = super(PMDGBoeing737NGModel, self).getAircraftState(aircraft, timestamp, data) if self._fsType==const.SIM_MSFS9: if data[self._pmdgidx_switches]&0x01==0x01: state.altimeter = 1013.25 state.apMaster = data[self._pmdgidx_ap]&0x02==0x02 state.apHeadingHold = data[self._pmdgidx_aphdgsel]==2 apalthold = data[self._pmdgidx_apalthold] state.apAltitudeHold = apalthold>=3 and apalthold<=6 else: state.apMaster = data[self._pmdgidx_cmda]!=0 state.apHeadingHold = data[self._pmdgidx_aphdgsel]!=0 state.apAltitudeHold = data[self._pmdgidx_apalthold]!=0 #state.strobeLightsOn = data[self._pmdgidx_lts_positionsw]==0x02 state.strobeLightsOn = None state.xpdrC = data[self._pmdgidx_xpdr]==4 state.apHeading = data[self._pmdgidx_aphdg] state.apAltitude = data[self._pmdgidx_apalt] return state #------------------------------------------------------------------------------ class B767Model(GenericAircraftModel): """Generic model for the Boeing 767 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(B767Model, self). \ __init__(flapsNotches = [0, 1, 5, 15, 20, 25, 30], fuelTanks = B767Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Boeing 767" #------------------------------------------------------------------------------ class DH8DModel(GenericAircraftModel): """Generic model for the Bombardier Dash 8-Q400 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(DH8DModel, self). \ __init__(flapsNotches = [0, 5, 10, 15, 35], fuelTanks = DH8DModel.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Bombardier Dash 8-Q400" #------------------------------------------------------------------------------ class DreamwingsDH8DModel(DH8DModel): """Model handler for the Dreamwings Dash 8-Q400.""" @staticmethod def doesHandle(aircraft, (name, airPath)): """Determine if this model handler handles the aircraft with the given name.""" return aircraft.type==const.AIRCRAFT_DH8D and \ (name.find("Dreamwings")!=-1 or airPath.find("Dreamwings")!=-1) and \ (name.find("Dash")!=-1 or airPath.find("Dash")!=-1) and \ (name.find("Q400")!=-1 or airPath.find("Q400")!=-1) and \ airPath.find("Dash8Q400")!=-1 @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Dreamwings Bombardier Dash 8-Q400" def addMonitoringData(self, data, fsType): """Add the model-specific monitoring data to the given array.""" super(DreamwingsDH8DModel, self).addMonitoringData(data, fsType) self._addOffsetWithIndexMember(data, 0x132c, "d", "_dwdh8d_navgps") def getAircraftState(self, aircraft, timestamp, data): """Get the aircraft state. Get it from the parent, and then invert the pitot heat state.""" state = super(DreamwingsDH8DModel, self).getAircraftState(aircraft, timestamp, data) if data[self._dwdh8d_navgps]==1: state.apHeading = None return state #------------------------------------------------------------------------------ class CRJ2Model(GenericAircraftModel): """Generic model for the Bombardier CRJ-200 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(CRJ2Model, self). \ __init__(flapsNotches = [0, 8, 20, 30, 45], fuelTanks = CRJ2Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Bombardier CRJ-200" #------------------------------------------------------------------------------ class F70Model(GenericAircraftModel): """Generic model for the Fokker F70 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(F70Model, self). \ __init__(flapsNotches = [0, 8, 15, 25, 42], fuelTanks = F70Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Fokker 70" #------------------------------------------------------------------------------ class DAF70Model(F70Model): """Model for the Digital Aviation F70 implementation on FS9.""" @staticmethod def doesHandle(aircraft, (name, airPath)): """Determine if this model handler handles the aircraft with the given name.""" return aircraft.type == const.AIRCRAFT_F70 and \ (airPath.endswith("fokker70_2k4_v4.1.air") or airPath.endswith("fokker70_2k4_v4.3.air")) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Digital Aviation Fokker 70" def getAircraftState(self, aircraft, timestamp, data): """Get the aircraft state. Get it from the parent, and then invert the pitot heat state.""" state = super(DAF70Model, self).getAircraftState(aircraft, timestamp, data) state.navLightsOn = None state.landingLightsOn = None state.altimeterReliable = False state.ils = state.nav1 state.ils_obs = state.nav1_obs state.ils_manual = state.nav1_manual state.nav1 = state.nav2 state.nav1_obs = state.nav2_obs state.nav1_manual = aircraft.flight.stage!=const.STAGE_CRUISE state.nav2 = None state.nav2_obs = None state.nav2_manual = False state.autoXPDR = True return state #------------------------------------------------------------------------------ class DC3Model(GenericAircraftModel): """Generic model for the Lisunov Li-2 (DC-3) aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] # fuelTanks = [const.FUELTANK_LEFT_AUX, const.FUELTANK_LEFT, # const.FUELTANK_RIGHT, const.FUELTANK_RIGHT_AUX] def __init__(self): """Construct the model.""" super(DC3Model, self). \ __init__(flapsNotches = [0, 15, 30, 45], fuelTanks = DC3Model.fuelTanks, numEngines = 2, isN1 = False) self._leftLevel = 0.0 self._rightLevel = 0.0 @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Lisunov Li-2 (DC-3)" def _convertFuelData(self, data, index = 0, addCapacities = False): """Convert the given data into a fuel info list. It assumes to receive the 3 fuel tanks as seen above (left, centre and right) and converts it to left aux, left, right, and right aux. The amount in the left tank goes into left aux, the amount of the right tank goes into right aux and the amount of the centre tank goes into the left and right tanks evenly distributed.""" (rawFuelData, totalFuel) = \ super(DC3Model, self)._convertFuelData(data, index, addCapacities) centreAmount = rawFuelData[1][1] if addCapacities: centreCapacity = rawFuelData[1][2] self._leftLevel = self._rightLevel = \ centreAmount / centreCapacity / 2.0 fuelData = [(const.FUELTANK_LEFT_AUX, rawFuelData[0][1], rawFuelData[0][2]), (const.FUELTANK_LEFT, centreAmount/2.0, centreCapacity/2.0), (const.FUELTANK_RIGHT, centreAmount/2.0, centreCapacity/2.0), (const.FUELTANK_RIGHT_AUX, rawFuelData[2][1], rawFuelData[2][2])] else: fuelData = [(const.FUELTANK_LEFT_AUX, rawFuelData[0][1]), (const.FUELTANK_LEFT, centreAmount/2.0), (const.FUELTANK_RIGHT, centreAmount/2.0), (const.FUELTANK_RIGHT_AUX, rawFuelData[2][1])] return (fuelData, totalFuel) def setFuelLevel(self, handler, levels): """Set the fuel level. See the description of Simulator.setFuelLevel. This implementation assumes to get the four-tank representation, as returned by getFuel().""" leftLevel = None centreLevel = None rightLevel = None for (tank, level) in levels: if tank==const.FUELTANK_LEFT_AUX: leftLevel = level if leftLevel is None else (leftLevel + level) elif tank==const.FUELTANK_LEFT: level /= 2.0 centreLevel = (self._rightLevel + level) \ if centreLevel is None else (centreLevel + level) self._leftLevel = level elif tank==const.FUELTANK_RIGHT: level /= 2.0 centreLevel = (self._leftLevel + level) \ if centreLevel is None else (centreLevel + level) self._rightLevel = level elif tank==const.FUELTANK_RIGHT_AUX: rightLevel = level if rightLevel is None \ else (rightLevel + level) levels = [] if leftLevel is not None: levels.append((const.FUELTANK_LEFT, leftLevel)) if centreLevel is not None: levels.append((const.FUELTANK_CENTRE, centreLevel)) if rightLevel is not None: levels.append((const.FUELTANK_RIGHT, rightLevel)) super(DC3Model, self).setFuelLevel(handler, levels) #------------------------------------------------------------------------------ class T134Model(GenericAircraftModel): """Generic model for the Tupolev Tu-134 aircraft.""" fuelTanks = [const.FUELTANK_LEFT_TIP, const.FUELTANK_EXTERNAL1, const.FUELTANK_LEFT_AUX, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT_AUX, const.FUELTANK_EXTERNAL2, const.FUELTANK_RIGHT_TIP] def __init__(self): """Construct the model.""" super(T134Model, self). \ __init__(flapsNotches = [0, 10, 20, 30], fuelTanks = T134Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Tupolev Tu-134" #------------------------------------------------------------------------------ class T154Model(GenericAircraftModel): """Generic model for the Tupolev Tu-134 aircraft.""" fuelTanks = [const.FUELTANK_LEFT_AUX, const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_CENTRE2, const.FUELTANK_RIGHT, const.FUELTANK_RIGHT_AUX] def __init__(self): """Construct the model.""" super(T154Model, self). \ __init__(flapsNotches = [0, 15, 28, 45], fuelTanks = T154Model.fuelTanks, numEngines = 3) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Tupolev Tu-154" def getAircraftState(self, aircraft, timestamp, data): """Get an aircraft state object for the given monitoring data. This removes the reverser value for the middle engine.""" state = super(T154Model, self).getAircraftState(aircraft, timestamp, data) del state.reverser[1] return state #------------------------------------------------------------------------------ class PTT154Model(T154Model): """Project Tupolev Tu-154.""" @staticmethod def doesHandle(aircraft, (name, airPath)): """Determine if this model handler handles the aircraft with the given name.""" print "PTT154Model.doesHandle", aircraft.type, name, airPath return aircraft.type==const.AIRCRAFT_T154 and \ (name.find("Tu-154")!=-1 or name.find("Tu154B")!=-1) and \ os.path.basename(airPath).startswith("154b_") def __init__(self): """Construct the model.""" super(PTT154Model, self).__init__() self._adf1 = None self._adf2 = None self._lastValue = None self._fsType = None @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Project Tupolev Tu-154" def addMonitoringData(self, data, fsType): """Add the model-specific monitoring data to the given array. It only stores the flight simulator type.""" self._fsType = fsType super(PTT154Model, self).addMonitoringData(data, fsType) def getAircraftState(self, aircraft, timestamp, data): """Get an aircraft state object for the given monitoring data. This removes the reverser value for the middle engine.""" state = super(PTT154Model, self).getAircraftState(aircraft, timestamp, data) adf1 = state.adf1 if self._adf1 is None: self._adf1 = self._adf2 = adf1 elif adf1 != self._lastValue and adf1 != self._adf1 and \ adf1 != self._adf2: if self._lastValue==self._adf2: self._adf1 = adf1 else: self._adf2 = adf1 self._lastValue = adf1 state.adf1 = self._adf1 state.adf2 = self._adf2 if self._fsType==const.SIM_MSFSX: state.xpdrC = None return state #------------------------------------------------------------------------------ class YK40Model(GenericAircraftModel): """Generic model for the Yakovlev Yak-40 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(YK40Model, self). \ __init__(flapsNotches = [0, 20, 35], fuelTanks = YK40Model.fuelTanks, numEngines = 2) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic Yakovlev Yak-40" #------------------------------------------------------------------------------ class B462Model(GenericAircraftModel): """Generic model for the British Aerospace BAe 146-200 aircraft.""" fuelTanks = [const.FUELTANK_LEFT, const.FUELTANK_CENTRE, const.FUELTANK_RIGHT] def __init__(self): """Construct the model.""" super(B462Model, self). \ __init__(flapsNotches = [0, 18, 24, 30, 33], fuelTanks = B462Model.fuelTanks, numEngines = 4) @property def name(self): """Get the name for this aircraft model.""" return "FSUIPC/Generic British Aerospace 146" def getAircraftState(self, aircraft, timestamp, data): """Get an aircraft state object for the given monitoring data. This removes the reverser value for the middle engine.""" state = super(B462Model, self).getAircraftState(aircraft, timestamp, data) state.reverser = [] return state #------------------------------------------------------------------------------ _genericModels = { const.AIRCRAFT_B736 : B737Model, const.AIRCRAFT_B737 : B737Model, const.AIRCRAFT_B738 : B737Model, const.AIRCRAFT_B738C : B737Model, const.AIRCRAFT_B733 : B737Model, const.AIRCRAFT_B734 : B737Model, const.AIRCRAFT_B735 : B737Model, const.AIRCRAFT_DH8D : DH8DModel, const.AIRCRAFT_B762 : B767Model, const.AIRCRAFT_B763 : B767Model, const.AIRCRAFT_CRJ2 : CRJ2Model, const.AIRCRAFT_F70 : F70Model, const.AIRCRAFT_DC3 : DC3Model, const.AIRCRAFT_T134 : T134Model, const.AIRCRAFT_T154 : T154Model, const.AIRCRAFT_YK40 : YK40Model, const.AIRCRAFT_B462 : B462Model } #------------------------------------------------------------------------------ AircraftModel.registerSpecial(PMDGBoeing737NGModel) AircraftModel.registerSpecial(DreamwingsDH8DModel) AircraftModel.registerSpecial(DAF70Model) AircraftModel.registerSpecial(PTT154Model) #------------------------------------------------------------------------------