aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormorefigs <morefigs@gmail.com>2019-01-30 16:18:14 +1100
committermorefigs <morefigs@gmail.com>2019-01-30 16:18:14 +1100
commit3c5ce2bb4a9b7e308d827a48388f8482aab0d59d (patch)
tree9090700d95bfe1a2021bd4681131d5ff5fccbca3
parent4b960dc83a50690158ba6de626de88f8148883d6 (diff)
downloadpymba-3c5ce2bb4a9b7e308d827a48388f8482aab0d59d.tar.gz
pymba-3c5ce2bb4a9b7e308d827a48388f8482aab0d59d.zip
link to py2 branch
-rw-r--r--README.md36
1 files changed, 19 insertions, 17 deletions
diff --git a/README.md b/README.md
index bf5c017..38f2722 100644
--- a/README.md
+++ b/README.md
@@ -6,31 +6,33 @@ Pymba is a Python wrapper for Allied Vision's Vimba C API. It wraps the VimbaC l
### Vimba SDK
-* Download and run the Vimba SDK installer from Allied Vision from https://www.alliedvision.com/en/products/software.html.
-* Select "Custom Selection".
-* Select (at least) the following options:
- * A transport layer that matches your hardware (e.g. "Vimba USB Transport Layer" for USB cameras)
- * Core components
- * Register GenICam Path variable
- * Vimba SDK
- * Core components
- * Register environment variables
- * C API runtime components
- * C API development components
- * Driver Installer
- * Vimba Viewer
+* [Download](https://www.alliedvision.com/en/products/software.html) and launch the Vimba SDK installer:
+ * Select "Custom Selection".
+ * Select (at least) the following options:
+ * A transport layer that matches your hardware (e.g. "Vimba USB Transport Layer" for USB cameras)
+ * Core components
+ * Register GenICam Path variable
+ * Vimba SDK
+ * Core components
+ * Register environment variables
+ * C API runtime components
+ * C API development components
+ * Driver Installer
+ * Vimba Viewer
* Run `VimbaDriverInstaller.exe` and install the relevant driver.
* Test the driver installation by running `VimbaViewer.exe`.
## Installation
-Install Pymba via PIP.
+For Python 3 install Pymba via PIP.
pip install pymba
+
+For Python 2 and for backwards compatibility with older versions of Pymba use the [`python2`](https://github.com/morefigs/pymba/tree/python2) branch.
## Testing installation
-If Vimba and pymba are installed correctly, then the following code examples should give the installed Vimba version. No camera is needed.
+If Vimba and Pymba are installed correctly, then the following code should give the installed Vimba version. No camera is needed.
from pymba import Vimba
@@ -38,10 +40,10 @@ If Vimba and pymba are installed correctly, then the following code examples sho
## Usage examples
-Usage examples can be found in [examples/](examples/).
+Usage examples can be found in the [`examples`](examples/) directory.
## Known issues
-* Not all API functions are supported.
+* Not all API functions are supported, but missing functions can be added on request.
* Not all camera pixel formats are currently supported.