Table of Contents

Class PortBase

Namespace
nanoFramework.Tools.Debugger
Assembly
nanoFramework.Tools.DebugLibrary.Net.dll
public abstract class PortBase : PortMessageBase
Inheritance
PortBase
Derived
Inherited Members
Extension Methods

Constructors

PortBase() 

protected PortBase()

Properties

IsDevicesEnumerationComplete

Flag to signal that devices enumeration is complete.

public bool IsDevicesEnumerationComplete { get; }

Property Value

bool

NanoFrameworkDevices 

public NanoFrameworkDevices NanoFrameworkDevices { get; }

Property Value

NanoFrameworkDevices

PersistName 

public string PersistName { get; }

Property Value

string

PortExclusionList 

public List<string> PortExclusionList { get; set; }

Property Value

List<string>

PortName 

public string PortName { get; }

Property Value

string

UniqueId 

public virtual object UniqueId { get; }

Property Value

object

Methods

AddDevice(string)

Adds a new device to list of NanoFrameworkDevices.

public abstract NanoDeviceBase AddDevice(string deviceId)

Parameters

deviceId string

The unique ID (based on the connection properties) of the device.

Returns

NanoDeviceBase

The device with the unique ID that is added or (if it was already discovered before) retrieved from the list of devices. Returns null if no device has been added.

CreateInstanceForComposite(IEnumerable<PortBase>, bool) 

public static PortBase CreateInstanceForComposite(IEnumerable<PortBase> ports, bool startDeviceWatchers)

Parameters

ports IEnumerable<PortBase>
startDeviceWatchers bool

Returns

PortBase

CreateInstanceForNetwork(bool) 

public static PortBase CreateInstanceForNetwork(bool startDeviceWatchers)

Parameters

startDeviceWatchers bool

Returns

PortBase

CreateInstanceForNetwork(bool, int) 

public static PortBase CreateInstanceForNetwork(bool startDeviceWatchers, int discoveryPort)

Parameters

startDeviceWatchers bool
discoveryPort int

Returns

PortBase

CreateInstanceForSerial() 

public static PortBase CreateInstanceForSerial()

Returns

PortBase

CreateInstanceForSerial(bool) 

public static PortBase CreateInstanceForSerial(bool startDeviceWatchers)

Parameters

startDeviceWatchers bool

Returns

PortBase

CreateInstanceForSerial(bool, List<string>, int) 

public static PortBase CreateInstanceForSerial(bool startDeviceWatchers, List<string> portExclusionList = null, int bootTime = 1000)

Parameters

startDeviceWatchers bool
portExclusionList List<string>
bootTime int

Returns

PortBase

CreateInstanceForSerial(bool, int) 

public static PortBase CreateInstanceForSerial(bool startDeviceWatchers, int bootTime = 1000)

Parameters

startDeviceWatchers bool
bootTime int

Returns

PortBase

CreateInstanceForSerial(List<string>) 

public static PortBase CreateInstanceForSerial(List<string> portExclusionList)

Parameters

portExclusionList List<string>

Returns

PortBase

DisposeDevice(string)

Disposes a device.

public abstract void DisposeDevice(string instanceId)

Parameters

instanceId string

Id of the device to dispose.

Equals(object) 

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode() 

public override int GetHashCode()

Returns

int

ReScanDevices()

Performs a re-scan of the connected devices. This operation resets the list of available devices and attempts to validate if a connected device it's a nanoDevice.

public abstract void ReScanDevices()

StartDeviceWatchers()

Starts the device watchers. If they are already started this operation won't have any effect.

public abstract void StartDeviceWatchers()

StopDeviceWatchers()

Stops the device watchers. If they are already stopped this operation won't have any effect.

public abstract void StopDeviceWatchers()

Events

DeviceEnumerationCompleted

Event that is raised when enumeration of all nF devices is complete.

public abstract event EventHandler DeviceEnumerationCompleted

Event Type

EventHandler