device.py

from __future__ import annotations

import time
from logging import getLogger
from typing import TYPE_CHECKING, Generator, Literal, NamedTuple

from serial import Serial, serialutil
from serial.tools import list_ports

from .errors import (
    InvalidParameter,
    InvalidParameterInput,
    ReconnectTimeout,
    RestartFailure,
    SerialConnectionNotFound,
    SerialException,
    TooManyDevices,
    UnknownCommand,
    UnknownProduct,
    UnknownVendor,
)
from ._types import Chord, ChordPhrase, Keymap, OperatingSystem

if TYPE_CHECKING:
    from typing_extensions import Self

logger = getLogger(__name__)

pid_mapping = {}
vid_mapping = {
    0x239A: "Adafruit",
    0x303A: "Espressif",
}


def allowed_product_ids(*product_ids: int):
    def decorator(cls):
        for product_id in product_ids:
            pid_mapping[product_id] = cls
        return cls

    return decorator


class Device(NamedTuple):
    """
    Represents any device connected through a serial port.

    This is more of a meta class; its main purpose is to provide a raw list of
    devices that are connected to the system and is not significant enough to be
    used on its own; if you want to create your own class, you should subclass
    from `charachorder.CharaChorder` instead.
    """

    product_id: int
    vendor_id: int
    port: str

    @classmethod
    def list_devices(cls) -> list[Device]:
        """Returns a list of devices connected to serial ports."""
        devices = []
        for port_info in list_ports.comports():
            device = Device(
                product_id=port_info.pid,
                vendor_id=port_info.vid,
                port=port_info.device,
            )
            devices.append(device)
        return devices


class CharaChorder(Device):
    """
    Represents any CharaChorder device.

    This is the base class of all the CharaChorder* classes and inherits from
    `charachorder.Device`.

    Normally, you wouldn't instantiate this class directly; instead use
    `CharaChorder.list_devices()` to get a list of CharaChorder devices
    connected to the system.
    """

    bootloader_mode: bool
    connection: Serial
    vendor: Literal["Adafruit", "Espressif"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        self.connection = Serial(baudrate=115200, timeout=1)
        # The port is specified separately so that
        # the connection is not immediately opened
        self.connection.port = port

        if product_id not in pid_mapping:
            raise UnknownProduct(product_id)

        if vendor_id in vid_mapping:
            self.vendor = vid_mapping[vendor_id]
        else:
            raise UnknownVendor(vendor_id)

        self.name = f"{self.__class__.__name__} {self.chipset}"

    def __repr__(self):
        return f"{self.name} ({self.port})"

    def __str__(self):
        return f"{self.name} ({self.port})"

    @classmethod
    def list_devices(cls) -> list[Self]:
        """Returns a list of CharaChorder devices connected to serial ports."""
        devices = []
        for device in super().list_devices():
            subclass = pid_mapping.get(device.product_id)
            if subclass and issubclass(subclass, cls):
                devices.append(
                    subclass(device.product_id, device.vendor_id, device.port)
                )
        return devices

    def open(self):
        """Opens a connection to the device."""
        try:
            self.connection.open()
        except serialutil.SerialException as error:
            logger.error(error.strerror)
            raise SerialException(error.strerror)

    def close(self):
        """Closes the connection to the device."""
        self.connection.close()

    def __enter__(self):
        self.open()
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        self.close()

    def _execute(self, *args: int | str, **kwargs) -> tuple[str, ...]:
        if self.connection.is_open is False:
            raise SerialConnectionNotFound

        command = " ".join(map(str, args))
        logger.debug(f"[{self}]: Executing '{command}'...")

        output = []
        while not output:
            try:
                self.connection.write(f"{command}\r\n".encode("utf-8"))
            except serialutil.SerialException:
                logger.warning(f"[{self}]: Device not found; trying to reconnect...")
                self._reconnect(timeout=kwargs["timeout"])

            for line in self.connection.iread_until():
                decoded_line = line.decode("utf-8").strip().split(" ")

                if decoded_line[0] == "01":  # drop serial header
                    decoded_line = decoded_line[1:]

                if decoded_line[0] == "UKN":
                    raise UnknownCommand(command)

                if command == " ".join(decoded_line[: len(args)]):
                    output = decoded_line
                    # There is no output in the buffer after this iteration but
                    # the default behaviour of detecting an EOF is quite slow.
                    break

        logger.debug(f"[{self}]: Received '{' '.join(output)}'")
        return tuple(output[len(args) :])

    def _reconnect(self, *, timeout: float | None = 3.0):
        def is_same_device(product_id: int, vendor_id: int) -> bool:
            return product_id == self.product_id and vendor_id == self.vendor_id

        start_time = time.time()
        while time.time() - start_time < (timeout or float("inf")):
            try:
                ports = list_ports.comports()
            except TypeError:
                # Weirdly, the list_ports.comports() can fail during the device restart
                #
                # Traceback (most recent call last):
                # ... snip ...
                # File ".../serial/tools/list_ports_linux.py", line 102, in comports
                #     for info in [SysFS(d) for d in devices]
                # File ".../serial/tools/list_ports_linux.py", line 102, in <listcomp>
                #     for info in [SysFS(d) for d in devices]
                # File ".../serial/tools/list_ports_linux.py", line 52, in __init__
                #     self.vid = int(self.read_line(self.usb_device_path, 'idVendor'), 16)
                # TypeError: int() can't convert non-string with explicit base
                continue

            comports = [port for port in ports if is_same_device(port.pid, port.vid)]

            # Device is disconnected or restarting
            if len(comports) == 0:
                continue

            # Device found
            elif len(comports) == 1:
                port = comports[0].device

                # This is true when the device is
                # restarting but hasn't fully shutdown yet
                is_same_session = port == self.port
                if is_same_session:
                    continue

                self.connection.close()
                self.connection.port = port
                try:
                    self.connection.open()
                except serialutil.SerialException:
                    # There is a brief period after the device
                    # restarts where you cannot open a connection to it
                    continue

                break

            # More than one device of the same model was found
            elif len(comports) > 1:
                raise TooManyDevices
        else:
            raise ReconnectTimeout

    def ping(self, *, timeout: float | None = 10.0):
        """Checks if the connection to a device is alive."""
        logger.debug(f"[{self}]: Attempting to ping...")
        start_time = time.time()
        self._execute("CMD", timeout=timeout)
        logger.info(
            f"[{self}]: Ping successful in {(time.time() - start_time) * 1000:.2f}ms"
        )

    def get_commands(self) -> list[str]:
        """Returns a list of all the commands in the Serial API."""
        return self._execute("CMD")[0].split(",")

    def get_id(self) -> str:
        """Returns the company, model, and the chipset of the device."""
        return " ".join(self._execute("ID"))

    def get_version(self) -> str:
        """Returns the current version of the CCOS firmware."""
        return self._execute("VERSION")[0]

    def get_chordmap_count(self) -> int:
        """Returns the total number of chordmaps in the device."""
        return int(self._execute("CML", "C0")[0])

    def get_chordmap(self, index: int) -> tuple[Chord, ChordPhrase]:
        """Returns a chordmap at the given index."""
        if index not in range(self.get_chordmap_count()):
            raise IndexError("Chordmap index out of range")

        chord, phrase, success = self._execute("CML", "C1", index)
        return Chord.from_hex(chord), ChordPhrase.from_hex(phrase)

    def get_chordmaps(self) -> Generator[tuple[Chord, ChordPhrase], None, None]:
        """Returns an iterable generator over all the chordmaps in the device."""
        chordmap_count = self.get_chordmap_count()
        return (self.get_chordmap(i) for i in range(chordmap_count))

    def get_chord_phrase(self, chord: Chord) -> ChordPhrase | None:
        """Returns the phrase corresponding to the given chord."""
        phrase = self._execute("CML", "C2", chord.to_hex())[0]
        return ChordPhrase.from_hex(phrase) if phrase != "0" else None

    def set_chordmap(self, chord: Chord, phrase: ChordPhrase) -> bool:
        """Sets a phrase corresponding to the given chord. Returns a success boolean."""
        return self._execute("CML", "C3", chord.to_hex(), phrase.to_hex())[0] == "0"

    def delete_chordmap(self, chord: Chord) -> bool:
        """Deletes a chordmap from the device. Returns a success boolean."""
        return self._execute("CML", "C4", chord.to_hex())[0] == "0"

    def delete_chordmaps(self):
        """Deletes all the chordmaps stored in the device and commits."""
        self._execute("RST", "CLEARCML")

    def upgrade_chordmaps(self):
        """WARNING: In development. Updates any chordmaps that the system detects to be outdated and commits."""
        self._execute("RST", "UPGRADECML")

    def append_starter_chordmaps(self):
        """Appends starter chordmaps to the chord library and commits."""
        self._execute("RST", "STARTER")

    def append_functional_chordmaps(self):
        """Appends functional chordmaps to the chord library and commits."""
        self._execute("RST", "FUNC")

    def commit(self) -> bool:
        """Commits any parameter changes to the persistent memory of the device. Returns a success boolean."""
        return self._execute("VAR", "B0")[0] == "0"

    def _maybe_commit(self, success, commit: bool) -> bool:
        if success and commit:
            return self.commit()
        return success

    def get_parameter(self, code: int) -> int:
        """Returns the value of a parameter."""
        value, success = self._execute("VAR", "B1", hex(code))
        if success != "0":
            raise InvalidParameter(hex(code))
        return int(value)

    def is_serial_header_enabled(self) -> bool:
        return bool(self.get_parameter(0x01))

    def is_serial_logging_enabled(self) -> bool:
        return bool(self.get_parameter(0x02))

    def is_serial_debugging_enabled(self) -> bool:
        return bool(self.get_parameter(0x03))

    def is_serial_raw_enabled(self) -> bool:
        return bool(self.get_parameter(0x04))

    def is_serial_chord_enabled(self) -> bool:
        return bool(self.get_parameter(0x05))

    def is_serial_keyboard_enabled(self) -> bool:
        return bool(self.get_parameter(0x06))

    def is_serial_mouse_enabled(self) -> bool:
        return bool(self.get_parameter(0x07))

    def is_usb_hid_keyboard_enabled(self) -> bool:
        return bool(self.get_parameter(0x11))

    def is_character_entry_enabled(self) -> bool:
        return bool(self.get_parameter(0x12))

    def get_key_scan_duration(self) -> int:
        return self.get_parameter(0x14)

    def get_key_debounce_press_duration(self) -> int:
        return self.get_parameter(0x15)

    def get_key_debounce_release_duration(self) -> int:
        return self.get_parameter(0x16)

    def get_keyboard_output_character_microsecond_delays(self) -> int:
        return self.get_parameter(0x17)

    def is_usb_hid_mouse_enabled(self) -> bool:
        return bool(self.get_parameter(0x21))

    def get_slow_mouse_poll_rate(self) -> int:
        return self.get_parameter(0x22)

    def get_fast_mouse_poll_rate(self) -> int:
        return self.get_parameter(0x23)

    def is_active_mouse_enabled(self) -> bool:
        return bool(self.get_parameter(0x24))

    def get_mouse_scroll_speed(self) -> int:
        return self.get_parameter(0x25)

    def get_mouse_poll_duration(self) -> int:
        return self.get_parameter(0x26)

    def is_chording_enabled(self) -> bool:
        return bool(self.get_parameter(0x31))

    def is_chording_character_counter_timeout_enabled(self) -> bool:
        return bool(self.get_parameter(0x32))

    def get_chording_character_counter_timeout_timer(self) -> int:
        return self.get_parameter(0x33)

    def get_chord_detection_press_tolerance(self) -> int:
        return self.get_parameter(0x34)

    def get_chord_detection_release_tolerance(self) -> int:
        return self.get_parameter(0x35)

    def is_spurring_enabled(self) -> bool:
        return bool(self.get_parameter(0x41))

    def is_spurring_character_counter_timeout_enabled(self) -> bool:
        return bool(self.get_parameter(0x42))

    def get_spurring_character_counter_timeout_timer(self) -> int:
        return self.get_parameter(0x43)

    def is_arpeggiates_enabled(self) -> bool:
        return bool(self.get_parameter(0x51))

    def get_arpeggiate_tolerance(self) -> int:
        return self.get_parameter(0x54)

    def is_compound_chording_enabled(self) -> bool:
        return bool(self.get_parameter(0x61))

    def get_compound_tolerance(self) -> int:
        return self.get_parameter(0x64)

    def get_operating_system(self) -> OperatingSystem:
        return OperatingSystem(self.get_parameter(0x91))

    def is_realtime_feedback_enabled(self) -> bool:
        return bool(self.get_parameter(0x92))

    def is_startup_message_enabled(self) -> bool:
        return bool(self.get_parameter(0x93))

    def set_parameter(
        self, code: int, value: int | str, *, commit: bool = False
    ) -> bool:
        """Sets the value of a parameter. Returns a success boolean."""
        success = self._execute("VAR", "B2", hex(code), value)[0]
        if success != "0":
            # Segregate invalid parameter and invalid input errors
            self.get_parameter(code)
            raise InvalidParameterInput(hex(code), value)
        return self._maybe_commit(success, commit)

    def enable_serial_header(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x01, 1), commit)

    def disable_serial_header(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x01, 0), commit)

    def enable_serial_logging(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x02, 1), commit)

    def disable_serial_logging(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x02, 0), commit)

    def enable_serial_debugging(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x03, 1), commit)

    def disable_serial_debugging(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x03, 0), commit)

    def enable_serial_raw(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x04, 1), commit)

    def disable_serial_raw(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x04, 0), commit)

    def enable_serial_chord(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x05, 1), commit)

    def disable_serial_chord(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x05, 0), commit)

    def enable_serial_keyboard(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x06, 1), commit)

    def disable_serial_keyboard(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x06, 0), commit)

    def enable_serial_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x07, 1), commit)

    def disable_serial_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x07, 0), commit)

    def enable_usb_hid_keyboard(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x11, 1), commit)

    def disable_usb_hid_keyboard(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x11, 0), commit)

    def enable_character_entry(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x12, 1), commit)

    def disable_character_entry(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x12, 0), commit)

    def set_key_scan_duration(self, value: int, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x14, value), commit)

    def set_key_debounce_press_duration(
        self, value: int, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x15, value), commit)

    def set_key_debounce_release_duration(
        self, value: int, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x16, value), commit)

    def set_keyboard_output_character_microsecond_delays(
        self, value: int = 480, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x17, value), commit)

    def enable_usb_hid_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x21, 1), commit)

    def disable_usb_hid_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x21, 0), commit)

    def set_slow_mouse_poll_rate(self, value: int = 5, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x22, value), commit)

    def set_fast_mouse_poll_rate(
        self, value: int = 25, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x23, value), commit)

    def enable_active_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x24, 1), commit)

    def disable_active_mouse(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x24, 0), commit)

    def set_mouse_scroll_speed(self, value: int = 1, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x25, value), commit)

    def set_mouse_poll_duration(self, value: int = 20, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x26, value), commit)

    def enable_chording(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x31, 1), commit)

    def disable_chording(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x31, 0), commit)

    def enable_chording_character_counter_timeout(
        self, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x32, 1), commit)

    def disable_chording_character_counter_timeout(
        self, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x32, 0), commit)

    def set_chording_character_counter_timeout_timer(
        self, value: int = 40, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x33, value), commit)

    def set_chord_detection_press_tolerance(
        self, value: int, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x34, value), commit)

    def set_chord_detection_release_tolerance(
        self, value: int, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x35, value), commit)

    def enable_spurring(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x41, 1), commit)

    def disable_spurring(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x41, 0), commit)

    def enable_spurring_character_counter_timeout(
        self, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x42, 1), commit)

    def disable_spurring_character_counter_timeout(
        self, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x42, 0), commit)

    def set_spurring_character_counter_timeout_timer(
        self, value: int = 240, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x43, value), commit)

    def enable_arpeggiates(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x51, 1), commit)

    def disable_arpeggiates(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x51, 0), commit)

    def set_arpeggiate_tolerance(
        self, value: int = 800, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x54, value), commit)

    def enable_compound_chording(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x61, 1), commit)

    def disable_compound_chording(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x61, 0), commit)

    def set_compound_tolerance(
        self, value: int = 1500, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x64, value), commit)

    def set_operating_system(
        self, os: OperatingSystem, *, commit: bool = False
    ) -> bool:
        return self._maybe_commit(self.set_parameter(0x91, hex(os.value)), commit)

    def enable_realtime_feedback(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x92, 1), commit)

    def disable_realtime_feedback(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x92, 0), commit)

    def enable_startup_message(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x93, 1), commit)

    def disable_startup_message(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x93, 0), commit)

    def reset_parameters(self):
        """Resets the parameters to the factory defaults and commits."""
        self._execute("RST", "PARAMS")

    def get_keymap_action(self, keymap: Keymap, index: int) -> int:
        """Returns the action id at a given keymap's index."""
        if issubclass(self.__class__, CharaChorderOne) and index not in range(90):
            raise IndexError("Keymap index out of range. Must be between 0-89")
        if issubclass(self.__class__, CharaChorderLite) and index not in range(67):
            raise IndexError("Keymap index out of range. Must be between 0-66")

        return int(self._execute("VAR", "B3", keymap.value, index)[0])

    def set_keymap_action(
        self, keymap: Keymap, index: int, action_id: int, *, commit: bool = False
    ) -> bool:
        """Sets an action id at the given keymap's index."""
        if issubclass(self.__class__, CharaChorderOne) and index not in range(90):
            raise IndexError("Keymap index out of range. Must be between 0-89")
        if issubclass(self.__class__, CharaChorderLite) and index not in range(67):
            raise IndexError("Keymap index out of range. Must be between 0-66")
        if action_id not in range(8, 2048):
            raise IndexError("Action id out of range. Must be between 8-2047")

        return self._maybe_commit(
            self._execute("VAR", "B4", keymap.value, index, action_id)[0] == "0", commit
        )

    def reset_keymaps(self):
        """Resets the keymaps to the factory defaults and commits."""
        self._execute("RST", "KEYMAPS")

    def restart(self, *, reconnect_timeout: float = 10.0):
        """Restarts the device.

        NOTE: This function blocks until the device is reconnected or the
        timeout is hit.
        """
        try:
            self._execute("RST")
        except serialutil.SerialException:
            self._reconnect(timeout=reconnect_timeout)
        else:
            # This has been recorded in the CC1 M0
            raise RestartFailure

    def factory_reset(self):
        """Performs a factory reset of the flash and emulated eeprom. During the process, the flash chip is erased."""
        self._execute("RST", "FACTORY")

    def enter_bootloader_mode(self):
        """Restarts the device into a bootloader mode."""
        self._execute("RST", "BOOTLOADER")

    def get_available_ram(self) -> int:
        """Returns the current number of bytes available in SRAM."""
        return int(self._execute("RAM")[0])

    def sim(self, subcommand: str, value: str) -> str:
        """Inject a chord or key states to be processed by the device. Useful for debugging."""
        return self._execute("SIM", subcommand, value)[0]


@allowed_product_ids(0x800F)  # M0
class CharaChorderOne(CharaChorder):
    """
    Represents a CharaChorderOne device.

    This class inherits from `charachorder.CharaChorder`.

    Normally, you wouldn't instantiate this class directly instead use
    `CharaChorderOne.list_devices()` to get a list of CharaChorderOne devices
    connected to the system.
    """

    chipset: Literal["M0"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        super().__init__(product_id, vendor_id, port)
        self.chipset = "M0"


@allowed_product_ids(
    0x8253,  # S3
    0x8254,  # S3 - UF2 Bootloader
)
class CharaChorderTwo(CharaChorder):
    """
    Represents a CharaChorderOne device.

    This class inherits from `charachorder.CharaChorder`.

    Normally, you wouldn't instantiate this class directly instead use
    `CharaChorderTwo.list_devices()` to get a list of CharaChorderTwo devices
    connected to the system.
    """

    chipset: Literal["S3"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        super().__init__(product_id, vendor_id, port)
        self.bootloader_mode = self.product_id == 0x8254
        self.chipset = "S3"


@allowed_product_ids(
    0x801C,  # M0
    0x812E,  # S2
    0x812F,  # S2 - UF2 Bootloader
)
class CharaChorderLite(CharaChorder):
    """
    Represents a CharaChorderLite device.

    This class inherits from `charachorder.CharaChorder`.

    Normally, you wouldn't instantiate this class directly instead use
    `CharaChorderLite.list_devices()` to get a list of CharaChorderLite devices
    connected to the system.
    """

    chipset: Literal["M0", "S2"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        super().__init__(product_id, vendor_id, port)
        self.bootloader_mode = self.product_id == 0x812F
        self.chipset = "M0" if self.product_id == 0x801C else "S2"

    def is_gui_ctrl_swapped(self) -> bool:
        return bool(self.get_parameter(0x13))

    def enable_gui_ctrl_swap(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x13, 1), commit)

    def disable_gui_ctrl_swap(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x13, 0), commit)

    def is_led_enabled(self) -> bool:
        return bool(self.get_parameter(0x84))

    def enable_led(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x84, 1), commit)

    def disable_led(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x84, 0), commit)

    def get_led_brightness(self) -> int:
        return self.get_parameter(0x81)

    def set_led_brightness(self, value: int = 5, *, commit: bool = False) -> bool:
        return bool(self._maybe_commit(self.set_parameter(0x81, value), commit))

    def get_led_color_code(self) -> int:
        return self.get_parameter(0x82)

    def set_led_color_code(self, value: int = 5, *, commit: bool = False) -> int:
        return self._maybe_commit(self.set_parameter(0x82, value), commit)

    def is_led_key_highlight_enabled(self) -> bool:
        return bool(self.get_parameter(0x83))

    def enable_led_key_highlight(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x83, 1), commit)

    def disable_led_key_highlight(self, *, commit: bool = False) -> bool:
        return self._maybe_commit(self.set_parameter(0x83, 0), commit)


@allowed_product_ids(
    0x818B,  # S2
    0x818C,  # S2 - UF2 Bootloader
    0x818D,  # S2 Host
    0x818E,  # S2 Host - UF2 Bootloader
)
class CharaChorderX(CharaChorder):
    """
    Represents a CharaChorderX device.

    This class inherits from `charachorder.CharaChorder`.

    Normally, you wouldn't instantiate this class directly instead use
    `CharaChorderX.list_devices()` to get a list of CharaChorderX devices
    connected to the system.
    """

    chipset: Literal["S2"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        super().__init__(product_id, vendor_id, port)
        self.bootloader_mode = self.product_id in (0x818C, 0x818E)
        self.chipset = "S2"


@allowed_product_ids(
    0x8189,  # S2
    0x818A,  # S2 - UF2 Bootloader
)
class CharaChorderEngine(CharaChorder):
    """
    Represents a CharaChorderEngine device.

    This class inherits from `charachorder.CharaChorder`. While this class can
    be used directly, its intended use is to be subclassed because if you have
    a CCEngine, you most likely are building your own device with its own
    functions.

    Normally, you wouldn't instantiate this class directly instead use
    `CharaChorderEngine.list_devices()` to get a list of CharaChorderEngine
    devices connected to the system.
    """

    chipset: Literal["S2"]

    def __init__(self, product_id: int, vendor_id: int, port: str):
        super().__init__(product_id, vendor_id, port)
        self.bootloader_mode = self.product_id == 0x818A
        self.chipset = "S2"