=======
Domogik
=======


.. todo::
    This release is actually in development.
    Some parts of this documentation still need to be updated!


Overview
========

* :doc:`Quick </overview/index>` 
* :doc:`Detailed </overview/detailed>`

End User Documentation
======================

* :doc:`Release 0.4.0 </releases/0.4.0>`
* :doc:`Release 0.3.0 </releases/0.3.0>`
* :doc:`Release 0.2.0 </releases/0.2.0>`
* :doc:`Release 0.1.0 </releases/0.1.0>`
* :doc:`Domogik requirements </enduser/requirements>`
* **Installation:**

  * :doc:`Standard Installation </enduser/installation/index>` (*)
  * :doc:`Repositories configuration </enduser/installation/repositories>` (*)
  * :doc:`Configure external access to Domogik </enduser/installation/external>`
  
  Now, install Domoweb (the Domogik web user interface) before starting the following parts.

* **First steps:**

  * :doc:`First Use </enduser/configuration/index>` (*)
  * :doc:`Accounts management </enduser/administration/account>`

* **Packages:**

  * :doc:`Repositories </enduser/packages/repositories>`
  * :doc:`Installing a package </enduser/packages/installation>` (*)
  * :doc:`Plugin configuration and startup </enduser/packages/plugin_configuration_and_startup>` (*)
  * :doc:`Plugin helpers </enduser/packages/plugin_helpers>` (*)

* **Devices:**

  * :doc:`Devices management </enduser/administration/device>` (*)
  * :doc:`Set up your devices </enduser/configuration/devices>` (*)

* **Uninstallation:**

  * :doc:`How to uninstall Domogik </enduser/installation/uninstall>` 
 
Technical Documentation
=======================
* :doc:`The xPL hub </xplhub/index>`
* :doc:`Network ports used by Domogik </technical/network_ports>`
* :doc:`Commands </technical/command>`
* :doc:`Sensors </technical/sensor>`
* :doc:`Device types and usages  </technical/device_feature_usage>`
* **Database:**
  :doc:`Model </technical/database>`
* **RINOR:**
	* :doc:`Overview </technical/rinor/index>`
	* :doc:`XPL Events </technical/rinor/statmgr>`: Store into the database the xPL activity on Network
	* :doc:`REST /device </technical/rinor/rest_device>`: Get device data from the database
	* :doc:`REST /cmd </technical/rinor/rest_command>`: Send commands to devices
	* :doc:`REST /stats </technical/rinor/rest_stats>`: Get stats from the database
	* :doc:`REST /account </technical/rinor/rest_account>`: Login and password changes
	* :doc:`REST /user </technical/rinor/rest_user>`: List users
	* :doc:`REST /person </technical/rinor/rest_person>`: List persons
	* :doc:`REST /xpl-cmnd </technical/rinor/rest_xplcmnd>`: Directly send a xPL message
	* :doc:`REST /repo </technical/rinor/rest_repository>`: Store files
	* :doc:`REST /helper </technical/rinor/rest_helper>`: Helpers
* **Packages:**
  :doc:`Packages overview </technical/packages>`
* **Message Queue:**
        * :doc:`Overview </technical/mq/overview>`
        * :doc:`Request Reply </technical/mq/reqrep>`
        * :doc:`Publish Subscribe </technical/mq/pubsub>`
        * :doc:`Used messages </technical/mq/used>`
        * :doc:`Detail on Request Reply used messages </technical/mq/reqrep_detailed>`
        * :doc:`detail on Publish Subscribe used messages</technical/mq/pubsub_detailed>`

Developers Documentation
========================
* :doc:`Developing a package </package_development/index>`
* :doc:`Upgrading a package to 0.4 </package_development/json_file_upgrade>`
* :doc:`Tools </tools/index>`