miauth


Namemiauth JSON
Version 0.9.6 PyPI version JSON
download
home_pagehttps://github.com/dnandha/miauth
SummaryAuthenticate and interact with Xiaomi devices over BLE
upload_time2022-06-23 20:58:03
maintainer
docs_urlNone
authorDaljeet Nandha
requires_python>=3.6
licenseGNU AGPL v3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Xiaomi Mi / Nb BLE - Python Lib + CLI

## Installation
`pip install miauth`

Or clone this repository and run `pip install -e` inside the cloned directory.

### Running tests
`python -m pytest` or `tox` in project main directory.

## Usage examples
After installation, you will have access to the `miauth` command line interface (cli):

1. Register / pair with device via Mi EC protocol (generates 'mi_token' file):
`miauth <device_mac> --register`
1. Login and retrieve serial number and firmware version via Mi EC protocol:
`miauth -s -v <device_mac>`
1. Retrieve serial number and firmware version via M365 protocol:
`miauth --m365 -s -v <device_mac>`
1. Authenticate and retrieve serial number and firmware version via Nb protocol:
`miauth --nb -s -v <device_mac>`

For a full list of the possible commands run `miauth -h`.

Note: Registering / pairing with devices unpairs the device from all other apps!
If you want to use your device with other apps after pairing, either reinstall or remove / re-add the device inside the app.

## License
See LICENSE.md

## Disclaimer
I'm in no way affiliated with Xiaomi or any of their subsidiaries and products. This code has been provided for research purposes only.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dnandha/miauth",
    "name": "miauth",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Daljeet Nandha",
    "author_email": "dalj337@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/8c/46/de523c57fc1b1e0135be9640fb55fe144e852deed0d820e00de20eb1ebaa/miauth-0.9.6.tar.gz",
    "platform": null,
    "description": "# Xiaomi Mi / Nb BLE - Python Lib + CLI\n\n## Installation\n`pip install miauth`\n\nOr clone this repository and run `pip install -e` inside the cloned directory.\n\n### Running tests\n`python -m pytest` or `tox` in project main directory.\n\n## Usage examples\nAfter installation, you will have access to the `miauth` command line interface (cli):\n\n1. Register / pair with device via Mi EC protocol (generates 'mi_token' file):\n`miauth <device_mac> --register`\n1. Login and retrieve serial number and firmware version via Mi EC protocol:\n`miauth -s -v <device_mac>`\n1. Retrieve serial number and firmware version via M365 protocol:\n`miauth --m365 -s -v <device_mac>`\n1. Authenticate and retrieve serial number and firmware version via Nb protocol:\n`miauth --nb -s -v <device_mac>`\n\nFor a full list of the possible commands run `miauth -h`.\n\nNote: Registering / pairing with devices unpairs the device from all other apps!\nIf you want to use your device with other apps after pairing, either reinstall or remove / re-add the device inside the app.\n\n## License\nSee LICENSE.md\n\n## Disclaimer\nI'm in no way affiliated with Xiaomi or any of their subsidiaries and products. This code has been provided for research purposes only.\n\n\n",
    "bugtrack_url": null,
    "license": "GNU AGPL v3",
    "summary": "Authenticate and interact with Xiaomi devices over BLE",
    "version": "0.9.6",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b736e7bf0c6212368edec1dd7a82141f",
                "sha256": "9764128c46abf75a3fda0af3433e166ee64b734e66c34bb0c637c1e08e5eb955"
            },
            "downloads": -1,
            "filename": "miauth-0.9.6.tar.gz",
            "has_sig": false,
            "md5_digest": "b736e7bf0c6212368edec1dd7a82141f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 26504,
            "upload_time": "2022-06-23T20:58:03",
            "upload_time_iso_8601": "2022-06-23T20:58:03.131631Z",
            "url": "https://files.pythonhosted.org/packages/8c/46/de523c57fc1b1e0135be9640fb55fe144e852deed0d820e00de20eb1ebaa/miauth-0.9.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-23 20:58:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "dnandha",
    "github_project": "miauth",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "miauth"
}
        
Elapsed time: 0.47924s