Merge pull request #1168 from fronzbot/dev

v0.25.3

Author: fronzbot

API.md

@@ -3,7 +3,7 @@ Unofficial documentation for the Client API of the Blink Wire-Free HD Home Monit
 
 Copied from https://github.com/MattTW/BlinkMonitorProtocol
 
-I am not affiliated with the company in any way - this documentation is strictly **"AS-IS"**.  My goal was to uncover enough to arm and disarm the system programatically so that I can issue those commands in sync with my home alarm system arm/disarm.  Just some raw notes at this point but should be enough for creating programmatic APIs.    Lots more to be discovered and documented - feel free to contribute!
+I am not affiliated with the company in any way - this documentation is strictly **"AS-IS"**.  My goal was to uncover enough to arm and disarm the system programmatically so that I can issue those commands in sync with my home alarm system arm/disarm.  Just some raw notes at this point but should be enough for creating programmatic APIs.    Lots more to be discovered and documented - feel free to contribute!
 
 The Client API is a straightforward REST API using JSON and HTTPS.
 
@@ -121,7 +121,7 @@ Get events for a given network (sync module) -- Need network ID from home
 >curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/events/network/*network__id*
 
 **Response**
-A json list of evets incluing URL's.   Replace the "mp4" with "jpg" extension to get the thumbnail of each clip
+A json list of evets including URL's.   Replace the "mp4" with "jpg" extension to get the thumbnail of each clip
 
 
 **Request**

CHANGES.rst

@@ -23,7 +23,7 @@ See release notes: (`0.22.7 <https://github.com/fronzbot/blinkpy/releases/tag/v0
 
 - Test for None type in poll_local_storage_manifest (`@mkmer #859 <https://github.com/fronzbot/blinkpy/pull/859>`__)
 - Update image after snap by (`@mkmer #861 <https://github.com/fronzbot/blinkpy/pull/861>`__)
-- fix missing ':' before port number in rtsps adress (`@Rosi2143 #863 <https://github.com/fronzbot/blinkpy/pull/863>`__)
+- fix missing ':' before port number in rtsps address (`@Rosi2143 #863 <https://github.com/fronzbot/blinkpy/pull/863>`__)
 - New temperature location (`@mkmer #867 <https://github.com/fronzbot/blinkpy/pull/867>`__)
 
 **Other changes**
@@ -366,12 +366,12 @@ Same as 0.22.1 (pypi upload issue)
 **New Features:**
 
 - Add is_errored property to Auth class (`@fronzbot #275 <https://github.com/fronzbot/blinkpy/pull/275>`__)
-- Add new endpoint to get user infor (`@fronzbot #280 <https://github.com/fronzbot/blinkpy/pull/280>`__)
+- Add new endpoint to get user info (`@fronzbot #280 <https://github.com/fronzbot/blinkpy/pull/280>`__)
 - Add get_liveview command to camera module (`@fronzbot #289 <https://github.com/fronzbot/blinkpy/pull/289>`__)
 - Add blink Mini Camera support (`@fronzbot #290 <https://github.com/fronzbot/blinkpy/pull/290>`__)
 - Add option to skip homescreen check (`@fronzbot #305 <https://github.com/fronzbot/blinkpy/pull/305>`__)
 - Add different timeout for video and image retrieval (`@fronzbot #323 <https://github.com/fronzbot/blinkpy/pull/323>`__)
-- Modifiy session to use HTTPAdapter and handle retries (`@fronzbot #324 <https://github.com/fronzbot/blinkpy/pull/324>`__)
+- Modify session to use HTTPAdapter and handle retries (`@fronzbot #324 <https://github.com/fronzbot/blinkpy/pull/324>`__)
 - Add retry option overrides (`@fronzbot #339 <https://github.com/fronzbot/blinkpy/pull/339>`__)
 
 **All changes:**
@@ -529,7 +529,7 @@ Wifi status reported in dBm again, instead of bars (which is great).  Also, the
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - Moved all API calls to own module for easier maintainability
 - Added network ids to sync module and cameras to allow for multi-network use
-- Removed dependency on video existance prior to camera setup (fixes `#93 <https://github.com/fronzbot/blinkpy/issues/#93>`__)
+- Removed dependency on video existence prior to camera setup (fixes `#93 <https://github.com/fronzbot/blinkpy/issues/#93>`__)
 - Camera wifi_strength now reported in wifi "bars" rather than dBm due to API endpoint change
 - Use homescreen thumbnail as fallback in case it's not in the camera endpoint
 - Removed "armed" and "status" attributes from camera (status of camera only reported by "motion_enabled" now)
@@ -569,7 +569,7 @@ Wifi status reported in dBm again, instead of bars (which is great).  Also, the
 - Added support for battery voltage level (fixes `#64 <https://github.com/fronzbot/blinkpy/issues/64>`__)
 - Added motion detection per camera
 - Added fully accessible camera configuration dict
-- Added celcius property to camera (fixes `#60 <https://github.com/fronzbot/blinkpy/issues/60>`__)
+- Added celsius property to camera (fixes `#60 <https://github.com/fronzbot/blinkpy/issues/60>`__)
 
 0.7.1 (2018-05-09)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -591,7 +591,7 @@ Wifi status reported in dBm again, instead of bars (which is great).  Also, the
 
 0.6.0 (2017-05-12)
 ~~~~~~~~~~~~~~~~~~
-- Removed redundent properties that only called hidden variables
+- Removed redundant properties that only called hidden variables
 - Revised request wrapper function to be more intelligent
 - Added tests to ensure exceptions are caught and handled (100% coverage!)
 - Added auto-reauthorization (token refresh) when a request fails due to an expired token (`@tySwift93 <https://github.com/fronzbot/blinkpy/pull/24>`__)

CONTRIBUTING.rst

@@ -87,7 +87,7 @@ You can then run all of the tests with the following command:
 
 If you only want to see if you can pass the local tests, you can run ``tox -e py39`` (or whatever python version you have installed.  Only ``py39`` through ``py312`` will be accepted).  If you just want to check for style violations, you can run ``tox -e lint``.  Regardless, when you submit a pull request, your code MUST pass both the unit tests, and the linters.
 
-If you need to change anything in ``requirements.txt`` for any reason, you'll want to regenerate the virtual envrionments used by ``tox`` by running with the ``-r`` flag: ``tox -r``
+If you need to change anything in ``requirements.txt`` for any reason, you'll want to regenerate the virtual environments used by ``tox`` by running with the ``-r`` flag: ``tox -r``
 
 If you want to run a single test (perhaps you only changed a small thing in one file) you can run ``tox -e py37 -- tests/<testname>.py -x``.  This will run the test ``<testname>.py`` and stop testing upon the first failure, making it easier to figure out why a particular test might be failing.  The test structure mimics the library structure, so if you changed something in ``sync_module.py``, the associated test file would be in ``test_sync_module.py`` (ie. the filename is prepended with ``test_``.
 

README.rst

@@ -198,7 +198,7 @@ Similar methods exist for individual cameras:
 
 Download videos
 ----------------
-You can also use this library to download all videos from the server.  In order to do this, you must specify a ``path``.  You may also specifiy a how far back in time to go to retrieve videos via the ``since=`` variable (a simple string such as ``"2017/09/21"`` is sufficient), as well as how many pages to traverse via the ``stop=`` variable.  Note that by default, the library will search the first ten pages which is sufficient in most use cases.  Additionally, you can specify one or more cameras via the ``camera=`` property.  This can be a single string indicating the name of the camera, or a list of camera names.  By default, it is set to the string ``'all'`` to grab videos from all cameras. If you are downloading many items, setting the ``delay`` parameter is advised in order to throttle sequential calls to the API. By default this is set to ``1`` but can be any integer representing the number of seconds to delay between calls.
+You can also use this library to download all videos from the server.  In order to do this, you must specify a ``path``.  You may also specify a how far back in time to go to retrieve videos via the ``since=`` variable (a simple string such as ``"2017/09/21"`` is sufficient), as well as how many pages to traverse via the ``stop=`` variable.  Note that by default, the library will search the first ten pages which is sufficient in most use cases.  Additionally, you can specify one or more cameras via the ``camera=`` property.  This can be a single string indicating the name of the camera, or a list of camera names.  By default, it is set to the string ``'all'`` to grab videos from all cameras. If you are downloading many items, setting the ``delay`` parameter is advised in order to throttle sequential calls to the API. By default this is set to ``1`` but can be any integer representing the number of seconds to delay between calls.
 
 Example usage, which downloads all videos recorded since July 4th, 2018 at 9:34am to the ``/home/blink`` directory with a 2s delay between calls:
 

blinkapp/run.sh

@@ -3,7 +3,7 @@
 
 if [ "$#" -ne 2 ]; then
     echo ""
-    echo "ERROR: Requries Blink username and password as arguments."
+    echo "ERROR: Requires Blink username and password as arguments."
     echo "bash run.sh [username] [password]"
     echo ""
     exit 1
@@ -28,4 +28,3 @@ docker run -it --name ${IMAGE} \
     -e PASSWORD=${PASSWORD} \
     $USER/$IMAGE \
     /bin/bash
-

blinkpy/helpers/util.py

@@ -39,7 +39,7 @@ async def json_save(data, file_name):
 
 
 def json_dumps(json_in, indent=2):
-    """Return a well formated json string."""
+    """Return a well formatted json string."""
     return json.dumps(json_in, indent=indent)
 
 

blinkpy/livestream.py

@@ -25,11 +25,25 @@ def __init__(self, camera, response):
         self.target_reader = None
         self.target_writer = None
 
+    def add_auth_header_string_field(self, auth_header, field_string, max_length):
+        """Add string field to authentication header."""
+        _LOGGER.debug("Field string: %s", field_string)
+        field_bytes = field_string.encode("utf-8")[:max_length]
+        field_bytes = field_bytes.ljust(max_length, b"\x00")
+        _LOGGER.debug("Field bytes: %s", field_bytes)
+        field_length = len(field_bytes).to_bytes(4, byteorder="big")
+        _LOGGER.debug("Field length: %s (%d)", field_length, len(field_length))
+        auth_header.extend(field_length)
+        auth_header.extend(field_bytes)
+
     def get_auth_header(self):
         """Get authentication header."""
         auth_header = bytearray()
+        serial_max_length = 16
+        token_field_max_length = 64
+        conn_id_max_length = 16
 
-        # Magic numeber
+        # Magic number (4 bytes)
         # fmt: off
         magic_number = [
             0x00, 0x00, 0x00, 0x28, # Magic number (4 bytes)
@@ -38,51 +52,39 @@ def get_auth_header(self):
         auth_header.extend(magic_number)
         # Total packet length: 4 bytes
 
-        # Unknown string field (4-byte length prefix, 16 unknown bytes)
-        # fmt: off
-        unknown_string_field = [
-            0x00, 0x00, 0x00, 0x00, # Length prefix (4 bytes)
-        ] + ([0x00] * 16) # Unknown bytes (16 bytes)
-        # fmt: on
-        auth_header.extend(unknown_string_field)
+        # Device Serial field (4-byte length prefix, 16 serial bytes)
+        serial = self.camera.serial
+        self.add_auth_header_string_field(auth_header, serial, serial_max_length)
         # Total packet length: 24 bytes
 
-        # Client ID field
+        # Client ID field (4 bytes)
         client_id = urllib.parse.parse_qs(self.target.query).get("client_id", [0])[0]
         _LOGGER.debug("Client ID: %s", client_id)
         client_id_field = int(client_id).to_bytes(4, byteorder="big")
         _LOGGER.debug("Client ID field: %s (%d)", client_id_field, len(client_id_field))
         auth_header.extend(client_id_field)
         # Total packet length: 28 bytes
 
-        # Unknown prefix field (2-byte prefix, 4-byte length prefix, 64 unknown bytes)
+        # Static field (2 bytes)
         # fmt: off
-        unknown_prefix_field = [
-            0x01, 0x08, # Static prefix (2 bytes)
-            0x00, 0x00, 0x00, 0x00, # Length prefix (4 bytes)
-        ] + ([0x00] * 64) # Unknown bytes (64 bytes)
+        static_field = [
+            0x01, 0x08, # Static value (2 bytes)
+        ]
         # fmt: on
-        auth_header.extend(unknown_prefix_field)
-        # Total packet length: 98 bytes
+        auth_header.extend(static_field)
+        # Total packet length: 30 bytes
 
-        # Connection ID length field (4-byte length prefix)
+        # Auth Token field (4-byte length prefix, 64 null bytes for now)
         # fmt: off
-        conn_id_length_prefix = [
-            0x00, 0x00, 0x00, 0x10,
-        ]
-        # fmt: on
-        auth_header.extend(conn_id_length_prefix)
-        # Total packet length: 102 bytes
+        token_length = token_field_max_length.to_bytes(4, byteorder="big")
+        _LOGGER.debug("Null token length: %s (%d)", token_length, len(token_length))
+        auth_header.extend(token_length)
+        auth_header.extend([0x00] * token_field_max_length)
+        # Total packet length: 98 bytes
 
-        # Connection ID field (UTF-8-encoded, 16 bytes)
+        # Connection ID field (4-byte length prefix, 16 connection ID bytes)
         conn_id = self.target.path.split("/")[-1].split("__")[0]
-        _LOGGER.debug("Connection ID: %s", conn_id)
-        conn_id_field = conn_id.encode("utf-8")[:16]
-        # Ensure it is exactly 16 bytes long
-        if len(conn_id_field) < 16:
-            conn_id_field += b"\x00" * (16 - len(conn_id_field))
-        _LOGGER.debug("Connection ID field: %s (%d)", conn_id_field, len(conn_id_field))
-        auth_header.extend(conn_id_field)
+        self.add_auth_header_string_field(auth_header, conn_id, conn_id_max_length)
         # Total packet length: 118 bytes
 
         # Trailer (static 4-byte trailer)
@@ -249,9 +251,14 @@ async def send(self):
         latency_stats_packet = [
             # [1-byte msgtype, 4-byte sequence (static 1000), 4-byte payload length]
             0x12, 0x00, 0x00, 0x03, 0xe8, 0x00, 0x00, 0x00, 0x18, # 9-byte header
-            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # 1/3 of 24-byte payload
-            0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # 2/3 of 24-byte payload
-            0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, # 3/3 of 24-byte payload
+            0x00, 0x00, 0x00, 0x00, # 4-byte audioAverageLatencyInMS
+            0x00, 0x00, 0x00, 0x00, # 4-byte audioMaxLatencyInMS
+            0x00, 0x00, # 2-byte audioFramesPresented
+            0x00, 0x00, # 2-byte audioFramesDropped
+            0x00, 0x00, 0x00, 0x00, # 4-byte videoAverageLatencyInMS
+            0x00, 0x00, 0x00, 0x00, # 4-byte videoMaxLatencyInMS
+            0x00, 0x00, # 2-byte videoFramesPresented
+            0x00, 0x00, # 2-byte videoFramesDropped
         ]
         # fmt: on
         every10s = 0

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "blinkpy"
-version = "0.25.2"
+version = "0.25.3"
 license = {text = "MIT"}
 description = "A Blink camera Python Library."
 readme = "README.rst"
@@ -47,7 +47,7 @@ lint.select = [
     "E",  # pydocstyle
     "F",  # pyflakes/autoflake
     "G",  # flake8-logging-format
-    "N815",  # Varible {name} in class scope should not be mixedCase
+    "N815",  # Variable {name} in class scope should not be mixedCase
     "PGH004",  # Use specific rule codes when using noqa
     "PLC",  # pylint
     "PLE",  # pylint

requirements_test.txt

@@ -1,4 +1,4 @@
-ruff==0.14.8
+ruff==0.14.10
 black==25.11.0
 build==1.3.0
 coverage==7.10.7

tests/test_api.py

@@ -117,7 +117,7 @@ async def test_request_notification_flags(self, mock_resp):
         )
 
     async def test_request_set_notification_flag(self, mock_resp):
-        """Test set of notifiaction flags."""
+        """Test set of notification flags."""
         mock_resp.side_effect = (
             mresp.MockResponse(COMMAND_RESPONSE, 200),
             COMMAND_COMPLETE,