Domogik 0.4 documentation

Home | Table of contents | Index |

« previous | up | next »

Domogik

Todo

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

Overview

• Quick
• Detailed

End User Documentation

• Release 0.4.0

• Release 0.3.0

• Release 0.2.0

• Release 0.1.0

• Domogik requirements

• Installation:

  • Standard Installation (*)
  • Repositories configuration (*)
  • Configure external access to Domogik

  Now, install Domoweb (the Domogik web user interface) before starting the following parts.

• First steps:

  • First Use (*)
  • Accounts management

• Packages:

  • Repositories
  • Installing a package (*)
  • Plugin configuration and startup (*)
  • Plugin helpers (*)

• Devices:

  • Devices management (*)
  • Set up your devices (*)

• Uninstallation:

  • How to uninstall Domogik

Technical Documentation

• The xPL hub

• Network ports used by Domogik

• Commands

• Sensors

• Device types and usages

• Database: Model

• RINOR:

  • Overview
  • XPL Events: Store into the database the xPL activity on Network
  • REST /device: Get device data from the database
  • REST /cmd: Send commands to devices
  • REST /stats: Get stats from the database
  • REST /account: Login and password changes
  • REST /user: List users
  • REST /person: List persons
  • REST /xpl-cmnd: Directly send a xPL message
  • REST /repo: Store files
  • REST /helper: Helpers

• Packages: Packages overview

• Message Queue:

  • Overview
  • Request Reply
  • Publish Subscribe
  • Used messages
  • Detail on Request Reply used messages
  • detail on Publish Subscribe used messages

Developers Documentation

• Developing a package
• Upgrading a package to 0.4
• Tools

« previous | up | next »