Sketch.FRP.Copilot.Types

Documentation

type Behavior t = Stream t

A value that changes over time.

This is implemented as a Stream in the Copilot DSL. Copilot provides many operations on streams, for example && to combine two streams of Bools.

For documentation on using the Copilot DSL, see https://copilot-language.github.io/

data TypedBehavior p t

A Behavior with an additional phantom type p.

The Compilot DSL only lets a Stream contain basic C types, a limitation that Behavior also has. When more type safely is needed, this can be used.

Constructors

TypedBehavior (Behavior t)

Instances

Output ctx o (Event p (Stream v)) => Output ctx o (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

Methods

(=:) :: o -> TypedBehavior p v -> GenSketch ctx ()

Typed a => IfThenElse (TypedBehavior p) a

Defined in Sketch.FRP.Copilot

Methods

ifThenElse :: Behavior Bool -> TypedBehavior p a -> TypedBehavior p a -> TypedBehavior p a

IsBehavior (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

Methods

(@:) :: TypedBehavior p v -> Behavior Bool -> BehaviorToEvent (TypedBehavior p v)

type BehaviorToEvent (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

type BehaviorToEvent (TypedBehavior p v) = Event p (Stream v)

data Event p v

A discrete event, that occurs at particular points in time.

Constructors

Event v (Stream Bool)

newtype GenSketch ctx t

A sketch, implemented using Copilot.

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

Under the hood, the Sketch is run in a loop. On each iteration, it first reads 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.

This is a generalized Sketch that can operate on any type of context.

Constructors

GenSketch (WriterT [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] (State UniqueIds) t)

Instances

MonadState UniqueIds (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

get :: GenSketch ctx UniqueIds

put :: UniqueIds -> GenSketch ctx ()

state :: (UniqueIds -> (a, UniqueIds)) -> GenSketch ctx a

Monad (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

(>>=) :: GenSketch ctx a -> (a -> GenSketch ctx b) -> GenSketch ctx b

(>>) :: GenSketch ctx a -> GenSketch ctx b -> GenSketch ctx b

return :: a -> GenSketch ctx a

Functor (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

fmap :: (a -> b) -> GenSketch ctx a -> GenSketch ctx b

(<$) :: a -> GenSketch ctx b -> GenSketch ctx a

Applicative (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

pure :: a -> GenSketch ctx a

(<*>) :: GenSketch ctx (a -> b) -> GenSketch ctx a -> GenSketch ctx b

liftA2 :: (a -> b -> c) -> GenSketch ctx a -> GenSketch ctx b -> GenSketch ctx c

(*>) :: GenSketch ctx a -> GenSketch ctx b -> GenSketch ctx b

(<*) :: GenSketch ctx a -> GenSketch ctx b -> GenSketch ctx a

Context ctx => IfThenElse (GenSketch ctx) ()

Defined in Sketch.FRP.Copilot

Methods

ifThenElse :: Behavior Bool -> GenSketch ctx () -> GenSketch ctx () -> GenSketch ctx ()

MonadWriter [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

writer :: (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

tell :: [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> GenSketch ctx ()

listen :: GenSketch ctx a -> GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)])

pass :: GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

(Context ctx, Typed a) => IfThenElse (GenSketch ctx) (Behavior a)

Defined in Sketch.FRP.Copilot

Methods

ifThenElse :: Behavior Bool -> GenSketch ctx (Behavior a) -> GenSketch ctx (Behavior a) -> GenSketch ctx (Behavior a)

Semigroup (GenSketch ctx t)

Defined in Sketch.FRP.Copilot.Types

Methods

(<>) :: GenSketch ctx t -> GenSketch ctx t -> GenSketch ctx t

sconcat :: NonEmpty (GenSketch ctx t) -> GenSketch ctx t

stimes :: Integral b => b -> GenSketch ctx t -> GenSketch ctx t

Monoid (GenSketch ctx ())

Defined in Sketch.FRP.Copilot.Types

Methods

mempty :: GenSketch ctx ()

mappend :: GenSketch ctx () -> GenSketch ctx () -> GenSketch ctx ()

mconcat :: [GenSketch ctx ()] -> GenSketch ctx ()

class Ord ctx => Context ctx

class Output ctx o t where

Things that can have a Behavior or Event output to them.

Methods

(=:) :: o -> t -> GenSketch ctx () infixr 1

Connect a Behavior or Event to an Output

led =: blinking

When a Behavior is used, its current value is written on each iteration of the Sketch.

For example, this constantly turns on the LED, even though it will already be on after the first iteration, because true is a Behavior (that is always True).

led =: true

To avoid unncessary work being done, you can use an Event instead. Then the write only happens at the points in time when the Event occurs. To turn a Behavior into an Event, use @:

So to make the LED only be turned on in the first iteration, and allow it to remain on thereafter without doing extra work:

led =: true @: firstIteration

Instances

Output ctx o (Event () (Stream v)) => Output ctx o (Behavior v)

Defined in Sketch.FRP.Copilot.Types

Methods

(=:) :: o -> Behavior v -> GenSketch ctx ()

Output ctx o (Event p (Stream v)) => Output ctx o (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

Methods

(=:) :: o -> TypedBehavior p v -> GenSketch ctx ()

class Input ctx o t where

Methods

input' :: o -> [t] -> GenSketch ctx (Behavior t)

The list is input to use when simulating the Sketch.

data GenFramework ctx

The framework of a sketch.

This is a generalized Framework that can operate on any type of context.

Constructors

Framework

Fields

• defines :: [CChunk]

  Things that come before the C code generated by Copilot.

• setups :: [CChunk]

  Things to do at setup, not including configuring pins.

• earlySetups :: [CChunk]

  Things to do at setup, before the setups.

• pinmodes :: Map ctx (Set PinMode)

  How pins are used.

• loops :: [CChunk]

  Things to run in loop.

Instances

Context ctx => Semigroup (GenFramework ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

(<>) :: GenFramework ctx -> GenFramework ctx -> GenFramework ctx

sconcat :: NonEmpty (GenFramework ctx) -> GenFramework ctx

stimes :: Integral b => b -> GenFramework ctx -> GenFramework ctx

Context ctx => Monoid (GenFramework ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

mempty :: GenFramework ctx

mappend :: GenFramework ctx -> GenFramework ctx -> GenFramework ctx

mconcat :: [GenFramework ctx] -> GenFramework ctx

MonadWriter [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

writer :: (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

tell :: [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> GenSketch ctx ()

listen :: GenSketch ctx a -> GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)])

pass :: GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

newtype UniqueIds

Constructors

UniqueIds (Map String Integer)

Instances

MonadState UniqueIds (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

get :: GenSketch ctx UniqueIds

put :: UniqueIds -> GenSketch ctx ()

state :: (UniqueIds -> (a, UniqueIds)) -> GenSketch ctx a

newtype UniqueId

Constructors

UniqueId Integer

data TriggerLimit

Constructors

TriggerLimit (Behavior Bool)

NoTriggerLimit

Instances

Semigroup TriggerLimit

Defined in Sketch.FRP.Copilot.Types

Methods

(<>) :: TriggerLimit -> TriggerLimit -> TriggerLimit

sconcat :: NonEmpty TriggerLimit -> TriggerLimit

stimes :: Integral b => b -> TriggerLimit -> TriggerLimit

Monoid TriggerLimit

Defined in Sketch.FRP.Copilot.Types

Methods

mempty :: TriggerLimit

mappend :: TriggerLimit -> TriggerLimit -> TriggerLimit

mconcat :: [TriggerLimit] -> TriggerLimit

MonadWriter [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] (GenSketch ctx)

Defined in Sketch.FRP.Copilot.Types

Methods

writer :: (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

tell :: [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> GenSketch ctx ()

listen :: GenSketch ctx a -> GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)])

pass :: GenSketch ctx (a, [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)] -> [(TriggerLimit -> Spec, TriggerLimit -> GenFramework ctx)]) -> GenSketch ctx a

data PinMode

Constructors

InputMode

InputPullupMode

OutputMode

Instances

Eq PinMode

Defined in Sketch.FRP.Copilot.Types

Methods

(==) :: PinMode -> PinMode -> Bool

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

Ord PinMode

Defined in Sketch.FRP.Copilot.Types

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

Defined in Sketch.FRP.Copilot.Types

Methods

showsPrec :: Int -> PinMode -> ShowS

show :: PinMode -> String

showList :: [PinMode] -> ShowS

newtype CLine

A line of C code.

Constructors

CLine

Fields

• fromCLine :: String

Instances

Eq CLine

Defined in Sketch.FRP.Copilot.Types

Methods

(==) :: CLine -> CLine -> Bool

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

Ord CLine

Defined in Sketch.FRP.Copilot.Types

Methods

compare :: CLine -> CLine -> Ordering

(<) :: CLine -> CLine -> Bool

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

(>) :: CLine -> CLine -> Bool

(>=) :: CLine -> CLine -> Bool

max :: CLine -> CLine -> CLine

min :: CLine -> CLine -> CLine

Show CLine

Defined in Sketch.FRP.Copilot.Types

Methods

showsPrec :: Int -> CLine -> ShowS

show :: CLine -> String

showList :: [CLine] -> ShowS

newtype CChunk

A chunk of C code. Identical chunks get deduplicated.

Constructors

CChunk [CLine]

Instances

Eq CChunk

Defined in Sketch.FRP.Copilot.Types

Methods

(==) :: CChunk -> CChunk -> Bool

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

Ord CChunk

Defined in Sketch.FRP.Copilot.Types

Methods

compare :: CChunk -> CChunk -> Ordering

(<) :: CChunk -> CChunk -> Bool

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

(>) :: CChunk -> CChunk -> Bool

(>=) :: CChunk -> CChunk -> Bool

max :: CChunk -> CChunk -> CChunk

min :: CChunk -> CChunk -> CChunk

Show CChunk

Defined in Sketch.FRP.Copilot.Types

Methods

showsPrec :: Int -> CChunk -> ShowS

show :: CChunk -> String

showList :: [CChunk] -> ShowS

Semigroup CChunk

Defined in Sketch.FRP.Copilot.Types

Methods

(<>) :: CChunk -> CChunk -> CChunk

sconcat :: NonEmpty CChunk -> CChunk

stimes :: Integral b => b -> CChunk -> CChunk

Monoid CChunk

Defined in Sketch.FRP.Copilot.Types

Methods

mempty :: CChunk

mappend :: CChunk -> CChunk -> CChunk

mconcat :: [CChunk] -> CChunk

type family BehaviorToEvent a

This type family is open, so it can be extended when adding other data types to the IsBehavior class.

Instances

type BehaviorToEvent (Behavior v)

Defined in Sketch.FRP.Copilot.Types

type BehaviorToEvent (Behavior v) = Event () (Stream v)

type BehaviorToEvent (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

type BehaviorToEvent (TypedBehavior p v) = Event p (Stream v)

class IsBehavior behavior where

Methods

(@:) :: behavior -> Behavior Bool -> BehaviorToEvent behavior

Generate an Event, from some type of behavior, that only occurs when the Behavior Bool is True.

Instances

IsBehavior (Behavior v)

Defined in Sketch.FRP.Copilot.Types

Methods

(@:) :: Behavior v -> Behavior Bool -> BehaviorToEvent (Behavior v)

IsBehavior (TypedBehavior p v)

Defined in Sketch.FRP.Copilot.Types

Methods

(@:) :: TypedBehavior p v -> Behavior Bool -> BehaviorToEvent (TypedBehavior p v)

data PinCapabilities

Constructors

DigitalIO

AnalogInput

PWM

Instances

Eq PinCapabilities

Defined in Sketch.FRP.Copilot.Types

Methods

(==) :: PinCapabilities -> PinCapabilities -> Bool

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

Ord PinCapabilities

Defined in Sketch.FRP.Copilot.Types

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

Defined in Sketch.FRP.Copilot.Types

Methods

showsPrec :: Int -> PinCapabilities -> ShowS

show :: PinCapabilities -> String

showList :: [PinCapabilities] -> ShowS

type family IsDigitalIOPin t where ...

Equations

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

type family IsAnalogInputPin t where ...

Equations

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

type family IsPWMPin t where ...

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 ...

Equations

HasPinCapability c '[] = 'False

HasPinCapability c (x ': xs) = SameCapability c x || HasPinCapability c xs

type family SameCapability a b :: Bool where ...

Equations

SameCapability 'DigitalIO 'DigitalIO = 'True

SameCapability 'AnalogInput 'AnalogInput = 'True

SameCapability 'PWM 'PWM = 'True

SameCapability _ _ = 'False