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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
%global _empty_manifest_terminate_build 0
Name: python-devolo-home-control-api
Version: 0.18.2
Release: 1
Summary: devolo Home Control API in Python
License: GPLv3
URL: https://github.com/2Fake/devolo_home_control_api
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/10/d4/05855ef926a73df33024290fd95a972c861d7067db9cb9642f242221383a/devolo_home_control_api-0.18.2.tar.gz
BuildArch: noarch
Requires: python3-requests
Requires: python3-websocket-client
Requires: python3-zeroconf
Requires: python3-importlib-metadata
Requires: python3-pre-commit
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-mock
%description
# devolo Home Control API
[](https://github.com/2Fake/devolo_home_control_api/actions?query=workflow%3A%22Python+package%22)
[](https://pypi.org/project/devolo-home-control-api/)
[](https://codeclimate.com/github/2Fake/devolo_home_control_api)
[](https://coveralls.io/github/2Fake/devolo_home_control_api?branch=master)
This project implements parts of the devolo Home Control API in Python. It is based on reverse engineering and therefore may fail with any new devolo update. If you discover a breakage, please feel free to [report an issue](https://github.com/2Fake/devolo_home_control_api/issues).
## System requirements
Defining the system requirements with exact versions typically is difficult. But there is a tested environment:
* Linux
* Python 3.7.12
* pip 22.0.1
* requests 2.27.1
* websocket_client 1.3.1
* zeroconf 0.38.4
Other versions and even other operating systems might work. Feel free to tell us about your experience. If you want to run our unit tests, you also need:
* pytest 7.0.1
* pytest-mock 3.7.0
## Versioning
In our versioning we follow [Semantic Versioning](https://semver.org/).
## Installing for usage
The Python Package Index takes care for you. Just use pip.
```bash
pip install devolo-home-control-api
```
## Installing for development
First, you need to get the sources.
```bash
git clone git@github.com:2Fake/devolo_home_control_api.git
```
Then you need to take care of the requirements.
```bash
cd devolo_home_control_api
python setup.py install
```
If you want to run out tests, install the extra requirements and start pytest.
```bash
pip install -e .[test]
pytest
```
## Quick start
To see that basic functionality, please look at our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). For this example, a working Home Control Central Unit must be attached to your my devolo account. After entering your my devolo username and password, simply run it:
```bash
python3 example.py
```
You will see changes to any BinarySwitch device (e.g. state or consumption) reported to your console. If the executing device is in the same LAN as the Home Control Central Unit, it will be discovered via Zeroconf. In this case, data will be collected from the Central Unit directly; otherwise data will be collected via cloud from my devolo.
### Connecting to my devolo
If you do not know your gateway ID, you can ask my devolo. For now, no other functionality is implemented, that you would need to access directly. If you discover other use cases, feel free to file a feature request.
```python
mydevolo = Mydevolo.get_instance()
mydevolo.user = "username"
mydevolo.password = "password"
for gateway_id in mydevolo.get_gateway_ids():
print(gateway_id)
```
### Collecting Home Control data
There are two ways of getting data:
1. Let the websocket push data into your object, but still poll the object
1. Subscribe to the publisher and let it push (preferred)
#### Using websockets
When using websocket events, messages will keep the object up to date. Nevertheless, no further action is triggered. So you have to ask yourself. The following example will list the current state of all binary switches. If the state changes, you will not notice unless you ask again.
```python
homecontrol = HomeControl(gateway_id=gateway_id, mydevolo_instance=mydevolo)
for binary_switch in mprm.binary_switch_devices:
for state in binary_switch.binary_switch_property:
print (f"State of {binary_switch.name} ({binary_switch.binary_switch_property[state].element_uid}): {binary_switch.binary_switch_property[state].state}")
```
To execute this example, you again need a configured instance of Mydevolo.
#### Using subscriber
This preferred usage is shown in our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). On every websocket event, ```update()``` will be called. That way you can react to changes right away.
## Further usage
You will find snippets discribing other use cases in our [wiki](https://github.com/2Fake/devolo_home_control_api/wiki).
%package -n python3-devolo-home-control-api
Summary: devolo Home Control API in Python
Provides: python-devolo-home-control-api
BuildRequires: python3-devel
BuildRequires: python3-setuptools
%description -n python3-devolo-home-control-api
# devolo Home Control API
[](https://github.com/2Fake/devolo_home_control_api/actions?query=workflow%3A%22Python+package%22)
[](https://pypi.org/project/devolo-home-control-api/)
[](https://codeclimate.com/github/2Fake/devolo_home_control_api)
[](https://coveralls.io/github/2Fake/devolo_home_control_api?branch=master)
This project implements parts of the devolo Home Control API in Python. It is based on reverse engineering and therefore may fail with any new devolo update. If you discover a breakage, please feel free to [report an issue](https://github.com/2Fake/devolo_home_control_api/issues).
## System requirements
Defining the system requirements with exact versions typically is difficult. But there is a tested environment:
* Linux
* Python 3.7.12
* pip 22.0.1
* requests 2.27.1
* websocket_client 1.3.1
* zeroconf 0.38.4
Other versions and even other operating systems might work. Feel free to tell us about your experience. If you want to run our unit tests, you also need:
* pytest 7.0.1
* pytest-mock 3.7.0
## Versioning
In our versioning we follow [Semantic Versioning](https://semver.org/).
## Installing for usage
The Python Package Index takes care for you. Just use pip.
```bash
pip install devolo-home-control-api
```
## Installing for development
First, you need to get the sources.
```bash
git clone git@github.com:2Fake/devolo_home_control_api.git
```
Then you need to take care of the requirements.
```bash
cd devolo_home_control_api
python setup.py install
```
If you want to run out tests, install the extra requirements and start pytest.
```bash
pip install -e .[test]
pytest
```
## Quick start
To see that basic functionality, please look at our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). For this example, a working Home Control Central Unit must be attached to your my devolo account. After entering your my devolo username and password, simply run it:
```bash
python3 example.py
```
You will see changes to any BinarySwitch device (e.g. state or consumption) reported to your console. If the executing device is in the same LAN as the Home Control Central Unit, it will be discovered via Zeroconf. In this case, data will be collected from the Central Unit directly; otherwise data will be collected via cloud from my devolo.
### Connecting to my devolo
If you do not know your gateway ID, you can ask my devolo. For now, no other functionality is implemented, that you would need to access directly. If you discover other use cases, feel free to file a feature request.
```python
mydevolo = Mydevolo.get_instance()
mydevolo.user = "username"
mydevolo.password = "password"
for gateway_id in mydevolo.get_gateway_ids():
print(gateway_id)
```
### Collecting Home Control data
There are two ways of getting data:
1. Let the websocket push data into your object, but still poll the object
1. Subscribe to the publisher and let it push (preferred)
#### Using websockets
When using websocket events, messages will keep the object up to date. Nevertheless, no further action is triggered. So you have to ask yourself. The following example will list the current state of all binary switches. If the state changes, you will not notice unless you ask again.
```python
homecontrol = HomeControl(gateway_id=gateway_id, mydevolo_instance=mydevolo)
for binary_switch in mprm.binary_switch_devices:
for state in binary_switch.binary_switch_property:
print (f"State of {binary_switch.name} ({binary_switch.binary_switch_property[state].element_uid}): {binary_switch.binary_switch_property[state].state}")
```
To execute this example, you again need a configured instance of Mydevolo.
#### Using subscriber
This preferred usage is shown in our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). On every websocket event, ```update()``` will be called. That way you can react to changes right away.
## Further usage
You will find snippets discribing other use cases in our [wiki](https://github.com/2Fake/devolo_home_control_api/wiki).
%package help
Summary: Development documents and examples for devolo-home-control-api
Provides: python3-devolo-home-control-api-doc
%description help
# devolo Home Control API
[](https://github.com/2Fake/devolo_home_control_api/actions?query=workflow%3A%22Python+package%22)
[](https://pypi.org/project/devolo-home-control-api/)
[](https://codeclimate.com/github/2Fake/devolo_home_control_api)
[](https://coveralls.io/github/2Fake/devolo_home_control_api?branch=master)
This project implements parts of the devolo Home Control API in Python. It is based on reverse engineering and therefore may fail with any new devolo update. If you discover a breakage, please feel free to [report an issue](https://github.com/2Fake/devolo_home_control_api/issues).
## System requirements
Defining the system requirements with exact versions typically is difficult. But there is a tested environment:
* Linux
* Python 3.7.12
* pip 22.0.1
* requests 2.27.1
* websocket_client 1.3.1
* zeroconf 0.38.4
Other versions and even other operating systems might work. Feel free to tell us about your experience. If you want to run our unit tests, you also need:
* pytest 7.0.1
* pytest-mock 3.7.0
## Versioning
In our versioning we follow [Semantic Versioning](https://semver.org/).
## Installing for usage
The Python Package Index takes care for you. Just use pip.
```bash
pip install devolo-home-control-api
```
## Installing for development
First, you need to get the sources.
```bash
git clone git@github.com:2Fake/devolo_home_control_api.git
```
Then you need to take care of the requirements.
```bash
cd devolo_home_control_api
python setup.py install
```
If you want to run out tests, install the extra requirements and start pytest.
```bash
pip install -e .[test]
pytest
```
## Quick start
To see that basic functionality, please look at our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). For this example, a working Home Control Central Unit must be attached to your my devolo account. After entering your my devolo username and password, simply run it:
```bash
python3 example.py
```
You will see changes to any BinarySwitch device (e.g. state or consumption) reported to your console. If the executing device is in the same LAN as the Home Control Central Unit, it will be discovered via Zeroconf. In this case, data will be collected from the Central Unit directly; otherwise data will be collected via cloud from my devolo.
### Connecting to my devolo
If you do not know your gateway ID, you can ask my devolo. For now, no other functionality is implemented, that you would need to access directly. If you discover other use cases, feel free to file a feature request.
```python
mydevolo = Mydevolo.get_instance()
mydevolo.user = "username"
mydevolo.password = "password"
for gateway_id in mydevolo.get_gateway_ids():
print(gateway_id)
```
### Collecting Home Control data
There are two ways of getting data:
1. Let the websocket push data into your object, but still poll the object
1. Subscribe to the publisher and let it push (preferred)
#### Using websockets
When using websocket events, messages will keep the object up to date. Nevertheless, no further action is triggered. So you have to ask yourself. The following example will list the current state of all binary switches. If the state changes, you will not notice unless you ask again.
```python
homecontrol = HomeControl(gateway_id=gateway_id, mydevolo_instance=mydevolo)
for binary_switch in mprm.binary_switch_devices:
for state in binary_switch.binary_switch_property:
print (f"State of {binary_switch.name} ({binary_switch.binary_switch_property[state].element_uid}): {binary_switch.binary_switch_property[state].state}")
```
To execute this example, you again need a configured instance of Mydevolo.
#### Using subscriber
This preferred usage is shown in our [small example](https://github.com/2Fake/devolo_home_control_api/blob/master/example.py). On every websocket event, ```update()``` will be called. That way you can react to changes right away.
## Further usage
You will find snippets discribing other use cases in our [wiki](https://github.com/2Fake/devolo_home_control_api/wiki).
%prep
%autosetup -n devolo-home-control-api-0.18.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-devolo-home-control-api -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Feb 24 2023 Python_Bot <Python_Bot@openeuler.org> - 0.18.2-1
- Package Spec generated
|
