py-ha-ws-client 0.1__tar.gz

py_ha_ws_client-0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

py_ha_ws_client-0.1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.1
+Name: py_ha_ws_client
+Version: 0.1
+Summary: A Python client to make it easy to connect and consume data from the Home Assistant web socket API.
+Home-page: https://github.com/foxy82/py-ha-ws-client
+Author: foxy82
+Author-email: foxy82.github@gmail.com
+License: Apache 2.0
+Download-URL: https://github.com/foxy82/py-ha-ws-client/archive/0.1.tar.gz
+Keywords: Home Assistant,Websocket
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# py-ha-ws-client
+A Python client to make it easy to connect and consume data from the [Home Assistant web socket API](https://developers.home-assistant.io/docs/api/websocket/).
+
+
+## Example
+
+```
+from time import sleep
+from py_ha_ws_client.client import HomeAssistantWsClient
+
+hostname = "<Home Assistant IP>"
+#token = "<from Home Assistant>"
+
+client = HomeAssistantWsClient(token, hostname)
+client.connect()
+
+while not client.connected():
+    sleep(1)
+
+# Get all the states as a list
+print("Get all States")
+states = client.get_states()
+print("Print one state as an example")
+print(states[0])
+
+
+entity_id = "media_player.amplifier"
+
+# Define a call back
+def my_callback(entity_id, message):
+    print(entity_id, message)
+
+# Get the state of a single entity
+state = client.get_state(entity_id)
+print(state)    
+
+# Register for updates for a specfic entity
+client.subscribe_to_trigger(
+    entity_id="media_player.studio_amplifier",
+    callback=my_callback,
+)
+
+sleep(10)
+
+# Send a turn on command
+client.turn_on(
+    entity_id=entity_id
+)
+
+sleep(10)
+
+# Send a change volume command
+client.call_service(
+    domain="media_player",
+    service="volume_set",
+    entity_id=entity_id,
+    service_data={
+        "volume_level" : "0.50"
+    }
+)
+
+sleep(10)
+
+# Send a turn off command
+client.turn_off(
+    entity_id=entity_id
+)
+
+sleep(60)
+
+```
+
+## TODO
+
+This is a work in progress there are a lot of TODOs in the code.
+

py_ha_ws_client-0.1/README.md

@@ -0,0 +1,75 @@
+# py-ha-ws-client
+A Python client to make it easy to connect and consume data from the [Home Assistant web socket API](https://developers.home-assistant.io/docs/api/websocket/).
+
+
+## Example
+
+```
+from time import sleep
+from py_ha_ws_client.client import HomeAssistantWsClient
+
+hostname = "<Home Assistant IP>"
+#token = "<from Home Assistant>"
+
+client = HomeAssistantWsClient(token, hostname)
+client.connect()
+
+while not client.connected():
+    sleep(1)
+
+# Get all the states as a list
+print("Get all States")
+states = client.get_states()
+print("Print one state as an example")
+print(states[0])
+
+
+entity_id = "media_player.amplifier"
+
+# Define a call back
+def my_callback(entity_id, message):
+    print(entity_id, message)
+
+# Get the state of a single entity
+state = client.get_state(entity_id)
+print(state)    
+
+# Register for updates for a specfic entity
+client.subscribe_to_trigger(
+    entity_id="media_player.studio_amplifier",
+    callback=my_callback,
+)
+
+sleep(10)
+
+# Send a turn on command
+client.turn_on(
+    entity_id=entity_id
+)
+
+sleep(10)
+
+# Send a change volume command
+client.call_service(
+    domain="media_player",
+    service="volume_set",
+    entity_id=entity_id,
+    service_data={
+        "volume_level" : "0.50"
+    }
+)
+
+sleep(10)
+
+# Send a turn off command
+client.turn_off(
+    entity_id=entity_id
+)
+
+sleep(60)
+
+```
+
+## TODO
+
+This is a work in progress there are a lot of TODOs in the code.

py_ha_ws_client-0.1/py_ha_ws_client/client.py

@@ -0,0 +1,462 @@
+import abc
+from abc import ABC
+from time import sleep
+from ws4py.client.threadedclient import WebSocketClient
+import logging
+import json
+import threading
+import itertools
+
+latest_states = {}
+include_by_default = True
+
+
+class HomeAssistantWsClient:
+
+    def __init__(self, token, hostname, port=8123):
+        self.logger = logging.getLogger(__name__)
+        self.url = f'ws://{hostname}:{port}/api/websocket'
+        self.token = token
+        self.ws_client = None
+        self._reconnection_thread = None
+        self._triggers = []
+
+    def connect(self):
+        """
+        Connect to the Home Assistant Web Socket API
+        :return:
+        """
+        self._reconnection_thread = threading.Thread(target=self._connect, daemon=True)
+        self._reconnection_thread.start()
+
+    def get_states(self):
+        """
+        Blocking call to get all states from Home Assistant
+        https://developers.home-assistant.io/docs/api/websocket/#fetching-states
+        :return:
+        """
+        if self.ws_client.authenticated:
+            callback = BlockingCallback()
+            self.ws_client.get_states(callback)
+            return callback.get_result()
+        else:
+            self.logger.warning(f"Can't get states as we aren't connected to home assistant")
+
+
+    def get_state(self, entity_id):
+        """
+        Blocking call to get a single entities state from Home Assistant
+        https://developers.home-assistant.io/docs/api/websocket/#fetching-states
+        :return:
+        """
+        states = self.get_states()
+        if states:
+           for state in states:
+
+                if(state.get("entity_id", None) == entity_id):
+                    return state
+        self.logger.warning(f"{entity_id} not found in Home Assistant")
+        return None
+
+
+    def get_config(self):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#fetching-config
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def get_services(self):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#fetching-services
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def subscribe_to_events(self, event_type):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#subscribe-to-events
+        :param event_type:
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def unsubscribe_from_events(self):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#unsubscribing-from-events
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def fire_an_event(self):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#fire-an-event
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    # TODO pass in a trigger not entity_id/from_state/to_state so we can be more flexible
+    def subscribe_to_trigger(self, entity_id, callback, from_state=None, to_state=None):
+        """
+        Subscribe to a trigger
+        https://developers.home-assistant.io/docs/api/websocket/#subscribe-to-trigger
+        :param entity_id:
+        :param callback:
+        :param from_state:
+        :param to_state:
+        :return:
+        """
+        self._triggers.append(
+            Subscription(
+                entity_id,
+                callback,
+                from_state,
+                to_state
+            )
+        )
+
+        if self.ws_client.authenticated:
+            self.ws_client.subscribe_to_trigger(entity_id, callback, from_state, to_state)
+
+    def unsubscribe_from_trigger(self):
+        """
+        Need to test this, but I guess this is the same as unsubscribing from an event
+        https://developers.home-assistant.io/docs/api/websocket/#unsubscribing-from-events
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def call_service(self, domain, service, entity_id=None, service_data=None):
+        """
+        Call a service:
+        https://developers.home-assistant.io/docs/api/websocket/#calling-a-service
+        :param domain:
+        :param service:
+        :param entity_id:
+        :param service_data:
+        :return:
+        """
+        if self.ws_client.authenticated:
+            self.ws_client.call_service(domain, service, entity_id, service_data)
+        else:
+            self.logger.warning(f"Can't call {domain}.{service} as we aren't connected to home assistant")
+
+    def validate_config(self):
+        """
+        https://developers.home-assistant.io/docs/api/websocket/#validate-config
+        :return:
+        """
+        # TODO implement this
+        pass
+
+    def turn_on(self, entity_id):
+        if self.ws_client.authenticated:
+            self.ws_client.turn_on(entity_id)
+        else:
+            self.logger.warning(f"Can't turn on {entity_id} as we aren't connected to home assistant")
+
+    def turn_off(self, entity_id):
+        if self.ws_client.authenticated:
+            self.ws_client.turn_off(entity_id)
+        else:
+            self.logger.warning(f"Can't turn off {entity_id} as we aren't connected to home assistant")
+
+    def _authenticated(self, auth_success):
+        if auth_success:
+            for trigger in self._triggers:
+                self.ws_client.subscribe_to_trigger(
+                    trigger.entity_id,
+                    trigger.callback,
+                    trigger.from_state,
+                    trigger.to_state
+                )
+
+    def connected(self):
+        if self.ws_client is None or self.ws_client.client_terminated:
+            return False
+        return True
+
+    def _disconnected(self):
+        self.logger.warning("Disconnected will attempt to reconnect.")
+        self._reconnection_thread = threading.Thread(target=self._reconnect, daemon=True)
+        self._reconnection_thread.start()
+
+    def _internal_connection(self):
+        while not self.connected():
+            self.logger.debug("Home Assistant WebSocket - Attempting to connect...")
+            self._connect_if_required()
+            self.logger.debug(f"Home Assistant WebSocket - connection work? {self.connected()}")
+            sleep(5)  # Give a moment before reconnecting to ensure the socket has been closed.
+
+    def _connect(self):
+        self.logger.debug("Home Assistant WebSocket - Starting connection thread")
+        self._internal_connection()
+        self.logger.debug("Home Assistant WebSocket - connection complete - connection thread ending")
+
+    def _connect_if_required(self):
+        if not self.connected():
+            try:
+                self.ws_client = _HaWsClient(self.url)
+                self.ws_client.set_token(self.token)
+                self.ws_client.set_disconnect_callback(self._disconnected)
+                self.ws_client.set_authenticated_callback(self._authenticated)
+                self.ws_client.connect()
+            except Exception as e:
+                self.logger.info("Error connecting to Home Assistant Websocket", e)
+                self.ws_client = None
+
+    def _reconnect(self):
+        self.logger.info("Home Assistant WebSocket - Starting reconnection thread")
+        sleep(5)  # Give a second before reconnecting to ensure the socket has been closed.
+        self._internal_connection()
+        self.logger.info("Home Assistant WebSocket - Reconnection complete - reconnection thread ending")
+
+
+# TODO add pings to ensure connectivity
+class _HaWsClient(WebSocketClient):
+    logger = logging.getLogger(__name__)
+    authenticated = False
+    connected = False
+    id_generator = itertools.count(start=1)
+    id_to_type = {}
+    id_to_entity_id = {}
+    id_to_callback = {}
+    _entity_id_to_trigger = {}
+    reconnection_thread = None
+    homeassistant_token = ""
+
+    def __init__(self, url):
+        super().__init__(url)
+        self._disconnected_callback = self.do_nothing
+        self._authenticated_callback = self.do_nothing
+
+    def set_token(self, token):
+        self.homeassistant_token = token
+
+    def set_disconnect_callback(self, callback):
+        self._disconnected_callback = callback
+
+    def set_authenticated_callback(self, callback):
+        self._authenticated_callback = callback
+
+    def opened(self):
+        self.logger.info("Home Assistant WebSocket Connection Opened")
+        self.connected = True
+
+    def closed(self, code, reason=None):
+        self.logger.warning("Home Assistant WebSocket Connection Closed. Code: {} Reason {}".format(code, reason))
+        self.connected = False
+        self.authenticated = False
+
+        self.id_to_type.clear()
+        self.id_to_entity_id.clear()
+        self._entity_id_to_trigger.clear()
+
+        self._disconnected_callback()
+
+    def subscribe_to_trigger(self, entity_id, callback, from_state=None, to_state=None):
+        self.logger.info(f"Subscribing for trigger for {entity_id} from_state: {from_state}, to_state: {to_state}")
+        trigger = {
+            "platform": "state",
+            "entity_id": entity_id,
+        }
+        if from_state:
+            trigger['from'] = from_state
+        if to_state:
+            trigger['to'] = to_state
+
+        payload = {
+            "type": "subscribe_trigger",
+            "trigger": trigger,
+        }
+
+        message_id = self._send_and_return_message_id(payload, "subscribe_trigger")
+        self.id_to_entity_id[message_id] = entity_id
+
+        self._entity_id_to_trigger[entity_id] = Subscription(entity_id, callback, from_state, to_state)
+
+    def turn_on(self, entity_id):
+        """
+        Attempts to turn on a device by guessing the domain from the entity id name
+        """
+        self.logger.info(f"Turning on {entity_id}")
+        split_entity_id = entity_id.split(".")
+        if len(split_entity_id) != 2:
+            self.logger.error(f"Couldn't get domain from entity_id - is the entity_id correct? {entity_id}")
+        else:
+            self.call_service(split_entity_id[0], "turn_on", entity_id=entity_id)
+
+    def turn_off(self, entity_id):
+        """
+        Attempts to turn off a device by guessing the domain from the entity id name
+        """
+        self.logger.info(f"Turning off {entity_id}")
+        split_entity_id = entity_id.split(".")
+        if len(split_entity_id) != 2:
+            self.logger.error(f"Couldn't get domain from entity_id - is the entity_id correct? {entity_id}")
+        else:
+            self.call_service(split_entity_id[0], "turn_off", entity_id=entity_id)
+
+    def call_service(self, domain, service, entity_id=None, service_data=None):
+
+        payload = {
+            "type": "call_service",
+            "domain": domain,
+            "service": service,
+        }
+        if service_data:
+            payload["service_data"] = service_data
+        if entity_id:
+            payload["target"] = {
+                "entity_id": entity_id
+            }
+        return self._send_and_return_message_id(payload, "call_service")
+
+    def received_message(self, m):
+        self.logger.debug("Received message: {}".format(m))
+        message_text = m.data.decode(m.encoding)
+        message = json.loads(message_text)
+        message_type = message.get('type', None)
+        if message_type == "auth_required":
+            self._do_auth_required()
+        elif message_type == "auth_ok":
+            self._do_auth_complete()
+        elif message_type == "auth_invalid":
+            self._do_auth_invalid(message)
+        elif message_type == "result":
+            self._do_result(message)
+        elif message_type == "event":
+            self._do_event(message)
+        elif message_type == "pong":
+            self._do_pong(message)
+        else:
+            self.logger.warning("Unexpected message: ", message)
+
+    def _do_auth_required(self):
+        self.logger.info("Home Assistant Web Socket Authorisation required")
+        payload = {
+            'type': 'auth',
+            'access_token': self.homeassistant_token
+        }
+        self.logger.debug(f"Sending {payload}")
+        self._send(payload)
+
+    def _do_auth_invalid(self, message):
+        self.logger.error("Home Assistant Web Socket Authorisation invalid: {}".format(message))
+        self.authenticated = False
+        self._authenticated_callback(self.authenticated)
+
+    def _do_auth_complete(self):
+        self.logger.info("Home Assistant Web Socket Authorisation complete")
+        self.authenticated = True
+        self._authenticated_callback(self.authenticated)
+
+    def get_states(self, callback):
+        payload = {
+            'type': 'get_states'
+        }
+        message_id = self._send_and_return_message_id(payload, "get_states")
+        self.id_to_callback[message_id] = callback
+
+    # def subscribe_for_updates(self):
+    #     payload = {
+    #         "type": "subscribe_events",
+    #         "event_type": "state_changed"
+    #     }
+    #     self._send_with_id(payload, "subscribe")
+
+    def _do_result(self, message):
+        self.logger.debug(self.id_to_type)
+        success = message['success']
+        if success:
+            if 'result' in message:
+                message_type = self.id_to_type.pop(message['id'])
+                self.logger.debug(f"Got message type {message_type}")
+                if message_type == 'subscribe_trigger':
+                    entity_id = self.id_to_entity_id.get(message['id'])
+                    self.logger.info(f"Subscribed for {entity_id}")
+                elif message_type == 'get_states':
+                    callback = self.id_to_callback.pop(message['id'])
+                    if callback is not None:
+                        callback.set_result(message['result'])
+                    self.logger.debug(f"Received all states for message id: {message['id']}")
+            else:
+                self.logger.warning(f"No result in message: {message}")
+        else:
+            self.logger.error(f"Error code: {message['error']['code']} message: {message['error']['message']}")
+
+    def _do_event(self, message):
+        message_id = message.get('id', -1)
+        if message_id in self.id_to_entity_id.keys():
+            entity_id = self.id_to_entity_id.get(message['id'])
+            self.logger.debug(f"Found entity id {entity_id} in {self.id_to_entity_id}")
+            subscription: Subscription = self._entity_id_to_trigger.get(entity_id)
+            callback = subscription.callback
+            self.logger.debug(f"Found callback {callback} in {self._entity_id_to_trigger}")
+            callback(entity_id=entity_id, message=message)
+        else:
+            self.logger.debug(f"Didn't find message id {message_id} in {self.id_to_entity_id}")
+
+    def _do_pong(self, message):
+        message_id = message['id']
+        self.logger.debug(f"Pong received with ID[{message_id}]")
+
+    def _send_and_return_message_id(self, payload, type_of_call):
+        message_id = self._get_next_message_id()
+        payload['id'] = message_id
+        self.logger.debug(f"Adding {message_id} as type {type_of_call}")
+        self.id_to_type[message_id] = type_of_call
+        self._send(payload)
+        return payload['id']
+
+    def _get_next_message_id(self):
+        return next(self.id_generator)
+
+    def _send(self, payload):
+        json_payload = json.dumps(payload)
+        self.logger.debug(f"Sending: {json_payload}")
+        self.send(json_payload)
+
+    def do_nothing(self, *args):
+        pass
+
+
+class Subscription:
+    def __init__(self, entity_id, callback, from_state, to_state) -> None:
+        self.entity_id = entity_id
+        self.callback = callback
+        self.from_state = from_state
+        self.to_state = to_state
+
+
+class Callback(ABC):
+
+    @abc.abstractmethod
+    def set_result(self, result):
+        pass
+
+    @abc.abstractmethod
+    def get_result(self):
+        pass
+
+
+class BlockingCallback(Callback):
+
+    def __init__(self, timeout=30):
+        self.timeout = timeout
+        self.event = threading.Event()
+        self.result = None
+
+    def set_result(self, result):
+        self.result = result
+        self.event.set()
+
+    def get_result(self):
+        self.event.wait(self.timeout)
+        return self.result

py_ha_ws_client-0.1/py_ha_ws_client.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.1
+Name: py-ha-ws-client
+Version: 0.1
+Summary: A Python client to make it easy to connect and consume data from the Home Assistant web socket API.
+Home-page: https://github.com/foxy82/py-ha-ws-client
+Author: foxy82
+Author-email: foxy82.github@gmail.com
+License: Apache 2.0
+Download-URL: https://github.com/foxy82/py-ha-ws-client/archive/0.1.tar.gz
+Keywords: Home Assistant,Websocket
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# py-ha-ws-client
+A Python client to make it easy to connect and consume data from the [Home Assistant web socket API](https://developers.home-assistant.io/docs/api/websocket/).
+
+
+## Example
+
+```
+from time import sleep
+from py_ha_ws_client.client import HomeAssistantWsClient
+
+hostname = "<Home Assistant IP>"
+#token = "<from Home Assistant>"
+
+client = HomeAssistantWsClient(token, hostname)
+client.connect()
+
+while not client.connected():
+    sleep(1)
+
+# Get all the states as a list
+print("Get all States")
+states = client.get_states()
+print("Print one state as an example")
+print(states[0])
+
+
+entity_id = "media_player.amplifier"
+
+# Define a call back
+def my_callback(entity_id, message):
+    print(entity_id, message)
+
+# Get the state of a single entity
+state = client.get_state(entity_id)
+print(state)    
+
+# Register for updates for a specfic entity
+client.subscribe_to_trigger(
+    entity_id="media_player.studio_amplifier",
+    callback=my_callback,
+)
+
+sleep(10)
+
+# Send a turn on command
+client.turn_on(
+    entity_id=entity_id
+)
+
+sleep(10)
+
+# Send a change volume command
+client.call_service(
+    domain="media_player",
+    service="volume_set",
+    entity_id=entity_id,
+    service_data={
+        "volume_level" : "0.50"
+    }
+)
+
+sleep(10)
+
+# Send a turn off command
+client.turn_off(
+    entity_id=entity_id
+)
+
+sleep(60)
+
+```
+
+## TODO
+
+This is a work in progress there are a lot of TODOs in the code.
+

py_ha_ws_client-0.1/py_ha_ws_client.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+py_ha_ws_client/__init__.py
+py_ha_ws_client/client.py
+py_ha_ws_client.egg-info/PKG-INFO
+py_ha_ws_client.egg-info/SOURCES.txt
+py_ha_ws_client.egg-info/dependency_links.txt
+py_ha_ws_client.egg-info/requires.txt
+py_ha_ws_client.egg-info/top_level.txt

py_ha_ws_client-0.1/py_ha_ws_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_ha_ws_client-0.1/py_ha_ws_client.egg-info/requires.txt

@@ -0,0 +1 @@
+ws4py==0.5.1

py_ha_ws_client-0.1/py_ha_ws_client.egg-info/top_level.txt

@@ -0,0 +1 @@
+py_ha_ws_client

py_ha_ws_client-0.1/setup.cfg

@@ -0,0 +1,7 @@
+[metadata]
+description-file = README
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_ha_ws_client-0.1/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup
+
+version = '0.1'
+
+with open("README.md", "rb") as f:
+    long_descr = f.read().decode("utf-8")
+
+setup(
+    name='py_ha_ws_client',
+    packages=['py_ha_ws_client'],
+    version=version,
+    license='Apache 2.0',
+    description='A Python client to make it easy to connect and consume data from the Home Assistant web socket API.',
+    long_description=long_descr,
+    long_description_content_type='text/markdown',    
+    author='foxy82',
+    author_email='foxy82.github@gmail.com',
+    url='https://github.com/foxy82/py-ha-ws-client',
+    download_url=f'https://github.com/foxy82/py-ha-ws-client/archive/{version}.tar.gz',
+    keywords=['Home Assistant', 'Websocket'],
+    install_requires=[
+        "ws4py==0.5.1"
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 3.10'
+    ],
+)