Safe Haskell	Safe-Inferred
Language	Haskell2010

Copilot.Zephyr.Internals

Description

You should not need to import this module unless you're adding support for a specific board supported by Zephyr, or a Zephyr library.

Synopsis

type Framework = GenFramework Zephyr
type Sketch = GenSketch Zephyr
newtype Pin t = Pin Zephyr
data Zephyr = Zephyr GPIOAlias GPIOAddress
newtype GPIOAlias = GPIOAlias String
data GPIOAddress
- = GPIOAddress String
- | GPIOAddressBuiltIn
type ADC = Int16
pinDevVar :: String -> String
pinDevDef :: String -> String
pinDevNode :: String -> String
module Sketch.FRP.Copilot.Internals
module Sketch.FRP.Copilot.Types
module Sketch.FRP.Copilot

Documentation

type Framework = GenFramework Zephyr Source #

The framework of a sketch.

type Sketch = GenSketch Zephyr Source #

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.

newtype Pin t Source #

A pin on the board.

For definitions of specific pins, load a module 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 Zephyr

Instances

Instances details

IsAnalogInputPin t => Input Zephyr (Pin t) ADC Source #
Instance details Defined in Copilot.Zephyr.Internals Methods input' :: Pin t -> [ADC] -> GenSketch Zephyr (Behavior ADC) #
IsDigitalIOPin t => Input Zephyr (Pin t) Bool Source #
Instance details Defined in Copilot.Zephyr.Internals Methods input' :: Pin t -> [Bool] -> GenSketch Zephyr (Behavior Bool) #
IsPWMPin t => Output Zephyr (Pin t) (Event 'PWM (Stream Word8)) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Pin t -> Event 'PWM (Stream Word8) -> GenSketch Zephyr () #
IsDigitalIOPin t => Output Zephyr (Pin t) (Event () (Stream Bool)) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Pin t -> Event () (Stream Bool) -> GenSketch Zephyr () #
Show (Pin t) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods showsPrec :: Int -> Pin t -> ShowS # show :: Pin t -> String # showList :: [Pin t] -> ShowS #
Eq (Pin t) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (==) :: Pin t -> Pin t -> Bool # (/=) :: Pin t -> Pin t -> Bool #
Ord (Pin t) Source #
Instance details Defined in Copilot.Zephyr.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 #

data Zephyr Source #

Indicates that you're programming a board with Zephyr. The similar library arduino-copilot allows programming Arduinos in a very similar style to this one.

Constructors

Zephyr GPIOAlias GPIOAddress

Instances

Instances details

Show Zephyr Source #
Instance details Defined in Copilot.Zephyr.Internals Methods showsPrec :: Int -> Zephyr -> ShowS # show :: Zephyr -> String # showList :: [Zephyr] -> ShowS #
Eq Zephyr Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (==) :: Zephyr -> Zephyr -> Bool # (/=) :: Zephyr -> Zephyr -> Bool #
Ord Zephyr Source #
Instance details Defined in Copilot.Zephyr.Internals Methods compare :: Zephyr -> Zephyr -> Ordering # (<) :: Zephyr -> Zephyr -> Bool # (<=) :: Zephyr -> Zephyr -> Bool # (>) :: Zephyr -> Zephyr -> Bool # (>=) :: Zephyr -> Zephyr -> Bool # max :: Zephyr -> Zephyr -> Zephyr # min :: Zephyr -> Zephyr -> Zephyr #
Context Zephyr Source #
Instance details Defined in Copilot.Zephyr.Internals
Output Zephyr Delay MicroSeconds Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Delay -> MicroSeconds -> GenSketch Zephyr () #
Output Zephyr Delay MilliSeconds Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Delay -> MilliSeconds -> GenSketch Zephyr () #
IsAnalogInputPin t => Input Zephyr (Pin t) ADC Source #
Instance details Defined in Copilot.Zephyr.Internals Methods input' :: Pin t -> [ADC] -> GenSketch Zephyr (Behavior ADC) #
IsDigitalIOPin t => Input Zephyr (Pin t) Bool Source #
Instance details Defined in Copilot.Zephyr.Internals Methods input' :: Pin t -> [Bool] -> GenSketch Zephyr (Behavior Bool) #
IsPWMPin t => Output Zephyr (Pin t) (Event 'PWM (Stream Word8)) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Pin t -> Event 'PWM (Stream Word8) -> GenSketch Zephyr () #
IsDigitalIOPin t => Output Zephyr (Pin t) (Event () (Stream Bool)) Source #
Instance details Defined in Copilot.Zephyr.Internals Methods (=:) :: Pin t -> Event () (Stream Bool) -> GenSketch Zephyr () #

newtype GPIOAlias Source #

Constructors

GPIOAlias String

Instances

Instances details

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

data GPIOAddress Source #

Constructors

GPIOAddress String	Eg "porta 17"
GPIOAddressBuiltIn	Use when Zephyr defines the GPIO address for a GPIOAlias.

Instances

Instances details

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

type ADC = Int16 Source #

Value read from an ADC. Ranges from 0-1023.

pinDevVar :: String -> String Source #

pinDevDef :: String -> String Source #

pinDevNode :: String -> String Source #

module Sketch.FRP.Copilot.Internals

module Sketch.FRP.Copilot.Types

module Sketch.FRP.Copilot