builtin

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Jun 9, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package builtin contains built-in modules compiled into the host

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClockFace

type ClockFace int

ClockFace controls the visual style of the clock zone.

const (
	ClockFaceDigital     ClockFace = iota // "HH:MM [AM/PM]" primary, date secondary
	ClockFaceTimeOnly                     // time only, no secondary — fills zone
	ClockFaceWithSeconds                  // "HH:MM:SS [AM/PM]" primary, date secondary
	ClockFaceDateFirst                    // date primary (large), time secondary (small)
	ClockFaceAnalog                       // hand-drawn analog face rendered to RawFrame
)

type ClockFormat

type ClockFormat int

ClockFormat describes the hour convention for digital faces.

const (
	ClockFormat12Hour ClockFormat = iota
	ClockFormat24Hour
)

type ClockPlugin

type ClockPlugin struct {
	// contains filtered or unexported fields
}

ClockPlugin displays current time and date.

func NewClock

func NewClock() *ClockPlugin

NewClock creates a new clock plugin with defaults.

func NewClock24

func NewClock24() *ClockPlugin

NewClock24 returns a 24-hour clock plugin.

func NewClockWithFormat

func NewClockWithFormat(format ClockFormat) *ClockPlugin

NewClockWithFormat creates a clock plugin with the requested hour format.

func (*ClockPlugin) Configure

func (m *ClockPlugin) Configure(cfg map[string]any) error

Configure applies zone-level plugin configuration.

func (*ClockPlugin) Describe

func (m *ClockPlugin) Describe() (plugin.Descriptor, error)

Describe returns plugin metadata.

func (*ClockPlugin) Sample

func (m *ClockPlugin) Sample() (plugin.Payload, error)

Sample returns the current time payload for the configured face.

type DebugPlugin

type DebugPlugin struct {
	// contains filtered or unexported fields
}

DebugPlugin displays debug information about the zone

func NewDebug

func NewDebug(zoneID string, width int) *DebugPlugin

NewDebug creates a new debug plugin

func (*DebugPlugin) Configure

func (m *DebugPlugin) Configure(_ map[string]any) error

Configure implements plugin.Plugin. Debug has no configurable fields.

func (*DebugPlugin) Describe

func (m *DebugPlugin) Describe() (plugin.Descriptor, error)

Describe returns plugin metadata

func (*DebugPlugin) Sample

func (m *DebugPlugin) Sample() (plugin.Payload, error)

Sample returns debug payload

type PlaceholderPlugin

type PlaceholderPlugin struct {
	// contains filtered or unexported fields
}

PlaceholderPlugin displays a placeholder message (for loading/errors)

func NewPlaceholder

func NewPlaceholder(message string) *PlaceholderPlugin

NewPlaceholder creates a new placeholder plugin

func (*PlaceholderPlugin) Configure

func (m *PlaceholderPlugin) Configure(_ map[string]any) error

Configure implements plugin.Plugin. Placeholder has no configurable fields.

func (*PlaceholderPlugin) Describe

func (m *PlaceholderPlugin) Describe() (plugin.Descriptor, error)

Describe returns plugin metadata

func (*PlaceholderPlugin) Sample

func (m *PlaceholderPlugin) Sample() (plugin.Payload, error)

Sample returns placeholder payload

Jump to

Keyboard shortcuts

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