pymagicstrip 0.1.0
Python Interface for Magic Strip LED Controllers
License: MIT
Requires Python: >=3.9
Keywords: Magic Strip

# pymagicstrip

## Purpose

Minimal python library for controlling LED controllers that use the MagicStrip iOS/Android app. These are inexpensive, white labeled controllers available on Amazon, AliExpress, etc.

The firmware on these devices is terrible so feature support is spotty.

## Device Support

This library only supports RGB LED strips that appear in the MagicStrip app under the name "HTZM". RGBW, RGBWW, etc. devices are not currently supported.

## Feature Support

| Feature            | Read Property | Set Property | Notes                                                                                                                                               |
| ------------------ | ------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Power              | ✅            | ⚠️           | Device firmware does not have discrete on and off commands. This library can only toggle state.                                                     |
| Brightness         | ✅            | ✅           |                                                                                                                                                     |
| Color              | 🚫            | ✅           |                                                                                                                                                     |
| Effects            | 🚫            | ✅           | We _technically_ can read this property, but the device does not report whether it is in solid color mode or effect mode, so the report is useless. |
| Effect Speed       | 🚫            | ✅           | (See above.)                                                                                                                                        |
| Sound / Music Mode | 🚫            | 🚫           |                                                                                                                                                     |

## Use

This library is based on the python [bleak](https://github.com/hbldh/bleak) library and does not abstract/wrap all features. You must use bleak directly alongside pymagicstrip.

For usage examples, see https://github.com/elahd/ha-magicstrip. (Apologies for the lack of clear examples here.)

## Credit

Pymagicstrip is heavily based on elupus' [Fjäråskupan Bluetooth Control library](https://github.com/elupus/fjaraskupan).

MIT License

Copyright (c) 2022 Elahd Bar-Shai

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.