8000 GitHub - rondou/aioserial: pyserial-asyncio for humans.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

rondou/aioserial

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

aioserial

Python asynchronous serial module for combining asyncio and pyserial.

Quick start

Constructor

import aioserial

aioserial_instance: aioserial.AioSerial = aioserial.AioSerial(
    SAME_WITH_PYSERIAL...,
    loop: Optional[asyncio.AbstractEventLoop] = None)

Asynchronously Read

read_async

bytes_read: bytes = \
    await aioserial_instance.read_async(size: int = 1)

read_until_async

import serial

at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.read_until_async(
        expected: bytes = serial.LF, size: Optional[int] = None)

readinto_async

import array

 number_of_byte_read: int = \
     await aioserial_instance.readinto_async(b: Union[array.array, bytearray])

readline_async

a_line_of_at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.readline_async(size: int = -1)

readlines_async

lines_of_at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.readlines_async(hint: int = -1)

Asynchronously Write

write_async

number_of_byte_like_data_written: int = \
    await aioserial_instance.write_async(bytes_like_data)

writelines_async

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 serial.Serial are supported as original.

About

pyserial-asyncio for humans.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%
0