-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prepare for initial release #32
Merged
andy-sweet
merged 3 commits into
acquire-project:main
from
andy-sweet:prep-init-release
Sep 29, 2023
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## Unreleased | ||
|
||
### Added | ||
|
||
- Initial support for the Oryx [ORX-10GS-51S5M-C](https://www.flir.com/products/oryx-10gige/?model=ORX-10GS-51S5M-C&vertical=machine+vision&segment=iis) 10GigE camera ([#18](https://github.com/acquire-project/acquire-driver-spinnaker/pull/18)) | ||
- Initial support for the Blackfly [BFLY-U3-23S6M-C](https://www.flir.com/products/blackfly-usb3/?model=BFLY-U3-23S6M-C&vertical=machine+vision&segment=iis) USB3 camera ([#4](https://github.com/acquire-project/acquire-driver-spinnaker/pull/4)). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,79 @@ | ||
# Acquire Driver for Spinnaker | ||
# Acquire driver for Spinnaker | ||
|
||
This is an acquire driver that supports some Teledyne FLIR cameras using the Spinnaker SDK. | ||
This is an Acquire driver that supports some Teledyne FLIR cameras using the Spinnaker SDK. | ||
|
||
## Supported devices | ||
## Usage | ||
|
||
### Camera | ||
The intended way to use this library is as part of the [acquire-imaging](https://github.com/acquire-project/acquire-python) | ||
Python package, which also includes Acquire's runtime as well as other drivers. | ||
|
||
That package can be installed using the following command in an environment with Python and `pip`. | ||
|
||
``` | ||
python -m pip install acquire-imaging | ||
``` | ||
|
||
### Prerequisites | ||
|
||
Before using this driver you must install the [Spinnaker SDK](https://www.flir.com/products/spinnaker-sdk/?vertical=machine+vision&segment=iis). | ||
This driver is built against version 3.1.0.79 of the SDK and you should install exactly the same version. | ||
|
||
### Supported cameras | ||
|
||
The following cameras have been tested using this driver. | ||
|
||
- [Blackfly USB3: BFLY-U3-23S6M-C](https://www.flir.com/products/blackfly-usb3/?model=BFLY-U3-23S6M-C&vertical=machine+vision&segment=iis) | ||
- [Oryx 10GigE: ORX-10GS-51S5M-C](https://www.flir.com/products/oryx-10gige/?model=ORX-10GS-51S5M-C&vertical=machine+vision&segment=iis) | ||
- [Oryx 10GigE: ORX-10GS-51S5M-C](https://www.flir.com/products/oryx-10gige/?model=ORX-10GS-51S5M-C&vertical=machine+vision&segment=iis) | ||
|
||
### Supported operating systems | ||
|
||
Windows is the primary usage target. | ||
But both Windows and macOS are currently supported for development purposes. | ||
|
||
## Development | ||
|
||
We welcome contributors. The following will help you get started building the code. | ||
|
||
### Environment | ||
|
||
Requires | ||
|
||
- CMake 3.13+ from its [download page](https://cmake.org/download/), or via | ||
[chocolatey](https://community.chocolatey.org/packages/cmake) or [homebrew](https://formulae.brew.sh/formula/cmake). | ||
- A C++20 compiler such as [Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/) or [Clang](https://clang.llvm.org/). | ||
|
||
|
||
### Configure | ||
|
||
From the repository root, run the following commands to configure the CMake build files. | ||
|
||
``` | ||
mkdir build | ||
cd build | ||
cmake .. | ||
``` | ||
|
||
### Build | ||
|
||
After configuration, run the following command to build the library and tests. | ||
|
||
``` | ||
cmake --build . | ||
``` | ||
|
||
### Test | ||
|
||
After building the default debug configuration, run the following command to run all the tests using CTest. | ||
|
||
``` | ||
ctest -C Debug | ||
``` | ||
|
||
You will need all supported cameras connected to the device that you're testing on for all tests to pass. | ||
|
||
If you only want to run a subset of the tests you can use CTest's `-R` option to specify a pattern to match against. | ||
For example, if you only want to run the oryx tests, run the following command. | ||
|
||
``` | ||
ctest -C Debug -R oryx | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say typical rather than intended, but maybe it's just a nit.