Comentarios

35714521 · Samuel Valverde Garcia · 8cacd52c · 35714521
Commit 35714521 authored May 07, 2024 by Samuel Valverde Garcia
Showing with 61 additions and 51 deletions
interfaz.py
--- a/interfaz.py
+++ b/interfaz.py
@@ -8,43 +8,60 @@ import mensajeInterfaz as mi
 # Clase que crea una ventana secundaria con la matriz de botones
 class MatrixWindow:
-    # master: Ventana principal del Tkinter
-    # matriz: matriz de valores para los botones
+    # Constructor de la clase MatrixWindow
-    # queue_callback: Funcion de callback para manejar los clicks en los botones
    def __init__(self, master, matriz, queue_callback):
+        """master: Ventana principal del Tkinter, Toplevel: crea una nueva ventana"""
        self.master = tk.Toplevel(master)
-        self.master.title("Matriz de Botones")
+        self.master.title("Creación de pedido")
+        """matriz: matriz de valores para los botones"""
        self.matriz = matriz
+        """queue_call: manejar eventos de click en los botones"""
        self.queue_callback = queue_callback
+        """click_positions: almacena las posiciones de los botones que han sido clicados"""
        self.click_positions = []
+        """Cargar imagenes"""
        self.load_images()
+        """Muestra botones dentro de la ventana emergente"""
        self.display_buttons()
-        #Bloquear ventana principal
+        """Bloquea la ventana principal y solo funciona la ventana emergente"""
        self.master.grab_set()
-    # Carga imagenes desde un directorio y las ajusta al tamaño deseado. Si una imagen no se encuentra, 
+    # Carga imagenes desde el directorio imagenes y las ajusta al tamaño deseado. 
-    # muestra un mensaje de error y coloca una casilla gris
+    # Si una imagen no se encuentra, muestra un mensaje de error y coloca una casilla gris
    def load_images(self):
+        """self.imagenes: diccionario vacio donde se alamacenarán las imagenes"""
        self.images = {}
        desired_size = (50, 50)
        for i in range(12):
            image_number = f"{i:02}"
            try:
+                """Abre la imagen desde el directorio usando el nombre formateado"""
                image = Image.open(f"images/{image_number}.png")
+                """Redimensiona la imagen al tamaño deseado usando el método LANCZOS, 
+                que es adecuado para iamgenes que se reducen de tamaño"""
                image = image.resize(desired_size, Image.Resampling.LANCZOS)
+                """Convierte la imagen redimensionada a un objeto PhotoImage que es el formato requerido
+                por TKinter para mostrar imágenes y se guarda en el diccionario,
+                usando como clave el numero de imagen"""
                self.images[image_number] = ImageTk.PhotoImage(image)
            except FileNotFoundError:
                print(f"Error: No se encontró la imagen para {image_number}")
        self.images['default'] = ImageTk.PhotoImage(Image.new('RGB', desired_size, color='grey'))
-    # Crea botones en la ventana secuandaria usando las imagenes cargadas. Los botones tienen asignados comandos que llaman a 'record_click()'
+    # Crea botones en la ventana secuandaria usando las imagenes cargadas. 
+    #Los botones tienen asignados comandos que llaman a 'record_click()'
    def display_buttons(self):
        for i in range(7):
            for j in range(5):
                image_value = self.matriz[i][j]
+                """Busca en el diccionario de imágenes una imagen que corresponda si no la encuientra carga la imagen por defecto"""
                image = self.images.get(image_value, self.images['default'])
+                """Creacion de Botones o etiquetas"""
                if(image_value == '01'):
                    if(j-1 < 0 or j+1 >4):
+                        """Se asignan comandos mediante el uso de lambda que capturan las coordenadas i y j y
+                          llaman a record_click cuando se ahce click en el boton"""
                        btn = tk.Button(self.master, image=image, compound=tk.CENTER, command=lambda i=i, j=j: self.record_click(i, j), bg='#515e5d')
                    else:
                        if((self.matriz[i][j-1] != '05' and self.matriz[i][j-1] != '06' and self.matriz[i][j-1] != '10' and self.matriz[i][j-1] != '00') and (self.matriz[i][j+1] != '03' and self.matriz[i][j+1] != '04' and self.matriz[i][j+1] != '08' and self.matriz[i][j+1] != '00') ):
@@ -61,75 +78,91 @@ class MatrixWindow:
                            btn = tk.Button(self.master, image=image, compound=tk.CENTER, command=lambda i=i, j=j: self.record_click(i, j), bg='#515e5d')      
                else:
                    btn = tk.Label(self.master, image=image, compound=tk.CENTER)
+                """Evita que la referencia a la iamgen sea recolectada por el recolector de basura de Python"""
                btn.image = image
+                """Colocar en las posicion correspondiente a sus indices, el boton o etiqueta en la ventana emergente"""
                btn.grid(row=i, column=j)
    # Registra clicks en los botones y, al seleccionar dos botones diferentes, 
    # llama al callback para actualizar la cola visual y cierra la ventana secuandaria
    def record_click(self, i, j):
+        """crea una tupla con las coordenadas"""
        position = (i, j)
        if position not in self.click_positions:
            self.click_positions.append(position)
            if len(self.click_positions) == 2:
                if self.click_positions[0] != self.click_positions[1]:
+                    """Inserta un nuevo par origen-destino en la Listbox"""
                    self.queue_callback(self.click_positions[0], self.click_positions[1])
+                    """Cierra la ventana emergente"""
                    self.master.destroy()
                else:
+                    """Elimina la ultima posicion añadida si es igual a la primera, ignorando el segundo click"""
                    self.click_positions.pop() 
 # Clase principal que gestiona la ventana principal de la aplicación
 class MainApp:
+    #Constructor
    def __init__(self, master):
+        """Funcion que maneja los mensajes MQTT que recibe la aplicacion"""
        def on_message(client, userdata, message):
            print(f'Topic:{message.topic} Mensage:{str(message.payload.decode("utf-8"))}')
            if(message.topic == "map"):
                self.cadena = str(message.payload.decode("utf-8"))
-        #Inicializa la posicion del robot
+        """Inicialización de Atributos"""
        self.robot_position = None
        self.borrar = False
+        """Configuracion de la ventana principal"""
        self.master = master
        master.title("Ventana Principal")
+        """Configuración de la interfaz"""
-        # Configuración de la interfaz
        self.setup_interface()
-        # Iniciar actualización periódica de la posición del robot
+        """Iniciar actualización periódica de la posición del robot"""
        self.schedule_robot_updates()
+    #Configuracion de la interfaz
    def setup_interface(self):
-        # Configuración del panel izquierdo y derecho, y otros elementos
+        """Estructura la disposion de la interfaz"""
        self.left_panel = ttk.Frame(self.master)
+        """Posiciona el panel izquierdo en el lado izquierdo, permitiendo que se expanda"""
        self.left_panel.pack(side=tk.LEFT, fill=tk.BOTH, expand=True)
        self.right_panel = ttk.Frame(self.master)
        self.right_panel.pack(side=tk.RIGHT, fill=tk.BOTH, expand=True)
+        """Crea un boton en el panel derecho"""
        ttk.Button(self.right_panel, text="Añadir Peticiones", command=self.open_matrix_window).pack(pady=20)
+        """Crea una lista de elementos, donde se van a ver las peticiones"""
        self.queue_listbox = tk.Listbox(self.right_panel, width=40, height=10)
        self.queue_listbox.pack(padx=20, pady=20)
        self.cadena = ""
        self.mensaje = mi.MensajeInterfaz()  
+        """Almacena el mapa"""
        self.cadena = self.mensaje.getMapa()
-        # Inicialización de la matriz
+        """Inicialización de la matriz"""
        self.matriz = self.create_initial_matrix() 
-        # Cargar imágenes y mostrar matriz estática
+        """Cargar imágenes y mostrar matriz estática"""
        self.load_images()
        self.labels = {}
+        """Llama al metodo para crear la matriz de imagenes estatica"""
        self.display_static_matrix()      
+    # Crea una matriz basada en una cadena codificada que representa valores
+    def create_initial_matrix(self):
+        segmentos = [self.cadena[i:i+2] for i in range(0, len(self.cadena), 2)]
+        matriz = []
+        for i in range(7):
+            fila = segmentos[i*5:(i+1)*5]
+            matriz.append(fila)
+        return matriz
    # Carga imagenes desde un directorio y las ajusta al tamaño deseado. Si una imagen no se encuentra, 
    # muestra un mensaje de error y coloca una casilla gris
@@ -157,18 +190,6 @@ class MainApp:
                lbl.grid(row=i, column=j)
                self.labels[(i, j)] = lbl
-    # Crea una matriz basada en una cadena codificada que representa valores
-    def create_initial_matrix(self):
-        segmentos = [self.cadena[i:i+2] for i in range(0, len(self.cadena), 2)]
-        matriz = []
-        for i in range(7):
-            fila = segmentos[i*5:(i+1)*5]
-            matriz.append(fila)
-        return matriz
    # Inicia la ventana secundaria MatrixWindow
    def open_matrix_window(self):
        MatrixWindow(self.master, self.matriz, self.update_queue_display)
@@ -178,9 +199,10 @@ class MainApp:
        self.queue_listbox.insert(tk.END, (origen, destino))
        self.highlight_path()
+    #Ejecuta de manera periodica, actualizacion del robot y maneja los pedidos
    def schedule_robot_updates(self):
-        """ Programa la actualización de la posición del robot cada 1 segundo. """
        self.update_robot_position(self.mensaje.getPosicion())
+        """Se llama de forma recursiva cada 1 segundo"""
        self.master.after(1000, self.schedule_robot_updates)
@@ -196,19 +218,6 @@ class MainApp:
                print("Breakpoint Enviar Pedido: ", self.queue_listbox.get(0))
                self.mensaje.sendPedido(self.queue_listbox.get(0))
                self.borrar = True      
-            # Aquí asumimos que self.borrar debe ser seteado a True por alguna función que
-            # detecte que el robot ha completado el pedido, por ejemplo en un callback de MQTT
-        """
-        #Eviar pedido al robot cuando lo solicita y hay pedidos
-        if self.mensaje.pedidoSolicitado:
-            if self.queue_listbox.size() >0:
-                if(self.borrar is True):
-                    self.queue_listbox.delete(0)
-            if self.queue_listbox.size() > 0: 
-                print("Breakpint Enviar Pedido: ",self.queue_listbox.get(0))
-                self.mensaje.sendPedido(self.queue_listbox.get(0))
-                self.borrar = True
-        """        
    #Actualiza la posición del robot y actualiza el resaltado correspondiente.
    def update_robot_position(self, new_position):
@@ -216,20 +225,21 @@ class MainApp:
        self.highlight_path()
    # Resalta los botones correspondientes al primer elemento de la Listbox
+    # Resalta donde se encuentra el robot
    def highlight_path(self):
-        # Reset all labels
+        """Resetea todo los labels"""
        for label in self.labels.values():
            label.config(relief='flat', bg='SystemButtonFace')
        if self.queue_listbox.size() > 0:
            origen, destino = self.queue_listbox.get(0)
-            # Resalta origen y destino
+            """Resalta origen y destino, con un borde elevador y el color correspondiente"""
            self.labels[origen].config(relief='raised', borderwidth=2, bg='green')
            self.labels[destino].config(relief='raised', borderwidth=2, bg='red')
-        # Resalta la posición del robot si está disponible
+        """Resalta la posición del robot si está disponible"""
        if self.robot_position is not None:
-            self.labels[self.robot_position].config(relief='raised', borderwidth=2, bg='blue')  # Asumiendo azul para el robot    
+            self.labels[self.robot_position].config(relief='raised', borderwidth=2, bg='blue')   
 #Inicializa la aplicación
 def main():