HueBLE 1.0.0__tar.gz

hueble-1.0.0/HueBLE.egg-info/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.1
+Name: HueBLE
+Version: 1.0.0
+Summary: Python module for controlling and monitoring Bluetooth Philips Hue bulbs
+Author-email: Harvey Lelliott <harveylelliott@duck.com>
+License: MIT License
+        
+        Copyright (c) 2024 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/HueBLE
+Project-URL: Documentation, https://hueble.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/flip-dots/HueBLE
+Project-URL: Issues, https://github.com/flip-dots/HueBLE/issues
+Project-URL: Changelog, https://github.com/flip-dots/HueBLE/CHANGELOG.rst
+Keywords: Philips Hue,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.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: bleak>=0.19.0
+Requires-Dist: bleak-retry-connector
+
+# HueBLE
+
+![HueBLE logo](/hue_ble.png)
+
+
+Python module for controlling Bluetooth Philips Hue lights.
+ - 👌 Free software: MIT license
+ - 🖨️ Documentation: https://hueble.readthedocs.io/en/latest/
+ - 📦 PIP: https://pypi.org/project/HueBLE/
+
+
+This Python module enables you to control Philips Hue Bluetooth lights directly
+from your computer, without the need for a Hue bridge or ZigBee dongle.
+It leverages the Bleak library to interact with Bluetooth Philips Hue lights.
+
+
+## Features
+
+- 💡 On/Off control
+- 🌗 Brightness control
+- 🌡️ Colour temp control 
+- 🌈 XY colour control
+- ❔ Light state (power/brightness/temp/colour)
+- ⚙️ Light configuration (name)
+- 📊 Light metadata (manufacturer/model/zigbee address)
+- 🤜 Supports push & polling models
+- 🔂 Simple structure
+- 📜 Mediocre documentation
+- ✔️ More emojis than strictly necessary
+
+
+## Requirements
+
+- 🐍 Python 3.10+
+- 📶 Bleak 0.19.0+
+- 📶 bleak-retry-connector
+
+
+## Supported Operating Systems
+
+- 🐧 Linux (BlueZ)
+  - Ubuntu Desktop
+  - Arch (HomeAssistant OS)
+- 🏢 Windows
+  - Windows 10 
+- 💾 Mac OSX
+  - Maybe?
+
+
+## Documentation
+
+https://hueble.readthedocs.io/en/latest/
+
+
+## Installation
+
+
+### PIP
+
+```
+pip install HueBLE
+```
+
+
+### Manual
+
+HueBLE consists of a single file (HueBLE.py) which you can simply put in the
+same directory as your program. If you are using manual installation make sure
+the dependencies are installed as well.
+
+```
+pip install bleak bleak-retry-connector
+```
+
+
+## Examples
+
+
+### Quick start example
+
+Example code from example.py
+
+```python
+import asyncio
+from bleak import BleakScanner
+import HueBLE
+
+
+async def main():
+
+    # Address of light to connect to
+    address = "F6:9B:48:A4:D2:D8"
+
+    # Obtain the BLEDevice from bleak
+    device = await BleakScanner.find_device_by_address(address)
+
+    # Initialize the light object
+    light = HueBLE.HueBleLight(device)
+
+    # Optionally we could call connect but it will be called automatically
+    # on the first request to the light. You might want to call this if
+    # you want to subscribe to state changes without changing the lights state.
+    # await light.connect()
+
+    # Will automatically connect to the light and turn it off
+    await light.set_power(False)
+
+    # Wait
+    await asyncio.sleep(5)
+
+    # Turn the light back on again
+    await light.set_power(True)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```
+
+
+### Demo program
+
+A more fully featured demo program can be found in  ``` examples/demo.py ``` which demonstrates all of the implemented features.

hueble-1.0.0/HueBLE.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+HueBLE.py
+LICENSE.txt
+README.md
+pyproject.toml
+HueBLE.egg-info/PKG-INFO
+HueBLE.egg-info/SOURCES.txt
+HueBLE.egg-info/dependency_links.txt
+HueBLE.egg-info/requires.txt
+HueBLE.egg-info/top_level.txt

hueble-1.0.0/HueBLE.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hueble-1.0.0/HueBLE.egg-info/requires.txt

@@ -0,0 +1,2 @@
+bleak>=0.19.0
+bleak-retry-connector

hueble-1.0.0/HueBLE.egg-info/top_level.txt

@@ -0,0 +1 @@
+HueBLE