Class Settings

Settings provider

Inheritance

object

Settings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetControlServer

Assembly: DuetControlServer.dll

Syntax

public static class Settings

Properties

AutoUpdateFirmware

Defines whether the mainboard and expansion boards may be updated automatically during unattended upgrades

Declaration

public static bool AutoUpdateFirmware { get; set; }

Property Value

Type	Description
bool

Backlog

Maximum number of simultaneously pending IPC connections

Declaration

public static int Backlog { get; set; }

Property Value

Type	Description
int

BaseDirectory

Virtual SD card directory. Paths starting with 0:/ are mapped to this directory

Declaration

public static string BaseDirectory { get; set; }

Property Value

Type	Description
string

BufferedMacroCodes

Number of codes to buffer per macro

Declaration

public static int BufferedMacroCodes { get; set; }

Property Value

Type	Description
int

BufferedPrintCodes

Number of codes to buffer in the internal print subsystem

Declaration

public static int BufferedPrintCodes { get; set; }

Property Value

Type	Description
int

ConfigFilename

Path to the configuration file

Declaration

[JsonIgnore]
public static string ConfigFilename { get; set; }

Property Value

Type	Description
string

CpuTemperatureDivider

Divide numeric value of CpuTemperaturePath by this

Declaration

public static float CpuTemperatureDivider { get; set; }

Property Value

Type	Description
float

CpuTemperaturePath

File containing the current CPU temperature

Declaration

public static string CpuTemperaturePath { get; set; }

Property Value

Type	Description
string

FilamentFilters

Regular expressions for finding the filament consumption (case insensitive, single line)

Declaration

public static List<Regex> FilamentFilters { get; set; }

Property Value

Type	Description
List<Regex>

FileBufferSize

Size of the read buffer used when reading from files (in bytes)

Declaration

public static int FileBufferSize { get; set; }

Property Value

Type	Description
int

FileInfoReadLimitFooter

How many bytes to parse max at the end of a file to retrieve G-code file information (in bytes)

Declaration

public static int FileInfoReadLimitFooter { get; set; }

Property Value

Type	Description
int

FileInfoReadLimitHeader

How many bytes to parse max at the beginning of a file to retrieve G-code file information (in bytes)

Declaration

public static int FileInfoReadLimitHeader { get; set; }

Property Value

Type	Description
int

FirmwareComments

List of string chunks that are identified by RepRapFirmware

Declaration

public static List<string> FirmwareComments { get; set; }

Property Value

Type	Description
List<string>

Remarks

Only if a comment contains one of these identifiers they will be sent to the firmware

FullSocketPath

Fully-qualified path to the main IPC UNIX socket (evaluated during runtime)

Declaration

[JsonIgnore]
public static string FullSocketPath { get; }

Property Value

Type	Description
string

GeneratedByFilters

Regular expressions for finding the slicer (case insensitive)

Declaration

public static List<Regex> GeneratedByFilters { get; set; }

Property Value

Type	Description
List<Regex>

GpioChipDevice

Path to the GPIO chip device node

Declaration

public static string GpioChipDevice { get; set; }

Property Value

Type	Description
string

HostUpdateInterval

Internal model update interval after which properties of the machine model from the host controller (e.g. network information and mass storage devices) are updated (in ms)

Declaration

public static int HostUpdateInterval { get; set; }

Property Value

Type	Description
int

LayerHeightFilters

Regular expressions for finding the layer height (case insensitive)

Declaration

public static List<Regex> LayerHeightFilters { get; set; }

Property Value

Type	Description
List<Regex>

LogLevel

Minimum log level for console output

Declaration

public static LogLevel LogLevel { get; set; }

Property Value

Type	Description
LogLevel

MaxBufferSpacePerChannel

Maximum space of buffered codes per channel (in bytes)

Declaration

public static int MaxBufferSpacePerChannel { get; set; }

Property Value

Type	Description
int

MaxCodeBufferSize

Maximum size of a binary encoded G/M/T-code. This is limited by RepRapFirmware (see code queue)

Declaration

public static int MaxCodeBufferSize { get; set; }

Property Value

Type	Description
int

MaxCodesPerInput

Maximum number of pending codes per code channel

Declaration

public static int MaxCodesPerInput { get; set; }

Property Value

Type	Description
int

MaxLayerHeight

Maximum allowed layer height. Used by the file info parser

Declaration

public static double MaxLayerHeight { get; set; }

Property Value

Type	Description
double

MaxMachineModelLockTime

Maximum lock time of the object model. If this time is exceeded, a deadlock is reported and the application is terminated. Set this to -1 to disable the automatic deadlock detection

Declaration

public static int MaxMachineModelLockTime { get; set; }

Property Value

Type	Description
int

MaxMessageAge

Maximum time to keep messages in the object model unless client(s) pick them up (in s). Note that messages are only cleared when the host update task runs.

Declaration

public static double MaxMessageAge { get; set; }

Property Value

Type	Description
double

MaxMessageLength

Maximum supported length of messages to be sent to RepRapFirmware

Declaration

public static int MaxMessageLength { get; set; }

Property Value

Type	Description
int

MaxSpiRetries

Maximum number of sequential transfer retries

Declaration

public static int MaxSpiRetries { get; set; }

Property Value

Type	Description
int

ModelUpdateInterval

Interval of object model updates (in ms)

Declaration

public static int ModelUpdateInterval { get; set; }

Property Value

Type	Description
int

NoSpi

Do NOT start the SPI task. This is meant entirely for development purposes and should not be used!

Declaration

[JsonIgnore]
public static bool NoSpi { get; set; }

Property Value

Type	Description
bool

NoTerminateOnReset

Set this to true to prevent M999 from stopping this application

Declaration

public static bool NoTerminateOnReset { get; set; }

Property Value

Type	Description
bool

NumLayersFilters

Regular expressions for finding the total number of layers

Declaration

public static List<Regex> NumLayersFilters { get; set; }

Property Value

Type	Description
List<Regex>

Remarks

If the number of layers cannot be found, the total number of layers is calculated from the layer and object heights (if applicable)

PluginAutoRestartInterval

Time to wait before auto-restarting a stopped plugin that has the SbcAutoRestart option set

Declaration

public static int PluginAutoRestartInterval { get; set; }

Property Value

Type	Description
int

PluginDirectory

Directory holding DSF plugins

Declaration

public static string PluginDirectory { get; set; }

Property Value

Type	Description
string

Remarks

This directory is not created by the DCS package. It is provided by DPS

PluginSupport

Whether this DCS instance may support third-party plugins. If this is set to false, dsf-config.g will be run right after the start

Declaration

public static bool PluginSupport { get; set; }

Property Value

Type	Description
bool

PluginsFilename

Path to the file holding a list of loaded plugins

Declaration

public static string PluginsFilename { get; set; }

Property Value

Type	Description
string

PrintTimeFilters

Regular expressions for finding the print time

Declaration

public static List<Regex> PrintTimeFilters { get; set; }

Property Value

Type	Description
List<Regex>

RootPluginSupport

Whether this DCS instance may support third-party root plugins. This is only respected if PluginSupport is set to true

Declaration

public static bool RootPluginSupport { get; set; }

Property Value

Type	Description
bool

SimulatedTimeFilters

Regular expressions for finding the simulated time

Declaration

public static List<Regex> SimulatedTimeFilters { get; set; }

Property Value

Type	Description
List<Regex>

SocketDirectory

Directory in which DSF-related UNIX sockets reside

Declaration

public static string SocketDirectory { get; set; }

Property Value

Type	Description
string

SocketFile

UNIX socket file for DuetControlServer

Declaration

public static string SocketFile { get; set; }

Property Value

Type	Description
string

See Also

DuetAPI

SocketPollInterval

Poll interval for connected IPC clients (in ms)

Declaration

public static int SocketPollInterval { get; set; }

Property Value

Type	Description
int

SpiBufferSize

SPI Tx and Rx buffer size Should not be greater than the kernel spidev buffer size

Declaration

public static int SpiBufferSize { get; set; }

Property Value

Type	Description
int

SpiConnectTimeout

Maximum allowed time when waiting for the first SPI transfer (in ms)

Declaration

public static int SpiConnectTimeout { get; set; }

Property Value

Type	Description
int

SpiConnectionTimeout

Maximum allowed delay between full transfers (in ms)

Declaration

public static int SpiConnectionTimeout { get; set; }

Property Value

Type	Description
int

SpiDevice

SPI device that is connected to RepRapFirmware

Declaration

public static string SpiDevice { get; set; }

Property Value

Type	Description
string

SpiFrequency

Frequency to use for SPI transfers (in Hz)

Declaration

public static int SpiFrequency { get; set; }

Property Value

Type	Description
int

SpiTransferMode

SPI Transfer Mode 0-3

Declaration

public static int SpiTransferMode { get; set; }

Property Value

Type	Description
int

SpiTransferTimeout

Maximum allowed delay between data exchanges during a full transfer (in ms)

Declaration

public static int SpiTransferTimeout { get; set; }

Property Value

Type	Description
int

StartErrorFile

File to contain the last start error of DCS. Once DCS starts successfully, it is deleted

Declaration

public static string StartErrorFile { get; set; }

Property Value

Type	Description
string

TransferReadyPin

Number of the GPIO pin that is used by RepRapFirmware to flag its ready state

Declaration

public static int TransferReadyPin { get; set; }

Property Value

Type	Description
int

UpdateOnly

Indicates if this program is only launched to update the board firmware

Declaration

[JsonIgnore]
public static bool UpdateOnly { get; set; }

Property Value

Type	Description
bool

Methods

Init(string[])

Initialize settings and load them from the config file or create it if it does not exist

Declaration

public static bool Init(string[] args)

Parameters

Type	Name	Description
string[]	args

Returns

Type	Description
bool	False if the application is supposed to terminate