-
Notifications
You must be signed in to change notification settings - Fork 99
Expand file tree
/
Copy pathplugin.yaml
More file actions
executable file
·183 lines (173 loc) · 8.14 KB
/
plugin.yaml
File metadata and controls
executable file
·183 lines (173 loc) · 8.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# Metadata for the Smart-Plugin
plugin:
# Global plugin attributes
type: web # plugin type (gateway, interface, protocol, system, web)
description:
de: 'Anbindung der BSH/Siemens HomeConnect Schnittstelle mit Oauth2'
en: 'Usage of the BSH/Siemens HomeConnect interface with oauth2'
maintainer: psilo909
tester: psilo909
state: develop
keywords: smart devices
documentation: ''
support: ''
version: 1.0.0 # Plugin version
sh_minversion: '1.7' # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
multi_instance: False # plugin supports multi instance
restartable: False
classname: SHNGHomeConnect # class containing the plugin
parameters:
# Definition of parameters to be configured in etc/plugin.yaml
client_id:
type: str
mandatory: True
description:
de: 'Client ID von https://developer.home-connect.com/'
en: 'Client ID from https://developer.home-connect.com/'
client_secret:
type: str
#default: 300 Default: 300 makes no sense for this parameter
mandatory: True
description:
de: 'Client Secret von https://developer.home-connect.com/'
en: 'Client Secret from https://developer.home-connect.com/'
simulate:
type: bool
default: False
mandatory: False
description:
de: 'Aktiviert den Simulationsmodus, um gegen virtuelle Geräte (Appliances) zu testen.'
en: 'Enables the simulation mode to test against virtual devices (appliances).'
cycle:
type: int
default: 300
description:
de: 'Dieser Parameter muss normalerweise nicht angegeben werden. Er erlaubt es die Update-Frquenz anzupassen (Standard: alle 600 Sekunden). Mit dem Standardwert werden die Daten von Nokia Health alle 5 Minuten aktualisiert.'
en: "This parameter usually doesn't have to be specified. It allows to change the update frequency (cycle every 300 seconds). As a standard, the plugin updates the Nokia Health data every 5 minutes."
item_attributes:
# Definition of item attributes defined by this plugin
homeconnect_data_type:
type: str
mandatory: True
description:
de: 'HomeConnect Datentyp des jeweiligen Items.'
en: 'HomeConnect Data Type of the respective item.'
valid_list:
- 'status'
ha_id:
type: str
mandatory: True
description:
de: 'haId des jeweiligen Items (siehe Appliance Liste im WebInterface des Plugins).'
en: 'haId of the respective item (see in appliance list in web interface of the plugin).'
item_structs: NONE
# Definition of item-structure templates for this plugin (enter 'item_structs: NONE', if section should be empty)
#item_attribute_prefixes:
# Definition of item attributes that only have a common prefix (enter 'item_attribute_prefixes: NONE' or ommit this section, if section should be empty)
# NOTE: This section should only be used, if really nessesary (e.g. for the stateengine plugin)
logic_parameters: NONE
# Definition of logic parameters defined by this plugin
plugin_functions:
# Definition of function interface of the plugin
get_redirect_url:
type: str
description:
de: 'Gibt die Redirect URL des HomeConnect Plugins zurück.'
en: 'Returns the redirect url of the HomeConnect plugin.'
get_hc:
type: foo
description:
de: 'Gibt das HomeConnect Objekt des HomeConnect Plugins zurück.'
en: 'Returns the HomeConnect object of the HomeConnect plugin.'
get_programs_available:
type: list(str)
description:
de: "Gibt die verfügbaren Programme einer Appliance zurück."
en: "Returns the available programs of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
get_programs_active:
type: str
description:
de: "Gibt die aktiven Programme einer Appliance zurück."
en: "Returns the active programs of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
get_programs_selected:
type: str
description:
de: "Gibt die selektierten Programme einer Appliance zurück."
en: "Returns the selected programs of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
get_program_options:
type: list(str)
description:
de: "Gibt die selektierten Programme einer Appliance zurück."
en: "Returns the selected programs of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
program_key:
type: str
description:
de: "program_key des Programms, dessen Optionen zurückgegeben werden sollen (im Web-Interface des Plugins zu sehen)"
en: "program_key of the program, whose options shall be retreiver (can be found in the web interface of the plugin)"
start_program:
type: str
description:
de: "Startet das Programm einer Appliance."
en: "Starts the program of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
program_key:
type: str
description:
de: "program_key des Programms, das ausgeführt werden soll (im Web-Interface des Plugins zu sehen)"
en: "program_key of the program, which shall be started (can be found in the web interface of the plugin)"
options:
type: str
description:
de: "Optionen des Programms, das ausgeführt werden soll (im Web-Interface des Plugins zu sehen)"
en: "Options of the program, which shall be started (can be found in the web interface of the plugin)"
stop_program:
type: str
description:
de: "Stoppt das Programm einer Appliance."
en: "Stops the program of an appliance."
parameters:
ha_id:
type: str
description:
de: "ha_id der Appliance (im Web-Interface des Plugins zu sehen)"
en: "ha_id of the appliance (can be found in the web interface of the plugin)"
program_key:
type: str
description:
de: "program_key des Programms, das gestoppt werden soll (im Web-Interface des Plugins zu sehen)"
en: "program_key of the program, which shall be stopped (can be found in the web interface of the plugin)"
options:
type: str
description:
de: "Optionen des Programms, das gestoppt werden soll (im Web-Interface des Plugins zu sehen)"
en: "Options of the program, which shall be stopped (can be found in the web interface of the plugin)"