From: Frank Mori Hess <fmhess@speakeasy.net>
Date: Sat, 1 Mar 2003 01:52:32 +0000 (+0000)
Subject: added documentation for comedi_set_calibration()
X-Git-Tag: r0_7_21~249
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=fc3cc45a16efc348557ddea51f3f926e467d5ca7;p=comedilib.git

added documentation for comedi_set_calibration()
---

diff --git a/doc/funcref b/doc/funcref
index cd4dd1e..ef440a4 100644
--- a/doc/funcref
+++ b/doc/funcref
@@ -779,10 +779,10 @@ Retval: int
 Param: comedi_t * device
 Param: unsigned int subdevice
 Description:
- The function comedi_mark_buffer_read() is used on a subdevice
+ The function comedi_get_buffer_offset() is used on a subdevice
  that has a Comedi command in progress.  This function returns
- the offset of the read pointer in the streaming buffer.  This
- offset is only useful for memory mapped buffers.
+ the offset in bytes of the read pointer in the streaming buffer.
+ This offset is only useful for memory mapped buffers.
  If there is an error, -1 is returned.
 
 Function: comedi_get_timer -- timer information (deprecated)
@@ -792,8 +792,8 @@ Param: unsigned int subdevice
 Param: double frequency
 Param: unsigned int * trigvar
 Param: double * actual_frequency
-Description:
 Status: deprecated
+Description:
  The function comedi_get_timer converts the frequency frequency
  to a number suitable to send to the driver in a comedi_trig
  structure.  This function remains for compatibility with very
@@ -812,15 +812,15 @@ Param: unsigned int aref
 Param: double frequency
 Param: unsigned int num_samples
 Param: double * data
-Description:
 Status: deprecated
+Description:
  Not documented.
 
 Function: comedi_set_global_oor_behavior -- out-of-range behavior
 Retval: int
 Param: enum comedi_oor_behavior behavior
-Description:
 Status: alpha
+Description:
  This function changes the Comedilib out-of-range behavior.
  This currently affects the behavior of comedi_to_phys() when
  converting endpoint sample values, that is, sample values
@@ -831,3 +831,23 @@ Status: alpha
 
  The previous out-of-range behavior is returned.
 
+Function: comedi_set_calibration -- set calibration
+Retval: int
+Param: comedi_t * device
+Param: unsigned int subdevice
+Param: unsigned int channel
+Param: unsigned int range
+Param: unsigned int aref
+Param: const char *file_path
+Status: alpha
+Description:
+ This function sets the calibration of the specified subdevice
+ so that it is in proper calibration when using the specified
+ channel, range and aref.  Depending on the hardware, the
+ calibration settings used may or may not depend on the channel,
+ range, or aref.  The file_path parameter can be used
+ to specify the file which contains the calibration information.
+ If file_path is NULL, then comedilib will use its the default
+ file location.  The calibration information used by this function
+ is generated by the comedi_calibrate program (see its man page).
+