diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c3aee25
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
diff --git a/.idea/aioserial.iml b/.idea/aioserial.iml
new file mode 100644
index 0000000..04f0e28
--- /dev/null
+++ b/.idea/aioserial.iml
@@ -0,0 +1,14 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
new file mode 100644
index 0000000..94bf861
--- /dev/null
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
new file mode 100644
index 0000000..ee04eea
--- /dev/null
+++ b/.idea/misc.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..321150d
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+
+
+
+
+
+
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..14e2f77
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..eecd29c
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,46 @@
+aioserial
+
+Copyright 2017-2018 Henry Chang
+
+--
+pySerial
+
+Copyright (c) 2001-2016 Chris Liechti
+All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the following
+ disclaimer in the documentation and/or other materials provided
+ with the distribution.
+
+ * Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---------------------------------------------------------------------------
+Note:
+Individual files contain the following tag instead of the full license text.
+
+ SPDX-License-Identifier: BSD-3-Clause
+
+This enables machine processing of license information based on the SPDX
+License Identifiers that are here available: http://spdx.org/licenses/
diff --git a/Pipfile b/Pipfile
new file mode 100644
index 0000000..58e08a4
--- /dev/null
+++ b/Pipfile
@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pyserial = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.7"
diff --git a/Pipfile.lock b/Pipfile.lock
new file mode 100644
index 0000000..39afb52
--- /dev/null
+++ b/Pipfile.lock
@@ -0,0 +1,41 @@
+{
+ "_meta": {
+ "hash": {
+ "sha256": "d75db13dc74fa9deff0950041bbb00232fadb5e528e5522eebbd12463e918346"
+ },
+ "host-environment-markers": {
+ "implementation_name": "cpython",
+ "implementation_version": "3.7.0",
+ "os_name": "posix",
+ "platform_machine": "x86_64",
+ "platform_python_implementation": "CPython",
+ "platform_release": "17.7.0",
+ "platform_system": "Darwin",
+ "platform_version": "Darwin Kernel Version 17.7.0: Thu Jun 21 22:53:14 PDT 2018; root:xnu-4570.71.2~1/RELEASE_X86_64",
+ "python_full_version": "3.7.0",
+ "python_version": "3.7",
+ "sys_platform": "darwin"
+ },
+ "pipfile-spec": 6,
+ "requires": {
+ "python_version": "3.7"
+ },
+ "sources": [
+ {
+ "name": "pypi",
+ "url": "https://pypi.python.org/simple",
+ "verify_ssl": true
+ }
+ ]
+ },
+ "default": {
+ "pyserial": {
+ "hashes": [
+ "sha256:e0770fadba80c31013896c7e6ef703f72e7834965954a78e71a3049488d4d7d8",
+ "sha256:6e2d401fdee0eab996cf734e67773a0143b932772ca8b42451440cfed942c627"
+ ],
+ "version": "==3.4"
+ }
+ },
+ "develop": {}
+}
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8afe6ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,124 @@
+# aioserial
+
+* [Quick start](#quick-start)
+ + [A simple serial port reader](#a-simple-serial-port-reader)
+* [API](#api)
+ + [AioSerial](#aioserial)
+ - [Constructor](#constructor)
+ - [Methods](#methods)
+ * [read_async](#read-async)
+ * [read_until_async](#read-until-async)
+ * [readinto_async](#readinto-async)
+ * [readline_async](#readline-async)
+ * [readlines_async](#readlines-async)
+ * [write_async](#write-async)
+ * [writelines_async](#writelines-async)
+ + [Other APIs](#other-apis)
+* [Why aioserial?](#why-aioserial-)
+
+A Python package that combines [asyncio](https://docs.python.org/3/library/asyncio.html) and [pySerial](https://github.com/pyserial/pyserial).
+
+## Quick start
+
+### A simple serial port reader
+
+```py
+import aioserial
+import asyncio
+
+
+async def read_and_print(aioserial_instance: aioserial.AioSerial):
+ while True:
+ print((await aioserial_instance.read_async()).decode(errors='ignore'), end='', flush=True)
+
+asyncio.run(read_and_print(aioserial.AioSerial(port='COM1')))
+```
+
+## API
+
+### AioSerial
+
+```py
+>>> import aioserial
+>>> import serial
+
+>>> isinstance(aioserial.AioSerial(), serial.Serial)
+True
+
+>>> issubclass(aioserial.AioSerial, serial.Serial)
+True
+
+>>> aioserial.Serial is serial.Serial
+True
+```
+
+#### Constructor
+
+```py
+aioserial_instance: aioserial.AioSerial = aioserial.AioSerial(
+ # ... same with what can be passed to serial.Serial ...,
+ loop: Optional[asyncio.AbstractEventLoop] = None)
+```
+
+#### Methods
+
+
+##### read_async
+
+```py
+bytes_read: bytes = \
+ await aioserial_instance.read_async(size: int = 1)
+```
+
+##### read_until_async
+
+```py
+at_most_certain_size_of_bytes_read: bytes = \
+ await aioserial_instance.read_until_async(
+ expected: bytes = aioserial.LF, size: Optional[int] = None)
+```
+
+##### readinto_async
+
+```py
+number_of_byte_read: int = \
+ await aioserial_instance.readinto_async(b: Union[array.array, bytearray])
+```
+
+##### readline_async
+
+```py
+a_line_of_at_most_certain_size_of_bytes_read: bytes = \
+ await aioserial_instance.readline_async(size: int = -1)
+```
+
+##### readlines_async
+
+```py
+lines_of_at_most_certain_size_of_bytes_read: bytes = \
+ await aioserial_instance.readlines_async(hint: int = -1)
+```
+
+##### write_async
+
+```py
+number_of_byte_like_data_written: int = \
+ await aioserial_instance.write_async(bytes_like_data)
+```
+
+##### writelines_async
+
+```py
+number_of_byte_like_data_in_the_given_list_written: int = \
+ await aioserial_instance.writelines_async(list_of_bytes_like_data)
+```
+
+### Other APIs
+
+All the other APIs in package [pySerial](https://github.com/pyserial/pyserial) are supported in [aioserial](https://github.com/changyuheng/aioserial) as [original](https://pyserial.readthedocs.io/).
+
+## Why aioserial?
+
+* Want to use an asyncio-based but not a (self-built) thread-based serial library.
+* [pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio) does [not support Windows](https://github.com/pyserial/pyserial-asyncio/issues/3).
+* APIs in all the other packages ([pySerial-asyncio](https://github.com/pyserial/pyserial-asyncio), [asyncserial](https://github.com/xvzf/asyncserial-py)) that target the same goal are not designed in high level.
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..3135a54
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,112 @@
+"""
+A setuptools based setup module.
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+import io
+import os
+import setuptools
+
+
+here: str = os.path.abspath(os.path.dirname(__file__))
+
+# Get the long description from the README file
+f: io.TextIOWrapper
+with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+ long_description = f.read()
+
+setuptools.setup(
+ name='aioserial',
+
+ # Versions should comply with PEP440. For a discussion on single-sourcing
+ # the version across setup.py and the project code, see
+ # https://packaging.python.org/en/latest/single_source_version.html
+ version='1.1.3',
+
+ description='An asynchronous serial port library of Python',
+ long_description=long_description,
+ long_description_content_type='text/markdown',
+
+ # The project's main homepage.
+ url='https://github.com/changyuheng/aioserial',
+
+ # Author details
+ author='Henry Chang',
+ author_email='mr.changyuheng@gmail.com',
+
+ # Choose your license
+ license='MPL-2.0',
+
+ # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+ classifiers=[
+ # How mature is this project? Common values are
+ # 3 - Alpha
+ # 4 - Beta
+ # 5 - Production/Stable
+ 'Development Status :: 5 - Production/Stable',
+
+ # Indicate who your project is intended for
+ 'Intended Audience :: Developers',
+ 'Topic :: Communications',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ 'Topic :: Terminals :: Serial',
+
+ # Pick your license as you wish (should match "license" above)
+ 'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
+
+ # Specify the Python versions you support here. In particular, ensure
+ # that you indicate whether you support Python 2, Python 3 or both.
+ 'Programming Language :: Python :: 3.6',
+ ],
+
+ # # What does your project relate to?
+ # keywords='sample setuptools development',
+
+ # You can just specify the packages manually here if your project is
+ # simple. Or you can use find_packages().
+ packages=setuptools.find_packages('src', exclude=['contrib', 'docs', 'tests']),
+ package_dir={'': 'src'},
+
+ # Alternatively, if you want to distribute just a my_module.py, uncomment
+ # this:
+ # py_modules=["my_module"],
+
+ # List run-time dependencies here. These will be installed by pip when
+ # your project is installed. For an analysis of "install_requires" vs pip's
+ # requirements files see:
+ # https://packaging.python.org/en/latest/requirements.html
+ install_requires=[
+ 'pyserial',
+ ],
+
+ python_requires='>=3.6',
+
+ # List additional groups of dependencies here (e.g. development
+ # dependencies). You can install these using the following syntax,
+ # for example:
+ # $ pip install -e .[dev,test]
+ extras_require={
+ 'dev': [],
+ 'test': [],
+ },
+
+ # If there are data files included in your packages that need to be
+ # installed, specify them here. If using Python 2.6 or less, then these
+ # have to be included in MANIFEST.in as well.
+ package_data={
+ },
+
+ # Although 'package_data' is the preferred approach, in some case you may
+ # need to place data files outside of your packages. See:
+ # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
+ # In this case, 'data_file' will be installed into '/my_data'
+ # data_files=[('my_data', ['data/data_file'])],
+
+ # To provide executable scripts, use entry points in preference to the
+ # "scripts" keyword. Entry points provide cross-platform support and allow
+ # pip to create the appropriate form of executable for the target platform.
+ entry_points={
+ },
+)
diff --git a/src/aioserial/__init__.py b/src/aioserial/__init__.py
new file mode 100644
index 0000000..c99c8cc
--- /dev/null
+++ b/src/aioserial/__init__.py
@@ -0,0 +1,11 @@
+# Copyright 2018 Henry Chang
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from serial import *
+
+from .aioserial import AioSerial
+
+protocol_handler_packages.append("aioserial")
diff --git a/src/aioserial/aioserial.py b/src/aioserial/aioserial.py
new file mode 100644
index 0000000..f114aba
--- /dev/null
+++ b/src/aioserial/aioserial.py
@@ -0,0 +1,108 @@
+# Copyright 2018 Henry Chang
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import array
+import asyncio
+import concurrent.futures
+import sys
+from typing import List, Optional, Union
+
+import serial
+
+
+class _AioSerialMixin(serial.SerialBase):
+ def __init__(self,
+ *args,
+ loop: Optional[asyncio.AbstractEventLoop] = None,
+ **kwargs):
+ super().__init__(*args, **kwargs)
+ self._loop: Optional[asyncio.AbstractEventLoop] = loop
+ self._read_executor = \
+ concurrent.futures.ThreadPoolExecutor(max_workers=1)
+ self._write_executor = \
+ concurrent.futures.ThreadPoolExecutor(max_workers=1)
+
+ @property
+ def loop(self) -> Optional[asyncio.AbstractEventLoop]:
+ return self._loop if self._loop else asyncio.get_running_loop() \
+ if sys.version_info >= (3, 7) else asyncio.get_event_loop()
+
+ @loop.setter
+ def loop(self, value: Optional[asyncio.AbstractEventLoop]):
+ self._loop = value
+
+ async def read_async(self, size: int = 1) -> bytes:
+ return await self.loop.run_in_executor(
+ self._read_executor, self.read, size)
+
+ async def read_until_async(
+ self,
+ expected: bytes = serial.LF,
+ size: Optional[int] = None) -> bytes:
+ return await self.loop.run_in_executor(
+ self._read_executor, self.read_until, expected, size)
+
+ async def readinto_async(self, b: Union[array.array, bytearray]):
+ return await self.loop.run_in_executor(
+ self._read_executor, self.readinto, b)
+
+ async def readline_async(self, size: int = -1) -> bytes:
+ return await self.loop.run_in_executor(
+ self._read_executor, self.readline, size)
+
+ async def readlines_async(self, hint: int = -1) -> List[bytes]:
+ return await self.loop.run_in_executor(
+ self._read_executor, self.readlines, hint)
+
+ async def write_async(
+ self, data: Union[bytearray, bytes, memoryview]) -> int:
+ return await self.loop.run_in_executor(
+ self._write_executor, self.write, data)
+
+ async def writelines_async(
+ self, lines: List[Union[bytearray, bytes, memoryview]]) -> int:
+ return await self.loop.run_in_executor(
+ self._write_executor, self.writelines, lines)
+
+ def close(self) -> None:
+ self._read_executor.shutdown(wait=False)
+ self._write_executor.shutdown(wait=False)
+ super().close()
+
+
+class AioSerial(_AioSerialMixin, serial.Serial):
+
+ def __init__(
+ self,
+ port: Optional[str] = None,
+ baudrate: int = 9600,
+ bytesize: int = serial.EIGHTBITS,
+ parity: str = serial.PARITY_NONE,
+ stopbits: Union[float, int] = serial.STOPBITS_ONE,
+ timeout: Optional[float] = None,
+ xonxoff: bool = False,
+ rtscts: bool = False,
+ write_timeout: Optional[float] = None,
+ dsrdtr: bool = False,
+ inter_byte_timeout: Optional[float] = None,
+ exclusive: Optional[bool] = None,
+ loop: Optional[asyncio.AbstractEventLoop] = None,
+ **kwargs):
+ super().__init__(
+ port=port,
+ baudrate=baudrate,
+ bytesize=bytesize,
+ parity=parity,
+ stopbits=stopbits,
+ timeout=timeout,
+ xonxoff=xonxoff,
+ rtscts=rtscts,
+ write_timeout=write_timeout,
+ dsrdtr=dsrdtr,
+ inter_byte_timeout=inter_byte_timeout,
+ exclusive=exclusive,
+ loop=loop,
+ **kwargs)
diff --git a/src/aioserial/protocol_aioserial.py b/src/aioserial/protocol_aioserial.py
new file mode 100644
index 0000000..3b56202
--- /dev/null
+++ b/src/aioserial/protocol_aioserial.py
@@ -0,0 +1,68 @@
+
+import aioserial
+
+try:
+ import urlparse
+except ImportError:
+ import urllib.parse as urlparse
+
+
+def serial_class_for_url(url):
+ """extract host and port from an URL string"""
+ parts = urlparse.urlsplit(url)
+ if parts.scheme != 'aioserial':
+ raise aioserial.SerialException(
+ 'expected a string in the form "aioserial://port[?handler=value[&option=[value]]]": '
+ 'not starting with aioserial:// ({!r})'.format(parts.scheme))
+
+ handler_cls_name = None
+ try:
+ for option, values in urlparse.parse_qs(parts.query, True).items():
+ if option == 'handler':
+ handler_cls_name = values[0]
+ except ValueError as e:
+ raise aioserial.SerialException(
+ 'expected a string in the form '
+ '"aioserial://port[?handler=value[&option=[value]]]": {!r}'.format(e))
+
+ if handler_cls_name:
+ import importlib
+
+ #
+ # Copied (and modified) from serial.serial_for_url
+ #
+ # Unfortunately there is no API for getting the class,
+ # only an instance of a serial.Serial.
+ #
+ protocol = handler_cls_name
+ module_name = '.protocol_{}'.format(protocol)
+ for package_name in aioserial.protocol_handler_packages:
+ try:
+ importlib.import_module(package_name)
+ handler_module = importlib.import_module(module_name,
+ package_name)
+ except ImportError:
+ continue
+ else:
+ url = url.replace("aioserial://", protocol + "://"). \
+ replace("handler=" + protocol, "")
+
+ if hasattr(handler_module, 'serial_class_for_url'):
+ url, cls = handler_module.serial_class_for_url(url)
+ else:
+ cls = handler_module.Serial
+ break
+ else:
+ raise ValueError(
+ 'invalid URL, protocol {!r} not known'.format(protocol))
+
+ cls = type(
+ "AioSerial{}".format(handler_cls_name.capitalize()),
+ (aioserial.aioserial._AioSerialMixin, cls),
+ {}
+ )
+ else:
+ cls = aioserial.AioSerial
+ url = ''.join([parts.netloc, parts.path])
+
+ return url, cls