Device.Net/docs/articles/GettingStarted.html at develop · MelbourneDeveloper/Device.Net

History

189 lines (162 loc) · 7.67 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

<!DOCTYPE html>

<html>

<head>

<title>Getting Started </title>

</head>

<span class="sr-only">Toggle navigation</span>

</button>

</a>

</div>

</div>

</form>

</div>

</nav>

</ul>

</div>

</header>

<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>

</div>

<h1 id="getting-started">Getting Started</h1>

<h2 id="run-windows-sample-usbnetwindowssample">Run Windows Sample (Usb.Net.WindowsSample)</h2>

<p>Run the Windows sample. You should see your device's path appear at the top of the console. If it does not, check the logs to find out why it didn't appear.</p>

<h2 id="modify-a-sample">Modify a Sample</h2>

<p>The easiest way to start is to clone this repo that uses Usb.Net or Hid.Net and modify the code to suit your needs. This repo contains a sample for Hid thermometer device and a Trezor Hardware wallet example. If you have trouble getting a sample to compile, please see <a href="BuildIssues.html">Build Issues</a></p>

<h2 id="clean-project">Clean Project</h2>

<p>If you want to start fresh, the easiest way would be to create a .NET Core project on Windows with Visual Studio and add the NuGet packages you require. Please see the <a href="NuGet.html">NuGet page</a>.</p>

<p>Please see</p>

<p><a href="DevicePermissionSetup.html">Device Permission Setup</a></p>

<p><a href="DeviceListener.html">Device Listener</a> or <a href="EnumeratingConnectedDevices.html">Enumerating Connected Devices</a></p>

<p><a href="WritingToandReadingFromaDevice.md">Writing To and Reading From a Device</a></p>

<p>For USB, please see <a href="USBInitialization.md">USB-Initialization: Interfaces And Endpoints</a></p>

<h3 id="example-code">Example Code:</h3>

<p>This is a simple Windows console app.</p>

<pre><code class="lang-cs">using Device.Net;

using Hid.Net.Windows;

using Microsoft.Extensions.Logging;

using System.Linq;

using System.Reactive.Linq;

using System.Threading.Tasks;

using Usb.Net.Windows;

namespace Usb.Net.WindowsSample

{

internal class Program

{

private static async Task Main()

{

//Create logger factory that will pick up all logs and output them in the debug output window

var loggerFactory = LoggerFactory.Create((builder) =>

{

_ = builder.AddDebug().SetMinimumLevel(LogLevel.Trace);

});

//----------------------

// This is Windows specific code. You can replace this with your platform of choice or put this part in the composition root of your app

//Register the factory for creating Hid devices.

var hidFactory =

new FilterDeviceDefinition(vendorId: 0x534C, productId: 0x0001, label: "Trezor One Firmware 1.6.x", usagePage: 65280)

.CreateWindowsHidDeviceFactory(loggerFactory);

//Register the factory for creating Usb devices.

var usbFactory =

new FilterDeviceDefinition(vendorId: 0x1209, productId: 0x53C1, label: "Trezor One Firmware 1.7.x")

.CreateWindowsUsbDeviceFactory(loggerFactory);

//----------------------

//Join the factories together so that it picks up either the Hid or USB device

var factories = hidFactory.Aggregate(usbFactory);

//Get connected device definitions

var deviceDefinitions = (await factories.GetConnectedDeviceDefinitionsAsync().ConfigureAwait(false)).ToList();

if (deviceDefinitions.Count == 0)

{

//No devices were found

return;

}

//Get the device from its definition

var trezorDevice = await hidFactory.GetDeviceAsync(deviceDefinitions.First()).ConfigureAwait(false);

//Initialize the device

await trezorDevice.InitializeAsync().ConfigureAwait(false);

//Create the request buffer

var buffer = new byte[65];

buffer[0] = 0x00;

buffer[1] = 0x3f;

buffer[2] = 0x23;

buffer[3] = 0x23;

//Write and read the data to the device

var readBuffer = await trezorDevice.WriteAndReadAsync(buffer).ConfigureAwait(false);

}

</code></pre>

</article>

</div>

</ul>

</div>

<h5>In This Article</h5>

</nav>

</div>

</span>

<span>Generated by <strong>DocFX</strong></span>

</div>

</footer>

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FilesExpand file tree

GettingStarted.html

Latest commit

History

GettingStarted.html

File metadata and controls