Skip to content

berrysauce/hoom


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

  • HomeKit Bridge
  • Minimalist Web UI
  • Create custom HomeKit Accessories with function decorators
  • Customizable
  • Easy to use

📦 Installation

Hoom is available on PyPi. You can easily install it using pip:

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:

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.<<accessory>> decorator and you're good to go.

If you want to know how to create other accessories, take a look at the documentation.


📣 Credits

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

A special thanks also goes out to: