API Reference

Dashboard builder and launcher

launch

Launch a serial dashboard.

app

Returns a function that can be used as a Bokeh app.

Serial communication utilities

SerialConnection

Class containing details about a serial connection.

comms.read_all

Read all available bytes from the serial port and append to the read buffer.

comms.read_all_newlines

Read data in until encountering newlines.

comms.device_name

Generate a name for a device at a given port.

comms.handshake_board

Connect to board by closing, then opening connection, discarding anything that may be in the input buffer.

comms.daq_stream

Obtain streaming data

comms.port_search

Search for ports and update dictionary of ports.

Parsers

parsers.parse_read

Parse a read with incoming delimited data.

parsers.data_to_dicts

Take in data as a list of lists and converts to a list of dictionaries that can be used to stream into the ColumnDataSources.

parsers.fill_nans

Right-fill NaNs into an array so that each row has the same number of entries.

parsers.backfill_nans

Given a 2D Numpy array, right-append an array of NaNs such that there are ncols in the resulting array.