X-Plane Toliss Airbus - Additional command to save situation in time-stamped files

PI_save_toliss.py

# Python Plugin To Save Toliss Situations on request.
# Enjoy.
#
import os
import glob
import time
from datetime import datetime

import xp

AIRCRAFT_DATAREF = "sim/aircraft/view/acf_ICAO"

SAVE_TOLISS_COMMAND = "toliss/save_situation_now"
SAVE_TOLISS_COMMAND_DESC = "Save ToLiss Airbus situation to file with a timestamp"

TOLISS_SAVE_COMMAND = "toliss_airbus/iscsinterface/save_sit"
XPLANE_FOLDER_PATH = os.getcwd()
SAVED_SITUATION_FOLDER_PATH = os.path.join("Resources", "Plugins", "ToLissData", "Situations")
DATETIME_FORMAT = "%Y%m%d%H%M%S"

FLIGHT_PHASE_DREF = "AirbusFBW/ECAMFlightPhase"
FLIGHT_PHASES = [
    "OFF",  # 0
    "ELEC POWER",
    "FIRST ENG STARTED",
    "FIRST ENG TO POWER",
    "80KT",
    "LIFT OFF",
    "1500 FT",
    "800 FT",
    "TOUCHDOWN",
    "80KT",
    "2ND ENG SHUTDOWN",
    "5 MIN AFTER",  # 10
]

# ###########################################################
# S A V E   T O L I S S   S I T U A T I O N
#
PLUGIN_VERSION = "1.4.0"
#
# Changelog:
#
# 10-MAR-2025: 1.4.0: Added flight phase code -0- (off) to -10- (off :-D) to name
# 15-OCT-2024: 1.3.0: Prepend aircraft ICAO name A339_... A321_...
# 15-OCT-2024: 1.2.0: Force name to USERSAVED_SITUATION-YYYMMDDHHMMSS*
# 02-SEP-2024: 1.1.0: Add notification on screen that it worked
# 23-AUG-2024: 1.0.1: Changed date/time format
# 02-FEB-2024: 1.0.0: Initial version
#
# Suggestion, ideas
# Depending on ac model (icao), we can get
# - toliss_airbus/flightplan/departure_icao
# - toliss_airbus/flightplan/destination_icao
# or equivalent


class PythonInterface:
    def __init__(self):
        self.Name = "Save ToLiss Situation"
        self.Sig = "xppython3.savetoliss"
        self.Desc = SAVE_TOLISS_COMMAND_DESC + " (Rel. " + PLUGIN_VERSION + ")"
        self.Info = self.Name + f" (rel. {PLUGIN_VERSION})"
        self.enabled = False
        self.trace = True  # produces extra debugging in XPPython3.log for this class
        self.color = (0.0, 1.0, 0.0)
        self.message = "Save ToLiss Airbus situation"
        self.duration = 5
        self.refCon = {"unsued": "unused"}
        self.saveToLissCmdRef = None

    def XPluginStart(self):
        if self.trace:
            print(self.Info, "XPluginStart: starting..")

        self.saveToLissCmdRef = xp.createCommand(SAVE_TOLISS_COMMAND, SAVE_TOLISS_COMMAND_DESC)
        xp.registerCommandHandler(self.saveToLissCmdRef, self.saveToLiss, 1, None)

        print(self.Info, "XPluginStart: ..started.")
        return self.Name, self.Sig, self.Desc

    def XPluginStop(self):
        if self.trace:
            print(self.Info, "XPluginStop: stopping..")

        if self.saveToLissCmdRef:
            xp.unregisterCommandHandler(self.saveToLissCmdRef, self.saveToLiss, 1, None)
            self.saveToLissCmdRef = None

        print(self.Info, "XPluginStop: ..stopped.")
        return None

    def XPluginEnable(self):
        xp.registerDrawCallback(self._notify)
        self.enabled = True
        return 1

    def XPluginDisable(self):
        self.enabled = False
        return None

    def XPluginReceiveMessage(self, inFromWho, inMessage, inParam):
        pass

    def notify(self):
        self.duration = 100
        xp.registerDrawCallback(self._notify)

    def _notify(self, phase, after, refCon):
        xp.setGraphicsState(0, 1, 0, 0, 0, 0, 0)
        xp.drawString(self.color, 20, 100, self.message)
        self.duration = self.duration - 1
        if self.duration <= 0:
            xp.unregisterDrawCallback(self._notify)

    def saveToLiss(self, *args, **kwargs):
        # pylint: disable=unused-argument
        if not self.enabled:
            print(self.Info, "saveToLiss: not enabled.")
            return 0

        command_phase = 0
        if len(args) > 2:
            command_phase = args[1]
            if self.trace:
                print(self.Info, "saveToLiss: command phase", command_phase)
        else:
            print(self.Info, "saveToLiss: no command phase", len(args))

        if command_phase == 0:
            try:
                # 0. Find aircraft ICAO name
                dref = xp.findDataRef(AIRCRAFT_DATAREF)
                ac_icao = "ZZZZ"
                if dref is not None:
                    ac_icao = xp.getDatas(dref, count=4)  # count=-1 gets error
                print(self.Info, f"aircraft icao {ac_icao}")

                # 0.b Find flight phase for ToLiss airbus
                fpref = xp.findDataRef(FLIGHT_PHASE_DREF)
                ac_fp = 0
                if fpref is not None:
                    ac_fp = xp.getDatai(fpref)  # count=-1 gets error
                    try:
                        ac_fp = int(ac_fp)
                        if 0 <= ac_fp < len(FLIGHT_PHASES):
                            print(self.Info, f"flight phase {FLIGHT_PHASES[ac_fp]}")
                        else:
                            print(self.Info, f"flight phase {ac_fp} (invalid)")
                    except:
                        print(self.Info, "flight phase is not an integer?")
                        print_exc()
                        ac_fp = 0

                # 1. Save the situation (2 files)
                cmd_ref = xp.findCommand(TOLISS_SAVE_COMMAND)
                if cmd_ref is None:
                    if self.trace:
                        self.color = (1.0, 0.0, 0.0)
                        self.message = "ToLiss save command not found"
                        self.notify()
                        print(self.Info, f"command '{TOLISS_SAVE_COMMAND}' not found")
                    return 1

                ts = datetime.now()
                xp.commandOnce(cmd_ref)
                if self.trace:
                    print(self.Info, f"saved situation at {ts}")

                # 2. Rename the situation files with timestamp
                # Find all files newer than ts
                # Name should contain toliss_airbus/iscsinterface/current_sit_name as a prefix...
                #
                all_files = glob.glob(os.path.join(XPLANE_FOLDER_PATH, SAVED_SITUATION_FOLDER_PATH, "*.qps"))
                all_files = all_files + glob.glob(os.path.join(XPLANE_FOLDER_PATH, SAVED_SITUATION_FOLDER_PATH, "*_pilotItems.dat"))
                files = list(filter(lambda f: os.path.getctime(f) > ts.timestamp(), all_files))
                if self.trace:
                    print(self.Info, f"files newer than {ts.isoformat()}", files)
                # Rename those files with <timestamp> added to name
                newname = ""
                if len(files) > 0:
                    tstr = ts.strftime(DATETIME_FORMAT)
                    for f in files:
                        fn, fext = os.path.os.path.splitext(f)
                        newname = os.path.join(os.path.dirname(fn), f"{ac_icao}_USERSAVED_SITUATION-{ac_fp}-" + tstr + fext)
                        os.rename(f, newname)
                        self.color = (0.0, 1.0, 0.0)
                        self.message = f"saved situation at {ts} in file {os.path.basename(newname)}"
                        print(self.Info, self.message)

                        self.notify()
                    # if self.trace:
                    #     print(self.Info, f"{len(files)} files renamed at {tstr}")
                else:
                    if self.trace:
                        print(self.Info, "no file")

                return 1
            except:
                print(self.Info, "saveToLiss: exception")
                print_exc()

        return 0