Metadata-Version: 2.4
Name: SolixBLE
Version: 3.7.0
Summary: Python module for monitoring & controlling Bluetooth Anker Solix devices
Author-email: Harvey Lelliott <harveylelliott@duck.com>
License: MIT License
        
        Copyright (c) 2026 Harvey Lelliott
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/flip-dots/SolixBLE
Project-URL: Documentation, https://solixble.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/flip-dots/SolixBLE
Project-URL: Issues, https://github.com/flip-dots/SolixBLE/issues
Keywords: Anker,Solix,BLE,Home Assistant
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Home Automation
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: AsyncIO
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: bleak>=0.19.0
Requires-Dist: cryptography
Requires-Dist: pycryptodome
Requires-Dist: bleak-retry-connector
Dynamic: license-file

# SolixBLE

[![PyPI Status](https://img.shields.io/pypi/v/SolixBLE.svg)](https://pypi.python.org/pypi/SolixBLE)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Python module for monitoring and controlling Anker Solix power stations and other devices over Bluetooth.
 - 👌 Free software: MIT license
 - 🍝 Sauce: https://github.com/flip-dots/SolixBLE
 - 🖨️ Documentation: https://solixble.readthedocs.io/en/latest/
 - 📦 PIP: https://pypi.org/project/SolixBLE/


This Python module enables you to monitor and control (some) Anker Solix
devices directly from your computer, without the need for any cloud services or Anker app.
It leverages the Bleak library to interact with Bluetooth Anker Solix devices.
No pairing is required in order to receive telemetry data or control the device.


## Features

- 🔋 Battery percentage
- ⚡ Total Power In/Out
- 🎛️ AC/DC output control
- 🔌 AC Power In/Out
- 🚗 DC Power In/Out
- ⏰ AC/DC Timer value
- ⏲️ Time remaining to full/empty
- ☀️ Solar Power In
- 💻 USB Port Power
- 📱 USB Port Status
- ⚙️ Firmware version
- 🩺 Battery health
- 🌡️ Battery temperature
- ↔️ Expansion batteries (Charge, Temperature, Health, Firmware)
- 💡 Light bar status & control
- 🖥️ Display status & control
- 🔂 Simple structure
- ✔️ More emojis than strictly necessary


## Supported Devices

See the [support table](https://solixble.readthedocs.io/en/latest) in the documentation for feature support for particular devices.

- C300(X)
- C300(X) DC
- C800(X)
- C1000(X)
- C1000 Gen 2
- F2000 (767 PowerHouse)
- F3800
- Solarbank 2
- Solarbank 3
- Prime Charger 160w
- Prime Charger 250w
- Potentially more!


## Requirements

- 🐍 Python 3.11+
- 📶 Bleak 0.19.0+
- 📶 bleak-retry-connector


## Supported Operating Systems

- 🐧 Linux (BlueZ)
  - Ubuntu Desktop
  - Arch (HomeAssistant OS)
- 🏢 Windows
  - Windows 10 
- 💾 Mac OSX
  - 15.7


## Installation


### PIP

```
pip install SolixBLE
```


## Adding support for new devices

See the `Generic` class inside `SolixBLE/devices/generic.py` and the 
[documentation](https://solixble.readthedocs.io/en/latest/new_devices.html)
for guidance on how to add support for new devices.
