machine

Documentation

Overview

Package machine contains all structs and functions related to the object model.

Index

• type MachineModel
  • func NewMachineModel() *MachineModel

Types

type MachineModel

type MachineModel struct {
	// Boards holds the list of connected boards
	Boards []boards.Board `json:"boards"`
	// Directories holds information about the individual directories
	Directories directories.Directories `json:"directories"`
	// Fans is a list of configured fans
	Fans []fans.Fan `json:"fans"`
	// Heat holds information about the heat subsystem
	Heat heat.Heat `json:"heat"`
	// HttpEndpoints is a list of registered third-party HTTP endpoints
	HttpEndpoints []httpendpoints.HttpEndpoint `json:"httpEndpoints"`
	// Inputs holds information about every available G/M/T-code channel
	Inputs inputs.Inputs `json:"inputs"`
	// Job holds information about the current file job (if any)
	Job job.Job `json:"job"`
	// Limits are machine configuration limits
	Limits limits.Limits `json:"limits"`
	// Messages is a list of generic messages that do not belong explicitly to codes
	// being executed. This includes status message, generic errors and outputs generated
	// by M118
	Messages []messages.Message `json:"messages"`
	// Move holds information about the move subsystem
	Move move.Move `json:"move"`
	// Network holds information about connected network adapters
	Network network.Network `json:"network"`
	// Plugins is the map of loaded SBC plugins where each key is the plugin identifier
	Plugins map[string]plugins.Plugin
	// Scanner holds information about the 3D scanner subsystem
	Scanner scanner.Scanner `json:"scanner"`
	// Sensors holds information about connected sensors including Z-probes and endstops
	Sensors sensors.Sensors `json:"sensors"`
	// Spindles is a list of configured CNC spindles
	Spindles []spindles.Spindle `json:"spindles"`
	// State holds information about the machine state
	State state.State `json:"state"`
	// Tools is a list of configure tools
	Tools []tool.Tool `json:"tools"`
	// UserSessions is a list of user session
	UserSessions []usersessions.UserSession `json:"userSessions"`
	// UserVariables is a list of user-defined variables
	// Deprecated: Do not use this field. This will probably be changed to a map in the future.
	UserVariables []uservariables.UserVariable `json:"-"`
	// Volumes holds a list of available mass storages
	Volumes []volume.Volume `json:"volumes"`
}

MachineModel represents the full machine model as maintained by DuetControlServer

func NewMachineModel

func NewMachineModel() *MachineModel

NewMachineModel creates a new MachineModel