Copilot.Arduino.Internals

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

Documentation

newtype Sketch t

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

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

Defined in Copilot.Arduino.Internals

Methods

fmap :: (a -> b) -> Sketch a -> Sketch b

(<$) :: a -> Sketch b -> Sketch a

Applicative Sketch

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)

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 ())

Defined in Copilot.Arduino.Internals

Methods

mempty :: Sketch ()

mappend :: Sketch () -> Sketch () -> Sketch ()

mconcat :: [Sketch ()] -> Sketch ()

MonadWriter [(Spec, Framework)] Sketch

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

The framework of an Arduino sketch.

Constructors

Framework

Fields

• defines :: [CFragment]

  Things that come before the C code generated by Copilot.

• setups :: [CFragment]

  Things to run in setup.

• loops :: [CFragment]

  Things to run in loop.

Instances

Semigroup Framework

Defined in Copilot.Arduino.Internals

Methods

(<>) :: Framework -> Framework -> Framework

sconcat :: NonEmpty Framework -> Framework

stimes :: Integral b => b -> Framework -> Framework

Monoid Framework

Defined in Copilot.Arduino.Internals

Methods

mempty :: Framework

mappend :: Framework -> Framework -> Framework

mconcat :: [Framework] -> Framework

MonadWriter [(Spec, Framework)] Sketch

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

type CFragment = String

A fragment of C code.

class ToFramework t where

Methods

toFramework :: t -> Framework

Instances

ToFramework (InputSource t)

Defined in Copilot.Arduino.Internals

Methods

toFramework :: InputSource t -> Framework

ToFramework (Output t)

Defined in Copilot.Arduino.Internals

Methods

toFramework :: Output t -> Framework

type Behavior t = Stream t -> Spec

data Output t

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

Constructors

Output

Fields

• setupOutput :: [CFragment]

  How to set up the output.

• outputCond :: Stream Bool
• outputBehavior :: Stream Bool -> Behavior t

Instances

ToFramework (Output t)

Defined in Copilot.Arduino.Internals

Methods

toFramework :: Output t -> Framework

type Input t = Sketch (Stream t)

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

Runs in the Sketch monad.

data InputSource t

Constructors

InputSource

Fields

• defineVar :: [CFragment]

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

• setupInput :: [CFragment]

  How to set up the input.

• readInput :: [CFragment]

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

• inputStream :: Stream t

Instances

ToFramework (InputSource t)

Defined in Copilot.Arduino.Internals

Methods

toFramework :: InputSource t -> Framework

mkInput :: InputSource t -> Input t

newtype GPIO

A GPIO pin

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

Constructors

GPIO Int16

type MicroSeconds = Int16

sketchFramework :: Framework -> [String] -> [CFragment]

Makes an arduino sketch, using a Framework, and a list of lines of C code generated by Copilot.