[298] | 1 |
|
---|
| 2 | import fs
|
---|
| 3 | import const
|
---|
| 4 | import util
|
---|
| 5 | from acars import ACARS
|
---|
| 6 | from sound import startSound
|
---|
| 7 |
|
---|
| 8 | import time
|
---|
| 9 |
|
---|
| 10 | #---------------------------------------------------------------------------------------
|
---|
| 11 |
|
---|
[297] | 12 | ## @package mlx.checks
|
---|
| 13 | #
|
---|
| 14 | # The classes that check the state of the aircraft.
|
---|
| 15 | #
|
---|
| 16 | # During the flight the program periodically queries various data from the
|
---|
| 17 | # simulator. This data is returned in instances of the \ref
|
---|
| 18 | # mlx.fs.AircraftState class and passed to the various "checkers",
|
---|
| 19 | # i.e. instances of subclasses of the \ref StateChecker class. These checkers
|
---|
| 20 | # perform various checks to see if the aircraft's parameters are within the
|
---|
| 21 | # expected limits, or some of them just logs something.
|
---|
| 22 | #
|
---|
| 23 | # There are a few special ones, such as \ref StageChecker which computes the
|
---|
| 24 | # transitions from one stage of the flight to the next one. Or \ref ACARSSender
|
---|
| 25 | # which sends the ACARS periodically
|
---|
[8] | 26 |
|
---|
| 27 | #---------------------------------------------------------------------------------------
|
---|
| 28 |
|
---|
| 29 | class StateChecker(object):
|
---|
| 30 | """Base class for classes the instances of which check the aircraft's state
|
---|
| 31 | from some aspect.
|
---|
| 32 |
|
---|
| 33 | As a result of the check they may log something, or notify of some fault, etc."""
|
---|
| 34 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 35 | """Perform the check and do whatever is needed.
|
---|
| 36 |
|
---|
| 37 | This default implementation raises a NotImplementedError."""
|
---|
| 38 | raise NotImplementedError()
|
---|
[332] | 39 |
|
---|
[8] | 40 | #---------------------------------------------------------------------------------------
|
---|
| 41 |
|
---|
| 42 | class StageChecker(StateChecker):
|
---|
| 43 | """Check the flight stage transitions."""
|
---|
[25] | 44 | def __init__(self):
|
---|
| 45 | """Construct the stage checker."""
|
---|
| 46 | self._flareStarted = False
|
---|
| 47 |
|
---|
[8] | 48 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 49 | """Check the stage of the aircraft."""
|
---|
| 50 | stage = flight.stage
|
---|
| 51 | if stage==None:
|
---|
| 52 | aircraft.setStage(state, const.STAGE_BOARDING)
|
---|
| 53 | elif stage==const.STAGE_BOARDING:
|
---|
| 54 | if not state.parking or \
|
---|
| 55 | (not state.trickMode and state.groundSpeed>5.0):
|
---|
| 56 | aircraft.setStage(state, const.STAGE_PUSHANDTAXI)
|
---|
| 57 | elif stage==const.STAGE_PUSHANDTAXI or stage==const.STAGE_RTO:
|
---|
[351] | 58 | if state.strobeLightsOn:
|
---|
[8] | 59 | aircraft.setStage(state, const.STAGE_TAKEOFF)
|
---|
| 60 | elif stage==const.STAGE_TAKEOFF:
|
---|
| 61 | if not state.gearsDown or \
|
---|
| 62 | (state.radioAltitude>3000.0 and state.vs>0):
|
---|
| 63 | aircraft.setStage(state, const.STAGE_CLIMB)
|
---|
| 64 | elif not state.landingLightsOn and \
|
---|
| 65 | not state.strobeLightsOn and \
|
---|
| 66 | state.onTheGround and \
|
---|
| 67 | state.groundSpeed<50.0:
|
---|
| 68 | aircraft.setStage(state, const.STAGE_RTO)
|
---|
| 69 | elif stage==const.STAGE_CLIMB:
|
---|
| 70 | if (state.altitude+2000) > flight.cruiseAltitude:
|
---|
| 71 | aircraft.setStage(state, const.STAGE_CRUISE)
|
---|
| 72 | elif state.radioAltitude<2000.0 and \
|
---|
| 73 | state.vs < 0.0 and state.gearsDown:
|
---|
| 74 | aircraft.setStage(state, const.STAGE_LANDING)
|
---|
| 75 | elif stage==const.STAGE_CRUISE:
|
---|
| 76 | if (state.altitude+2000) < flight.cruiseAltitude:
|
---|
| 77 | aircraft.setStage(state, const.STAGE_DESCENT)
|
---|
| 78 | elif stage==const.STAGE_DESCENT or stage==const.STAGE_GOAROUND:
|
---|
| 79 | if state.gearsDown and state.radioAltitude<2000.0:
|
---|
| 80 | aircraft.setStage(state, const.STAGE_LANDING)
|
---|
| 81 | elif (state.altitude+2000) > flight.cruiseAltitude:
|
---|
| 82 | aircraft.setStage(state, const.STAGE_CRUISE)
|
---|
| 83 | elif stage==const.STAGE_LANDING:
|
---|
[332] | 84 | if state.onTheGround and state.groundSpeed<25.0:
|
---|
[8] | 85 | aircraft.setStage(state, const.STAGE_TAXIAFTERLAND)
|
---|
| 86 | elif not state.gearsDown:
|
---|
| 87 | aircraft.setStage(state, const.STAGE_GOAROUND)
|
---|
[25] | 88 | elif state.radioAltitude>200 and self._flareStarted:
|
---|
[8] | 89 | aircraft.cancelFlare()
|
---|
[25] | 90 | self._flareStarted = False
|
---|
| 91 | elif state.radioAltitude<150 and not state.onTheGround and \
|
---|
| 92 | not self._flareStarted:
|
---|
| 93 | self._flareStarted = True
|
---|
[9] | 94 | aircraft.prepareFlare()
|
---|
[8] | 95 | elif stage==const.STAGE_TAXIAFTERLAND:
|
---|
[359] | 96 | if state.parking and aircraft.checkFlightEnd(state):
|
---|
[8] | 97 | aircraft.setStage(state, const.STAGE_END)
|
---|
| 98 |
|
---|
| 99 | #---------------------------------------------------------------------------------------
|
---|
| 100 |
|
---|
[139] | 101 | class ACARSSender(StateChecker):
|
---|
| 102 | """Sender of online ACARS.
|
---|
| 103 |
|
---|
| 104 | It sends the ACARS every 3 minutes to the MAVA website."""
|
---|
| 105 |
|
---|
[297] | 106 | ## The interval at which the ACARS are sent
|
---|
[139] | 107 | INTERVAL = 3*60.0
|
---|
[332] | 108 |
|
---|
[139] | 109 | def __init__(self, gui):
|
---|
| 110 | """Construct the ACARS sender."""
|
---|
| 111 | self._gui = gui
|
---|
| 112 | self._lastSent = None
|
---|
[374] | 113 | self._sending = False
|
---|
[139] | 114 |
|
---|
| 115 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 116 | """If the time has come to send the ACARS, send it."""
|
---|
[374] | 117 | if self._sending:
|
---|
| 118 | return
|
---|
| 119 |
|
---|
[139] | 120 | now = time.time()
|
---|
[332] | 121 |
|
---|
[139] | 122 | if self._lastSent is not None and \
|
---|
| 123 | (self._lastSent + ACARSSender.INTERVAL)>now:
|
---|
[332] | 124 | return
|
---|
[139] | 125 |
|
---|
[380] | 126 | self._sending = True
|
---|
[139] | 127 | acars = ACARS(self._gui, state)
|
---|
| 128 | self._gui.webHandler.sendACARS(self._acarsCallback, acars)
|
---|
| 129 |
|
---|
| 130 | def _acarsCallback(self, returned, result):
|
---|
| 131 | """Callback for ACARS sending."""
|
---|
| 132 | if returned:
|
---|
| 133 | print "Sent online ACARS"
|
---|
| 134 | self._lastSent = time.time() if self._lastSent is None \
|
---|
| 135 | else self._lastSent + ACARSSender.INTERVAL
|
---|
| 136 | else:
|
---|
| 137 | print "Failed to send the ACARS"
|
---|
[374] | 138 | self._sending = False
|
---|
[332] | 139 |
|
---|
[139] | 140 | #---------------------------------------------------------------------------------------
|
---|
| 141 |
|
---|
[9] | 142 | class TakeOffLogger(StateChecker):
|
---|
| 143 | """Logger for the cruise speed."""
|
---|
| 144 | def __init__(self):
|
---|
| 145 | """Construct the logger."""
|
---|
| 146 | self._onTheGround = True
|
---|
[332] | 147 |
|
---|
[9] | 148 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 149 | """Log the cruise speed if necessary."""
|
---|
| 150 | if flight.stage==const.STAGE_TAKEOFF and \
|
---|
| 151 | self._onTheGround and not state.onTheGround:
|
---|
| 152 | logger.message(state.timestamp,
|
---|
[241] | 153 | "Takeoff speed: %.0f %s" % \
|
---|
| 154 | (flight.speedFromKnots(state.ias),
|
---|
| 155 | flight.getEnglishSpeedUnit()))
|
---|
[9] | 156 | logger.message(state.timestamp,
|
---|
| 157 | "Takeoff heading: %03.0f degrees" % (state.heading,))
|
---|
| 158 | logger.message(state.timestamp,
|
---|
| 159 | "Takeoff pitch: %.1f degrees" % (state.pitch,))
|
---|
[332] | 160 | logger.message(state.timestamp,
|
---|
[364] | 161 | "Takeoff flaps: %.0f" % (state.flapsSet))
|
---|
| 162 | logger.message(state.timestamp,
|
---|
[340] | 163 | "CG/Trim: %.1f%%/%.2f" % \
|
---|
| 164 | (state.cog*100.0, state.elevatorTrim))
|
---|
[9] | 165 | self._onTheGround = False
|
---|
| 166 |
|
---|
| 167 | #---------------------------------------------------------------------------------------
|
---|
| 168 |
|
---|
| 169 | class CruiseSpeedLogger(StateChecker):
|
---|
| 170 | """Logger for the cruise speed."""
|
---|
| 171 | def __init__(self):
|
---|
| 172 | """Construct the logger."""
|
---|
| 173 | self._lastTime = None
|
---|
[332] | 174 |
|
---|
[9] | 175 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 176 | """Log the cruise speed if necessary."""
|
---|
| 177 | if flight.stage==const.STAGE_CRUISE and \
|
---|
| 178 | (self._lastTime is None or \
|
---|
| 179 | (self._lastTime+800)<=state.timestamp):
|
---|
| 180 | if state.altitude>24500.0:
|
---|
| 181 | logger.message(state.timestamp,
|
---|
[10] | 182 | "Cruise speed: %.3f mach" % (state.mach,))
|
---|
[9] | 183 | else:
|
---|
| 184 | logger.message(state.timestamp,
|
---|
[241] | 185 | "Cruise speed: %.0f %s" %
|
---|
| 186 | (flight.speedFromKnots(state.ias),
|
---|
| 187 | flight.getEnglishSpeedUnit()))
|
---|
[9] | 188 | self._lastTime = state.timestamp
|
---|
| 189 |
|
---|
| 190 | #---------------------------------------------------------------------------------------
|
---|
| 191 |
|
---|
[10] | 192 | class SpoilerLogger(StateChecker):
|
---|
| 193 | """Logger for the cruise speed."""
|
---|
| 194 | def __init__(self):
|
---|
| 195 | """Construct the logger."""
|
---|
| 196 | self._logged = False
|
---|
[13] | 197 | self._spoilersExtension = None
|
---|
[332] | 198 |
|
---|
[10] | 199 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 200 | """Log the cruise speed if necessary."""
|
---|
| 201 | if flight.stage==const.STAGE_LANDING and not self._logged:
|
---|
| 202 | if state.onTheGround:
|
---|
[13] | 203 | if state.spoilersExtension!=self._spoilersExtension:
|
---|
[10] | 204 | logger.message(state.timestamp, "Spoilers deployed")
|
---|
| 205 | self._logged = True
|
---|
[170] | 206 | config = flight.config
|
---|
| 207 | if config.enableSounds and config.speedbrakeAtTD:
|
---|
| 208 | startSound(const.SOUND_SPEEDBRAKE)
|
---|
[10] | 209 | else:
|
---|
[13] | 210 | self._spoilersExtension = state.spoilersExtension
|
---|
[10] | 211 |
|
---|
| 212 | #---------------------------------------------------------------------------------------
|
---|
| 213 |
|
---|
[134] | 214 | class VisibilityChecker(StateChecker):
|
---|
| 215 | """Inform the pilot of the visibility once when descending below 2000 ft,
|
---|
| 216 | then when descending below 1000 ft."""
|
---|
| 217 | def __init__(self):
|
---|
| 218 | """Construct the visibility checker."""
|
---|
| 219 | self._informedBelow2000 = False
|
---|
| 220 | self._informedBelow1000 = False
|
---|
| 221 |
|
---|
| 222 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 223 | """Check if we need to inform the pilot of the visibility."""
|
---|
| 224 | if flight.stage==const.STAGE_DESCENT or \
|
---|
| 225 | flight.stage==const.STAGE_LANDING:
|
---|
| 226 | if (state.radioAltitude<2000 and not self._informedBelow2000) or \
|
---|
| 227 | (state.radioAltitude<1000 and not self._informedBelow1000):
|
---|
| 228 | visibilityString = util.visibility2String(state.visibility)
|
---|
| 229 | fs.sendMessage(const.MESSAGETYPE_VISIBILITY,
|
---|
| 230 | "Current visibility: " + visibilityString,
|
---|
| 231 | 5)
|
---|
| 232 | logger.message(state.timestamp,
|
---|
| 233 | "Pilot was informed about the visibility: " +
|
---|
| 234 | visibilityString)
|
---|
| 235 | self._informedBelow2000 = True
|
---|
| 236 | self._informedBelow1000 = state.radioAltitude<1000
|
---|
| 237 |
|
---|
| 238 | #---------------------------------------------------------------------------------------
|
---|
| 239 |
|
---|
[273] | 240 | class ApproachCalloutsPlayer(StateChecker):
|
---|
| 241 | """A state checker that plays a sequence of approach callouts.
|
---|
| 242 |
|
---|
| 243 | It tracks the altitude during the descent and landing phases and
|
---|
| 244 | if the altitude crosses one that has a callout associated with and
|
---|
[332] | 245 | the vertical speed is negative, that callout will be played."""
|
---|
[273] | 246 | def __init__(self, approachCallouts):
|
---|
| 247 | """Construct the approach callouts player."""
|
---|
| 248 | self._approachCallouts = approachCallouts
|
---|
| 249 | self._altitudes = approachCallouts.getAltitudes(descending = False)
|
---|
| 250 |
|
---|
| 251 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 252 | """Check if we need to play a callout."""
|
---|
| 253 | if (flight.stage==const.STAGE_DESCENT or \
|
---|
| 254 | flight.stage==const.STAGE_LANDING) and state.vs<0:
|
---|
| 255 | oldRadioAltitude = oldState.radioAltitude
|
---|
| 256 | radioAltitude = state.radioAltitude
|
---|
| 257 | for altitude in self._altitudes:
|
---|
| 258 | if radioAltitude<=altitude and \
|
---|
| 259 | oldRadioAltitude>altitude:
|
---|
| 260 | startSound(self._approachCallouts[altitude])
|
---|
| 261 | break
|
---|
| 262 |
|
---|
| 263 | #---------------------------------------------------------------------------------------
|
---|
| 264 |
|
---|
[8] | 265 | class StateChangeLogger(StateChecker):
|
---|
| 266 | """Base class for classes the instances of which check if a specific change has
|
---|
| 267 | occured in the aircraft's state, and log such change."""
|
---|
[356] | 268 | def __init__(self, logInitial = True, excludedStages = None):
|
---|
[8] | 269 | """Construct the logger.
|
---|
| 270 |
|
---|
| 271 | If logInitial is True, the initial value will be logged, not just the
|
---|
| 272 | changes later.
|
---|
| 273 |
|
---|
[356] | 274 | If excludedStages is given, it should be a list containing those stages
|
---|
| 275 | during which the changes should not be logged.
|
---|
| 276 |
|
---|
[8] | 277 | Child classes should define the following functions:
|
---|
| 278 | - _changed(self, oldState, state): returns a boolean indicating if the
|
---|
| 279 | value has changed or not
|
---|
[321] | 280 | - _getMessage(self, flight, state, forced): return a strings containing
|
---|
| 281 | the message to log with the new value
|
---|
[8] | 282 | """
|
---|
[332] | 283 | self._logInitial = logInitial
|
---|
[356] | 284 | self._excludedStages = [] if excludedStages is None else excludedStages
|
---|
[8] | 285 |
|
---|
[324] | 286 | def _getLogTimestamp(self, state, forced):
|
---|
[22] | 287 | """Get the log timestamp."""
|
---|
| 288 | return state.timestamp
|
---|
| 289 |
|
---|
[8] | 290 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 291 | """Check if the state has changed, and if so, log the new state."""
|
---|
[356] | 292 | if flight.stage in self._excludedStages:
|
---|
| 293 | return
|
---|
| 294 |
|
---|
[8] | 295 | shouldLog = False
|
---|
| 296 | if oldState is None:
|
---|
| 297 | shouldLog = self._logInitial
|
---|
| 298 | else:
|
---|
| 299 | shouldLog = self._changed(oldState, state)
|
---|
[332] | 300 |
|
---|
[8] | 301 | if shouldLog:
|
---|
[321] | 302 | self.logState(flight, logger, state)
|
---|
| 303 |
|
---|
| 304 | def logState(self, flight, logger, state, forced = False):
|
---|
| 305 | """Log the state."""
|
---|
| 306 | message = self._getMessage(flight, state, forced)
|
---|
| 307 | if message is not None:
|
---|
[324] | 308 | logger.message(self._getLogTimestamp(state, forced), message)
|
---|
[332] | 309 |
|
---|
[241] | 310 | #-------------------------------------------------------------------------------
|
---|
[8] | 311 |
|
---|
| 312 | class SimpleChangeMixin(object):
|
---|
| 313 | """A mixin that defines a _changed() function which simply calls a function
|
---|
| 314 | to retrieve the value two monitor for both states and compares them.
|
---|
| 315 |
|
---|
| 316 | Child classes should define the following function:
|
---|
| 317 | - _getValue(state): get the value we are interested in."""
|
---|
| 318 | def _changed(self, oldState, state):
|
---|
| 319 | """Determine if the value has changed."""
|
---|
[314] | 320 | currentValue = self._getValue(state)
|
---|
| 321 | return currentValue is not None and self._getValue(oldState)!=currentValue
|
---|
[8] | 322 |
|
---|
| 323 | #---------------------------------------------------------------------------------------
|
---|
| 324 |
|
---|
| 325 | class SingleValueMixin(object):
|
---|
| 326 | """A mixin that provides a _getValue() function to query a value from the
|
---|
| 327 | state using the name of the attribute."""
|
---|
| 328 | def __init__(self, attrName):
|
---|
| 329 | """Construct the mixin with the given attribute name."""
|
---|
| 330 | self._attrName = attrName
|
---|
| 331 |
|
---|
| 332 | def _getValue(self, state):
|
---|
| 333 | """Get the value of the attribute from the state."""
|
---|
| 334 | return getattr(state, self._attrName)
|
---|
[332] | 335 |
|
---|
[8] | 336 | #---------------------------------------------------------------------------------------
|
---|
| 337 |
|
---|
| 338 | class DelayedChangeMixin(object):
|
---|
| 339 | """A mixin to a StateChangeLogger that stores the old value and reports a
|
---|
| 340 | change only if the change has been there for a certain amount of time.
|
---|
| 341 |
|
---|
| 342 | Child classes should define the following function:
|
---|
| 343 | - _getValue(state): get the value we are interested in."""
|
---|
[22] | 344 | def __init__(self, minDelay = 3.0, maxDelay = 10.0):
|
---|
[8] | 345 | """Construct the mixin with the given delay in seconds."""
|
---|
[22] | 346 | self._minDelay = minDelay
|
---|
| 347 | self._maxDelay = maxDelay
|
---|
[8] | 348 | self._oldValue = None
|
---|
| 349 | self._firstChange = None
|
---|
[22] | 350 | self._lastChangeState = None
|
---|
[355] | 351 | self._lastLoggedValue = None
|
---|
| 352 |
|
---|
| 353 | self._logState = lambda flight, logger, state, forced = False: \
|
---|
| 354 | StateChangeLogger.logState(self, flight, logger, state,
|
---|
| 355 | forced = forced)
|
---|
| 356 | self.logState = lambda flight, logger, state, forced = False: \
|
---|
| 357 | DelayedChangeMixin.logState(self, flight, logger, state,
|
---|
| 358 | forced = forced)
|
---|
[332] | 359 |
|
---|
[8] | 360 | def _changed(self, oldState, state):
|
---|
| 361 | """Determine if the value has changed."""
|
---|
| 362 | if self._oldValue is None:
|
---|
| 363 | self._oldValue = self._getValue(oldState)
|
---|
[332] | 364 |
|
---|
[8] | 365 | newValue = self._getValue(state)
|
---|
[321] | 366 | if self._isDifferent(self._oldValue, newValue):
|
---|
[355] | 367 | if self._lastLoggedValue is not None and \
|
---|
| 368 | not self._isDifferent(self._lastLoggedValue, newValue):
|
---|
| 369 | self._firstChange = None
|
---|
| 370 | else:
|
---|
| 371 | if self._firstChange is None:
|
---|
| 372 | self._firstChange = state.timestamp
|
---|
| 373 | self._lastChangeState = state
|
---|
[22] | 374 | self._oldValue = newValue
|
---|
| 375 |
|
---|
| 376 | if self._firstChange is not None:
|
---|
[324] | 377 | if state.timestamp >= min(self._lastChangeState.timestamp +
|
---|
| 378 | self._minDelay,
|
---|
[22] | 379 | self._firstChange + self._maxDelay):
|
---|
[8] | 380 | self._firstChange = None
|
---|
| 381 | return True
|
---|
[332] | 382 |
|
---|
[22] | 383 | return False
|
---|
[8] | 384 |
|
---|
[324] | 385 | def _getLogTimestamp(self, state, forced):
|
---|
[22] | 386 | """Get the log timestamp."""
|
---|
[324] | 387 | return self._lastChangeState.timestamp \
|
---|
| 388 | if not forced and self._lastChangeState is not None \
|
---|
| 389 | else state.timestamp
|
---|
[8] | 390 |
|
---|
[321] | 391 | def _isDifferent(self, oldValue, newValue):
|
---|
| 392 | """Determine if the given values are different.
|
---|
| 393 |
|
---|
| 394 | This default implementation checks for simple equality."""
|
---|
| 395 | return oldValue!=newValue
|
---|
| 396 |
|
---|
[355] | 397 | def logState(self, flight, logger, state, forced):
|
---|
| 398 | """Log the given state.
|
---|
| 399 |
|
---|
| 400 | The value belonging to that state is recorded in _lastLoggedValue.
|
---|
| 401 |
|
---|
| 402 | It calls _logState to perform the real logging."""
|
---|
| 403 | self._lastLoggedValue = self._getValue(state)
|
---|
| 404 | self._logState(flight, logger, state, forced = forced)
|
---|
| 405 |
|
---|
[8] | 406 | #---------------------------------------------------------------------------------------
|
---|
| 407 |
|
---|
| 408 | class TemplateMessageMixin(object):
|
---|
| 409 | """Mixin to generate a message based on a template.
|
---|
| 410 |
|
---|
| 411 | Child classes should define the following function:
|
---|
| 412 | - _getValue(state): get the value we are interested in."""
|
---|
| 413 | def __init__(self, template):
|
---|
| 414 | """Construct the mixin."""
|
---|
| 415 | self._template = template
|
---|
| 416 |
|
---|
[321] | 417 | def _getMessage(self, flight, state, forced):
|
---|
[8] | 418 | """Get the message."""
|
---|
[332] | 419 | value = self._getValue(state)
|
---|
[320] | 420 | return None if value is None else self._template % (value,)
|
---|
[8] | 421 |
|
---|
| 422 | #---------------------------------------------------------------------------------------
|
---|
| 423 |
|
---|
| 424 | class GenericStateChangeLogger(StateChangeLogger, SingleValueMixin,
|
---|
| 425 | DelayedChangeMixin, TemplateMessageMixin):
|
---|
| 426 | """Base for generic state change loggers that monitor a single value in the
|
---|
| 427 | state possibly with a delay and the logged message comes from a template"""
|
---|
[22] | 428 | def __init__(self, attrName, template, logInitial = True,
|
---|
[356] | 429 | excludedStages = None, minDelay = 0.0, maxDelay = 0.0):
|
---|
[8] | 430 | """Construct the object."""
|
---|
[358] | 431 | StateChangeLogger.__init__(self, logInitial = logInitial,
|
---|
| 432 | excludedStages = excludedStages)
|
---|
[8] | 433 | SingleValueMixin.__init__(self, attrName)
|
---|
[329] | 434 | DelayedChangeMixin.__init__(self, minDelay = minDelay,
|
---|
| 435 | maxDelay = maxDelay)
|
---|
[8] | 436 | TemplateMessageMixin.__init__(self, template)
|
---|
[324] | 437 | self._getLogTimestamp = \
|
---|
| 438 | lambda state, forced: \
|
---|
| 439 | DelayedChangeMixin._getLogTimestamp(self, state, forced)
|
---|
[8] | 440 |
|
---|
| 441 | #---------------------------------------------------------------------------------------
|
---|
| 442 |
|
---|
[321] | 443 | class ForceableLoggerMixin(object):
|
---|
[355] | 444 | """A mixin for loggers that can be forced to log a certain state."""
|
---|
[321] | 445 | def forceLog(self, flight, logger, state):
|
---|
| 446 | """Force logging the given state."""
|
---|
| 447 | self.logState(flight, logger, state, forced = True)
|
---|
| 448 |
|
---|
| 449 | #---------------------------------------------------------------------------------------
|
---|
| 450 |
|
---|
[8] | 451 | class AltimeterLogger(StateChangeLogger, SingleValueMixin,
|
---|
| 452 | DelayedChangeMixin):
|
---|
| 453 | """Logger for the altimeter setting."""
|
---|
| 454 | def __init__(self):
|
---|
| 455 | """Construct the logger."""
|
---|
| 456 | StateChangeLogger.__init__(self, logInitial = True)
|
---|
| 457 | SingleValueMixin.__init__(self, "altimeter")
|
---|
| 458 | DelayedChangeMixin.__init__(self)
|
---|
[324] | 459 | self._getLogTimestamp = \
|
---|
| 460 | lambda state, forced: \
|
---|
| 461 | DelayedChangeMixin._getLogTimestamp(self, state, forced)
|
---|
[8] | 462 |
|
---|
[321] | 463 | def _getMessage(self, flight, state, forced):
|
---|
[8] | 464 | """Get the message to log on a change."""
|
---|
[22] | 465 | logState = self._lastChangeState if \
|
---|
| 466 | self._lastChangeState is not None else state
|
---|
[409] | 467 | message = "Altimeter: %.2f hPa at %.0f feet" % \
|
---|
[394] | 468 | (logState.altimeter, logState.altitude)
|
---|
| 469 | if not logState.altimeterReliable:
|
---|
| 470 | message += " (u/r)"
|
---|
| 471 | return message
|
---|
[8] | 472 |
|
---|
| 473 | #---------------------------------------------------------------------------------------
|
---|
| 474 |
|
---|
[321] | 475 | class NAVLogger(StateChangeLogger, DelayedChangeMixin, ForceableLoggerMixin):
|
---|
[320] | 476 | """Logger for NAV radios.
|
---|
| 477 |
|
---|
[355] | 478 | It also logs the OBS radial set."""
|
---|
[356] | 479 | excludedStages = [const.STAGE_BOARDING, const.STAGE_PUSHANDTAXI,
|
---|
| 480 | const.STAGE_RTO, const.STAGE_TAXIAFTERLAND,
|
---|
| 481 | const.STAGE_PARKING]
|
---|
| 482 |
|
---|
[321] | 483 | @staticmethod
|
---|
| 484 | def getMessage(logName, frequency, obs):
|
---|
| 485 | """Get the message for the given NAV radio setting."""
|
---|
[389] | 486 | message = u"%-5s %s" % (logName + ":", frequency)
|
---|
[363] | 487 | if obs is not None: message += u" (%03d\u00b0)" % (obs,)
|
---|
[321] | 488 | return message
|
---|
[332] | 489 |
|
---|
[320] | 490 | def __init__(self, attrName, logName):
|
---|
| 491 | """Construct the NAV logger."""
|
---|
[356] | 492 | StateChangeLogger.__init__(self, logInitial = False,
|
---|
| 493 | excludedStages = self.excludedStages)
|
---|
[320] | 494 | DelayedChangeMixin.__init__(self)
|
---|
[321] | 495 |
|
---|
| 496 | self._getLogTimestamp = \
|
---|
[324] | 497 | lambda state, forced: \
|
---|
| 498 | DelayedChangeMixin._getLogTimestamp(self, state, forced)
|
---|
[320] | 499 |
|
---|
| 500 | self._attrName = attrName
|
---|
| 501 | self._logName = logName
|
---|
[321] | 502 |
|
---|
[320] | 503 | def _getValue(self, state):
|
---|
| 504 | """Get the value.
|
---|
| 505 |
|
---|
| 506 | If both the frequency and the obs settings are available, a tuple
|
---|
| 507 | containing them is returned, otherwise None."""
|
---|
| 508 | frequency = getattr(state, self._attrName)
|
---|
| 509 | obs = getattr(state, self._attrName + "_obs")
|
---|
[321] | 510 | manual = getattr(state, self._attrName + "_manual")
|
---|
| 511 | return (frequency, obs, manual)
|
---|
[320] | 512 |
|
---|
[321] | 513 | def _getMessage(self, flight, state, forced):
|
---|
[320] | 514 | """Get the message."""
|
---|
[321] | 515 | (frequency, obs, manual) = self._getValue(state)
|
---|
| 516 | return None if frequency is None or obs is None or \
|
---|
| 517 | (not manual and not forced) else \
|
---|
| 518 | self.getMessage(self._logName, frequency, obs)
|
---|
| 519 |
|
---|
| 520 | def _isDifferent(self, oldValue, newValue):
|
---|
| 521 | """Determine if the valie has changed between the given states."""
|
---|
| 522 | (oldFrequency, oldOBS, _oldManual) = oldValue
|
---|
| 523 | (newFrequency, newOBS, _newManual) = newValue
|
---|
| 524 | return oldFrequency!=newFrequency or oldOBS!=newOBS
|
---|
[320] | 525 |
|
---|
| 526 | #---------------------------------------------------------------------------------------
|
---|
| 527 |
|
---|
[366] | 528 | class ILSLogger(NAVLogger):
|
---|
| 529 | """Logger for the ILS radio setting."""
|
---|
| 530 | def __init__(self):
|
---|
| 531 | """Construct the logger."""
|
---|
| 532 | super(ILSLogger, self).__init__("ils", "ILS")
|
---|
| 533 |
|
---|
| 534 | #---------------------------------------------------------------------------------------
|
---|
| 535 |
|
---|
[320] | 536 | class NAV1Logger(NAVLogger):
|
---|
[8] | 537 | """Logger for the NAV1 radio setting."""
|
---|
| 538 | def __init__(self):
|
---|
| 539 | """Construct the logger."""
|
---|
[320] | 540 | super(NAV1Logger, self).__init__("nav1", "NAV1")
|
---|
[8] | 541 |
|
---|
| 542 | #---------------------------------------------------------------------------------------
|
---|
| 543 |
|
---|
[320] | 544 | class NAV2Logger(NAVLogger):
|
---|
[8] | 545 | """Logger for the NAV2 radio setting."""
|
---|
| 546 | def __init__(self):
|
---|
| 547 | """Construct the logger."""
|
---|
[320] | 548 | super(NAV2Logger, self).__init__("nav2", "NAV2")
|
---|
[8] | 549 |
|
---|
| 550 | #---------------------------------------------------------------------------------------
|
---|
| 551 |
|
---|
[321] | 552 | class ADFLogger(GenericStateChangeLogger, ForceableLoggerMixin):
|
---|
| 553 | """Base class for the ADF loggers."""
|
---|
| 554 | def __init__(self, attr, logName):
|
---|
| 555 | """Construct the ADF logger."""
|
---|
| 556 | GenericStateChangeLogger.__init__(self, attr,
|
---|
[333] | 557 | "%s: %%s" % (logName,),
|
---|
[356] | 558 | logInitial = False,
|
---|
| 559 | excludedStages =
|
---|
| 560 | NAVLogger.excludedStages,
|
---|
[321] | 561 | minDelay = 3.0, maxDelay = 10.0)
|
---|
| 562 |
|
---|
| 563 | #---------------------------------------------------------------------------------------
|
---|
| 564 |
|
---|
| 565 | class ADF1Logger(ADFLogger):
|
---|
[317] | 566 | """Logger for the ADF1 radio setting."""
|
---|
| 567 | def __init__(self):
|
---|
| 568 | """Construct the logger."""
|
---|
[321] | 569 | super(ADF1Logger, self).__init__("adf1", "ADF1")
|
---|
[317] | 570 |
|
---|
| 571 | #---------------------------------------------------------------------------------------
|
---|
| 572 |
|
---|
[321] | 573 | class ADF2Logger(ADFLogger):
|
---|
[317] | 574 | """Logger for the ADF2 radio setting."""
|
---|
| 575 | def __init__(self):
|
---|
| 576 | """Construct the logger."""
|
---|
[321] | 577 | super(ADF2Logger, self).__init__("adf2", "ADF2")
|
---|
[317] | 578 |
|
---|
| 579 | #---------------------------------------------------------------------------------------
|
---|
| 580 |
|
---|
[8] | 581 | class SquawkLogger(GenericStateChangeLogger):
|
---|
| 582 | """Logger for the squawk setting."""
|
---|
| 583 | def __init__(self):
|
---|
| 584 | """Construct the logger."""
|
---|
| 585 | super(SquawkLogger, self).__init__("squawk", "Squawk code: %s",
|
---|
[22] | 586 | minDelay = 3.0, maxDelay = 10.0)
|
---|
[8] | 587 |
|
---|
| 588 | #---------------------------------------------------------------------------------------
|
---|
| 589 |
|
---|
| 590 | class LightsLogger(StateChangeLogger, SingleValueMixin, SimpleChangeMixin):
|
---|
| 591 | """Base class for the loggers of the various lights."""
|
---|
| 592 | def __init__(self, attrName, template):
|
---|
| 593 | """Construct the logger."""
|
---|
| 594 | StateChangeLogger.__init__(self)
|
---|
| 595 | SingleValueMixin.__init__(self, attrName)
|
---|
[332] | 596 |
|
---|
[8] | 597 | self._template = template
|
---|
| 598 |
|
---|
[321] | 599 | def _getMessage(self, flight, state, forced):
|
---|
[8] | 600 | """Get the message from the given state."""
|
---|
| 601 | return self._template % ("ON" if self._getValue(state) else "OFF")
|
---|
[332] | 602 |
|
---|
[8] | 603 | #---------------------------------------------------------------------------------------
|
---|
| 604 |
|
---|
| 605 | class AnticollisionLightsLogger(LightsLogger):
|
---|
| 606 | """Logger for the anti-collision lights."""
|
---|
| 607 | def __init__(self):
|
---|
| 608 | LightsLogger.__init__(self, "antiCollisionLightsOn",
|
---|
| 609 | "Anti-collision lights: %s")
|
---|
| 610 |
|
---|
| 611 | #---------------------------------------------------------------------------------------
|
---|
| 612 |
|
---|
| 613 | class LandingLightsLogger(LightsLogger):
|
---|
| 614 | """Logger for the landing lights."""
|
---|
| 615 | def __init__(self):
|
---|
| 616 | LightsLogger.__init__(self, "landingLightsOn",
|
---|
| 617 | "Landing lights: %s")
|
---|
| 618 |
|
---|
| 619 | #---------------------------------------------------------------------------------------
|
---|
| 620 |
|
---|
| 621 | class StrobeLightsLogger(LightsLogger):
|
---|
| 622 | """Logger for the strobe lights."""
|
---|
| 623 | def __init__(self):
|
---|
| 624 | LightsLogger.__init__(self, "strobeLightsOn",
|
---|
| 625 | "Strobe lights: %s")
|
---|
| 626 |
|
---|
| 627 | #---------------------------------------------------------------------------------------
|
---|
| 628 |
|
---|
| 629 | class NavLightsLogger(LightsLogger):
|
---|
| 630 | """Logger for the navigational lights."""
|
---|
| 631 | def __init__(self):
|
---|
| 632 | LightsLogger.__init__(self, "navLightsOn",
|
---|
| 633 | "Navigational lights: %s")
|
---|
| 634 |
|
---|
| 635 | #---------------------------------------------------------------------------------------
|
---|
| 636 |
|
---|
| 637 | class FlapsLogger(StateChangeLogger, SingleValueMixin, SimpleChangeMixin):
|
---|
| 638 | """Logger for the flaps setting."""
|
---|
| 639 | def __init__(self):
|
---|
| 640 | """Construct the logger."""
|
---|
[364] | 641 | StateChangeLogger.__init__(self, logInitial = True,
|
---|
| 642 | excludedStages =
|
---|
| 643 | [const.STAGE_BOARDING,
|
---|
| 644 | const.STAGE_PUSHANDTAXI,
|
---|
| 645 | const.STAGE_RTO,
|
---|
| 646 | const.STAGE_TAKEOFF])
|
---|
[8] | 647 | SingleValueMixin.__init__(self, "flapsSet")
|
---|
| 648 |
|
---|
[321] | 649 | def _getMessage(self, flight, state, forced):
|
---|
[8] | 650 | """Get the message to log on a change."""
|
---|
| 651 | speed = state.groundSpeed if state.groundSpeed<80.0 else state.ias
|
---|
[333] | 652 | return "Flaps %.0f - %.0f %s" % \
|
---|
[241] | 653 | (state.flapsSet, flight.speedFromKnots(speed),
|
---|
| 654 | flight.getEnglishSpeedUnit())
|
---|
[8] | 655 |
|
---|
| 656 | #---------------------------------------------------------------------------------------
|
---|
| 657 |
|
---|
| 658 | class GearsLogger(StateChangeLogger, SingleValueMixin, SimpleChangeMixin):
|
---|
| 659 | """Logger for the gears state."""
|
---|
| 660 | def __init__(self):
|
---|
| 661 | """Construct the logger."""
|
---|
| 662 | StateChangeLogger.__init__(self, logInitial = True)
|
---|
[209] | 663 | SingleValueMixin.__init__(self, "gearControlDown")
|
---|
[8] | 664 |
|
---|
[321] | 665 | def _getMessage(self, flight, state, forced):
|
---|
[8] | 666 | """Get the message to log on a change."""
|
---|
[241] | 667 | return "Gears SET to %s at %.0f %s, %.0f feet" % \
|
---|
[209] | 668 | ("DOWN" if state.gearControlDown else "UP",
|
---|
[241] | 669 | flight.speedFromKnots(state.ias),
|
---|
| 670 | flight.getEnglishSpeedUnit(), state.altitude)
|
---|
[8] | 671 |
|
---|
| 672 | #---------------------------------------------------------------------------------------
|
---|
[11] | 673 |
|
---|
[338] | 674 | class APLogger(StateChangeLogger, DelayedChangeMixin):
|
---|
| 675 | """Log the state of the autopilot."""
|
---|
| 676 | @staticmethod
|
---|
| 677 | def _logBoolean(logger, timestamp, what, value):
|
---|
| 678 | """Log a boolean value.
|
---|
| 679 |
|
---|
| 680 | what is the name of the value that is being logged."""
|
---|
| 681 | message = what + " "
|
---|
| 682 | if value is None:
|
---|
| 683 | message += "cannot be detected, will not log"
|
---|
| 684 | else:
|
---|
| 685 | message += "is " + ("ON" if value else "OFF")
|
---|
| 686 | logger.message(timestamp, message)
|
---|
| 687 |
|
---|
| 688 | @staticmethod
|
---|
| 689 | def _logNumeric(logger, timestamp, what, format, value):
|
---|
| 690 | """Log a numerical value."""
|
---|
| 691 | message = what
|
---|
| 692 | if value is None:
|
---|
| 693 | message += u" cannot be detected, will not log"
|
---|
| 694 | else:
|
---|
| 695 | message += u": " + format % (value,)
|
---|
| 696 | logger.message(timestamp, message)
|
---|
| 697 |
|
---|
| 698 | @staticmethod
|
---|
| 699 | def _logAPMaster(logger, timestamp, state):
|
---|
| 700 | """Log the AP master state."""
|
---|
| 701 | APLogger._logBoolean(logger, timestamp, "AP master",
|
---|
| 702 | state.apMaster)
|
---|
| 703 |
|
---|
| 704 | @staticmethod
|
---|
| 705 | def _logAPHeadingHold(logger, timestamp, state):
|
---|
| 706 | """Log the AP heading hold state."""
|
---|
| 707 | APLogger._logBoolean(logger, timestamp, "AP heading hold",
|
---|
| 708 | state.apHeadingHold)
|
---|
| 709 |
|
---|
| 710 | @staticmethod
|
---|
| 711 | def _logAPHeading(logger, timestamp, state):
|
---|
| 712 | """Log the AP heading."""
|
---|
| 713 | APLogger._logNumeric(logger, timestamp, u"AP heading",
|
---|
| 714 | u"%03.0f\u00b0", state.apHeading)
|
---|
| 715 |
|
---|
| 716 | @staticmethod
|
---|
| 717 | def _logAPAltitudeHold(logger, timestamp, state):
|
---|
| 718 | """Log the AP altitude hold state."""
|
---|
| 719 | APLogger._logBoolean(logger, timestamp, "AP altitude hold",
|
---|
| 720 | state.apAltitudeHold)
|
---|
| 721 |
|
---|
| 722 | @staticmethod
|
---|
| 723 | def _logAPAltitude(logger, timestamp, state):
|
---|
| 724 | """Log the AP heading."""
|
---|
| 725 | APLogger._logNumeric(logger, timestamp, u"AP altitude",
|
---|
| 726 | u"%.0f ft", state.apAltitude)
|
---|
| 727 |
|
---|
| 728 | def __init__(self):
|
---|
| 729 | """Construct the state logger."""
|
---|
| 730 | StateChangeLogger.__init__(self)
|
---|
| 731 | DelayedChangeMixin.__init__(self)
|
---|
| 732 | self._lastLoggedState = None
|
---|
[355] | 733 | self.logState = lambda flight, logger, state:\
|
---|
| 734 | APLogger.logState(self, flight, logger, state)
|
---|
[338] | 735 |
|
---|
| 736 | def _getValue(self, state):
|
---|
| 737 | """Convert the relevant values from the given state into a tuple."""
|
---|
| 738 | return (state.apMaster,
|
---|
| 739 | state.apHeadingHold, state.apHeading,
|
---|
| 740 | state.apAltitudeHold, state.apAltitude)
|
---|
| 741 |
|
---|
| 742 | def _isDifferent(self, oldValue, newValue):
|
---|
| 743 | """Determine if the given old and new values are different (enough) to
|
---|
| 744 | be logged."""
|
---|
| 745 | (oldAPMaster, oldAPHeadingHold, oldAPHeading,
|
---|
| 746 | oldAPAltitudeHold, oldAPAltitude) = oldValue
|
---|
| 747 | (apMaster, apHeadingHold, apHeading,
|
---|
| 748 | apAltitudeHold, apAltitude) = newValue
|
---|
| 749 |
|
---|
| 750 | if apMaster is not None and apMaster!=oldAPMaster:
|
---|
| 751 | return True
|
---|
| 752 | if apMaster is False:
|
---|
| 753 | return False
|
---|
| 754 |
|
---|
| 755 | if apHeadingHold is not None and apHeadingHold!=oldAPHeadingHold:
|
---|
| 756 | return True
|
---|
| 757 | if apHeadingHold is not False and apHeading is not None and \
|
---|
| 758 | apHeading!=oldAPHeading:
|
---|
| 759 | return True
|
---|
| 760 |
|
---|
| 761 | if apAltitudeHold is not None and apAltitudeHold!=oldAPAltitudeHold:
|
---|
| 762 | return True
|
---|
| 763 | if apAltitudeHold is not False and apAltitude is not None and \
|
---|
| 764 | apAltitude!=oldAPAltitude:
|
---|
| 765 | return True
|
---|
| 766 |
|
---|
| 767 | return False
|
---|
| 768 |
|
---|
| 769 | def logState(self, flight, logger, state):
|
---|
| 770 | """Log the autopilot state."""
|
---|
| 771 | timestamp = DelayedChangeMixin._getLogTimestamp(self, state, False)
|
---|
| 772 | if self._lastLoggedState is None:
|
---|
| 773 | self._logAPMaster(logger, timestamp, state)
|
---|
| 774 | if state.apMaster is not False or state.apHeadingHold is None:
|
---|
| 775 | self._logAPHeadingHold(logger, timestamp, state)
|
---|
| 776 | if state.apMaster is not False and \
|
---|
| 777 | (state.apHeadingHold is not False or state.apHeading is None):
|
---|
| 778 | self._logAPHeading(logger, timestamp, state)
|
---|
| 779 | if state.apMaster is not False or state.apAltitudeHold is None:
|
---|
| 780 | self._logAPAltitudeHold(logger, timestamp, state)
|
---|
| 781 | if state.apMaster is not False and \
|
---|
| 782 | (state.apAltitudeHold is not False or state.apAltitude is None):
|
---|
| 783 | self._logAPAltitude(logger, timestamp, state)
|
---|
| 784 | self._firstCall = False
|
---|
| 785 | else:
|
---|
| 786 | oldState = self._lastLoggedState
|
---|
| 787 |
|
---|
| 788 | apMasterTurnedOn = False
|
---|
| 789 | if state.apMaster is not None and state.apMaster!=oldState.apMaster:
|
---|
| 790 | apMasterTurnedOn = state.apMaster
|
---|
| 791 | self._logAPMaster(logger, timestamp, state)
|
---|
| 792 |
|
---|
| 793 | if state.apMaster is not False:
|
---|
| 794 | apHeadingHoldTurnedOn = False
|
---|
| 795 | if state.apHeadingHold is not None and \
|
---|
| 796 | (state.apHeadingHold!=oldState.apHeadingHold or
|
---|
| 797 | apMasterTurnedOn):
|
---|
| 798 | apHeadingHoldTurnedOn = state.apHeadingHold
|
---|
| 799 | self._logAPHeadingHold(logger, timestamp, state)
|
---|
| 800 |
|
---|
| 801 | if state.apHeadingHold is not False and \
|
---|
| 802 | state.apHeading is not None and \
|
---|
| 803 | (state.apHeading!=oldState.apHeading or apMasterTurnedOn or
|
---|
| 804 | apHeadingHoldTurnedOn):
|
---|
| 805 | self._logAPHeading(logger, timestamp, state)
|
---|
| 806 |
|
---|
| 807 | apAltitudeHoldTurnedOn = False
|
---|
| 808 | if state.apAltitudeHold is not None and \
|
---|
| 809 | (state.apAltitudeHold!=oldState.apAltitudeHold or
|
---|
| 810 | apMasterTurnedOn):
|
---|
| 811 | apAltitudeHoldTurnedOn = state.apAltitudeHold
|
---|
| 812 | self._logAPAltitudeHold(logger, timestamp, state)
|
---|
| 813 |
|
---|
| 814 | if state.apAltitudeHold is not False and \
|
---|
| 815 | state.apAltitude is not None and \
|
---|
| 816 | (state.apAltitude!=oldState.apAltitude or apMasterTurnedOn or
|
---|
| 817 | apAltitudeHoldTurnedOn):
|
---|
| 818 | self._logAPAltitude(logger, timestamp, state)
|
---|
| 819 |
|
---|
| 820 | self._lastLoggedState = state
|
---|
| 821 |
|
---|
| 822 | #---------------------------------------------------------------------------------------
|
---|
| 823 |
|
---|
[11] | 824 | class FaultChecker(StateChecker):
|
---|
| 825 | """Base class for checkers that look for faults."""
|
---|
| 826 | @staticmethod
|
---|
| 827 | def _appendDuring(flight, message):
|
---|
| 828 | """Append a 'during XXX' test to the given message, depending on the
|
---|
| 829 | flight stage."""
|
---|
| 830 | stageStr = const.stage2string(flight.stage)
|
---|
| 831 | return message if stageStr is None \
|
---|
| 832 | else (message + " during " + stageStr.upper())
|
---|
| 833 |
|
---|
| 834 | @staticmethod
|
---|
| 835 | def _getLinearScore(minFaultValue, maxFaultValue, minScore, maxScore,
|
---|
| 836 | value):
|
---|
| 837 | """Get the score for a faulty value where the score is calculated
|
---|
| 838 | linearly within a certain range."""
|
---|
| 839 | if value<minFaultValue:
|
---|
| 840 | return 0
|
---|
| 841 | elif value>maxFaultValue:
|
---|
| 842 | return maxScore
|
---|
| 843 | else:
|
---|
| 844 | return minScore + (maxScore-minScore) * (value-minFaultValue) / \
|
---|
| 845 | (maxFaultValue - minFaultValue)
|
---|
| 846 |
|
---|
| 847 | #---------------------------------------------------------------------------------------
|
---|
| 848 |
|
---|
| 849 | class SimpleFaultChecker(FaultChecker):
|
---|
| 850 | """Base class for fault checkers that check for a single occurence of a
|
---|
| 851 | faulty condition.
|
---|
| 852 |
|
---|
| 853 | Child classes should implement the following functions:
|
---|
| 854 | - isCondition(self, flight, aircraft, oldState, state): should return whether the
|
---|
| 855 | condition holds
|
---|
| 856 | - logFault(self, flight, aircraft, logger, oldState, state): log the fault
|
---|
| 857 | via the logger."""
|
---|
| 858 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 859 | """Perform the check."""
|
---|
| 860 | if self.isCondition(flight, aircraft, oldState, state):
|
---|
| 861 | self.logFault(flight, aircraft, logger, oldState, state)
|
---|
| 862 |
|
---|
| 863 | #---------------------------------------------------------------------------------------
|
---|
| 864 |
|
---|
| 865 | class PatientFaultChecker(FaultChecker):
|
---|
| 866 | """A fault checker that does not decides on a fault when the condition
|
---|
| 867 | arises immediately, but can wait some time.
|
---|
| 868 |
|
---|
| 869 | Child classes should implement the following functions:
|
---|
| 870 | - isCondition(self, flight, aircraft, oldState, state): should return whether the
|
---|
| 871 | condition holds
|
---|
| 872 | - logFault(self, flight, aircraft, logger, oldState, state): log the fault
|
---|
| 873 | via the logger
|
---|
| 874 | """
|
---|
| 875 | def __init__(self, timeout = 2.0):
|
---|
| 876 | """Construct the fault checker with the given timeout."""
|
---|
| 877 | self._timeout = timeout
|
---|
| 878 | self._faultStarted = None
|
---|
| 879 |
|
---|
| 880 | def getTimeout(self, flight, aircraft, oldState, state):
|
---|
| 881 | """Get the timeout.
|
---|
| 882 |
|
---|
| 883 | This default implementation returns the timeout given in the
|
---|
| 884 | constructor, but child classes might want to enforce a different
|
---|
| 885 | policy."""
|
---|
| 886 | return self._timeout
|
---|
| 887 |
|
---|
| 888 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 889 | """Perform the check."""
|
---|
| 890 | if self.isCondition(flight, aircraft, oldState, state):
|
---|
| 891 | if self._faultStarted is None:
|
---|
| 892 | self._faultStarted = state.timestamp
|
---|
| 893 | timeout = self.getTimeout(flight, aircraft, oldState, state)
|
---|
| 894 | if state.timestamp>=(self._faultStarted + timeout):
|
---|
| 895 | self.logFault(flight, aircraft, logger, oldState, state)
|
---|
| 896 | self._faultStarted = state.timestamp
|
---|
| 897 | else:
|
---|
| 898 | self._faultStarted = None
|
---|
[332] | 899 |
|
---|
[11] | 900 | #---------------------------------------------------------------------------------------
|
---|
| 901 |
|
---|
| 902 | class AntiCollisionLightsChecker(PatientFaultChecker):
|
---|
| 903 | """Check for the anti-collision light being off at high N1 values."""
|
---|
| 904 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 905 | """Check if the fault condition holds."""
|
---|
| 906 | return (flight.stage!=const.STAGE_PARKING or \
|
---|
[183] | 907 | not flight.config.usingFS2Crew) and \
|
---|
[11] | 908 | not state.antiCollisionLightsOn and \
|
---|
[211] | 909 | self.isEngineCondition(state)
|
---|
[11] | 910 |
|
---|
| 911 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 912 | """Log the fault."""
|
---|
[30] | 913 | flight.handleFault(AntiCollisionLightsChecker, state.timestamp,
|
---|
| 914 | FaultChecker._appendDuring(flight,
|
---|
| 915 | "Anti-collision lights were off"),
|
---|
| 916 | 1)
|
---|
[11] | 917 |
|
---|
[211] | 918 | def isEngineCondition(self, state):
|
---|
| 919 | """Determine if the engines are in such a state that the lights should
|
---|
| 920 | be on."""
|
---|
[263] | 921 | if state.n1 is not None:
|
---|
| 922 | return max(state.n1)>5
|
---|
| 923 | elif state.rpm is not None:
|
---|
| 924 | return max(state.rpm)>0
|
---|
| 925 | else:
|
---|
| 926 | return False
|
---|
[211] | 927 |
|
---|
| 928 | #---------------------------------------------------------------------------------------
|
---|
| 929 |
|
---|
| 930 | class TupolevAntiCollisionLightsChecker(AntiCollisionLightsChecker):
|
---|
| 931 | """Check for the anti-collision light for Tuplev planes."""
|
---|
[307] | 932 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
[332] | 933 | """Check if the fault condition holds."""
|
---|
[307] | 934 | numEnginesRunning = 0
|
---|
| 935 | for n1 in state.n1:
|
---|
| 936 | if n1>5: numEnginesRunning += 1
|
---|
[332] | 937 |
|
---|
[307] | 938 | if flight.stage==const.STAGE_PARKING:
|
---|
| 939 | return numEnginesRunning<len(state.n1) \
|
---|
| 940 | and state.antiCollisionLightsOn
|
---|
| 941 | else:
|
---|
| 942 | return numEnginesRunning>1 and not state.antiCollisionLightsOn or \
|
---|
| 943 | numEnginesRunning<1 and state.antiCollisionLightsOn
|
---|
[211] | 944 |
|
---|
[11] | 945 | #---------------------------------------------------------------------------------------
|
---|
| 946 |
|
---|
| 947 | class BankChecker(SimpleFaultChecker):
|
---|
[263] | 948 | """Check for the bank is within limits."""
|
---|
[11] | 949 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 950 | """Check if the fault condition holds."""
|
---|
| 951 | if flight.stage==const.STAGE_CRUISE:
|
---|
| 952 | bankLimit = 30
|
---|
| 953 | elif flight.stage in [const.STAGE_TAKEOFF, const.STAGE_CLIMB,
|
---|
| 954 | const.STAGE_DESCENT, const.STAGE_LANDING]:
|
---|
| 955 | bankLimit = 35
|
---|
| 956 | else:
|
---|
| 957 | return False
|
---|
| 958 |
|
---|
| 959 | return state.bank>bankLimit or state.bank<-bankLimit
|
---|
| 960 |
|
---|
| 961 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 962 | """Log the fault."""
|
---|
[30] | 963 | flight.handleFault(BankChecker, state.timestamp,
|
---|
| 964 | FaultChecker._appendDuring(flight, "Bank too steep"),
|
---|
| 965 | 2)
|
---|
[11] | 966 |
|
---|
| 967 | #---------------------------------------------------------------------------------------
|
---|
| 968 |
|
---|
| 969 | class FlapsRetractChecker(SimpleFaultChecker):
|
---|
| 970 | """Check if the flaps are not retracted too early."""
|
---|
[13] | 971 | def __init__(self):
|
---|
| 972 | """Construct the flaps checker."""
|
---|
| 973 | self._timeStart = None
|
---|
[332] | 974 |
|
---|
[11] | 975 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 976 | """Check if the fault condition holds.
|
---|
| 977 |
|
---|
| 978 | FIXME: check if this really is the intention (FlapsRetractedMistake.java)"""
|
---|
[357] | 979 | if (flight.stage==const.STAGE_TAKEOFF and not state.onTheGround and
|
---|
| 980 | aircraft.type!=const.AIRCRAFT_F70) or \
|
---|
[11] | 981 | (flight.stage==const.STAGE_LANDING and state.onTheGround):
|
---|
| 982 | if self._timeStart is None:
|
---|
| 983 | self._timeStart = state.timestamp
|
---|
| 984 |
|
---|
| 985 | if state.flapsSet==0 and state.timestamp<=(self._timeStart+2.0):
|
---|
| 986 | return True
|
---|
[13] | 987 | else:
|
---|
| 988 | self._timeStart = None
|
---|
[11] | 989 | return False
|
---|
| 990 |
|
---|
| 991 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 992 | """Log the fault."""
|
---|
[30] | 993 | flight.handleFault(FlapsRetractChecker, state.timestamp,
|
---|
| 994 | FaultChecker._appendDuring(flight, "Flaps retracted"),
|
---|
| 995 | 20)
|
---|
[11] | 996 |
|
---|
| 997 | #---------------------------------------------------------------------------------------
|
---|
| 998 |
|
---|
| 999 | class FlapsSpeedLimitChecker(SimpleFaultChecker):
|
---|
| 1000 | """Check if the flaps are extended only at the right speeds."""
|
---|
| 1001 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1002 | """Check if the fault condition holds."""
|
---|
| 1003 | speedLimit = aircraft.getFlapsSpeedLimit(state.flapsSet)
|
---|
[197] | 1004 | return speedLimit is not None and state.smoothedIAS>speedLimit
|
---|
[11] | 1005 |
|
---|
| 1006 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1007 | """Log the fault."""
|
---|
[30] | 1008 | flight.handleFault(FlapsSpeedLimitChecker, state.timestamp,
|
---|
| 1009 | FaultChecker._appendDuring(flight, "Flap speed limit fault"),
|
---|
| 1010 | 5)
|
---|
[11] | 1011 |
|
---|
| 1012 | #---------------------------------------------------------------------------------------
|
---|
| 1013 |
|
---|
| 1014 | class GearsDownChecker(SimpleFaultChecker):
|
---|
| 1015 | """Check if the gears are down at low altitudes."""
|
---|
| 1016 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1017 | """Check if the fault condition holds."""
|
---|
| 1018 | return state.radioAltitude<10 and not state.gearsDown and \
|
---|
| 1019 | flight.stage!=const.STAGE_TAKEOFF
|
---|
| 1020 |
|
---|
| 1021 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1022 | """Log the fault."""
|
---|
[30] | 1023 | flight.handleNoGo(GearsDownChecker, state.timestamp,
|
---|
| 1024 | "Gears not down at %.0f feet radio altitude" % \
|
---|
| 1025 | (state.radioAltitude,),
|
---|
| 1026 | "GEAR DOWN NO GO")
|
---|
[11] | 1027 |
|
---|
| 1028 | #---------------------------------------------------------------------------------------
|
---|
| 1029 |
|
---|
| 1030 | class GearSpeedLimitChecker(PatientFaultChecker):
|
---|
| 1031 | """Check if the gears not down at too high a speed."""
|
---|
| 1032 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1033 | """Check if the fault condition holds."""
|
---|
[197] | 1034 | return state.gearsDown and state.smoothedIAS>aircraft.gearSpeedLimit
|
---|
[11] | 1035 |
|
---|
| 1036 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1037 | """Log the fault."""
|
---|
[30] | 1038 | flight.handleFault(GearSpeedLimitChecker, state.timestamp,
|
---|
| 1039 | FaultChecker._appendDuring(flight, "Gear speed limit fault"),
|
---|
| 1040 | 5)
|
---|
[11] | 1041 |
|
---|
| 1042 | #---------------------------------------------------------------------------------------
|
---|
| 1043 |
|
---|
| 1044 | class GLoadChecker(SimpleFaultChecker):
|
---|
| 1045 | """Check if the G-load does not exceed 2 except during flare."""
|
---|
| 1046 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1047 | """Check if the fault condition holds."""
|
---|
| 1048 | return state.gLoad>2.0 and (flight.stage!=const.STAGE_LANDING or \
|
---|
| 1049 | state.radioAltitude>=50)
|
---|
[332] | 1050 |
|
---|
[11] | 1051 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1052 | """Log the fault."""
|
---|
[30] | 1053 | flight.handleFault(GLoadChecker, state.timestamp,
|
---|
| 1054 | "G-load was %.2f" % (state.gLoad,),
|
---|
| 1055 | 10)
|
---|
[11] | 1056 |
|
---|
| 1057 | #---------------------------------------------------------------------------------------
|
---|
| 1058 |
|
---|
| 1059 | class LandingLightsChecker(PatientFaultChecker):
|
---|
| 1060 | """Check if the landing lights are used properly."""
|
---|
| 1061 | def getTimeout(self, flight, aircraft, oldState, state):
|
---|
| 1062 | """Get the timeout.
|
---|
| 1063 |
|
---|
| 1064 | It is the default timeout except for landing and takeoff."""
|
---|
| 1065 | return 0.0 if flight.stage in [const.STAGE_TAKEOFF,
|
---|
| 1066 | const.STAGE_LANDING] else self._timeout
|
---|
| 1067 |
|
---|
| 1068 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1069 | """Check if the fault condition holds."""
|
---|
[314] | 1070 | return state.landingLightsOn is not None and \
|
---|
| 1071 | ((flight.stage==const.STAGE_BOARDING and \
|
---|
| 1072 | state.landingLightsOn and state.onTheGround) or \
|
---|
| 1073 | (flight.stage==const.STAGE_TAKEOFF and \
|
---|
| 1074 | not state.landingLightsOn and not state.onTheGround) or \
|
---|
| 1075 | (flight.stage in [const.STAGE_CLIMB, const.STAGE_CRUISE,
|
---|
| 1076 | const.STAGE_DESCENT] and \
|
---|
| 1077 | state.landingLightsOn and state.altitude>12500) or \
|
---|
| 1078 | (flight.stage==const.STAGE_LANDING and \
|
---|
[397] | 1079 | not state.landingLightsOn and not state.onTheGround) or \
|
---|
[314] | 1080 | (flight.stage==const.STAGE_PARKING and \
|
---|
| 1081 | state.landingLightsOn and state.onTheGround))
|
---|
[332] | 1082 |
|
---|
[11] | 1083 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1084 | """Log the fault."""
|
---|
[375] | 1085 | score = 0 if flight.stage in [const.STAGE_TAKEOFF,
|
---|
| 1086 | const.STAGE_LANDING] else 1
|
---|
[335] | 1087 | message = "Landing lights were %s" % \
|
---|
| 1088 | (("on" if state.landingLightsOn else "off"),)
|
---|
[30] | 1089 | flight.handleFault(LandingLightsChecker, state.timestamp,
|
---|
| 1090 | FaultChecker._appendDuring(flight, message),
|
---|
[332] | 1091 | score)
|
---|
[11] | 1092 |
|
---|
| 1093 | #---------------------------------------------------------------------------------------
|
---|
| 1094 |
|
---|
[335] | 1095 | class TransponderChecker(PatientFaultChecker):
|
---|
| 1096 | """Check if the transponder is used properly."""
|
---|
[361] | 1097 | def __init__(self):
|
---|
| 1098 | """Construct the transponder checker."""
|
---|
| 1099 | super(TransponderChecker, self).__init__()
|
---|
| 1100 | self._liftOffTime = None
|
---|
| 1101 |
|
---|
[335] | 1102 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1103 | """Check if the fault condition holds."""
|
---|
[361] | 1104 | if state.onTheGround:
|
---|
| 1105 | self._liftOffTime = None
|
---|
| 1106 | elif self._liftOffTime is None:
|
---|
| 1107 | self._liftOffTime = state.timestamp
|
---|
| 1108 |
|
---|
[335] | 1109 | return state.xpdrC is not None and \
|
---|
| 1110 | ((state.xpdrC and flight.stage in
|
---|
| 1111 | [const.STAGE_BOARDING, const.STAGE_PARKING]) or \
|
---|
[361] | 1112 | (not state.xpdrC and
|
---|
| 1113 | (flight.stage in
|
---|
| 1114 | [const.STAGE_CRUISE, const.STAGE_DESCENT,
|
---|
| 1115 | const.STAGE_LANDING, const.STAGE_GOAROUND] or \
|
---|
| 1116 | ((not state.autoXPDR or \
|
---|
| 1117 | (self._liftOffTime is not None and
|
---|
| 1118 | state.timestamp > (self._liftOffTime+8))) and \
|
---|
| 1119 | flight.stage in
|
---|
| 1120 | [const.STAGE_TAKEOFF, const.STAGE_RTO, const.STAGE_CLIMB])
|
---|
| 1121 | )
|
---|
| 1122 | )
|
---|
| 1123 | )
|
---|
[335] | 1124 |
|
---|
| 1125 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1126 | """Log the fault."""
|
---|
| 1127 | score = 0
|
---|
| 1128 | message = "Transponder was %s" % \
|
---|
| 1129 | (("mode C" if state.xpdrC else "standby"),)
|
---|
| 1130 | flight.handleFault(TransponderChecker, state.timestamp,
|
---|
| 1131 | FaultChecker._appendDuring(flight, message),
|
---|
| 1132 | score)
|
---|
| 1133 |
|
---|
| 1134 | #---------------------------------------------------------------------------------------
|
---|
| 1135 |
|
---|
[11] | 1136 | class WeightChecker(PatientFaultChecker):
|
---|
| 1137 | """Base class for checkers that check that some limit is not exceeded."""
|
---|
| 1138 | def __init__(self, name):
|
---|
| 1139 | """Construct the checker."""
|
---|
| 1140 | super(WeightChecker, self).__init__(timeout = 5.0)
|
---|
| 1141 | self._name = name
|
---|
| 1142 |
|
---|
| 1143 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1144 | """Check if the fault condition holds."""
|
---|
| 1145 | if flight.entranceExam:
|
---|
| 1146 | return False
|
---|
| 1147 |
|
---|
| 1148 | limit = self.getLimit(flight, aircraft, state)
|
---|
| 1149 | if limit is not None:
|
---|
[183] | 1150 | #if flight.options.compensation is not None:
|
---|
| 1151 | # limit += flight.options.compensation
|
---|
[13] | 1152 | return self.getWeight(state)>limit
|
---|
[11] | 1153 |
|
---|
| 1154 | return False
|
---|
| 1155 |
|
---|
| 1156 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1157 | """Log the fault."""
|
---|
[13] | 1158 | mname = "M" + self._name
|
---|
[30] | 1159 | flight.handleNoGo(self.__class__, state.timestamp,
|
---|
| 1160 | "%s exceeded: %s is %.0f kg" % \
|
---|
| 1161 | (mname, self._name, self.getWeight(state)),
|
---|
| 1162 | "%s NO GO" % (mname,))
|
---|
[13] | 1163 |
|
---|
| 1164 | def getWeight(self, state):
|
---|
| 1165 | """Get the weight that is interesting for us."""
|
---|
| 1166 | return state.grossWeight
|
---|
[11] | 1167 |
|
---|
| 1168 | #---------------------------------------------------------------------------------------
|
---|
| 1169 |
|
---|
| 1170 | class MLWChecker(WeightChecker):
|
---|
| 1171 | """Checks if the MLW is not exceeded on landing."""
|
---|
| 1172 | def __init__(self):
|
---|
| 1173 | """Construct the checker."""
|
---|
[13] | 1174 | super(MLWChecker, self).__init__("LW")
|
---|
[11] | 1175 |
|
---|
[13] | 1176 | def getLimit(self, flight, aircraft, state):
|
---|
[11] | 1177 | """Get the limit if we are in the right state."""
|
---|
| 1178 | return aircraft.mlw if flight.stage==const.STAGE_LANDING and \
|
---|
[184] | 1179 | state.onTheGround and \
|
---|
| 1180 | not flight.entranceExam else None
|
---|
[11] | 1181 |
|
---|
| 1182 | #---------------------------------------------------------------------------------------
|
---|
| 1183 |
|
---|
| 1184 | class MTOWChecker(WeightChecker):
|
---|
| 1185 | """Checks if the MTOW is not exceeded on landing."""
|
---|
| 1186 | def __init__(self):
|
---|
| 1187 | """Construct the checker."""
|
---|
[13] | 1188 | super(MTOWChecker, self).__init__("TOW")
|
---|
[11] | 1189 |
|
---|
[13] | 1190 | def getLimit(self, flight, aircraft, state):
|
---|
[11] | 1191 | """Get the limit if we are in the right state."""
|
---|
[184] | 1192 | return aircraft.mtow if flight.stage==const.STAGE_TAKEOFF and \
|
---|
| 1193 | not flight.entranceExam else None
|
---|
[11] | 1194 |
|
---|
| 1195 | #---------------------------------------------------------------------------------------
|
---|
| 1196 |
|
---|
| 1197 | class MZFWChecker(WeightChecker):
|
---|
[60] | 1198 | """Checks if the MZFW is not exceeded on landing."""
|
---|
[11] | 1199 | def __init__(self):
|
---|
| 1200 | """Construct the checker."""
|
---|
[13] | 1201 | super(MZFWChecker, self).__init__("ZFW")
|
---|
[11] | 1202 |
|
---|
[13] | 1203 | def getLimit(self, flight, aircraft, state):
|
---|
[11] | 1204 | """Get the limit if we are in the right state."""
|
---|
[184] | 1205 | return aircraft.mzfw if not flight.entranceExam else None
|
---|
[11] | 1206 |
|
---|
[13] | 1207 | def getWeight(self, state):
|
---|
| 1208 | """Get the weight that is interesting for us."""
|
---|
| 1209 | return state.zfw
|
---|
| 1210 |
|
---|
[11] | 1211 | #---------------------------------------------------------------------------------------
|
---|
| 1212 |
|
---|
| 1213 | class NavLightsChecker(PatientFaultChecker):
|
---|
| 1214 | """Check if the navigational lights are used properly."""
|
---|
| 1215 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1216 | """Check if the fault condition holds."""
|
---|
| 1217 | return flight.stage!=const.STAGE_BOARDING and \
|
---|
| 1218 | flight.stage!=const.STAGE_PARKING and \
|
---|
[341] | 1219 | state.navLightsOn is False
|
---|
[332] | 1220 |
|
---|
[11] | 1221 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1222 | """Log the fault."""
|
---|
[30] | 1223 | flight.handleFault(NavLightsChecker, state.timestamp,
|
---|
| 1224 | FaultChecker._appendDuring(flight,
|
---|
| 1225 | "Navigation lights were off"),
|
---|
| 1226 | 1)
|
---|
[11] | 1227 |
|
---|
| 1228 | #---------------------------------------------------------------------------------------
|
---|
| 1229 |
|
---|
| 1230 | class OverspeedChecker(PatientFaultChecker):
|
---|
| 1231 | """Check if Vne has been exceeded."""
|
---|
[197] | 1232 | def __init__(self, timeout = 5.0):
|
---|
[11] | 1233 | """Construct the checker."""
|
---|
[197] | 1234 | super(OverspeedChecker, self).__init__(timeout = timeout)
|
---|
[11] | 1235 |
|
---|
| 1236 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1237 | """Check if the fault condition holds."""
|
---|
| 1238 | return state.overspeed
|
---|
[332] | 1239 |
|
---|
[11] | 1240 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1241 | """Log the fault."""
|
---|
[30] | 1242 | flight.handleFault(OverspeedChecker, state.timestamp,
|
---|
| 1243 | FaultChecker._appendDuring(flight, "Overspeed"),
|
---|
[332] | 1244 | 20)
|
---|
[11] | 1245 |
|
---|
| 1246 | #---------------------------------------------------------------------------------------
|
---|
| 1247 |
|
---|
| 1248 | class PayloadChecker(SimpleFaultChecker):
|
---|
| 1249 | """Check if the payload matches the specification."""
|
---|
| 1250 | TOLERANCE=550
|
---|
[60] | 1251 |
|
---|
| 1252 | @staticmethod
|
---|
| 1253 | def isZFWFaulty(aircraftZFW, flightZFW):
|
---|
| 1254 | """Check if the given aircraft's ZFW is outside of the limits."""
|
---|
| 1255 | return aircraftZFW < (flightZFW - PayloadChecker.TOLERANCE) or \
|
---|
[332] | 1256 | aircraftZFW > (flightZFW + PayloadChecker.TOLERANCE)
|
---|
| 1257 |
|
---|
[11] | 1258 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1259 | """Check if the fault condition holds."""
|
---|
[192] | 1260 | return not flight.entranceExam and \
|
---|
[184] | 1261 | flight.stage==const.STAGE_PUSHANDTAXI and \
|
---|
[60] | 1262 | PayloadChecker.isZFWFaulty(state.zfw, flight.zfw)
|
---|
[332] | 1263 |
|
---|
[11] | 1264 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1265 | """Log the fault."""
|
---|
[30] | 1266 | flight.handleNoGo(PayloadChecker, state.timestamp,
|
---|
| 1267 | "ZFW difference is more than %d kgs" % \
|
---|
| 1268 | (PayloadChecker.TOLERANCE,),
|
---|
| 1269 | "ZFW NO GO")
|
---|
[11] | 1270 |
|
---|
| 1271 | #---------------------------------------------------------------------------------------
|
---|
| 1272 |
|
---|
| 1273 | class PitotChecker(PatientFaultChecker):
|
---|
| 1274 | """Check if pitot heat is on."""
|
---|
| 1275 | def __init__(self):
|
---|
| 1276 | """Construct the checker."""
|
---|
| 1277 | super(PitotChecker, self).__init__(timeout = 3.0)
|
---|
| 1278 |
|
---|
| 1279 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1280 | """Check if the fault condition holds."""
|
---|
[13] | 1281 | return state.groundSpeed>80 and not state.pitotHeatOn
|
---|
[332] | 1282 |
|
---|
[11] | 1283 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1284 | """Log the fault."""
|
---|
| 1285 | score = 2 if flight.stage in [const.STAGE_TAKEOFF, const.STAGE_CLIMB,
|
---|
| 1286 | const.STAGE_CRUISE, const.STAGE_DESCENT,
|
---|
| 1287 | const.STAGE_LANDING] else 0
|
---|
[30] | 1288 | flight.handleFault(PitotChecker, state.timestamp,
|
---|
| 1289 | FaultChecker._appendDuring(flight, "Pitot heat was off"),
|
---|
[332] | 1290 | score)
|
---|
[11] | 1291 |
|
---|
| 1292 | #---------------------------------------------------------------------------------------
|
---|
| 1293 |
|
---|
| 1294 | class ReverserChecker(SimpleFaultChecker):
|
---|
[360] | 1295 | """Check if the reverser is not used below the speed prescribed for the
|
---|
| 1296 | aircraft."""
|
---|
[11] | 1297 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1298 | """Check if the fault condition holds."""
|
---|
| 1299 | return flight.stage in [const.STAGE_DESCENT, const.STAGE_LANDING,
|
---|
| 1300 | const.STAGE_TAXIAFTERLAND] and \
|
---|
[360] | 1301 | state.groundSpeed<aircraft.reverseMinSpeed and max(state.reverser)
|
---|
[332] | 1302 |
|
---|
[11] | 1303 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1304 | """Log the fault."""
|
---|
[241] | 1305 | message = "Reverser used below %.0f %s" % \
|
---|
| 1306 | (flight.speedFromKnots(60), flight.getEnglishSpeedUnit())
|
---|
[30] | 1307 | flight.handleFault(ReverserChecker, state.timestamp,
|
---|
[241] | 1308 | FaultChecker._appendDuring(flight, message),
|
---|
| 1309 | 15)
|
---|
[11] | 1310 |
|
---|
| 1311 | #---------------------------------------------------------------------------------------
|
---|
| 1312 |
|
---|
| 1313 | class SpeedChecker(SimpleFaultChecker):
|
---|
| 1314 | """Check if the speed is in the prescribed limits."""
|
---|
[344] | 1315 | @staticmethod
|
---|
[349] | 1316 | def logSpeedFault(flight, state, stage = None, updateID = None):
|
---|
[344] | 1317 | """Log the speed fault."""
|
---|
| 1318 | message = "Taxi speed over %.0f %s" % \
|
---|
| 1319 | (flight.speedFromKnots(50), flight.getEnglishSpeedUnit())
|
---|
[349] | 1320 | if stage is None:
|
---|
| 1321 | stage = flight.stage
|
---|
| 1322 | score = FaultChecker._getLinearScore(50, 80, 10, 15, state.groundSpeed)
|
---|
| 1323 | return flight.handleFault((SpeedChecker, stage), state.timestamp,
|
---|
| 1324 | FaultChecker._appendDuring(flight, message),
|
---|
| 1325 | score, updatePrevious = updateID is None,
|
---|
| 1326 | updateID = updateID)
|
---|
[344] | 1327 |
|
---|
[11] | 1328 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1329 | """Check if the fault condition holds."""
|
---|
| 1330 | return flight.stage in [const.STAGE_PUSHANDTAXI,
|
---|
[354] | 1331 | const.STAGE_RTO,
|
---|
[11] | 1332 | const.STAGE_TAXIAFTERLAND] and \
|
---|
| 1333 | state.groundSpeed>50
|
---|
[332] | 1334 |
|
---|
[11] | 1335 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1336 | """Log the fault."""
|
---|
[344] | 1337 | self.logSpeedFault(flight, state)
|
---|
| 1338 |
|
---|
| 1339 | #---------------------------------------------------------------------------------------
|
---|
| 1340 |
|
---|
| 1341 | class NoStrobeSpeedChecker(StateChecker):
|
---|
| 1342 | """Checker for the ground speed of aircraft that have no strobe lights by
|
---|
| 1343 | which to detect the takeoff stage.
|
---|
| 1344 |
|
---|
| 1345 | If, during the PUSHANDTAXI stage the speed exceeds 50 knots, the state as
|
---|
| 1346 | saved as a provisional takeoff state. If the speed then decreases below 50
|
---|
| 1347 | knots, or the plane remains on the ground for more than 20 seconds, a taxi
|
---|
[349] | 1348 | speed error is logged with the highest ground speed detected. This state is
|
---|
| 1349 | also stored in the flight object as a possible
|
---|
[344] | 1350 |
|
---|
| 1351 | If the plane becomes airborne within 20 seconds, the stage becomes TAKEOFF,
|
---|
| 1352 | and the previously saved takeoff state is logged.
|
---|
| 1353 |
|
---|
| 1354 | During the TAXIAFTERLAND stage, speed is checked as in case of
|
---|
| 1355 | SpeedChecker."""
|
---|
| 1356 | def __init__(self):
|
---|
| 1357 | """Initialize the speed checker."""
|
---|
| 1358 | self._takeoffState = None
|
---|
| 1359 | self._highestSpeedState = None
|
---|
| 1360 |
|
---|
| 1361 | def check(self, flight, aircraft, logger, oldState, state):
|
---|
| 1362 | """Check the state as described above."""
|
---|
[354] | 1363 | if flight.stage==const.STAGE_PUSHANDTAXI or \
|
---|
| 1364 | flight.stage==const.STAGE_RTO:
|
---|
[344] | 1365 | self._checkPushAndTaxi(flight, aircraft, state)
|
---|
| 1366 | elif flight.stage==const.STAGE_TAXIAFTERLAND:
|
---|
| 1367 | if state.groundSpeed>50:
|
---|
| 1368 | SpeedChecker.logSpeedFault(flight, state)
|
---|
| 1369 |
|
---|
| 1370 | def _checkPushAndTaxi(self, flight, aircraft, state):
|
---|
| 1371 | """Check the speed during the push and taxi stage."""
|
---|
| 1372 | if state.groundSpeed>50:
|
---|
| 1373 | if self._takeoffState is None:
|
---|
| 1374 | self._takeoffState = state
|
---|
| 1375 | self._highestSpeedState = state
|
---|
| 1376 | else:
|
---|
| 1377 | if state.groundSpeed>self._highestSpeedState.groundSpeed:
|
---|
| 1378 | self._highestSpeedState = state
|
---|
| 1379 |
|
---|
| 1380 | if state.timestamp > (self._takeoffState.timestamp + 20):
|
---|
[349] | 1381 | flight.setRTOState(self._highestSpeedState)
|
---|
[344] | 1382 | elif not state.onTheGround:
|
---|
| 1383 | aircraft.setStage(self._takeoffState, const.STAGE_TAKEOFF)
|
---|
| 1384 | self._takeoffState = None
|
---|
| 1385 | elif self._takeoffState is not None:
|
---|
[349] | 1386 | flight.setRTOState(self._highestSpeedState)
|
---|
[344] | 1387 | self._takeoffState = None
|
---|
[11] | 1388 |
|
---|
| 1389 | #---------------------------------------------------------------------------------------
|
---|
| 1390 |
|
---|
| 1391 | class StallChecker(PatientFaultChecker):
|
---|
| 1392 | """Check if stall occured."""
|
---|
| 1393 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1394 | """Check if the fault condition holds."""
|
---|
| 1395 | return flight.stage in [const.STAGE_TAKEOFF, const.STAGE_CLIMB,
|
---|
| 1396 | const.STAGE_CRUISE, const.STAGE_DESCENT,
|
---|
| 1397 | const.STAGE_LANDING] and state.stalled
|
---|
[332] | 1398 |
|
---|
[11] | 1399 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1400 | """Log the fault."""
|
---|
| 1401 | score = 40 if flight.stage in [const.STAGE_TAKEOFF,
|
---|
| 1402 | const.STAGE_LANDING] else 30
|
---|
[30] | 1403 | flight.handleFault(StallChecker, state.timestamp,
|
---|
| 1404 | FaultChecker._appendDuring(flight, "Stalled"),
|
---|
[332] | 1405 | score)
|
---|
[11] | 1406 |
|
---|
| 1407 | #---------------------------------------------------------------------------------------
|
---|
| 1408 |
|
---|
| 1409 | class StrobeLightsChecker(PatientFaultChecker):
|
---|
| 1410 | """Check if the strobe lights are used properly."""
|
---|
| 1411 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1412 | """Check if the fault condition holds."""
|
---|
[211] | 1413 | return (flight.stage==const.STAGE_BOARDING and \
|
---|
| 1414 | state.strobeLightsOn and state.onTheGround) or \
|
---|
| 1415 | (flight.stage==const.STAGE_TAKEOFF and \
|
---|
| 1416 | not state.strobeLightsOn and not state.gearsDown) or \
|
---|
| 1417 | (flight.stage in [const.STAGE_CLIMB, const.STAGE_CRUISE,
|
---|
| 1418 | const.STAGE_DESCENT] and \
|
---|
| 1419 | not state.strobeLightsOn and not state.onTheGround) or \
|
---|
| 1420 | (flight.stage==const.STAGE_PARKING and \
|
---|
| 1421 | state.strobeLightsOn and state.onTheGround)
|
---|
[332] | 1422 |
|
---|
[11] | 1423 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1424 | """Log the fault."""
|
---|
| 1425 | message = "Strobe lights were %s" % (("on" if state.strobeLightsOn else "off"),)
|
---|
[30] | 1426 | flight.handleFault(StrobeLightsChecker, state.timestamp,
|
---|
| 1427 | FaultChecker._appendDuring(flight, message),
|
---|
| 1428 | 1)
|
---|
[11] | 1429 |
|
---|
| 1430 | #---------------------------------------------------------------------------------------
|
---|
| 1431 |
|
---|
| 1432 | class ThrustChecker(SimpleFaultChecker):
|
---|
| 1433 | """Check if the thrust setting is not too high during takeoff.
|
---|
| 1434 |
|
---|
| 1435 | FIXME: is this really so general, for all aircraft?"""
|
---|
| 1436 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1437 | """Check if the fault condition holds."""
|
---|
[263] | 1438 | return flight.stage==const.STAGE_TAKEOFF and \
|
---|
| 1439 | state.n1 is not None and max(state.n1)>97
|
---|
[332] | 1440 |
|
---|
[11] | 1441 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1442 | """Log the fault."""
|
---|
[30] | 1443 | flight.handleFault(ThrustChecker, state.timestamp,
|
---|
| 1444 | FaultChecker._appendDuring(flight,
|
---|
| 1445 | "Thrust setting was too high (>97%)"),
|
---|
[405] | 1446 | FaultChecker._getLinearScore(97, 110, 0, 10,
|
---|
| 1447 | max(state.n1)),
|
---|
| 1448 | updatePrevious = True)
|
---|
[11] | 1449 |
|
---|
| 1450 | #---------------------------------------------------------------------------------------
|
---|
| 1451 |
|
---|
| 1452 | class VSChecker(SimpleFaultChecker):
|
---|
| 1453 | """Check if the vertical speed is not too low at certain altitudes"""
|
---|
| 1454 | BELOW10000 = -5000
|
---|
| 1455 | BELOW5000 = -2500
|
---|
| 1456 | BELOW2500 = -1500
|
---|
| 1457 | BELOW500 = -1000
|
---|
| 1458 | TOLERANCE = 1.2
|
---|
| 1459 |
|
---|
| 1460 | def isCondition(self, flight, aircraft, oldState, state):
|
---|
| 1461 | """Check if the fault condition holds."""
|
---|
[197] | 1462 | vs = state.smoothedVS
|
---|
[11] | 1463 | altitude = state.altitude
|
---|
| 1464 | return vs < -8000 or vs > 8000 or \
|
---|
| 1465 | (altitude<500 and vs < (VSChecker.BELOW500 *
|
---|
[13] | 1466 | VSChecker.TOLERANCE)) or \
|
---|
[11] | 1467 | (altitude<2500 and vs < (VSChecker.BELOW2500 *
|
---|
[13] | 1468 | VSChecker.TOLERANCE)) or \
|
---|
[11] | 1469 | (altitude<5000 and vs < (VSChecker.BELOW5000 *
|
---|
[13] | 1470 | VSChecker.TOLERANCE)) or \
|
---|
[11] | 1471 | (altitude<10000 and vs < (VSChecker.BELOW10000 *
|
---|
[13] | 1472 | VSChecker.TOLERANCE))
|
---|
[332] | 1473 |
|
---|
[11] | 1474 | def logFault(self, flight, aircraft, logger, oldState, state):
|
---|
| 1475 | """Log the fault."""
|
---|
[197] | 1476 | vs = state.smoothedVS
|
---|
[11] | 1477 |
|
---|
| 1478 | message = "Vertical speed was %.0f feet/min" % (vs,)
|
---|
| 1479 | if vs>-8000 and vs<8000:
|
---|
| 1480 | message += " at %.0f feet (exceeds company limit)" % (state.altitude,)
|
---|
| 1481 |
|
---|
| 1482 | score = 10 if vs<-8000 or vs>8000 else 0
|
---|
| 1483 |
|
---|
[30] | 1484 | flight.handleFault(VSChecker, state.timestamp,
|
---|
| 1485 | FaultChecker._appendDuring(flight, message),
|
---|
| 1486 | score)
|
---|
[11] | 1487 |
|
---|
| 1488 | #---------------------------------------------------------------------------------------
|
---|