Platypush
#########

Description
===========

This is the main documentation hub for Platypush. It includes both the wiki and
the complete reference of the available integrations.

Platypush is a general-purpose automation framework that can be used to cover
all the cases where you'd use a home automation hub, a media center, a smart
assistant, some IFTTT recipes, and a variety of other products and services.

It draws inspiration from the following projects, and it aims to cover all of
their use-cases:

* `Home Assistant <https://www.home-assistant.io/>`_
* `Homebridge <https://homebridge.io/>`_
* `OpenHAB <https://www.openhab.org/>`_
* `IFTTT <https://ifttt.com/>`_
* `Tasker <https://tasker.joaoapps.com/>`_

Useful links
============

* The `main page <https://platypush.tech>`_ of the project.
* The `source code <https://git.platypush.tech/platypush/platypush>`_.
* The `blog <https://blog.platypush.tech>`_.

Wiki
====

.. toctree::
    :maxdepth: 3

    wiki/index
    wiki/Quickstart
    wiki/Installation
    wiki/Plugins-installation
    wiki/APIs
    wiki/Variables
    wiki/Entities
    wiki/Configuration
    wiki/A-full-configuration-example
    wiki/The-Web-interface

Reference
=========

.. toctree::
    :maxdepth: 2

    backends
    plugins
    events

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`