Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ishuah/bifrost

🌈 burning rainbow bridge between your terminal and serial ports
https://github.com/ishuah/bifrost

kalamashaka serial-port terminal-emulator

Last synced: about 2 months ago
JSON representation

🌈 burning rainbow bridge between your terminal and serial ports

Host: GitHub
URL: https://github.com/ishuah/bifrost
Owner: ishuah
License: mit
Created: 2018-02-16T16:21:50.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2021-01-29T18:01:44.000Z (over 3 years ago)
Last Synced: 2024-04-15T02:47:31.008Z (2 months ago)
Topics: kalamashaka, serial-port, terminal-emulator
Language: Go
Homepage:
Size: 53.7 KB
Stars: 77
Watchers: 5
Forks: 10
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Lists

open-source-mac-os-apps - Bifrost - A tiny terminal emulator for serial port communication (macOS/Linux). ![go_icon] (Applications / Terminal)
awesome-stars - bifrost

README

# 🌈 bifrost
[![Go Report Card](https://goreportcard.com/badge/github.com/ishuah/bifrost)](https://goreportcard.com/report/github.com/ishuah/bifrost)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fishuah%2Fbifrost.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fishuah%2Fbifrost?ref=badge_shield)

Bifrost is a tiny terminal emulator for serial port communication. Supports USB type-C out of the box (2016+ Macbook friendly).

Note: Only Linux and OSX are currenly supported. Windows will be supported in subsequent releases.

## Installation
- Download the latest version from the releases page (https://github.com/ishuah/bifrost/releases)

On linux:
- Unzip and copy binary to `/usr/bin/`
```
unzip bifrost--linux-amd64.zip
cd bifrost--linux-amd64
sudo cp bifrost /usr/bin/
sudo chown root:root /usr/bin/bifrost
sudo chmod 755 /usr/bin/bifrost
```
On OSX/MacOS:
- Unzip and copy binary to `/usr/local/bin/`
```
sudo mkdir -p /usr/local/bin
unzip bifrost--darwin-amd64.zip
cd bifrost--darwin-amd64
sudo cp bifrost /usr/local/bin/
```

- Run `bifrost -help` to confirm bifrost was installed correctly.

## Usage
Bifrost takes `-port-path` and `-baud` as parameters. By default `-port-path` is set to `/dev/tty.usbserial`
and `-baud` is set to 115200.

Example usage:

```
bifrost -port-path="/dev/ttyUSB0" -baud=128000
```

On Linux the serial port adapter path is /dev/ttyUSB0, /dev/ttyUSB1 and so on. Some USB serial port adapters may appear as /dev/ttyACM0.

On OSX/MacOS the serial port adapter path is /dev/tty.usbserial.

The default baud rate 115200 works for most serial connection but you may want to confirm the optimal baud rate for the device you're connecting to.

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fishuah%2Fbifrost.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fishuah%2Fbifrost?ref=badge_large)