Sketch.FRP.Copilot.Internals

Documentation

getTriggerLimit :: TriggerLimit -> Behavior Bool

addTriggerLimit :: TriggerLimit -> Behavior Bool -> Behavior Bool

getUniqueId :: String -> GenSketch pinid UniqueId

Gets a unique id.

uniqueName :: String -> UniqueId -> String

Generates a unique name.

uniqueName' :: String -> UniqueId -> String

emptyFramework :: Ord pinid => GenFramework pinid

Use to create an empty framework.

It helps to specify the type of pinid to use:

(emptyFramework @PinId) { ... }

mkCChunk :: [CLine] -> [CChunk]

defineTriggerAlias :: String -> GenFramework pinid -> GenSketch pinid (GenFramework pinid, String)

Copilot only supports calling a trigger with a given name once per Spec; the generated C code will fail to build if the same name is used in two triggers. This generates a unique alias that can be used in a trigger.

defineTriggerAlias' :: String -> String -> GenFramework pinid -> GenSketch pinid (GenFramework pinid, String)

data MkInputSource pinid t

Constructors

InputSource

Fields

• defineVar :: [CChunk]

  Added to the Framework's defines, this typically defines a C variable.

• setupInput :: [CChunk]

  How to set up the input, not including pin mode.

• inputPinmode :: Map pinid PinMode

  How pins are used by the input.

• readInput :: [CChunk]

  How to read a value from the input, this typically reads a value into a C variable.

• inputStream :: Stream t

  How to use Copilot's extern to access the input values.

mkInput :: MkInputSource pinid t -> GenSketch pinid (Behavior t)

evalSketch :: Ord pinid => GenSketch pinid a -> (Maybe Spec, GenFramework pinid)

sketchSpec :: Ord pinid => GenSketch pinid a -> Spec

Extracts a copilot Spec from a Sketch.

This can be useful to intergrate with other libraries such as copilot-theorem.