nightscout-menu-bar

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2024 License: MIT Imports: 5 Imported by: 0

README

Nightscout Menu Bar

Build Go Report Card Quality Gate Status

A small application that displays live blood sugar data from Nightscout on your menu bar.

Works on Windows, MacOS, and Linux.

macOS Screenshot

Install

Brew (macOS)
brew install gabe565/tap/nightscout-menu-bar --no-quarantine
Binary

Automated builds are uploaded during the release process. See the latest release for download links.

Usage

After launching Nightscout Menu Bar, you will need to open its tray menu, then hover over "Preferences" to configure the integration.

The preferences menu contains the following options:

  • Nightscout URL (required)
  • API Token
  • Units: mg/dL or mmol/L
  • Start on login
  • Write to a local file (see contrib/powerlevel10k)

Additional configuration is available in a configuration file, which can be found in the following locations:

  • Windows: %AppData%\nightscout-menu-bar\config.toml
  • macOS: ~/Library/Application Support/nightscout-menu-bar/config.toml
  • Linux: ~/.config/nightscout-menu-bar/config.toml

Contrib

Integrations with external tools are available in the contrib directory.

Development

The systray menu is provided by fyne.io/systray. See systray's platform notes for required dependencies.

macOS

To generate a Mac app, run hack/build-darwin.sh. An app will be created in the dist directory.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL