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
withSerial port defaultSerialSettings{ commSpeed = CS2400 } $ \s -> do
  send s $ B.pack "AT\r"
  recv s 10 >>= print

Alternatively, use handles to perform IO:

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

Types

data CommSpeed

Supported baudrates

Constructors

CS110

CS300

CS600

CS1200

CS2400

CS4800

CS9600

CS19200

CS38400

CS57600

CS115200

Instances

Bounded CommSpeed

Defined in System.Hardware.Serialport.Types

Methods

minBound :: CommSpeed

maxBound :: CommSpeed

Eq CommSpeed

Defined in System.Hardware.Serialport.Types

Methods

(==) :: CommSpeed -> CommSpeed -> Bool

(/=) :: CommSpeed -> CommSpeed -> Bool

Read CommSpeed

Defined in System.Hardware.Serialport.Types

Methods

readsPrec :: Int -> ReadS CommSpeed

readList :: ReadS [CommSpeed]

readPrec :: ReadPrec CommSpeed

readListPrec :: ReadPrec [CommSpeed]

Show CommSpeed

Defined in System.Hardware.Serialport.Types

Methods

showsPrec :: Int -> CommSpeed -> ShowS

show :: CommSpeed -> String

showList :: [CommSpeed] -> ShowS

data StopBits

Constructors

One

Two

Instances

Bounded StopBits

Defined in System.Hardware.Serialport.Types

Methods

minBound :: StopBits

maxBound :: StopBits

Eq StopBits

Defined in System.Hardware.Serialport.Types

Methods

(==) :: StopBits -> StopBits -> Bool

(/=) :: StopBits -> StopBits -> Bool

Read StopBits

Defined in System.Hardware.Serialport.Types

Methods

readsPrec :: Int -> ReadS StopBits

readList :: ReadS [StopBits]

readPrec :: ReadPrec StopBits

readListPrec :: ReadPrec [StopBits]

Show StopBits

Defined in System.Hardware.Serialport.Types

Methods

showsPrec :: Int -> StopBits -> ShowS

show :: StopBits -> String

showList :: [StopBits] -> ShowS

data Parity

Constructors

Even

Odd

NoParity

Instances

Eq Parity

Defined in System.Hardware.Serialport.Types

Methods

(==) :: Parity -> Parity -> Bool

(/=) :: Parity -> Parity -> Bool

Read Parity

Defined in System.Hardware.Serialport.Types

Methods

readsPrec :: Int -> ReadS Parity

readList :: ReadS [Parity]

readPrec :: ReadPrec Parity

readListPrec :: ReadPrec [Parity]

Show Parity

Defined in System.Hardware.Serialport.Types

Methods

showsPrec :: Int -> Parity -> ShowS

show :: Parity -> String

showList :: [Parity] -> ShowS

data FlowControl

Constructors

Software

NoFlowControl

Instances

Eq FlowControl

Defined in System.Hardware.Serialport.Types

Methods

(==) :: FlowControl -> FlowControl -> Bool

(/=) :: FlowControl -> FlowControl -> Bool

Read FlowControl

Defined in System.Hardware.Serialport.Types

Methods

readsPrec :: Int -> ReadS FlowControl

readList :: ReadS [FlowControl]

readPrec :: ReadPrec FlowControl

readListPrec :: ReadPrec [FlowControl]

Show FlowControl

Defined in System.Hardware.Serialport.Types

Methods

showsPrec :: Int -> FlowControl -> ShowS

show :: FlowControl -> String

showList :: [FlowControl] -> ShowS

data SerialPort

Instances

Show SerialPort

Defined in System.Hardware.Serialport.Posix

Methods

showsPrec :: Int -> SerialPort -> ShowS

show :: SerialPort -> String

showList :: [SerialPort] -> ShowS

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

Instances

Eq SerialPortSettings

Defined in System.Hardware.Serialport.Types

Methods

(==) :: SerialPortSettings -> SerialPortSettings -> Bool

(/=) :: SerialPortSettings -> SerialPortSettings -> Bool

Read SerialPortSettings

Defined in System.Hardware.Serialport.Types

Methods

readsPrec :: Int -> ReadS SerialPortSettings

readList :: ReadS [SerialPortSettings]

readPrec :: ReadPrec SerialPortSettings

readListPrec :: ReadPrec [SerialPortSettings]

Show SerialPortSettings

Defined in System.Hardware.Serialport.Types

Methods

showsPrec :: Int -> SerialPortSettings -> ShowS

show :: SerialPortSettings -> String

showList :: [SerialPortSettings] -> ShowS

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 :: FilePath -> SerialPortSettings -> (SerialPort -> IO a) -> IO a

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

hWithSerial :: FilePath -> SerialPortSettings -> (Handle -> IO a) -> IO a

Like withSerial but using Handle

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