🏡
Heim

A home monitoring system, focused on temperature and power usage

Project setup

You need Python 3.10+ and PostgreSQL 12+ to run this project.

1. Start by installing the dependencies:

   poetry install

2. Next you need to set some environment variables, for this I recommend direnv:

   # Auto-activate venv
   load_prefix <path to project>/.venv
   export VIRTUAL_ENV=<path to project>/.venv
   
   # Set up aqara integration
   export AQARA_APP_ID=...
   export AQARA_APP_KEY=...
   export AQARA_KEY_ID=...
   export AQARA_DOMAIN=open-ger.aqara.com
   
   # Specify which database to use
   export PGDATABASE=heim

3. Create the database:

   createdb heim

4. Apply migrations:

   ./bin/migrate

5. That should be if, you're now good to go.

Running

To run the server use any ASGI server. uvicorn is installed as part of the project dependencies. It supports reloading as well:

uvicorn heim.server:app --reload

In addition to the HTTP component, heim also has a background task runner that has to be run as a separate process:

./bin/run-tasks