sok-ble 0.1.6__tar.gz → 0.1.9b2__tar.gz

sok_ble-0.1.9b2/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the default location of `.github/workflows`
+    # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
+    directory: "/"
+    schedule:
+      interval: "weekly"

sok_ble-0.1.9b2/.github/workflows/prerelease.yml

@@ -0,0 +1,105 @@
+name: Prerelease
+
+on:
+  pull_request:
+    branches: [main]
+    types: [opened]
+  workflow_dispatch:
+    inputs:
+      release_branch:
+        description: Branch to build from
+        required: false
+        default: release-please--branches--main
+      semantic_version:
+        description: Optional semantic version to publish (x.x.x)
+        required: false
+      prerelease:
+        description: Prerelease type (defaults to beta)
+        required: false
+        type: choice
+        options:
+          - beta
+          - alpha
+      beta_iteration:
+        description: Optional alpha/beta iteration identifier (defaults to run number)
+        required: false
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  publish-beta:
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'pull_request' && startsWith(github.event.pull_request.head.ref, 'release-please--'))
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event_name == 'workflow_dispatch' && (inputs.release_branch || 'release-please--main') || github.event.pull_request.head.ref }}
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Derive beta version
+        id: version
+        env:
+          BETA_ITERATION: ${{ github.event_name == 'workflow_dispatch' && inputs.beta_iteration || '' }}
+          SEMANTIC_VERSION: ${{ github.event_name == 'workflow_dispatch' && inputs.semantic_version || '' }}
+          PRERELEASE_ID: ${{ github.event_name == 'workflow_dispatch' && inputs.prerelease || '' }}
+        run: |
+          python - <<'PY'
+          from pathlib import Path
+          import os
+          import re
+          import sys
+
+          pyproject = Path("pyproject.toml")
+          content = pyproject.read_text(encoding="utf-8")
+
+          match = re.search(r'^version\s*=\s*"(?P<version>[^"]+)"', content, flags=re.MULTILINE)
+          if not match:
+            sys.exit("Version not found in pyproject.toml")
+
+          semver_input = os.environ.get("SEMANTIC_VERSION", "").strip()
+          prerelease_input = os.environ.get("PRERELEASE_ID", "").strip().lower()
+          prerelease_map = {"alpha": "a", "beta": "b", "a": "a", "b": "b"}
+          if prerelease_input and prerelease_input not in prerelease_map:
+            sys.exit("Invalid prerelease identifier. Use 'alpha' or 'beta'.")
+
+          if semver_input:
+            if not re.fullmatch(r"\d+\.\d+\.\d+", semver_input):
+              sys.exit("Invalid semantic version. Use x.x.x format.")
+            base_version = semver_input
+          else:
+            base_version = match.group("version")
+
+          prerelease = prerelease_map.get(prerelease_input, "b")
+          iteration = os.environ.get("BETA_ITERATION") or os.environ.get("GITHUB_RUN_NUMBER")
+          beta_version = f"{base_version}{prerelease}{iteration}"
+
+          new_content = re.sub(
+            r'^version\s*=\s*".*"',
+            f'version = "{beta_version}"',
+            content,
+            count=1,
+            flags=re.MULTILINE,
+          )
+          pyproject.write_text(new_content, encoding="utf-8")
+
+          print(f"Publishing beta version {beta_version}")
+          with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
+            output.write(f"beta_version={beta_version}\n")
+          PY
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish beta to PyPI
+        run: uv publish

sok_ble-0.1.9b2/.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    environment: release
+    outputs:
+      release_created: ${{ steps.release-please.outputs.release_created }}
+      tag_name: ${{ steps.release-please.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release-please
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          config-file: release-please-config.json
+
+  test:
+    uses: ./.github/workflows/test.yml
+
+  release:
+    runs-on: ubuntu-latest
+    environment: release
+    if: ${{ needs.release-please.outputs.release_created == 'true' }}
+    needs:
+      - release-please
+      - test
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload package to PyPI
+        run: uv publish
+
+      - name: Upload Release Artifacts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          for file in dist/*; do
+            gh release upload ${{ needs.release-please.outputs.tag_name }} "$file"
+          done

sok_ble-0.1.9b2/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_call: # Makes this workflow reusable
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    environment: test
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests
+
+      - name: Lint with Ruff
+        run: uv run ruff check . --output-format=github
+
+      - name: Type check with ty
+        run: uv run ty check . --output-format=github

sok_ble-0.1.9b2/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.9"
+}

sok_ble-0.1.9b2/AGENTS.md

@@ -0,0 +1,67 @@
+# Background
+
+sok-ble is a library written in Python. Its purpose is to connect to SOK LiFePO4 batteries over Bluetooth low energy and send and receive modbus commands. sok-ble then parses the responses and returns usable data. The primary intent is for sok-ble to be utilized/wrapped/consumed by sok-ha, a custom integration for Home Assistant; however, sok-ble may be used by any 3rd party and must remain independent of Home Assistant.
+
+# Documentation
+
+- Use Markdown for all documentation
+- Place documentation in the `docs/` directory
+
+# Code Style
+
+- Add comments to code when it may be unclear what the code does or how it functions.
+- Comments should be full sentences and end with a period.
+- Maintainable and understandable code is preferred over complex code. Simplicity is the ultimate complexity!
+
+# Python
+
+- Use uv to manage Python and all python packages
+- Use 'uv add [package_name]' instead of 'uv pip install [package_name]'
+
+# Testing
+
+- Use pytest for Python testing
+- Ensure all code is formatted and linted with Ruff.
+
+# Files
+
+- Do not create binary files, such as Lambda zip files.
+- Do not modify CHANGELOG.md. This is handled by CI.
+
+# Commits
+
+- Use conventional commits for all changes
+  - Prefix all commit messages with fix:; feat:; build:; chore:; ci:; docs:; style:; refactor:; perf:; or test: as appropriate.
+
+# Before Checking In Code
+
+- Fix all code formatting and quality issues in the entire codebase.
+- Ensure all new code is covered by appropriate unit tests.
+
+## Python
+
+Fix all Python formatting and linting issues.
+
+### Steps:
+
+1. **Format with ruff**: `uv run ruff format .`
+2. **Lint with ruff**: `uv run ruff check . --output-format=github`
+3. **Type check with ty**: `uv run ty check . --output-format=github`
+4. **Run unit tests**: `uv run pytest tests`
+
+## General Process:
+
+1. Run automated formatters first.
+2. Fix remaining linting issues manually.
+3. Resolve type checking errors.
+4. Verify all tests pass with no errors.
+5. Review changes before committing.
+
+## Common Issues:
+
+- Import order conflicts between tools
+- Line length violations
+- Unused imports/variables
+- Type annotation requirements
+- Missing return types
+- Inconsistent quotes/semicolons

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/CHANGELOG.md

@@ -1,6 +1,33 @@
 # CHANGELOG
 
 
+## [0.1.9](https://github.com/IAmTheMitchell/sok-ble/compare/v0.1.8...v0.1.9) (2026-02-05)
+
+
+### Documentation
+
+* update AI directives ([afb9309](https://github.com/IAmTheMitchell/sok-ble/commit/afb9309eaa061d9087fc49f74593b1358810307a))
+
+## [0.1.8](https://github.com/IAmTheMitchell/sok-ble/compare/v0.1.7...v0.1.8) (2025-08-03)
+
+
+### Bug Fixes
+
+* fix release ([9257795](https://github.com/IAmTheMitchell/sok-ble/commit/9257795edaa5937371fd3870ae7434a468bbdca2))
+* fix release ([25395a2](https://github.com/IAmTheMitchell/sok-ble/commit/25395a22d35d62516b5ddb5d1be5e944e654cf15))
+
+## [0.1.7](https://github.com/IAmTheMitchell/sok-ble/compare/v0.1.6...v0.1.7) (2025-08-03)
+
+
+### Bug Fixes
+
+* fix bleak import ([e413bb7](https://github.com/IAmTheMitchell/sok-ble/commit/e413bb75ad3e10a73dba08881829e76dc8358d2c))
+
+
+### Documentation
+
+* update CI badges ([a3f4f24](https://github.com/IAmTheMitchell/sok-ble/commit/a3f4f2478dc96a8861820adce5b40eeab1bb581d))
+
 ## v0.1.6 (2025-07-13)
 
 ### Bug Fixes

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sok-ble
-Version: 0.1.6
+Version: 0.1.9b2
 Summary: SOK BLE battery interface library
 Project-URL: Homepage, https://github.com/IAmTheMitchell/sok-ble
 Project-URL: Bug Tracker, https://github.com/IAmTheMitchell/sok-ble/issues
@@ -19,7 +19,8 @@ Description-Content-Type: text/markdown
 
 # SOK BLE
 
-![CI](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/ci.yml/badge.svg)
+![Tests](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/test.yml/badge.svg)
+![Release](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/release.yml/badge.svg)
 
 Python library for interacting with SOK Bluetooth-enabled batteries.
 
@@ -42,5 +43,6 @@ asyncio.run(main())
 ```
 
 ## References
+
 [@zuccaro's comment](https://github.com/Louisvdw/dbus-serialbattery/issues/350#issuecomment-1500658941)
-[Bluetooth-Devices/inkbird-ble](https://github.com/Bluetooth-Devices/inkbird-ble)
+[Bluetooth-Devices/inkbird-ble](https://github.com/Bluetooth-Devices/inkbird-ble)

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/README.md

@@ -1,6 +1,7 @@
 # SOK BLE
 
-![CI](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/ci.yml/badge.svg)
+![Tests](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/test.yml/badge.svg)
+![Release](https://github.com/IAmTheMitchell/sok-ble/actions/workflows/release.yml/badge.svg)
 
 Python library for interacting with SOK Bluetooth-enabled batteries.
 
@@ -23,5 +24,6 @@ asyncio.run(main())
 ```
 
 ## References
+
 [@zuccaro's comment](https://github.com/Louisvdw/dbus-serialbattery/issues/350#issuecomment-1500658941)
-[Bluetooth-Devices/inkbird-ble](https://github.com/Bluetooth-Devices/inkbird-ble)
+[Bluetooth-Devices/inkbird-ble](https://github.com/Bluetooth-Devices/inkbird-ble)

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sok-ble"
-version = "0.1.6"
+version = "0.1.9b2"
 description = "SOK BLE battery interface library"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -24,6 +24,7 @@ dev = [
     "pytest>=7.0.1",
     "pytest-asyncio>=1.0.0",
     "ruff>=0.12.3",
+    "ty>=0.0.15",
 ]
 
 [project.urls]
@@ -35,10 +36,6 @@ dev = [
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.semantic_release]
-branch = "main"
-version_toml = ["pyproject.toml:project.version"]
-
 [tool.ruff]
 line-length = 88
 target-version = "py311"

sok_ble-0.1.9b2/release-please-config.json

@@ -0,0 +1,14 @@
+{
+  "packages": {
+    ".": {
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "python",
+      "include-v-in-tag": true,
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": false,
+      "prerelease": false
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/src/sok_ble/exceptions.py

@@ -8,4 +8,3 @@ class BLEConnectionError(SokError):
 
 class InvalidResponseError(SokError):
     """Raised when an invalid response is received."""
-

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/src/sok_ble/sok_bluetooth_device.py

@@ -10,8 +10,9 @@ from contextlib import asynccontextmanager
 from typing import AsyncIterator, Optional
 
 import async_timeout
-from bleak import BleakError
+from bleak.backends.characteristic import BleakGATTCharacteristic
 from bleak.backends.device import BLEDevice
+from bleak.exc import BleakError
 
 from sok_ble.const import UUID_RX, UUID_TX, _sok_command
 from sok_ble.exceptions import BLEConnectionError
@@ -114,7 +115,7 @@ class SokBluetoothDevice:
 
                 queue: asyncio.Queue[bytes] = asyncio.Queue()
 
-                def handler(_: int, data: bytearray) -> None:
+                def handler(_: BleakGATTCharacteristic, data: bytearray) -> None:
                     queue.put_nowait(bytes(data))
 
                 await client.start_notify(UUID_RX, handler)
@@ -136,6 +137,10 @@ class SokBluetoothDevice:
                     await asyncio.sleep(0.2)
                     continue
                 raise
+        raise BleakError(
+            f"Failed to receive response 0x{expected:04X} "
+            f"from {self._ble_device.address}"
+        )
 
     async def async_update(self) -> None:
         """Poll the device for all telemetry and update attributes."""
@@ -180,13 +185,30 @@ class SokBluetoothDevice:
         parsed = SokParser.parse_all(responses)
         logger.debug("Parsed update: %s", parsed)
 
-        self.voltage = parsed["voltage"]
-        self.current = parsed["current"]
-        self.soc = parsed["soc"]
-        self.temperature = parsed["temperature"]
-        self.capacity = parsed["capacity"]
-        self.num_cycles = parsed["num_cycles"]
-        self.cell_voltages = parsed["cell_voltages"]
+        voltage = parsed.get("voltage")
+        self.voltage = voltage if isinstance(voltage, (int, float)) else None
+
+        current = parsed.get("current")
+        self.current = current if isinstance(current, (int, float)) else None
+
+        soc = parsed.get("soc")
+        self.soc = soc if isinstance(soc, int) else None
+
+        temperature = parsed.get("temperature")
+        self.temperature = (
+            temperature if isinstance(temperature, (int, float)) else None
+        )
+
+        capacity = parsed.get("capacity")
+        self.capacity = capacity if isinstance(capacity, (int, float)) else None
+
+        num_cycles = parsed.get("num_cycles")
+        self.num_cycles = num_cycles if isinstance(num_cycles, int) else None
+
+        cell_voltages = parsed.get("cell_voltages")
+        self.cell_voltages = (
+            list(cell_voltages) if isinstance(cell_voltages, list) else None
+        )
 
         self.num_samples += 1
 

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/src/sok_ble/sok_parser.py

@@ -14,19 +14,20 @@ logger = logging.getLogger(__name__)
 
 # Endian helper functions copied from the reference addon
 
+
 def get_le_short(data: Sequence[int] | bytes | bytearray, offset: int) -> int:
     """Read a little-endian signed short."""
-    return struct.unpack_from('<h', bytes(data), offset)[0]
+    return struct.unpack_from("<h", bytes(data), offset)[0]
 
 
 def get_le_ushort(data: Sequence[int] | bytes | bytearray, offset: int) -> int:
     """Read a little-endian unsigned short."""
-    return struct.unpack_from('<H', bytes(data), offset)[0]
+    return struct.unpack_from("<H", bytes(data), offset)[0]
 
 
 def get_le_int3(data: Sequence[int] | bytes | bytearray, offset: int) -> int:
     """Read a 3-byte little-endian signed integer."""
-    b0, b1, b2 = bytes(data)[offset:offset + 3]
+    b0, b1, b2 = bytes(data)[offset : offset + 3]
     val = b0 | (b1 << 8) | (b2 << 16)
     if val & 0x800000:
         val -= 0x1000000
@@ -35,7 +36,7 @@ def get_le_int3(data: Sequence[int] | bytes | bytearray, offset: int) -> int:
 
 def get_be_uint3(data: Sequence[int] | bytes | bytearray, offset: int) -> int:
     """Read a 3-byte big-endian unsigned integer."""
-    b0, b1, b2 = bytes(data)[offset:offset + 3]
+    b0, b1, b2 = bytes(data)[offset : offset + 3]
     return (b0 << 16) | (b1 << 8) | b2
 
 

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/tests/test_derived.py

@@ -26,4 +26,3 @@ def test_cell_voltage_stats():
     assert dev.cell_voltage_delta == pytest.approx(0.15)
     assert dev.cell_index_max == 3
     assert dev.cell_index_min == 2
-

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/tests/test_exceptions.py

@@ -16,4 +16,3 @@ def test_raises_ble_connection_error():
 def test_raises_invalid_response_error():
     with pytest.raises(InvalidResponseError):
         raise InvalidResponseError()
-

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/tests/test_parser_full.py

@@ -4,18 +4,10 @@ from sok_ble.sok_parser import SokParser
 
 
 def test_parse_all():
-    info_buf = bytes.fromhex(
-        "ccf0000000102700000000000000320041000000"
-    )
-    temp_buf = bytes.fromhex(
-        "ccf2000000140000000000000000000000000000"
-    )
-    cap_buf = bytes.fromhex(
-        "ccf3000000003200000000000000000000000000"
-    )
-    cell_buf = bytes.fromhex(
-        "ccf401c50c0002c60c0003bf0c0004c00c000000"
-    )
+    info_buf = bytes.fromhex("ccf0000000102700000000000000320041000000")
+    temp_buf = bytes.fromhex("ccf2000000140000000000000000000000000000")
+    cap_buf = bytes.fromhex("ccf3000000003200000000000000000000000000")
+    cell_buf = bytes.fromhex("ccf401c50c0002c60c0003bf0c0004c00c000000")
 
     responses = {
         0xCCF0: info_buf,
@@ -34,4 +26,3 @@ def test_parse_all():
         "num_cycles": 50,
         "cell_voltages": [3.269, 3.27, 3.263, 3.264],
     }
-

{sok_ble-0.1.6 → sok_ble-0.1.9b2}/tests/test_parser_info.py

@@ -2,9 +2,7 @@ from sok_ble.sok_parser import SokParser
 
 
 def test_parse_info_basic():
-    hex_data = bytes.fromhex(
-        "ccf0000000102700000000000000320041000000"
-    )
+    hex_data = bytes.fromhex("ccf0000000102700000000000000320041000000")
     result = SokParser.parse_info(hex_data)
     assert result == {
         "current": 10.0,