WindowView API

What is the WindowView API

The WindowView API is a framework for developing custom simulator subwindows using PySide6. The simulator windows run in a separate process as the robot code, requiring the use of I/O queues for handling live data between the robot code and the simulator.

Info

The WindowView API requires the usage of PySide6. PySide6 versions not installed as a dependency of KevinbotLib, or other Python Qt bindings are not officially supported, and may not function properly.

Creating and Registering a WindowView

from PySide6.QtCore import QSize
from PySide6.QtGui import QColor, QIcon, QImage, QPixmap
from PySide6.QtWidgets import QLabel, QWidget

from kevinbotlib.robot import BaseRobot
from kevinbotlib.simulator.windowview import WindowView, register_window_view


@register_window_view("test.mywindowview")
class MyWindowView(WindowView):
    def __init__(self):
        super().__init__()

    @property
    def title(self):
        return "My Awesome WindowView"

    # ! optional - define an icon for the WindowView
    # Icons must be PySide6 QIcon and scalable down to 16x16
    def icon(self, dark_mode: bool) -> QIcon:
        super().icon(dark_mode)
        # this seems like a lot, but it just generates a red icon for use in this example
        image = QImage(QSize(16, 16), QImage.Format.Format_RGB888)
        image.fill(QColor(255, 0, 0))
        return QIcon(QPixmap.fromImage(image))

    def generate(self) -> QWidget:
        return QLabel("Hello World!")


class DemoRobot(BaseRobot):
    def __init__(self):
        super().__init__(
            ["Test"],
            enable_stderr_logger=True,
        )

        if BaseRobot.IS_SIM:
            self.simulator.add_window("test.mywindowview", MyWindowView)
            self.telemetry.info(f"Registered WindowViews: {self.simulator.windows}")


if __name__ == "__main__":
    DemoRobot().run()

Tip

Each WindowView must have a different registered Window ID (in this case, test.mywindowview). It is recommended to use reverse domain name notation (e.g., com.example.myproduct.mywindowview). Do not use Window IDs starting with kevinbotlib or com.meowmeowahr.kevinbotlib

Working with Payloads

from typing import Any

from PySide6.QtWidgets import QLabel, QPushButton, QVBoxLayout, QWidget

from kevinbotlib.robot import BaseRobot
from kevinbotlib.simulator.windowview import WindowView, WindowViewOutputPayload, register_window_view


class ResetPayload(WindowViewOutputPayload):
    def payload(self) -> Any:
        return "reset"


@register_window_view("test.mywindowview")
class MyWindowView(WindowView):
    def __init__(self):
        super().__init__()

        self.widget = QWidget()

        self.layout = QVBoxLayout()
        self.widget.setLayout(self.layout)

        self.label = QLabel("Robot Cycles: ?")
        self.layout.addWidget(self.label)

        self.button = QPushButton("Reset")
        self.button.clicked.connect(lambda: self.send_payload(ResetPayload()))
        self.layout.addWidget(self.button)

    @property
    def title(self):
        return "My Awesome WindowView"

    def generate(self) -> QWidget:
        return self.widget

    def update(self, payload: Any) -> None:
        self.label.setText(f"Robot Cycles: {payload}")


class DemoRobot(BaseRobot):
    def __init__(self):
        super().__init__(
            ["Test"],
            enable_stderr_logger=True,
        )

        self.cycles = 0
        if BaseRobot.IS_SIM:
            self.simulator.add_window("test.mywindowview", MyWindowView)

            def reset_cycles(payload: WindowViewOutputPayload):
                if payload.payload() == "reset":
                    self.cycles = 0

            self.simulator.add_payload_callback(ResetPayload, reset_cycles)

    def robot_periodic(self, opmode: str, enabled: bool):
        super().robot_periodic(opmode, enabled)

        self.cycles += 1
        self.simulator.send_to_window("test.mywindowview", self.cycles)


if __name__ == "__main__":
    DemoRobot().run()