RELEASE NOTES Vision SDK Release Vision SDK 4.0.3

Transcription

1 Vision SDK Release Notes June

2 2011. Pleora Technologies Inc. All rights reserved. Information in this document is subject to change without notice. Vision, ebus, PureGEV, iport, vdisplay, and all product logos are trademarks of Pleora Technologies. All other trademarks are the property of their respective owners. 2

3 Introduction Vision SDK, Release is the latest release of Pleora Technologies legacy software development kit (SDK). These release notes pertain to the Generally Available (GA) release of the software, as of June 2011, and describe the changes since the Release General Availability (GA) version. Release notes describing earlier changes can be found in the Appendix at the end of these notes. What s New in Release 4.0.3? Release has no changes. Built for porting to the ebus SDK What s New in Release 4.0.1? Release changes include: Resolves incorrect operation of i 2 c read/write functions. Vision SDK can be installed side-by-side with ebus SDK 2.0.1, to allow developers to migrate code to use the latter SDK. Known Issues and Limitations When installing Vision on the same PC as ebus SDK 2.0.3, ensure that the versions (build numbers) are exactly the same. If versions are mismatched, Windows may not correctly install the ebus drivers. To upgrade the Vision SDK to version 4.x from any previous release, completely uninstall any previous versions of the iport Vision Suite and the ebus Driver Suite; reboot your PC; and install the SDK. Some versions of Windows XP Service Pack 2 are unstable when running Vision. Microsoft offers a Hotfix that corrects this issue. Refer to the solution at: The ebus Optimal Driver supports a maximum of 13 multicast groups NICs with the Intel or chipsets must use the ebus Universal Driver During the installation of some drivers, Windows may produce a Security Alert dialog. The following procedure permanently accepts Pleora's certificate, and ensures that the alert dialog no longer appears. When the alert dialog appears: 1. Click Pleora Technologies Inc 2. Click Install Certificate 3. Click Next 4. Select "Place all certificates in the following store" 5. In the "Certificate store" field, enter "Trusted Publishers". 6. Click Next; Finish; then click OK. When multiple identical NICs are installed in a single PC, they must use the same version of the manufacturer's NIC driver Aborting driver installations can leave the NIC in an invalid state. To recover NIC functions, reinstall the manufacturer's NIC driver 3

4 When using certain PCIe NICs, throughput from the PC to the device might be degraded. This condition can affect making changes to a device s configuration, sending commands to the device s PLC, and/or uploading firmware to the device. Certain combinations of selected NICs and ebus drivers can reduce the rate of firmware updates to IP Engines by a factor of up to 10. Although the updates have reduced rate, the update completes successfully, if uninterrupted. Updates can be performed at normal speed when using other NICs or drivers. The undesired behavior has been noticed when using PCIe NICs. To increase the reliability of new installs and upgrades, reinstall the manufacturer's NIC driver and reboot before installing new Pleora drivers An issue with the Intel ProSet software can cause a conflict in Pleora drivers. The software continually tests for drivers and attempts to reinstall them, resulting in driver contention Pleora recommends that you not install Intel ProSet, or other software that behaves likewise. Both the ebus Optimal Driver and iport High-Performance IP Device Driver do not support power management. Turn off your PC using "Shut Down", rather than "Standby" or "Hibernate". Also, Pleora recommends that you disable automatic hibernation on your PC. Due to buffer size limitations in Windows XP, the maximum image size is 64 MB minus 4 KB. Due to a DirectX driver problem in the hardware emulation layer, some combinations of DirectX and ATI video cards can produce garbled or frozen output in the image acquisition display window. This issue is most likely to occur with scaled or stretched images. Due to an issue with the Phillips SAA7115HL chip, the PT1000-ANL may return unreliable horizontal and vertical synchronization bits in some acquisition modes. In its default configuration, the Windows Firewall may block some network packets between your IP Engine and the Vision SDK (including the Coyote sample application). To configure the Windows XP Firewall, see the iport Quick Start Guide. Only one application can use the IP Engine's serial port at a time (e.g. Coyote, clser* DLLs, and applications that use serial port through the SDK). To connect with multiple programs simultaneously, use the iport High-Performance IP Device Driver. Due to an issue with Doxygen, some methods in the iport C++ SDK reference guide lack links. This issue affects only a few overloaded methods where one of the methods has been deprecated. To reach the method easily, copy/paste the method name to the Index tab. CLM-series IP Engines cannot be used with image offset, decimation, or windowing. Due to the possibility of remote code execution, some web browsers might not open CHM files from an HTML link. Virtually all web browsers refuse to open CHM files across a network drive (the contents of the CHM appear empty). The full description is available here: To open the file, copy the file to a local directory, and open the CHM using Windows Explorer. When connecting to an IP Engine for the first time, the connection might fail while Windows requests users feedback after having "found new hardware". Windows might also display a prompt that the new hardware is not properly installed (even when it is). A second connection attempt will succeed. When upgrading from previous versions, some older files and Start menu items can remain. 32-bit.NET assemblies will function correctly on a 32 bit system only. 64-bit.NET assemblies will function correctly on a 64 bit system only. 4

5 System Requirements Category Requirements Operating System Windows Operating Systems o Microsoft Windows XP (32 or 64-bit version), Service Pack 2 or higher (Service Pack 3 recommended). Refer to if utilizing Service Pack 2. o Microsoft Windows Vista (32 or 64-bit version), Service Pack 2. Hardware Network card 40 MB of space free on hard drive for SDK, documentation, and sample applications For More Information Product documentation is installed with Vision, into <install directory>\documentation (by default, c:\program Files\Pleora Technologies Inc\eBUS-Vision Package\Documentation). For more information on Vision 4.0.3, see the following documents: Quick Start Guide C++ SDK Reference Guide Additional documentation can be accessed via index.html in the documentation directory. 5

6 Appendix Information on Previous Releases Vision SDK Sample code, demonstrating streaming from a CLM device, is now included with the package. Allows EnableSystemSerialPort to use COM port 10 and higher. Resolves USRT timeout issues introduced in recent SDK versions. Ensures that the driver is enabled to begin receiving images before triggering the device. This resolves an issue where recorded images can fail to play back correctly. Performs a state check inside GetPerformanceMonitor so that it returns a dummy monitor when the device is not connected, to avoid the possibility of a crash. Vision SDK can be installed side-by-side with PureGEV SDK 1.3.3, to allow developers to migrate code to use the latter SDK. Vision SDK 3.1 The heartbeat mechanism has been improved and the reliability of the pixel converters has been enhanced. Recovery from cable disconnects has been improved. The heartbeat can now be disabled completely in devices implementing the Pleora protocol by writing 0 to the Heartbeat Expiration and Heartbeat Interval parameters The Heartbeat Enabled parameter is no longer valid. Configure the heartbeat at connection time with CyConfig type parameters, and after connection with CyDevice type parameters The heartbeat expiration time in GigE Vision devices is read back at connection time in the event that the Heartbeat Expiration parameter is set to 0 (default). When the heartbeat interval is not specified at connection time, it is automatically set to a divisor of the expiration value applied to the device Vision SDK Leaner installation packages expedite the installation process Improved ebus Driver installation process Faster device connection times through the ebus Drivers Improvements to many software components, including Coyote Vision SDK 3.0 The ebus Driver Suite and iport Vision Suite are now bundled together as the ebus-vision Package. The Pleora installer seamlessly installs both the iport Vision Suite and ebus Driver Suite, with fewer user prompts. The new Pleora installer allows you to easily install all the iport and ebus components you require, without installing unused components. An easier process for rebranding iport products as your own, using merge modules. All the tools and information are available for you to rebrand your software and documentation. The new Pleora Custom Install Reference Guide has been updated to reflect the new, easier process; the Pleora OEM Rebranding Reference Guide; the iport Deployment Reference Guide; and the ebus Deployment Reference Guide have been superseded, but are still available. The new hardware guides feature more graphics, and better organization. Signal names have been modified to be consistent across all IP Engines and to more clearly identify related signals. New design sections make it easier for you to integrate your cameras and IP Engine into a reliable design. A new overview allows you to view all iport IP Engines at a glance. 6

7 Some content in the iport Programmable Logic Controller Reference Guide has been added to the hardware guides. Overall, the documentation has been organized to reflect the new and clearer notation in the hardware guides. Revisions to the iport C++ SDK Reference Guide are now complete. Camera DLLs and CyCamera* classes are now officially obsolete. To control your camera with CyDevice::SendCommand, see CyDevice in the iport C++ SDK Reference Guide. (If you want to use existing camera DLLs, contact Pleora Support.) To upgrade to 3.0, completely uninstall any previous versions of the iport Vision Suite and the ebus Driver Suite, reboot your PC, and install the Vision Package. ebus Driver Suite 2.0 The ebus Driver Suite is now automatically installed with either the iport Vision Suite, or the iport PureGEV Suite. (Only one version of the ebus Driver Suite can be installed on your PC at one time.) The Pleora installer allows you to easily distribute the ebus Driver Suite in your own OEM package. The ebus Universal Driver uses less CPU. The ebus Optimal Driver features improved response. The revised ebus Driver Installation Tool has a new, easy-to-use interface. You can now automate driver installs by controlling the ebus Driver Installation Tool with command-line scripts. The new ebus Driver Suite SDK allows you to install the ebus Driver Suite with your own program. Methods and classes for creating your own functional driver object have been deprecated. This functionality was intended primarily for internal use. To reflect the easier installation, the content of the ebus Quick Start Guide has been rolled into both the iport Quick Start Guide and the iport PureGEV Quick Start Guide. 7