Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/berrysauce/hoom

🏡 Build your own HomeKit Bridge & Accessories with Hoom
https://github.com/berrysauce/hoom

bridge hap homekit homekit-accessory-protocol homekit-bridge iot python

Last synced: 2 months ago
JSON representation

🏡 Build your own HomeKit Bridge & Accessories with Hoom

Awesome Lists containing this project

README

        


Hoom


Build your own HomeKit Bridge & Accessories with Hoom



CodeQL Status
PyPi Publishing Status
Documentation Status
PyPi Python Versions
PyPi Package Downloads


> [!WARNING]
> Hoom is still under development. It is not recommended at this point, to use Hoom in a production environment.


## ✨ Features
- [x] HomeKit Bridge
- [x] Minimalist Web UI
- [x] Create custom HomeKit Accessories with function decorators
- [x] Customizable
- [x] Easy to use


## 📦 Installation
Hoom is available on [PyPi](https://pypi.org/project/hoom/). You can easily install it using pip:

```bash
pip install hoom
```

> [!NOTE]
> Hoom requires Python 3.8 or higher


## 🚀 Getting started
Here's a demo script which shows how easy Hoom is to use:

```python
from hoom import Hoom
from hoom.accessory_types import Switch

hoom = Hoom()

@hoom.switch("Switch ")
def switch(response: Switch.Response):
if response.on: # boolean value
print("Switch is now on")
else:
print("Switch is now off")

return

hoom.run()
```

As you can see, Hoom is very similar to frameworks like FastAPI. No need for complicated classes with lots of methods. Just use the `@hoom.<>` decorator and you're good to go.

If you want to know how to create other accessories, [take a look at the documentation](https://berrysauce.me/hoom/).


## 📣 Credits
A special thanks goes out to these Python packages/frameworks and their authors:

- [HAP-python](https://github.com/ikalchev/HAP-python) - Hoom wouldn't be possible without this HomeKit Accessory Protocol implementation by [Ivan Kalchev](https://github.com/ikalchev)
- [FastAPI](https://github.com/tiangolo/fastapi) - Hoom uses FastAPI by [Sebastián Ramírez](https://github.com/tiangolo) for its web server & UI and is heavily inspired by it

A special thanks also goes out to:

- [Tabler Icons](https://tabler-icons.io/) - The icon for Hoom is from Tabler Icons