This class represents global settings used by the Treehopper API More...

Properties
bool	ThrowExceptions `[get, set]`
	Get or sets whether exceptions should be thrown. More...

uint	Vid = 0x10c4 `[get, set]`
	The VID to search for More...

uint	Pid = 0x8a7e `[get, set]`
	The PID to search for More...

Guid	Guid = new Guid("{5B34B38B-F4CD-49C3-B2BB-60E47A43E12D}") `[get, set]`
	The WinUSB GUID used by the library More...

bool	PropertyWritesReturnImmediately = false `[get, set]`
	Whether or not writing to properties should return immediately, or only upon successfully sending to the board. More...

Detailed Description

This class represents global settings used by the Treehopper API

Property Documentation

◆ ThrowExceptions

bool ThrowExceptions

getset

Get or sets whether exceptions should be thrown.

If true, any exceptions received will be thrown to user code, as well as printed. If false, exceptions will only be printed.

◆ Vid

uint Vid = 0x10c4

getset

The VID to search for

◆ Pid

uint Pid = 0x8a7e

getset

The PID to search for

◆ Guid

Guid Guid = new Guid("{5B34B38B-F4CD-49C3-B2BB-60E47A43E12D}")

getset

The WinUSB GUID used by the library

◆ PropertyWritesReturnImmediately

bool PropertyWritesReturnImmediately = false

getset

Whether or not writing to properties should return immediately, or only upon successfully sending to the board.

Properties provide a useful abstraction for the state of peripherals (i.e., Pin.DigitalValue), but they are inherently synchronous. This setting allows you to control how writes to properties behave; when true, a write to one of these properties will queue up a request to the board but will return immediately — setting this property to false will synchronously wait for the message to be sent to the board.

The documentation for this class was generated from the following file:

F:/Git/treehopper-sdk/NET/API/Treehopper/Settings.cs