diff options
| author | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2011-03-04 02:15:38 +0000 |
|---|---|---|
| committer | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2011-03-04 02:15:38 +0000 |
| commit | 5f0a4f6bd42c01033066bbc57b19696e79f8a06d (patch) | |
| tree | e650c0bb0b9930993a167e1a4c85d91491265333 /documentation | |
| parent | 7dd1565e13521ef2a119e4938ee8601c345296bc (diff) | |
| download | pyserial-5f0a4f6bd42c01033066bbc57b19696e79f8a06d.tar.gz | |
document the new possibilities for URL handlers, mention py2exe
git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@384 f19166aa-fa4f-0410-85c2-fa1106f25c8a
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/appendix.rst | 27 | ||||
| -rw-r--r-- | documentation/index.rst | 2 |
2 files changed, 28 insertions, 1 deletions
diff --git a/documentation/appendix.rst b/documentation/appendix.rst index 9c216f8..487a334 100644 --- a/documentation/appendix.rst +++ b/documentation/appendix.rst @@ -34,6 +34,33 @@ Test your setup. though). +URL handlers +============ +``serial_for_url`` can be used to access "virtual" serial ports identified by +an URL scheme. E.g. for the RFC 2217, ``rfc2217:://``. + +Custom URL handlers can be added in the ``serial.urlhandler`` directory. +Modules must be named ``protocol_xxx.py`` where ``xxx`` is the part that is +used in the URL (``xxx://``). + +This is possible starting from pySerial V2.6. + + +py2exe +====== +py2exe and similar packaging programs scan the sources for import statements +and create a list of modules that they package. pySerial may create two issues +with that: + +- implementations for other modules are found. On Windows, it's save to exclude + 'serialposix', 'serialjava' and 'serialcli' as these are not used. + +- ``serial_for_url`` does a dynamic lookup of protocol handlers at runtime. + If this function is used, the desired handlers have to be included manually + (e.g. 'serial.urlhandler.protocol_socket', + 'serial.urlhandler.protocol_rfc2217', etc.) + + Related software ================ diff --git a/documentation/index.rst b/documentation/index.rst index bfdd59f..ed306ba 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -13,7 +13,7 @@ Other pages (online) - `project page on SourceForge`_ - `SVN repository`_ - `Download Page`_ with releases -- This page, when viewed online is at http://pyserial.sf.net. +- This page, when viewed online, is at http://pyserial.sf.net. .. _`project page on SourceForge`: http://sourceforge.net/projects/pyserial/ .. _`SVN repository`: http://sourceforge.net/svn/?group_id=46487 |