From 77e8c970b467726dc79f0277bf3e3c0a2029c353 Mon Sep 17 00:00:00 2001 From: Euan Torano Date: Sun, 12 Feb 2017 16:33:47 +0000 Subject: [PATCH] Rename lib to `libserialport` Signed-off-by: Euan Torano --- README.md | 12 +- docs/{serialport.html => libserialport.html} | 138 +++++++++--------- examples/list_serial_ports.nim | 2 +- examples/read_write.nim | 2 +- serialport.nimble => libserialport.nimble | 2 +- src/{serialport.nim => libserialport.nim} | 2 +- .../private/common.nim | 0 .../private/list_serialports.nim | 0 .../private/list_serialports/linux.nim | 0 .../private/list_serialports/mac.nim | 0 .../private/list_serialports/posix.nim | 0 .../private/list_serialports/windows.nim | 0 .../private/serial_posix.nim | 0 .../private/serial_windows.nim | 0 14 files changed, 80 insertions(+), 78 deletions(-) rename docs/{serialport.html => libserialport.html} (93%) mode change 100755 => 100644 rename serialport.nimble => libserialport.nimble (78%) rename src/{serialport.nim => libserialport.nim} (98%) rename src/{serialport => libserialport}/private/common.nim (100%) rename src/{serialport => libserialport}/private/list_serialports.nim (100%) rename src/{serialport => libserialport}/private/list_serialports/linux.nim (100%) rename src/{serialport => libserialport}/private/list_serialports/mac.nim (100%) rename src/{serialport => libserialport}/private/list_serialports/posix.nim (100%) rename src/{serialport => libserialport}/private/list_serialports/windows.nim (100%) rename src/{serialport => libserialport}/private/serial_posix.nim (100%) rename src/{serialport => libserialport}/private/serial_windows.nim (100%) diff --git a/README.md b/README.md index d3ceedb..63e98ab 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# serialport.nim +# libserialport.nim A library to work with serial ports using pure Nim. ## Installation ``` -nimble install serialport +nimble install libserialport ``` ## Usage @@ -13,12 +13,13 @@ nimble install serialport ### Reading from a serial port, into a pre-defined buffer: ```nim -import serialport +import libserialport let port = openSerialPort("COM3", baudRate=BaudRate.BR9600, dataBits=DataBits.eight, stopBits=StopBits.one, parity=Parity.none, useHardwareFlowControl=true, useSoftwareFlowControl=false) +defer: port.close() ## The baud rate, data bits, stop bits and parity default to 9600, 8, 1 and none - in that order @@ -44,12 +45,13 @@ echo "Read ", numRead, " bytes from the serial port: ", readBuffer ### Writing to a serial port: ```nim -import serialport +import libserialport let port = openSerialPort("COM3", baudRate=BaudRate.BR9600, dataBits=DataBits.eight, stopBits=StopBits.one, parity=Parity.none, useHardwareFlowControl=true, useSoftwareFlowControl=false) +defer: port.close() ## The baud rate, data bits, stop bits and parity default to 9600, 8, 1 and none - in that order @@ -76,7 +78,7 @@ port.write(newDataToSend, timeout=5) # Wait for 5 seconds. If the data isn't tra ### Listing serial ports available on the system ```nim -import serialport +import libserialport for p in listSerialPorts(): echo "Found serial port: ", p diff --git a/docs/serialport.html b/docs/libserialport.html old mode 100755 new mode 100644 similarity index 93% rename from docs/serialport.html rename to docs/libserialport.html index fe8dd2b..454f309 --- a/docs/serialport.html +++ b/docs/libserialport.html @@ -14,7 +14,7 @@ -Module serialport +Module libserialport