order

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Apr 1, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Basic orders from the main service to the modules
	OrderStartUp  = "OrderStartUp"  // called during startup procedore, after configuration is readed
	OrderShutdown = "OrderShutdown" // called to shutdown the module, i.e. idle mode
	OrderReboot   = "OrderReboot"   // called to reboot the module, i.e. unexpected error or response
	OrderUpdate   = "OrderUpdate"   // called to update the module, i.e. update data or state
	OrderRender   = "OrderRender"   // called to render the module, i.e. draw the module on the output
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Order

type Order struct {
	From    string
	To      string
	Order   string
	Payload any
}

type OrderRenderPayload

type OrderRenderPayload struct {
	SizeX int // size of the output to render on
	SizeY int // size of the output to render on
}

type OrderStartUpPayload

type OrderStartUpPayload struct {
	QueuePosition int // Position of the module
}

type OrderUpdatePayload

type OrderUpdatePayload struct {
	Order      string // detailed order
	OrderValue any    // order value
}

Jump to

Keyboard shortcuts

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