Copilot.Arduino.Library.Serial

Serial port library for arduino-copilot.

This module is designed to be imported qualified as Serial

Documentation

baud :: Int -> Sketch ()

Configure the baud rate of the serial port.

This must be included in your sketch if it uses the serial port.

output

Arguments

:: Stream Bool

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

-> [FormatOutput]

-> Sketch ()

Output to the serial port.

Note that this can only be used once in a Sketch.

main = arduino $ do
	Serial.baud 9600
	b <- readfrom pin3
	n <- readvoltage a1
	Serial.output true
		[ Serial.str "pin3:"
		, Serial.show b
		, Serial.str " a1:"
		, Serial.show n
		, Serial.char '\n'
		]

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.

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.show (constant (1.234 :: Float)) 2 -- "1.23"

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

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

input :: Input Int8

Input from the serial port.

Reads one byte on each iteration of the sketch. When there is no serial input available, reads noInput.

userinput <- Serial.input

input' :: [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.

class ShowableType t

Minimal complete definition

showCType

Instances

ShowableType Bool

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Bool -> String

ShowableType Double

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Double -> String

ShowableType Float

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Float -> String

ShowableType Int8

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Int8 -> String

ShowableType Int16

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Int16 -> String

ShowableType Int32

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Int32 -> String

ShowableType Int64

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Int64 -> String

ShowableType Word8

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Word8 -> String

ShowableType Word16

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Word16 -> String

ShowableType Word32

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Word32 -> String

ShowableType Word64

Defined in Copilot.Arduino.Library.Serial

Methods

showCType :: Proxy Word64 -> String

class FormatableType t f

Minimal complete definition

formatter

Instances

FormatableType Float Int

Defined in Copilot.Arduino.Library.Serial

Methods

formatter :: Proxy Float -> Int -> String

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

Defined in Copilot.Arduino.Library.Serial

Methods

formatter :: Proxy t -> Base -> String

data Base

Constructors

BIN

OCT

DEC

HEX

Instances

Show Base

Defined in Copilot.Arduino.Library.Serial

Methods

showsPrec :: Int -> Base -> ShowS

show :: Base -> String

showList :: [Base] -> ShowS

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

Defined in Copilot.Arduino.Library.Serial

Methods

formatter :: Proxy t -> Base -> String