.. OpenHEMS documentation master file, created by
   sphinx-quickstart on Fri Oct 25 08:13:04 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

OpenHEMS documentation
======================

**OpenHEMS** is a simple Home Energy Management System (HEMS) witch aims to switch on/off devices at home to optimize electricity consumption. To know more about use cases please refer to :doc:`usage` page.
It's an Open-Source software licensed under GNU GPLv3.
The software use [Home-Assistant](https://www.home-assistant.io/) to control devices.
The software is developped by `OpenHomeSystem <https://openhomesystem.com/>` and the open-source comunity.

.. Check out the :doc:`usage` section for further information, including
.. how to :ref:`installation` the project.


.. note::

   This project is under active development.

Contents
--------

.. toctree::

   intro
   usage
   installation
   installation_from_scratch
   configure
   configure_nodes
   api