Skip to content

Commit

Permalink
Bulb zu Light geändert.
Browse files Browse the repository at this point in the history
Discovery Instanz ergänzt.
Doku angefangen.
  • Loading branch information
Nall-chan committed Jan 9, 2024
1 parent 2ffb743 commit 49df22e
Show file tree
Hide file tree
Showing 14 changed files with 553 additions and 341 deletions.
21 changes: 0 additions & 21 deletions Tapo Bulb/locale.json

This file was deleted.

92 changes: 92 additions & 0 deletions Tapo Discovery/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
[![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.60-blue.svg)](https://community.symcon.de/t/modul-tp-link-tapo-smarthome/131865)
[![Version](https://img.shields.io/badge/Symcon%20Version-6.1%20%3E-green.svg)](https://www.symcon.de/service/dokumentation/installation/migrationen/v60-v61-q1-2022/)
[![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/SSHClient/workflows/Check%20Style/badge.svg)](https://github.com/Nall-chan/tapo-SmartHome/actions)
[![Run Tests](https://github.com/Nall-chan/SSHClient/workflows/Run%20Tests/badge.svg)](https://github.com/Nall-chan/tapo-SmartHome/actions)
[![Spenden](https://www.paypalobjects.com/de_DE/DE/i/btn/btn_donate_SM.gif)](#2-spenden)
[![Wunschliste](https://img.shields.io/badge/Wunschliste-Amazon-ff69fb.svg)](#2-spenden)
# tapo Discovery <!-- omit in toc -->

## Inhaltsverzeichnis <!-- 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. PHP-Befehlsreferenz](#6-php-befehlsreferenz)
- [7. Aktionen](#7-aktionen)
- [8. Anhang](#8-anhang)
- [1. Changelog](#1-changelog)
- [2. Spenden](#2-spenden)
- [9. Lizenz](#9-lizenz)


## 1. Funktionsumfang

- Auffinden von tapo SmartHome Geräten im Netzwerk.
- Einfaches Anlegen von dem benötigten Geräte Instanzen, oder den Konfiguratoren mit Gateway Instanzen.

## 2. Voraussetzungen

- IP-Symcon ab Version 6.1

## 3. Software-Installation

* Dieses Modul ist Bestandteil der [tapo SmartHome-Library](../README.md#3-software-installation).

## 4. Einrichten der Instanzen in IP-Symcon

Eine einfache Einrichtung ist über diese Instanz möglich.
Bei der installation aus dem Store wird das anlegen der Instanz automatisch angeboten.

Bei der manuellen Einrichtung ist das Modul im Dialog `Instanz hinzufügen` unter den Hersteller `TP-Link` zu finden.
![Instanz hinzufügen](../imgs/module.png)

Alternativ ist es auch in der Liste alle Konfiguratoren aufgeführt.
![Instanz hinzufügen](../imgs/module_discovery.png)

Die Suche im Netzwerk nutzt einen Broadcast auf Port 20002.

Damit Symcon mit den Geräten kommunizieren können, müssen diese in der TP-Link Cloud angemeldet und registriert sein.
Die entsprechenden Cloud-Zugangsdaten sind in der Discovery-Instanz einzutragen, damit die Instanzen gleich mit den korrekten Daten erstellt werden.

Über das selektieren eines Eintrages in der Tabelle und betätigen des dazugehörigen `Erstellen` Button,
wird automatisch eine [Geräte-Instanz](../README.md#2-geräte-instanzen) erzeugt, sofern es sich **nicht** um einen Smart Hub handelt.
Bei einem Smart Hub wird eine [Konfigurator-Instanz](../Tapo%20Configurator/README.md) und eine, [Gateway-Instanz](../Tapo%20Gateway/README.md) erzeugt.

![Discovery](../imgs/conf_discovery.png)

## 5. Statusvariablen und Profile

Dieses Modul erstellt keine Statusvariablen und Profile.

## 6. PHP-Befehlsreferenz

Dieses Modul besitzt keine Instanz-Funktionen.

## 7. Aktionen

Es gibt keine speziellen Aktionen für dieses Modul.

## 8. Anhang

### 1. Changelog

[Changelog der Library](../README.md#1-changelog)

### 2. Spenden

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>

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


## 9. Lizenz

IPS-Modul:
[CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)

104 changes: 54 additions & 50 deletions Tapo Bulb/form.json → Tapo Discovery/form.json
Original file line number Diff line number Diff line change
@@ -1,58 +1,69 @@
{
"elements": [
"actions": [
{
"type": "RowLayout",
"type": "ExpansionPanel",
"caption": "Credentials",
"expanded": true,
"items": [
{
"name": "Open",
"type": "CheckBox",
"caption": "Open",
"width": "300px"
},
{
"name": "Host",
"type": "ValidationTextBox",
"caption": "Host"
"type": "RowLayout",
"items": [
{
"name": "Username",
"type": "ValidationTextBox",
"caption": "Username"
},
{
"name": "Password",
"type": "PasswordTextBox",
"caption": "Password"
},
{
"onClick": "IPS_RequestAction($id,'Save',urlencode($Username).':'.urlencode($Password));",
"type": "Button",
"caption": "Save & Reload"
}
]
}
]
},
{
"type": "RowLayout",
"items": [
"type": "Configurator",
"name": "Configurator",
"add": false,
"delete": true,
"sort": {
"column": "host",
"direction": "ascending"
},
"columns": [
{
"name": "Username",
"type": "ValidationTextBox",
"caption": "Username",
"width": "300px"
"caption": "Hostname",
"name": "host",
"width": "200px"
},
{
"name": "Password",
"type": "PasswordTextBox",
"caption": "Password"
"caption": "MAC",
"name": "mac",
"width": "200px"
},
{
"caption": "Name",
"name": "name",
"width": "auto"
},
{
"caption": "Type",
"name": "device_type",
"width": "200px"
},
{
"caption": "Model",
"name": "device_model",
"width": "200px"
}
]
},
{
"name": "Interval",
"type": "NumberSpinner",
"caption": "Read interval",
"suffix": "seconds",
"minimum": 0
},
{
"name": "AutoRename",
"type": "CheckBox",
"caption": "Auto rename instance"
}
],
"actions": [
{
"type": "TestCenter"
},
{
"type": "Label",
"bold": true,
"caption": "This module contains 'phpseclib - PHP Secure Communications Library' (https://github.com/phpseclib/phpseclib)"
],
"values": []
},
{
"type": "Label",
Expand All @@ -73,12 +84,5 @@
}
]
}
],
"status": [
{
"code": 201,
"icon": "error",
"caption": "Not connected"
}
]
}
12 changes: 12 additions & 0 deletions Tapo Discovery/locale.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"translations": {
"de": {
"Credentials": "Anmeldedaten",
"Username": "Benutzername",
"Password": "Passwort",
"Save & Reload": "Speichern & Neuladen",
"Type": "Typ",
"This module is free for non-commercial use,\r\nDonations in support of the author are accepted here:": "Dieses Modul ist für die nicht kommerzielle Nutzung kostenlos,\r\nSchenkungen als Unterstützung für den Autor werden hier akzeptiert:"
}
}
}
12 changes: 12 additions & 0 deletions Tapo Discovery/module.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"id": "{DCD52B0C-3E06-4EFE-AA95-C54709AC87D3}",
"name": "tapo Discovery",
"type": 5,
"vendor": "TP-Link",
"aliases": [],
"parentRequirements": [],
"childRequirements": [],
"implemented": [],
"prefix": "TAPOSH",
"url": "https://github.com/Nall-chan/tapoSmartHome"
}
Loading

0 comments on commit 49df22e

Please sign in to comment.