Safe Haskell	None
Language	Haskell2010

Ham.Log

Contents

Reading and writing log and configuration.
The HamLog monad.
The Log
Exporting

Description

Ham radio logging and other operations. This module provides a monad that abstracts some of the work necessary for logging ham radio contacts, as well as doing related tasks.

Synopsis

module Ham.Qso
logToFile :: Log -> FilePath -> IO ()
logFromFile :: FilePath -> IO (Maybe Log)
configToFile :: LogConfig -> FilePath -> IO ()
configFromFile :: FilePath -> IO (Maybe LogConfig)
type HamLog = RWST LogConfig [Text] LogState IO
data LogState = LogState {
- _stateLog :: Log
- _stateUseCat :: Bool
- _stateSerialCAT :: Maybe SerialCAT
}
emptyLogState :: LogState
data LogConfigV3 = LogConfigV3 {
- _configLogFile :: FilePath
- _configQsoDefaults :: QsoDefaults
- _configUseCat :: Bool
- _configCat :: CATConfig
}
type LogConfig = LogConfigV3
configLogFile :: Lens' LogConfigV3 FilePath
configQsoDefaults :: Lens' LogConfigV3 QsoDefaults
defaultConfig :: LogConfig
evalHamLog :: LogConfig -> LogState -> HamLog a -> IO (a, [Text])
execHamLog :: LogConfig -> LogState -> HamLog a -> IO (LogState, [Text])
runHamLog :: LogConfig -> LogState -> HamLog a -> IO (a, LogState, [Text])
readLog :: HamLog ()
writeLog :: HamLog ()
addQso :: Qso -> HamLog ()
newQsoNow :: HamLog Qso
fillFromCAT :: Qso -> HamLog Qso
updateQso :: Int -> Qso -> HamLog ()
deleteQso :: Int -> HamLog ()
sortLog :: Ord a => (Qso -> a) -> HamLog ()
currentUtcTime :: HamLog UTCTime
filterCallsign :: Text -> HamLog (Seq Qso)
isDuplicate :: Text -> HamLog Bool
findQsos :: Text -> Maybe Band -> Maybe QsoMode -> HamLog (Seq Qso)
findDuplicateQsos :: Qso -> HamLog (Seq Duplicate)
data Duplicate = Duplicate {
- duplicateBand :: Bool
- duplicateMode :: Bool
- duplicateQso :: Qso
}
getQsoList :: HamLog [Qso]
getQsoSeq :: HamLog (Seq Qso)
asks :: (Monoid w, Monad m) => (r -> a) -> RWST r w s m a
cat :: CAT IO a -> HamLog (Either CATError (a, [Text]))
lookupFcc :: Text -> HamLog (Maybe FccResult)
lookupFccName :: Text -> HamLog Text
data Log = Log {
- _logQsos :: Seq Qso
}
addQsoToLog :: Log -> Qso -> Log
sortLog_ :: Ord a => Log -> (Qso -> a) -> Log
emptyLog :: Log
makeCabrillo :: Cabrillo -> HamLog CabrilloLog

Documentation

module Ham.Qso

Reading and writing log and configuration.

logToFile :: Log -> FilePath -> IO () Source #

Write a log to a file in JSON format.

logFromFile :: FilePath -> IO (Maybe Log) Source #

Read a log from a file in JSON format.

configToFile :: LogConfig -> FilePath -> IO () Source #

Write the log configuration to a text file.

configFromFile :: FilePath -> IO (Maybe LogConfig) Source #

Read the log configuration from a text file.

The HamLog monad.

type HamLog = RWST LogConfig [Text] LogState IO Source #

Log monad. You would normally run the monad for example with evalHamLog, and use the monadic actions such as readLog, newQsoNow, writeLog, etc. to modify the log and QSOs.

data LogState Source #

Constructors

LogState
Fields _stateLog :: Log _stateUseCat :: Bool Mirroring the configuration in _configCat in the LogConfig to be able to turn it off after a failed action. _stateSerialCAT :: Maybe SerialCAT

emptyLogState :: LogState Source #

Configuration

data LogConfigV3 Source #

Configuration for a log, version 2.

Constructors

LogConfigV3
Fields _configLogFile :: FilePath File to store the logged Qsos in. _configQsoDefaults :: QsoDefaults Default values, if any, for Qsos. _configUseCat :: Bool Flag to turn CAT support on or off. _configCat :: CATConfig CAT configuration.

Instances

Show LogConfigV3 Source #
Instance details Defined in Ham.Internal.Log.V3 Methods showsPrec :: Int -> LogConfigV3 -> ShowS # show :: LogConfigV3 -> String # showList :: [LogConfigV3] -> ShowS #
ToJSON LogConfigV3 Source #
Instance details Defined in Ham.Internal.Log.V3 Methods toJSON :: LogConfigV3 -> Value # toEncoding :: LogConfigV3 -> Encoding # toJSONList :: [LogConfigV3] -> Value # toEncodingList :: [LogConfigV3] -> Encoding #
FromJSON LogConfigV3 Source #
Instance details Defined in Ham.Internal.Log.V3 Methods parseJSON :: Value -> Parser LogConfigV3 # parseJSONList :: Value -> Parser [LogConfigV3] #

type LogConfig = LogConfigV3 Source #

configLogFile :: Lens' LogConfigV3 FilePath Source #

configQsoDefaults :: Lens' LogConfigV3 QsoDefaults Source #

defaultConfig :: LogConfig Source #

Running the monad

evalHamLog :: LogConfig -> LogState -> HamLog a -> IO (a, [Text]) Source #

Run a HamLog action and return the result and potential logging text.

execHamLog :: LogConfig -> LogState -> HamLog a -> IO (LogState, [Text]) Source #

Run a HamLog action and return the final state and potential logging text.

runHamLog :: LogConfig -> LogState -> HamLog a -> IO (a, LogState, [Text]) Source #

Run a HamLog action and return the result, final state, and potential logging text.

Reading and writing logs

readLog :: HamLog () Source #

Read the log database from the file set in _configLogFile entry of the LogConfig. The log is then set to the _stateLog entry of the current LogState.

writeLog :: HamLog () Source #

Write the log database to the file set in _configLogFile entry of the LogConfig.

Manipulating QSOs.

addQso :: Qso -> HamLog () Source #

Add the given QSO at the front of the current log.

newQsoNow :: HamLog Qso Source #

Create a new QSO with the current UTC time as reported by the operating system, and set the default values from the _configQsoDefaults values. uses fillFromCAT to fill some values from a connected radio, if any.

fillFromCAT :: Qso -> HamLog Qso Source #

Try to get a few values from a CAT connected radio. If the function is turned off (_stateUseCat is False), then the input is going to be returned unchanged. The same is true if there is an error while retrieving data from the radio. Note that when the functionality is turned on and there is an error, it may take a few seconds for the function to return. A message will be set in the Writer layer of HamLog, so that you can get the messages back with evalHamLog, execHamLog, or runHamLog.

updateQso :: Int -> Qso -> HamLog () Source #

Update the QSO at the given position in the log with the given QSO.

deleteQso :: Int -> HamLog () Source #

Delete the QSO at the given position in the log.

sortLog :: Ord a => (Qso -> a) -> HamLog () Source #

Sort the log according to the given key.

Helpers

currentUtcTime :: HamLog UTCTime Source #

Get the current UTC time up to seconds.

Queries

filterCallsign Source #

Arguments

:: Text	The Callsign to find.
-> HamLog (Seq Qso)	Returns a sequence of Qsos.

Return a sequence of all QSOs with a given callsign.

isDuplicate Source #

Arguments

:: Text	The Callsign to find.
-> HamLog Bool

Checks if there is already at least one entry with the given callsign. DEPRECATED. Use findDuplicateQsos.

findQsos Source #

Arguments

:: Text	The callsign to find.
-> Maybe Band	Band to check for
-> Maybe QsoMode	Mode to check for
-> HamLog (Seq Qso)

Find qsos containing the given information.

findDuplicateQsos :: Qso -> HamLog (Seq Duplicate) Source #

data Duplicate Source #

Constructors

Duplicate
Fields duplicateBand :: Bool Indicates whether band matches duplicateMode :: Bool Indicates whether mode matches duplicateQso :: Qso The potential duplicate QSO

Instances

Show Duplicate Source #
Instance details Defined in Ham.Log Methods showsPrec :: Int -> Duplicate -> ShowS # show :: Duplicate -> String # showList :: [Duplicate] -> ShowS #

getQsoList :: HamLog [Qso] Source #

Get a list of QSOs. Use qsoSeq for better performance.

getQsoSeq :: HamLog (Seq Qso) Source #

Get the sequence of stored QSOs.

asks :: (Monoid w, Monad m) => (r -> a) -> RWST r w s m a #

Retrieve a function of the current environment.

```
asks f = liftM f ask
```

Interacting with a radio via CAT

cat :: CAT IO a -> HamLog (Either CATError (a, [Text])) Source #

Run a CAT action.

Getting information from the FCC database.

lookupFcc :: Text -> HamLog (Maybe FccResult) Source #

Get the FCC information for a given callsign.

lookupFccName :: Text -> HamLog Text Source #

Get the operator's name for a given callsign from the FCC.

The Log

data Log Source #

A log. A log contains a set of Qsos

Constructors

Log
Fields _logQsos :: Seq Qso The set of QSOs contained in this log.

Instances

Show Log Source #
Instance details Defined in Ham.Internal.Log.Log Methods showsPrec :: Int -> Log -> ShowS # show :: Log -> String # showList :: [Log] -> ShowS #
ToJSON Log Source #
Instance details Defined in Ham.Internal.Log.Log Methods toJSON :: Log -> Value # toEncoding :: Log -> Encoding # toJSONList :: [Log] -> Value # toEncodingList :: [Log] -> Encoding #
FromJSON Log Source #
Instance details Defined in Ham.Internal.Log.Log Methods parseJSON :: Value -> Parser Log # parseJSONList :: Value -> Parser [Log] #

addQsoToLog :: Log -> Qso -> Log Source #

Add a QSO to the beginning of the log list.

sortLog_ :: Ord a => Log -> (Qso -> a) -> Log Source #

emptyLog :: Log Source #

An empty log.

Exporting

makeCabrillo :: Cabrillo -> HamLog CabrilloLog Source #

Make a cabrillo log from the current log, given a cabrillo configuration.