Interface ILinkAdapter

Namespace

DuetControlServer.Link.Adapter

Assembly

DuetControlServer.dll

Interface for hardware link adapters

public interface ILinkAdapter

Properties

PacketsToRead

Returns the number of packets to read

int PacketsToRead { get; }

Property Value

int

ProtocolVersion

Currently-used protocol version

int ProtocolVersion { get; }

Property Value

int

Methods

Connect(CancellationToken)

Attempt to connect to the firmware

void Connect(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional cancellation token

DumpMalformedPacket()

Write the last packet + content for diagnostic purposes

void DumpMalformedPacket()

FlashFirmwareSegment(Stream)

Flash another segment of the firmware via the IAP binary

bool FlashFirmwareSegment(Stream stream)

Parameters

stream Stream

Stream of the firmware binary

Returns

bool

Whether another segment could be sent

GetMaxFullTransferDelay()

Get the maximum time between two full transfers

double GetMaxFullTransferDelay()

Returns

double

Time in ms

HadReset()

Check if the controller has been reset

bool HadReset()

Returns

bool

Whether the controller has been reset

PerformFullTransfer(bool, CancellationToken)

Perform a full data transfer synchronously

void PerformFullTransfer(bool connecting = false, CancellationToken cancellationToken = default)

Parameters

connecting bool

Whether this an initial connection is being established

cancellationToken CancellationToken

Optional cancellation token

ReadAbortFile(out CodeChannel, out bool)

Read the content of an AbortFileHeader packet

void ReadAbortFile(out CodeChannel channel, out bool abortAll)

Parameters

channel CodeChannel

Code channel where all files are supposed to be aborted

abortAll bool

Whether all files are supposed to be aborted

ReadCheckFileExists(out string)

Read a request to check if a file exists

void ReadCheckFileExists(out string filename)

Parameters

filename string

Name of the file

ReadCloseFile(out uint)

Read a request to close a file

void ReadCloseFile(out uint handle)

Parameters

handle uint

File handle

ReadCodeBufferUpdate(out ushort)

Read a code buffer update

void ReadCodeBufferUpdate(out ushort bufferSpace)

Parameters

bufferSpace ushort

Buffer space

ReadCodeChannel(out CodeChannel)

Read a code channel

void ReadCodeChannel(out CodeChannel channel)

Parameters

channel CodeChannel

Code channel that has acquired the lock

ReadDeleteFileOrDirectory(out string)

Read a request to delete a file or directory

void ReadDeleteFileOrDirectory(out string filename)

Parameters

filename string

Name of the file

ReadDoCode(out CodeChannel, out string)

Read a code request

void ReadDoCode(out CodeChannel channel, out string code)

Parameters

channel CodeChannel

Channel to execute this code on

code string

Code to execute

ReadEvaluationResult(out CodeChannel?, out string, out object?)

Read the result of an expression evaluation request

void ReadEvaluationResult(out CodeChannel? channel, out string expression, out object? result)

Parameters

channel CodeChannel?

Channel where the evaluation was performed

expression string

Evaluated expression

result object

Result

ReadFileChunkRequest(out string, out uint, out int)

Read a chunk of a FileChunk packet

void ReadFileChunkRequest(out string filename, out uint offset, out int maxLength)

Parameters

filename string

Filename

offset uint

File offset

maxLength int

Maximum chunk size

ReadFileRequest(out uint, out int)

Read a request to read data from a file

void ReadFileRequest(out uint handle, out int maxLength)

Parameters

handle uint

File handle

maxLength int

Maximum data length

ReadMacroRequest(out CodeChannel, out bool, out string)

Read the content of a ExecuteMacroHeader packet

void ReadMacroRequest(out CodeChannel channel, out bool isSystemMacro, out string filename)

Parameters

channel CodeChannel

Channel requesting a macro file

isSystemMacro bool

Indicates if this code is not bound to a code being executed (e.g. when a trigger macro is requested)

filename string

Filename of the requested macro

ReadMessage(out MessageTypeFlags, out string)

Read an incoming message

void ReadMessage(out MessageTypeFlags messageType, out string reply)

Parameters

messageType MessageTypeFlags

Message type flags of the reply

reply string

Code reply

ReadNextPacket()

Read the next packet

PacketHeader? ReadNextPacket()

Returns

PacketHeader?

The next packet or null if none is available

ReadObjectModel(out ReadOnlySpan<byte>)

Read the result of a GetObjectModel request

void ReadObjectModel(out ReadOnlySpan<byte> json)

Parameters

json ReadOnlySpan<byte>

JSON data

ReadOpenFile(out string, out bool, out bool, out long)

Read an open file request

void ReadOpenFile(out string filename, out bool forWriting, out bool append, out long preAllocSize)

Parameters

filename string

Filename to open

forWriting bool

Whether the file is supposed to be written to

append bool

Whether data is supposed to be appended in write mode

preAllocSize long

How many bytes to allocate if the file is created or overwritten

ReadPrintPaused(out uint, out uint, out PrintPausedReason)

Read the content of a PrintPausedHeader packet

void ReadPrintPaused(out uint filePosition, out uint filePosition2, out PrintPausedReason reason)

Parameters

filePosition uint

Position where the print has been paused

filePosition2 uint

Secondary file position where the print has been paused

reason PrintPausedReason

Reason why the print has been paused

ReadSeekFile(out uint, out long)

Read a request to seek in a file

void ReadSeekFile(out uint handle, out long offset)

Parameters

handle uint

File handle

offset long

New file position

ReadTruncateFile(out uint)

Read a request to truncate a file

void ReadTruncateFile(out uint handle)

Parameters

handle uint

File handle

ReadWriteRequest(out uint, out ReadOnlySpan<byte>)

Read a request to write data to a file

void ReadWriteRequest(out uint handle, out ReadOnlySpan<byte> data)

Parameters

handle uint

File handle

data ReadOnlySpan<byte>

Data to write

ResendPacket(PacketHeader, out Request)

Resend a packet back to the firmware

void ResendPacket(PacketHeader packet, out Request sbcRequest)

Parameters

packet PacketHeader

Packet holding the resend request

sbcRequest Request

Content of the packet to resend

StartIap(uint, CancellationToken)

Instruct the firmware to start the IAP binary

void StartIap(uint firmwareLength, CancellationToken cancellationToken = default)

Parameters

firmwareLength uint

Length of the firmware binary in bytes (used by USB IAP for end-of-transfer detection; ignored by SPI)

cancellationToken CancellationToken

Cancellation token

VerifyFirmwareChecksum(long, ushort)

Send the CRC16 checksum of the firmware binary to the IAP program and verify the written data

bool VerifyFirmwareChecksum(long firmwareLength, ushort crc16)

Parameters

firmwareLength long

Length of the written firmware in bytes

crc16 ushort

CRC16 checksum of the firmware

Returns

bool

Whether the firmware has been written successfully

WaitForIapReset()

Wait for the IAP program to reset the controller

void WaitForIapReset()

WriteCheckFileExistsResult(bool)

Send back whether a file exists or not

bool WriteCheckFileExistsResult(bool exists)

Parameters

exists bool

Whether the file exists

Returns

bool

If the packet could be written

WriteCode(Code)

Request a code to be executed

bool WriteCode(Code code)

Parameters

code Code

Code to send

Returns

bool

True if the packet could be written

WriteDeleteLocalVariable(CodeChannel, string)

Delete a local variable at the end of the current code block

bool WriteDeleteLocalVariable(CodeChannel channel, string varName)

Parameters

channel CodeChannel

G-code channel

varName string

Name of the variable excluding var prefix

Returns

bool

True if the packet could be written

WriteEmergencyStop()

Request an emergency stop

bool WriteEmergencyStop()

Returns

bool

True if the packet could be written

WriteEvaluateExpression(CodeChannel, string)

Write a request for an expression evaluation

bool WriteEvaluateExpression(CodeChannel channel, string expression)

Parameters

channel CodeChannel

Where to evaluate the expression

expression string

Expression to evaluate

Returns

bool

Whether the evaluation request has been written successfully

WriteFileChunk(Span<byte>, long)

Write another chunk of the file being requested

bool WriteFileChunk(Span<byte> data, long fileLength)

Parameters

data Span<byte>

File chunk data

fileLength long

Total length of the file in bytes

Returns

bool

Whether the firmware has been written successfully

WriteFileDeleteResult(bool)

Send back whether a file or directory could be deleted

bool WriteFileDeleteResult(bool success)

Parameters

success bool

Whether the file operation was successful

Returns

bool

If the packet could be written

WriteFileReadResult(Span<byte>, int)

Write requested read data from a file

bool WriteFileReadResult(Span<byte> data, int bytesRead)

Parameters

data Span<byte>

File data

bytesRead int

Number of bytes read or negative on error

Returns

bool

If the packet could be written

WriteFileSeekResult(bool)

Tell RRF if the seek operation was successful

bool WriteFileSeekResult(bool success)

Parameters

success bool

If the seek operation succeeded

Returns

bool

If the packet could be written

WriteFileTruncateResult(bool)

Tell RRF if the seek operation was successful

bool WriteFileTruncateResult(bool success)

Parameters

success bool

If the seek operation succeeded

Returns

bool

If the packet could be written

WriteFileWriteResult(bool)

Tell RRF if the last file block could be written

bool WriteFileWriteResult(bool success)

Parameters

success bool

If the file data could be written

Returns

bool

If the packet could be written

WriteGetObjectModel(string, string)

Request the key of an object module of a specific module

bool WriteGetObjectModel(string key, string flags)

Parameters

key string

Object model key to query

flags string

Object model flags to query

Returns

bool

True if the packet could be written

WriteIapSegment(Stream, CancellationToken)

Write another segment of the IAP binary

bool WriteIapSegment(Stream stream, CancellationToken cancellationToken = default)

Parameters

stream Stream

IAP binary

cancellationToken CancellationToken

Cancellation token

Returns

bool

Whether another segment could be written

WriteInvalidateChannel(CodeChannel)

Called when a code channel is supposed to be invalidated (e.g. via abort keyword)

bool WriteInvalidateChannel(CodeChannel channel)

Parameters

channel CodeChannel

Code channel that requires the lock

Returns

bool

True if the packet could be written

WriteLockAllMovementSystemsAndWaitForStandstill(CodeChannel)

Request the movement systems to be locked and wait for standstill

bool WriteLockAllMovementSystemsAndWaitForStandstill(CodeChannel channel)

Parameters

channel CodeChannel

Code channel that requires the lock

Returns

bool

True if the packet could be written

WriteMacroCompleted(CodeChannel, bool)

Notify the firmware about a completed macro file. This function is only used for macro files that the firmware requested

bool WriteMacroCompleted(CodeChannel channel, bool error)

Parameters

channel CodeChannel

Code channel of the finished macro

error bool

Whether an error occurred

Returns

bool

True if the packet could be written

WriteMacroStarted(CodeChannel)

Notify RepRapFirmware that a macro file could be started

bool WriteMacroStarted(CodeChannel channel)

Parameters

channel CodeChannel

Code channel that requires the lock

Returns

bool

True if the packet could be written

WriteMessage(MessageTypeFlags, string)

Write a message

bool WriteMessage(MessageTypeFlags flags, string message)

Parameters

flags MessageTypeFlags

Message flags

message string

Message content

Returns

bool

Whether the firmware has been written successfully

WriteObjectModelKeyChanged(string)

Notify RRF that an object model key has changed

bool WriteObjectModelKeyChanged(string key)

Parameters

key string

Key that has changed

Returns

bool

If the packet could be written

WriteOpenFileResult(uint, long)

Write the new file handle and file length of the file that has just been opened

bool WriteOpenFileResult(uint fileHandle, long length)

Parameters

fileHandle uint

New file handle or noFileHandle if the file could not be opened

length long

Length of the file

Returns

bool

If the packet could be written

WritePrintFileInfo(GCodeFileInfo)

Notify the firmware that a file print has started

bool WritePrintFileInfo(GCodeFileInfo info)

Parameters

info GCodeFileInfo

Information about the file being printed

Returns

bool

True if the packet could be written

WritePrintStopped(PrintStoppedReason)

Notify that a file print has been stopped

bool WritePrintStopped(PrintStoppedReason reason)

Parameters

reason PrintStoppedReason

Reason why the print has been stopped

Returns

bool

True if the packet could be written

WriteReset()

Request a firmware reset

bool WriteReset()

Returns

bool

True if the packet could be written

WriteSetLastCodeResult(CodeChannel, CodeResult)

Write the last code result for a specific code channel

bool WriteSetLastCodeResult(CodeChannel channel, CodeResult result)

Parameters

channel CodeChannel

Code channel

result CodeResult

Last code result

Returns

bool

If the packet could be written

WriteSetVariable(CodeChannel, bool, string, string)

Set a global or local variable

bool WriteSetVariable(CodeChannel channel, bool createVariable, string varName, string expression)

Parameters

channel CodeChannel

G-code channel

createVariable bool

Whether the variable should be created or updated

varName string

Name of the variable including global or var prefix

expression string

New value of the variable

Returns

bool

True if the packet could be written

WriteUnlock(CodeChannel)

Release all acquired locks again

bool WriteUnlock(CodeChannel channel)

Parameters

channel CodeChannel

Code channel that releases the locks

Returns

bool

True if the packet could be written