inquiry

package
v0.5.8 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (
	// Basic inquiries from the main service to the modules
	InquiryInformation = "InquiryInformation" // called to request information from the system
	InquiryRender      = "InquiryRender"      // called to render the module
)
View Source
const (
	Modules = iota
	Module
)

Variables

This section is empty.

Functions

This section is empty.

Types

type InquiryInformationPayload

type InquiryInformationPayload struct {
	Type    int
	Payload any
}

type InquiryRenderPayload

type InquiryRenderPayload struct {
	Format  string // Format choosen, e.g. raw, H264, H265, Jpeg
	Channel string // IPC, PubSub, REST

	FPS  int           // FPS choosen for the video stream, e.g. 30, 60, must be bigger than 0
	Time time.Duration // Duration; FPS * Time = Animation length; optional zero value means until ringbuffer closes

	MaxFrameSize int           // max frame size, i.e. custom size, FullHD, 4K
	Timeout      time.Duration // Duration to context timeout on receiver site while waiting for new data. Max should be 1sec/FPS
}

type ModuleInformation

type ModuleInformation struct {
	ID            string        // ID of the module
	Name          string        // Name of the module
	Ready         bool          // Is the module ready to receive orders
	Changes       []string      // List of changes the module can receive
	Heartbeat     time.Duration // Duration between each heartbeat, for debugging and logging purposes
	LastHeartbeat time.Time     // Last time the module sent a heartbeat, for debugging and logging purposes
}

type ModulesPayload

type ModulesPayload struct {
	Modules []ModuleInformation // Information about the active modules
}

Jump to

Keyboard shortcuts

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