Skip to content

Commit e98ff9b

Browse files
iabdalkaderiabdalkader
committed
src: OpenMV Python package
- PyPI package name: openmv - CLI command: openmv - Library for OpenMV Camera Protocol V2 - Dependencies: pyserial, numpy, pygame (optional) Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
1 parent d11899a commit e98ff9b

14 files changed

Lines changed: 2512 additions & 0 deletions

‎.gitignore‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.nox/
42+
.coverage
43+
.coverage.*
44+
.cache
45+
nosetests.xml
46+
coverage.xml
47+
*.cover
48+
*.py,cover
49+
.hypothesis/
50+
.pytest_cache/
51+
52+
# Translations
53+
*.mo
54+
*.pot
55+
56+
# Django stuff:
57+
*.log
58+
local_settings.py
59+
db.sqlite3
60+
db.sqlite3-journal
61+
62+
# Flask stuff:
63+
instance/
64+
.webassets-cache
65+
66+
# Scrapy stuff:
67+
.scrapy
68+
69+
# Sphinx documentation
70+
docs/_build/
71+
72+
# PyBuilder
73+
target/
74+
75+
# Jupyter Notebook
76+
.ipynb_checkpoints
77+
78+
# IPython
79+
profile_default/
80+
ipython_config.py
81+
82+
# pyenv
83+
.python-version
84+
85+
# pipenv
86+
Pipfile.lock
87+
88+
# PEP 582
89+
__pypackages__/
90+
91+
# Celery stuff
92+
celerybeat-schedule
93+
celerybeat.pid
94+
95+
# SageMath parsed files
96+
*.sage.py
97+
98+
# Environments
99+
.env
100+
.venv
101+
env/
102+
venv/
103+
ENV/
104+
env.bak/
105+
venv.bak/
106+
107+
# Spyder project settings
108+
.spyderproject
109+
.spyproject
110+
111+
# Rope project settings
112+
.ropeproject
113+
114+
# mkdocs documentation
115+
/site
116+
117+
# mypy
118+
.mypy_cache/
119+
.dmypy.json
120+
dmypy.json
121+
122+
# Pyre type checker
123+
.pyre/
124+
125+
# IDE
126+
.vscode/
127+
.idea/
128+
*.swp
129+
*.swo
130+
*~
131+
132+
# OS
133+
.DS_Store
134+
Thumbs.db
135+
136+
# Project specific
137+
capture.png

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 OpenMV, LLC.
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.

‎README.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# OpenMV Python
2+
3+
Python library and CLI for communicating with OpenMV cameras using Protocol V2.
4+
5+
## Installation
6+
7+
```bash
8+
pip install openmv
9+
```
10+
11+
For video streaming support (requires pygame):
12+
13+
```bash
14+
pip install openmv[gui]
15+
```
16+
17+
## CLI Usage
18+
19+
### Stream Video
20+
21+
```bash
22+
# Stream from default port (/dev/ttyACM0)
23+
openmv
24+
25+
# Stream from specific port
26+
openmv --port /dev/ttyACM1
27+
28+
# Run a custom script
29+
openmv --script my_script.py
30+
31+
# Adjust display scale
32+
openmv --scale 2
33+
```
34+
35+
### Camera Info
36+
37+
```bash
38+
openmv --info
39+
```
40+
41+
### Reset Camera
42+
43+
```bash
44+
openmv --reset
45+
```
46+
47+
### Enter Bootloader
48+
49+
```bash
50+
openmv --boot
51+
```
52+
53+
### Benchmark Mode
54+
55+
```bash
56+
openmv --bench
57+
```
58+
59+
### Controls (Stream Mode)
60+
61+
- `C` - Capture screenshot to `capture.png`
62+
- `ESC` - Exit
63+
64+
## Library Usage
65+
66+
```python
67+
from openmv import OMVCamera
68+
69+
# Connect to camera
70+
with OMVCamera('/dev/ttyACM0') as camera:
71+
# Get system info
72+
info = camera.system_info()
73+
print(f"Firmware: {info['firmware_version']}")
74+
75+
# Execute a script
76+
camera.exec('''
77+
import csi
78+
csi0 = csi.CSI()
79+
csi0.reset()
80+
''')
81+
82+
# Read frames
83+
camera.streaming(True)
84+
while True:
85+
if frame := camera.read_frame():
86+
print(f"Frame: {frame['width']}x{frame['height']}")
87+
```
88+
89+
## API Reference
90+
91+
### OMVCamera
92+
93+
Main class for camera communication.
94+
95+
```python
96+
OMVCamera(
97+
port, # Serial port (e.g., '/dev/ttyACM0')
98+
baudrate=921600, # Serial baudrate
99+
crc=True, # Enable CRC validation
100+
seq=True, # Enable sequence number validation
101+
ack=True, # Enable packet acknowledgment
102+
events=True, # Enable event notifications
103+
timeout=1.0, # Protocol timeout in seconds
104+
max_retry=3, # Maximum retries
105+
max_payload=4096, # Maximum payload size
106+
)
107+
```
108+
109+
#### Methods
110+
111+
- `connect()` / `disconnect()` - Manage connection
112+
- `exec(script)` - Execute a MicroPython script
113+
- `stop()` - Stop the running script
114+
- `reset()` - Reset the camera
115+
- `boot()` - Enter bootloader mode
116+
- `streaming(enable, raw=False, res=None)` - Enable/disable video streaming
117+
- `read_frame()` - Read a video frame
118+
- `read_stdout()` - Read script output
119+
- `read_status()` - Poll channel status
120+
- `system_info()` - Get camera system information
121+
- `channel_read(name)` / `channel_write(name, data)` - Custom channel I/O
122+
123+
### Exceptions
124+
125+
- `OMVPException` - Base protocol exception
126+
- `OMVPTimeoutException` - Timeout during communication
127+
- `OMVPChecksumException` - CRC validation failure
128+
- `OMVPSequenceException` - Sequence number mismatch
129+
130+
## Requirements
131+
132+
- Python 3.8+
133+
- pyserial
134+
- numpy
135+
- pygame (optional, for video streaming)
136+
137+
## License
138+
139+
MIT License - Copyright (c) 2025 OpenMV, LLC.

‎pyproject.toml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
[build-system]
2+
requires = ["setuptools>=61.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "openmv"
7+
version = "2.0.0"
8+
description = "OpenMV Camera Protocol V2 - Python library and CLI"
9+
readme = "README.md"
10+
license = {text = "MIT"}
11+
requires-python = ">=3.8"
12+
authors = [
13+
{name = "OpenMV, LLC", email = "info@openmv.io"}
14+
]
15+
keywords = ["openmv", "camera", "machine-vision", "embedded", "micropython"]
16+
classifiers = [
17+
"Development Status :: 4 - Beta",
18+
"Environment :: Console",
19+
"Intended Audience :: Developers",
20+
"License :: OSI Approved :: MIT License",
21+
"Operating System :: OS Independent",
22+
"Programming Language :: Python :: 3",
23+
"Programming Language :: Python :: 3.8",
24+
"Programming Language :: Python :: 3.9",
25+
"Programming Language :: Python :: 3.10",
26+
"Programming Language :: Python :: 3.11",
27+
"Programming Language :: Python :: 3.12",
28+
"Topic :: Scientific/Engineering :: Image Processing",
29+
"Topic :: Software Development :: Embedded Systems",
30+
]
31+
dependencies = [
32+
"pyserial>=3.5",
33+
"numpy>=1.20.0",
34+
"pygame>=2.0.0",
35+
"pyelftools"
36+
]
37+
38+
[project.scripts]
39+
openmv = "openmv.cli:main"
40+
41+
[project.urls]
42+
Homepage = "https://openmv.io"
43+
Documentation = "https://docs.openmv.io"
44+
Repository = "https://github.com/openmv/openmv-python"
45+
Issues = "https://github.com/openmv/openmv-python/issues"
46+
47+
[tool.setuptools.packages.find]
48+
where = ["src"]

‎src/openmv/__init__.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# SPDX-License-Identifier: MIT
2+
#
3+
# Copyright (c) 2025 OpenMV, LLC.
4+
#
5+
# OpenMV Protocol Package
6+
#
7+
# This package provides a Python implementation of the OpenMV Protocol
8+
# for communicating with OpenMV cameras.
9+
#
10+
# Main classes:
11+
# Camera: High-level camera interface with channel operations
12+
#
13+
# Main exceptions:
14+
# OMVException: Base exception for protocol errors
15+
# TimeoutException: Timeout during protocol operations
16+
# ChecksumException: CRC validation failures
17+
# SequenceException: Sequence number validation failures
18+
19+
from .camera import Camera
20+
from .exceptions import (
21+
OMVException,
22+
TimeoutException,
23+
ChecksumException,
24+
SequenceException
25+
)
26+
27+
__version__ = "2.0.0"
28+
29+
__all__ = [
30+
'Camera',
31+
'OMVException',
32+
'TimeoutException',
33+
'ChecksumException',
34+
'SequenceException'
35+
]

0 commit comments

Comments
 (0)