CommAPI: Difference between revisions
Jump to navigation
Jump to search
m (→History: add link) |
(add changelog, roudmap, support notice, link to examples) |
||
| Line 1: | Line 1: | ||
CommAPI translates the communications functions of Windows API to AutoIt functions. | CommAPI translates the communications functions of Windows API to AutoIt functions. | ||
== | == Overview == | ||
=== Features === | |||
== Features == | |||
* No need to install DLL's | * No need to install DLL's | ||
* Using Windows API calls (kernel32.dll) | * Using Windows API calls (kernel32.dll) | ||
| Line 18: | Line 12: | ||
* A lot of additional utility and helper functions | * A lot of additional utility and helper functions | ||
== History == | === Scripts === | ||
* [[CommAPIStructures.au3]] | |||
* [[CommAPI.au3]] | |||
* [[CommAPIHelper.au3]] | |||
* [[CommUtilities.au3]] | |||
* [[CommInterface.au3]] | |||
=== Examples === | |||
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum]. | |||
== Background == | |||
=== History === | |||
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)] | * 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)] | ||
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)] | * 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)] | ||
| Line 26: | Line 31: | ||
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3] | * 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3] | ||
== Resources == | === Changelog === | ||
* 2014-01-23 [[CommUtilities.au3]] - Update method _CommAPI_CreateModeString | |||
* 2014-02-03 [[CommInterface.au3]] - Change timeout handling (Attention: not backward compatible) | |||
=== Roadmap === | |||
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs. | |||
=== Support === | |||
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread]. | |||
=== Resources === | |||
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions] | * [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions] | ||
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT] | * [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT] | ||
Revision as of 13:33, 3 February 2014
CommAPI translates the communications functions of Windows API to AutoIt functions.
Overview
Features
- No need to install DLL's
- Using Windows API calls (kernel32.dll)
- Possibility of serial communication (serial port, COM port, RS-232)
- Possibility of parallel communication (parallel port, LPT port)
- No use of global variables
- Uniform namespace _CommAPI_XXX
- Modular organization into files
- A lot of additional utility and helper functions
Scripts
Examples
CommAPI Examples shows you some examples. Mayby you could find more examples in forum.
Background
History
- 2008-09-12 Creation of cfx.au3 (V1.0)
- 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 (V2.0)
- 2011-02-28 Update V2.0to V2.1
- 2011-04-27 Update V2.1 to V2.2 (german forum)
- 2013-07-10 Modify V2.1 to V2.1mod
- 2013-10-24 Creation of CommAPI.au3
Changelog
- 2014-01-23 CommUtilities.au3 - Update method _CommAPI_CreateModeString
- 2014-02-03 CommInterface.au3 - Change timeout handling (Attention: not backward compatible)
Roadmap
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.
Support
There is no official support. Try to get help from community in the official forum. Here you can find the main thread.
Resources
- MSDN Library of communications functions
- WIN32API.TXT
- cfxUDF.au3 (see section above)
- GetCOMPorts (german forum)
- ParseCommState
Functions
Implemented API functions
- BuildCommDCB
- BuildCommDCBAndTimeouts
- ClearCommBreak
- ClearCommError
- EscapeCommFunction
- GetCommMask
- GetCommModemStatus
- GetCommProperties
- GetCommState
- GetCommTimeouts
- PurgeComm
- SetCommBreak
- SetCommMask
- SetCommState
- SetCommTimeouts
- SetupComm
- TransmitCommChar
- WaitCommEvent
Unimplemented API functions
- CommConfigDialog
- GetCommConfig
- GetDefaultCommConfig
- SetCommConfig
- SetDefaultCommConfig
API helper functions
- ChangeCommStateElement
- ChangeCommTimeoutsElement
- GetCommStateElement
- GetCommTimeoutsElement
- IsOnCTS
- IsOnDCD
- IsOnDSR
- IsOnRI
- SetCommStateElement
- SetCommTimeoutsElement
- SetOnDTR
- SetOnRTS
Utility functions
- CommStateToString
- CommTimeoutsToString
- CreateModeString
- GetCOMPorts
Interface functions
- ClosePort
- OpenCOMPort
- OpenPort
- ReceiveData
- TransmitData