source: src/mlx/checks.py@ 478:00d38a068da9

xplane
Last change on this file since 478:00d38a068da9 was 478:00d38a068da9, checked in by István Váradi <ivaradi@…>, 11 years ago

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