Recent changes to Device class

Device class modified by Miso kopera

Miso kopera — Sat, 27 Apr 2013 20:54:32 -0000

--- v10
+++ v11
@@ -170,7 +170,7 @@
 ~~~~~
 get_serial_string()
 ~~~~~
-Return device ftdi serial string. It is the same string that was passes to [\_\_init\_\_()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#9595init9595)
+Return device ftdi serial string. It is the same string that was passed to [\_\_init\_\_()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#9595init9595)

 ####get_error_string()

Device class modified by Miso kopera

Miso kopera — Sat, 27 Apr 2013 20:53:40 -0000

--- v9
+++ v10
@@ -170,21 +170,25 @@
 ~~~~~
 get_serial_string()
 ~~~~~
-Return device ftdi serial string. It is the same string that was passes to [\_\_init\_\_()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#\_\_init\_\_)
+Return device ftdi serial string. It is the same string that was passes to [\_\_init\_\_()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#9595init9595)

 ####get_error_string()
 ~~~~~
 get_error_string()
 ~~~~~
-text
+Returns internal string of last error from libFTDI.
+
+  
 ####get_modem_status()
 ~~~~~
 get_modem_status()
 ~~~~~
-text
+Returns poll modem status information or raises *DeviceModemStatusError* exception.
+
+
 ####read_pins()
 ~~~~~
 read_pins()
 ~~~~~
-text
+Returns pins state or raises *DeviceReadPinsError* exception.

Device class modified by Miso kopera

Miso kopera — Sat, 27 Apr 2013 20:48:36 -0000

--- v8
+++ v9
@@ -55,13 +55,13 @@
 ~~~~~
 read(size, timeout = None, expected_time = 0)
 ~~~~~
-Reads and returns *size* of bytes from device. Function pools for data until desired *size* or *timeout* is reached. When *timeout* is reached, function returns all bytes that were obtained until than. Raise *DeviceReadError* if reading fail for some reason.
+Reads and returns *size* of bytes from device. Function pools for data until desired *size* or *timeout* is reached. When *timeout* is reached, function returns all bytes that were obtained until than. Raise *DeviceReadError* exception if reading fail for some reason.

 *size*
 Number of desired or expected bytes.

 *timeout*
-Time in ms. After that function returns whatever it has. If *None*, *read_timeout* from [set_timeout()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/edit#set_timeout) is used.
+Time in ms. After that function returns whatever it has. If *None*, *read_timeout* from [set_timeout()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#set_timeout) is used.

 *expected_time*
 Time in ms. Function will sleep *expected_time* before it first reads (and starts pooling for) data. This can be very usefull for pooling optimalization. Default value is 0.
@@ -111,7 +111,7 @@
 ~~~~~
 set_latency_timer(latency)
 ~~~~~
-Sets device *latency* timer. Or raise *DeviceLatencyTimerError*.
+Sets device *latency* timer. Or raise *DeviceLatencyTimerError* exception.

 *latency*
 Time in ms.
@@ -121,29 +121,58 @@
 ~~~~~
 get_latency_timer()
 ~~~~~
-Returns device latency timer. Or raise *DeviceLatencyTimerError*.
+Returns device latency timer. Or raise *DeviceLatencyTimerError* exception.

 ####set_line_property()
 ~~~~~
 set_line_property(bits_type, stopbits_type, parity_type, break_type = BREAK_OFF)
 ~~~~~
-text
+Sets RS232 line characteristics or raise *DeviceLinePropertyError* exception.
+
+*bits_type*
+Should be one of *BITS_7*, *BITS_8* constants.
+ 
+*stopbits_type*
+Number of stopbites. One of *STOP_BIT_1*, *STOP_BIT_15*, *STOP_BIT_2* constants.
+
+*parity_type*
+One of *PARITY_NONE*, *PARITY_ODD*, *PARITY_EVEN*, *PARITY_MARK*, *PARITY_SPACE* constants.
+
+*break_type*
+One of *BREAK_OFF* or *BREAK_ON*
+
+
 ####set_timeout()
 ~~~~~
 set_timeout(read_timeout, write_timeout)
 ~~~~~
-text
+Sets device read and write timeout.
+
+*read_timeout*
+Read timeout in ms.
+
+*write_timeout*
+Write timeout in ms.
+
+
 ####set_flow_control()
 ~~~~~
 set_flow_control(flow_ctrl = SIO_DISABLE_FLOW_CTRL)
 ~~~~~
-text
+Sets flow control or raises *DeviceFlowCtrlError* exception
+
+*flow_ctrl*
+Should be one of *SIO_DISABLE_FLOW_CTRL*, *SIO_RTS_CTS_HS*, *SIO_DTR_DSR_HS* or *SIO_XON_XOFF_HS* 
+
+
 ####get_serial_string()
 ~~~~~
 get_serial_string()
 ~~~~~
-text
+Return device ftdi serial string. It is the same string that was passes to [\_\_init\_\_()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/#\_\_init\_\_)
+
+
 ####get_error_string()
 ~~~~~
 get_error_string()

Device class modified by Miso kopera

Miso kopera — Sat, 27 Apr 2013 20:32:31 -0000

--- v7
+++ v8
@@ -64,40 +64,66 @@
 Time in ms. After that function returns whatever it has. If *None*, *read_timeout* from [set_timeout()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/edit#set_timeout) is used.

 *expected_time*
-Time in ms. Function will sleep *expected_time* before it first reads (and starts pooling for) data. This can by very usefull for pooling optimalization. Default value is 0.
-
+Time in ms. Function will sleep *expected_time* before it first reads (and starts pooling for) data. This can be very usefull for pooling optimalization. Default value is 0.

 ####write()
 ~~~~~
 write(data)
 ~~~~~
-text
+Write *data* to device. *Data* should be a bytes() object. Returns number of written bytes. Raise *DeviceWriteError* exception.
+
+*data*
+bytes that should be send to device. E.g. b"hello"
+
+ 
 ####flush()
 ~~~~~
 flush(flush_input = False, flush_output = False)
 ~~~~~
-text
+Flush devices input and/or output buffer.
+
+*flush_input*
+If *True* flush input (read or RX) buffer.
+
+*flush_output*
+If *True* flush output (write or TX) buffer.
+
+
 ####get_baudrate()
 ~~~~~
 get_baudrate()
 ~~~~~
-text
+Returns device baudrate.
+
+
 ####set_baudrate()
 ~~~~~
 set_baudrate(baudrate)
 ~~~~~
-text
+Sets device *baudrate*.
+
+*baudrate*
+Desired *baudrate*.
+
+
 ####set_latency_timer()
 ~~~~~
 set_latency_timer(latency)
 ~~~~~
-text
+Sets device *latency* timer. Or raise *DeviceLatencyTimerError*.
+
+*latency*
+Time in ms.
+
+
 ####get_latency_timer()
 ~~~~~
 get_latency_timer()
 ~~~~~
-text
+Returns device latency timer. Or raise *DeviceLatencyTimerError*.
+
+
 ####set_line_property()
 ~~~~~
 set_line_property(bits_type, stopbits_type, parity_type, break_type = BREAK_OFF)
@@ -133,4 +159,3 @@
 read_pins()
 ~~~~~
 text
-

Device class modified by Miso kopera

Miso kopera — Sat, 27 Apr 2013 20:20:04 -0000

--- v6
+++ v7
@@ -5,27 +5,69 @@
 __init__(serial_string, description, index = 0, baudrate = None, 
          interface = None, read_buffer_size = 4096, write_buffer_size = 4096)
 ~~~~~~
-text
+Internaly init device, sets and allocate read/write buffers. Device is referenced by *serial_string*, *description* (and *index*) parameters. They are returned by [Ftdi.list_devices()](https://sourceforge.net/p/ftdidevice/wiki/Ftdi%20class/#list_devices).
+If something goes wrong *DeviceInitError* exception is raised. And if interface is invalid *DeviceInterfaceError* is raised.
+
+*serial_string*
+Ftdi serial byte string of device.
+ 
+*description*
+Description byte string.
+ 
+*index*
+If is more devices with same *serial_string* and *description*, device can be selected by index. Indexes starts from 0 what is also a default value.
+
+*baudrate*
+Desired communication baudrate. If *None* default value from libFTDI is used.
+
+*interface*
+Desired device channel. If *None* default value from libFTDI is used.
+
+*read_buffer_size*
+Size of read buffer. Default value is 4096
+
+*write_buffer_size*
+Size of write buffer. Default value is 4096
+
+   
 ####open()
 ~~~~~
 open()
 ~~~~~
-text
+Opens device. This must be called before any other functions. Raise *DeviceOpenError* when device can't be opened.
+
+
 ####close()
 ~~~~~
 close()
 ~~~~~
-text
+Close (and deinit) opened device.
+
+
 ####reset()
 ~~~~~
 reset()
 ~~~~~
-text
+Reset device.
+
+
 ####read()
 ~~~~~
 read(size, timeout = None, expected_time = 0)
 ~~~~~
-text
+Reads and returns *size* of bytes from device. Function pools for data until desired *size* or *timeout* is reached. When *timeout* is reached, function returns all bytes that were obtained until than. Raise *DeviceReadError* if reading fail for some reason.
+
+*size*
+Number of desired or expected bytes.
+
+*timeout*
+Time in ms. After that function returns whatever it has. If *None*, *read_timeout* from [set_timeout()](https://sourceforge.net/p/ftdidevice/wiki/Device%20class/edit#set_timeout) is used.
+
+*expected_time*
+Time in ms. Function will sleep *expected_time* before it first reads (and starts pooling for) data. This can by very usefull for pooling optimalization. Default value is 0.
+
+
+
 ####write()
 ~~~~~
 write(data)
@@ -92,4 +134,3 @@
 ~~~~~
 text

-

Device class modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 17:25:13 -0000

--- v5
+++ v6
@@ -2,93 +2,93 @@
 ###Device class:
 ####\_\_init\_\_()
 ~~~~~~
-__init__(self, serial_string, description, index = 0, baudrate = None, 
+__init__(serial_string, description, index = 0, baudrate = None, 
          interface = None, read_buffer_size = 4096, write_buffer_size = 4096)
 ~~~~~~
 text
 ####open()
 ~~~~~
-open(self)
+open()
 ~~~~~
 text
 ####close()
 ~~~~~
-close(self)
+close()
 ~~~~~
 text
 ####reset()
 ~~~~~
-reset(self)
+reset()
 ~~~~~
 text
 ####read()
 ~~~~~
-read(self, size, timeout = None, expected_time = 0)
+read(size, timeout = None, expected_time = 0)
 ~~~~~
 text
 ####write()
 ~~~~~
-write(self, data)
+write(data)
 ~~~~~
 text
 ####flush()
 ~~~~~
-flush(self, flush_input = False, flush_output = False)
+flush(flush_input = False, flush_output = False)
 ~~~~~
 text
 ####get_baudrate()
 ~~~~~
-get_baudrate(self)
+get_baudrate()
 ~~~~~
 text
 ####set_baudrate()
 ~~~~~
-set_baudrate(self, baudrate)
+set_baudrate(baudrate)
 ~~~~~
 text
 ####set_latency_timer()
 ~~~~~
-set_latency_timer(self, latency)
+set_latency_timer(latency)
 ~~~~~
 text
 ####get_latency_timer()
 ~~~~~
-get_latency_timer(self)
+get_latency_timer()
 ~~~~~
 text
 ####set_line_property()
 ~~~~~
-set_line_property(self, bits_type, stopbits_type, parity_type, break_type = BREAK_OFF)
+set_line_property(bits_type, stopbits_type, parity_type, break_type = BREAK_OFF)
 ~~~~~
 text
 ####set_timeout()
 ~~~~~
-set_timeout(self, read_timeout, write_timeout)
+set_timeout(read_timeout, write_timeout)
 ~~~~~
 text
 ####set_flow_control()
 ~~~~~
-set_flow_control(self, flow_ctrl = SIO_DISABLE_FLOW_CTRL)
+set_flow_control(flow_ctrl = SIO_DISABLE_FLOW_CTRL)
 ~~~~~
 text
 ####get_serial_string()
 ~~~~~
-get_serial_string(self)
+get_serial_string()
 ~~~~~
 text
 ####get_error_string()
 ~~~~~
-get_error_string(self)
+get_error_string()
 ~~~~~
 text
 ####get_modem_status()
 ~~~~~
-get_modem_status(self)
+get_modem_status()
 ~~~~~
 text
 ####read_pins()
 ~~~~~
-read_pins(self)
+read_pins()
 ~~~~~
 text

Device class modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 17:23:41 -0000

--- v4
+++ v5
@@ -58,7 +58,7 @@
 text
 ####set_line_property()
 ~~~~~
-set_line_property(self, bits_type, stopbits_type, parity_type, break_type = 0)
+set_line_property(self, bits_type, stopbits_type, parity_type, break_type = BREAK_OFF)
 ~~~~~
 text
 ####set_timeout()
@@ -93,4 +93,3 @@
 text

-

Device class modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 17:22:42 -0000

--- v3
+++ v4
@@ -2,7 +2,7 @@
 ###Device class:
 ####\_\_init\_\_()
 ~~~~~~
-__init__(self, serial_string = None, description = None, index = 0, baudrate = None, 
+__init__(self, serial_string, description, index = 0, baudrate = None, 
          interface = None, read_buffer_size = 4096, write_buffer_size = 4096)
 ~~~~~~
 text

Device class modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 08:39:24 -0000

--- v2
+++ v3
@@ -1,40 +1,95 @@
 [TOC]
 ###Device class:
 ####\_\_init\_\_()
+~~~~~~
+__init__(self, serial_string = None, description = None, index = 0, baudrate = None, 
+         interface = None, read_buffer_size = 4096, write_buffer_size = 4096)
+~~~~~~
 text
 ####open()
+~~~~~
+open(self)
+~~~~~
 text
 ####close()
+~~~~~
+close(self)
+~~~~~
 text
 ####reset()
+~~~~~
+reset(self)
+~~~~~
 text
 ####read()
+~~~~~
+read(self, size, timeout = None, expected_time = 0)
+~~~~~
 text
 ####write()
+~~~~~
+write(self, data)
+~~~~~
 text
 ####flush()
+~~~~~
+flush(self, flush_input = False, flush_output = False)
+~~~~~
 text
 ####get_baudrate()
+~~~~~
+get_baudrate(self)
+~~~~~
 text
 ####set_baudrate()
+~~~~~
+set_baudrate(self, baudrate)
+~~~~~
 text
 ####set_latency_timer()
+~~~~~
+set_latency_timer(self, latency)
+~~~~~
 text
 ####get_latency_timer()
+~~~~~
+get_latency_timer(self)
+~~~~~
 text
 ####set_line_property()
+~~~~~
+set_line_property(self, bits_type, stopbits_type, parity_type, break_type = 0)
+~~~~~
 text
 ####set_timeout()
+~~~~~
+set_timeout(self, read_timeout, write_timeout)
+~~~~~
 text
 ####set_flow_control()
+~~~~~
+set_flow_control(self, flow_ctrl = SIO_DISABLE_FLOW_CTRL)
+~~~~~
 text
 ####get_serial_string()
+~~~~~
+get_serial_string(self)
+~~~~~
 text
 ####get_error_string()
+~~~~~
+get_error_string(self)
+~~~~~
 text
 ####get_modem_status()
+~~~~~
+get_modem_status(self)
+~~~~~
 text
 ####read_pins()
+~~~~~
+read_pins(self)
+~~~~~
 text

Device class modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 08:26:28 -0000

--- v1
+++ v2
@@ -0,0 +1,41 @@
+[TOC]
+###Device class:
+####\_\_init\_\_()
+text
+####open()
+text
+####close()
+text
+####reset()
+text
+####read()
+text
+####write()
+text
+####flush()
+text
+####get_baudrate()
+text
+####set_baudrate()
+text
+####set_latency_timer()
+text
+####get_latency_timer()
+text
+####set_line_property()
+text
+####set_timeout()
+text
+####set_flow_control()
+text
+####get_serial_string()
+text
+####get_error_string()
+text
+####get_modem_status()
+text
+####read_pins()
+text
+
+
+