Skip to content

Commit

Permalink
no message
Browse files Browse the repository at this point in the history
  • Loading branch information
Nall-chan committed Nov 5, 2023
1 parent 3d39c74 commit 5079156
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 42 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Ermöglicht die Einbindung von Xiaomi Geräten in IP-Symcon.

## Inhaltsverzeichnis <!-- omit in toc -->

- [1. Vorbemerkungen](#1-vorbemerkungen)
- [Zur Library](#zur-library)
- [Zur Integration von Geräten](#zur-integration-von-geräten)
Expand Down Expand Up @@ -84,11 +85,11 @@ Sind die Eingaben korrekt, so wird der Konfigurator geöffnet.
### 1. GUID der Module


| Modul | Typ | Prefix | GUID |
| :----------------------: | :----------: | :----: | :------------------------------------: |
| Xiaomi MIoT Cloud IO | IO | XIAOMI | {DF2248D9-FC17-4609-840D-BA52DBF9CEB6} |
| Modul | Typ | Prefix | GUID |
| ------------------------ | ------------ | ------ | -------------------------------------- |
| Xiaomi MIoT Cloud IO | IO | XIAOMI | {DF2248D9-FC17-4609-840D-BA52DBF9CEB6} |
| Xiaomi MIoT Configurator | Configurator | XIAOMI | {CCB7419D-F038-E519-8D63-171260FED0A0} |
| Xiaomi MIoT Device | Device | XIAOMI | {733AB5D2-957D-E76A-BA5D-5006701A6216} |
| Xiaomi MIoT Device | Device | XIAOMI | {733AB5D2-957D-E76A-BA5D-5006701A6216} |

### 2. Changelog

Expand Down
90 changes: 52 additions & 38 deletions Xiaomi MIoT Device/README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,78 @@
# Xiaomi Mi Device
Beschreibung des Moduls.
[![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.00-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)

### Inhaltsverzeichnis
# Xiaomi MIoT Device <!-- omit in toc -->

1. [Funktionsumfang](#1-funktionsumfang)
2. [Voraussetzungen](#2-voraussetzungen)
3. [Software-Installation](#3-software-installation)
4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon)
5. [Statusvariablen und Profile](#5-statusvariablen-und-profile)
6. [WebFront](#6-webfront)
7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz)
## Inhaltsverzeichnis <!-- omit in toc -->

### 1. Funktionsumfang
- [1. Funktionsumfang](#1-funktionsumfang)
- [2. Voraussetzungen](#2-voraussetzungen)
- [3. Software-Installation](#3-software-installation)
- [4. Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon)
- [5. Statusvariablen und Profile](#5-statusvariablen-und-profile)
- [Statusvariablen](#statusvariablen)
- [Profile](#profile)
- [6. WebFront](#6-webfront)
- [7. PHP-Befehlsreferenz](#7-php-befehlsreferenz)

*
## 1. Funktionsumfang

### 2. Voraussetzungen
* Instanz für die Integration eines Xiaomi Gerätes in von Symcon.

- IP-Symcon ab Version 6.0
## 2. Voraussetzungen

### 3. Software-Installation
- IPS 6.4 oder höher
- Eingebundene Geräte in der Mi Home App

* Über den Module Store das 'Xiaomi Mi Device'-Modul installieren.
* Alternativ über das Module Control folgende URL hinzufügen
## 3. Software-Installation

### 4. Einrichten der Instanzen in IP-Symcon
* Dieses Modul ist Bestandteil der [Xiaomi MIoT-Library](../README.md#4-software-installation).

Unter 'Instanz hinzufügen' kann das 'Xiaomi Mi Device'-Modul mithilfe des Schnellfilters gefunden werden.
- Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen)
## 4. Einrichten der Instanzen in IP-Symcon

Unter 'Instanz hinzufügen' ist das 'Xiaomi MIoT Device'-Modul unter dem Hersteller `Xiaomi` aufgeführt.
![Module](../imgs/Module.png)

Es wird empfohlen diese Instanz über die dazugehörige Instanz des [MIoT Configurator-Moduls](../Xiaomi%20MIoT%20Configurator/README.md) von diesem Geräte anzulegen.

__Konfigurationsseite__:

Name | Beschreibung
-------- | ------------------
|
|
![Config](imgs/Config.png)

| Name | Beschreibung |
| ---- | ------------ |
| |
| |

### 5. Statusvariablen und Profile
## 5. Statusvariablen und Profile

Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen.

#### Statusvariablen
### Statusvariablen

Name | Typ | Beschreibung
------ | ------- | ------------
| |
| |
| Name | Typ | Beschreibung |
| --------------- | ------- | ----------------------------------------- |
| Open | boolean | Verbindung aktiv |
| Host | string | IP-Adresse von dem Gerät |
| DeviceId | string | Geräte ID zur eindeutigen Identifizierung |
| ForceCloud | boolean | Cloud Anbindung erzwingen |
| DeniedCloud | boolean | Cloud Anbindung verbieten |
| RefreshInterval | integer | Intervall der Statusaktualisierung |

#### Profile
### Profile

Name | Typ
------ | -------
|
|
Profile werden auf Basis der Gerätefähigkeiten erzeugt.

### 6. WebFront
## 6. WebFront

Die Funktionalität, die das Modul im WebFront bietet.
Die direkte Darstellung des Medien-Objektes und der eventuellen Statusvariablen von Ereignissen ist möglich; es wird aber empfohlen mit Links zu arbeiten.

### 7. PHP-Befehlsreferenz
## 7. PHP-Befehlsreferenz

`boolean XIAOMI_BeispielFunktion(integer $InstanzID);`
Erklärung der Funktion.
Expand Down
Binary file added Xiaomi MIoT Device/imgs/Config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Xiaomi MIoT Device/locale.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"Connection established": "Verbindung hergestellt",
"Reconnect successfully": "Wiederverbinden erfolgreich",
"disconnected": "getrennt",
"Execute":"Ausführen",
"Request state": "Zustand lesen",
"Reload device information": "Geräteinformationen neu laden",
"Device information": "Geräteinformationen",
Expand Down
1 change: 1 addition & 0 deletions Xiaomi MIoT Device/module.php
Original file line number Diff line number Diff line change
Expand Up @@ -781,6 +781,7 @@ private function GetModelData(): bool
$this->WriteAttributeArray(\Xiaomi\Device\Attribute::Specs, $Specs['props']['spec']);
$this->loadLocale($Specs['props']['spec']['urn']);
// Wenn nicht vorhanden, dann geht auch nicht das get/set_properties + siid/piid protokoll ?!
$this->ReloadForm();
return true;
}
private function loadLocale(string $Urn)
Expand Down
Binary file added imgs/Module.png
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 5079156

Please sign in to comment.