Skip to main content

MiBand2 Python API based on bleak

The library provides convenient APIs to control and read data of MiBand2.

Supported features

  • sending notifications
  • date/time setup and reading
  • onetime alarm setup
  • reading battery level

Usage

import asyncio
import bleak
from miband2 import Band2, Key, NotificationType as NT
from datetime import datetime

KEY = Key(
    key=b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x05',
    reset=True # note *
)

async def main():
    located_band = await scan_bands(timeout=15)
    client = bleak.BleakClient(located_band, timeout=15)
    
    async with Band2(client) as band:
        auth_status = await band.auth(KEY)
        print(f"auth status: {auth_status}")

        battery_level = await band.get_battery()
        print(f"battery: {battery_level}")

        await band.ring(NT.SINGLE)
        
        now = datetime.now()
        await band.set_datetime(now)

async def scan_bands(timeout):
    def bands_only(dev, adv):
        return "MI Band" in dev.name
    return await bleak.BleakScanner.find_device_by_filter(timeout=timeout, filterfunc=bands_only)

asyncio.run(main())

Note: key reset is required for the first time only. Later, one can auth with the same key setting the reset=False

Why?

This project initially helped me to learn BLE. My old Band2 got its second life when I started to learn BLE and became curious if I can communicate with the device using a Linux machine. This Band2 device acted as an oracle visually confirming if I craft packets correctly. The fact of a visual feedback in a form of a notification or displaying a newly set time provided some incentive to me and made learning funnier than it could be if relying solely on reading books.

Metadata

Release files for miband2 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for miband2 0.1.1
File Size Uploaded
miband2-0.1.1.tar.gz 6.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for miband2 0.1.1
File Interpreter ABI Platform
miband2-0.1.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 12.3 kB

Release files / miband2-0.1.1.tar.gz

Download URL miband2-0.1.1.tar.gz
Size 6.7 kB
Tags Source
SHA-256 checksum
How to use checksums
80a322cabb00018c6bb377ae8c9208e8bb91079245f7e0a377fe604f600faed7
BLAKE2b-256 checksum
How to use checksums
cbde0f3f6b24b8591380837f9782a2eebb49b056dfe729ac2e4e19eba760930f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release files / miband2-0.1.1-py2.py3-none-any.whl

Download URL miband2-0.1.1-py2.py3-none-any.whl
Size 5.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
66ae02958cdf62ad9279cebf7bb6bc0b4c578f285fb33eac1d1642a935a59bb1
BLAKE2b-256 checksum
How to use checksums
42db8b0119fa33eb6f8f21bc02a64f6253458a5c3fc066778116caa4b4519487
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page