Package HIK Robotics camera drivers and a Pythonic wrappers to the data. You still need to install the SDK to get the drivers/libraries.
This supports a subset of the platforms HIKRobotics’ supports:
Linux: glibc (not MUSL, ie not Alpine) x86_64, aarch64 and armhf (probably, only tested on aarch64)
MacOS (idk if the dynlibs from vendor are both for Apple silicon and x86_64 but at least x86_64 works)
I’ve tried to make nice wrappers that should mostly handle things cleanly but this uses ctypes and calls external libraries that are not real Python bindings (via cddl). One wrong move and everything crashes hard.
Usage
The wrappers are documented and type-hinted, enjoy. TLDR:
from typing import Optional
import time
from hikrobotcamlib Camera, DeviceList, Frame, DeviceTransport
def frame_callback(frame: Frame, cam: Camera) -> None:
"""Handle frames from camera"""
# TODO: Do something with the frame
cam: Optional[Camera] = None
for devinfo in DeviceList(DeviceTransport.GIGE | DeviceTransport.USB):
cam = Camera(devinfo)
break
if not cam:
raise RuntimeError("No camera")
cam.open()
cam.frame_callback = frame_callback
cam.trigger_enable(False)
cam.set_framerate(10.0)
cam.start()
time.sleep(2.5)
cam.stop()
cam.close()Docker
For more controlled deployments and to get rid of “works on my computer” -syndrome, we always make sure our software works under docker.
It’s also a quick way to get started with a standard development environment.
SSH agent forwarding
We need buildkit:
export DOCKER_BUILDKIT=1
And also the exact way for forwarding agent to running instance is different on OSX:
export DOCKER_SSHAGENT="-v /run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock -e SSH_AUTH_SOCK=/run/host-services/ssh-auth.sock"
and Linux:
export DOCKER_SSHAGENT="-v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK -e SSH_AUTH_SOCK"
Creating a development container
Build image, create container and start it:
docker build --ssh default --target devel_shell -t hikrobotcamlib:devel_shell . docker create --name hikrobotcamlib_devel -v `pwd`":/app" -it `echo $DOCKER_SSHAGENT` hikrobotcamlib:devel_shell docker start -i hikrobotcamlib_devel
pre-commit considerations
If working in Docker instead of native env you need to run the pre-commit checks in docker too:
docker exec -i hikrobotcamlib_devel /bin/bash -c "pre-commit install" docker exec -i hikrobotcamlib_devel /bin/bash -c "pre-commit run --all-files"
You need to have the container running, see above. Or alternatively use the docker run syntax but using the running container is faster:
docker run --rm -it -v `pwd`":/app" hikrobotcamlib:devel_shell -c "pre-commit run --all-files"
Test suite
You can use the devel shell to run py.test when doing development, for CI use the “tox” target in the Dockerfile:
docker build --ssh default --target tox -t hikrobotcamlib:tox . docker run --rm -it -v `pwd`":/app" `echo $DOCKER_SSHAGENT` hikrobotcamlib:tox
Production docker
TODO: Remove this section if this is a library and not an application
There’s a “production” target as well for running the application, remember to change that architecture tag to arm64 if building on ARM:
docker build --ssh default --target production -t hikrobotcamlib:amd64-latest . docker run --rm --network host -it --name hikrobotcamlib hikrobotcamlib:amd64-latest
Development
TODO: Remove the repo init from this document after you have done it.
TLDR:
Create and activate a Python 3.11 virtualenv (assuming virtualenvwrapper):
mkvirtualenv -p `which python3.11` my_virtualenv
change to a branch:
git checkout -b my_branch
install Poetry: https://python-poetry.org/docs/#installation
Install project deps and pre-commit hooks:
poetry install pre-commit install pre-commit run --all-files
Ready to go.
Remember to activate your virtualenv whenever working on the repo, this is needed because pylint and mypy pre-commit hooks use the “system” python for now (because reasons).
1 maintainer
Metadata
1 maintainer
Release files for hikrobotcamlib 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hikrobotcamlib-1.2.0.tar.gz | 30.2 kB | Without provenance | Details for hikrobotcamlib-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hikrobotcamlib-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for hikrobotcamlib-1.2.0-py3-none-any.whl |
Total release size: 62.8 kB
Release files / hikrobotcamlib-1.2.0.tar.gz
| Download URL | hikrobotcamlib-1.2.0.tar.gz |
|---|---|
| Size | 30.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d61097079cfd71f3de23656c417ab409fefce73304ccbb4a1a5920f7038904b0
|
|
BLAKE2b-256 checksum How to use checksums |
dc3ee217ffd9a3b7dc74607f3d86fe641a82a55fb2e4411f058ef26ad117328b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.9
|
Release files / hikrobotcamlib-1.2.0-py3-none-any.whl
| Download URL | hikrobotcamlib-1.2.0-py3-none-any.whl |
|---|---|
| Size | 32.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
87b81313583de9ded3bb4c7663f38c0422f30effbb6367f3ce26374b6acd3df0
|
|
BLAKE2b-256 checksum How to use checksums |
ad4cc91e4b12aa138b7cf2e4b3d84d05dd920b4308cea9277123826f3f8c1987
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.9
|
Security for hikrobotcamlib 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
