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

class ShowCType t where

Methods

showCType :: Proxy t -> String

Instances

ShowCType Bool

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Bool -> String

ShowCType Double

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Double -> String

ShowCType Float

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Float -> String

ShowCType Int8

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Int8 -> String

ShowCType Int16

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Int16 -> String

ShowCType Int32

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Int32 -> String

ShowCType Int64

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Int64 -> String

ShowCType Word8

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Word8 -> String

ShowCType Word16

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Word16 -> String

ShowCType Word32

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Word32 -> String

ShowCType Word64

Defined in Copilot.Arduino.Internals

Methods

showCType :: Proxy Word64 -> String

type ADC = Int16

Value read from an Arduino's ADC. Ranges from 0-1023.

newtype Arduino

Indicates that you're programming an arduino, and not some other kind of hardware. The similar library zephyr-copilot allows programming other embedded boards in a very similar style to this one.

Constructors

Arduino Int16

Instances

Eq Arduino

Defined in Copilot.Arduino.Internals

Methods

(==) :: Arduino -> Arduino -> Bool

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

Ord Arduino

Defined in Copilot.Arduino.Internals

Methods

compare :: Arduino -> Arduino -> Ordering

(<) :: Arduino -> Arduino -> Bool

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

(>) :: Arduino -> Arduino -> Bool

(>=) :: Arduino -> Arduino -> Bool

max :: Arduino -> Arduino -> Arduino

min :: Arduino -> Arduino -> Arduino

Show Arduino

Defined in Copilot.Arduino.Internals

Methods

showsPrec :: Int -> Arduino -> ShowS

show :: Arduino -> String

showList :: [Arduino] -> ShowS

Context Arduino

Defined in Copilot.Arduino.Internals

Output Arduino Delay MilliSeconds

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Delay -> MilliSeconds -> GenSketch Arduino ()

Output Arduino Delay MicroSeconds

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Delay -> MicroSeconds -> GenSketch Arduino ()

Input Arduino ClockMicros Word32

Defined in Copilot.Arduino

Methods

input' :: ClockMicros -> [Word32] -> GenSketch Arduino (Behavior Word32)

Input Arduino ClockMillis Word32

Defined in Copilot.Arduino

Methods

input' :: ClockMillis -> [Word32] -> GenSketch Arduino (Behavior Word32)

Input Arduino SerialDevice Int8

Defined in Copilot.Arduino.Library.Serial.Device

Methods

input' :: SerialDevice -> [Int8] -> GenSketch Arduino (Behavior Int8)

Input Arduino RandomInput Word32

Defined in Copilot.Arduino.Library.Random

Methods

input' :: RandomInput -> [Word32] -> GenSketch Arduino (Behavior Word32)

Output Arduino SerialDevice [FormatOutput]

Defined in Copilot.Arduino.Library.Serial.Device

Methods

(=:) :: SerialDevice -> [FormatOutput] -> GenSketch Arduino ()

Output Arduino SerialDevice (Event () [FormatOutput])

Defined in Copilot.Arduino.Library.Serial.Device

Methods

(=:) :: SerialDevice -> Event () [FormatOutput] -> GenSketch Arduino ()

Output Arduino RandomSeed (Event () (Stream Word8))

Defined in Copilot.Arduino.Library.Random

Methods

(=:) :: RandomSeed -> Event () (Stream Word8) -> GenSketch Arduino ()

Output Arduino RandomSeed (Event () (Stream ADC))

Defined in Copilot.Arduino.Library.Random

Methods

(=:) :: RandomSeed -> Event () (Stream ADC) -> GenSketch Arduino ()

(ShowCType t, EEPROMable t) => Input Arduino (RangeReads t) t

Defined in Copilot.Arduino.Library.EEPROMex

Methods

input' :: RangeReads t -> [t] -> GenSketch Arduino (Behavior t)

EEPROMable t => Output Arduino (Range t) (RangeWrites t)

Defined in Copilot.Arduino.Library.EEPROMex

Methods

(=:) :: Range t -> RangeWrites t -> GenSketch Arduino ()

EEPROMable t => Output Arduino (Range t) (Event () (RangeWrites t))

Defined in Copilot.Arduino.Library.EEPROMex

Methods

(=:) :: Range t -> Event () (RangeWrites t) -> GenSketch Arduino ()

EEPROMable t => Output Arduino (Location t) (Event () (Stream t))

Defined in Copilot.Arduino.Library.EEPROMex

Methods

(=:) :: Location t -> Event () (Stream t) -> GenSketch Arduino ()

IsAnalogInputPin t => Input Arduino (Pin t) ADC

Defined in Copilot.Arduino.Internals

Methods

input' :: Pin t -> [ADC] -> GenSketch Arduino (Behavior ADC)

IsDigitalIOPin t => Input Arduino (Pin t) Bool

Defined in Copilot.Arduino.Internals

Methods

input' :: Pin t -> [Bool] -> GenSketch Arduino (Behavior Bool)

IsPWMPin t => Output Arduino (Pin t) (Event 'PWM (Stream Word8))

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Pin t -> Event 'PWM (Stream Word8) -> GenSketch Arduino ()

IsDigitalIOPin t => Output Arduino (Pin t) (Event () (Stream Bool))

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Pin t -> Event () (Stream Bool) -> GenSketch Arduino ()

newtype Pin t

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.

A type-level list indicates how a Pin can be used, so the haskell compiler will detect impossible uses of pins.

Constructors

Pin Arduino

Instances

IsAnalogInputPin t => Input Arduino (Pin t) ADC

Defined in Copilot.Arduino.Internals

Methods

input' :: Pin t -> [ADC] -> GenSketch Arduino (Behavior ADC)

IsDigitalIOPin t => Input Arduino (Pin t) Bool

Defined in Copilot.Arduino.Internals

Methods

input' :: Pin t -> [Bool] -> GenSketch Arduino (Behavior Bool)

IsPWMPin t => Output Arduino (Pin t) (Event 'PWM (Stream Word8))

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Pin t -> Event 'PWM (Stream Word8) -> GenSketch Arduino ()

IsDigitalIOPin t => Output Arduino (Pin t) (Event () (Stream Bool))

Defined in Copilot.Arduino.Internals

Methods

(=:) :: Pin t -> Event () (Stream Bool) -> GenSketch Arduino ()

Eq (Pin t)

Defined in Copilot.Arduino.Internals

Methods

(==) :: Pin t -> Pin t -> Bool

(/=) :: Pin t -> Pin t -> Bool

Ord (Pin t)

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)

Defined in Copilot.Arduino.Internals

Methods

showsPrec :: Int -> Pin t -> ShowS

show :: Pin t -> String

showList :: [Pin t] -> ShowS

type Framework = GenFramework Arduino

The framework of a sketch.

type Sketch = GenSketch Arduino

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

module Sketch.FRP.Copilot.Internals

module Sketch.FRP.Copilot.Types

module Sketch.FRP.Copilot