pyTelops 0.0.1__tar.gz → 0.2.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. pytelops-0.2.2/.gitignore +23 -0
  2. pytelops-0.2.2/AGENTS.md +79 -0
  3. pytelops-0.2.2/CONTRIBUTING.rst +134 -0
  4. pytelops-0.2.2/LICENSE +21 -0
  5. pytelops-0.2.2/PKG-INFO +76 -0
  6. pytelops-0.2.2/PYPI_README.rst +30 -0
  7. pytelops-0.2.2/README.rst +443 -0
  8. pytelops-0.2.2/docs/requirements.txt +5 -0
  9. pytelops-0.2.2/docs/rtd_postbuild.py +194 -0
  10. pytelops-0.2.2/docs/source/_static/.gitkeep +0 -0
  11. pytelops-0.2.2/docs/source/_static/ai-buttons.css +32 -0
  12. pytelops-0.2.2/docs/source/_static/ai-buttons.js +118 -0
  13. pytelops-0.2.2/docs/source/_static/logo.png +0 -0
  14. pytelops-0.2.2/docs/source/calibration.rst +101 -0
  15. pytelops-0.2.2/docs/source/camera.rst +41 -0
  16. pytelops-0.2.2/docs/source/changelog.rst +87 -0
  17. pytelops-0.2.2/docs/source/conf.py +71 -0
  18. pytelops-0.2.2/docs/source/examples.rst +49 -0
  19. pytelops-0.2.2/docs/source/getting_started.rst +64 -0
  20. pytelops-0.2.2/docs/source/index.rst +42 -0
  21. pytelops-0.2.2/docs/source/streaming_and_buffer.rst +237 -0
  22. pytelops-0.2.2/docs/source/troubleshooting.rst +244 -0
  23. pytelops-0.2.2/examples/01_connect_and_grab.py +29 -0
  24. pytelops-0.2.2/examples/02_continuous_live.py +34 -0
  25. pytelops-0.2.2/examples/03_buffer_record.py +37 -0
  26. pytelops-0.2.2/examples/04_calibration_load.py +30 -0
  27. pytelops-0.2.2/examples/05_external_trigger.py +43 -0
  28. pytelops-0.2.2/examples/06_force_ip.py +50 -0
  29. pytelops-0.2.2/examples/07_robust_download.py +57 -0
  30. pytelops-0.2.2/examples/README.rst +17 -0
  31. pytelops-0.2.2/pyTelops/__init__.py +72 -0
  32. pytelops-0.2.2/pyTelops/camera.py +4342 -0
  33. pytelops-0.2.2/pyTelops/cli.py +214 -0
  34. pytelops-0.2.2/pyTelops/connection.py +323 -0
  35. pytelops-0.2.2/pyTelops/errors.py +40 -0
  36. pytelops-0.2.2/pyTelops/gui.py +333 -0
  37. pytelops-0.2.2/pyTelops/provisioning.py +31 -0
  38. pytelops-0.2.2/pyTelops/py.typed +0 -0
  39. pytelops-0.2.2/pyTelops/registers.py +513 -0
  40. pytelops-0.2.2/pyproject.toml +98 -0
  41. pytelops-0.2.2/requirements.dev.txt +12 -0
  42. pytelops-0.2.2/requirements.txt +3 -0
  43. pytelops-0.2.2/sync_version.py +62 -0
  44. pytelops-0.2.2/tests/conftest.py +25 -0
  45. pytelops-0.2.2/tests/test_camera.py +749 -0
  46. pytelops-0.2.2/tests/test_cli.py +62 -0
  47. pytelops-0.2.2/tests/test_connection.py +152 -0
  48. pytelops-0.2.2/tests/test_discovery_reachability.py +100 -0
  49. pytelops-0.2.2/tests/test_download_integrity.py +504 -0
  50. pytelops-0.2.2/tests/test_enum_resolution.py +449 -0
  51. pytelops-0.2.2/tests/test_hardware.py +620 -0
  52. pytelops-0.2.2/tests/test_registers.py +63 -0
  53. pytelops-0.0.1/PKG-INFO +0 -7
  54. pytelops-0.0.1/pyTelops/__init__.py +0 -2
  55. pytelops-0.0.1/pyproject.toml +0 -13
@@ -0,0 +1,23 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *$py.class
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+ *.egg
8
+ .eggs/
9
+ *.so
10
+ .tox/
11
+ .venv/
12
+ venv/
13
+ env/
14
+ .pytest_cache/
15
+ .mypy_cache/
16
+ .coverage
17
+ htmlcov/
18
+ *.whl
19
+ *.npy
20
+ *.jpg
21
+
22
+ # Sphinx build output
23
+ docs/build/
@@ -0,0 +1,79 @@
1
+ # pyTelops for agents
2
+
3
+ pyTelops is a pure-Python driver for Telops thermal cameras over GigE Vision
4
+ (no vendor SDK). It speaks GVCP and GVSP directly over UDP on top of
5
+ [pyGigEVision](https://github.com/ladisk/pyGigEVision).
6
+
7
+ This file is for coding agents. For the full human guide see
8
+ [CONTRIBUTING.rst](CONTRIBUTING.rst); the commands here mirror it.
9
+
10
+ ## Documentation
11
+
12
+ Published at https://pytelops.readthedocs.io/en/latest/
13
+
14
+ Start at https://pytelops.readthedocs.io/en/latest/llms.txt for the page index,
15
+ or fetch https://pytelops.readthedocs.io/en/latest/llms-full.txt for the whole
16
+ corpus in one request. Every page is also available as Markdown by replacing
17
+ the `.html` extension with `.md`.
18
+
19
+ | Doing | Read |
20
+ |---|---|
21
+ | Connecting and grabbing a frame | getting_started.md |
22
+ | Full API surface | camera.md |
23
+ | Calibration modes (RT / NUC / RAW), loading calibrations | calibration.md |
24
+ | Live streaming and onboard-buffer recording | streaming_and_buffer.md |
25
+ | Runnable scripts | examples.md |
26
+ | Discovery / network / firewall problems | troubleshooting.md |
27
+ | Re-homing a camera onto the right subnet by MAC (`force_ip`) | camera.md |
28
+ | Tuning the link and download config (`tune_connection`) | camera.md |
29
+ | Handling incomplete buffer downloads (`FrameIntegrityError`) | streaming_and_buffer.md |
30
+
31
+ ## Setup
32
+
33
+ ```bash
34
+ pip install -e ".[dev,gui]"
35
+ ```
36
+
37
+ This pulls the dev tools (pytest, ruff, sphinx) and the optional GUI extras.
38
+ The pyGigEVision dependency installs from PyPI like any other package.
39
+
40
+ ## Test, lint, format
41
+
42
+ ```bash
43
+ pytest # unit tests; hardware tests auto-skip
44
+ ruff check pyTelops tests
45
+ ruff format --check pyTelops tests
46
+ ```
47
+
48
+ Hardware tests are gated behind a flag and need a connected Telops camera:
49
+
50
+ ```bash
51
+ pytest tests/test_hardware.py --hardware
52
+ ```
53
+
54
+ Stop any VPN that holds a link-local adapter before running
55
+ hardware tests, or camera discovery fails. See troubleshooting.md.
56
+
57
+ ## Conventions
58
+
59
+ - Line length 100, enforced by `ruff format` (double quotes).
60
+ - `from __future__ import annotations` at the top of each module; modern type
61
+ hints (`str | None`, `list[dict]`).
62
+ - f-strings, not `.format()`. No bare `except:`.
63
+ - NumPy-style docstrings on every public symbol.
64
+ - No em dashes in user-facing docs, docstrings, or changelogs.
65
+ - Add a line to `docs/source/changelog.rst` under the next version for any
66
+ user-visible change.
67
+ - Branch off `master`; open pull requests against `master`.
68
+
69
+ ## Project layout
70
+
71
+ ```
72
+ pyTelops/ driver package: camera.py, registers.py, cli.py, gui.py
73
+ tests/ pytest suite (test_hardware.py is camera-gated)
74
+ examples/ runnable scripts (01_connect_and_grab.py ... 07_robust_download.py)
75
+ docs/source/ Sphinx docs (RST source)
76
+ ```
77
+
78
+ The `pytelops` console command is the CLI entry point (`pyTelops.cli:main`).
79
+ Requires Python 3.10 or newer.
@@ -0,0 +1,134 @@
1
+ Contributing to pyTelops
2
+ ========================
3
+
4
+ Thanks for your interest in contributing. This guide covers the development
5
+ workflow.
6
+
7
+ Architecture
8
+ ------------
9
+
10
+ pyTelops is the vendor layer on top of `pyGigEVision
11
+ <https://github.com/ladisk/pyGigEVision>`_, which implements the GigE Vision
12
+ protocol (GVCP control, GVSP streaming, GenICam XML). pyTelops adds only the
13
+ Telops-specific parts:
14
+
15
+ - ``camera.py`` - the ``Camera`` class: properties, context manager,
16
+ auto-discovery and connect, RT-mode Celsius conversion, and 16 GB onboard
17
+ buffer recording with integrity-checked download.
18
+ - ``registers.py`` - Telops register addresses and enums.
19
+ - ``connection.py`` - ``tune_connection`` / ``ConnectionReport`` (link probing
20
+ and download tuning).
21
+ - ``errors.py`` - ``DownloadStats`` and ``FrameIntegrityError``.
22
+ - ``provisioning.py`` - ``force_ip`` (assign a camera IP by MAC).
23
+ - ``cli.py`` / ``gui.py`` - command-line tools and the Tkinter live viewer.
24
+
25
+ Control runs over GVCP (UDP 3956, request/response with a heartbeat); frames
26
+ arrive over GVSP (the camera pushes Leader / Data / Trailer packets that are
27
+ reassembled into numpy arrays). Both are provided by pyGigEVision.
28
+
29
+ Development setup
30
+ -----------------
31
+
32
+ 1. Fork and clone:
33
+
34
+ .. code-block:: bash
35
+
36
+ git clone https://github.com/<your-username>/pyTelops.git
37
+ cd pyTelops
38
+
39
+ 2. Install in editable mode with dev (and GUI) extras:
40
+
41
+ .. code-block:: bash
42
+
43
+ pip install -e ".[dev,gui]"
44
+
45
+ This pulls in pytest, sphinx, ruff, and the rest of the dev tools.
46
+
47
+ Note: pyTelops depends on `pyGigEVision
48
+ <https://github.com/ladisk/pyGigEVision>`_. While that package is
49
+ pre-release the dependency resolves over SSH from GitHub; once it is on
50
+ PyPI the pin becomes a normal version.
51
+
52
+ 3. Create a feature branch off ``master``:
53
+
54
+ .. code-block:: bash
55
+
56
+ git checkout -b feature/my-change
57
+
58
+ Making a change
59
+ ---------------
60
+
61
+ 1. Make your change.
62
+ 2. Add or update tests in ``tests/``. Hardware-only tests use the
63
+ ``@pytest.mark.hardware`` marker and run with ``pytest --hardware``.
64
+ 3. Add or update NumPy-style docstrings on every public symbol you touch.
65
+ 4. Run the local checks:
66
+
67
+ .. code-block:: bash
68
+
69
+ pytest
70
+ ruff check pyTelops tests
71
+ ruff format --check pyTelops tests
72
+
73
+ 5. Add a line to ``docs/source/changelog.rst`` under the next version.
74
+ 6. Push to your fork and open a pull request against ``master``.
75
+
76
+ Running hardware tests
77
+ ----------------------
78
+
79
+ The 57 hardware tests need a connected Telops camera:
80
+
81
+ .. code-block:: bash
82
+
83
+ pytest tests/test_hardware.py --hardware
84
+
85
+ Stop any VPN that owns a link-local adapter first, or
86
+ discovery will fail. See the troubleshooting guide.
87
+
88
+ Code style
89
+ ----------
90
+
91
+ * Line length 100, enforced by ``ruff format``.
92
+ * Modern type hints (``str | None``, ``list[dict]``) with
93
+ ``from __future__ import annotations`` at the top of each module.
94
+ * f-strings, not ``.format()``. No bare ``except:``.
95
+
96
+ Documentation
97
+ -------------
98
+
99
+ Built with Sphinx, hosted on ReadTheDocs.
100
+
101
+ .. code-block:: bash
102
+
103
+ pip install -r docs/requirements.txt
104
+ sphinx-build -b html docs/source docs/build/html
105
+
106
+ Setting up ReadTheDocs (one-time, maintainers)
107
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108
+
109
+ 1. Sign in to https://readthedocs.org with the maintainer GitHub account.
110
+ 2. Import ``ladisk/pyTelops``.
111
+ 3. Set the slug to ``pytelops``.
112
+ 4. Trigger the first build.
113
+
114
+ Releasing (maintainers)
115
+ -----------------------
116
+
117
+ 1. Make sure ``master`` is green.
118
+ 2. Update ``docs/source/changelog.rst``.
119
+ 3. Tag and push:
120
+
121
+ .. code-block:: bash
122
+
123
+ git tag vX.Y.Z
124
+ git push origin vX.Y.Z
125
+
126
+ 4. The ``release-and-publish-to-pypi.yml`` workflow syncs the version into
127
+ ``pyproject.toml``, ``pyTelops/__init__.py``, and ``docs/source/conf.py``,
128
+ builds, publishes to PyPI using the ``PYPI_API_TOKEN`` secret, and creates
129
+ a GitHub Release.
130
+
131
+ License
132
+ -------
133
+
134
+ By contributing you agree your contribution is licensed under the MIT License.
pytelops-0.2.2/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jaša Šonc, University of Ljubljana
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,76 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyTelops
3
+ Version: 0.2.2
4
+ Summary: Pure-Python driver for Telops thermal cameras over GigE Vision
5
+ Project-URL: Homepage, https://github.com/ladisk/pyTelops
6
+ Project-URL: Documentation, https://pytelops.readthedocs.io
7
+ Project-URL: Repository, https://github.com/ladisk/pyTelops
8
+ Project-URL: Issues, https://github.com/ladisk/pyTelops/issues
9
+ Author-email: Jaša Šonc <jasa.sonc@fs.uni-lj.si>, Janko Slavič <janko.slavic@fs.uni-lj.si>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Keywords: MWIR,camera,gige,infrared,telops,thermal,vision
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Scientific/Engineering
24
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
25
+ Classifier: Topic :: System :: Hardware :: Hardware Drivers
26
+ Requires-Python: >=3.10
27
+ Requires-Dist: numpy>=1.20
28
+ Requires-Dist: pygigevision>=0.2.1
29
+ Requires-Dist: tqdm
30
+ Provides-Extra: dev
31
+ Requires-Dist: build; extra == 'dev'
32
+ Requires-Dist: pytest; extra == 'dev'
33
+ Requires-Dist: pytest-cov; extra == 'dev'
34
+ Requires-Dist: ruff; extra == 'dev'
35
+ Requires-Dist: sphinx; extra == 'dev'
36
+ Requires-Dist: sphinx-book-theme; extra == 'dev'
37
+ Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
38
+ Requires-Dist: sphinx-llms-txt; extra == 'dev'
39
+ Requires-Dist: sphinx-markdown-builder; extra == 'dev'
40
+ Requires-Dist: twine; extra == 'dev'
41
+ Requires-Dist: wheel; extra == 'dev'
42
+ Provides-Extra: gui
43
+ Requires-Dist: matplotlib; extra == 'gui'
44
+ Requires-Dist: pillow; extra == 'gui'
45
+ Description-Content-Type: text/x-rst
46
+
47
+ pyTelops
48
+ ========
49
+
50
+ Pure-Python driver for Telops thermal cameras over GigE Vision. No vendor SDK
51
+ required: pyTelops speaks the GVCP and GVSP protocols directly over UDP.
52
+
53
+ It builds on `pyGigEVision <https://github.com/ladisk/pyGigEVision>`_ for the
54
+ GigE Vision protocol layer and adds the Telops-specific calibration, registers,
55
+ and onboard-buffer support.
56
+
57
+ * GitHub: https://github.com/ladisk/pyTelops
58
+ * Documentation: https://pytelops.readthedocs.io
59
+
60
+ Installation
61
+ ------------
62
+
63
+ .. code-block:: bash
64
+
65
+ pip install pyTelops
66
+
67
+ For the Tkinter live viewer:
68
+
69
+ .. code-block:: bash
70
+
71
+ pip install pyTelops[gui]
72
+
73
+ License: MIT.
74
+
75
+ pyTelops is an independent project, not affiliated with or endorsed by
76
+ Telops Inc. "Telops", "FAST", and "Reveal IR" are trademarks of Telops Inc.
@@ -0,0 +1,30 @@
1
+ pyTelops
2
+ ========
3
+
4
+ Pure-Python driver for Telops thermal cameras over GigE Vision. No vendor SDK
5
+ required: pyTelops speaks the GVCP and GVSP protocols directly over UDP.
6
+
7
+ It builds on `pyGigEVision <https://github.com/ladisk/pyGigEVision>`_ for the
8
+ GigE Vision protocol layer and adds the Telops-specific calibration, registers,
9
+ and onboard-buffer support.
10
+
11
+ * GitHub: https://github.com/ladisk/pyTelops
12
+ * Documentation: https://pytelops.readthedocs.io
13
+
14
+ Installation
15
+ ------------
16
+
17
+ .. code-block:: bash
18
+
19
+ pip install pyTelops
20
+
21
+ For the Tkinter live viewer:
22
+
23
+ .. code-block:: bash
24
+
25
+ pip install pyTelops[gui]
26
+
27
+ License: MIT.
28
+
29
+ pyTelops is an independent project, not affiliated with or endorsed by
30
+ Telops Inc. "Telops", "FAST", and "Reveal IR" are trademarks of Telops Inc.