python-rockbox 0.1.0__tar.gz

python_rockbox-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.3
+Name: python-rockbox
+Version: 0.1.0
+Summary: Create and manipulate WPS tags from Python
+Author: Stormy
+Author-email: Stormy <oohstormy@gmail.com>
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# python-rockbox
+
+Create and manipulate WPS tags from Python
+
+### Currently supported:
+* All tags from Rockbox 4.0 (via `Tags` class)
+* Tags (`Tag` class)
+* Conditionals (`Match` class)
+
+## Example
+
+This conditional that displays an appropriate battery bitmap:
+```py
+wps = Match(
+    Tags.IS_CHARGING,
+    [
+        Tag(Tags.DISPLAY_IMAGE, "A"),
+        Match(
+            Tags.BATTERY_PERCENTAGE,
+            [
+                Tag(Tags.DISPLAY_IMAGE, "B"),
+                Tag(Tags.DISPLAY_IMAGE, "C"),
+                Tag(Tags.DISPLAY_IMAGE, "D"),
+                Tag(Tags.DISPLAY_IMAGE, "E"),
+                Tag(Tags.DISPLAY_IMAGE, "F"),
+            ],
+        ),
+    ],
+)
+```
+
+Would `__repr__` to:
+```c
+%?bp<%xd(A)|%?bl<%xd(B)|%xd(C)|%xd(D)|%xd(E)|%xd(F)>>
+```
+
+## Install
+
+To install locally, make sure you have the following installed:
+* A modern version of Python 3 (I target 3.14)
+* git
+* pip
+
+First, clone the repository:
+```sh
+git clone https://git.0stormy.xyz/stormy/python-rockbox.git
+```
+
+Next, change directories into the folder you just cloned:
+```sh
+cd python-rockbox
+```
+
+Finally, install it locally with:
+```sh
+pip install -e .
+```

python_rockbox-0.1.0/README.md

@@ -0,0 +1,57 @@
+# python-rockbox
+
+Create and manipulate WPS tags from Python
+
+### Currently supported:
+* All tags from Rockbox 4.0 (via `Tags` class)
+* Tags (`Tag` class)
+* Conditionals (`Match` class)
+
+## Example
+
+This conditional that displays an appropriate battery bitmap:
+```py
+wps = Match(
+    Tags.IS_CHARGING,
+    [
+        Tag(Tags.DISPLAY_IMAGE, "A"),
+        Match(
+            Tags.BATTERY_PERCENTAGE,
+            [
+                Tag(Tags.DISPLAY_IMAGE, "B"),
+                Tag(Tags.DISPLAY_IMAGE, "C"),
+                Tag(Tags.DISPLAY_IMAGE, "D"),
+                Tag(Tags.DISPLAY_IMAGE, "E"),
+                Tag(Tags.DISPLAY_IMAGE, "F"),
+            ],
+        ),
+    ],
+)
+```
+
+Would `__repr__` to:
+```c
+%?bp<%xd(A)|%?bl<%xd(B)|%xd(C)|%xd(D)|%xd(E)|%xd(F)>>
+```
+
+## Install
+
+To install locally, make sure you have the following installed:
+* A modern version of Python 3 (I target 3.14)
+* git
+* pip
+
+First, clone the repository:
+```sh
+git clone https://git.0stormy.xyz/stormy/python-rockbox.git
+```
+
+Next, change directories into the folder you just cloned:
+```sh
+cd python-rockbox
+```
+
+Finally, install it locally with:
+```sh
+pip install -e .
+```

python_rockbox-0.1.0/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "python-rockbox"
+version = "0.1.0"
+description = "Create and manipulate WPS tags from Python"
+readme = "README.md"
+authors = [
+    { name = "Stormy", email = "oohstormy@gmail.com" }
+]
+requires-python = ">=3.14"
+dependencies = []
+
+[build-system]
+requires = ["uv_build>=0.11.25,<0.12.0"]
+build-backend = "uv_build"

python_rockbox-0.1.0/src/python_rockbox/__init__.py

@@ -0,0 +1,4 @@
+from .wps import Tag, Match, Color
+from .tags import Tags
+
+__all__ = ["Tag", "Tags", "Match", "Color"]

python_rockbox-0.1.0/src/python_rockbox/tags.py

@@ -0,0 +1,226 @@
+from enum import Enum
+
+
+class Tags(Enum):
+    """
+    All WPS tags from Rockbox 4.0 represented as enums.
+
+    Tag enums are ordered and sectioned by position in manual.
+    """
+
+    # Status Bar (D.1)
+    DISPLAY_STATUSBAR = "we"
+    HIDE_STATUSBAR = "wd"
+    INBUILT_STATUSBAR = "wi"
+
+    # Hardware (D.2)
+    HAS_CLOCK = "cc"
+    HAS_RADIO = "tp"
+    HAS_TOUCHSCREEN = "Tp"
+
+    # Metadata (D.3)
+    ARTIST_NAME = "ia"
+    COMPOSER_NAME = "ic"
+    ALBUM_ARTIST = "iA"
+    ALBUM_NAME = "id"
+    GROUPING = "iG"
+    TRACK_NUMBER = "in"
+    TRACK_TITLE = "it"
+    SONG_COMMENT = "iC"
+    ID3_VERSION = "iv"
+    SONG_YEAR = "iy"
+    DISC_NUMBER = "ik"
+
+    # Viewports (D.4)
+    VIEWPORT = "V"
+    VIEWPORT_FG = "Vf"
+    VIEWPORT_BG = "Vb"
+    VIEWPORT_STYLE = "Vs"
+    PRELOAD_VIEWPORT = "Vl"
+    DISPLAY_VIEWPORT = "Vd"
+    UI_VIEWPORT = "Vi"
+    INFO_VIEWPORT = "VI"
+    VIEWPORT_ON_BACKDROP = "VB"
+
+    # Fonts (D.5)
+    DEFINE_FONT = "Fl"
+
+    # Coloring Tags (D.6)
+    DRAW_RECTANGLE = "dr"
+
+    # Power (D.7)
+    BATTERY_PERCENTAGE = "bl"
+    BATTERY_VOLTS = "bv"
+    BATTERY_TIME = "bt"
+    IS_CHARGING = "bp"
+    CHARGING_BATTERY = "bc"
+    SLEEP_TIMER = "bs"
+
+    # File Information (D.8)
+    FILE_BITRATE = "fb"
+    FILE_CODEC = "fc"
+    FILE_FREQUENCY_HZ = "ff"
+    FILE_FREQUENCY_KHZ = "fk"
+    FILE_NAME_EXTENSION = "fm"
+    FILE_NAME = "fn"
+    FILE_PATH = "fp"
+    FILE_SIZE = "fs"
+    AVERAGE_BITRATE = "fv"
+    SEGMENT_FROM_END = "d"
+
+    # Playlist/Song (D.9)
+    PROGRESS_BAR = "pb"
+    SONG_PERCENTAGE = "px"
+    SONG_TIME = "pc"
+    PLAYLIST_ENTRIES = "pe"
+    PEAK_METER = "pm"
+    PEAK_LEFT_CHANNEL = "pL"
+    PEAK_RIGHT_CHANNEL = "pR"
+    PLAYLIST_NAME = "pn"
+    PLAYLIST_POSITION = "pp"
+    PLAYLIST_PERCENTAGE = "pP"
+    SONG_TIME_REMAINING = "pr"
+    IS_SHUFFLE = "ps"
+    TOTAL_TRACK_TIME = "pt"
+    VOLUME = "pv"
+    TRACK_STARTING = "pS"
+    TRACK_ENDING = "pE"
+
+    # Playlist Viewer (D.10)
+    PLAYLIST_VIEWPORT = "Vp"
+
+    # Runtime Database (D.11)
+    SONG_PLAYCOUNT = "rp"
+    SONG_RATING = "rr"
+    SONG_AUTOSCORE = "ra"
+
+    # Sound/DSP Settings (D.12)
+    PLAYBACK_PITCH = "Sp"
+    CROSSFADE_SETTING = "xf"
+    REPLAYGAIN_VALUE = "rg"
+
+    # Hold (D.13)
+    IS_HOLD_SWITCH = "mh"
+
+    # Virtual LED (D.14)
+    IS_HARDDISK = "lh"
+
+    # Repeat Mode (D.15)
+    REPEAT_MODE = "mm"
+
+    # Playback Mode (D.16)
+    PLAYBACK_STATUS = "mp"
+
+    # Current Screen (D.17)
+    CURRENT_SCREEN = "cs"
+
+    # List Title (D.18)
+    TITLE_TEXT = "Lt"
+    TITLE_ICON = "Li"
+
+    # List Skinning (D.19)
+    CURRENT_ITEM_TEXT = "LT"
+    CURRENT_ITEM_ICON = "LI"
+    CURRENT_ITEM_INDEX = "LN"
+    ITEM_ROW_NUMBER = "LR"
+    ITEM_COLUMN_NUMBER = "LC"
+    ITEM_IS_SELECTED = "Lc"
+    SCROLL_BAR_TAG = "LB"
+    VIEWPORT_ITEM_DRAW = "Lb"
+
+    # Changing Volume (D.20)
+    IS_VOLUME_CHANGING = "mv"
+
+    # Settings (D.21)
+    SETTING_VALUE = "St"
+    QUICKSCREEN_TOP_NAME = "QT"
+    QUICKSCREEN_TOP_VALUE = "Qt"
+    QUICKSCREEN_RIGHT_NAME = "QR"
+    QUICKSCREEN_RIGHT_VALUE = "Qr"
+    QUICKSCREEN_BOTTOM_NAME = "QB"
+    QUICKSCREEN_BOTTOM_VALUE = "Qb"
+    QUICKSCREEN_LEFT_NAME = "QL"
+    QUICKSCREEN_LEFT_VALUE = "Ql"
+
+    # Images (D.22):
+    BACKDROP_IMAGE = "X"
+    IMAGE = "x"
+    PRELOAD_IMAGE = "xl"
+    DISPLAY_IMAGE = "xd"
+    NINE_PATCH_IMAGE = "x9"
+    ALBUM_ART_SETTINGS = "Cl"
+    DISPLAY_ALBUM_ART = "Cd"
+    IS_ALBUM_ART = "C"
+
+    # FM Radio (D.23)
+    TUNER_TUNED = "tt"
+    FM_SCAN_OR_PRESET = "tm"
+    IS_FM_STEREO = "ts"
+    MINIMUM_FREQUENCY = "ta"
+    MAXIMUM_FREQUENCY = "tb"
+    CURRENT_FREQUENCY_MHZ = "tf"
+    CURRENT_PRESET_ID = "Ti"
+    CURRENT_PRESET_FREQUENCY = "Tf"
+    PRESET_COUNTT = "Tc"
+    IS_RDS = "tx"
+    RDS_NAME = "ty"
+    RDS_TEXT = "tz"
+    FM_SIGNAL_STRENGTH = "tr"
+
+    # Alignment (D.24)
+    ALIGN_LEFT = "al"
+    ALIGN_START = "aL"
+    ALIGN_CENTER = "ac"
+    ALIGN_RIGHT = "ar"
+    ALIGN_END = "aR"
+    NEXT_TAG_DIRECTION = "ax"
+    DEFINE_ALIGN_OPTIONS = "Sr"
+
+    # Conditional Tags (D.25)
+    IF = "if"
+    AND = "and"
+    OR = "or"
+
+    # Sublime Tags (D.26)
+    SUBLIME_DISPLAY_CYCLE_TIME = "t"
+
+    # Time and Date (D.27)
+    DAY_OF_MONTH = "cd"
+    ZERO_PADDED_MONTH_DAY = "ce"
+    TIME_FORMAT = "cf"
+    ZERO_PADDED_24_HOUR = "cH"
+    NORMAL_24_HOUR = "ck"
+    ZERO_PADDED_12_HOUR = "cI"
+    NORMAL_12_HOUR = "cl"
+    MONTH_OF_YEAR = "cm"
+    MINUTES = "cM"
+    SECONDS = "cS"
+    YEAR_2_DIGIT = "cy"
+    YEAR_4_DIGIT = "cY"
+    CAPITAL_AM_PM = "cP"
+    AM_PM = "cp"
+    WEEKDAY = "ca"
+    MONTH = "cb"
+    DAY_OF_WEEK_1_INDEX = "cu"
+    DAY_OF_WEEK_0_INDEX = "cw"
+
+    # Text Translation (D.28)
+    TRANSLATION = "Sx"
+
+    # Bar Tags (D.29)
+    DRAW_AS_BAR = "XX"
+
+    # Misc. Tags (D.30)
+    TAG_SUBSTRING = "ss"
+    READ_LINE_FILE = "ft"
+    LEFT_PARENTHESIS = "("
+    RIGHT_PARENTHESIS = ")"
+    COMMA = ","
+    PERCENT_SIGN = "%"
+    LEFT_THAN = "<"
+    PIPE = "|"
+    GREATER_THAN = ">"
+    SEMICOLON = ";"
+    HASHTAG = "#"
+    POUND = "#"
+    LINE_SHOULD_SCROLL = "s"

python_rockbox-0.1.0/src/python_rockbox/wps.py

@@ -0,0 +1,77 @@
+from .tags import Tags
+
+
+class Color:
+    def __init__(self, color: str) -> None:
+        """Rockbox formatted RGB Hex color code"""
+        self.color = self.normalize_color(color)
+
+    @staticmethod
+    def normalize_color(color: str) -> str:
+        """Normalizes hex color to Rockbox format"""
+        color = color.upper().removeprefix("#")
+
+        # Convert to 6 character hex code if needed
+        if len(color) == 3:
+            color = "".join(c * 2 for c in color)
+        return color
+
+    def __str__(self) -> str:
+        return self.color
+
+    def __repr__(self) -> str:
+        return self.color
+
+
+class Tag:
+    def __init__(self, tag: Tag | Tags | str, *args) -> None:
+        """
+        Class representation of a Rockbox WPS tag.
+
+        Ex: `Tag(Tags.DISPLAY_IMAGE, "X")` = `%xd(X)`
+        """
+        if isinstance(tag, Tag):
+            self.tag: str = tag.tag
+            self.arguments: tuple = tag.arguments
+        else:
+            if isinstance(tag, Tags):
+                self.tag: str = tag.value
+            else:
+                self.tag: str = tag
+            self.arguments: tuple = args
+
+    def render_simple_tag(self) -> str:
+        """Renders a tag with no arguments"""
+        return f"%{self.tag}"
+
+    def render_argument_tag(self) -> str:
+        """Renders a tag that has arguments"""
+        rendered_args = ", ".join(map(str, self.arguments))
+        return f"%{self.tag}({rendered_args})"
+
+    def __repr__(self) -> str:
+        if self.arguments:
+            return self.render_argument_tag()
+        else:
+            return self.render_simple_tag()
+
+
+class Match:
+    def __init__(
+        self, tag: Tag | Tags | str, cases: list[Tag | Match]
+    ) -> None:
+        """Class representation of Rockbox WPS conditional"""
+        if isinstance(tag, Tags):
+            self.tag: Tag = Tag(tag.value)
+        else:
+            self.tag: Tag = Tag(tag)
+        self.cases: list[Tag | Match] = cases
+
+    def _render_match(self) -> str:
+        rendered_cases: list = []
+        for case in self.cases:
+            rendered_cases.append(case.__repr__())
+        return f"%?{self.tag.tag}<{"|".join(rendered_cases)}>"
+
+    def __repr__(self) -> str:
+        return self._render_match()