deapi 5.3b6__tar.gz → 5.3.1__tar.gz

{deapi-5.3b6 → deapi-5.3.1}/.github/workflows/build.yaml

@@ -20,8 +20,8 @@ jobs:
         python-version: ["3.12", "3.13"]
         include:
           - os: ubuntu-latest
-            python-version: "3.11"
-            DEPENDENCIES: protobuf==5.26.0
+            python-version: "3.10"
+            DEPENDENCIES: protobuf==6.33.5
             LABEL: -oldest
     steps:
       - uses: actions/checkout@v4

deapi-5.3.1/.github/workflows/prepare_release.yml

@@ -0,0 +1,192 @@
+name: Prepare Release
+
+# Run manually from the Actions tab.
+# Opens a PR that bumps the version in pyproject.toml and builds CHANGES.rst from
+# the towncrier fragments in upcoming_changes/. After merging it, create the GitHub
+# Release by hand (tag v<version>); publishing the release triggers publish.yaml,
+# which uploads to PyPI.
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: "Version component to bump"
+        required: true
+        type: choice
+        options:
+          - pre-release   # increments the bN counter on the current base version (5.3b6 -> 5.3.0b7)
+          - finalize      # drop the bN suffix: release the current beta's base as stable (5.3b6 -> 5.3.0)
+          - minor
+          - bugfix
+          - major
+      beta:
+        description: "Mark as beta pre-release (adds bN suffix). Ignored for 'pre-release' (always beta) and 'finalize' (always stable)."
+        required: false
+        type: boolean
+        default: false
+
+permissions:
+  contents: write        # push branch
+  pull-requests: write   # open PR
+
+jobs:
+  prepare:
+    name: Prepare release PR
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      # ── Compute the new version ──────────────────────────────────────────
+      - name: Compute new version
+        id: version
+        env:
+          BUMP: ${{ inputs.bump }}
+          IS_BETA: ${{ inputs.beta }}
+        run: |
+          CURRENT=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          export CURRENT_VERSION="$CURRENT"
+
+          NEW_VERSION=$(python3 - <<'PYEOF'
+          import re, os
+
+          current = os.environ["CURRENT_VERSION"]
+          bump    = os.environ["BUMP"]
+          is_beta = os.environ["IS_BETA"].lower() == "true"
+
+          # deapi's versions have had no patch component (5.3b6); read it as 0 and
+          # always write major.minor.patch from here on (5.3b6 == 5.3.0b6 in PEP 440).
+          m = re.match(r"^(\d+)\.(\d+)(?:\.(\d+))?(?:b(\d+))?$", current)
+          if not m:
+              raise SystemExit(f"cannot parse the current version {current!r}")
+          major  = int(m.group(1))
+          minor  = int(m.group(2))
+          patch  = int(m.group(3) or 0)
+          beta_n = int(m.group(4)) if m.group(4) else None
+          on_beta = beta_n is not None
+
+          if bump == "finalize":
+              # Release the current beta's base as stable: just drop the bN
+              # suffix, keep major.minor.patch. e.g. 5.3.0b7 -> 5.3.0.
+              if not on_beta:
+                  raise SystemExit(
+                      f"'finalize' requires a beta base version, but current "
+                      f"version {current!r} has no bN suffix. Use minor / bugfix "
+                      f"/ major to start a new release instead."
+                  )
+              is_beta = False
+          elif bump == "pre-release":
+              # Keep the same base; just walk the beta counter forward.
+              is_beta = True
+              beta_n  = (beta_n or 0) + 1
+          elif on_beta:
+              # We are on a beta of the NEXT release (e.g. 5.3.0b7). The base
+              # major.minor.patch is that upcoming version, so minor/bugfix/major
+              # would skip it entirely. The common intent from a beta is
+              # 'finalize', so steer the user there rather than guess.
+              raise SystemExit(
+                  f"Current version {current!r} is a beta of the upcoming "
+                  f"{major}.{minor}.{patch} release. To ship it, use bump="
+                  f"'finalize' (-> {major}.{minor}.{patch}). A '{bump}' bump from "
+                  f"a beta would skip {major}.{minor}.{patch} entirely; "
+                  f"that is almost never intended."
+              )
+          elif bump == "major":
+              major, minor, patch = major + 1, 0, 0
+          elif bump == "minor":
+              minor, patch = minor + 1, 0
+          elif bump == "bugfix":
+              patch += 1
+
+          if is_beta:
+              if bump != "pre-release":
+                  beta_n = 1          # fresh beta series for the new base
+              print(f"{major}.{minor}.{patch}b{beta_n}", end="")
+          else:
+              print(f"{major}.{minor}.{patch}", end="")
+          PYEOF
+          )
+
+          # Derive is_beta from the COMPUTED version (ends in bN?), not the raw input.
+          if [[ "$NEW_VERSION" =~ b[0-9]+$ ]]; then IS_BETA_OUT=true; else IS_BETA_OUT=false; fi
+
+          echo "new_version=$NEW_VERSION"                  >> "$GITHUB_OUTPUT"
+          echo "tag=v$NEW_VERSION"                         >> "$GITHUB_OUTPUT"
+          echo "branch=release/v$NEW_VERSION"              >> "$GITHUB_OUTPUT"
+          echo "is_beta=$IS_BETA_OUT"                      >> "$GITHUB_OUTPUT"
+          echo "Bumping (${{ inputs.bump }}): $CURRENT → $NEW_VERSION"
+
+      # ── Bump version strings ─────────────────────────────────────────────
+      # Only the package version: deapi/version.py holds the client's protocol
+      # version (sent to DE-Server), which does not follow package releases.
+      - name: Bump version in pyproject.toml
+        run: |
+          sed -i 's/^version = ".*"/version = "${{ steps.version.outputs.new_version }}"/' pyproject.toml
+
+      # ── Build changelog ──────────────────────────────────────────────────
+      - name: Build changelog with towncrier
+        run: |
+          FRAGMENT_COUNT=$(find upcoming_changes -maxdepth 1 -name "*.rst" \
+                            ! -name "README.rst" | wc -l)
+          if [ "$FRAGMENT_COUNT" -eq 0 ]; then
+            echo "⚠ No news fragments found — skipping towncrier (CHANGES.rst unchanged)."
+          else
+            uvx towncrier build --yes --version "${{ steps.version.outputs.new_version }}"
+          fi
+
+      # ── Commit and push ──────────────────────────────────────────────────
+      - name: Configure git
+        run: |
+          git config user.name  "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Commit release changes
+        run: |
+          git checkout -b "${{ steps.version.outputs.branch }}"
+
+          # Stage the version bump, updated changelog, and consumed fragments.
+          git add pyproject.toml CHANGES.rst
+          git add -A upcoming_changes/    # stages deleted fragment files
+
+          git commit -m "chore: prepare release ${{ steps.version.outputs.tag }}"
+          git push origin "${{ steps.version.outputs.branch }}"
+
+      # ── Open pull request ────────────────────────────────────────────────
+      - name: Open pull request
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG: ${{ steps.version.outputs.tag }}
+          BRANCH: ${{ steps.version.outputs.branch }}
+          IS_BETA: ${{ steps.version.outputs.is_beta }}
+        run: |
+          if [ "$IS_BETA" = "true" ]; then PRE="tick **Set as a pre-release**"; else PRE="leave **Set as a pre-release** unticked"; fi
+          gh pr create \
+            --title "Release ${TAG}" \
+            --base  main \
+            --head  "${BRANCH}" \
+            --body  "## Release ${TAG}
+
+          > Auto-generated by the **Prepare Release** workflow.
+
+          ### What changed
+          - Version bumped to \`${TAG#v}\` in \`pyproject.toml\`
+          - \`CHANGES.rst\` updated from the towncrier fragments in \`upcoming_changes/\`
+
+          ### Review checklist
+          - [ ] \`CHANGES.rst\` reads well — edit the text directly in this PR if needed
+          - [ ] The version in \`pyproject.toml\` is correct
+          - [ ] CI passes
+
+          ### After merging
+          Create the GitHub Release by hand: **Releases → Draft a new release**, tag
+          \`${TAG}\` on \`main\`, paste this version's section of \`CHANGES.rst\` as the
+          notes, ${PRE}, and publish. Publishing it runs \`publish.yaml\`, which uploads
+          to PyPI."

{deapi-5.3b6 → deapi-5.3.1}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   - repo: https://github.com/psf/black-pre-commit-mirror
     # Version can be updated by running "pre-commit autoupdate"
-    rev: 25.9.0
+    rev: 26.5.1
     hooks:
       - id: black
 ci:

deapi-5.3.1/CHANGES.rst

@@ -0,0 +1,92 @@
+.. _changelog:
+
+Changelog
+*********
+
+This document describes the changes in the DEAPI library.
+
+Changes are filed as fragment files in ``upcoming_changes/`` and assembled into this
+file by `towncrier <https://towncrier.readthedocs.io/>`_ when a release is prepared
+(see ``upcoming_changes/README.rst``).
+
+.. towncrier release notes start
+
+5.3.1 (2026-09-25)
+==================
+
+Maintenance
+-----------
+
+- Bumped the google protobuf version to 6.33 and dropped support for Python < 3.10. Closes #3691 (`#64 <https://github.com/directelectron/deapi/pull/64>`_)
+
+
+5.3.0 (2026-09-24)
+==================
+
+New Features
+------------
+
+- ``pydeserver --twin`` serves frames rendered by the `de-twin <https://github.com/directelectron/de-twin>`_ digital twin instead of the built-in fake data: a simulated microscope, specimen and detector, with a DE-TEM-Channel (``--soap-port``) so stage and optics changes show up in the images. Install it with ``pip install "deapi[twin]"``. (`#59 <https://github.com/directelectron/deapi/pull/59>`_)
+
+
+Bug Fixes
+---------
+
+- Fixed virtual masks and XY scan arrays sometimes arriving incomplete, which hung the connection (seen on macOS): the client now sends every byte of them. (`#60 <https://github.com/directelectron/deapi/pull/60>`_)
+
+
+Documentation
+-------------
+
+- Added an example that moves the stage with ``de_microscope`` and images holes in a grid, run against the digital twin. (`#59 <https://github.com/directelectron/deapi/pull/59>`_)
+
+
+Maintenance
+-----------
+
+- The simulated server closes a connection after an error, so the client gets an error instead of waiting; the test suite only stops deapi's own simulated server on port 13240, never a real DE-Server. (`#60 <https://github.com/directelectron/deapi/pull/60>`_)
+- Releases are prepared by the **Prepare Release** workflow, and the changelog is assembled from towncrier fragments in ``upcoming_changes/``, as in the other Direct Electron Python packages. (`#61 <https://github.com/directelectron/deapi/pull/61>`_)
+
+
+5.3.beta6
+=========
+- Fixed invalid property errors and bugs in set_binning
+- Updated get_property_specifications
+- Do not automatically set attributes.windowWidth and attributes.windowHeight
+- Return pattern index for get_result and get_virtual_image_buffer
+
+5.3.beta5
+=========
+- Modify gain acquisition
+
+5.3.beta4
+=========
+- Add GetEvent functionality to client.py
+- Fixed bug in set_binning
+
+5.3.beta3
+=========
+- Fix the problem that the set_binning function could not set HW binning to 1
+
+5.3.beta2
+=========
+- Add access register
+
+5.3.beta1
+=========
+- Create a Result Class to handle Result + Histogram
+
+5.3.beta0
+=========
+- Add support for binning in x/ y dimensions when returning a result (#19)
+
+5.2.2
+==========
+- Initial release
+- Renamed `Client` functions from CamelCase to snake_case (Legacy functions are still available)
+- Added buffer_protocol module for handling different buffer protocol files
+- Added a data_types module for handling different data types
+- Added a python based DEServer for testing purposes
+- Update the Testing to allow for a real DEServer to be used for testing (#7)
+- Add support for `@pytest.mark.server` decorator for tests that require a full DEServer to be running (#7)
+- Add a commandline interface for the pydeserver. (#8) Running `pydeserver --port 13241` will start the server on port 13241

{deapi-5.3b6 → deapi-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deapi
-Version: 5.3b6
+Version: 5.3.1
 Summary: API for DE Server
 Author: Direct Electron
 Project-URL: Bug Reports, https://github.com/directelectron/deapi/issues
@@ -12,16 +12,15 @@ Keywords: EELS,STEM,TEM,hyperspy,microscopy,Cryo EM,4D STEM
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 License-File: LICENSE
 Requires-Dist: numpy>=1.20.0
-Requires-Dist: protobuf>=3.20.0
+Requires-Dist: protobuf<7,>=6.33.5
 Requires-Dist: pillow
 Requires-Dist: matplotlib
 Requires-Dist: scipy
@@ -42,6 +41,8 @@ Requires-Dist: hyperspy; extra == "tests"
 Requires-Dist: psutil; extra == "tests"
 Provides-Extra: service
 Requires-Dist: pyqt6; extra == "service"
+Provides-Extra: twin
+Requires-Dist: de-twin>=0.1.1; python_version >= "3.10" and extra == "twin"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: pydata_sphinx_theme; extra == "doc"

{deapi-5.3b6 → deapi-5.3.1}/deapi/buffer_protocols/__init__.py

@@ -17,8 +17,7 @@ else:
 
     long = int  # python 3 no longer has int
     if int(pyVersion[1]) >= 10:
-        # import pb_3_19_3 as pb
-        import deapi.buffer_protocols.pb_3_23_3 as pb
+        import deapi.buffer_protocols.pb_6_33_4 as pb
     elif int(pyVersion[1]) >= 8:
         import deapi.buffer_protocols.pb_3_11_4 as pb
     else:

deapi-5.3.1/deapi/buffer_protocols/pb_6_33_4.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: DE.proto
+# Protobuf Python Version: 6.33.4
+"""Generated protocol buffer code."""
+
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC, 6, 33, 4, "", "DE.proto"
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
+    b'\n\x08\x44\x45.proto\x12\x0b\x44\x45Messaging"\xbd\x02\n\x08\x44\x45Packet\x12(\n\x04type\x18\x01 \x01(\x0e\x32\x1a.DEMessaging.DEPacket.Type\x12\x19\n\x11\x63\x61mera_identifier\x18\x02 \x01(\r\x12+\n\x07\x63ommand\x18\x03 \x03(\x0b\x32\x1a.DEMessaging.SingleCommand\x12\x33\n\x0b\x61\x63knowledge\x18\x04 \x03(\x0b\x32\x1e.DEMessaging.SingleAcknowledge\x12,\n\x0b\x64\x61ta_header\x18\x05 \x01(\x0b\x32\x17.DEMessaging.DataHeader\x12\x13\n\x0b\x63\x61mera_name\x18\x06 \x01(\t"G\n\x04Type\x12\n\n\x06P_NULL\x10\x00\x12\r\n\tP_COMMAND\x10\x01\x12\x11\n\rP_ACKNOWLEDGE\x10\x02\x12\x11\n\rP_DATA_HEADER\x10\x03"g\n\rSingleCommand\x12\x12\n\ncommand_id\x18\x01 \x01(\r\x12\x14\n\x0c\x63ommand_name\x18\x02 \x01(\t\x12,\n\tparameter\x18\x03 \x03(\x0b\x32\x19.DEMessaging.AnyParameter"\xf0\x01\n\x0c\x41nyParameter\x12,\n\x04type\x18\x01 \x01(\x0e\x32\x1e.DEMessaging.AnyParameter.Type\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\r\n\x05p_int\x18\x03 \x01(\x11\x12\x0e\n\x06p_bool\x18\x04 \x01(\x08\x12\x10\n\x08p_string\x18\x05 \x01(\t\x12\x0f\n\x07p_float\x18\x06 \x01(\x02\x12\x0f\n\x07p_bytes\x18\x07 \x01(\x0c"Q\n\x04Type\x12\n\n\x06P_NULL\x10\x00\x12\t\n\x05P_INT\x10\x01\x12\n\n\x06P_BOOL\x10\x02\x12\x0c\n\x08P_STRING\x10\x03\x12\x0b\n\x07P_FLOAT\x10\x04\x12\x0b\n\x07P_BYTES\x10\x05"]\n\x0b\x41\x63knowledge\x12\x19\n\x11\x63\x61mera_identifier\x18\x01 \x01(\r\x12\x33\n\x0b\x61\x63knowledge\x18\x02 \x03(\x0b\x32\x1e.DEMessaging.SingleAcknowledge"\x91\x01\n\x11SingleAcknowledge\x12\r\n\x05\x65rror\x18\x01 \x01(\x08\x12\x12\n\ncommand_id\x18\x02 \x01(\r\x12\x14\n\x0c\x63ommand_name\x18\x03 \x01(\t\x12\x15\n\rerror_message\x18\x04 \x01(\t\x12,\n\tparameter\x18\x05 \x03(\x0b\x32\x19.DEMessaging.AnyParameter"2\n\nDataHeader\x12\x10\n\x08\x62ytesize\x18\x01 \x01(\x04\x12\x12\n\nidentifier\x18\x02 \x01(\tb\x06proto3'
+)
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "DE_pb2", _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+    DESCRIPTOR._loaded_options = None
+    _globals["_DEPACKET"]._serialized_start = 26
+    _globals["_DEPACKET"]._serialized_end = 343
+    _globals["_DEPACKET_TYPE"]._serialized_start = 272
+    _globals["_DEPACKET_TYPE"]._serialized_end = 343
+    _globals["_SINGLECOMMAND"]._serialized_start = 345
+    _globals["_SINGLECOMMAND"]._serialized_end = 448
+    _globals["_ANYPARAMETER"]._serialized_start = 451
+    _globals["_ANYPARAMETER"]._serialized_end = 691
+    _globals["_ANYPARAMETER_TYPE"]._serialized_start = 610
+    _globals["_ANYPARAMETER_TYPE"]._serialized_end = 691
+    _globals["_ACKNOWLEDGE"]._serialized_start = 693
+    _globals["_ACKNOWLEDGE"]._serialized_end = 786
+    _globals["_SINGLEACKNOWLEDGE"]._serialized_start = 789
+    _globals["_SINGLEACKNOWLEDGE"]._serialized_end = 934
+    _globals["_DATAHEADER"]._serialized_start = 936
+    _globals["_DATAHEADER"]._serialized_end = 986
+# @@protoc_insertion_point(module_scope)

{deapi-5.3b6 → deapi-5.3.1}/deapi/client.py

@@ -151,7 +151,7 @@ class Client:
                 PropertyCollection(client=self, name=collection, properties=props),
             )
 
-    def connect(self, host: str = "127.0.0.1", port: int = 13240, read_only=False):
+    def connect(self, host: str = "127.0.0.1", port: int = 13240, read_only=None):
         """Connect to DE-Server
 
         Parameters
@@ -160,20 +160,12 @@ class Client:
             The host to connect to, by default "127.0.0.1" for local connection
         port : int, optional
             The port to connect to, by default 13240
-        read_only : bool, optional
+        read_only : bool, optional (deprecated for command version >= 17)
             If True, the client will be in read-only mode, by default False
+            For command version >= 17, the read_only parameter is ignored and
+            the client will query the server to determine whether it should be
+            read-only or read-write.
         """
-        self.read_only = read_only
-        if not read_only and (host == "localhost" or host == "127.0.0.1"):
-            tcp_no_delay = 0  # on loopback interface, nodelay causes delay
-
-            if self.usingMmf:
-                self.mmf = mmap.mmap(0, MMF_DATA_BUFFER_SIZE, "ImageFileMappingObject")
-                self.mmf[0] = True
-        else:
-            self.usingMmf = False  # Disabled MMF if connected remotely
-            tcp_no_delay = 1
-
         if logLevel == logging.DEBUG:
             log.debug("Connecting to server: %s", host)
 
@@ -183,7 +175,6 @@ class Client:
         self.socket.connect(
             (host, port)
         )  # Connect to server reading port for sending data
-        self.socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, tcp_no_delay)
         self.socket.setblocking(False)
         self.socket.settimeout(2)
 
@@ -200,15 +191,15 @@ class Client:
         self.port = port
         log.info("Connected to server: %s, port: %d", host, port)
 
-        if cVersion >= 12:
-            self.set_client_read_only(read_only)
-
         server_version = self.GetProperty("Server Software Version")
         server_version = re.findall(r"\d+", server_version)
 
         version = [int(part) for part in server_version[:4]]
         temp = version[2] + version[1] * 1000 + version[0] * 1000000
-        if temp >= 2008000 and version[3] >= 12073:
+        if temp >= 2008003 and version[3] >= 12436:
+            ## version 2.8.3 build 12436+
+            self.commandVersion = 17
+        elif temp >= 2008000 and version[3] >= 12073:
             ## version 2.8.0 build 12073+ — virtual image buffer support (SDK 5.3.0)
             self.commandVersion = 16
         elif (temp >= 2007005 and version[3] < 11274) or temp >= 2008000:
@@ -234,6 +225,25 @@ class Client:
             self.commandVersion = 3
         else:
             self.commandVersion = commandVersion
+
+        if self.commandVersion >= 12 and self.commandVersion < 17:
+            if read_only is None:
+                read_only = False
+            self.set_client_read_only(read_only)
+        elif self.commandVersion >= 17:
+            if read_only is not None:
+                log.warning(
+                    "The `read_only` argument to `connect()` is ignored for servers "
+                    "with command version >= 17 (DE-MC version >= 2.8.3.12436). "
+                    "The client now determines read-only status automatically."
+                )
+            self.get_client_read_only()
+
+        self.SelectImageTransferMode()
+        self.socket.setsockopt(
+            socket.IPPROTO_TCP, socket.TCP_NODELAY, self.tcp_no_delay
+        )
+
         log.info(f"Command Version: {self.commandVersion}")
         self._initialize_attributes()
         self.update_scan_size()
@@ -245,8 +255,17 @@ class Client:
 
     def set_client_read_only(self, read_only):
         self.read_only = read_only
-        command = self._addSingleCommand(self.SET_CLIENT_READ_ONLY, None, [read_only])
+        command = self._addSingleCommand(
+            self.SET_CLIENT_READ_ONLY_DEPRECATED, None, [read_only]
+        )
+        response = self._sendCommand(command)
+        return response
+
+    def get_client_read_only(self):
+        command = self._addSingleCommand(self.GET_CLIENT_READ_ONLY, None)
         response = self._sendCommand(command)
+        if response != False:
+            self.read_only = self.__getParameters(response.acknowledge[0])[0]
         return response
 
     def update_scan_size(self):
@@ -435,9 +454,11 @@ class Client:
             The name of the property to get the specifications for
         """
         if self.commandVersion < 13:
-            log.error("get_property_specifications is only supported for server version 2.7.5 and above.")
+            log.error(
+                "get_property_specifications is only supported for server version 2.7.5 and above."
+            )
             return None
-        
+
         command = self._addSingleCommand(
             self.GET_PROPERTY_SPECIFICATIONS, property_name
         )
@@ -448,9 +469,11 @@ class Client:
         values = self.__getParameters(response.acknowledge[0])
 
         if not values or len(values) == 0:
-            log.error(f"get_property_specifications({property_name}) failed, parameter size not matched.")
+            log.error(
+                f"get_property_specifications({property_name}) failed, parameter size not matched."
+            )
             return None
-        
+
         prop_spec = PropertySpecifications()
 
         param_id = 0
@@ -463,9 +486,11 @@ class Client:
         elif data_type == "Integer":
             prop_spec.prop_type = PropertyType.Integer
         else:
-            log.error(f"get_property_specifications({property_name}) failed, property type not matched.")
+            log.error(
+                f"get_property_specifications({property_name}) failed, property type not matched."
+            )
             return None
-        
+
         prop_allowable_type = values[param_id]
         param_id += 1
 
@@ -477,7 +502,9 @@ class Client:
                 prop_spec.max_value = values[param_id]
                 param_id += 1
             else:
-                log.error(f"get_property_specifications({property_name}) failed, cannot read the min/max value.")
+                log.error(
+                    f"get_property_specifications({property_name}) failed, cannot read the min/max value."
+                )
                 return None
         elif prop_allowable_type == "Set":
             prop_spec.prop_allowable_type = PropertyAllowableType.Set
@@ -485,7 +512,9 @@ class Client:
         elif prop_allowable_type == "AllowAll":
             prop_spec.prop_allowable_type = PropertyAllowableType.AllowAll
         else:
-            log.error(f"get_property_specifications({property_name}) failed, unknown allowable type.")
+            log.error(
+                f"get_property_specifications({property_name}) failed, unknown allowable type."
+            )
             return None
 
         prop_spec.category = values[-4]
@@ -1498,7 +1527,7 @@ class Client:
         command = self._addSingleCommand(self.SET_SCAN_XY_ARRAY, None, vals_to_send)
         try:
             packet = struct.pack("I", command.ByteSize()) + command.SerializeToString()
-            self.socket.send(packet)
+            self.socket.sendall(packet)
             ret = self.__ReceiveResponseForCommand(command) != False
             log.info(f"response {ret}")
         except socket.error:
@@ -1850,7 +1879,7 @@ class Client:
             command = self._addSingleCommand(self.SET_VIRTUAL_MASK, None, [id, w, h])
             ret = True
             packet = struct.pack("I", command.ByteSize()) + command.SerializeToString()
-            self.socket.send(packet)
+            self.socket.sendall(packet)
 
             if ret:
                 if mask.dtype != np.uint8:
@@ -2823,6 +2852,19 @@ class Client:
         if self.connected:
             self.disconnect()
 
+    def SelectImageTransferMode(self):
+        if not self.read_only and (
+            self.host == "localhost" or self.host == "127.0.0.1"
+        ):
+            self.tcp_no_delay = 0  # on loopback interface, nodelay causes delay
+
+            if self.usingMmf:
+                self.mmf = mmap.mmap(0, MMF_DATA_BUFFER_SIZE, "ImageFileMappingObject")
+                self.mmf[0] = True
+        else:
+            self.usingMmf = False  # Disabled MMF if connected remotely
+            self.tcp_no_delay = 1
+
     # get multiple parameters from a single acknowledge packet
     def __getParameters(self, single_acknowledge=None):
         output = []
@@ -3050,29 +3092,17 @@ class Client:
         return buffer
 
     def __sendToSocket(self, sock, buffer, bytes):
+        """Send all of *buffer*, or raise.
+
+        ``socket.send`` may accept only part of a buffer (routinely on macOS's loopback once
+        the socket has a timeout), so the return value must be honoured: dropping the rest
+        left the server waiting for bytes that never came, and every later command on the
+        connection hung. ``sendall`` loops until every byte is sent and raises
+        ``socket.timeout`` if the server stops reading for *timeout* seconds.
+        """
         timeout = self.exposureTime * 10 + 30
-        startTime = self.GetTime()
         self.socket.settimeout(timeout)
-
-        retval = True
-        chunkSize = 4096
-        for i in range(0, len(buffer), chunkSize):
-            try:
-                sock.send(buffer[i : min(len(buffer), i + chunkSize)])
-            except socket.timeout:
-
-                log.debug(f" __sendToSocket : timeout in trying to send {bytes} bytes")
-                if self.GetTime() - startTime > timeout:
-                    log.error(" __recvFromSocket: max timeout %d seconds", timeout)
-                    retval = False
-                    break
-                else:
-                    pass  # continue further
-            except socket.error as e:
-                log.error(f"Error during send: {e}")
-                # Handle the error as needed, e.g., close the connection
-                retval = False
-                break
+        sock.sendall(buffer)
         return buffer
 
     def __saveText(self, image, fileName, textSize):
@@ -3162,6 +3192,7 @@ class Client:
     height = 0
     mmf = 0
     usingMmf = True
+    tcp_no_delay = 0
     debugImagesFolder = "D:\\DebugImages\\"
     connected = False
     camera = ""
@@ -3201,7 +3232,7 @@ class Client:
     SET_SCAN_ROI = 28
     SET_SCAN_SIZE_AND_GET_CHANGED_PROPERTIES = 29
     SET_SCAN_ROI__AND_GET_CHANGED_PROPERTIES = 30
-    SET_CLIENT_READ_ONLY = 31
+    SET_CLIENT_READ_ONLY_DEPRECATED = 31
     SET_SCAN_XY_ARRAY = 32
     SET_ADAPTIVE_ROI = 33
     SET_ADAPTIVE_ROI_AND_GET_CHANGED_PROPERTIES = 34
@@ -3213,6 +3244,7 @@ class Client:
     LIST_REGISTERS = 40
     GET_VIRTUAL_IMAGE_INFO = 41
     GET_VIRTUAL_IMAGE = 42
+    GET_CLIENT_READ_ONLY = 43
 
 
 MMF_DATA_HEADER_SIZE = 24