System.Hardware.Serialport

This module provides the serial port interface.

 import qualified Data.ByteString.Char8 as B
 import System.Hardware.Serialport
 let port = "COM3"          -- Windows
 let port = "/dev/ttyUSB0"  -- Linux
 s <- openSerial port defaultSerialSettings { commSpeed = CS2400 }
 send s $ B.pack "AT\r"
 recv s 10 >>= print
 closeSerial s

Or use the experimental interface with standard handles:

 import System.IO
 import System.Hardware.Serialport
 let port = "COM3"           -- Windows
 let port = "/dev/ttyUSB0"   -- Linux
 h <- hOpenSerial port defaultSerialSettings
 hPutStr h "AT\r"
 hGetLine h >>= print
 hClose h

Types

data CommSpeed

Supported baudrates

Constructors

CS110

CS300

CS600

CS1200

CS2400

CS4800

CS9600

CS19200

CS38400

CS57600

CS115200

Instances

Bounded CommSpeed

Eq CommSpeed

Show CommSpeed

data StopBits

Constructors

One

Two

Instances

Bounded StopBits

Eq StopBits

Show StopBits

data Parity

Constructors

Even

Odd

NoParity

Instances

Eq Parity

Show Parity

data FlowControl

Constructors

Software

NoFlowControl

Instances

Eq FlowControl

Show FlowControl

data SerialPort

Instances

Typeable SerialPort

BufferedIO SerialPort

RawIO SerialPort

IODevice SerialPort

Configure port

You don't need the get or set functions, they are used by openSerial

data SerialPortSettings

Constructors

SerialPortSettings

Fields

commSpeed :: CommSpeed

baudrate

bitsPerWord :: Word8

Number of bits in a word

stopb :: StopBits

Number of stop bits

parity :: Parity

Type of parity

flowControl :: FlowControl

Type of flowcontrol

timeout :: Int

Timeout when receiving a char in tenth of seconds

defaultSerialSettings :: SerialPortSettings

Most commonly used configuration

• 9600 baud
• 8 data bits
• 1 stop bit
• no parity
• no flow control
• 0.1 second receive timeout

setSerialSettings

Arguments

:: SerialPort

The currently opened serial port

-> SerialPortSettings

The new settings

-> IO SerialPort

New serial port

Configure the serial port

getSerialSettings :: SerialPort -> SerialPortSettings

Get configuration from serial port

Serial methods

Device

hOpenSerial :: FilePath -> SerialPortSettings -> IO Handle

Open and configure a serial port returning a standard Handle

openSerial

Arguments

:: FilePath

Serial port, such as /dev/ttyS0 or /dev/ttyUSB0

-> SerialPortSettings

-> IO SerialPort

Open and configure a serial port

closeSerial :: SerialPort -> IO ()

Close the serial port

withSerial :: String -> SerialPortSettings -> (SerialPort -> IO a) -> IO a

Safer device function, so you don't forget to close the device

Sending & receiving

send

Arguments

:: SerialPort

-> ByteString

-> IO Int

Number of bytes actually sent

Send bytes

recv :: SerialPort -> Int -> IO ByteString

Receive bytes, given the maximum number

flush :: SerialPort -> IO ()

Flush buffers

Line control

setDTR :: SerialPort -> Bool -> IO ()

Set the Data Terminal Ready level

setRTS :: SerialPort -> Bool -> IO ()

Set the Ready to send level