sok-ble 0.1.5__tar.gz → 0.1.8__tar.gz

{sok_ble-0.1.5 → sok_ble-0.1.8}/.github/copilot-instructions.md

@@ -1,22 +1,34 @@
 # 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.
-    
+
+- Use conventional commits for all changes
+  - Prefix all commit messages with fix:; feat:; build:; chore:; ci:; docs:; style:; refactor:; perf:; or test: as appropriate.

sok_ble-0.1.8/.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.8/.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@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - 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.8/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+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"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        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

sok_ble-0.1.8/.release-please-manifest.json

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

sok_ble-0.1.8/AGENTS.md

@@ -0,0 +1,35 @@
+# Basic Instructions
+
+- Follow all instructions in the .github/copilot-instructions.md file.
+
+# 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:
+
+2. **Format with ruff**: `uv run ruff format .`
+3. **Lint with ruff**: `uv run ruff 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 tools 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.5 → sok_ble-0.1.8}/CHANGELOG.md

@@ -1,6 +1,34 @@
 # CHANGELOG
 
 
+## [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
+
+- Prevent reconnect loop in async context
+  ([`688d298`](https://github.com/IAmTheMitchell/sok-ble/commit/688d29874cb09c2ea40df818d07122d1bad32141))
+
+
 ## v0.1.5 (2025-07-13)
 
 ### Bug Fixes

{sok_ble-0.1.5 → sok_ble-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sok-ble
-Version: 0.1.5
+Version: 0.1.8
 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.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sok-ble"
-version = "0.1.5"
+version = "0.1.8"
 description = "SOK BLE battery interface library"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -35,10 +35,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.8/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.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/src/sok_ble/sok_bluetooth_device.py

@@ -10,8 +10,8 @@ from contextlib import asynccontextmanager
 from typing import AsyncIterator, Optional
 
 import async_timeout
-from bleak import BleakError
 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
@@ -26,6 +26,7 @@ try:
     )
 except Exception:  # pragma: no cover - optional dependency
     from bleak import BleakClient as BleakClientWithServiceCache
+
     establish_connection = None  # type: ignore[misc]
 
 
@@ -54,6 +55,8 @@ class SokBluetoothDevice:
         """Connect to the device and yield a BLE client."""
         logger.debug("Connecting to %s", self._ble_device.address)
         last_err: Exception | None = None
+        client: BleakClientWithServiceCache | None = None
+
         for attempt in range(3):
             try:
                 if establish_connection:
@@ -65,7 +68,8 @@ class SokBluetoothDevice:
                     )
                 else:
                     client = BleakClientWithServiceCache(
-                        self._ble_device, adapter=self._adapter
+                        self._ble_device,
+                        adapter=self._adapter,
                     )
                     await client.connect()
 
@@ -73,15 +77,7 @@ class SokBluetoothDevice:
                 async with async_timeout.timeout(5):
                     _ = client.services
                 await asyncio.sleep(0.15)
-
-                try:
-                    yield client
-                finally:
-                    await client.disconnect()
-                    logger.debug(
-                        "Disconnected from %s", self._ble_device.address
-                    )
-                return
+                break
             except (BleakError, asyncio.TimeoutError) as err:
                 last_err = err
                 logger.debug(
@@ -91,10 +87,17 @@ class SokBluetoothDevice:
                     err,
                 )
                 await asyncio.sleep(0.5)
-
-        raise BLEConnectionError(
-            f"Unable to establish GATT connection to {self._ble_device.address}"
-        ) from last_err
+        else:
+            raise BLEConnectionError(
+                f"Unable to establish GATT connection to {self._ble_device.address}"
+            ) from last_err
+
+        assert client is not None
+        try:
+            yield client
+        finally:
+            await client.disconnect()
+            logger.debug("Disconnected from %s", self._ble_device.address)
 
     async def _send_command(
         self, client: BleakClientWithServiceCache, cmd: int, expected: int

{sok_ble-0.1.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/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.5 → sok_ble-0.1.8}/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,

{sok_ble-0.1.5 → sok_ble-0.1.8}/uv.lock

@@ -276,7 +276,7 @@ wheels = [
 
 [[package]]
 name = "sok-ble"
-version = "0.1.4"
+version = "0.1.6"
 source = { editable = "." }
 dependencies = [
     { name = "async-timeout" },

sok_ble-0.1.5/.github/workflows/ci.yml

@@ -1,84 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-concurrency:
-  group: ${{ github.head_ref || github.run_id }}
-  cancel-in-progress: true
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version:
-          - "3.11"
-          - "3.12"
-          - "3.13"
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v5
-        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
-
-  release:
-    runs-on: ubuntu-latest
-    environment: release
-    if: github.ref == 'refs/heads/main'
-    needs:
-      - test
-    permissions:
-      id-token: write
-      contents: write
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-
-      - name: Set up Python
-        run: uv python install
-
-      - name: Python Semantic Release
-        id: release
-        uses: python-semantic-release/python-semantic-release@v9.21.0
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build package
-        run: uv build
-
-      - name: Upload package to PyPI
-        run: uv publish
-        if: steps.release.outputs.released == 'true'
-
-      - name: Upload Github Release Assets
-        uses: python-semantic-release/publish-action@v9.21.0
-        if: steps.release.outputs.released == 'true'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          tag: ${{ steps.release.outputs.tag }}
-

sok_ble-0.1.5/AGENTS.md

@@ -1,3 +0,0 @@
-# Basic Instructions
-
-- Follow all instructions in the .github/copilot-instructions.md file.