/
OpenHardwareMonitor.xml
658 lines (658 loc) · 38.8 KB
/
OpenHardwareMonitor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
<Type Name="OpenHardwareMonitor" FullName="Iot.Device.HardwareMonitor.OpenHardwareMonitor">
<TypeSignature Language="C#" Value="public sealed class OpenHardwareMonitor : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed OpenHardwareMonitor extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Iot.Device.HardwareMonitor.OpenHardwareMonitor" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class OpenHardwareMonitor
Implements IDisposable" />
<TypeSignature Language="F#" Value="type OpenHardwareMonitor = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
This class connects to a running instance of OpenHardwareMonitor and reads out all available values.
This works only if OpenHardwareMonitor (https://openhardwaremonitor.org/) is currently running.
While the tool needs to be run with elevated permissions, the application using this binding does not.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OpenHardwareMonitor ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructs a new instance of this class.
The class can be constructed even if no sensors are available or OpenHardwareMonitor is not running (yet).
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException">The operating system is not Windows.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OpenHardwareMonitor (Iot.Device.HardwareMonitor.OpenHardwareMonitorTransport transport, string host = "localhost", int port = 8086);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Iot.Device.HardwareMonitor.OpenHardwareMonitorTransport transport, string host, int32 port) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.#ctor(Iot.Device.HardwareMonitor.OpenHardwareMonitorTransport,System.String,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (transport As OpenHardwareMonitorTransport, Optional host As String = "localhost", Optional port As Integer = 8086)" />
<MemberSignature Language="F#" Value="new Iot.Device.HardwareMonitor.OpenHardwareMonitor : Iot.Device.HardwareMonitor.OpenHardwareMonitorTransport * string * int -> Iot.Device.HardwareMonitor.OpenHardwareMonitor" Usage="new Iot.Device.HardwareMonitor.OpenHardwareMonitor (transport, host, port)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="transport" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitorTransport" Index="0" FrameworkAlternate="iot-dotnet-2.1;iot-dotnet-latest" />
<Parameter Name="host" Type="System.String" Index="1" FrameworkAlternate="iot-dotnet-2.1;iot-dotnet-latest" />
<Parameter Name="port" Type="System.Int32" Index="2" FrameworkAlternate="iot-dotnet-2.1;iot-dotnet-latest" />
</Parameters>
<Docs>
<param name="transport">The transport protocol to use. WMI is for OpenHardwareMonitor 0.9 and below, from OpenHardwareMonitor 0.10 and above,
HTTP is used.</param>
<param name="host">Optional host name for connection</param>
<param name="port">Network port</param>
<summary>
Constructs a new instance of this class using a specific transport protocol
The class can be constructed even if no sensors are available or OpenHardwareMonitor is not running (yet).
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.PlatformNotSupportedException" />
</Docs>
</Member>
<Member MemberName="DisableDerivedSensors">
<MemberSignature Language="C#" Value="public void DisableDerivedSensors ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DisableDerivedSensors() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.DisableDerivedSensors" />
<MemberSignature Language="VB.NET" Value="Public Sub DisableDerivedSensors ()" />
<MemberSignature Language="F#" Value="member this.DisableDerivedSensors : unit -> unit" Usage="openHardwareMonitor.DisableDerivedSensors " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Remove the derived sensors from the active list.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="openHardwareMonitor.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="EnableDerivedSensors">
<MemberSignature Language="C#" Value="public void EnableDerivedSensors (UnitsNet.Area cpuDieSize = default, TimeSpan monitoringInterval = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnableDerivedSensors(valuetype UnitsNet.Area cpuDieSize, valuetype System.TimeSpan monitoringInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.EnableDerivedSensors(UnitsNet.Area,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Sub EnableDerivedSensors (Optional cpuDieSize As Area = Nothing, Optional monitoringInterval As TimeSpan = Nothing)" />
<MemberSignature Language="F#" Value="member this.EnableDerivedSensors : UnitsNet.Area * TimeSpan -> unit" Usage="openHardwareMonitor.EnableDerivedSensors (cpuDieSize, monitoringInterval)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cpuDieSize" Type="UnitsNet.Area" />
<Parameter Name="monitoringInterval" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="cpuDieSize">Die size of your CPU, optional. Find your CPU on https://en.wikichip.org/ to find out. Note: This
value is usually much smaller than the size of the physical CPU.</param>
<param name="monitoringInterval">Monitoring interval for the derived sensors. Defaults to 500ms.</param>
<summary>
Adds some special derived sensors.
- For each power sensor, this adds another sensor that integrates power over time and so generated the energy used in W/h or
more conveniently, Kilowatthours (this is the unit the electricity bill bases on)
- Gives the heat flux for the primary CPU, using the given CPU die size (or a default value)
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="monitoringInterval" /> is less than 0.</exception>
</Docs>
</Member>
<Member MemberName="GetCpuLoad">
<MemberSignature Language="C#" Value="public UnitsNet.Ratio GetCpuLoad ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype UnitsNet.Ratio GetCpuLoad() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.GetCpuLoad" />
<MemberSignature Language="VB.NET" Value="Public Function GetCpuLoad () As Ratio" />
<MemberSignature Language="F#" Value="member this.GetCpuLoad : unit -> UnitsNet.Ratio" Usage="openHardwareMonitor.GetCpuLoad " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>UnitsNet.Ratio</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the overall CPU Load
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHardwareComponents">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware> GetHardwareComponents ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IList`1<class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Hardware> GetHardwareComponents() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.GetHardwareComponents" />
<MemberSignature Language="VB.NET" Value="Public Function GetHardwareComponents () As IList(Of OpenHardwareMonitor.Hardware)" />
<MemberSignature Language="F#" Value="member this.GetHardwareComponents : unit -> System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware>" Usage="openHardwareMonitor.GetHardwareComponents " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor+Hardware></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a list of hardware components, such as "CPU", "GPU" or "Mainboard"
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSensorList">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor> GetSensorList ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IList`1<class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Sensor> GetSensorList() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.GetSensorList" />
<MemberSignature Language="VB.NET" Value="Public Function GetSensorList () As IList(Of OpenHardwareMonitor.Sensor)" />
<MemberSignature Language="F#" Value="member this.GetSensorList : unit -> System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor>" Usage="openHardwareMonitor.GetSensorList " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Iot.Device.HardwareMonitor.OpenHardwareMonitor+Sensor></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Query the list of all available sensors.
</summary>
<returns>A list of <see cref="T:Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor" /> instances. May be empty.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Management.ManagementException">The WMI objects required are not available. Is OpenHardwareMonitor running?</exception>
</Docs>
</Member>
<Member MemberName="GetSensorList">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor> GetSensorList (Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware? forHardware);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Sensor> GetSensorList(class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Hardware forHardware) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.GetSensorList(Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware)" />
<MemberSignature Language="VB.NET" Value="Public Function GetSensorList (forHardware As OpenHardwareMonitor.Hardware) As IEnumerable(Of OpenHardwareMonitor.Sensor)" />
<MemberSignature Language="F#" Value="member this.GetSensorList : Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware -> seq<Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor>" Usage="openHardwareMonitor.GetSensorList forHardware" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Iot.Device.HardwareMonitor.OpenHardwareMonitor+Sensor></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="forHardware" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitor+Hardware" />
</Parameters>
<Docs>
<param name="forHardware">The module that should be queried</param>
<summary>
Get the list of sensors for a specific piece of hardware
</summary>
<returns>A list of sensors</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogicalProcessors">
<MemberSignature Language="C#" Value="public int LogicalProcessors { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 LogicalProcessors" />
<MemberSignature Language="DocId" Value="P:Iot.Device.HardwareMonitor.OpenHardwareMonitor.LogicalProcessors" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LogicalProcessors As Integer" />
<MemberSignature Language="F#" Value="member this.LogicalProcessors : int" Usage="Iot.Device.HardwareMonitor.OpenHardwareMonitor.LogicalProcessors" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Number of logical processors in the system
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MonitoringInterval">
<MemberSignature Language="C#" Value="public TimeSpan MonitoringInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MonitoringInterval" />
<MemberSignature Language="DocId" Value="P:Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringInterval" />
<MemberSignature Language="VB.NET" Value="Public Property MonitoringInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MonitoringInterval : TimeSpan with get, set" Usage="Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The minimum monitoring interval.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartMonitoring">
<MemberSignature Language="C#" Value="public Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringJob StartMonitoring (Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor sensorToMonitor, TimeSpan monitoringInterval, Iot.Device.HardwareMonitor.OpenHardwareMonitor.OnNewValue onNewValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Iot.Device.HardwareMonitor.OpenHardwareMonitor/MonitoringJob StartMonitoring(class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Sensor sensorToMonitor, valuetype System.TimeSpan monitoringInterval, class Iot.Device.HardwareMonitor.OpenHardwareMonitor/OnNewValue onNewValue) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.StartMonitoring(Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor,System.TimeSpan,Iot.Device.HardwareMonitor.OpenHardwareMonitor.OnNewValue)" />
<MemberSignature Language="VB.NET" Value="Public Function StartMonitoring (sensorToMonitor As OpenHardwareMonitor.Sensor, monitoringInterval As TimeSpan, onNewValue As OpenHardwareMonitor.OnNewValue) As OpenHardwareMonitor.MonitoringJob" />
<MemberSignature Language="F#" Value="member this.StartMonitoring : Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor * TimeSpan * Iot.Device.HardwareMonitor.OpenHardwareMonitor.OnNewValue -> Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringJob" Usage="openHardwareMonitor.StartMonitoring (sensorToMonitor, monitoringInterval, onNewValue)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Iot.Device.HardwareMonitor.OpenHardwareMonitor+MonitoringJob</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sensorToMonitor" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitor+Sensor" />
<Parameter Name="monitoringInterval" Type="System.TimeSpan" />
<Parameter Name="onNewValue" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitor+OnNewValue" />
</Parameters>
<Docs>
<param name="sensorToMonitor">The sensor to monitor. The same sensor may be registered multiple times</param>
<param name="monitoringInterval">The monitoring interval. Will be rounded to the next 0.1s.</param>
<param name="onNewValue">Action to perform each time</param>
<summary>
Starts monitoring a sensor.
This will internally start a thread that calls the provided action each time the TimeSpan elapses.
</summary>
<returns>An identifier for the monitoring job</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StopAllMonitoring">
<MemberSignature Language="C#" Value="public void StopAllMonitoring ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopAllMonitoring() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.StopAllMonitoring" />
<MemberSignature Language="VB.NET" Value="Public Sub StopAllMonitoring ()" />
<MemberSignature Language="F#" Value="member this.StopAllMonitoring : unit -> unit" Usage="openHardwareMonitor.StopAllMonitoring " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Stops all monitoring.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StopMonitoring">
<MemberSignature Language="C#" Value="public void StopMonitoring (Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringJob job);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StopMonitoring(class Iot.Device.HardwareMonitor.OpenHardwareMonitor/MonitoringJob job) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.StopMonitoring(Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringJob)" />
<MemberSignature Language="VB.NET" Value="Public Sub StopMonitoring (job As OpenHardwareMonitor.MonitoringJob)" />
<MemberSignature Language="F#" Value="member this.StopMonitoring : Iot.Device.HardwareMonitor.OpenHardwareMonitor.MonitoringJob -> unit" Usage="openHardwareMonitor.StopMonitoring job" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="job" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitor+MonitoringJob" />
</Parameters>
<Docs>
<param name="job">Monitoring job</param>
<summary>
Stops monitoring of the given job.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetAverage<T>">
<MemberSignature Language="C#" Value="public bool TryGetAverage<T> (Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware hardware, out T? average) where T : UnitsNet.IQuantity;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetAverage<(class UnitsNet.IQuantity) T>(class Iot.Device.HardwareMonitor.OpenHardwareMonitor/Hardware hardware, [out] !!T& average) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.TryGetAverage``1(Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware,``0@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetAverage(Of T As IQuantity) (hardware As OpenHardwareMonitor.Hardware, ByRef average As T) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetAverage : Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware * 'T -> bool (requires 'T :> UnitsNet.IQuantity)" Usage="openHardwareMonitor.TryGetAverage (hardware, average)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>UnitsNet.IQuantity</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="hardware" Type="Iot.Device.HardwareMonitor.OpenHardwareMonitor+Hardware" />
<Parameter Name="average" Type="T" RefType="out" />
</Parameters>
<Docs>
<typeparam name="T">Type of value to query (i.e. Load, Power)</typeparam>
<param name="hardware">The hardware type (i.e. CPU)</param>
<param name="average">Gets the returned quantity</param>
<summary>
Tries to calculate the average of a set of sensors.
</summary>
<returns>True if at least one matching quantity was found</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">There were multiple sensors found, but they return different units (i.e. CPU temperature is
reported as Celsius for some cores and Fahrenheit for others)</exception>
</Docs>
</Member>
<Member MemberName="TryGetAverageCpuTemperature">
<MemberSignature Language="C#" Value="public bool TryGetAverageCpuTemperature (out UnitsNet.Temperature temperature);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetAverageCpuTemperature([out] valuetype UnitsNet.Temperature& temperature) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.TryGetAverageCpuTemperature(UnitsNet.Temperature@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetAverageCpuTemperature (ByRef temperature As Temperature) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetAverageCpuTemperature : Temperature -> bool" Usage="openHardwareMonitor.TryGetAverageCpuTemperature temperature" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="temperature" Type="UnitsNet.Temperature" RefType="out" />
</Parameters>
<Docs>
<param name="temperature">To be added.</param>
<summary>
Gets the average CPU temperature (averaged over all CPU sensors / cores)
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetAverageGpuTemperature">
<MemberSignature Language="C#" Value="public bool TryGetAverageGpuTemperature (out UnitsNet.Temperature temperature);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetAverageGpuTemperature([out] valuetype UnitsNet.Temperature& temperature) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.TryGetAverageGpuTemperature(UnitsNet.Temperature@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetAverageGpuTemperature (ByRef temperature As Temperature) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetAverageGpuTemperature : Temperature -> bool" Usage="openHardwareMonitor.TryGetAverageGpuTemperature temperature" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="temperature" Type="UnitsNet.Temperature" RefType="out" />
</Parameters>
<Docs>
<param name="temperature">The average GPU temperature</param>
<summary>
Gets the average GPU temperature (averaged over all GPU sensors / cores)
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateSensors">
<MemberSignature Language="C#" Value="public void UpdateSensors (bool refreshSensorList);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UpdateSensors(bool refreshSensorList) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.HardwareMonitor.OpenHardwareMonitor.UpdateSensors(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub UpdateSensors (refreshSensorList As Boolean)" />
<MemberSignature Language="F#" Value="member this.UpdateSensors : bool -> unit" Usage="openHardwareMonitor.UpdateSensors refreshSensorList" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="refreshSensorList" Type="System.Boolean" Index="0" FrameworkAlternate="iot-dotnet-2.1;iot-dotnet-latest" />
</Parameters>
<Docs>
<param name="refreshSensorList">To be added.</param>
<summary>
Re-reads the sensor tree. Updates all values and the list of sensors.
You should invalidate all cached <see cref="T:Iot.Device.HardwareMonitor.OpenHardwareMonitor.Sensor" /> and <see cref="T:Iot.Device.HardwareMonitor.OpenHardwareMonitor.Hardware" /> instances after using this with <paramref name="refreshSensorList" />=true
</summary>
<remarks>To be added.</remarks>
<paramref name="refreshSensorList">True to also update the list of sensors. False to only update the values. If false, new sensors will not be visible
(e.g. after inserting a thumb drive)</paramref>
</Docs>
</Member>
<Member MemberName="UpdateStrategy">
<MemberSignature Language="C#" Value="public Iot.Device.HardwareMonitor.SensorUpdateStrategy UpdateStrategy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Iot.Device.HardwareMonitor.SensorUpdateStrategy UpdateStrategy" />
<MemberSignature Language="DocId" Value="P:Iot.Device.HardwareMonitor.OpenHardwareMonitor.UpdateStrategy" />
<MemberSignature Language="VB.NET" Value="Public Property UpdateStrategy As SensorUpdateStrategy" />
<MemberSignature Language="F#" Value="member this.UpdateStrategy : Iot.Device.HardwareMonitor.SensorUpdateStrategy with get, set" Usage="Iot.Device.HardwareMonitor.OpenHardwareMonitor.UpdateStrategy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Iot.Device.HardwareMonitor.SensorUpdateStrategy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Selects the sensor update strategy.
Default is <see cref="F:Iot.Device.HardwareMonitor.SensorUpdateStrategy.PerSensor" /> for WMI, <see cref="F:Iot.Device.HardwareMonitor.SensorUpdateStrategy.SynchronousAfterTimeout" /> for HTTP.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>