pyhikrobot 0.1.0__tar.gz

pyhikrobot-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+/CLAUDE.md
+.idea/
+.vscode/
+
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+.venv/
+venv/
+/.claude/

pyhikrobot-0.1.0/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project are documented here.
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-07-27
+
+First release. Enumeration, open/close, the GenICam node map, streaming with enforced buffer
+lifetime, and GigE transport tuning — all exercised against an MV-CS023-10GM. Action commands
+and the CUDA layer are not implemented yet, and the public API may still change.
+
+### Added
+
+- README with the public API, the buffer-lifetime rules and the GigE transport notes. Every
+  example is verified against a real camera; `ruff format` also parses the Python blocks, so a
+  broken snippet fails lint.
+- CI: a `package` job that builds the wheel, installs it into a clean environment and imports it
+  from `site-packages` — the check the `src/` layout exists to make possible.
+
+- Repository skeleton: `src/` layout, hatchling build, ruff/mypy/pytest configuration, CI matrix
+  (ubuntu-latest + windows-latest, unit tests only).
+- `_loader`: lazy MVS library discovery and loading across Linux and Windows, with the
+  `MVCAM_SDK_PATH` / `MVCAM_COMMON_RUNENV` / installer-default search order, the
+  architecture-directory map, `WinDLL` on Windows and `RTLD_GLOBAL` on Linux.
+- `_errors`: `HikrobotError` base with `SDKNotFoundError`, `SDKLoadError` and
+  `UnsupportedPlatformError`.
+- `_errors`: all 55 `MV_E_*` status codes of `MvErrorDefine.h` transcribed by hand, mapped onto a
+  `StatusError` hierarchy — one class per vendor range (`GeneralError`, `GenICamError`, `GigEError`,
+  `USBError`, `UpgradeError`) plus named classes for the codes callers act on. Codes are normalised
+  from the signed `int` the SDK returns, so `restype` may be `c_int` or `c_uint`.
+- `_errors`: the `check` / `call` helpers, the only sanctioned way to invoke an SDK entry point.
+  `call(..., allow=...)` covers statuses that are expected at a given call site, which keeps bare
+  `if ret != 0` out of the package.
+- `_ctypes_defs`: the structures the enumerate/open/grab path needs — `MV_CC_DEVICE_INFO` with its
+  six-member transport union, `MV_CC_DEVICE_INFO_LIST`, `MV_FRAME_OUT_INFO_EX`, `MV_FRAME_OUT` —
+  transcribed by hand from `CameraParams.h`, with the transport-layer and access-mode constants.
+- `_ctypes_defs`: `argtypes`/`restype` for the twelve entry points used so far, applied through
+  `sdk()`, which loads the library once and declares every prototype before first use.
+- `device`: `enumerate_devices()` and the `DeviceInfo` record. Each record holds its own copy of
+  the vendor structure, so it stays valid after a later enumeration has reused the SDK's own.
+- `camera`: `Camera` with `open()` / `close()`, context-manager support, `is_open`,
+  `is_connected` and the access-mode table. A failed open destroys the handle it had already
+  created; a failed close still destroys it and still forgets it.
+- `CameraStateError` for state mismatches the wrapper catches before the SDK does.
+- Tests: a fake MVS library at the CDLL boundary, so struct packing, `argtypes` and the
+  status-to-exception mapping stay under test without hardware.
+- `nodes`: `NodeMap` with typed access to integer, float, boolean, enumeration, string and
+  command nodes, plus the `IntRange` / `FloatRange` records. Enumerations go through the `Ex`
+  entry point, whose 256-entry list is not capped at 64 like the older one.
+- `frame`: `Frame` — a zero-copy, read-only NumPy view onto a driver node, with metadata
+  snapshotted so it outlives the buffer. `data` and `copy()` raise `BufferReleasedError` once the
+  node is gone; bit-packed formats raise `UnsupportedPixelFormatError` from `data` and stay
+  reachable through `raw_bytes`.
+- `camera`: `start_grabbing()` / `stop_grabbing()` / `is_grabbing`, and the `frames()` and
+  `frames_raw()` iterators. `frames()` releases each node in a `finally`; `frames_raw()` hands the
+  release to the caller. Stopping acquisition reclaims any frame still outstanding, because the
+  pool is torn down with it.
+- `BufferReleasedError` and `UnsupportedPixelFormatError`.
+- `camera`: GigE transport tuning — `packet_size`, `packet_delay`, `optimal_packet_size`,
+  `tune_packet_size()`, `enable_resend()` and the `statistics` counters (`TransportStats`).
+  `MV_CC_GetOptimalPacketSize` returns the size rather than a status and reports failure by
+  returning an `MV_E_*` code, which the wrapper unpicks.
+- `camera`: `Camera.nodes` and `Camera.handle`, plus named properties over the SFNC features -
+  `width`, `height`, `offset_x`, `offset_y`, `payload_size`, `exposure_us`, `gain_db`,
+  `frame_rate`, `pixel_format`, `pixel_formats`, and the matching range accessors.

pyhikrobot-0.1.0/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.

pyhikrobot-0.1.0/NOTICE

@@ -0,0 +1,11 @@
+pyhikrobot
+Copyright 2026 Stanislav Shalimov
+
+This product includes software developed by contributors to the
+pyhikrobot project.
+
+Hikrobot and MVS are trademarks of Hangzhou Hikrobot Co., Ltd.
+Use of these names is nominative and does not imply affiliation
+or endorsement. This software does not include or distribute any
+Hikrobot software; the MVS SDK must be obtained from the vendor
+under its own terms.

pyhikrobot-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: pyhikrobot
+Version: 0.1.0
+Summary: Thin, zero-copy Python bindings for Hikrobot machine-vision cameras (MVS SDK).
+Project-URL: Homepage, https://github.com/Shalimov04/pyhikrobot
+Project-URL: Source, https://github.com/Shalimov04/pyhikrobot
+Project-URL: Changelog, https://github.com/Shalimov04/pyhikrobot/blob/main/CHANGELOG.md
+Author: Stanislav Shalimov
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: camera,genicam,gige,hikrobot,machine-vision,mvs,numpy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+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 :: Multimedia :: Graphics :: Capture
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.20
+Provides-Extra: cuda
+Requires-Dist: cupy-cuda12x>=13; extra == 'cuda'
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyhikrobot
+
+Thin, zero-copy Python bindings for Hikrobot machine-vision cameras over the MVS SDK.
+NumPy views without the copy, a cross-platform loader, and errors you can catch.
+
+> **Status: alpha.** Enumeration, open/close, the GenICam node map, streaming and GigE
+> transport tuning are implemented and tested against real hardware. Action commands and
+> the CUDA layer are not written yet. The public API may still change.
+
+---
+
+## Requirements
+
+| | |
+|---|---|
+| Python | 3.9+ |
+| Runtime dependency | `numpy` — nothing else, ever, in the core package |
+| SDK | Hikrobot MVS 4.x, installed separately by you |
+| Platforms | Linux `x86_64` / `aarch64` / `armv7l`, Windows x64 |
+
+This package **does not ship any Hikrobot code**. It opens an SDK you installed yourself;
+get it from the vendor under their terms.
+
+## Install
+
+```bash
+pip install pyhikrobot
+```
+
+The `cuda` extra (`pip install "pyhikrobot[cuda]"`) pulls in CuPy for the device-side
+layer, which is not written yet.
+
+The SDK is found through `MVCAM_SDK_PATH`, falling back to `/opt/MVS` on Linux and the
+installer's `Common Files\MVS\Runtime` on Windows. Nothing is loaded at import time, so
+`import hikrobot` works on a machine with no SDK and no camera — a missing SDK raises
+`SDKNotFoundError` on first real use.
+
+## Quick start
+
+```python
+import hikrobot
+
+devices = hikrobot.enumerate_devices()
+for device in devices:
+    print(device.transport, device.model_name, device.serial_number, device.ip_address)
+
+with hikrobot.Camera(devices[0]) as camera:
+    camera.exposure_us = 2500.0
+    camera.gain_db = 0.0
+
+    for frame in camera.frames(timeout_ms=1000):
+        print(frame.frame_number, frame.data.shape, frame.data.mean())
+        break
+```
+
+`Camera()` touches no SDK state; the context manager opens and closes the device.
+
+## Buffer lifetime
+
+**This is the one rule that matters.** `frame.data` is a read-only NumPy view onto a node
+of the driver's buffer pool — not memory you own. The pool is fixed and recycled, so once
+the node goes back the driver writes the *next* frame into the same address.
+
+```python
+for frame in camera.frames(timeout_ms=1000):
+    total = frame.data.sum()  # fine — inside the body
+    keep = frame.copy()  # fine — owns its memory, writable
+    leaked = frame.data  # a view; its node goes back at the end of the body
+    break
+
+frame.data  # BufferReleasedError — the usual mistake, caught
+leaked.mean()  # no error, and no longer this frame's pixels
+```
+
+Note the asymmetry. Reaching for `frame.data` after the release raises, which catches the
+common mistake in development instead of in the field. An array you already took out
+cannot be caught — NumPy has no idea the memory changed hands, so it keeps working and
+quietly returns whatever the driver wrote there next. That is the failure this API is
+shaped to avoid, and `.copy()` is the only thing that avoids it.
+
+`frames()` releases the node in a `finally`, on every route out including `break`,
+`return` and exceptions. There is deliberately no "hold this one for me" shortcut: a
+`.copy()` of a 2 MB frame is visible in a profile, an accidentally retained view is not.
+
+For consumers that outlive the loop body, `frames_raw()` hands the release over:
+
+```python
+camera.start_grabbing(node_count=8)  # own acquisition, or leaving the loop stops it
+try:
+    for frame in camera.frames_raw(timeout_ms=1000):
+        queue.put(frame)  # released later, by whoever drains the queue
+finally:
+    camera.stop_grabbing()  # reclaims anything still outstanding
+```
+
+The pool holds exactly `node_count` nodes and **the SDK's default is one**, so holding a
+second frame without raising it fails with `InsufficientBufferError`.
+
+## Camera settings
+
+Named properties cover the common SFNC features:
+
+```python
+camera.width, camera.height, camera.offset_x, camera.offset_y
+camera.exposure_us, camera.gain_db, camera.frame_rate
+camera.pixel_format, camera.pixel_formats
+camera.payload_size  # read-only
+camera.exposure_range_us.min  # FloatRange(value, min, max)
+camera.nodes.int_range("Width").inc  # IntRange(value, min, max, inc)
+```
+
+Anything else goes through the node map directly:
+
+```python
+camera.nodes.set_enum("TriggerMode", "On")
+camera.nodes.set_enum("TriggerSource", "Software")
+camera.nodes.execute("TriggerSoftware")
+camera.nodes.get_int("GevTimestampTickFrequency")
+```
+
+Two behaviours worth knowing, both measured rather than assumed:
+
+- A missing node and a wrong-typed access return the **same** status, so both raise
+  `GenICamError`. When one appears, check the spelling *and* the type.
+- Float features are quantised to a hardware step the node map does not expose. Writing
+  `gain_db = 1.0` reads back as `1.0052`. Write, then read, and trust the second value.
+
+## GigE transport
+
+The knobs that decide whether streaming works at all:
+
+```python
+camera.tune_packet_size()  # probe the path, apply what it carries
+camera.enable_resend(True)  # retransmit packets the host missed
+
+camera.start_grabbing(node_count=4)
+for frame in camera.frames(timeout_ms=5000):
+    ...
+    stats = camera.statistics  # only valid while acquisition runs
+camera.stop_grabbing()
+
+stats.lost_packets, stats.lost_frames, stats.resent_packets
+```
+
+Incomplete frames almost always mean a packet size the network path cannot carry — start
+with `tune_packet_size()`. Counters live only between `start_grabbing()` and
+`stop_grabbing()` and reset on every start.
+
+## Errors
+
+Everything derives from `HikrobotError`, so you can catch one thing. Below it, one class
+per vendor error range, plus named classes for the codes callers actually branch on:
+
+```text
+HikrobotError
+├── SDKNotFoundError, SDKLoadError, UnsupportedPlatformError
+├── CameraStateError, BufferReleasedError, UnsupportedPixelFormatError
+└── StatusError                      .status  .name  .operation
+    ├── GeneralError                 InvalidHandleError, CallOrderError, NoDataError,
+    │                                IncompleteImageError, InsufficientBufferError, …
+    ├── GenICamError                 CameraTimeoutError, ValueOutOfRangeError, …
+    ├── GigEError                    AccessDeniedError, DeviceBusyError, NetworkError, …
+    ├── USBError
+    └── UpgradeError
+```
+
+An untranslated code still arrives as its range's class carrying `.status` and `.name`, so
+nothing is lost:
+
+```python
+try:
+    camera.open()
+except hikrobot.AccessDeniedError:
+    ...  # held by another process
+except hikrobot.HikrobotError as exc:
+    print(exc)  # MV_CC_OpenDevice failed: MV_E_NETER (0x80000206) - network error
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+
+pytest tests/unit              # no SDK, no camera, no CUDA — runs anywhere
+pytest tests --hardware        # opt-in; needs one reachable camera
+ruff check . && ruff format --check . && mypy
+```
+
+Unit tests run against a fake that sits at the `CDLL` boundary, so struct packing,
+`argtypes` and the status-to-exception mapping stay under test without hardware.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+Hikrobot and MVS are trademarks of Hangzhou Hikrobot Co., Ltd. This project is not
+affiliated with or endorsed by them, and distributes none of their software.