Safe Haskell	None
Language	Haskell98

Copilot.Arduino.Internals

Description

You should not need to import this module unless you're adding support for a new model of Arduino, or an Arduino library.

Synopsis

newtype Sketch t = Sketch (Writer [(Spec, Framework)] t)
data Framework = Framework {
- defines :: [CLine]
- setups :: [CLine]
- pinmodes :: Map PinId (Set PinMode)
- loops :: [CLine]
}
newtype CLine = CLine {
- fromCLine :: String
}
class ToFramework t where
- toFramework :: t -> Framework
type Behavior t = Stream t -> Spec
data Output t = Output {
- setupOutput :: [CLine]
- outputPinmode :: Map PinId PinMode
- outputCond :: Stream Bool
- outputBehavior :: Stream Bool -> Behavior t
}
type Input t = Sketch (Stream t)
data InputSource t = InputSource {
- defineVar :: [CLine]
- setupInput :: [CLine]
- inputPinmode :: Map PinId PinMode
- readInput :: [CLine]
- inputStream :: Stream t
}
mkInput :: InputSource t -> Input t
newtype Pin t = Pin PinId
newtype PinId = PinId Int16
data PinCapabilities
- = DigitalIO
- | AnalogInput
- | PWM
type family IsDigitalIOPin t where ...
type family IsAnalogInputPin t where ...
type family IsPWMPin t where ...
type family HasPinCapability (c :: t) (list :: [t]) :: Bool where ...
type family SameCapability (a :: PinCapabilities) (b :: PinCapabilities) :: Bool where ...
data PinMode
- = InputMode
- | InputPullupMode
- | OutputMode
type MicroSeconds = Int16

Documentation

newtype Sketch t Source #

An Arduino sketch, implemented using Copilot.

It's best to think of the Sketch as a description of the state of the Arduino at any point in time.

Under the hood, the Sketch is run in a loop. On each iteration, it first reads all inputs and then updates outputs as needed. While it is a monad, a Sketch's outputs are not updated in any particular order, because Copilot does not guarantee any order.

Constructors

Sketch (Writer [(Spec, Framework)] t)

Instances

Monad Sketch Source #
Instance details Defined in Copilot.Arduino.Internals Methods (>>=) :: Sketch a -> (a -> Sketch b) -> Sketch b # (>>) :: Sketch a -> Sketch b -> Sketch b # return :: a -> Sketch a # fail :: String -> Sketch a #
Functor Sketch Source #
Instance details Defined in Copilot.Arduino.Internals Methods fmap :: (a -> b) -> Sketch a -> Sketch b # (<$) :: a -> Sketch b -> Sketch a #
Applicative Sketch Source #
Instance details Defined in Copilot.Arduino.Internals Methods pure :: a -> Sketch a # (<>) :: Sketch (a -> b) -> Sketch a -> Sketch b # liftA2 :: (a -> b -> c) -> Sketch a -> Sketch b -> Sketch c # (>) :: Sketch a -> Sketch b -> Sketch b # (<*) :: Sketch a -> Sketch b -> Sketch a #
Semigroup (Sketch t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods (<>) :: Sketch t -> Sketch t -> Sketch t # sconcat :: NonEmpty (Sketch t) -> Sketch t # stimes :: Integral b => b -> Sketch t -> Sketch t #
Monoid (Sketch ()) Source #
Instance details Defined in Copilot.Arduino.Internals Methods mempty :: Sketch () # mappend :: Sketch () -> Sketch () -> Sketch () # mconcat :: [Sketch ()] -> Sketch () #
MonadWriter [(Spec, Framework)] Sketch Source #
Instance details Defined in Copilot.Arduino.Internals Methods writer :: (a, [(Spec, Framework)]) -> Sketch a # tell :: [(Spec, Framework)] -> Sketch () # listen :: Sketch a -> Sketch (a, [(Spec, Framework)]) # pass :: Sketch (a, [(Spec, Framework)] -> [(Spec, Framework)]) -> Sketch a #

data Framework Source #

The framework of an Arduino sketch.

Constructors

Framework
Fields defines :: [CLine] Things that come before the C code generated by Copilot. setups :: [CLine] Things to do at setup, not including configuring pins. pinmodes :: Map PinId (Set PinMode) How pins are used. loops :: [CLine] Things to run in `loop`.

Instances

Semigroup Framework Source #
Instance details Defined in Copilot.Arduino.Internals Methods (<>) :: Framework -> Framework -> Framework # sconcat :: NonEmpty Framework -> Framework # stimes :: Integral b => b -> Framework -> Framework #
Monoid Framework Source #
Instance details Defined in Copilot.Arduino.Internals Methods mempty :: Framework # mappend :: Framework -> Framework -> Framework # mconcat :: [Framework] -> Framework #
MonadWriter [(Spec, Framework)] Sketch Source #
Instance details Defined in Copilot.Arduino.Internals Methods writer :: (a, [(Spec, Framework)]) -> Sketch a # tell :: [(Spec, Framework)] -> Sketch () # listen :: Sketch a -> Sketch (a, [(Spec, Framework)]) # pass :: Sketch (a, [(Spec, Framework)] -> [(Spec, Framework)]) -> Sketch a #

newtype CLine Source #

A line of C code.

Constructors

CLine
Fields fromCLine :: String

class ToFramework t where Source #

Methods

toFramework :: t -> Framework Source #

Instances

ToFramework (InputSource t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods toFramework :: InputSource t -> Framework Source #
ToFramework (Output t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods toFramework :: Output t -> Framework Source #

type Behavior t = Stream t -> Spec Source #

data Output t Source #

Somewhere that a Stream can be directed to, in order to control the Arduino.

Constructors

Output
Fields setupOutput :: [CLine] How to set up the output, not including pin mode. outputPinmode :: Map PinId PinMode outputCond :: Stream Bool outputBehavior :: Stream Bool -> Behavior t

Instances

ToFramework (Output t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods toFramework :: Output t -> Framework Source #

type Input t = Sketch (Stream t) Source #

A source of a Stream of values input from the Arduino.

Runs in the Sketch monad.

data InputSource t Source #

Constructors

InputSource
Fields defineVar :: [CLine] Added to the `Framework`'s `defines`, this typically defines a C variable. setupInput :: [CLine] How to set up the input, not including pin mode. inputPinmode :: Map PinId PinMode readInput :: [CLine] How to read a value from the input, this typically reads a value into a C variable. inputStream :: Stream t

Instances

ToFramework (InputSource t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods toFramework :: InputSource t -> Framework Source #

mkInput :: InputSource t -> Input t Source #

newtype Pin t Source #

A pin on the Arduino board.

For definitions of pins like pin12, load a module such as Copilot.Arduino.Uno, which provides the pins of a particular board.

Some pins can only be used for digital IO, while others support analog input and/or digital IO. A type-level list of PinCapabilties indicates how a Pin can be used.

Constructors

Pin PinId

Instances

Eq (Pin t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods (==) :: Pin t -> Pin t -> Bool # (/=) :: Pin t -> Pin t -> Bool #
Ord (Pin t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods compare :: Pin t -> Pin t -> Ordering # (<) :: Pin t -> Pin t -> Bool # (<=) :: Pin t -> Pin t -> Bool # (>) :: Pin t -> Pin t -> Bool # (>=) :: Pin t -> Pin t -> Bool # max :: Pin t -> Pin t -> Pin t # min :: Pin t -> Pin t -> Pin t #
Show (Pin t) Source #
Instance details Defined in Copilot.Arduino.Internals Methods showsPrec :: Int -> Pin t -> ShowS # show :: Pin t -> String # showList :: [Pin t] -> ShowS #

newtype PinId Source #

Constructors

PinId Int16

Instances

Eq PinId Source #
Instance details Defined in Copilot.Arduino.Internals Methods (==) :: PinId -> PinId -> Bool # (/=) :: PinId -> PinId -> Bool #
Ord PinId Source #
Instance details Defined in Copilot.Arduino.Internals Methods compare :: PinId -> PinId -> Ordering # (<) :: PinId -> PinId -> Bool # (<=) :: PinId -> PinId -> Bool # (>) :: PinId -> PinId -> Bool # (>=) :: PinId -> PinId -> Bool # max :: PinId -> PinId -> PinId # min :: PinId -> PinId -> PinId #
Show PinId Source #
Instance details Defined in Copilot.Arduino.Internals Methods showsPrec :: Int -> PinId -> ShowS # show :: PinId -> String # showList :: [PinId] -> ShowS #

data PinCapabilities Source #

Constructors

DigitalIO
AnalogInput
PWM

Instances

Eq PinCapabilities Source #
Instance details Defined in Copilot.Arduino.Internals Methods (==) :: PinCapabilities -> PinCapabilities -> Bool # (/=) :: PinCapabilities -> PinCapabilities -> Bool #
Ord PinCapabilities Source #
Instance details Defined in Copilot.Arduino.Internals Methods compare :: PinCapabilities -> PinCapabilities -> Ordering # (<) :: PinCapabilities -> PinCapabilities -> Bool # (<=) :: PinCapabilities -> PinCapabilities -> Bool # (>) :: PinCapabilities -> PinCapabilities -> Bool # (>=) :: PinCapabilities -> PinCapabilities -> Bool # max :: PinCapabilities -> PinCapabilities -> PinCapabilities # min :: PinCapabilities -> PinCapabilities -> PinCapabilities #
Show PinCapabilities Source #
Instance details Defined in Copilot.Arduino.Internals Methods showsPrec :: Int -> PinCapabilities -> ShowS # show :: PinCapabilities -> String # showList :: [PinCapabilities] -> ShowS #

type family IsDigitalIOPin t where ... Source #

Equations

IsDigitalIOPin t = True ~ If (HasPinCapability DigitalIO t) True (TypeError (Text "This Pin does not support digital IO"))

type family IsAnalogInputPin t where ... Source #

Equations

IsAnalogInputPin t = True ~ If (HasPinCapability AnalogInput t) True (TypeError (Text "This Pin does not support analog input"))

type family IsPWMPin t where ... Source #

Equations

IsPWMPin t = True ~ If (HasPinCapability PWM t) True (TypeError (Text "This Pin does not support PWM"))

type family HasPinCapability (c :: t) (list :: [t]) :: Bool where ... Source #

Equations

HasPinCapability c '[] = False
HasPinCapability c (x ': xs) = SameCapability c x \|\| HasPinCapability c xs

type family SameCapability (a :: PinCapabilities) (b :: PinCapabilities) :: Bool where ... Source #

Equations

SameCapability DigitalIO DigitalIO = True
SameCapability AnalogInput AnalogInput = True
SameCapability PWM PWM = True
SameCapability _ _ = False

data PinMode Source #

Constructors

InputMode
InputPullupMode
OutputMode

Instances

Eq PinMode Source #
Instance details Defined in Copilot.Arduino.Internals Methods (==) :: PinMode -> PinMode -> Bool # (/=) :: PinMode -> PinMode -> Bool #
Ord PinMode Source #
Instance details Defined in Copilot.Arduino.Internals Methods compare :: PinMode -> PinMode -> Ordering # (<) :: PinMode -> PinMode -> Bool # (<=) :: PinMode -> PinMode -> Bool # (>) :: PinMode -> PinMode -> Bool # (>=) :: PinMode -> PinMode -> Bool # max :: PinMode -> PinMode -> PinMode # min :: PinMode -> PinMode -> PinMode #
Show PinMode Source #
Instance details Defined in Copilot.Arduino.Internals Methods showsPrec :: Int -> PinMode -> ShowS # show :: PinMode -> String # showList :: [PinMode] -> ShowS #

type MicroSeconds = Int16 Source #