System.FTDI

Devices

data Device

A representation of an FTDI device.

data ChipType

The type of FTDI chip in a Device. The capabilities of a device depend on its chip type.

Constructors

ChipType_AM

ChipType_BM

ChipType_2232C

ChipType_R

ChipType_2232H

ChipType_4232H

Instances

Enum ChipType

Defined in System.FTDI.Internal

Methods

succ :: ChipType -> ChipType

pred :: ChipType -> ChipType

toEnum :: Int -> ChipType

fromEnum :: ChipType -> Int

enumFrom :: ChipType -> [ChipType]

enumFromThen :: ChipType -> ChipType -> [ChipType]

enumFromTo :: ChipType -> ChipType -> [ChipType]

enumFromThenTo :: ChipType -> ChipType -> ChipType -> [ChipType]

Eq ChipType

Defined in System.FTDI.Internal

Methods

(==) :: ChipType -> ChipType -> Bool

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

Data ChipType

Defined in System.FTDI.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChipType -> c ChipType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChipType

toConstr :: ChipType -> Constr

dataTypeOf :: ChipType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChipType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChipType)

gmapT :: (forall b. Data b => b -> b) -> ChipType -> ChipType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChipType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChipType -> r

gmapQ :: (forall d. Data d => d -> u) -> ChipType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChipType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChipType -> m ChipType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChipType -> m ChipType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChipType -> m ChipType

Ord ChipType

Defined in System.FTDI.Internal

Methods

compare :: ChipType -> ChipType -> Ordering

(<) :: ChipType -> ChipType -> Bool

(<=) :: ChipType -> ChipType -> Bool

(>) :: ChipType -> ChipType -> Bool

(>=) :: ChipType -> ChipType -> Bool

max :: ChipType -> ChipType -> ChipType

min :: ChipType -> ChipType -> ChipType

Show ChipType

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> ChipType -> ShowS

show :: ChipType -> String

showList :: [ChipType] -> ShowS

Generic ChipType

Defined in System.FTDI.Internal

Associated Types

type Rep ChipType :: Type -> Type

Methods

from :: ChipType -> Rep ChipType x

to :: Rep ChipType x -> ChipType

type Rep ChipType

Defined in System.FTDI.Internal

type Rep ChipType = D1 ('MetaData "ChipType" "System.FTDI.Internal" "ftdi-0.3.0.1-inplace" 'False) ((C1 ('MetaCons "ChipType_AM" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ChipType_BM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChipType_2232C" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ChipType_R" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ChipType_2232H" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChipType_4232H" 'PrefixI 'False) (U1 :: Type -> Type))))

getChipType :: Device -> ChipType

setChipType :: Device -> ChipType -> Device

fromUSBDevice

Arguments

:: Device

USB device

-> ChipType

-> IO Device

FTDI device

Promote a USB device to an FTDI device. You are responsible for supplying the correct USB device and specifying the correct chip type. There is no failsafe way to automatically determine whether a random USB device is an actual FTDI device.

guessChipType :: DeviceDesc -> Maybe ChipType

Tries to guess the type of the FTDI chip by looking at the USB device release number of a device's descriptor. Each FTDI chip uses a specific release number to indicate its type.

Interfaces

data Interface

A device interface. You can imagine an interface as a port or a communication channel. Some devices support communication over multiple interfaces at the same time.

Constructors

Interface_A

Interface_B

Interface_C

Interface_D

Instances

Enum Interface

Defined in System.FTDI.Internal

Methods

succ :: Interface -> Interface

pred :: Interface -> Interface

toEnum :: Int -> Interface

fromEnum :: Interface -> Int

enumFrom :: Interface -> [Interface]

enumFromThen :: Interface -> Interface -> [Interface]

enumFromTo :: Interface -> Interface -> [Interface]

enumFromThenTo :: Interface -> Interface -> Interface -> [Interface]

Eq Interface

Defined in System.FTDI.Internal

Methods

(==) :: Interface -> Interface -> Bool

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

Data Interface

Defined in System.FTDI.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Interface -> c Interface

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Interface

toConstr :: Interface -> Constr

dataTypeOf :: Interface -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Interface)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Interface)

gmapT :: (forall b. Data b => b -> b) -> Interface -> Interface

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Interface -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Interface -> r

gmapQ :: (forall d. Data d => d -> u) -> Interface -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Interface -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Interface -> m Interface

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Interface -> m Interface

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Interface -> m Interface

Ord Interface

Defined in System.FTDI.Internal

Methods

compare :: Interface -> Interface -> Ordering

(<) :: Interface -> Interface -> Bool

(<=) :: Interface -> Interface -> Bool

(>) :: Interface -> Interface -> Bool

(>=) :: Interface -> Interface -> Bool

max :: Interface -> Interface -> Interface

min :: Interface -> Interface -> Interface

Show Interface

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> Interface -> ShowS

show :: Interface -> String

showList :: [Interface] -> ShowS

Device handles

data DeviceHandle

You need a handle in order to communicate with a Device.

resetUSB :: DeviceHandle -> IO ()

Perform a USB device reset.

getTimeout :: DeviceHandle -> Int

Returns the USB timeout associated with a handle.

setTimeout :: DeviceHandle -> Int -> DeviceHandle

Modifies the USB timeout associated with a handle.

openDevice :: Device -> IO DeviceHandle

Open a device handle to enable communication. Only use this if you can't use withDeviceHandle for some reason.

closeDevice :: DeviceHandle -> IO ()

Release a device handle.

withDeviceHandle :: Device -> (DeviceHandle -> IO α) -> IO α

The recommended way to acquire a handle. Ensures that the handle is released when the monadic computation is completed. Even, or especially, when an exception is thrown.

Interface handles

data InterfaceHandle

getDeviceHandle :: InterfaceHandle -> DeviceHandle

getInterface :: InterfaceHandle -> Interface

openInterface :: DeviceHandle -> Interface -> IO InterfaceHandle

closeInterface :: InterfaceHandle -> IO ()

withInterfaceHandle :: DeviceHandle -> Interface -> (InterfaceHandle -> IO α) -> IO α

Kernel drivers

withDetachedKernelDriver :: DeviceHandle -> Interface -> IO a -> IO a

Data transfer

data ChunkedReaderT m α

Instances

MonadTrans ChunkedReaderT

Defined in System.FTDI.Internal

Methods

lift :: Monad m => m a -> ChunkedReaderT m a

Monad m => Monad (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

(>>=) :: ChunkedReaderT m a -> (a -> ChunkedReaderT m b) -> ChunkedReaderT m b

(>>) :: ChunkedReaderT m a -> ChunkedReaderT m b -> ChunkedReaderT m b

return :: a -> ChunkedReaderT m a

Functor m => Functor (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

fmap :: (a -> b) -> ChunkedReaderT m a -> ChunkedReaderT m b

(<$) :: a -> ChunkedReaderT m b -> ChunkedReaderT m a

MonadFix m => MonadFix (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

mfix :: (a -> ChunkedReaderT m a) -> ChunkedReaderT m a

Monad m => Applicative (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

pure :: a -> ChunkedReaderT m a

(<*>) :: ChunkedReaderT m (a -> b) -> ChunkedReaderT m a -> ChunkedReaderT m b

liftA2 :: (a -> b -> c) -> ChunkedReaderT m a -> ChunkedReaderT m b -> ChunkedReaderT m c

(*>) :: ChunkedReaderT m a -> ChunkedReaderT m b -> ChunkedReaderT m b

(<*) :: ChunkedReaderT m a -> ChunkedReaderT m b -> ChunkedReaderT m a

MonadIO m => MonadIO (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

liftIO :: IO a -> ChunkedReaderT m a

MonadPlus m => Alternative (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

empty :: ChunkedReaderT m a

(<|>) :: ChunkedReaderT m a -> ChunkedReaderT m a -> ChunkedReaderT m a

some :: ChunkedReaderT m a -> ChunkedReaderT m [a]

many :: ChunkedReaderT m a -> ChunkedReaderT m [a]

MonadPlus m => MonadPlus (ChunkedReaderT m)

Defined in System.FTDI.Internal

Methods

mzero :: ChunkedReaderT m a

mplus :: ChunkedReaderT m a -> ChunkedReaderT m a -> ChunkedReaderT m a

runChunkedReaderT :: ChunkedReaderT m α -> ByteString -> m (α, ByteString)

Run the ChunkedReaderT given an initial state.

The initial state represents excess bytes carried over from a previous run. When invoking runChunkedReaderT for the first time you can safely pass the empty bytestring as the initial state.

A contrived example showing how you can manually thread the excess bytes through subsequent invocations of runChunkedReaderT:

  example ∷ InterfaceHandle → IO ()
  example ifHnd = do
    (packets1, rest1) ← runChunkedReaderT (readData ifHnd (return False) 400) empty
    print $ concat packets1
    (packets2, rest2) ← runChunkedReaderT (readData ifHnd (return False) 200) rest1
    print $ concat packets2

However, it is much easier to let ChunkedReaderTs monad instance handle the plumbing:

  example ∷ InterfaceHandle → IO ()
  example ifHnd =
    let reader = do packets1 ← readData ifHnd (return False) 400
                    liftIO $ print $ concat packets1
                    packets2 ← readData ifHnd (return False) 200
                    liftIO $ print $ concat packets1
    in runChunkedReaderT reader empty

readData

Arguments

:: forall m. MonadIO m

=> InterfaceHandle

-> m Bool

Check stop action

-> Int

Number of bytes to read

-> ChunkedReaderT m [ByteString]

Reads data from the given FTDI interface by performing bulk reads.

This function produces an action in the ChunkedReaderT monad that will read exactly the requested number of bytes unless it is explicitly asked to stop early. Executing the readData action will block until either:

• All data are read
• The given checkStop action returns True

The result value is a list of chunks, represented as ByteStrings. This representation was choosen for efficiency reasons.

Data are read in packets. The function may choose to request more than needed in order to get the highest possible bandwidth. The excess of bytes is kept as the state of the ChunkedReaderT monad. A subsequent invocation of readData will first return bytes from the stored state before requesting more from the device itself. A consequence of this behaviour is that even when you request 100 bytes the function will actually request 512 bytes (depending on the packet size) and block until all 512 bytes are read! There is no workaround since requesting less bytes than the packet size is an error.

USB timeouts will not interrupt readData. In case of a timeout readData will simply resume reading data. A small USB timeout can degrade performance.

The FTDI latency timer can cause poor performance. If the FTDI chip can't fill a packet before the latency timer fires it is forced to send an incomplete packet. This will cause a stream of tiny packets instead of a few large packets. Performance will suffer horribly, but the request will still be completed.

If you need to make a lot of small requests then a small latency can actually improve performance.

Modem status bytes are filtered from the result. Every packet sent by the FTDI chip contains 2 modem status bytes. They are not part of the data and do not count for the number of bytes read. They will not appear in the result.

Example:

  -- Read 100 data bytes from ifHnd
  (packets, rest) ← runChunkedReaderT (readData ifHnd (return False) 100) empty

Low level bulk transfers

These are low-level functions and as such they ignores things like:

• Max packet size
• Latency timer
• Modem status bytes

USB timeouts are not ignored, but they will prevent the request from being completed.

readBulk

Arguments

:: InterfaceHandle

-> Int

Number of bytes to read

-> IO (ByteString, Status)

Perform a bulk read.

Returns the bytes that where read (in the form of a ByteString) and a flag which indicates whether a timeout occured during the request.

writeBulk

Arguments

:: InterfaceHandle

-> ByteString

Data to be written

-> IO (Int, Status)

Perform a bulk write.

Returns the number of bytes that where written and a flag which indicates whether a timeout occured during the request.

Control requests

reset :: InterfaceHandle -> IO ()

Reset the FTDI device.

purgeReadBuffer :: InterfaceHandle -> IO ()

Clear the on-chip read buffer.

purgeWriteBuffer :: InterfaceHandle -> IO ()

Clear the on-chip write buffer.

getLatencyTimer :: InterfaceHandle -> IO Word8

Returns the current value of the FTDI latency timer.

setLatencyTimer :: InterfaceHandle -> Word8 -> IO ()

Set the FTDI latency timer. The latency is the amount of milliseconds after which the FTDI chip will send a packet regardless of the number of bytes in the packet.

data BitMode

MPSSE bitbang modes

Constructors

BitMode_Reset

Switch off bitbang mode, back to regular serial/FIFO.

BitMode_BitBang

Classical asynchronous bitbang mode, introduced with B-type chips.

BitMode_MPSSE

Multi-Protocol Synchronous Serial Engine, available on 2232x chips.

BitMode_SyncBitBang

Synchronous Bit-Bang Mode, available on 2232x and R-type chips.

BitMode_MCU

MCU Host Bus Emulation Mode, available on 2232x chips. CPU-style fifo mode gets set via EEPROM.

BitMode_Opto

Fast Opto-Isolated Serial Interface Mode, available on 2232x chips.

BitMode_CBus

Bit-Bang on CBus pins of R-type chips, configure in EEPROM before use.

BitMode_SyncFIFO

Single Channel Synchronous FIFO Mode, available on 2232H chips.

Instances

Eq BitMode

Defined in System.FTDI.Internal

Methods

(==) :: BitMode -> BitMode -> Bool

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

Data BitMode

Defined in System.FTDI.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BitMode -> c BitMode

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BitMode

toConstr :: BitMode -> Constr

dataTypeOf :: BitMode -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BitMode)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BitMode)

gmapT :: (forall b. Data b => b -> b) -> BitMode -> BitMode

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BitMode -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BitMode -> r

gmapQ :: (forall d. Data d => d -> u) -> BitMode -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BitMode -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BitMode -> m BitMode

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BitMode -> m BitMode

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BitMode -> m BitMode

Ord BitMode

Defined in System.FTDI.Internal

Methods

compare :: BitMode -> BitMode -> Ordering

(<) :: BitMode -> BitMode -> Bool

(<=) :: BitMode -> BitMode -> Bool

(>) :: BitMode -> BitMode -> Bool

(>=) :: BitMode -> BitMode -> Bool

max :: BitMode -> BitMode -> BitMode

min :: BitMode -> BitMode -> BitMode

Show BitMode

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> BitMode -> ShowS

show :: BitMode -> String

showList :: [BitMode] -> ShowS

setBitMode :: InterfaceHandle -> Word8 -> BitMode -> IO ()

The bitmode controls the method of communication.

Line properties

data Parity

Constructors

Parity_Odd

The parity bit is set to one if the number of ones in a given set of bits is even (making the total number of ones, including the parity bit, odd).

Parity_Even

The parity bit is set to one if the number of ones in a given set of bits is odd (making the total number of ones, including the parity bit, even).

Parity_Mark

The parity bit is always 1.

Parity_Space

The parity bit is always 0.

Instances

Enum Parity

Defined in System.FTDI.Internal

Methods

succ :: Parity -> Parity

pred :: Parity -> Parity

toEnum :: Int -> Parity

fromEnum :: Parity -> Int

enumFrom :: Parity -> [Parity]

enumFromThen :: Parity -> Parity -> [Parity]

enumFromTo :: Parity -> Parity -> [Parity]

enumFromThenTo :: Parity -> Parity -> Parity -> [Parity]

Eq Parity

Defined in System.FTDI.Internal

Methods

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

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

Data Parity

Defined in System.FTDI.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Parity -> c Parity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Parity

toConstr :: Parity -> Constr

dataTypeOf :: Parity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Parity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Parity)

gmapT :: (forall b. Data b => b -> b) -> Parity -> Parity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Parity -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Parity -> r

gmapQ :: (forall d. Data d => d -> u) -> Parity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Parity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Parity -> m Parity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Parity -> m Parity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Parity -> m Parity

Ord Parity

Defined in System.FTDI.Internal

Methods

compare :: Parity -> Parity -> Ordering

(<) :: Parity -> Parity -> Bool

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

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

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

max :: Parity -> Parity -> Parity

min :: Parity -> Parity -> Parity

Show Parity

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> Parity -> ShowS

show :: Parity -> String

showList :: [Parity] -> ShowS

data BitDataFormat

Constructors

Bits_7

Bits_8

data StopBits

Constructors

StopBit_1

StopBit_15

StopBit_2

Instances

Enum StopBits

Defined in System.FTDI.Internal

Methods

succ :: StopBits -> StopBits

pred :: StopBits -> StopBits

toEnum :: Int -> StopBits

fromEnum :: StopBits -> Int

enumFrom :: StopBits -> [StopBits]

enumFromThen :: StopBits -> StopBits -> [StopBits]

enumFromTo :: StopBits -> StopBits -> [StopBits]

enumFromThenTo :: StopBits -> StopBits -> StopBits -> [StopBits]

setLineProperty

Arguments

:: InterfaceHandle

-> BitDataFormat

Number of bits

-> StopBits

Number of stop bits

-> Maybe Parity

Optional parity mode

-> Bool

Break

-> IO ()

Set RS232 line characteristics

newtype BaudRate α

Representation of a baud rate. The most interesting part is the instance for Bounded.

Constructors

BaudRate

Fields

• unBaudRate :: α

Instances

Num α => Bounded (BaudRate α)

Defined in System.FTDI.Internal

Methods

minBound :: BaudRate α

maxBound :: BaudRate α

Enum α => Enum (BaudRate α)

Defined in System.FTDI.Internal

Methods

succ :: BaudRate α -> BaudRate α

pred :: BaudRate α -> BaudRate α

toEnum :: Int -> BaudRate α

fromEnum :: BaudRate α -> Int

enumFrom :: BaudRate α -> [BaudRate α]

enumFromThen :: BaudRate α -> BaudRate α -> [BaudRate α]

enumFromTo :: BaudRate α -> BaudRate α -> [BaudRate α]

enumFromThenTo :: BaudRate α -> BaudRate α -> BaudRate α -> [BaudRate α]

Eq α => Eq (BaudRate α)

Defined in System.FTDI.Internal

Methods

(==) :: BaudRate α -> BaudRate α -> Bool

(/=) :: BaudRate α -> BaudRate α -> Bool

Fractional α => Fractional (BaudRate α)

Defined in System.FTDI.Internal

Methods

(/) :: BaudRate α -> BaudRate α -> BaudRate α

recip :: BaudRate α -> BaudRate α

fromRational :: Rational -> BaudRate α

Integral α => Integral (BaudRate α)

Defined in System.FTDI.Internal

Methods

quot :: BaudRate α -> BaudRate α -> BaudRate α

rem :: BaudRate α -> BaudRate α -> BaudRate α

div :: BaudRate α -> BaudRate α -> BaudRate α

mod :: BaudRate α -> BaudRate α -> BaudRate α

quotRem :: BaudRate α -> BaudRate α -> (BaudRate α, BaudRate α)

divMod :: BaudRate α -> BaudRate α -> (BaudRate α, BaudRate α)

toInteger :: BaudRate α -> Integer

Num α => Num (BaudRate α)

Defined in System.FTDI.Internal

Methods

(+) :: BaudRate α -> BaudRate α -> BaudRate α

(-) :: BaudRate α -> BaudRate α -> BaudRate α

(*) :: BaudRate α -> BaudRate α -> BaudRate α

negate :: BaudRate α -> BaudRate α

abs :: BaudRate α -> BaudRate α

signum :: BaudRate α -> BaudRate α

fromInteger :: Integer -> BaudRate α

Ord α => Ord (BaudRate α)

Defined in System.FTDI.Internal

Methods

compare :: BaudRate α -> BaudRate α -> Ordering

(<) :: BaudRate α -> BaudRate α -> Bool

(<=) :: BaudRate α -> BaudRate α -> Bool

(>) :: BaudRate α -> BaudRate α -> Bool

(>=) :: BaudRate α -> BaudRate α -> Bool

max :: BaudRate α -> BaudRate α -> BaudRate α

min :: BaudRate α -> BaudRate α -> BaudRate α

Read α => Read (BaudRate α)

Defined in System.FTDI.Internal

Methods

readsPrec :: Int -> ReadS (BaudRate α)

readList :: ReadS [BaudRate α]

readPrec :: ReadPrec (BaudRate α)

readListPrec :: ReadPrec [BaudRate α]

Real α => Real (BaudRate α)

Defined in System.FTDI.Internal

Methods

toRational :: BaudRate α -> Rational

RealFrac α => RealFrac (BaudRate α)

Defined in System.FTDI.Internal

Methods

properFraction :: Integral b => BaudRate α -> (b, BaudRate α)

truncate :: Integral b => BaudRate α -> b

round :: Integral b => BaudRate α -> b

ceiling :: Integral b => BaudRate α -> b

floor :: Integral b => BaudRate α -> b

Show α => Show (BaudRate α)

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> BaudRate α -> ShowS

show :: BaudRate α -> String

showList :: [BaudRate α] -> ShowS

nearestBaudRate :: RealFrac α => ChipType -> BaudRate α -> BaudRate α

Calculates the nearest representable baud rate.

setBaudRate :: RealFrac α => InterfaceHandle -> BaudRate α -> IO (BaudRate α)

Sets the baud rate. Internally the baud rate is represented as a fraction. The maximum baudrate is the numerator and a special divisor is used as the denominator. The maximum baud rate is given by the BaudRate instance for Bounded. The divisor consists of an integral part and a fractional part. Both parts are limited in range. As a result not all baud rates can be accurately represented. This function returns the nearest representable baud rate relative to the requested baud rate. According to FTDI documentation the maximum allowed error is 3%. The nearest representable baud rate can be calculated with the nearestBaudRate function.

Modem status

data ModemStatus

Modem status information. The modem status is send as a header for each read access. In the absence of data the FTDI chip will generate the status every 40 ms.

The modem status can be explicitely requested with the pollModemStatus function.

Constructors

ModemStatus

Fields

• msClearToSend :: Bool

  Clear to send (CTS)

• msDataSetReady :: Bool

  Data set ready (DTS)

• msRingIndicator :: Bool

  Ring indicator (RI)

• msReceiveLineSignalDetect :: Bool

  Receive line signal detect (RLSD)

• msDataReady :: Bool

  Data ready (DR)

• msOverrunError :: Bool

  Overrun error (OE)

• msParityError :: Bool

  Parity error (PE)

• msFramingError :: Bool

  Framing error (FE)

• msBreakInterrupt :: Bool

  Break interrupt (BI)

• msTransmitterHoldingRegister :: Bool

  Transmitter holding register (THRE)

• msTransmitterEmpty :: Bool

  Transmitter empty (TEMT)

• msErrorInReceiverFIFO :: Bool

  Error in RCVR FIFO

Instances

Eq ModemStatus

Defined in System.FTDI.Internal

Methods

(==) :: ModemStatus -> ModemStatus -> Bool

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

Data ModemStatus

Defined in System.FTDI.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModemStatus -> c ModemStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModemStatus

toConstr :: ModemStatus -> Constr

dataTypeOf :: ModemStatus -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModemStatus)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModemStatus)

gmapT :: (forall b. Data b => b -> b) -> ModemStatus -> ModemStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModemStatus -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModemStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> ModemStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModemStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModemStatus -> m ModemStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModemStatus -> m ModemStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModemStatus -> m ModemStatus

Ord ModemStatus

Defined in System.FTDI.Internal

Methods

compare :: ModemStatus -> ModemStatus -> Ordering

(<) :: ModemStatus -> ModemStatus -> Bool

(<=) :: ModemStatus -> ModemStatus -> Bool

(>) :: ModemStatus -> ModemStatus -> Bool

(>=) :: ModemStatus -> ModemStatus -> Bool

max :: ModemStatus -> ModemStatus -> ModemStatus

min :: ModemStatus -> ModemStatus -> ModemStatus

Show ModemStatus

Defined in System.FTDI.Internal

Methods

showsPrec :: Int -> ModemStatus -> ShowS

show :: ModemStatus -> String

showList :: [ModemStatus] -> ShowS

Generic ModemStatus

Defined in System.FTDI.Internal

Associated Types

type Rep ModemStatus :: Type -> Type

Methods

from :: ModemStatus -> Rep ModemStatus x

to :: Rep ModemStatus x -> ModemStatus

type Rep ModemStatus

Defined in System.FTDI.Internal

type Rep ModemStatus = D1 ('MetaData "ModemStatus" "System.FTDI.Internal" "ftdi-0.3.0.1-inplace" 'False) (C1 ('MetaCons "ModemStatus" 'PrefixI 'True) (((S1 ('MetaSel ('Just "msClearToSend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "msDataSetReady") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "msRingIndicator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "msReceiveLineSignalDetect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "msDataReady") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "msOverrunError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "msParityError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "msFramingError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "msBreakInterrupt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "msTransmitterHoldingRegister") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "msTransmitterEmpty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "msErrorInReceiverFIFO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))))

pollModemStatus :: InterfaceHandle -> IO ModemStatus

Manually request the modem status.

Flow control

data FlowCtrl

Constructors

RTS_CTS

Request-To-Send / Clear-To-Send

DTR_DSR

Data-Terminal-Ready / Data-Set-Ready

XOnXOff

Transmitter on / Transmitter off

setFlowControl :: InterfaceHandle -> Maybe FlowCtrl -> IO ()

Set the flow control for the FTDI chip. Use Nothing to disable flow control.

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

Set DTR line.

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

Set RTS line.

setEventCharacter :: InterfaceHandle -> Maybe Word8 -> IO ()

Set the special event character. Use Nothing to disable the event character.

setErrorCharacter :: InterfaceHandle -> Maybe Word8 -> IO ()

Set the error character. Use Nothing to disable the error character.

Defaults

defaultTimeout :: Int

Default USB timeout. The timeout can be set per device handle with the setTimeout function.