https://github.com/flxzt/splot

A multi-platform serial plotter and monitor
https://github.com/flxzt/splot

Last synced: 21 days ago
JSON representation

A multi-platform serial plotter and monitor

• Host: GitHub
• URL: https://github.com/flxzt/splot
• Owner: flxzt
• License: gpl-3.0
• Created: 2022-11-06T13:31:06.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T18:16:44.000Z (8 months ago)
• Last Synced: 2024-05-02T03:03:35.321Z (7 months ago)
• Language: Rust
• Homepage:
• Size: 331 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-GPL3

Awesome Lists containing this project

README

        






# Splot

[![CI](https://github.com/flxzt/splot/actions/workflows/ci.yml/badge.svg)](https://github.com/flxzt/splot/actions/workflows/ci.yml)

A multi-platform serial plotter and monitor.

### Build and run natively

On debian based distros some packages are needed, which can be installed with:

`sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev libudev-dev`

For fedora based distros:

`sudo dnf install clang clang-devel clang-tools-extra speech-dispatcher-devel libxkbcommon-devel pkg-config openssl-devel libxcb-devel fontconfig-devel libudev-devel`

Then build and run the app:

`cargo run --release`

Install with:

`cargo install --path .`

And copy the desktop file to `.local/share/applications`.

### Run web for developing

The app can be compiled to [WASM](https://en.wikipedia.org/wiki/WebAssembly) and published as a web page.

To compile with the Web Serial API enabled, first set the environment variable for it with:

`export RUSTFLAGS=--cfg=web_sys_unstable_apis`.

[Trunk](https://trunkrs.dev/) is used to build for web target.

- Install Trunk with `cargo install --locked trunk`.

- Run `trunk serve` to build and serve on `http://127.0.0.1:8080`. It will use the default `Trunk.toml` configuration

    file and will rebuild automatically if you edit the project.

- Open `http://127.0.0.1:8080/index.html#dev` in a browser. See the warning below.

> `assets/sw.js` script will try to cache our app, and loads the cached version when it cannot connect to server

    allowing your app to work offline (like PWA).

> appending `#dev` to `index.html` will skip this caching, allowing us to load the latest builds during development.

### Deploy web

Execute:

```bash

RUSTFLAGS=--cfg=web_sys_unstable_apis trunk --config Trunk_Release.toml build

```

### License



Licensed under GPL-3.0-or-later license.