Recent changes to Device class

Device class modified by Miso kopera

Miso kopera — Tue, 04 Jun 2013 19:54:20 -0000

--- v11
+++ v12
@@ -92,7 +92,7 @@
 Method starts periodical mode in device. Device will continualy with *timer* period measures voltage based on *channels* parameter. Measurement starts immediately after this function is called. Measured values are returned by *get_sample* function. *TimerError* is raised if *timer* is too sort.

 *channels*
-Must be a iterable object that contains tuples with channel id and gain for each channel where measurement will be performed. E.g. if it is list like [(*CHANNEL_0*, *GAIN_1*), (*CHANNEL_5*, *GAIN_39*), (*CHANNEL_7*, *GAIN_17*)]. Then measured will be (and *get_sample* returns voltage) from *CHANNEL_0* with *GAIN_1*. After the *timer* ms *CHANNEL_5* with *GAIN_39* will be measured and after another *timer* ms *CHANNEL_7* with *GAIN_17* will follows. After that measurement starts again from the begining until *stop_periodical_mode* is called.
+Must be a iterable object that contains tuples with channel id and gain for each channel where measurement will be performed. E.g. if it is list like \[(*CHANNEL_0*, *GAIN_1*), (*CHANNEL_5*, *GAIN_39*), (*CHANNEL_7*, *GAIN_17*)\]. Then measured will be (and *get_sample* returns voltage) from *CHANNEL_0* with *GAIN_1*. After the *timer* ms *CHANNEL_5* with *GAIN_39* will be measured and after another *timer* ms *CHANNEL_7* with *GAIN_17* will follows. After that measurement starts again from the begining until *stop_periodical_mode* is called.

 *timer*
 Value in ms for internal timer. Value must be more than a time necessary to finish measurement for given channel, chopper and resolution. Maximal value is 65000.

Device class modified by Miso kopera

Miso kopera — Tue, 04 Jun 2013 19:51:36 -0000

--- v10
+++ v11
@@ -6,7 +6,7 @@
 ~~~~~~
 __init__(serial_string, description = b"AD24USB", index = 0):
 ~~~~~~
-Constructor initialize and open ad24usb device. Device is referenced by *serial_string*, *description* and *index* parameters. Raises *OpenError* if is not able to open device and *InitError* when some initilization fails.
+Constructor initializes and opens ad24usb device. Device is selected by *serial_string*, *description* and *index* parameters. Raises *OpenError* if is not able to open device and *InitError* when some initilization fails.

 *serial_string*
 Ftdi serial byte string of device.
@@ -28,7 +28,7 @@
 ~~~~~
 set_range(unipolar = True)
 ~~~~~
-Function sets input range of AD converter.
+Sets input range of AD converter.

 *unipolar*
 If parameter is True range is set to unipolar. Otherwise range will be bipolar.
@@ -38,7 +38,7 @@
 ~~~~~
 set_chopper(chop_type = CHOPPER_DISABLED, samples_count = 2)
 ~~~~~
-Function sets type of chopper and number of sampes for chopping. Chopper can remove voltage drifts and noise. Function sets device into bipolar mode for any active chopper.
+Method sets type of chopper and number of sampes for chopping. Chopper can remove voltage drifts and noise. Automaticaly sets device into bipolar mode for any active chopper.

 *chop_type*
 Type of required chopper. Must be one of:
@@ -54,7 +54,7 @@
 ~~~~~
 set_resolution(self, resolution)
 ~~~~~
-Sets resolution (integrating time) for AD converter. Function raises *DeviceInPeriodicalMode* exception if device is in periodical mode and *ValueError* for incorrect resolution values.
+Sets resolution (integrating time) for AD converter. Raises *DeviceInPeriodicalMode* exception if device is in periodical mode and *ValueError* for incorrect resolution values.

 *resolution*
 Should be one of *RESOLUTIONS* constants.
@@ -63,7 +63,7 @@
 ~~~~~
 calibration(one_gain, gain)
 ~~~~~
-Function internaly fills calibration table that is used to convert measured values to real voltage. This function must be called before each measurement. And for longer measuring should be called periodicaly because of thermal changes and voltage drifts inside the device. Raises *DeviceInPeriodicalMode* when is called during periodical measurement, *ValueError* for bad *gain* parameter and *CommunicationError* if is not able to communicate with device.
+Method internaly fills calibration table that is used to convert measured values to real voltage. This function must be called before each measurement. And for longer measuring should be called periodicaly because of thermal changes and voltage drifts inside the device. Raises *DeviceInPeriodicalMode* when is called during periodical measurement, *ValueError* for bad *gain* parameter and *CommunicationError* if is not able to communicate with device.

 *one_gain*
 If True, only one *gain* will be calibrated. Otherwise all gains will be calibrated and *gain* parameter is ignored.
@@ -76,7 +76,7 @@
 ~~~~~
 get_sample(channel, gain)
 ~~~~~
-Returns measured voltage (modified by calibration table) from *channel* with *gain* if device is in standard mode. If periodical mode is enabled, both parameters are ignored and measuring depends on *channels* parameter in *start_periodical_mode* function. Function applies and uses chopper if is enabled. Raises *ValueError* if *gain* or *channel* are not a valid values. Function call *ftdidevice.read()* so eventualy can by raised *ftdidevice.DeviceReadError*.
+Returns measured voltage (modified by calibration table) from *channel* with *gain* if device is in standard mode. If periodical mode is enabled, both parameters are ignored and measuring depends on *channels* parameter in *start_periodical_mode* method. Method applies and uses chopper if is enabled. Raises *ValueError* if *gain* or *channel* are not a valid values. Function call *ftdidevice.read()* so eventualy can be raised *ftdidevice.DeviceReadError*.

 *channel*
 Input channel. Must be one of *CHANNELS* constants.
@@ -89,46 +89,83 @@
 ~~~~~
 start_periodical_mode(channels, timer)
 ~~~~~
-Function starts periodical mode in device. Device will continualy with *timer* period measures and *get_sample* will returns voltage based on *channels* parameter. Function raises *TimerError* if *timer* is too sort.
+Method starts periodical mode in device. Device will continualy with *timer* period measures voltage based on *channels* parameter. Measurement starts immediately after this function is called. Measured values are returned by *get_sample* function. *TimerError* is raised if *timer* is too sort.

 *channels*
+Must be a iterable object that contains tuples with channel id and gain for each channel where measurement will be performed. E.g. if it is list like [(*CHANNEL_0*, *GAIN_1*), (*CHANNEL_5*, *GAIN_39*), (*CHANNEL_7*, *GAIN_17*)]. Then measured will be (and *get_sample* returns voltage) from *CHANNEL_0* with *GAIN_1*. After the *timer* ms *CHANNEL_5* with *GAIN_39* will be measured and after another *timer* ms *CHANNEL_7* with *GAIN_17* will follows. After that measurement starts again from the begining until *stop_periodical_mode* is called.

 *timer*
 Value in ms for internal timer. Value must be more than a time necessary to finish measurement for given channel, chopper and resolution. Maximal value is 65000.
+

 ####stop_periodical_mode()
 ~~~~~
 stop_periodical_mode()
 ~~~~~
+Method stops periodical mode.
+
+
 ####is_periodical_mode()
 ~~~~~
 is_periodical_mode()
 ~~~~~
+Returns True if device is in periodical mode. If not returns False.
+
+
+####set_current_value()
+~~~~~
+set_current_value(current, sleep = True)
+~~~~~
+Method set power of output current source. Returns value that is setted.
+
+*current*
+Should be a float number of required power in mA. Value is rounded to match device current resolution. *ValueError* is raised if *current* is more then maximal current. *DeviceInPeriodicalMode* if device is in periodical mode.
+
+*sleep*
+If True, method will wait for 100ms. To be sure the current value is exact before method returns. If False method return immediately.
+
+
+####get_current_source_info()
+~~~~~
+get_current_source_info()
+~~~~~
+Returns tuple that contains maximal current of current source in mA and resolution in bits of current DA converter. Both values are integers.
+
+
+####get_version()
+~~~~~
+get_version()
+~~~~~
+Method returns 4 bytes long binary string representing device firmware verions.
+
+
+####get_serial_number()
+~~~~~
+get_serial_number()
+~~~~~
+Returns device serial number as a integer.
+
+
+####get_real_gains()
+~~~~~
+get_real_gains()
+~~~~~
+Returns list of real devices gains. Those values are obtained from device flash rom in *__init__* method.
+
+
 ####dig_output()
 ~~~~~
 dig_output(byte)
 ~~~~~
+THIS IS EXPERIMENTAL FUNCTION AND IS NOT TESTED YET!!
+Method sends *byte* to digital output pins.
+
+*byte*
+Integer value that will be written to digital output.
+
 ####dig_input()
 ~~~~~
 dig_input()
 ~~~~~
-####set_current_value()
-~~~~~
-set_current_value(current, sleep = True)
-~~~~~
-####get_version()
-~~~~~
-get_version()
-~~~~~
-####get_serial_number()
-~~~~~
-get_serial_number()
-~~~~~
-####get_current_source_info()
-~~~~~
-get_current_source_info()
-~~~~~
-####get_real_gains()
-~~~~~
-get_real_gains()
-~~~~~
+THIS IS EXPERIMENTAL FUNCTION AND IS NOT TESTED YET!!
+Method reads byte from digital input pins and returns it as a integer.

Device class modified by Miso kopera

Miso kopera — Tue, 04 Jun 2013 19:07:49 -0000

--- v9
+++ v10
@@ -1,8 +1,4 @@
-Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class. Covers all necessary function that are needed for setting, managing and measuring with device. Device can measures in two modes. Periodical and standard (Non-periodical) mode. 
-
-Standard mode returns measured value immediately on request. Well, not immediately but just after the measuring done what may be several minutes depends on resolution and chopper setings. This is the most universal mode because various changes can be done to device between measures.
-
-During periodical mode device returns measured values continualy in precise periods based on devices internal timer. Unfortunately during this mode no other communication (except *stop_periodical_mode*) is possible. So is not possible to recalibrate it, change output current, change resolution, etc... This mode is for sorter measuring when precise period is required.
+API documentation for *ad24usbdevice.Device* class.

 [TOC]
 ###Device class:
@@ -58,10 +54,10 @@
 ~~~~~
 set_resolution(self, resolution)
 ~~~~~
-Sets resolution (integrating time) for AD converter. Function raises *DeviceInPeriodicalMode* exception if you try to set resolution while device is in periodical mode and *ValueError* for incorrect resolution values.
+Sets resolution (integrating time) for AD converter. Function raises *DeviceInPeriodicalMode* exception if device is in periodical mode and *ValueError* for incorrect resolution values.

 *resolution*
-Should be one of RESOLUTION_5, RESOLUTION_20, RESOLUTION_80, RESOLUTION_320. Number is for integrating time in ms.
+Should be one of *RESOLUTIONS* constants.

 ####calibration()
 ~~~~~
@@ -73,17 +69,33 @@
 If True, only one *gain* will be calibrated. Otherwise all gains will be calibrated and *gain* parameter is ignored.

 *gain*
-Gain that should be calibrated (ignored when *one_gain* is False). Value must be one of GAIN_1, GAIN_2, GAIN_4, GAIN_8, GAIN_17, GAIN_39, GAIN_102, GAIN_512
+Gain that should be calibrated (ignored when *one_gain* is False). Value must be one of *GAINS* constants.

 ####get_sample()
 ~~~~~
 get_sample(channel, gain)
 ~~~~~
+Returns measured voltage (modified by calibration table) from *channel* with *gain* if device is in standard mode. If periodical mode is enabled, both parameters are ignored and measuring depends on *channels* parameter in *start_periodical_mode* function. Function applies and uses chopper if is enabled. Raises *ValueError* if *gain* or *channel* are not a valid values. Function call *ftdidevice.read()* so eventualy can by raised *ftdidevice.DeviceReadError*.
+
+*channel*
+Input channel. Must be one of *CHANNELS* constants.
+
+*gain*
+Required gain for *channel*. Must be one of *GAINS* constants.
+
+
 ####start_periodical_mode()
 ~~~~~
 start_periodical_mode(channels, timer)
 ~~~~~
+Function starts periodical mode in device. Device will continualy with *timer* period measures and *get_sample* will returns voltage based on *channels* parameter. Function raises *TimerError* if *timer* is too sort.
+
+*channels*
+
+*timer*
+Value in ms for internal timer. Value must be more than a time necessary to finish measurement for given channel, chopper and resolution. Maximal value is 65000.
+
 ####stop_periodical_mode()
 ~~~~~
 stop_periodical_mode()

Device class modified by Miso kopera

Miso kopera — Mon, 03 Jun 2013 19:52:58 -0000

--- v8
+++ v9
@@ -1,4 +1,4 @@
-Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class. Covers all necessary function that are needed for setting, managing and measuring with device. Device can measure in two modes. Periodical and standard (Non-periodical) mode. 
+Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class. Covers all necessary function that are needed for setting, managing and measuring with device. Device can measures in two modes. Periodical and standard (Non-periodical) mode.

 Standard mode returns measured value immediately on request. Well, not immediately but just after the measuring done what may be several minutes depends on resolution and chopper setings. This is the most universal mode because various changes can be done to device between measures.

Device class modified by Miso kopera

Miso kopera — Mon, 03 Jun 2013 19:51:16 -0000

--- v7
+++ v8
@@ -1,4 +1,8 @@
-Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class.
+Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class. Covers all necessary function that are needed for setting, managing and measuring with device. Device can measure in two modes. Periodical and standard (Non-periodical) mode. 
+
+Standard mode returns measured value immediately on request. Well, not immediately but just after the measuring done what may be several minutes depends on resolution and chopper setings. This is the most universal mode because various changes can be done to device between measures.
+
+During periodical mode device returns measured values continualy in precise periods based on devices internal timer. Unfortunately during this mode no other communication (except *stop_periodical_mode*) is possible. So is not possible to recalibrate it, change output current, change resolution, etc... This mode is for sorter measuring when precise period is required.

 [TOC]
 ###Device class:

Device class modified by Miso kopera

Miso kopera — Mon, 03 Jun 2013 19:29:31 -0000

--- v6
+++ v7
@@ -63,6 +63,15 @@
 ~~~~~
 calibration(one_gain, gain)
 ~~~~~
+Function internaly fills calibration table that is used to convert measured values to real voltage. This function must be called before each measurement. And for longer measuring should be called periodicaly because of thermal changes and voltage drifts inside the device. Raises *DeviceInPeriodicalMode* when is called during periodical measurement, *ValueError* for bad *gain* parameter and *CommunicationError* if is not able to communicate with device.
+
+*one_gain*
+If True, only one *gain* will be calibrated. Otherwise all gains will be calibrated and *gain* parameter is ignored.
+
+*gain*
+Gain that should be calibrated (ignored when *one_gain* is False). Value must be one of GAIN_1, GAIN_2, GAIN_4, GAIN_8, GAIN_17, GAIN_39, GAIN_102, GAIN_512
+
+
 ####get_sample()
 ~~~~~
 get_sample(channel, gain)
@@ -107,4 +116,3 @@
 ~~~~~
 get_real_gains()
 ~~~~~
-

Device class modified by Miso kopera

Miso kopera — Sun, 02 Jun 2013 19:30:29 -0000

--- v5
+++ v6
@@ -1,10 +1,12 @@
+Device class is derived from [ftdidevice.Device](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/) class.
+
 [TOC]
 ###Device class:
 ####\_\_init\_\_()
 ~~~~~~
 __init__(serial_string, description = b"AD24USB", index = 0):
 ~~~~~~
-Constructor initialize and open ad24usb device. Device is referenced by *serial_string*, *description* and *index* parameters. Raises *OpenError* if is not able open device and *InitError* when some initilization fails.
+Constructor initialize and open ad24usb device. Device is referenced by *serial_string*, *description* and *index* parameters. Raises *OpenError* if is not able to open device and *InitError* when some initilization fails.

 *serial_string*
 Ftdi serial byte string of device.
@@ -17,7 +19,7 @@

 ####close()
 ~~~~~
-####close()
+close()
 ~~~~~
 Stops periodical mode, sets current to 0, and deinit device.

@@ -57,15 +59,52 @@
 *resolution*
 Should be one of RESOLUTION_5, RESOLUTION_20, RESOLUTION_80, RESOLUTION_320. Number is for integrating time in ms.

-####calibration(one_gain, gain):
-####get_sample(channel, gain):
-####start_periodical_mode(channels, timer):
-####stop_periodical_mode():
-####is_periodical_mode():
-####dig_output(byte):
-####dig_input():
-####set_current_value(current, sleep = True):
-####get_version():
-####get_serial_number():
-####get_current_source_info():
-####get_real_gains():
+####calibration()
+~~~~~
+calibration(one_gain, gain)
+~~~~~
+####get_sample()
+~~~~~
+get_sample(channel, gain)
+~~~~~
+####start_periodical_mode()
+~~~~~
+start_periodical_mode(channels, timer)
+~~~~~
+####stop_periodical_mode()
+~~~~~
+stop_periodical_mode()
+~~~~~
+####is_periodical_mode()
+~~~~~
+is_periodical_mode()
+~~~~~
+####dig_output()
+~~~~~
+dig_output(byte)
+~~~~~
+####dig_input()
+~~~~~
+dig_input()
+~~~~~
+####set_current_value()
+~~~~~
+set_current_value(current, sleep = True)
+~~~~~
+####get_version()
+~~~~~
+get_version()
+~~~~~
+####get_serial_number()
+~~~~~
+get_serial_number()
+~~~~~
+####get_current_source_info()
+~~~~~
+get_current_source_info()
+~~~~~
+####get_real_gains()
+~~~~~
+get_real_gains()
+~~~~~
+

Device class modified by Miso kopera

Miso kopera — Sun, 02 Jun 2013 19:14:38 -0000

--- v4
+++ v5
@@ -14,6 +14,12 @@

 *index*
 If is more devices with the same *serial_string* and *description*, device can be selected by index. Indexes starts from 0 what is also a default value.
+
+####close()
+~~~~~
+####close()
+~~~~~
+Stops periodical mode, sets current to 0, and deinit device.

 ####set_range()
@@ -49,4 +55,17 @@
 Sets resolution (integrating time) for AD converter. Function raises *DeviceInPeriodicalMode* exception if you try to set resolution while device is in periodical mode and *ValueError* for incorrect resolution values.

 *resolution*
-Required resolution. Should be one of RESOLUTION_5, RESOLUTION_20, RESOLUTION_80, RESOLUTION_320. Number is for integrating time in ms.
+Should be one of RESOLUTION_5, RESOLUTION_20, RESOLUTION_80, RESOLUTION_320. Number is for integrating time in ms.
+
+####calibration(one_gain, gain):
+####get_sample(channel, gain):
+####start_periodical_mode(channels, timer):
+####stop_periodical_mode():
+####is_periodical_mode():
+####dig_output(byte):
+####dig_input():
+####set_current_value(current, sleep = True):
+####get_version():
+####get_serial_number():
+####get_current_source_info():
+####get_real_gains():

Device class modified by Miso kopera

Miso kopera — Sun, 02 Jun 2013 18:59:21 -0000

--- v3
+++ v4
@@ -40,3 +40,13 @@

 *samples_count*
 Number of measured samples used by chopper. Value should be even number.
+
+
+####set_resolution()
+~~~~~
+set_resolution(self, resolution)
+~~~~~
+Sets resolution (integrating time) for AD converter. Function raises *DeviceInPeriodicalMode* exception if you try to set resolution while device is in periodical mode and *ValueError* for incorrect resolution values.
+
+*resolution*
+Required resolution. Should be one of RESOLUTION_5, RESOLUTION_20, RESOLUTION_80, RESOLUTION_320. Number is for integrating time in ms.

Device class modified by Miso kopera

Miso kopera — Sat, 01 Jun 2013 21:20:31 -0000

--- v2
+++ v3
@@ -30,7 +30,7 @@
 ~~~~~
 set_chopper(chop_type = CHOPPER_DISABLED, samples_count = 2)
 ~~~~~
-Function sets type of chopper and number of sampes for chopping. Chopper can remove voltage drifts and noise. 
+Function sets type of chopper and number of sampes for chopping. Chopper can remove voltage drifts and noise. Function sets device into bipolar mode for any active chopper.

 *chop_type*
 Type of required chopper. Must be one of:
@@ -38,7 +38,5 @@
 - CHOPPER_INPUT for chopping input of AD converter
 - CHOPPER_OUTPUT for chopping current source

-For any active chopper, function sets device to bipolar mode.
-
 *samples_count*
-Number of measured values for chopper. Value should be even number.
+Number of measured samples used by chopper. Value should be even number.