Recent changes to API Documentation

API Documentation modified by Miso kopera

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

--- v6
+++ v7
@@ -1,5 +1,36 @@
+[TOC]
+
+###Classes
 [Ftdi class]
 [Device class]
+###Constants
+~~~~~
+#flow control constants
+SIO_DISABLE_FLOW_CTRL = 0x0
+SIO_RTS_CTS_HS = (0x1 << 8)
+SIO_DTR_DSR_HS = (0x2 << 8)
+SIO_XON_XOFF_HS = (0x4 << 8)
+
+#bits type
+BITS_7 = 7
+BITS_8 = 8
+
+#stop bit type
+STOP_BIT_1 = 0 
+STOP_BIT_15 = 1 
+STOP_BIT_2 = 2
+
+#parity type
+PARITY_NONE = 0
+PARITY_ODD = 1
+PARITY_EVEN = 2
+PARITY_MARK = 3
+PARITY_SPACE = 4
+
+#break type
+BREAK_OFF = 0
+BREAK_ON = 1
+~~~~~

API Documentation modified by Miso kopera

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

--- v5
+++ v6
@@ -1,125 +1,5 @@
 [Ftdi class]
 [Device class]

-[TOC]
-###Ftdi class:
-Ftdi is static class that find and load libFTDI. Then works as a simple wrapper that only check if the parameters have correct type. You can call all functions from libFTDI simple just by:
-
-~~~~
-Ftdi.init(...)
-Ftdi.usb_find_all(...)
-Ftdi.usb_open(...)
-...
-~~~~
-
-The following table shows functions from Ftdi class and thier equivalents from libFTDI. Please see [libFTDI documentation](http://www.intra2net.com/en/developer/libftdi/documentation/group__libftdi.html) for functions and parameters. Usually instead of "ftid_" just use "Ftdi.".
-
-Ftdi class API| libFTDI api
---------------|------------
-init | ftdi_init
-usb_find_all | ftdi_usb_find_all
-usb_get_strings |ftdi_usb_get_strings
-usb_open |ftdi_usb_open
-usb_open_desc |ftdi_usb_open_desc
-usb_open_desc_index |ftdi_usb_open_desc_index
-usb_open_dev |ftdi_usb_open_dev
-usb_open_string |ftdi_usb_open_string
-usb_close |ftdi_usb_close
-usb_reset |ftdi_usb_reset
-usb_purge_rx_buffer |ftdi_usb_purge_rx_buffer
-usb_purge_tx_buffer |ftdi_usb_purge_tx_buffer
-usb_purge_buffers |ftdi_usb_purge_buffers
-set_baudrate |ftdi_set_baudrate
-set_bitmode |ftdi_set_bitmode
-set_interface |ftdi_set_interface
-set_line_property |ftdi_set_line_property
-set_line_property2 |ftdi_set_line_property2
-read_data |ftdi_read_data
-read_data_set_chunksize |ftdi_read_data_set_chunksize
-read_data_get_chunksize |ftdi_read_data_get_chunksize
-write_data |ftdi_write_data
-write_data_set_chunksize |ftdi_write_data_set_chunksize
-write_data_get_chunksize |ftdi_write_data_get_chunksize
-set_latency_timer |ftdi_set_latency_timer
-get_latency_timer |ftdi_get_latency_timer
-read_pins |ftdi_read_pins
-poll_modem_status |ftdi_poll_modem_status
-setflowctrl |ftdi_setflowctrl
-setdtr_rts |ftdi_setdtr_rts
-setdtr |ftdi_setdtr
-setrts |ftdi_setrts
-set_event_char |ftdi_set_event_char
-set_error_char |ftdi_set_error_char
-disable_bitbang |ftdi_disable_bitbang
-eeprom_build |ftdi_eeprom_build
-eeprom_decode |ftdi_eeprom_decode
-read_eeprom |ftdi_read_eeprom
-read_chipid |ftdi_read_chipid
-read_eeprom_getsize |ftdi_read_eeprom_getsize
-write_eeprom |ftdi_write_eeprom
-erase_eeprom |ftdi_erase_eeprom
-read_eeprom_location |ftdi_read_eeprom_location
-write_eeprom_location |ftdi_write_eeprom_location
-set_usbdev|ftdi_set_usbdev
-free |ftdi_free
-deinit |ftdi_deinit
-list_free |ftdi_list_free
-list_free2 |ftdi_list_free2
-get_error_string |ftdi_get_error_string
-eeprom_initdefaults |ftdi_eeprom_initdefaults
-eeprom_free |ftdi_eeprom_free
-eeprom_setsize |ftdi_eeprom_setsize
-write_data_async |ftdi_write_data_async
-async_complete |ftdi_async_complete

-####list_devices:
-~~~~
-list_devices()
-~~~~
-Static function that list all pluged ftdi devices (that have idProduct = 0x6001), and returns list of tuples. Each tuple contains (manufacturer, description, serial_num). manufacturer, description, serial_num may be empty bytes (b'') if user doesn't have permission to access the device. If no device is found, returns empty list.
-
-###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
-
-
-
-
-
-
-

API Documentation modified by Miso kopera

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

--- v4
+++ v5
@@ -1,3 +1,6 @@
+[Ftdi class]
+[Device class]
+
 [TOC]
 ###Ftdi class:
 Ftdi is static class that find and load libFTDI. Then works as a simple wrapper that only check if the parameters have correct type. You can call all functions from libFTDI simple just by:

API Documentation modified by Miso kopera

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

--- v3
+++ v4
@@ -2,8 +2,14 @@
 ###Ftdi class:
 Ftdi is static class that find and load libFTDI. Then works as a simple wrapper that only check if the parameters have correct type. You can call all functions from libFTDI simple just by:

+~~~~
+Ftdi.init(...)
+Ftdi.usb_find_all(...)
+Ftdi.usb_open(...)
+...
+~~~~

-The following table shows
+The following table shows functions from Ftdi class and thier equivalents from libFTDI. Please see [libFTDI documentation](http://www.intra2net.com/en/developer/libftdi/documentation/group__libftdi.html) for functions and parameters. Usually instead of "ftid_" just use "Ftdi.".

 Ftdi class API| libFTDI api
 --------------|------------
@@ -62,10 +68,17 @@
 eeprom_setsize |ftdi_eeprom_setsize
 write_data_async |ftdi_write_data_async
 async_complete |ftdi_async_complete
+
+
 ####list_devices:
-list device text
+~~~~
+list_devices()
+~~~~
+Static function that list all pluged ftdi devices (that have idProduct = 0x6001), and returns list of tuples. Each tuple contains (manufacturer, description, serial_num). manufacturer, description, serial_num may be empty bytes (b'') if user doesn't have permission to access the device. If no device is found, returns empty list.
+
 ###Device class:
 ####\_\_init\_\_()
+text
 ####open()
 text
 ####close()

API Documentation modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 08:01:09 -0000

--- v2
+++ v3
@@ -1,9 +1,71 @@
 [TOC]
 ###Ftdi class:
-Ftdi class text
+Ftdi is static class that find and load libFTDI. Then works as a simple wrapper that only check if the parameters have correct type. You can call all functions from libFTDI simple just by:
+
+
+The following table shows
+
+Ftdi class API| libFTDI api
+--------------|------------
+init | ftdi_init
+usb_find_all | ftdi_usb_find_all
+usb_get_strings |ftdi_usb_get_strings
+usb_open |ftdi_usb_open
+usb_open_desc |ftdi_usb_open_desc
+usb_open_desc_index |ftdi_usb_open_desc_index
+usb_open_dev |ftdi_usb_open_dev
+usb_open_string |ftdi_usb_open_string
+usb_close |ftdi_usb_close
+usb_reset |ftdi_usb_reset
+usb_purge_rx_buffer |ftdi_usb_purge_rx_buffer
+usb_purge_tx_buffer |ftdi_usb_purge_tx_buffer
+usb_purge_buffers |ftdi_usb_purge_buffers
+set_baudrate |ftdi_set_baudrate
+set_bitmode |ftdi_set_bitmode
+set_interface |ftdi_set_interface
+set_line_property |ftdi_set_line_property
+set_line_property2 |ftdi_set_line_property2
+read_data |ftdi_read_data
+read_data_set_chunksize |ftdi_read_data_set_chunksize
+read_data_get_chunksize |ftdi_read_data_get_chunksize
+write_data |ftdi_write_data
+write_data_set_chunksize |ftdi_write_data_set_chunksize
+write_data_get_chunksize |ftdi_write_data_get_chunksize
+set_latency_timer |ftdi_set_latency_timer
+get_latency_timer |ftdi_get_latency_timer
+read_pins |ftdi_read_pins
+poll_modem_status |ftdi_poll_modem_status
+setflowctrl |ftdi_setflowctrl
+setdtr_rts |ftdi_setdtr_rts
+setdtr |ftdi_setdtr
+setrts |ftdi_setrts
+set_event_char |ftdi_set_event_char
+set_error_char |ftdi_set_error_char
+disable_bitbang |ftdi_disable_bitbang
+eeprom_build |ftdi_eeprom_build
+eeprom_decode |ftdi_eeprom_decode
+read_eeprom |ftdi_read_eeprom
+read_chipid |ftdi_read_chipid
+read_eeprom_getsize |ftdi_read_eeprom_getsize
+write_eeprom |ftdi_write_eeprom
+erase_eeprom |ftdi_erase_eeprom
+read_eeprom_location |ftdi_read_eeprom_location
+write_eeprom_location |ftdi_write_eeprom_location
+set_usbdev|ftdi_set_usbdev
+free |ftdi_free
+deinit |ftdi_deinit
+list_free |ftdi_list_free
+list_free2 |ftdi_list_free2
+get_error_string |ftdi_get_error_string
+eeprom_initdefaults |ftdi_eeprom_initdefaults
+eeprom_free |ftdi_eeprom_free
+eeprom_setsize |ftdi_eeprom_setsize
+write_data_async |ftdi_write_data_async
+async_complete |ftdi_async_complete
 ####list_devices:
 list device text
 ###Device class:
+####\_\_init\_\_()
 ####open()
 text
 ####close()

API Documentation modified by Miso kopera

Miso kopera — Thu, 25 Apr 2013 07:44:59 -0000

--- v1
+++ v2
@@ -1 +1,47 @@
-Hello doc
+[TOC]
+###Ftdi class:
+Ftdi class text
+####list_devices:
+list device text
+###Device class:
+####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
+
+
+
+
+
+
+

API Documentation modified by Miso kopera

Miso kopera — Wed, 24 Apr 2013 07:22:49 -0000

Hello doc