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.

device :: SerialDevice

Use this to communicate with the serial port, both input and output.

To output to the serial port, simply connect this to a [FormatOutput] that describes the serial output.

main = arduino $ do
	Serial.baud 9600
	b <- input pin4
	Serial.device =:
		[ Serial.str "pin4:"
		, Serial.show b
		, Serial.char '\n'
		]

You can output different things to a serial port at different times, eg using whenB, but note that if multiple outputs are sent at the same time, the actual order is not defined. This example may output "world" before "hello"

Serial.device =: [Serial.str "hello "]
Serial.device =: [Serial.str "world"]

To input from the serial port, use this with input.

userinput <- input Serial.device

The resulting `Behavior Int8` will be updated on each iteration of the sketch. When there is no new serial input available, it will contain noInput.

Note: When a Sketch that does serial output is sumulated (with -i), Copilot does not display the static strings (str) that are output to the serial port, but it does output the changing values.

char :: Char -> FormatOutput

Use this to output a Char.

str :: OutputString t => t -> FormatOutput

Use this to output a String or FlashString

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

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.

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"

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.

noInput :: Int8

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

data SerialDevice

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

data FormatOutput

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]

class OutputString t

Minimal complete definition

str

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

class FormatableType t f

Minimal complete definition

formatter

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

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