Skip to content
Serial communication for UNIX and Windows.
C
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
breakfast.h
example.c

README.md

Breakfast

Serial communication library for UNIX and Windows.
Public domain, single-header.
by Benedict Henshaw, 2019

Just pop the file breakfast.h into your source folder, and #include it where you need it.

This library works great for communicating with an Arduino via USB cable. You just need the name of the port it is connected to, which you can find under Tools > Port within the Arduino Editor.

API

// Returns BF_BAD_HANDLE on failure.
bf_handle bf_open(char * serial_port_name, int baud);

// Returns number of bytes read, returns -1 on failure.
int bf_read(bf_handle handle, void * buffer, int byte_count);

// Returns number of bytes written, returns -1 on failure.
int bf_write(bf_handle handle, void * data, int byte_count);

void bf_close(bf_handle handle);

Tips

The function bf_open() takes a string that refers to a serial port.
On Windows it looks like: COM1, COM24, etc.
On UNIX it looks like: /dev/ttyUSB0, /dev/cu.usbmodem123, etc.

The following baud values are available in both UNIX and Windows:

110     300     600
1200    2400    4800
9600    19200   38400

Some of these values might not be supported by the hardware. There are also values supported only on Windows, or only on UNIX.

UNIX Windows
50 .
75 .
110 110
134 .
150 .
200 .
300 300
600 600
1200 1200
1800 .
2400 2400
4800 4800
9600 9600
. 14400
19200 19200
38400 38400
. 57600
. 115200
. 128000
. 256000

See Windows Supported Baud Rates.
See UNIX/POSIX Supported Baud Rates (near bottom of page).

You can’t perform that action at this time.