fbstatus

command module
v0.0.0-...-147dca1 Latest Latest
Warning

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

Go to latest
Published: Aug 18, 2024 License: Apache-2.0 Imports: 34 Imported by: 0

README

gokrazy framebuffer status (fbstatus)

fbstatus graphically shows the gokrazy system status on the Linux frame buffer, which is typically available via HDMI when running on a Raspberry Pi or a PC.

fbstatus screenshot

This graphical output is helpful to understand:

  1. whether gokrazy booted up correctly
  2. whether gokrazy’s NTP client obtained the correct time
  3. whether gokrazy’s DHCP client obtained an IP address
  4. the current resource usage of the system

Usage

Please refer to the gokrazy quickstart if you are unfamiliar.

The gok new command already adds the fbstatus package by default, so no further customization is needed. If you have removed the package for some reason, you can always re-add it with:

gok add github.com/gokrazy/fbstatus

After your Raspberry Pi reboots, you should eventually see the graphical output from the screenshot above on your HDMI monitor.

TODO

  • show ethernet interface(s) plugged-in state somehow?
  • show service log messages (stdout, stderr)
  • implement different views, switch between the different views via flag (rotate mode, switches every n=60 seconds between views)

Documentation

Overview

Program fbstatus graphically shows the gokrazy system status on the Linux frame buffer, which is typically available via HDMI when running on a Raspberry Pi or a PC.

Directories

Path Synopsis
internal
console
Package console allows working with Linux consoles in graphics mode, typically for using the Linux frame buffer.
Package console allows working with Linux consoles in graphics mode, typically for using the Linux frame buffer.
fb
Package fb implements Linux frame buffer interaction via ioctls and mmap.
Package fb implements Linux frame buffer interaction via ioctls and mmap.
fbimage
Package fbimage contains additional in-memory image format implementations that are useful for working with the Linux frame buffer.
Package fbimage contains additional in-memory image format implementations that are useful for working with the Linux frame buffer.
linuxvt
Package linuxvt contains type definitions for the Linux virtual console API, see https://manpages.debian.org/ioctl_console.2
Package linuxvt contains type definitions for the Linux virtual console API, see https://manpages.debian.org/ioctl_console.2

Jump to

Keyboard shortcuts

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