Skip to content

Method FromConnectionString

Namespace: Belay.Core
Assembly: Belay.Core.dll

FromConnectionString(string, ILoggerFactory?)

Create a Device instance from a connection string.

csharp
public static Device FromConnectionString(string connectionString, ILoggerFactory? loggerFactory = null)

Parameters

connectionString string

Connection string (e.g., "serial:COM3", "subprocess:micropython").

loggerFactory ILoggerFactory?

Optional logger factory.

Returns

Device

A configured Device instance.

Examples

// Connect to a device via serial port
var device = Device.FromConnectionString("serial:COM3");

// Connect to MicroPython subprocess for testing
var testDevice = Device.FromConnectionString("subprocess:micropython");

// With logging
var loggerFactory = LoggerFactory.Create(builder => builder.AddConsole());
var deviceWithLogging = Device.FromConnectionString("serial:/dev/ttyACM0", loggerFactory);

Exceptions

ArgumentException

Thrown when the connection string is invalid or unsupported.

Released under the Apache License 2.0.