Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.58 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.58 KB

SerialPorts

Build Status

SerialPorts SerialPorts SerialPorts

SerialPorts.jl lets you work with devices over serial communication with Julia. It is designed to mimic regular file IO as in the Base Julia library.

This package requires PySerial, which is used through PyCall. Conda is used as a fallback so cross-platform installation is simple. Overtime, one of the long term objectives should be to rewrite this in Julia for better portability, installation, and performance.

Documentation

A SerialPort can be treated like any other IO stream in Julia.

A brief example:

using SerialPorts
s = SerialPort("/dev/ttyACM1", 250000)
write(s, "Hello World!\n")
close(s)

open, close, read, write, nb_available, readavailable, are all defined for SerialPort.

In order to see the attached serial devices, use list_serialports().

The Arduino submodule provides functionality for manipulating Arduinos over serial. SerialPorts.Arduino.reset(s::SerialPort) will reset an Arduino.

License

Available under the CC0 1.0 Universal Public Domain Dedication. See: LICENSE.md.