# AravisCameras Device (C++)
## Overview
The AravisCamera class provides an interface to GigE Vision and USB3
Vision cameras in the Karabo framework environment. It enables users to
configure the camera settings, acquire images, and dynamically update the
settings during runtime. This class simplifies the interaction with the camera
and streamlines the process making it easier to integrate the camera into
various applications.
## Contact
For questions, please contact opensource@xfel.eu.
## License and Contributing
This software is released by the European XFEL GmbH as is and without any
warranty under the GPLv3 license.
If you have questions on contributing to the project, please get in touch at
opensource@xfel.eu.
External contributors, i.e. anyone not contractually associated to
the European XFEL GmbH, are asked to sign a Contributor License
Agreement (CLA):
- people contributing as individuals should sign the Individual CLA
- people contributing on behalf of an organization should sign
the Entity CLA.
The CLAs can be found in the `contributor_license_agreement.md` and
`entity_contributor_license_agreement.md` documents located in
the root folder of this repository.
Please send signed CLAs to opensource [at] xfel.eu. We'll get in
touch with you then.
We ask for your understanding that we cannot accept external
contributions without a CLA in place. Importantly, with signing the CLA
you acknowledge that
- European XFEL retains all copyrights of the Karabo Aravis Cameras,
- European XFEL may relicense the Karabo Aravis Cameras under other
appropriate open source licenses which the Free Software Foundation
classifies as Free Software licenses.
However, you are welcome to already
suggest modifications you'd like to contribute by opening a merge/pull
request before you send the CLA.
## Source Code
The sources for this project can be found at
https://github.com/European-XFEL/Karabo-aravisCameras
## Dependencies
- aravis (https://github.com/AravisProject/aravis)
- meson (https://pypi.org/project/meson/)
- ninja (https://pypi.org/project/ninja/)
- imageSource (https://git.xfel.eu/karaboDevices/imageSource or
https://github.com/European-XFEL/imageSource)
- opencv (https://opencv.org/)
## Host Setup
In order to enable users to access a USB3V camera, a file
``/etc/udev/rules.d/69-basler-cameras.rules`` must be added with the following
content
```
# Enable user access to all basler cameras
SUBSYSTEM=="usb", ATTRS{idVendor}=="2676", MODE:="0666", TAG+="uaccess", TAG+="udev-acl"
```
## Installing and Running from PyPI
The device can further be installed from PyPI and ships in the form of
a self-hosting device server. To install, run
```
pip install karabo-aravis-cameras
```
To run, make sure you have activated a Karabo environment using
```
source PATH/TO/KARABO/activate
```
and then start the self-hosting server with
```
karabo-aravis-cameras-server [serverId=, ... karabo-cpp-server options]
```
You can directly start a device connected to a network camera using e.g.
```
karabo-aravis-cameras-server \
serverId=MyServer
init='{"MyCamera": {"classId": "AravisBaslerCamera", "cameraId": "192.168.0.1"}}'
```
## Compiling in a self-contained Karabo Environment
1. Source activate the Karabo installation against which the device will be
developed:
```
cd <Karabo installation root directory>
source ./activate
```
2. Go to the device source root directory and generate its build files with
cmake:
```
cd $KARABO/devices/aravisCameras
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_PREFIX_PATH=$KARABO/extern ..
```
``CMAKE_BUILD_TYPE`` can also be set to "Release".
3. Build the device:
```
cd $KARABO/devices/aravisCameras
cmake --build .
```
``make`` can also be used as long as the Makefile generator is used by
cmake.
## Testing
After a successfull build, a shared library is generated here:
``dist/<configuration>/<system>/libaravisCameras.so``
And a soft-link to the ``libaravisCameras.so`` file is created in the
``$KARABO/plugins`` folder.
To run the tests, go to the tests directory in your build tree and use
``ctest``:
```
cd $KARABO/devices/aravisCameras/build/aravisCameras
ctest -VV
```
## Running
If you want to manually start a server using this device, simply type:
```
karabo-cppserver serverId=cppServer/1 deviceClasses=AravisCameras
```
Or just use (a properly configured):
```
karabo-start
```
Raw data
{
"_id": null,
"home_page": null,
"name": "karabo-aravis-cameras",
"maintainer": null,
"docs_url": null,
"requires_python": "==3.12.*",
"maintainer_email": "\"A. Parenti\" <andrea.parenti@xfel.eu>",
"keywords": "Karabo, SCADA, camera, control system, aravis",
"author": null,
"author_email": "European XFEL GmbH <opensource@xfel.eu>",
"download_url": null,
"platform": null,
"description": "# AravisCameras Device (C++)\n\n\n\n\n\n\n\n\n\n\n\n## Overview\n\nThe AravisCamera class provides an interface to GigE Vision and USB3\nVision cameras in the Karabo framework environment. It enables users to\nconfigure the camera settings, acquire images, and dynamically update the\nsettings during runtime. This class simplifies the interaction with the camera\nand streamlines the process making it easier to integrate the camera into\nvarious applications.\n\n## Contact\n\nFor questions, please contact opensource@xfel.eu.\n\n## License and Contributing\n\nThis software is released by the European XFEL GmbH as is and without any\nwarranty under the GPLv3 license.\nIf you have questions on contributing to the project, please get in touch at\nopensource@xfel.eu.\n\nExternal contributors, i.e. anyone not contractually associated to\nthe European XFEL GmbH, are asked to sign a Contributor License\nAgreement (CLA):\n\n- people contributing as individuals should sign the Individual CLA\n- people contributing on behalf of an organization should sign\n the Entity CLA.\n\nThe CLAs can be found in the `contributor_license_agreement.md` and\n`entity_contributor_license_agreement.md` documents located in\nthe root folder of this repository.\nPlease send signed CLAs to opensource [at] xfel.eu. We'll get in\ntouch with you then.\nWe ask for your understanding that we cannot accept external\ncontributions without a CLA in place. Importantly, with signing the CLA\nyou acknowledge that\n\n- European XFEL retains all copyrights of the Karabo Aravis Cameras,\n- European XFEL may relicense the Karabo Aravis Cameras under other\n appropriate open source licenses which the Free Software Foundation\n classifies as Free Software licenses.\n\nHowever, you are welcome to already\nsuggest modifications you'd like to contribute by opening a merge/pull\nrequest before you send the CLA.\n\n## Source Code\n\nThe sources for this project can be found at \nhttps://github.com/European-XFEL/Karabo-aravisCameras\n\n## Dependencies\n\n- aravis (https://github.com/AravisProject/aravis)\n\n - meson (https://pypi.org/project/meson/)\n - ninja (https://pypi.org/project/ninja/)\n\n- imageSource (https://git.xfel.eu/karaboDevices/imageSource or\n https://github.com/European-XFEL/imageSource)\n\n - opencv (https://opencv.org/)\n\n## Host Setup\n\nIn order to enable users to access a USB3V camera, a file\n``/etc/udev/rules.d/69-basler-cameras.rules`` must be added with the following\ncontent\n\n```\n# Enable user access to all basler cameras\nSUBSYSTEM==\"usb\", ATTRS{idVendor}==\"2676\", MODE:=\"0666\", TAG+=\"uaccess\", TAG+=\"udev-acl\"\n```\n\n## Installing and Running from PyPI\n\nThe device can further be installed from PyPI and ships in the form of \na self-hosting device server. To install, run\n\n```\npip install karabo-aravis-cameras\n```\n\nTo run, make sure you have activated a Karabo environment using\n\n```\nsource PATH/TO/KARABO/activate\n```\n\nand then start the self-hosting server with\n\n```\nkarabo-aravis-cameras-server [serverId=, ... karabo-cpp-server options]\n```\n\nYou can directly start a device connected to a network camera using e.g.\n\n```\nkarabo-aravis-cameras-server \\\n serverId=MyServer \n init='{\"MyCamera\": {\"classId\": \"AravisBaslerCamera\", \"cameraId\": \"192.168.0.1\"}}'\n```\n\n\n## Compiling in a self-contained Karabo Environment\n\n1. Source activate the Karabo installation against which the device will be\n developed:\n\n ```\n cd <Karabo installation root directory>\n source ./activate\n ```\n\n2. Go to the device source root directory and generate its build files with\n cmake:\n\n ```\n cd $KARABO/devices/aravisCameras\n mkdir build\n cd build\n cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_PREFIX_PATH=$KARABO/extern ..\n ```\n\n ``CMAKE_BUILD_TYPE`` can also be set to \"Release\".\n\n3. Build the device:\n\n ```\n cd $KARABO/devices/aravisCameras\n cmake --build .\n ```\n\n ``make`` can also be used as long as the Makefile generator is used by\n cmake.\n\n## Testing\n\nAfter a successfull build, a shared library is generated here:\n\n``dist/<configuration>/<system>/libaravisCameras.so``\n\nAnd a soft-link to the ``libaravisCameras.so`` file is created in the\n``$KARABO/plugins`` folder.\n\nTo run the tests, go to the tests directory in your build tree and use\n``ctest``:\n\n```\ncd $KARABO/devices/aravisCameras/build/aravisCameras\nctest -VV\n```\n\n## Running\n\nIf you want to manually start a server using this device, simply type:\n\n```\nkarabo-cppserver serverId=cppServer/1 deviceClasses=AravisCameras\n```\n\nOr just use (a properly configured):\n\n```\nkarabo-start\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Karabo device to control and acquire data from Aravis compatible cameras.",
"version": "3.0.5",
"project_urls": {
"Bug Reports": "https://github.com/European-XFEL/Karabo-aravisCameras/issues",
"Homepage": "https://github.com/European-XFEL/Karabo-aravisCameras",
"Source": "https://github.com/European-XFEL/Karabo-aravisCameras"
},
"split_keywords": [
"karabo",
" scada",
" camera",
" control system",
" aravis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0343d26f4121a092caa4152f0c1f1d6903c8f77aca68f746d3571f5605449947",
"md5": "61fec1498eb1de1056f0339bb095f602",
"sha256": "bf0750b669880ac9000e9975cb833dff33a1e552c401db47d6385c5742854d49"
},
"downloads": -1,
"filename": "karabo_aravis_cameras-3.0.5-cp312-cp312-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "61fec1498eb1de1056f0339bb095f602",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": "==3.12.*",
"size": 31029550,
"upload_time": "2025-10-07T08:24:53",
"upload_time_iso_8601": "2025-10-07T08:24:53.145429Z",
"url": "https://files.pythonhosted.org/packages/03/43/d26f4121a092caa4152f0c1f1d6903c8f77aca68f746d3571f5605449947/karabo_aravis_cameras-3.0.5-cp312-cp312-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 08:24:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "European-XFEL",
"github_project": "Karabo-aravisCameras",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "karabo-aravis-cameras"
}
JSON
