Safe Haskell	None
Language	Haskell2010

Copilot.Arduino.Library.Serial.Device

Description

This module be used to create a new module targeting a specific serial device. See CoPilot.Arduino.Library.Serial and CoPilot.Arduino.Library.Serial.XBee for examples.

Synopsis

data Base
- = BIN
- | OCT
- | DEC
- | HEX
class FormatableType t f where
- formatter :: Proxy t -> f -> String
newtype FlashString = FlashString String
class OutputString t where
- str :: t -> FormatOutput
data FormatOutput = FormatOutput {
- formatArg :: Maybe Arg
- formatCType :: Maybe String
- formatCLine :: SerialDeviceName -> String -> CLine
}
newtype SerialDevice = SerialDevice SerialDeviceName
newtype Baud = Baud Int
newtype SerialDeviceName = SerialDeviceName String
baudD :: SerialDeviceName -> Int -> Sketch ()
configureD :: (IsDigitalIOPin rx, IsDigitalIOPin tx) => SerialDeviceName -> Pin rx -> Pin tx -> Baud -> Sketch ()
noInput :: Int8
char :: Char -> FormatOutput
quoteString :: String -> String
show :: forall t. (ShowCType t, Typed t) => Stream t -> FormatOutput
byte :: Stream Int8 -> FormatOutput
showFormatted :: forall t f. (ShowCType t, Typed t, FormatableType t f) => Stream t -> f -> FormatOutput
type family IsDigitalIOPin t where ...

Documentation

data Base Source #

Constructors

BIN
OCT
DEC
HEX

Instances

Show Base Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods showsPrec :: Int -> Base -> ShowS # show :: Base -> String # showList :: [Base] -> ShowS #
Integral t => FormatableType (t :: Type) Base Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods formatter :: Proxy t -> Base -> String Source #

class FormatableType t f where Source #

Methods

formatter :: Proxy t -> f -> String Source #

Instances

FormatableType Float Int Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods formatter :: Proxy Float -> Int -> String Source #
Integral t => FormatableType (t :: Type) Base Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods formatter :: Proxy t -> Base -> String Source #

newtype FlashString Source #

Normally a String will be copied into ram before it is output. A FlashString will be output directly from flash memory.

Using this with str will reduce the amount of memory used by your program, but will likely slightly increase the size of the program.

Constructors

FlashString String

Instances

OutputString FlashString Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods str :: FlashString -> FormatOutput Source #

class OutputString t where Source #

Methods

str :: t -> FormatOutput Source #

Use this to output a String or FlashString

Instances

OutputString String Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods str :: String -> FormatOutput Source #
OutputString FlashString Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods str :: FlashString -> FormatOutput Source #

data FormatOutput Source #

Constructors

FormatOutput
Fields formatArg :: Maybe Arg formatCType :: Maybe String formatCLine :: SerialDeviceName -> String -> CLine

Instances

Output SerialDevice [FormatOutput] Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (=:) :: SerialDevice -> [FormatOutput] -> Sketch () Source #
Output SerialDevice (Event () [FormatOutput]) Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (=:) :: SerialDevice -> Event () [FormatOutput] -> Sketch () Source #
IsBehavior [FormatOutput] Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (@:) :: [FormatOutput] -> Behavior Bool -> BehaviorToEvent [FormatOutput] Source #
type BehaviorToEvent [FormatOutput] Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device type BehaviorToEvent [FormatOutput] = Event () [FormatOutput]

newtype SerialDevice Source #

Constructors

SerialDevice SerialDeviceName

Instances

Input SerialDevice Int8 Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods input' :: SerialDevice -> [Int8] -> Sketch (Behavior Int8) Source #
Output SerialDevice [FormatOutput] Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (=:) :: SerialDevice -> [FormatOutput] -> Sketch () Source #
Output SerialDevice (Event () [FormatOutput]) Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (=:) :: SerialDevice -> Event () [FormatOutput] -> Sketch () Source #

newtype Baud Source #

Constructors

Baud Int

Instances

Eq Baud Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods (==) :: Baud -> Baud -> Bool # (/=) :: Baud -> Baud -> Bool #
Show Baud Source #
Instance details Defined in Copilot.Arduino.Library.Serial.Device Methods showsPrec :: Int -> Baud -> ShowS # show :: Baud -> String # showList :: [Baud] -> ShowS #

newtype SerialDeviceName Source #

Eg "Serial" or "Serial2"

Constructors

SerialDeviceName String

baudD :: SerialDeviceName -> Int -> Sketch () Source #

configureD :: (IsDigitalIOPin rx, IsDigitalIOPin tx) => SerialDeviceName -> Pin rx -> Pin tx -> Baud -> Sketch () Source #

noInput :: Int8 Source #

Value that is read from serial port when there is no input available.

char :: Char -> FormatOutput Source #

Use this to output a Char.

quoteString :: String -> String Source #

show :: forall t. (ShowCType t, Typed t) => Stream t -> FormatOutput Source #

Use this to show the current value of a Stream.

Numbers will be formatted in decimal. Bool is displayed as 0 and 1.

byte :: Stream Int8 -> FormatOutput Source #

Write a byte to the serial port.

showFormatted :: forall t f. (ShowCType t, Typed t, FormatableType t f) => Stream t -> f -> FormatOutput Source #

Show the current value of a Stream with control over the formatting.

When used with a Float, provide the number of decimal places to show.

Serial.showFormatted (constant (1.234 :: Float)) 2 -- "1.23"

When used with any Integral type, provide the Base to display it in

Serial.showFormatted (constant (78 :: Int8)) Serial.HEX -- "4E"

type family IsDigitalIOPin t where ... Source #

Equations

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