Skip to content

Commit

Permalink
Doku ergänzt
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nall-chan
Nall-chan committed Jan 1, 2024
1 parent 7ff23b5 commit 82a16f3
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 20 deletions.
15 changes: 11 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![SDK](https://img.shields.io/badge/Symcon-PHPModul-red.svg)](https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/)
[![Version](https://img.shields.io/badge/Modul%20version-1.05-blue.svg)]()
[![Version](https://img.shields.io/badge/Modul%20version-1.10-blue.svg)]()
[![Version](https://img.shields.io/badge/Symcon%20Version-6.4%20%3E-green.svg)](https://www.symcon.de/de/service/dokumentation/installation/migrationen/v63-v64-q2-2023/)
[![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-green.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[![Check Style](https://github.com/Nall-chan/Xiaomi/workflows/Check%20Style/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions) [![Run Tests](https://github.com/Nall-chan/Xiaomi/workflows/Run%20Tests/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions)
[![Spenden](https://www.paypalobjects.com/de_DE/DE/i/btn/btn_donate_SM.gif)](#6-spenden)
[![Wunschliste](https://img.shields.io/badge/Wunschliste-Amazon-ff69fb.svg)](#6-spenden)
[![Spenden](https://www.paypalobjects.com/de_DE/DE/i/btn/btn_donate_SM.gif)](#3-spenden)
[![Wunschliste](https://img.shields.io/badge/Wunschliste-Amazon-ff69fb.svg)](#3-spenden)


# Xiaomi MIoT <!-- omit in toc -->
Expand Down Expand Up @@ -66,6 +66,7 @@ Folgende Module beinhaltet das Xiaomi MIoT Repository:

Über den `Module-Store` in IPS das Modul `Xiaomi MIot` hinzufügen.
**Bei kommerzieller Nutzung (z.B. als Errichter oder Integrator) wenden Sie sich bitte an den Autor.**

![Module-Store](imgs/install.png)

## 5. Einrichten der Instanzen in IP-Symcon
Expand Down Expand Up @@ -93,6 +94,10 @@ Sind die Eingaben korrekt, so wird der [Xiaomi MIoT Configurator](Xiaomi%20MIoT%

### 2. Changelog

Version 1.10:
- In den Geräte Instanzen können nicht genutzte Statusvariablen deaktiviert werden.
- Diverse Übersetzungen ergänzt.

Version 1.05:
- Übersetzungen von Tagen, Stunden, Minuten, Sekunden fehlte
- Fehlende Übersetzungen der Systemsprache werden aus der englischen Übersetzung des Gerätes ergänzt
Expand All @@ -107,7 +112,9 @@ Sind die Eingaben korrekt, so wird der [Xiaomi MIoT Configurator](Xiaomi%20MIoT%

Die Library ist für die nicht kommerzielle Nutzung kostenlos, Schenkungen als Unterstützung für den Autor werden hier akzeptiert:

<a href="https://www.paypal.com/donate?hosted_button_id=G2SLW2MEMQZH2" target="_blank"><img src="https://www.paypalobjects.com/de_DE/DE/i/btn/btn_donate_LG.gif" border="0" /></a>
<a href="https://www.paypal.com/donate?hosted_button_id=G2SLW2MEMQZH2" target="_blank"><img src="https://www.paypalobjects.com/de_DE/DE/i/btn/btn_donate_LG.gif" border="0" /></a>

[![Wunschliste](https://img.shields.io/badge/Wunschliste-Amazon-ff69fb.svg)](https://www.amazon.de/hz/wishlist/ls/YU4AI9AQT9F?ref_=wl_share)

## 7. Lizenz

Expand Down
6 changes: 3 additions & 3 deletions Xiaomi MIoT Cloud IO/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![SDK](https://img.shields.io/badge/Symcon-PHPModul-red.svg)](https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/)
[![Version](https://img.shields.io/badge/Modul%20version-1.05-blue.svg)]()
[![Version](https://img.shields.io/badge/Modul%20version-1.10-blue.svg)]()
[![Version](https://img.shields.io/badge/Symcon%20Version-6.4%20%3E-green.svg)](https://www.symcon.de/de/service/dokumentation/installation/migrationen/v63-v64-q2-2023/)
[![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-green.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[![Check Style](https://github.com/Nall-chan/Xiaomi/workflows/Check%20Style/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions) [![Run Tests](https://github.com/Nall-chan/Xiaomi/workflows/Run%20Tests/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions)
Expand Down Expand Up @@ -49,12 +49,12 @@

| Name | Text | Beschreibung |
| -------- | ------------ | ------------------------------------------------------------- |
| Username | Benutzername | eMail-Adresse, MI Konto-ID oder Rufnummer inkl. Länderkennung |
| Username | Benutzername | eMail-Adresse, MI Konto-ID oder Rufnummer (inkl. Länderkennung) |
| Password | Passwort | Passwort des Account |
| Country | Land | Auswahl welche Cloud benutzt werden soll |

Da es diverse Geräte gibt, welche keine direkte Kommunikation im lokalen Netzwerk erlauben, versucht die `Xiaomi MIoT Geräte`-Instanz das Gerät dann über die Cloud anzusprechen.
Dazu zu zwingend eine `Xiaomi MIoT Cloud IO`-Instanz als Gateway verbunden sein.
Dazu muss zwingend eine `Xiaomi MIoT Cloud IO`-Instanz als Gateway verbunden sein.

## 5. Statusvariablen und Profile

Expand Down
2 changes: 1 addition & 1 deletion Xiaomi MIoT Configurator/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![SDK](https://img.shields.io/badge/Symcon-PHPModul-red.svg)](https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/)
[![Version](https://img.shields.io/badge/Modul%20version-1.05-blue.svg)]()
[![Version](https://img.shields.io/badge/Modul%20version-1.10-blue.svg)]()
[![Version](https://img.shields.io/badge/Symcon%20Version-6.4%20%3E-green.svg)](https://www.symcon.de/de/service/dokumentation/installation/migrationen/v63-v64-q2-2023/)
[![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-green.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[![Check Style](https://github.com/Nall-chan/Xiaomi/workflows/Check%20Style/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions) [![Run Tests](https://github.com/Nall-chan/Xiaomi/workflows/Run%20Tests/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions)
Expand Down
26 changes: 14 additions & 12 deletions Xiaomi MIoT Device/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![SDK](https://img.shields.io/badge/Symcon-PHPModul-red.svg)](https://www.symcon.de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/)
[![Version](https://img.shields.io/badge/Modul%20version-1.05-blue.svg)]()
[![Version](https://img.shields.io/badge/Modul%20version-1.10-blue.svg)]()
[![Version](https://img.shields.io/badge/Symcon%20Version-6.4%20%3E-green.svg)](https://www.symcon.de/de/service/dokumentation/installation/migrationen/v63-v64-q2-2023/)
[![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-green.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[![Check Style](https://github.com/Nall-chan/Xiaomi/workflows/Check%20Style/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions) [![Run Tests](https://github.com/Nall-chan/Xiaomi/workflows/Run%20Tests/badge.svg)](https://github.com/Nall-chan/Xiaomi/actions)
Expand Down Expand Up @@ -65,12 +65,13 @@


Da es diverse Geräte gibt, welche keine direkte Kommunikation im lokalen Netzwerk erlauben, versucht die Geräte-Instanz das Gerät dann über die Cloud anzusprechen.
Dieses Verhalten kann durch die beiden Einstellungen `Cloud-Verbindung erzwingen` bzw. `Cloud-Verbindung verbieten` verändert werden.

Dieses Verhalten **kann** durch die beiden Einstellungen `Cloud-Verbindung erzwingen` bzw. `Cloud-Verbindung verbieten` verändert werden.
Es darf nur einer der beiden Einstellungen aktiv sein.
Bei `erzwingen` wird (nach dem Handshake mit dem Gerät, was immer lokal läuft) die gesamte weitere Kommunikation über die Cloud geführt.
Bei `verbieten` wird niemals automatisch auf die Cloud Verbindung umgeschaltet, wenn das Gerät auf lokale Anfragen nicht reagiert.

Im Normalfall brauchen diese Einstellungen nicht verändert werden!
**Im Normalfall brauchen diese Einstellungen nicht verändert werden!**

### Konfigurationsseite (Status und Bedienung)

Expand All @@ -79,27 +80,28 @@ Die Schaltfläche `Geräteinformationen neu laden` bewirkt das löschen alle abg

Der Bereich `Geräteinformationen` zeigt alle erkannten Eigenschaften von dem Gerät an.
Besonders hervorzuheben ist der Punkt `Model`, da eine Änderung vom Model ein automatisches neu laden der Geräteinformationen auslöst.
Der Link unter `Infosite` führt zu den MIoT Spezifikationen des Gerätes.
Der Link unter `Spezifikationen` führt zu den MIoT Spezifikationen des Gerätes.

## 5. Statusvariablen und Profile

### Statusvariablen

Die Statusvariablen inklusive der Übersetzung werden automatisch auf Basis der Gerätefähigkeiten erzeugt.

Bei fehlende Übersetzungen gibt es in der Cloud keine passende Lokalisierung, die Variablen sollten dann selbst umbenannt werden.
Bei fehlenden Übersetzungen in der Cloud, findet keine passende Lokalisierung statt, die Variablen sollten dann selbst umbenannt werden.

__Beispiel von einem Standlüfter:__

![Config](imgs/variables.png)

Der Erste Buchstabe einer Statusvariable gibt Auskunft darüber ob es sich um eine Eigenschaft vom Gerät (P) oder eine ausführbare Aktion (A) handelt.
Während Eigenschaften jeweiligen Zustand darstellen und auch abgefragt werden können, so sind Aktion nicht lesbar und können entsprechen keinen Zustand annehmen und darstellen.
**Ident der Variablen:**
Der Erste Buchstabe eines Ident einer Statusvariable gibt Auskunft darüber ob es sich um eine Eigenschaft/Wert vom Gerät (P) oder eine ausführbare Aktion (A) handelt.
Während Eigenschaften/Werte den jeweiligen Zustand darstellen und auch abgefragt werden können, so sind Aktion nicht lesbar und können entsprechen keinen Zustand annehmen und darstellen.

### Profile

Die Profile inklusive der Übersetzungen, Maßeinheiten usw. werden automatisch auf Basis der Gerätefähigkeiten erzeugt.
Statusvariablen welche Aktionen abbilden und keine Parameter erwarten, erhalten einheitlich das Profil XIAOMI.Execute mit der einzigen Assoziation 'Ausführen'.
Statusvariablen welche Aktionen abbilden und keine Parameter erwarten, erhalten einheitlich das Profil `XIAOMI.Execute` mit der einzigen Assoziation `Ausführen`.

## 6. WebFront

Expand All @@ -121,10 +123,10 @@ XIAOMI_RequestState(12345);
---
### Schreiben von Werten

**Es wird empfohlen Schaltaktionen dem universellen Befehl [`RequestAction(integer $VariableID, mixed $Value);` Link zur Doku](https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenzugriff/requestaction/) auszuführen.**
**Es wird empfohlen Schaltaktionen mit dem universellen Befehl [`RequestAction(integer $VariableID, mixed $Value);` (Link zur Doku)](https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenzugriff/requestaction/) auszuführen.**

Sollte es dennoch erforderlich gezielt Werte an bestimme Services zu senden, so stehen folgende Befehle zur Verfügung.
Dabei sind `$ServiceID` und `$PropertyID` die nummerischen Indexes der MIoT Spezifikationen des Gerätes, welche in der Konfiguration der Instanz unter [`Infosite`](#konfigurationsseite-status-und-bedienung) verlinkt sind.
Dabei sind `$ServiceID` und `$PropertyID` die nummerischen Indexes der MIoT Spezifikationen des Gerätes, welche in der Konfiguration der Instanz unter [`Spezifikationen`](#konfigurationsseite-status-und-bedienung) verlinkt sind.

```php
boolean XIAOMI_WriteValueBoolean(integer $InstanzID, integer $ServiceID, integer $PropertyID, boolean $Value);
Expand All @@ -140,10 +142,10 @@ XIAOMI_WriteValueBoolean(12345, 1, 1, true);
---
### Ausführen einer Aktion

**Es wird empfohlen Schaltaktionen dem universellen Befehl [`RequestAction(integer $VariableID, mixed $Value);` Link zur Doku](https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenzugriff/requestaction/) auszuführen.**
**Es wird empfohlen Schaltaktionen mit dem universellen Befehl [`RequestAction(integer $VariableID, mixed $Value);` (Link zur Doku)](https://www.symcon.de/de/service/dokumentation/befehlsreferenz/variablenzugriff/requestaction/) auszuführen.**

Verfügbare Werte sind z.B. dem Variablenprofil zu entnehmen, oder bei Aktionen welche keine Parameter erwarten irrelevant.
Dabei sind `$ServiceID` und `$ActionID` die nummerischen Indexes der MIoT Spezifikationen des Gerätes, welche in der Konfiguration der Instanz unter [`Infosite`](#konfigurationsseite-status-und-bedienung) verlinkt sind.
Dabei sind `$ServiceID` und `$ActionID` die nummerischen Indexes der MIoT Spezifikationen des Gerätes, welche in der Konfiguration der Instanz unter [`Spezifikationen`](#konfigurationsseite-status-und-bedienung) verlinkt sind.

```php
boolean XIAOMI_ExecuteAction(integer $InstanzID, integer $ServiceID, integer $ActionID, array $Values);
Expand Down
Binary file modified Xiaomi MIoT Device/imgs/config.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 82a16f3

Please sign in to comment.