Menu.py

"""
Class for creating the menu bar based on the state of the IMU object.
"""
import constants as c


class Menu:
    def __init__(self):
        # Set initial values
        self.imuConnected = False
        self.imuImenu = None
        # Initial creation of menus.
        self.__generateMenus()

    def getMenu(self, imuConnected=False):
        """
        Return the current menu bar based on the parameter values given. The local parameter values are updated based on
        the given parameters and the menu(s) are generated. The generated menus are combined into a single menu bar
        layout and returned.

        Args:
            imuConnected (bool): True if IMU object is connected, else False.

        Returns:
            menuFinal (list): Final menu layout.
        """
        # Local variable update.
        self.imuConnected = imuConnected
        # Generate menus.
        self.__generateMenus()

        menuFinal = [self.imuImenu]
        # Return menu bar layout.
        return menuFinal

    def __generateImuMenu(self):
        """
        Function for creating imu menus based on the connection status of the IMU object. For controlling the
        connection to the IMU. if self.imuConnected:

        False (initial state):      Menu to show when the IMU is not connected. Since the IMU is not connected the
                                    return rate cannot be changed and the acceleration cannot be calibrated, so these
                                    options are disabled.
        True (post connection):     Menu to show when the IMU has been connected, enabling return rate and acceleration
                                    calibration.
        """
        if not self.imuConnected:
            self.imuImenu = ['IMU', ['Connect::-MENU-IMU-CONNECT-',
                                     '---',
                                     '!Set Return Rate',
                                     '!Set Bandwidth',
                                     '!Set Algorithm',
                                     '!Calibrate Acceleration::-MENU-IMU-CALIBRATE-']
                             ]
        if self.imuConnected:
            self.imuImenu = ['IMU', ['Disconnect::-MENU-IMU-DISCONNECT-',
                                     '---',
                                     'Set Return Rate', [f'{i}::-MENU-IMU-RATE-' for i in c.IMU_RATE_OPTIONS],
                                     'Set Bandwidth', [f'{i}::-MENU-IMU-BANDWIDTH-' for i in c.IMU_BANDWIDTH_OPTIONS],
                                     'Set Algorithm', [f'{i}::-MENU-IMU-ALGORITHM-' for i in c.IMU_ALGORITHM_OPTIONS],
                                     'Calibrate Acceleration::-MENU-IMU-CALIBRATE-']
                             ]

    def __generateMenus(self):
        """
        Function to call individual menu generating functions. More menus can be added, which now only require a single
        function to create the menu and a single call to this __generateMenus function.
        """
        # IMU Menu.
        self.__generateImuMenu()