HAP-python 1.0.5__tar.gz → 1.0.6__tar.gz

{usr/local/lib/python3.6/site-packages/HAP_python-1.0.5-py3.6.egg-info → HAP-python-1.0.6/HAP_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: HAP-python
-Version: 1.0.5
+Version: 1.0.6
 Summary: HomeKit Accessory Protocol implementation in python3
 Home-page: https://github.com/ikalchev/HAP-python.git
 Author: Ivan Kalchev

HAP-python-1.0.6/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

HAP-python-1.0.6/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+recursive-include pyhap/resources *

HAP-python-1.0.6/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 1.1
+Name: HAP-python
+Version: 1.0.6
+Summary: HomeKit Accessory Protocol implementation in python3
+Home-page: https://github.com/ikalchev/HAP-python.git
+Author: Ivan Kalchev
+Author-email: UNKNOWN
+License: Apache-2.0
+Description-Content-Type: UNKNOWN
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers

HAP-python-1.0.6/README.md

@@ -0,0 +1,230 @@
+[![PyPI version](https://badge.fury.io/py/HAP-python.svg)](https://badge.fury.io/py/HAP-python)
+# HAP-python
+
+HomeKit Accessory Protocol implementation in python 3 (tested with 3.4, 3.5 and 3.6).
+With this project, you can integrate your own accessories and add them to your
+iOS Home app. Since Siri is integrated with the Home app, you can start voice-control your
+accessories right away - e.g. "What is the temperature in my bedroom." and "Turn on the
+lights in the Dining Room."
+
+The project was developed for a Raspberry Pi, but it should work on other platforms. You
+can even integrate with HAP-python remotely using HTTP (see below). To kick-start things,
+you can open `main.py`, where you can find out how to launch a mock temperature sensor.
+Just run `python3 main.py` and you should see it in the Home app (be sure to be in the same network).
+Stop it by hitting Ctrl+C.
+
+There are example accessories in [the accessories folder](pyhap/accessories) (e.g. AM2302 temperature and humidity sensor).
+
+## Table of Contents
+1. [API](#API)
+2. [Installation](#Installation)
+3. [Integrating non-compatible devices](#HttpAcc)
+4. [Run at boot (and a Switch to shutdown your device)](#AtBoot)
+5. [Notice](#Notice)
+
+## Installation <a name="Installation"></a>
+
+As a prerequisite, you will need Avahi/Bonjour installed (due to zeroconf package).
+On a Raspberry Pi, you can get it with:
+```
+sudo apt-get install libavahi-compat-libdnssd-dev
+```
+`avahi-utils` may also fit the bill. Then, you can install with `pip3` (you will need `sudo` or `--user` for the install):
+```sh
+pip3 install HAP-python
+```
+
+This will install HAP-python in your python packages, so that you can import it as `pyhap`. To uninstall, just do:
+```
+pip3 uninstall HAP-python
+```
+
+## API <a name="API"></a>
+
+A typical flow for using HAP-python starts with implementing an Accessory. This is done by
+subclassing [Accessory](pyhap/accessory.py) and putting in place a few details
+(see below). After that, you give your accessory to an AccessoryDriver to manage. This
+will take care of advertising it on the local network, setting a HAP server and
+running the Accessory. Take a look at [main.py](main.py) for a quick start on that.
+
+```python
+from pyhap.accessory import Accessory, Category
+import pyhap.loader as loader
+
+class TemperatureSensor(Accessory):
+    """Implementation of a mock temperature sensor accessory."""
+
+    category = Category.SENSOR  # This is for the icon in the iOS Home app.
+
+    def __init__(self, *args, **kwargs):
+        """Here, we just store a reference to the current temperature characteristic and
+        add a method that will be executed every time its value changes.
+        """
+        # If overriding this method, be sure to call the super's implementation first,
+        # because it calls _set_services and performs some other important actions.
+        super(TemperatureSensor, self).__init__(*args, **kwargs)
+
+        self.temp_char = self.get_service("TemperatureSensor")\
+                             .get_characteristic("CurrentTemperature")
+        # Having a callback is optional, but you can use it to add functionality.
+        self.temp_char.setter_callback = self.temperature_changed
+
+    def temperature_changed(self, value):
+        """This will be called every time the value of the CurrentTemperature Characteristic
+        is changed. Use setter_callbacks to react to user actions, e.g. setting the
+        lights On could fire some GPIO code to turn on a LED (see pyhap/accessories/LightBulb.py).
+
+        NOTE: no need to set the value yourself, this is done for you, before the callback
+        is called.
+        """
+        print("Temperature changed to: ", value)
+
+    def _set_services(self):
+        """We override this method to add the services that we want our accessory to
+        support. Services have "mandatory" characteristics and optional
+        characteristics. Mandatory characteristics are automatically added
+        to your selected service, but you must add optional characteristics yourself.
+        Take a look at pyhap/accessories/FakeFan.py for an example of how to do that.
+        """
+        super(TemperatureSensor, self)._set_services()  # Adds some neccessary characteristics.
+        # A loader creates Service and Characteristic objects based on json representation
+        # such as the Apple-defined ones in pyhap/resources/.
+        temp_sensor_service = loader.get_serv_loader().get("TemperatureSensor")
+        self.add_service(temp_sensor_service)
+
+    def run(self):
+        """We override this method to implement what the accessory will do when it is
+        started. An accessory is started and stopped from the AccessoryDriver.
+
+        It might be convenient to use the Accessory's run_sentinel, which is a
+        threading.Event object which is set when the accessory should stop running.
+
+        In this example, we wait 3 seconds to see if the run_sentinel will be set and if
+        not, we set the current temperature to a random number.
+        """
+        while not self.run_sentinel.wait(3):
+            self.temp_char.set_value(random.randint(18, 26))
+
+    def stop(self):
+        """We override this method to clean up any resources or perform final actions, as
+        this is called by the AccessoryDriver when the Accessory is being stopped (it is
+        called right after run_sentinel is set).
+        """
+        print("Stopping accessory.")
+```
+
+## Integrating non-compatible devices <a name="HttpAcc"></a>
+HAP-python may not be available for many IoT devices. For them, HAP-python allows devices
+to be bridged by means of communicating with an HTTP server - the [HttpBridge](pyhap/accessories/Http.py). You can add as many remote accessories as you like.
+
+For example, the bellow snippet creates an Http Accessory that listens on port 51800
+for updates on the TemperatureSensor service:
+```python
+import pyhap.util as util
+import pyhap.loader as loader
+from pyhap.accessories.Http import HttpBridge
+from pyhap.accessory import Accessory
+from pyhap.accessory_driver import AccessoryDriver
+
+# get loaders
+service_loader = loader.get_serv_loader()
+char_loader = loader.get_char_loader()
+
+# Create an accessory with the temperature sensor service.
+# Also, add an optional characteristic StatusLowBattery to that service.
+remote_accessory = Accessory("foo", aid=2)  # aids must be unique for each accessory.
+tservice = service_loader.get("TemperatureSensor")
+tservice.add_opt_characteristic(
+    char_loader.get("StatusLowBattery"))
+remote_accessory.add_service(tservice)
+
+# Create the HTTP Bridge and add the accessory to it.
+address = ("", 51111)
+http_bridge = HttpBridge(address=address,
+                         display_name="HTTP Bridge",
+                         pincode=b"203-23-999")
+http_bridge.add_accessory(remote_accessory)
+
+# Add to driver and run.
+driver = AccessoryDriver(http_bridge, 51826)
+driver.start()
+```
+Now, remote accessories can do an HTTP POST to the address of the device where the
+accessory is running (port 51111) with the following content:
+```json
+{
+    "aid": 2,
+    "services": {
+        "TemperatureSensor": {
+            "CurrentTemperature" : 20,
+            "StatusLowBattery": true,
+        }
+    }
+}
+```
+This will update the value of the characteristic "CurrentTemperature" to 20 degrees C
+and "StatusLowBattery" to `true`.
+Needless to say the communication to the Http Bridge poses a security risk, so
+keep that in mind.
+
+## Run at boot <a name="AtBoot"></a>
+This is a quick way to get `HAP-python` to run at boot on a Raspberry Pi. It is recommended
+to turn on "Wait for network" in `raspi-config`. If this turns to be unreliable, see
+[this](https://www.raspberrypi.org/forums/viewtopic.php?f=66&t=187225).
+
+Copy the below in `/etc/systemd/system/HAP-python.service` (needs sudo).
+```
+[Unit]
+Description = HAP-python daemon
+Wants = pigpiod.service  # Remove this if you don't depend on pigpiod
+After = local-fs.target network-online.target pigpiod.service
+
+[Service]
+User = lesserdaemon  # It's a good idea to use some unprivileged system user
+# Script starting HAP-python, e.g. main.py
+# Be careful to set any paths you use, e.g. for persisting the state.
+ExecStart = /usr/bin/python3 /home/lesserdaemon/.hap-python/hap-python.py
+
+[Install]
+WantedBy = multi-user.target
+```
+
+Test that everything is fine by doing:
+
+```sh
+> sudo systemctl start HAP-python
+> systemctl status HAP-python
+> sudo journalctl -u HAP-python  # to see the output of the start up script.
+> sudo systemctl stop HAP-python
+```
+
+To enable or disable at boot, do:
+
+```sh
+> sudo systemctl enable HAP-python
+> sudo systemctl disable HAP-python
+```
+
+### Shutdown switch
+
+If you are running `HAP-python` on a Raspberry Pi, you may want to add a
+[Shutdown Switch](pyhap/accessories/ShutdownSwitch.py) to your Home. This is a
+Switch Accessory, which, when triggered, executes `sudo shutdown -h now`, i.e.
+it shutdowns and halts the Pi. This allows you to safely unplug it.
+
+For the above to work, you need to enable passwordless `/sbin/shutdown` to whichever
+user is running `HAP-python`. For example, do:
+```sh
+$ sudo visudo # and add the line: "<hap-user> ALL=NOPASSWD: /sbin/shutdown".
+```
+
+## Notice <a name="Notice"></a>
+
+Some HAP know-how was taken from [HAP-NodeJS by KhaosT](https://github.com/KhaosT/HAP-NodeJS).
+
+I am not aware of any bugs, but I am more than confident that such exist. If you find any,
+please report and I will try to fix them.
+
+Suggestions are always welcome.
+
+Have fun!

{usr/local/lib/python3.6/site-packages → HAP-python-1.0.6}/pyhap/accessory.py

@@ -146,7 +146,6 @@ class Accessory(object):
         The default implementation adds only the AccessoryInformation services
         and sets its Name characteristic to the Accessory's display name.
         """
-        # Info service
         info_service = get_serv_loader().get("AccessoryInformation")
         info_service.get_characteristic("Name")\
                     .set_value(self.display_name, False)
@@ -172,6 +171,22 @@ class Accessory(object):
         """
         self.run_sentinel = run_sentinel
 
+    def config_changed(self):
+        """Notify the accessory about configuration changes.
+
+        These include new services or updated characteristic values, e.g.
+        the Name of a service changed.
+
+        This method also notifies the broker about the change, so that it can
+        publish the changes to the world.
+
+        @note: If you are changing the configuration of a bridged accessory
+        (i.e. an Accessory that is contained in a Bridge),
+        you should call the `config_changed` method on the Bridge.
+        """
+        self.config_version += 1
+        self.broker.config_changed()
+
     def add_service(self, *servs):
         """Add the given services to this Accessory.
 

{usr/local/lib/python3.6/site-packages → HAP-python-1.0.6}/pyhap/accessory_driver.py

@@ -12,7 +12,8 @@ AccessoryDriver (all this happens through the publish() interface). The Accessor
 will then check if there is a client that subscribed for events from this exact
 Characteristic from this exact Accessory (remember, it could be a Bridge with more than
 one Accessory in it). If so, the event is put in a FIFO queue - the event queue. This
-terminates the call chain and concludes the publishing process from the Characteristic.
+terminates the call chain and concludes the publishing process from the Characteristic,
+the Characteristic does not block waiting for the actual send to happen.
 
 When the AccessoryDriver is started, it spawns an event dispatch thread. The purpose of
 this thread is to get events from the event queue and send them to subscribed clients.
@@ -217,6 +218,16 @@ class AccessoryDriver(object):
                 self.sent_events = 0
                 self.accumulated_qsize = 0
 
+    def config_changed(self):
+        """Notify the driver that the accessory's configuration has changed.
+
+        Updates the mDNS advertisment, so that iOS clients know they need to new data.
+        Also, persists the accessory, so that the new configuration is available on
+        restart.
+        """
+        self.update_advertisment()
+        self.persist()
+
     def update_advertisment(self):
         """Updates the mDNS service info for the accessory."""
         self.advertiser.unregister_service(self.mdns_service_info)
@@ -434,6 +445,10 @@ class AccessoryDriver(object):
         self.http_server.shutdown()
         self.http_server.server_close()
         self.http_server_thread.join()
+
+        logger.debug("Persisting accessory state")
+        self.persist()
+
         logger.debug("AccessoryDriver stopped successfully")
 
     def signal_handler(self, _signal, _frame):

HAP-python-1.0.6/setup.cfg

@@ -0,0 +1,10 @@
+[metadata]
+description-file = README.md
+
+[pycodestyle]
+max-line-length = 90
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

HAP-python-1.0.6/setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup
+
+setup(
+    name="HAP-python",
+    description="HomeKit Accessory Protocol implementation in python3",
+    author="Ivan Kalchev",
+    version="1.0.6",
+    url="https://github.com/ikalchev/HAP-python.git",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+        "Topic :: Home Automation",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "License :: OSI Approved :: Apache Software License",
+        "Intended Audience :: Developers",
+    ],
+    license="Apache-2.0",
+    packages=[
+        "pyhap",
+        "pyhap.accessories"
+    ],
+    install_requires=[
+        "pycryptodome",
+        "tlslite-ng",
+        "ed25519",
+        "zeroconf",
+        "curve25519-donna"
+    ],
+    package_data={
+        "pyhap": ["resources/*"],
+    }
+)