Skip to content

Commit

Permalink
deploy: 4a94d1c
Browse files Browse the repository at this point in the history
  • Loading branch information
@hahn-th
hahn-th committed May 4, 2024
0 parents commit b28ec8d
Show file tree
Hide file tree
Showing 66 changed files with 7,498 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 14ab13b2fe4cbd742cfe48a225e2e846
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/api_introduction.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/gettingstarted.doctree
Binary file not shown.
Binary file added .doctrees/homematicip.aio.doctree
Binary file not shown.
Binary file added .doctrees/homematicip.base.doctree
Binary file not shown.
Binary file added .doctrees/homematicip.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/modules.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
198 changes: 198 additions & 0 deletions _modules/homematicip/auth.html

Large diffs are not rendered by default.

111 changes: 111 additions & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; HomematicIP-Rest-API 0.0.post1.dev1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=42336cb0"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
HomematicIP-Rest-API
</a>
<div class="version">
0.0.post1.dev1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gettingstarted.html">Getting Started</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api_introduction.html">API Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../modules.html">homematicip</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">HomematicIP-Rest-API</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Overview: module code</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="homematicip/auth.html">homematicip.auth</a></li>
</ul>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Thomas Hahn.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
17 changes: 17 additions & 0 deletions _sources/api_introduction.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
API Introduction
****************

There are a few key classes for communication with the Rest API of HomematicIP.

| **Home:** is the most important object as it has the "overview" of the installation
| **Group:** a group of devices for a specific need. E.g. Heating group, security group, ...
| **MetaGroup:** a collection of groups. In the HomematicIP App this is called a "Room"
| **Device:** a hardware device e.g. shutter contact, heating thermostat, alarm siren, ...
| **FunctionChannel:** a channel of a device. For example DoorLockChannel for DoorLockDrive or **DimmerChannel**. A device has multiple channels - depending on its functions.
| For example:
| The device HmIP-DLD is represented by the class **DoorLockDrive** (or AsyncDoorLockDrive). The device has multiple channels.
| The base channel holds informations about the device and has the index 0.
| The device has also a channel called **DoorLockChannel** which contains the functions "set_lock_state" and "async_set_lock_state". These are functions to set the lock state of that device.
If you have dimmer with multiple I/Os, there are multiple channels. For each I/O a unique channel.
66 changes: 66 additions & 0 deletions _sources/gettingstarted.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
Getting Started
***************

Installation
============

Just run **pip3 install -U homematicip** in the command line to get the package.
This will install (and update) the library and all required packages

Getting the AUTH-TOKEN
======================
Before you can start using the library you will need an auth-token. Otherwise the HMIP Cloud will not trust you.

You will need:

- Access to an active Access Point (it must glow blue)
- the SGTIN of the Access Point
- [optional] the PIN

Now you have to run **hmip_generate_auth_token.py** and follow it's instructions.
It will generate a **config.ini** in your current working directory. The scripts which are using this library are looking
for this file to load the auth-token and SGTIN of the Access Point. You can either place it in the working directory when you are
running the scripts or depending on your OS in different "global" folders:

- General

- current working directory

- Windows

- %APPDATA%\\homematicip-rest-api\
- %PROGRAMDATA%\\homematicip-rest-api\

- Linux

- ~/.homematicip-rest-api/
- /etc/homematicip-rest-api/

- MAC OS

- ~/Library/Preferences/homematicip-rest-api/
- /Library/Application Support/homematicip-rest-api/

Using the CLI
=============

You can send commands to homematicIP using the `hmip_cli.py` script. To get an overview, use -h or --help param. To address devices, use the argument -d in combination with the 24-digit ID (301400000000000000000000) from --list-devices.

Get Information about devices and groups
----------------------------------------

Commands are bound to the channel type. To get a list of all allowed actions for a device you can write `hmip_cli -d {deviceid} --print-allowed-commands` or `hmip_cli -d {deviceid} -ac`.

To get infos for a device and its channels use the `--print-infos` argument in combination with -d for a device or -g for a group.

Examples
--------

A few examples:

- `python hmip_cli.py --help` to get help
- `python hmip_cli.py --list-devices` to get a list of your devices.
- `python hmip_cli.py -d <id-from-device-list> --toggle-garage-door` to toogle the garage door with HmIP-WGC.
- `python hmip_cli.py --list-events` to listen to events and changes in your homematicIP system
- `python hmip_cli.py -d <id> --set-lock-state LOCKED --pin 1234` to lock a door with HmIP-DLD
- `python hmip_cli.py --dump-configuration --anonymize` to dump the current config and anonymize it.
77 changes: 77 additions & 0 deletions _sources/homematicip.aio.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
homematicip.aio package
=======================

Submodules
----------

homematicip.aio.auth module
---------------------------

.. automodule:: homematicip.aio.auth
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.class\_maps module
----------------------------------

.. automodule:: homematicip.aio.class_maps
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.connection module
---------------------------------

.. automodule:: homematicip.aio.connection
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.device module
-----------------------------

.. automodule:: homematicip.aio.device
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.group module
----------------------------

.. automodule:: homematicip.aio.group
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.home module
---------------------------

.. automodule:: homematicip.aio.home
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.rule module
---------------------------

.. automodule:: homematicip.aio.rule
:members:
:undoc-members:
:show-inheritance:

homematicip.aio.securityEvent module
------------------------------------

.. automodule:: homematicip.aio.securityEvent
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: homematicip.aio
:members:
:undoc-members:
:show-inheritance:
61 changes: 61 additions & 0 deletions _sources/homematicip.base.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
homematicip.base package
========================

Submodules
----------

homematicip.base.HomeMaticIPObject module
-----------------------------------------

.. automodule:: homematicip.base.HomeMaticIPObject
:members:
:undoc-members:
:show-inheritance:

homematicip.base.base\_connection module
----------------------------------------

.. automodule:: homematicip.base.base_connection
:members:
:undoc-members:
:show-inheritance:

homematicip.base.constants module
---------------------------------

.. automodule:: homematicip.base.constants
:members:
:undoc-members:
:show-inheritance:

homematicip.base.enums module
-----------------------------

.. automodule:: homematicip.base.enums
:members:
:undoc-members:
:show-inheritance:

homematicip.base.functionalChannels module
------------------------------------------

.. automodule:: homematicip.base.functionalChannels
:members:
:undoc-members:
:show-inheritance:

homematicip.base.helpers module
-------------------------------

.. automodule:: homematicip.base.helpers
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: homematicip.base
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit b28ec8d

Please sign in to comment.