lin-epics-modules/ADAndor
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documented PSByteRate and maxPvAPIFrames

Browse Source 
git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@13374 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
This commit is contained in:
rivers
2011-08-08 16:03:47 +00:00
parent 6cb236d57a
commit 3250c423f2
1 changed files with 53 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/prosilicaDoc.html
+53 -22
View File
@@ -31,10 +31,10 @@
<p>
This is a driver for Gigabit Ethernet and Firewire cameras from <a href="http://www.prosilica.com">
Prosilica</a>. The driver is only supported under Windows (EPICS win32-x86 architecture),
Linux and Mac OS X because the vendor library is provided as a pre-built binary for
those operating systems only. The vendor library provided by Prosilica does callbacks
to a user-supplied function each time there is a new frame. Thus, the driver does
not need to create a thread itself for callbacks."
Linux and Mac OS X because the vendor library is provided as a pre-built binary
for those operating systems only. The vendor library provided by Prosilica does
callbacks to a user-supplied function each time there is a new frame. Thus, the
driver does not need to create a thread itself for callbacks."
</p>
<p>
This driver inherits from <a href="areaDetectorDoc.html#ADDriver">ADDriver</a>.
@@ -525,6 +525,27 @@
<td>
ai</td>
</tr>
<tr>
<td>
PSByteRate</td>
<td>
asynInt32</td>
<td>
r/w</td>
<td>
Stream bytes per second in the PvAPI driver. This allows limiting the bandwidth
that a camera uses. It also allows operation of GigE cameras on non-Gigabit Ethernet
networks by decreasing the value to maximum that the network supports. The default
of 115000000 allows full-speed operation on GigE networks.</td>
<td>
PS_BYTE_RATE</td>
<td>
$(P)$(R)PSByteRate<br />
$(P)$(R)PSByteRate_RBV</td>
<td>
longout<br />
longin</td>
</tr>
<tr>
<td>
PSStatFramesCompleted</td>
@@ -663,27 +684,37 @@
<pre>int prosilicaConfig(char *portName,
const char* cameraId,
int maxBuffers, size_t maxMemory,
int priority, int stackSize)
int priority, int stackSize, int maxPvAPIFrames)
</pre>
<p>
The <b>cameraId</b> string can be any of the following:</p>
<ul>
<li>The camera's UniqueId, which is a number assigned by the vendor to each Prosilica camera, e.g. 50110.</li>
<li>The camera's IP address, e.g. 164.54.160.48.</li>
<li>The camera's IP DNS name, e.g. gse-prosilica1.cars.aps.anl.gov.</li>
</ul>
<p>Using the UniqueId has the advantage that the cameras can be configured to use DHCP,
and hence have non-predictable TCP/IP addresses. However, if the UniqueId is used then the areaDetector
IOC must be on the same subnet as the camera, since cameras cannot be found by UniqueID
through routers. The simplest way to determine the uniqueId of a camera is to run
the Prosilica GigEViewer application, select the camera, and press the "i" icon
on the bottom of the main window to show the camera information for this camera.
The Unique ID will be displayed on the first line in the information window.</p>
<p>The IP address or IP DNS name
can be used for cameras with fixed IP addresses, and <b>must</b> be used for cameras that are not
on the local subnet.</p>
<p>For details on the meaning of the other parameters to this function refer to the detailed
documentation on the prosilicaConfig function in the <a href="areaDetectorDoxygenHTML/prosilica_8cpp.html">
<ul>
<li>The camera's UniqueId, which is a number assigned by the vendor to each Prosilica
camera, e.g. 50110.</li>
<li>The camera's IP address, e.g. 164.54.160.48.</li>
<li>The camera's IP DNS name, e.g. gse-prosilica1.cars.aps.anl.gov.</li>
</ul>
<p>
Using the UniqueId has the advantage that the cameras can be configured to use DHCP,
and hence have non-predictable TCP/IP addresses. However, if the UniqueId is used
then the areaDetector IOC must be on the same subnet as the camera, since cameras
cannot be found by UniqueID through routers. The simplest way to determine the uniqueId
of a camera is to run the Prosilica GigEViewer application, select the camera, and
press the "i" icon on the bottom of the main window to show the camera information
for this camera. The Unique ID will be displayed on the first line in the information
window.</p>
<p>
The IP address or IP DNS name can be used for cameras with fixed IP addresses, and
<b>must</b> be used for cameras that are not on the local subnet.</p>
<p>
The maxPvAPIFrames parameter controls how many frame buffers will be used by the
PvAPI library. This is the last parameter in the prosilicaConfig command, and if
it is absent the default value of 2 is used, which is sufficient in most circumstances.
However, with very high frame rates or busy IOCs increasing this value can reduce
dropped frames.</p>
<p>
For details on the meaning of the other parameters to this function refer to the
detailed documentation on the prosilicaConfig function in the <a href="areaDetectorDoxygenHTML/prosilica_8cpp.html">
prosilica.cpp documentation</a> and in the documentation for the constructor for
the <a href="areaDetectorDoxygenHTML/classprosilica.html">prosilica class</a>.
</p>