Ham.CAT

Documentation

data CATConfig

Configuration for the CAT monad.

Constructors

CATConfig

Fields

• catPort :: String

  Serial port the radio is connected to. In Linux e.g. "devttyUSB0".

• catRadio :: Radio

  Radio identifier.

• catSerialSettings :: SerialPortSettings

  Serial settings for the connection. Note the radio must have the same settings.

Instances

Show CATConfig

Defined in Ham.Internal.CAT

Methods

showsPrec :: Int -> CATConfig -> ShowS

show :: CATConfig -> String

showList :: [CATConfig] -> ShowS

Generic CATConfig

Defined in Ham.Internal.CAT

Associated Types

type Rep CATConfig :: Type -> Type

Methods

from :: CATConfig -> Rep CATConfig x

to :: Rep CATConfig x -> CATConfig

ToJSON CATConfig

Defined in Ham.Internal.CAT

Methods

toJSON :: CATConfig -> Value

toEncoding :: CATConfig -> Encoding

toJSONList :: [CATConfig] -> Value

toEncodingList :: [CATConfig] -> Encoding

FromJSON CATConfig

Defined in Ham.Internal.CAT

Methods

parseJSON :: Value -> Parser CATConfig

parseJSONList :: Value -> Parser [CATConfig]

type Rep CATConfig

Defined in Ham.Internal.CAT

type Rep CATConfig = D1 (MetaData "CATConfig" "Ham.Internal.CAT" "ham-0.1.0.0-8Jb3s78JRYM4BaePNf8wNc" False) (C1 (MetaCons "CATConfig" PrefixI True) (S1 (MetaSel (Just "catPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "catRadio") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Radio) :*: S1 (MetaSel (Just "catSerialSettings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialPortSettings))))

defaultConfig :: CATConfig

Default configuration. Note this assumes port and radio, so you will want to adjust it.

data CATState

State type for the CAT monad.

Constructors

CATState

Fields

• statePort :: Maybe SerialPort

  Serial port, if one is open.

• stateInterface :: SerialCAT

  SerialCAT implementation for the radio.

defaultState :: CATState

Default state. Note that this sets the SerialCAT to a default implementation. You will want to change that.

data CATError

Constructors

CATError CATErrorType Text

Instances

Show CATError

Defined in Ham.Internal.CAT

Methods

showsPrec :: Int -> CATError -> ShowS

show :: CATError -> String

showList :: [CATError] -> ShowS

data CATErrorType

Constructors

CATErrorGeneric

CATErrorIdentify

Instances

Show CATErrorType

Defined in Ham.Internal.CAT

Methods

showsPrec :: Int -> CATErrorType -> ShowS

show :: CATErrorType -> String

showList :: [CATErrorType] -> ShowS

newtype CAT m a

The computer aided transceiver monad.

Constructors

CAT

Fields

• unCAT :: RWST CATConfig [Text] CATState (ExceptT CATError m) a

Instances

Monad m => Monad (CAT m)

Defined in Ham.Internal.CAT

Methods

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

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

return :: a -> CAT m a

fail :: String -> CAT m a

Monad m => Functor (CAT m)

Defined in Ham.Internal.CAT

Methods

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

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

Monad m => Applicative (CAT m)

Defined in Ham.Internal.CAT

Methods

pure :: a -> CAT m a

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

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

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

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

throwCAT :: Monad m => CATError -> CAT m a

Throw an exception in the Overpass monad.

catchCAT :: Monad m => CAT m a -> (CATError -> CAT m a) -> CAT m a

Catching exceptions in the Overpass monad.

runCAT

Arguments

:: MonadIO m

=> CATConfig

-> CATState

State to start with.

-> CAT m a

-> m (Either CATError (a, [Text]))

Run an action in the CAT monad.

catInit :: MonadIO m => CAT m ()

FIXME: Add error handling. What if the radio can not be opened?

catDeinit :: MonadIO m => CAT m ()

Close everything down.

catFrequency :: MonadIO m => CAT m (Maybe Frequency)

Get the current frequency from the transceiver.

catMode :: MonadIO m => CAT m (Maybe QsoMode)

Get the current mode from the transceiver.

catPowerSSB :: MonadIO m => CAT m (Maybe Int)

Get the SSB power setting in watts.

catSetPowerSSB :: MonadIO m => Int -> CAT m ()

Set the SSB power in watts.

module Ham.CAT.SerialCAT

module Ham.CAT.YaesuFT891

module Ham.CAT.ElecraftKX2