pyvlx 0.2.27__py3-none-any.whl

pyvlx-0.2.27.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: pyvlx
+Version: 0.2.27
+Summary: PyVLX is a wrapper for the Velux KLF 200 API. PyVLX enables you to run scenes and or open and close velux windows.
+Home-page: https://github.com/Julius2342/pyvlx
+Download-URL: https://github.com/Julius2342/pyvlx/archive/0.2.27.zip
+Author: Julius Mittenzwei
+Author-email: julius@mittenzwei.com
+License: LGPL
+Keywords: velux KLF 200 home automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML
+Requires-Dist: zeroconf
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+PyVLX - controling VELUX windows with Python
+============================================
+
+[![CI](https://github.com/Julius2342/pyvlx/actions/workflows/ci.yml/badge.svg)](https://github.com/Julius2342/pyvlx/actions/workflows/ci.yml)
+
+PyVLX uses the Velux KLF 200 interface to control io-Homecontrol devices, e.g. Velux Windows.
+
+Installation
+------------
+
+PyVLX can be installed via:
+
+```bash
+pip3 install pyvlx
+```
+
+Home Assistant Plugin
+---------------------
+
+PyVLX is used within [Home Assistant](https://www.home-assistant.io/components/velux/). To enable it add the following lines to your ~/.homeassistant/configuration.yml:
+
+```yaml
+velux:
+    host: "192.168.0.0"
+    password: "1ADwl48dka"
+```
+
+*Please note that this uses the WiFi password, not the web login.*
+
+For debugging frames add:
+
+```yaml
+logger:
+  default: warning
+  logs:
+    homeassistant.components.velux: debug
+    pyvlx: debug
+```
+
+
+Basic Operations
+----------------
+
+```python
+"""Just a demo of the new PyVLX module."""
+import asyncio
+from pyvlx import PyVLX, Position
+
+
+async def main(loop):
+    """Demonstrate functionality of PyVLX."""
+    pyvlx = PyVLX('pyvlx.yaml', loop=loop)
+    # Alternative:
+    # pyvlx = PyVLX(host="192.168.2.127", password="velux123", loop=loop)
+
+    # Runing scenes:
+    await pyvlx.load_scenes()
+    await pyvlx.scenes["All Windows Closed"].run()
+
+    # Changing position of windows:
+    await pyvlx.load_nodes()
+    await pyvlx.nodes['Bath'].open()
+    await pyvlx.nodes['Bath'].close()
+    await pyvlx.nodes['Bath'].set_position(Position(position_percent=45))
+
+    # Read limits of windows
+    # limit = await pyvlx.nodes['Bath'].get_limitation()
+    # limit.min_value
+    # limit.max_value
+    
+    # Changing of on-off switches:
+    # await pyvlx.nodes['CoffeeMaker'].set_on()
+    # await pyvlx.nodes['CoffeeMaker'].set_off()
+
+    # You can easily rename nodes:
+    # await pyvlx.nodes["Window 10"].rename("Window 11")
+        
+    await pyvlx.disconnect()
+
+if __name__ == '__main__':
+    # pylint: disable=invalid-name
+    LOOP = asyncio.get_event_loop()
+    LOOP.run_until_complete(main(LOOP))
+    # LOOP.run_forever()
+    LOOP.close()
+```

pyvlx-0.2.27.dist-info/RECORD

@@ -0,0 +1,84 @@
+pyvlx/__init__.py,sha256=9-lFF4trEhSYuXaiI7ha3sG_MSLstR3jB6CRzE3ahJw,766
+pyvlx/config.py,sha256=H8AcBohRkIAdwM6fjSSTrUbVqxYb2SAUp_JZLfPeYWI,1993
+pyvlx/connection.py,sha256=A4qCv7QV0vcFdRyOcsazuB4q7mRUMW3-j9_GoFxbTIk,6942
+pyvlx/const.py,sha256=caqHWviz7vRaAtpW-1mSbeuFuaCruKH1TsTnWdPQ5Po,25559
+pyvlx/dataobjects.py,sha256=qJaKTTZ67eSeB4xkV-iV7ZOTgcYhtuFtWviYO57GBuQ,5890
+pyvlx/discovery.py,sha256=yoPMNsCBaHhQgrVcQmJfE8KeDONowUGOpwLrrj_p5GU,3908
+pyvlx/exception.py,sha256=NsYGSl9OF7ttFtHqiLFZnEYytH3CnIDNoRCHo2h08l4,796
+pyvlx/heartbeat.py,sha256=NaBu-OdV0eFyGemSOAwzLdLYMsJEEUuDI3lON9yBiF4,2911
+pyvlx/klf200gateway.py,sha256=-Z8UqkU9xQdR5MEN91FNt4ogeyMrSAC64XnnGub_wBA,7124
+pyvlx/lightening_device.py,sha256=dzaBJrrR_U8erxw2IpLXtEbs4hExSseOGnWiDJKr1U4,3267
+pyvlx/log.py,sha256=d57nQrR2ZyiZUZBG0y1fcZiXtXs95kOCh_YRIqcLNvA,104
+pyvlx/node.py,sha256=cNu4by0L-iaP0PBUxJebjoSa0npF7DwHsTfQ3G_o724,2666
+pyvlx/node_helper.py,sha256=CvmgCf3jBmomLUvk3rHovaeBsuGHc0D0xmu6YnTpam4,5422
+pyvlx/node_updater.py,sha256=WLVuMd393_UqPgflMhJrzdTotrUlQXY9KpWb_fQmURo,7972
+pyvlx/nodes.py,sha256=UDqs4F7STqN5LuGIg4j_Jp4gkz31Nf2b9TIRRSBsMWw,3616
+pyvlx/on_off_switch.py,sha256=YPXoj4uPpzag_1jNhOYTNS5JRIQIvxH8J_YPB2ksq9s,1436
+pyvlx/opening_device.py,sha256=PWNZaGauEEPEff7dRvf5pis8RwudbbXnLTo7FT_V908,22575
+pyvlx/parameter.py,sha256=s8EptpopumJyePbIazBcMGUb6n8jN7aBs1NO323y9wo,12219
+pyvlx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyvlx/pyvlx.py,sha256=l0PWgHl_Bu1cnvKbvyxFDd0KRdXZM2iL5g3t3QEG74U,4828
+pyvlx/scene.py,sha256=fKh15jl5cmWUpMKwHlXXgVzNzyH-CCkRY_eL9eR8q5Q,1538
+pyvlx/scenes.py,sha256=szJ5cAjraI8WL8FEFFvqVsT9MBSmcXYCHJCBE_nVldw,1993
+pyvlx/slip.py,sha256=ugdL1QVXHpLCM063zYVmu2H1qn1GwincHElMhDJIC1g,1375
+pyvlx/string_helper.py,sha256=bDzAhEyQcT2iPCof1JoopUZcLOD5VZ0UdMLqFOxjDGA,631
+pyvlx/api/__init__.py,sha256=wGsaA6hn8qAV36mu6KSCFvc5vG2QEhIP3lAxT2_m4Nk,941
+pyvlx/api/activate_scene.py,sha256=_fLnVBmd6KGU_DweTcxn7Phjfq8idwq21RZ9tCYT2z4,2498
+pyvlx/api/api_event.py,sha256=o99YlqF08wevrIPspkVUmp94I5uKr2jHJcmlavQ0krg,2906
+pyvlx/api/command_send.py,sha256=L70yS4CiGowgYOP33qrrJ8wAbZ31VOQP_xzHLiqZt9Y,3215
+pyvlx/api/factory_default.py,sha256=mQuRKR9EgtlEPQSkGKhSzbzS3Lrk0yS1PAyDjrEj6Rs,1126
+pyvlx/api/frame_creation.py,sha256=k2C5oenL2N5i_dnKK1zj79QjfRgIBCc0D0KTMM1v6JY,9105
+pyvlx/api/get_all_nodes_information.py,sha256=dnsUSMTa9HzqJqXfWzVc_cTPAgCrVKZTS83wyleGBKE,1855
+pyvlx/api/get_limitation.py,sha256=ePWTAe1xBg-5SboXYBpdxZZR247OXLcnzqpbBNJHLHo,2653
+pyvlx/api/get_local_time.py,sha256=nccu42RpDA15xgB2CvgJuPDTwJE7S86dZcEMTHbb0ZY,1086
+pyvlx/api/get_network_setup.py,sha256=f3rPqAW0S9jc33H1214ERBgcFACk_fTedTMxFidqJNM,1189
+pyvlx/api/get_node_information.py,sha256=4GOm3mvqhqd2ktoax4vkWAhLdmaeHgnPkWzPu5oX-Ho,1569
+pyvlx/api/get_protocol_version.py,sha256=_vA4-8XiYOPqQiSCxHDqkmOLu4a6Y4Xhebc_d9FpO3A,1421
+pyvlx/api/get_scene_list.py,sha256=dRdw_qlz2lLHho1tDc_yDL6q8K5fe4NOrP__oZH3BU0,1851
+pyvlx/api/get_state.py,sha256=RDUpZSFyBj2ksJl-q9LfgB4hniEcwmJBtDj8nrm090A,1526
+pyvlx/api/get_version.py,sha256=ZhHYBBgxrWdObvft2M3U151I3_idPojKxHZ6gttYPWY,1186
+pyvlx/api/house_status_monitor.py,sha256=lDrH4TXKuDq_lUlSaf_weIp4GQVHwUWXH5ilY_ti90I,1866
+pyvlx/api/leave_learn_state.py,sha256=y9Zqjf7bQhkJn6oVz_xk-Xx3mMZ-mECacA2NDUYfZi0,1108
+pyvlx/api/password_enter.py,sha256=28wvCffn6oD4vK4HxyJW9i5pgIam6gcvY5_1mSysBvs,1384
+pyvlx/api/reboot.py,sha256=GSAPf6NAonIWV2nH876hUBYwslMZ9Ye4TILTFmfMvEI,1044
+pyvlx/api/session_id.py,sha256=roFHItnE-fBmYpwgpE8r1W9kbIya72ImT_dIi9W33DY,572
+pyvlx/api/set_node_name.py,sha256=vdL0Z_c-lY13GvGScMyWqNC0pQiuul0ncvDMbYABbi8,1123
+pyvlx/api/set_utc.py,sha256=iQLO87hG7-3eJtp_obh28Y4R8MrUmp_S-XOtuBVnVgs,1041
+pyvlx/api/status_request.py,sha256=bmAPZ5idcFWZho5d-95lMEF0hxLw85cwiIFj1ZC1SKk,1738
+pyvlx/api/frames/__init__.py,sha256=mNJ2ippywvody9dq7jTxU4VGMPVT1E1tL9kh4if_F8I,3715
+pyvlx/api/frames/alias_array.py,sha256=lGqUwAfy8LeHu9GwE2Fuat4rozFZ8nA38rcAEKANk1c,1626
+pyvlx/api/frames/frame.py,sha256=yFbydr25zpl8Eyk8ZAX3zIHZ72bR348v9Bn2J5WadLE,1800
+pyvlx/api/frames/frame_activate_scene.py,sha256=s54eG302_qMq5G1pw1bPKzOOgDF9IZLlZkfzOE1SDgw,3197
+pyvlx/api/frames/frame_activation_log_updated.py,sha256=zyD8EB9LAYTRe8ojX-fibpY-G_GKNhlmBorEuzTscCE,355
+pyvlx/api/frames/frame_command_send.py,sha256=6FYRy95Yhn8V81q0sl51zqpmnx38kXvYwusxE-kAMjE,10437
+pyvlx/api/frames/frame_discover_nodes.py,sha256=9EyyXn2IhfvO3qMoBNKLcSyng96iUAgs1rfX3_R03Tg,1865
+pyvlx/api/frames/frame_error_notification.py,sha256=8y4GpccMzdegoOMQre262dOSeCXTkDZer9qFWm6oTU8,1138
+pyvlx/api/frames/frame_facory_default.py,sha256=WFdqNw5LC4ELPuUyDMUOdjGbkpVZv_gUlpjXDGrjncE,874
+pyvlx/api/frames/frame_get_all_nodes_information.py,sha256=wutKFOCF-OOi4Uj6iNOGbJwiMqaC2HKyADXmBm9KhZI,8380
+pyvlx/api/frames/frame_get_limitation.py,sha256=38BhHAIYsDZ4AGmYz2p-8ZDNez13tVz6Rq4bGrOip24,4720
+pyvlx/api/frames/frame_get_local_time.py,sha256=o6N2if_-fy8G7iTmyscXr4ktAzjBuYpIgt9Q2zrW39Y,1075
+pyvlx/api/frames/frame_get_network_setup.py,sha256=rhUb_yxQwWh3-rjCLnSXv5IgiNcW92FaKtOG3fYD7uk,2158
+pyvlx/api/frames/frame_get_node_information.py,sha256=Du8Jnt-fvf1yvVgqUbTIIRR4AZFQjdOLVcpbqlvuOH0,8663
+pyvlx/api/frames/frame_get_protocol_version.py,sha256=VAm_X4Y33guSADJx6stMWsdHM8KPsXhkO196I-VgJBU,1647
+pyvlx/api/frames/frame_get_scene_list.py,sha256=-yHTZHj4-XBmwR2PndyTjGzMm7o9yTKmg-JvoxgWKyM,2680
+pyvlx/api/frames/frame_get_state.py,sha256=WUXd9kloLF2S4wo1D253VSKxQqVBuiTXNmLDeQ5rBvk,1557
+pyvlx/api/frames/frame_get_version.py,sha256=2DgGPinlRrgEdgpYWVMJVCTH--gJ4jvutVuUbwmjDOA,2480
+pyvlx/api/frames/frame_helper.py,sha256=s8QjTDDykdI8mtEAZl9celcFAgdHzO1NCXI2K01QrBs,1317
+pyvlx/api/frames/frame_house_status_monitor_disable_cfm.py,sha256=ZFX__mguYuOZAjHP7a0hw6M9BXjOpGjEfmtI1yy4B7c,426
+pyvlx/api/frames/frame_house_status_monitor_disable_req.py,sha256=PfUgpmpIRHr2CZjRDiiKgggmK9mSamAzCJ2VwZAWOsU,415
+pyvlx/api/frames/frame_house_status_monitor_enable_cfm.py,sha256=KPgeBWvs3wp94Y4cYufHUFqpM7Ritaw4lJlm4awQNrA,428
+pyvlx/api/frames/frame_house_status_monitor_enable_req.py,sha256=i2mKQNUvJzdYjVYf860iX63u-NJiznIV_7cV8Oew_NM,411
+pyvlx/api/frames/frame_leave_learn_state.py,sha256=OQL1gFL079CghS12wIqf3EtkHoGp2jy-DWcSTzhsHt8,1297
+pyvlx/api/frames/frame_node_information_changed.py,sha256=TxJTTkmFwBtoAzJmxoi9X5mB1bGas9Sk_y4j_imZaAw,1971
+pyvlx/api/frames/frame_node_state_position_changed_notification.py,sha256=rMWZZdgK0Ek6ZtAbRhk--Un9eRuiS1JYzAE-iECjGlo,3404
+pyvlx/api/frames/frame_password_change.py,sha256=QwsONY1mNmYEZ5jely9zGprQbkGxN5iJrdt3Hj8wwu0,4158
+pyvlx/api/frames/frame_password_enter.py,sha256=TJlu59Wq1GKyOlQldaKieCLJJcJGLfJKycR2-UTX3Gs,2297
+pyvlx/api/frames/frame_reboot.py,sha256=QhP5THt6axA6IU9BdPh1I3kV9Z9xu79UGLGNbHUSt-0,827
+pyvlx/api/frames/frame_set_node_name.py,sha256=NidbbDo6up8Z7vWyBoYnWy7D_UfM490RhF-UAOsl_A8,2295
+pyvlx/api/frames/frame_set_utc.py,sha256=qKy-NyV6baolbTzT4KbYYG-_dqvCZmKF5Buq6fOU85E,1316
+pyvlx/api/frames/frame_status_request.py,sha256=cy_bPG8priEQf5KVreXVrURUq9engfLq_a7E_6ap-1c,8265
+pyvlx-0.2.27.dist-info/licenses/LICENSE,sha256=6n0EnHcF3BOvwgLdGOGCfzSE-CEv0_p7gvxKDDY0Msk,7816
+pyvlx-0.2.27.dist-info/METADATA,sha256=v8MiJ3AEY_5aNJwpc_25AUxhPeO0m81SDQaKu3Uw574,3474
+pyvlx-0.2.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyvlx-0.2.27.dist-info/top_level.txt,sha256=e8iDCwK-J6mO8CKEqA3HZMpBG0wez9FMYK5JKz1Wbrc,6
+pyvlx-0.2.27.dist-info/RECORD,,

pyvlx-0.2.27.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyvlx-0.2.27.dist-info/licenses/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

pyvlx-0.2.27.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyvlx