okokscale 0.0.1__tar.gz

okokscale-0.0.1/.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github: [rrooggiieerr]
+patreon: seekingtheedge
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: rrooggiieerr
+custom: ['https://paypal.me/seekingtheedge']

okokscale-0.0.1/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

okokscale-0.0.1/.github/workflows/check-format.yml

@@ -0,0 +1,20 @@
+name: Check Python code format
+
+on: [push]
+
+jobs:
+  linter_name:
+    name: runner / isort & black formatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - name: Check files using the isort import sorter
+        uses: isort/isort-action@v1
+        with:
+          configuration: "--profile black --check-only"
+          requirements-files: "requirements.txt"
+      - name: Check files using the black formatter
+        uses: psf/black@stable
+        with:
+          options: "--check"
+          src: "."

okokscale-0.0.1/.github/workflows/pypi-publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write   # required for OIDC
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        print-hash: true

okokscale-0.0.1/.github/workflows/stale.yaml

@@ -0,0 +1,44 @@
+---
+name: Stale
+
+# yamllint disable-line rule:truthy
+on:
+  schedule:
+    - cron: "0 8 * * *"
+  workflow_dispatch:
+
+jobs:
+  stale:
+    name: 🧹 Clean up stale issues and PRs
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+      issues: write
+      pull-requests: write
+    steps:
+      - name: 🚀 Run stale
+        uses: actions/stale@v10.3.0
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          days-before-stale: 30
+          days-before-close: 7
+          remove-stale-when-updated: true
+          stale-issue-label: "stale"
+          exempt-issue-labels: "no-stale,help-wanted"
+          stale-issue-message: >
+            There hasn't been any activity on this issue recently, so we
+            clean up some of the older and inactive issues.
+
+            Please make sure to update to the latest version and
+            check if that solves the issue. Let us know if that works for you
+            by leaving a comment 👍
+
+            This issue has now been marked as stale and will be closed if no
+            further activity occurs. Thanks!
+          stale-pr-label: "stale"
+          exempt-pr-labels: "no-stale"
+          stale-pr-message: >
+            There hasn't been any activity on this pull request recently. This
+            pull request has been automatically marked as stale because of that
+            and will be closed if no further activity occurs within 7 days.
+            Thank you for your contributions.

okokscale-0.0.1/.gitignore

@@ -0,0 +1 @@
+*/_version.py

okokscale-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

okokscale-0.0.1/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: okokscale
+Version: 0.0.1
+Summary: Library for parsing OKOK scale BLE advertisements.
+Project-URL: Homepage, https://github.com/rrooggiieerr/okokscale.py
+Project-URL: Bug Tracker, https://github.com/rrooggiieerr/okokscale.py/issues
+Author-email: Rogier van Staveren <rogier@batoid.com>
+License: Apache-2.0
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: bleak>=3.0.2
+Requires-Dist: bluetooth-sensor-state-data==1.9.0
+Description-Content-Type: text/markdown
+
+# Python library for parsing OKOK scale BLE advertisements.
+
+![Python][python-shield]
+[![GitHub Release][releases-shield]][releases]
+[![Licence][license-shield]][license]
+[![Maintainer][maintainer-shield]][maintainer]  
+[![GitHub Sponsors][github-shield]][github]
+[![PayPal][paypal-shield]][paypal]
+[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
+[![Patreon][patreon-shield]][patreon]
+
+## Introduction
+
+A Python library for parsing the BLE advertisements of OKOK scales which can be used with the
+*OKOK international* app and identify themselves on Bluetooth as *Chipsea-BLE*.
+
+## Supported scales
+
+The following scale is known to work:
+
+* Tristar WG-2440
+
+Please let me know if your scale works with this library so I can improve the overview of supported
+scales.
+
+## Installation
+
+To install the Python OKOK scale library use the Package Installer for Python PIP:
+
+`pip3 install okokscale`
+
+## Contribution and appreciation
+
+Do you enjoy using this Python library? You can contribute or show your appreciation, in the
+following ways.
+
+### Contribute your scale brand and model
+
+Is your scale supported by this Python library but not listed under *Supported scales*? Let me know
+your scale brand and model so I can improve the overview of supported scales.
+
+### Star this GitHub page
+Help other OKOK scale users find this Python library by starring this GitHub page. Click ⭐ Star on
+the top right of the GitHub page.
+
+### Support my work
+
+Please consider supporting my work through one of the following platforms. Your contribution is
+greatly appreciated and keeps me motivated:
+
+[![GitHub Sponsors][github-shield]][github]
+[![PayPal][paypal-shield]][paypal]
+[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
+[![Patreon][patreon-shield]][patreon]
+
+### Hire me
+
+If you're in need for a freelance Python developer for your project please contact me, you can find
+my email address on [my GitHub profile](https://github.com/rrooggiieerr).
+
+[python-shield]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
+[releases]: https://github.com/rrooggiieerr/okokscale.py/releases
+[releases-shield]: https://img.shields.io/github/v/release/rrooggiieerr/okokscale.py?style=for-the-badge
+[license]: ./LICENSE
+[license-shield]: https://img.shields.io/github/license/rrooggiieerr/okokscale.py?style=for-the-badge
+[maintainer]: https://github.com/rrooggiieerr
+[maintainer-shield]: https://img.shields.io/badge/MAINTAINER-%40rrooggiieerr-41BDF5?style=for-the-badge
+[paypal]: https://paypal.me/seekingtheedge
+[paypal-shield]: https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white
+[buymecoffee]: https://www.buymeacoffee.com/rrooggiieerr
+[buymecoffee-shield]: https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
+[github]: https://github.com/sponsors/rrooggiieerr
+[github-shield]: https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=ea4aaa
+[patreon]: https://www.patreon.com/seekingtheedge/creators
+[patreon-shield]: https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white

okokscale-0.0.1/README.md

@@ -0,0 +1,75 @@
+# Python library for parsing OKOK scale BLE advertisements.
+
+![Python][python-shield]
+[![GitHub Release][releases-shield]][releases]
+[![Licence][license-shield]][license]
+[![Maintainer][maintainer-shield]][maintainer]  
+[![GitHub Sponsors][github-shield]][github]
+[![PayPal][paypal-shield]][paypal]
+[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
+[![Patreon][patreon-shield]][patreon]
+
+## Introduction
+
+A Python library for parsing the BLE advertisements of OKOK scales which can be used with the
+*OKOK international* app and identify themselves on Bluetooth as *Chipsea-BLE*.
+
+## Supported scales
+
+The following scale is known to work:
+
+* Tristar WG-2440
+
+Please let me know if your scale works with this library so I can improve the overview of supported
+scales.
+
+## Installation
+
+To install the Python OKOK scale library use the Package Installer for Python PIP:
+
+`pip3 install okokscale`
+
+## Contribution and appreciation
+
+Do you enjoy using this Python library? You can contribute or show your appreciation, in the
+following ways.
+
+### Contribute your scale brand and model
+
+Is your scale supported by this Python library but not listed under *Supported scales*? Let me know
+your scale brand and model so I can improve the overview of supported scales.
+
+### Star this GitHub page
+Help other OKOK scale users find this Python library by starring this GitHub page. Click ⭐ Star on
+the top right of the GitHub page.
+
+### Support my work
+
+Please consider supporting my work through one of the following platforms. Your contribution is
+greatly appreciated and keeps me motivated:
+
+[![GitHub Sponsors][github-shield]][github]
+[![PayPal][paypal-shield]][paypal]
+[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
+[![Patreon][patreon-shield]][patreon]
+
+### Hire me
+
+If you're in need for a freelance Python developer for your project please contact me, you can find
+my email address on [my GitHub profile](https://github.com/rrooggiieerr).
+
+[python-shield]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54
+[releases]: https://github.com/rrooggiieerr/okokscale.py/releases
+[releases-shield]: https://img.shields.io/github/v/release/rrooggiieerr/okokscale.py?style=for-the-badge
+[license]: ./LICENSE
+[license-shield]: https://img.shields.io/github/license/rrooggiieerr/okokscale.py?style=for-the-badge
+[maintainer]: https://github.com/rrooggiieerr
+[maintainer-shield]: https://img.shields.io/badge/MAINTAINER-%40rrooggiieerr-41BDF5?style=for-the-badge
+[paypal]: https://paypal.me/seekingtheedge
+[paypal-shield]: https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white
+[buymecoffee]: https://www.buymeacoffee.com/rrooggiieerr
+[buymecoffee-shield]: https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
+[github]: https://github.com/sponsors/rrooggiieerr
+[github-shield]: https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=ea4aaa
+[patreon]: https://www.patreon.com/seekingtheedge/creators
+[patreon-shield]: https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white

okokscale-0.0.1/okokscale/__init__.py

@@ -0,0 +1,3 @@
+"""
+Parser for OKOK scale BLE advertisements.
+"""

okokscale-0.0.1/okokscale/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None

okokscale-0.0.1/okokscale/parser.py

@@ -0,0 +1,455 @@
+"""
+Parser for OKOK scale BLE advertisements.
+"""
+
+import logging
+
+from bleak import AdvertisementData, BleakClient, BLEDevice
+from bleak_retry_connector import BleakClientWithServiceCache, establish_connection
+from bluetooth_data_tools import human_readable_name
+from bluetooth_sensor_state_data import BluetoothData
+from home_assistant_bluetooth import BluetoothServiceInfo
+from sensor_state_data import SensorDeviceClass, SensorLibrary, SensorUpdate, Units
+
+UPDATE_INTERVAL_SECONDS = 60 * 60 * 24  # 1 day
+
+_LOGGER = logging.getLogger(__name__)
+
+
+# "00002a29-0000-1000-8000-00805f9b34fb" #(Handle: 11): Manufacturer Name String
+CHARACTERISTIC_MODEL_NUMBER = (
+    "00002a24-0000-1000-8000-00805f9b34fb"  # (Handle: 13): Model Number String
+)
+# "00002a25-0000-1000-8000-00805f9b34fb" #(Handle: 15): Serial Number String
+# "00002a26-0000-1000-8000-00805f9b34fb" #(Handle: 17): Firmware Revision String
+# "00002a27-0000-1000-8000-00805f9b34fb" #(Handle: 19): Hardware Revision String
+# "0000fff1-0000-1000-8000-00805f9b34fb" #(Handle: 22): Vendor specific
+# "0000fff2-0000-1000-8000-00805f9b34fb" #(Handle: 25): Vendor specific
+CHARACTERISTIC_BODY_COMPOSITION = (
+    "00002a9c-0000-1000-8000-00805f9b34fb"  # (Handle: 28): Body Composition Measurement
+)
+# "0000fa9c-0000-1000-8000-00805f9b34fb" #(Handle: 31): Vendor specific
+CHARACTERISTIC_BATTERY_LEVEL = (
+    "00002a19-0000-1000-8000-00805f9b34fb"  # (Handle: 35): Battery Level
+)
+# "00002a08-0000-1000-8000-00805f9b34fb" #(Handle: 39): Date Time
+# "0000faa1-0000-1000-8000-00805f9b34fb" #(Handle: 43): Vendor specific
+# "0000faa2-0000-1000-8000-00805f9b34fb" #(Handle: 45): Vendor specific
+
+MANUFACTURER_DATA_ID_V10 = 0x10FF  # 16-bit little endian "header" 0xff 0x10
+MANUFACTURER_DATA_ID_V11 = 0x11CA  # 16-bit little endian "header" 0xca 0x11
+MANUFACTURER_DATA_ID_V20 = 0x20CA  # 16-bit little endian "header" 0xca 0x20
+MANUFACTURER_DATA_ID_V26 = 0x26C0  # 16-bit little endian "header" 0xc0 0x26
+MANUFACTURER_DATA_ID_VC0 = 0xC0  # 8-bit little endian "header" 0xc0
+MANUFACTURER_DATA_ID_VF0 = 0xF0FF  # 16-bit little endian "header" 0xff 0xf0
+
+IDX_V10_WEIGHT_MSB = 3
+IDX_V10_WEIGHT_LSB = 2
+
+IDX_V11_FINAL = 1
+IDX_V11_WEIGHT_MSB = 3
+IDX_V11_WEIGHT_LSB = 4
+IDX_V11_BODY_PROPERTIES = 9
+IDX_V11_CHECKSUM = 16
+
+IDX_V20_FINAL = 6
+IDX_V20_WEIGHT_MSB = 8
+IDX_V20_WEIGHT_LSB = 9
+IDX_V20_IMPEDANCE_MSB = 10
+IDX_V20_IMPEDANCE_LSB = 11
+IDX_V20_CHECKSUM = 12
+
+IDX_V26_WEIGHT_MSB = 3
+IDX_V26_WEIGHT_LSB = 2
+
+IDX_VC0_FINAL = 6
+IDX_VC0_WEIGHT_MSB = 0
+IDX_VC0_WEIGHT_LSB = 1
+IDX_VC0_BODY_PROPERTIES = 6
+
+IDX_VF0_WEIGHT_MSB = 3
+IDX_VF0_WEIGHT_LSB = 2
+
+
+class OKOKScaleBluetoothDeviceData(BluetoothData):
+    """Data for OKOK Scale sensors."""
+
+    name = None
+
+    _device = None
+    _client = None
+    _expected_disconnect = False
+
+    supports_impedance = False
+
+    def _start_update(self, service_info: BluetoothServiceInfo) -> None:
+        """Update from BLE advertisement data."""
+        if _LOGGER.isEnabledFor(logging.DEBUG):
+            self.log_service_info(service_info)
+
+        manufacturer_data_key_lsbs = [
+            key & 0xFF for key in service_info.manufacturer_data
+        ]
+        if not (
+            MANUFACTURER_DATA_ID_V10 in service_info.manufacturer_data
+            or MANUFACTURER_DATA_ID_V11 in service_info.manufacturer_data
+            or MANUFACTURER_DATA_ID_V20 in service_info.manufacturer_data
+            or MANUFACTURER_DATA_ID_V26 in service_info.manufacturer_data
+            or MANUFACTURER_DATA_ID_VF0 in service_info.manufacturer_data
+            or MANUFACTURER_DATA_ID_VC0 in manufacturer_data_key_lsbs
+        ):
+            _LOGGER.info(
+                "Manufacturer data not found for %s; ids=%s",
+                service_info.address,
+                list(service_info.manufacturer_data.keys()),
+            )
+            return
+
+        self.set_device_manufacturer("OKOK")
+        self.set_device_type("OKOK Scale")
+        self.name = human_readable_name(
+            "OKOK Scale", service_info.name, service_info.address
+        )
+        self.set_device_name(self.name)
+        self.set_title(self.name)
+
+        self.process_manufacturer_data(service_info.manufacturer_data)
+
+        self.update_signal_strength(service_info.rssi)
+
+    def poll_needed(
+        self, service_info: BluetoothServiceInfo, last_poll: float | None
+    ) -> bool:
+        """
+        This is called every time we get a service_info for a device. It means the
+        device is working and online.
+        """
+        if last_poll is None or self.supports_impedance:
+            return True
+        return last_poll > UPDATE_INTERVAL_SECONDS
+
+    async def connect(self, ble_device: BLEDevice):
+        if self._client and self._client.is_connected:
+            _LOGGER.debug("Already connected to %s", self.name)
+            return self._client
+
+        # Connecting with the scale
+        self._device = ble_device
+        _LOGGER.info("Connecting to %s", self.name)
+        client: BleakClient = await establish_connection(
+            BleakClientWithServiceCache,
+            ble_device,
+            self.name,
+            self._disconnected,
+            use_services_cache=True,
+            ble_device_callback=lambda: self._device,
+        )
+        self._client = client
+
+        return client
+
+    async def disconnect(self):
+        if self._client and self._client.is_connected:
+            self._expected_disconnect = True
+            await self._client.disconnect()
+
+    def _disconnected(self, client: BleakClientWithServiceCache) -> None:
+        """Disconnected callback."""
+        if self._expected_disconnect:
+            _LOGGER.debug("%s: Disconnected from device", self.get_device_name())
+            return
+
+        _LOGGER.warning("%s: Device unexpectedly disconnected", self.get_device_name())
+
+    async def async_poll(
+        self, ble_device: BLEDevice, advertisement_data: AdvertisementData
+    ) -> SensorUpdate:
+        """
+        Poll the device to retrieve any values we can't get from passive listening.
+        """
+        try:
+            client = await self.connect(ble_device)
+            if _LOGGER.isEnabledFor(logging.DEBUG):
+                await self.log_client(client)
+
+            body_composition_char = client.services.get_characteristic(
+                CHARACTERISTIC_BODY_COMPOSITION
+            )
+            if body_composition_char:
+                self.supports_impedance = True
+
+                body_composition_payload = await client.read_gatt_char(
+                    body_composition_char
+                )
+                _LOGGER.debug(
+                    "Body Composition Payload: 0x%s", body_composition_payload.hex()
+                )
+
+                control_bytes = (
+                    body_composition_payload[1] << 8
+                ) + body_composition_payload[0]
+                partial = (control_bytes & 1024) > 0
+                in_pounds = (control_bytes & 256) > 0
+                finished = (control_bytes & 128) > 0
+                in_jin = (control_bytes & 64) > 0
+                weight_stabilized = (control_bytes & 32) > 0
+                impedance_stabilized = (control_bytes & 2) > 0
+
+                weight = (
+                    (body_composition_payload[12] << 8) + body_composition_payload[11]
+                ) / 10
+                _LOGGER.debug("Weight: %.2f kg", weight)
+
+                impedance = (
+                    body_composition_payload[10] << 8
+                ) + body_composition_payload[9]
+                _LOGGER.debug("Impedance: %d Ω", impedance)
+
+                self.update_predefined_sensor(
+                    SensorLibrary.MASS__MASS_KILOGRAMS, weight
+                )
+
+                self.update_predefined_sensor(SensorLibrary.IMPEDANCE__OHM, impedance)
+
+            # Battery percentage always returns 0 on my device
+            battery_char = client.services.get_characteristic(
+                CHARACTERISTIC_BATTERY_LEVEL
+            )
+            if battery_char:
+                battery_payload = await client.read_gatt_char(battery_char)
+
+                self.update_predefined_sensor(
+                    SensorLibrary.BATTERY__PERCENTAGE,
+                    battery_payload[0],
+                )
+
+            if _LOGGER.isEnabledFor(logging.DEBUG):
+                self.log_manufacturer_data(advertisement_data.manufacturer_data)
+            self.process_manufacturer_data(advertisement_data.manufacturer_data)
+        finally:
+            await self.disconnect()
+
+        return self._finish_update()
+
+    def process_manufacturer_data(self, manufacturer_data):
+        if MANUFACTURER_DATA_ID_V10 in manufacturer_data:
+            return
+        if MANUFACTURER_DATA_ID_V26 in manufacturer_data:
+            return
+
+        if MANUFACTURER_DATA_ID_V11 in manufacturer_data:
+            self._process_manufacturer_data_v11(manufacturer_data)
+        elif MANUFACTURER_DATA_ID_V20 in manufacturer_data:
+            self._process_manufacturer_data_v20(manufacturer_data)
+        elif MANUFACTURER_DATA_ID_VF0 in manufacturer_data:
+            self._process_manufacturer_data_vf0(manufacturer_data)
+        else:
+            self._process_manufacturer_data_vc0(manufacturer_data)
+
+    def _process_manufacturer_data_v11(self, manufacturer_data):
+        data = manufacturer_data[MANUFACTURER_DATA_ID_V11]
+        if data is None or len(data) != IDX_V11_CHECKSUM + 6 + 1:
+            _LOGGER.error(
+                "Data length error, got %d, expected %d",
+                len(data),
+                IDX_V11_CHECKSUM + 6 + 1,
+            )
+            return
+
+        if (data[IDX_V11_FINAL] & 1) == 0:
+            _LOGGER.debug("Data is not final")
+            return
+
+        checksum = (
+            0xCA ^ 0x11
+        )  # Version and magic fields are part of the checksum, but not in array
+        for i in range(0, IDX_V11_CHECKSUM - 1):
+            checksum ^= data[i]
+        if data[IDX_V11_CHECKSUM] != checksum:
+            _LOGGER.error(
+                "Checksum error, got %s, expected %s",
+                hex(data[IDX_V11_CHECKSUM] & 0xFF),
+                hex(checksum & 0xFF),
+            )
+            return
+
+        # Reading the weight
+        divider = 10.0
+        weight = data[IDX_V11_WEIGHT_MSB] & 0xFF
+        weight = weight << 8 | (data[IDX_V11_WEIGHT_LSB] & 0xFF)
+
+        match (data[IDX_V11_BODY_PROPERTIES] >> 1) & 3:
+            case 0:
+                divider = 10.0
+            case 1:
+                divider = 1.0
+            case 2:
+                divider = 100.0
+            case _:
+                _LOGGER.warning("Invalid weight scale received, assuming 1 decimal")
+                divider = 10.0
+
+        base_description = None
+        match (data[IDX_V11_BODY_PROPERTIES] >> 3) & 3:
+            case 0:  # kg
+                weight = weight / divider
+                base_description = SensorLibrary.MASS__MASS_KILOGRAMS
+            case 1:  # Jin
+                divider *= 2.0
+                weight = weight / divider
+                base_description = SensorLibrary.MASS__MASS_KILOGRAMS
+            case 2:  # lb
+                weight = weight / divider
+                base_description = SensorLibrary.MASS__MASS_POUNDS
+            case 3:  # st & lb
+                stones = weight >> 8
+                pounds = (weight & 0xFF) / divider
+                weight = pounds + (stones * 14)
+                base_description = SensorLibrary.MASS__MASS_POUNDS
+        _LOGGER.debug(
+            "Weight: %.2f %s", weight, base_description.native_unit_of_measurement
+        )
+
+        self.update_predefined_sensor(base_description, weight)
+
+    def _process_manufacturer_data_v20(self, manufacturer_data):
+        data = manufacturer_data[MANUFACTURER_DATA_ID_V20]
+        if data is None or len(data) != 19:
+            _LOGGER.error("Data length error, got %d, expected 19", len(data))
+            return
+
+        if (data[IDX_V20_FINAL] & 1) == 0:
+            _LOGGER.debug("Data is not final")
+            return
+
+        checksum = 0x20  # Version field is part of the checksum, but not in array
+        for i in range(0, IDX_V20_CHECKSUM - 1):
+            checksum ^= data[i]
+        if data[IDX_V20_CHECKSUM] != checksum:
+            _LOGGER.error(
+                "Checksum error, got 0x%s, expected 0x%s",
+                hex(data[IDX_V20_CHECKSUM] & 0xFF),
+                hex(checksum & 0xFF),
+            )
+            return
+
+        # Reading the weight
+        divider = 10.0
+        if (data[IDX_V20_FINAL] & 4) == 4:
+            divider = 100.0
+        weight = ((data[IDX_V20_WEIGHT_MSB] << 8) + data[IDX_V20_WEIGHT_LSB]) / divider
+        _LOGGER.debug("Weight: %.2f kg", weight)
+
+        # Reading the impedance
+        impedance = (
+            (data[IDX_V20_IMPEDANCE_MSB] << 8) + data[IDX_V20_IMPEDANCE_LSB]
+        ) / 10.0
+        _LOGGER.debug("Impedance: %.1f Ω", impedance)
+
+        self.update_predefined_sensor(SensorLibrary.MASS__MASS_KILOGRAMS, weight)
+
+        self.update_predefined_sensor(SensorLibrary.IMPEDANCE__OHM, impedance)
+
+    def _process_manufacturer_data_vc0(self, manufacturer_data):
+        data = None
+        final = False
+        for key, _data in manufacturer_data.items():
+            # Run through the whole list of values so we get the final reading
+            if (key & 0xFF) != MANUFACTURER_DATA_ID_VC0:
+                continue
+            if len(_data) != 13:
+                continue
+            if _data[IDX_VC0_WEIGHT_MSB] == 0 and _data[IDX_VC0_WEIGHT_LSB] == 0:
+                continue
+
+            if (_data[IDX_VC0_FINAL] & 1) == 1:
+                data = _data
+                final = True
+            elif not final:
+                data = _data
+
+        if data is None:
+            return
+
+        if not final:
+            _LOGGER.debug("Data is not final")
+            # return
+
+        msb = data[IDX_VC0_WEIGHT_MSB]
+        lsb = data[IDX_VC0_WEIGHT_LSB]
+        base_description = None
+        match data[IDX_VC0_BODY_PROPERTIES] >> 3 & 0x3:
+            case 0:  # kg
+                weight = (msb << 8 | lsb) / 100.0
+                base_description = SensorLibrary.MASS__MASS_KILOGRAMS
+            case 2:  # lb
+                weight = (msb << 8 | lsb) / 10.0
+                base_description = SensorLibrary.MASS__MASS_POUNDS
+            case 3:  # st:lb
+                weight = msb * 14 + lsb / 10.0
+                base_description = SensorLibrary.MASS__MASS_POUNDS
+        _LOGGER.debug(
+            "Weight: %.2f %s", weight, base_description.native_unit_of_measurement
+        )
+
+        self.update_predefined_sensor(base_description, weight)
+
+    def _process_manufacturer_data_vf0(self, manufacturer_data):
+        data = manufacturer_data[MANUFACTURER_DATA_ID_VF0]
+        if len(data) != 18:
+            _LOGGER.error("Data length error, got %d, expected 18", len(data))
+            return
+
+        # Reading the weight
+        # ToDo use unpack
+        weight = ((data[IDX_VF0_WEIGHT_MSB] << 8) + data[IDX_VF0_WEIGHT_LSB]) / 10.0
+        _LOGGER.debug("Weight: %.1f kg", weight)
+
+        self.update_predefined_sensor(SensorLibrary.MASS__MASS_KILOGRAMS, weight)
+
+    def log_service_info(self, service_info: BluetoothServiceInfo):
+        _LOGGER.debug("Device Name: %s", service_info.name)
+        _LOGGER.debug("Device Address: %s", service_info.address)
+        _LOGGER.debug("Device RSSI: %s", service_info.rssi)
+
+        self.log_manufacturer_data(service_info.manufacturer_data)
+
+        service_data = service_info.service_data
+        for service_id in service_data:
+            try:
+                data = service_data[service_id]
+                _LOGGER.debug("Service Data %s: %s", service_id, data.decode())
+                _LOGGER.debug("Service Data %s: 0x%s", service_id, data.hex())
+            except UnicodeDecodeError:
+                _LOGGER.debug("Service Data %s: 0x%s", service_id, data.hex())
+            except Exception:
+                pass
+
+        _LOGGER.debug("Service UUIDs: %s", service_info.service_uuids)
+
+    def log_manufacturer_data(self, manufacturer_data):
+        for manufacturer_id in manufacturer_data:
+            data = manufacturer_data[manufacturer_id]
+            _LOGGER.debug("Manufacturer Identifier: %s", hex(manufacturer_id))
+            _LOGGER.debug("Manufacturer Data Length: %s", len(data))
+            try:
+                _LOGGER.debug("Manufacturer Data: %s", data.decode())
+                _LOGGER.debug("Manufacturer Data: 0x%s", data.hex())
+            except UnicodeDecodeError:
+                _LOGGER.debug("Manufacturer Data: 0x%s", data.hex())
+            except Exception:
+                pass
+
+    async def log_client(self, client):
+        # Log characteristics for debugging
+        for i in client.services.characteristics:
+            try:
+                characteristic = client.services.characteristics[i]
+                gatt_char = client.services.get_characteristic(characteristic.uuid)
+                payload = await client.read_gatt_char(gatt_char)
+                _LOGGER.debug("client.services %s: %s", gatt_char, payload.decode())
+                _LOGGER.debug("client.services %s: 0x%s", gatt_char, payload.hex())
+            except UnicodeDecodeError:
+                _LOGGER.debug("client.services %s: 0x%s", gatt_char, payload.hex())
+            except Exception:
+                pass

okokscale-0.0.1/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["hatchling>=1.29", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "okokscale/_version.py"
+
+[tool.hatch.version]
+source = "vcs"
+
+[project]
+name = "okokscale"
+dynamic = ["version"]
+license = {text = "Apache-2.0"}
+authors = [
+    { name="Rogier van Staveren", email="rogier@batoid.com" }
+]
+description = "Library for parsing OKOK scale BLE advertisements."
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "bleak>=3.0.2",
+    "bluetooth_sensor_state_data==1.9.0"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/rrooggiieerr/okokscale.py"
+"Bug Tracker" = "https://github.com/rrooggiieerr/okokscale.py/issues"
+
+[tool.isort]
+# https://github.com/PyCQA/isort/wiki/isort-Settings
+profile = "black"
+skip = "*/_version.py"
+
+[tool.black]
+exclude = "rfcontrol/_version.py"
+
+[tool.pylint]
+ignore = "_version.py"
+recursive = "y"
+
+[tool.mypy]
+python_version = "3.11"
+mypy_path = "rfcontrol"
+
+[[tool.mypy.overrides]]
+module = ["*._version"]
+ignore_missing_imports = true

okokscale-0.0.1/requirements.txt

@@ -0,0 +1,2 @@
+bleak==3.0.2
+bluetooth_sensor_state_data==1.9.0