pyweii


Namepyweii JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://gitlab.com/stavros/weii
SummaryA utility to measure weight using the Wii Balance Board.
upload_time2023-01-30 13:17:41
maintainer
docs_urlNone
authorStavros Korokithakis
requires_python>=3.8,<4
licenseAGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Weii
====

Weii (pronounced "weigh") is a small script that connects to a Wii Balance Board, reads a weight measurement, and disconnects.
Weii is the new, redesigned spiritual successor to [gr8w8upd8m8](https://github.com/skorokithakis/gr8w8upd8m8).

Installation
------------

To install using `pipx` (recommended) or `pip`, run:

```
pipx install pyweii
```

or

```
pip install pyweii
```


Usage
-----

Weii currently is only tested on Linux.
Before you use Weii, you need to pair your balance board via Bluetooth.
You can do that by pressing the red button in the battery compartment and then going through the normal Bluetooth pairing process.
I don't remember the pairing code, try 0000 or 1234, and please let me know which one is right.

To weigh yourself, run `weii` and follow the instructions.
You need to have paired your balance board beforehand, then press the button at the front of the board until the blue LED lights up solid, and step on.
Once the measurement is done, you can step off.

Weii can optionally use `bluetoothctl` to disconnect (and turn off) the balance board when the weighing is done, you can do that by passing the device's address to the `-d` argument:

```
weii --disconnect-when-done 11:22:33:44:55:66
```

You can run a command after weighing, like so:

```
weii --command "echo {weight}"
```

`{weight}` will be replaced with the measured weight.

You can also adjust the measurement to account for clothing, or to match some other scale:

```
weii --adjust=-2.3
```

Changelog
=========


(unreleased)
------------

Fix
~~~
- Rename `terse` argument. [Stavros Korokithakis]

Other
~~~~~
- Build: Release v0.1.1. [Stavros Korokithakis]
- Doc: Documentation updates. [Stavros Korokithakis]
- Switch to ruff. [Stavros Korokithakis]
- Chore: Add repository and homepage. [Stavros Korokithakis]
- Feat: Abort if the user presses the board button while measuring.
  [Stavros Korokithakis]
- Feat: Add the `--command` argument. [Stavros Korokithakis]
- Add LICENSE. [Stavros Korokithakis]
- Doc: Add changelog. [Stavros Korokithakis]
- Initial commit. [Stavros Korokithakis]




            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/stavros/weii",
    "name": "pyweii",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4",
    "maintainer_email": "",
    "keywords": "",
    "author": "Stavros Korokithakis",
    "author_email": "hi@stavros.io",
    "download_url": "https://files.pythonhosted.org/packages/cb/18/ae7f438fe25c9c800a7578b4f41200fa9794343e62b6e073e26af0f0c938/pyweii-0.1.1.tar.gz",
    "platform": null,
    "description": "Weii\n====\n\nWeii (pronounced \"weigh\") is a small script that connects to a Wii Balance Board, reads a weight measurement, and disconnects.\nWeii is the new, redesigned spiritual successor to [gr8w8upd8m8](https://github.com/skorokithakis/gr8w8upd8m8).\n\nInstallation\n------------\n\nTo install using `pipx` (recommended) or `pip`, run:\n\n```\npipx install pyweii\n```\n\nor\n\n```\npip install pyweii\n```\n\n\nUsage\n-----\n\nWeii currently is only tested on Linux.\nBefore you use Weii, you need to pair your balance board via Bluetooth.\nYou can do that by pressing the red button in the battery compartment and then going through the normal Bluetooth pairing process.\nI don't remember the pairing code, try 0000 or 1234, and please let me know which one is right.\n\nTo weigh yourself, run `weii` and follow the instructions.\nYou need to have paired your balance board beforehand, then press the button at the front of the board until the blue LED lights up solid, and step on.\nOnce the measurement is done, you can step off.\n\nWeii can optionally use `bluetoothctl` to disconnect (and turn off) the balance board when the weighing is done, you can do that by passing the device's address to the `-d` argument:\n\n```\nweii --disconnect-when-done 11:22:33:44:55:66\n```\n\nYou can run a command after weighing, like so:\n\n```\nweii --command \"echo {weight}\"\n```\n\n`{weight}` will be replaced with the measured weight.\n\nYou can also adjust the measurement to account for clothing, or to match some other scale:\n\n```\nweii --adjust=-2.3\n```\n\nChangelog\n=========\n\n\n(unreleased)\n------------\n\nFix\n~~~\n- Rename `terse` argument. [Stavros Korokithakis]\n\nOther\n~~~~~\n- Build: Release v0.1.1. [Stavros Korokithakis]\n- Doc: Documentation updates. [Stavros Korokithakis]\n- Switch to ruff. [Stavros Korokithakis]\n- Chore: Add repository and homepage. [Stavros Korokithakis]\n- Feat: Abort if the user presses the board button while measuring.\n  [Stavros Korokithakis]\n- Feat: Add the `--command` argument. [Stavros Korokithakis]\n- Add LICENSE. [Stavros Korokithakis]\n- Doc: Add changelog. [Stavros Korokithakis]\n- Initial commit. [Stavros Korokithakis]\n\n\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-or-later",
    "summary": "A utility to measure weight using the Wii Balance Board.",
    "version": "0.1.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb3c2dcc439160f428bbb2597ff96d7ea5db58b0f5e5d31a27482e8645370516",
                "md5": "3ee35de90b7517947c3dc368b3123fc7",
                "sha256": "7501c9604b4a2bab414cd32ac01cb34041f28bd87ee0de789f5945d968a9863c"
            },
            "downloads": -1,
            "filename": "pyweii-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ee35de90b7517947c3dc368b3123fc7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4",
            "size": 16201,
            "upload_time": "2023-01-30T13:17:39",
            "upload_time_iso_8601": "2023-01-30T13:17:39.993964Z",
            "url": "https://files.pythonhosted.org/packages/cb/3c/2dcc439160f428bbb2597ff96d7ea5db58b0f5e5d31a27482e8645370516/pyweii-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb18ae7f438fe25c9c800a7578b4f41200fa9794343e62b6e073e26af0f0c938",
                "md5": "4205786c459d69a0fd44e0dc2706c435",
                "sha256": "82b812165622dfe1081372f74a333f3f1e8bfb01e78a3e725d7546693b62f742"
            },
            "downloads": -1,
            "filename": "pyweii-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4205786c459d69a0fd44e0dc2706c435",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4",
            "size": 15864,
            "upload_time": "2023-01-30T13:17:41",
            "upload_time_iso_8601": "2023-01-30T13:17:41.236802Z",
            "url": "https://files.pythonhosted.org/packages/cb/18/ae7f438fe25c9c800a7578b4f41200fa9794343e62b6e073e26af0f0c938/pyweii-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-30 13:17:41",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "gitlab_user": "stavros",
    "gitlab_project": "weii",
    "lcname": "pyweii"
}
        
Elapsed time: 0.03293s