Copilot.Arduino.Library.Serial.Device

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.

Documentation

data Base

Constructors

BIN

OCT

DEC

HEX

Instances

Show Base

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showsPrec :: Int -> Base -> ShowS

show :: Base -> String

showList :: [Base] -> ShowS

Integral t => FormatableType (t :: Type) Base

Defined in Copilot.Arduino.Library.Serial.Device

Methods

formatter :: Proxy t -> Base -> String

class FormatableType t f where

Methods

formatter :: Proxy t -> f -> String

Instances

FormatableType Float Int

Defined in Copilot.Arduino.Library.Serial.Device

Methods

formatter :: Proxy Float -> Int -> String

Integral t => FormatableType (t :: Type) Base

Defined in Copilot.Arduino.Library.Serial.Device

Methods

formatter :: Proxy t -> Base -> String

class ShowableType t where

Methods

showCType :: Proxy t -> String

Instances

ShowableType Bool

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Bool -> String

ShowableType Double

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Double -> String

ShowableType Float

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Float -> String

ShowableType Int8

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Int8 -> String

ShowableType Int16

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Int16 -> String

ShowableType Int32

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Int32 -> String

ShowableType Int64

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Int64 -> String

ShowableType Word8

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Word8 -> String

ShowableType Word16

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Word16 -> String

ShowableType Word32

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Word32 -> String

ShowableType Word64

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showCType :: Proxy Word64 -> String

data FormatOutput

Constructors

FormatOutput

Fields

• formatArg :: Maybe Arg
• formatCType :: Maybe String
• formatCLine :: SerialDeviceName -> String -> CLine

newtype Baud

Constructors

Baud Int

Instances

Eq Baud

Defined in Copilot.Arduino.Library.Serial.Device

Methods

(==) :: Baud -> Baud -> Bool

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

Show Baud

Defined in Copilot.Arduino.Library.Serial.Device

Methods

showsPrec :: Int -> Baud -> ShowS

show :: Baud -> String

showList :: [Baud] -> ShowS

newtype SerialDeviceName

Eg Serial or Serial2

Constructors

SerialDeviceName String

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

deviceD :: (IsDigitalIOPin rx, IsDigitalIOPin tx) => SerialDeviceName -> Pin rx -> Pin tx -> Baud -> Sketch ()

outputD

Arguments

:: SerialDeviceName

-> Stream Bool

This Stream controls when output is sent to the serial port.

-> [FormatOutput]

-> Sketch ()

char :: Char -> FormatOutput

Use this to output a Char

str :: String -> FormatOutput

Use this to output a String

show :: forall t. (ShowableType t, Typed t) => Stream t -> FormatOutput

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

Write a byte to the serial port.

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

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"

inputD :: SerialDeviceName -> Input Int8

input'D :: SerialDeviceName -> [Int8] -> Input Int8

The list is used to simulate serial input when interpreting the program.

noInput :: Int8

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

type family IsDigitalIOPin t where ...

Equations

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