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

newtype FlashString

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

Defined in Copilot.Arduino.Library.Serial.Device

Methods

str :: FlashString -> FormatOutput

class OutputString t where

Methods

str :: t -> FormatOutput

Use this to output a String or FlashString

Instances

OutputString String

Defined in Copilot.Arduino.Library.Serial.Device

Methods

str :: String -> FormatOutput

OutputString FlashString

Defined in Copilot.Arduino.Library.Serial.Device

Methods

str :: FlashString -> FormatOutput

data FormatOutput

Constructors

FormatOutput

Fields

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

Instances

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 ()

IsBehavior [FormatOutput]

Defined in Copilot.Arduino.Library.Serial.Device

Methods

(@:) :: [FormatOutput] -> Behavior Bool -> BehaviorToEvent [FormatOutput]

type BehaviorToEvent [FormatOutput]

Defined in Copilot.Arduino.Library.Serial.Device

type BehaviorToEvent [FormatOutput] = Event () [FormatOutput]

newtype SerialDevice

Constructors

SerialDevice SerialDeviceName

Instances

Input Arduino SerialDevice Int8

Defined in Copilot.Arduino.Library.Serial.Device

Methods

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

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 ()

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 ()

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

noInput :: Int8

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

char :: Char -> FormatOutput

Use this to output a Char.

quoteString :: String -> String

show :: forall t. (ShowCType 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.

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

Write an array of bytes to the serial port.

showFormatted :: forall t f. (ShowCType 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"

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)