Safe Haskell	Safe-Inferred
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

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

Documentation

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

Instances details

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

newtype SerialDevice Source #

Constructors

SerialDevice SerialDeviceName

Instances

Instances details

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

data FormatOutput Source #

Constructors

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

Instances

Instances details

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

class OutputString t where Source #

Methods

str :: t -> FormatOutput Source #

Use this to output a String or FlashString

Instances

Instances details

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

class FormatableType t f where Source #

Methods

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

Instances

Instances details

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 #

data Base Source #

Constructors

BIN
OCT
DEC
HEX

Instances

Instances details

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 #

newtype SerialDeviceName Source #

Eg "Serial" or "Serial2"

Constructors

SerialDeviceName String

newtype Baud Source #

Constructors

Baud Int

Instances

Instances details

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

char :: Char -> FormatOutput Source #

Use this to output a Char.

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.

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"

byte :: Stream Int8 -> FormatOutput Source #

Write a byte to the serial port.

byteArray :: KnownNat n => Stream (Array n Int8) -> FormatOutput Source #

Write an array of bytes to the serial port.

noInput :: Int8 Source #

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

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

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

quoteString :: String -> String Source #

type family IsDigitalIOPin (t :: [PinCapabilities]) where ... #

Equations

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