HardwareMonitor 1.2.0__py3-none-win_amd64.whl

hardwaremonitor-1.2.0.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: HardwareMonitor
+Version: 1.2.0
+Summary: Python import layer for the LibreHardwareMonitorLib assembly.
+Author-email: Nicholas Feix <nf@fconsoft.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2022, Nicholas Feix
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Repository, https://github.com/snip3rnick/PyHardwareMonitor
+Keywords: monitoring,sensors,LibreHardwareMonitor
+Classifier: License :: Other/Proprietary License
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pythonnet
+Dynamic: license-file
+
+# PyHardwareMonitor
+
+Python Harware Monitor is a thin package layer for [`LibreHardwareMonitorLib`](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) using [`pythonnet`](https://github.com/pythonnet/pythonnet). 
+Libre Hardware Monitor, a fork of Open Hardware Monitor, is free software that can monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer. 
+This package is mostly auto generated using the [`pythonstubs`](https://github.com/mcneel/pythonstubs) generator tool for .NET libraries.
+Scripts for generating, altering and extending package resources are located in the [scripts folder](https://github.com/snip3rnick/PyHardwareMonitor/tree/main/scripts).
+
+The purpose of this layer is the ability to provide extensive typing information and additional utilities around the LibreHardwareMonitorLib.
+
+> **Note:** Python must have **admin privileges** for `HardwareMonitor` to be able to access all available sensors properly!
+
+
+## Prerequisites
+- Python 3.6+
+  - pythonnet
+  - .NET 4.7
+- PawnIO (for system sensors)
+
+
+## Installation
+
+Install from PyPi directly
+```
+pip3 install HardwareMonitor
+```
+
+or install locally from source
+
+```
+git clone https://github.com/snip3rnick/PyHardwareMonitor
+cd PyHardwareMonitor
+pip3 install .
+```
+
+### PawnIO Input/Output Driver
+
+For many system sensors (eg. motherboard) it is required to install the [PawnIO driver](https://pawnio.eu/).  
+The driver can be installed using ``winget``
+```
+winget install PawnIO
+```
+
+Alternatively you may download the latest version from the [GitHub release](https://github.com/namazso/PawnIO.Setup/releases/latest/download/PawnIO_setup.exe) page.
+
+
+## Basic Usage
+
+This simple example is a python adaptation of the [**C#** example of the LibreHardwareMonitor repository](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor#whats-the-easiest-way-to-start).
+
+```python
+from HardwareMonitor.Hardware import *  # equivalent to 'using LibreHardwareMonitor.Hardware;'
+
+class UpdateVisitor(IVisitor):
+    __namespace__ = "TestHardwareMonitor"  # must be unique among implementations of the IVisitor interface
+    def VisitComputer(self, computer: IComputer):
+        computer.Traverse(self);
+
+    def VisitHardware(self, hardware: IHardware):
+        hardware.Update()
+        for subHardware in hardware.SubHardware:
+            subHardware.Update()
+
+    def VisitParameter(self, parameter: IParameter): pass
+
+    def VisitSensor(self, sensor: ISensor): pass
+
+
+computer = Computer()  # settings can not be passed as constructor argument (following below)
+computer.IsMotherboardEnabled = True
+computer.IsControllerEnabled = True
+computer.IsCpuEnabled = True
+computer.IsGpuEnabled = True
+computer.IsBatteryEnabled = True
+computer.IsMemoryEnabled = True
+computer.IsNetworkEnabled = True
+computer.IsStorageEnabled = True
+
+computer.Open()
+computer.Accept(UpdateVisitor())
+
+for hardware in computer.Hardware:
+    print(f"Hardware: {hardware.Name}")
+    for subhardware  in hardware.SubHardware:
+        print(f"\tSubhardware: {subhardware.Name}")
+        for sensor in subhardware.Sensors:
+            print(f"\t\tSensor: {sensor.Name}, value: {sensor.Value}")
+    for sensor in hardware.Sensors:
+        print(f"\tSensor: {sensor.Name}, value: {sensor.Value}")
+
+computer.Close()
+```
+
+---
+
+## Utilities
+
+Utilities are located in the `HardwareMonitor.Util` module.
+
+### Function `OpenComputer`
+
+The `OpenComputer` function provides a shorthand for creating the `HardwareMonitor.Hardware.Computer` instance including the settings and update visitor.  
+Settings are given as keyword arguments, the following example enables just the `cpu` and `motherboard` component.
+
+```python
+computer = OpenComputer(cpu=True, motherboard=True)  # use 'all=True' to enable every component
+# Access sensors
+...
+computer.Update()  # Updates all sensors
+...
+computer.Close()
+```
+
+### Function `ToBuiltinTypes`
+
+Instances from the `HardwareMonitor` module can be reduced to primitive python types instead of `HardwareMonitor` object instances with the `ToBuiltinTypes` function.  
+Objects are recursively converted to Python builtin types (`dict`, `list`, ...).
+This can be useful for applications that serialized the data (e.g. with json).
+
+```python
+computer = OpenComputer(cpu=True)
+
+data = ToBuiltinTypes(computer.Hardware)
+# [{'Type': 'Hardware', 'HardwareType': 'Cpu', 'Name': 'Intel Core i5-8265U', 'Sensors': [...], 'SubHardware': [...]}]
+```
+
+### Function `GroupSensorsByType`
+
+Sensors of an instance of `HardwareMonitor.Harware.Hardware` are held in a flat list.  
+The helper function `GroupSensorsByType` converts the sensor list into a list of lists grouping sensors by type.
+
+```python
+GroupSensorsByType(sensors: Iterable[ISensor]) -> List[List[ISensor]]
+```
+
+### Function `SensorValueToString`
+
+The helper function `SensorValueToString` converts sensor values to strings appending with the appropriate unit.
+
+```python
+SensorValueToString(value: float, type: SensorType) -> str
+# returns "3100.0 MHz" for value=3100.0 with type=SensorType.Clock
+```
+
+### Dictionary `HardwareTypeString` and `SensorTypeString`
+
+These two mappings convert values for `HardwareType` (or `SensorType`) to a string.  
+Both the integer value for the enum or the instances of the enum value (e.g. `HardwareType.Cpu`) are present as keys.
+
+> In some environments the type fields were set to integers in others to the corresponding type instance.

hardwaremonitor-1.2.0.dist-info/RECORD

@@ -0,0 +1,54 @@
+HardwareMonitor/Util.py,sha256=EWwMffKaMTeMt48XqCmlcwrdzJ1E4BKlBQ9pfSo64jE,7583
+HardwareMonitor/__init__.py,sha256=WANviOLcG5qaSW7yfjTcN-i10xHdUMP2FSjwyhPcFEA,1698
+HardwareMonitor/Hardware/__init__.py,sha256=YqgkvblMM-ch1F_bpPyTC7dX0uNonIN5-m7NSCrkBzI,118
+HardwareMonitor/Hardware/__init__.pyi,sha256=Mz-eGdcaL1LCkDtmQ3DJffUglW9FWTkHBgC-H60D0uo,25583
+HardwareMonitor/Hardware/CPU/__init__.py,sha256=dG-mGdlfRIf_okM0DqxVBk8TvZC3sWHM4Fo3S8ZXOnw,126
+HardwareMonitor/Hardware/CPU/__init__.pyi,sha256=ttQR2uj9vX69e9FIMSsfWqU6uTCsFgeXQonKwrBgcD8,1693
+HardwareMonitor/Hardware/Controller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+HardwareMonitor/Hardware/Controller/AeroCool/__init__.py,sha256=fuiJJZXpB0W8uhBkcsbHqCxDITg4gpzIeQ2eaGTvYGs,158
+HardwareMonitor/Hardware/Controller/AeroCool/__init__.pyi,sha256=-yk49p4Hv2VdKINRizDa4n0bwqZIEQSeSI8TG6gVk6A,263
+HardwareMonitor/Hardware/Controller/AquaComputer/__init__.py,sha256=Q6vf0zZjSs0rR9WcAOgiNr4Cxho3GKdkISfBms6h4mg,166
+HardwareMonitor/Hardware/Controller/AquaComputer/__init__.pyi,sha256=Dw9rf_pBPJVyEgKCrBByZ24qP_UIv5XuYn-Rdued3yE,267
+HardwareMonitor/Hardware/Controller/MSI/__init__.py,sha256=d6cai-lpLd66shR3TGofh_Q_LeYDR4d7ljMiw9bUDsQ,148
+HardwareMonitor/Hardware/Controller/MSI/__init__.pyi,sha256=l3287N0Oc_4SlbkQAwnwQS5y8GrJVT6-vC29VFPZD5Y,2353
+HardwareMonitor/Hardware/Gpu/__init__.py,sha256=Q03aZ49i5lGtIa9htW19uj7MpaNc7CoVr0mrvDBllzo,126
+HardwareMonitor/Hardware/Gpu/__init__.pyi,sha256=APYUpV0RlbR8T6f_I2AWE_sHILWF-IgIPsRjm1pD-1M,118
+HardwareMonitor/Hardware/Motherboard/__init__.py,sha256=hnjIXtA1fi1bd39silYkVqVGDXE39Iv5Nqhfg8fOpj8,142
+HardwareMonitor/Hardware/Motherboard/__init__.pyi,sha256=vpmejrgfF3Xu9ELIzTuFxt8bVmxuU11p9a4OmwnQYR4,11161
+HardwareMonitor/Hardware/Motherboard/Lpc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+HardwareMonitor/Hardware/Motherboard/Lpc/EC/__init__.py,sha256=nS51bfXniBEZL93uyodGOQ-QF41V5bXryGXtWjasvFQ,156
+HardwareMonitor/Hardware/Motherboard/Lpc/EC/__init__.pyi,sha256=WGOMNFZmP_-B59no8O_MUODz-paAUmP3fD6NOhwyhMQ,2657
+HardwareMonitor/Hardware/PowerMonitor/__init__.py,sha256=KIA0dHx5ELAzkZpfMmIZdV1V5BqnUy9pwbulOtK1d8M,144
+HardwareMonitor/Hardware/PowerMonitor/__init__.pyi,sha256=u84s6mTtJCy_gJ1_HIndl-2m0hq6SB8tAZBfkJZUBzU,998
+HardwareMonitor/Hardware/Psu/__init__.py,sha256=2efjm1kC8HQAfn9uBrO9cGTfwb5l3ujx20g907ZZHFo,126
+HardwareMonitor/Hardware/Psu/__init__.pyi,sha256=HE8a0cVKKrKVReH3yHTFAC7d_rZ--fut4aXTbWcevAE,147
+HardwareMonitor/Hardware/Psu/Corsair/__init__.py,sha256=by_nIrvBHaXvlVeFeqGUss2D25BoJJILFAF23mkcoC4,142
+HardwareMonitor/Hardware/Psu/Corsair/__init__.pyi,sha256=8XLLhORxXP29r2d0LHRyY2II8PlaORJqUZN0w1N5-XU,265
+HardwareMonitor/Hardware/Psu/Msi/__init__.py,sha256=XAsS9Qg1G7l1mq1Az1lvltsOaUFYvBabHxcco6eT2iI,134
+HardwareMonitor/Hardware/Psu/Msi/__init__.pyi,sha256=UxA8oH0yuH0ja8c37aoGIxFNKvLOF3SRsrQrn2DUGcs,261
+HardwareMonitor/Hardware/Storage/__init__.py,sha256=eCNE2n8zr4bRayXaEaNpzwd89uc39Rvo8yzxec-Giv4,134
+HardwareMonitor/Hardware/Storage/__init__.pyi,sha256=BCli3GL_nRdR91pvqNAVbVC8dMPd5_aMx3vuv59NZn4,1547
+HardwareMonitor/Interop/__init__.py,sha256=tW65In2jGp3p67omZDwIdahuL_qOX3hS6WIaxVR2cm0,116
+HardwareMonitor/Interop/PowerMonitor/__init__.py,sha256=xQHqZufOFZir3J3SyL8kCjFN_UYMXr8Wilk9jBrrA-s,142
+HardwareMonitor/Interop/PowerMonitor/__init__.pyi,sha256=PNZ_PaUW9KL0ccFR0SNvTn8oi-_rgMVSeQUJbtyZwT8,5855
+HardwareMonitor/PawnIo/__init__.py,sha256=oBJvzk8gOsO_UM-r2CgHBdTJ0iWvEne7_Iikz-c6Iyg,114
+HardwareMonitor/PawnIo/__init__.pyi,sha256=rKeaRoFMydT7wLDbJzNkyf2PtrfOarPvXCHiPNGdy-E,3785
+HardwareMonitor/Software/__init__.py,sha256=Ze_FPHXXISpD56Y3N415NbQTuvtnvXRQRFeNdPGJ7Sk,118
+HardwareMonitor/Software/__init__.pyi,sha256=TFTzrrKfc-oN--EMSiwOdK7QdaYqR3m1c5JFA7NdMh0,180
+HardwareMonitor/_util/types.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+HardwareMonitor/_util/types.pyi,sha256=a-hniLLaENmFTPlVJhJe8_iJAK-zvCJ4RhMne_Num3A,6685
+HardwareMonitor/lib/BlackSharp.Core.dll,sha256=ziyQPCChbJ-m9k-jO9_EzvL0qMQsWZeX-BbmuPyEKw8,37888
+HardwareMonitor/lib/DiskInfoToolkit.dll,sha256=OM8gbu0sjmkGjygBUVqMDk3329dk446r81RP-_pNIWQ,1001472
+HardwareMonitor/lib/HidSharp.dll,sha256=2GaQ794w6pF59mkyDzkUiFN5O3Q6mLUxr-rzBZjiL1Q,262792
+HardwareMonitor/lib/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+HardwareMonitor/lib/LibreHardwareMonitorLib.dll,sha256=_18JWAM_gNNtAVamXEesEyrpeG7Xxa4Qa0-Gk6ZW2pM,1202176
+HardwareMonitor/lib/RAMSPDToolkit-NDD.dll,sha256=oatdiwGsMiupS04NL5Jr_hSXgpYC3lcDdf21372uZR4,249344
+HardwareMonitor/lib/System.Memory.dll,sha256=1ejkhm-c-mb3dlZg-EshAZiJPlUzVIev5evaNCwOkT0,145200
+HardwareMonitor/lib/System.Numerics.Vectors.dll,sha256=IML6gbjHDWUQmddilU8oX9T5QuY7LXIXwUXauNSy9Mk,110344
+HardwareMonitor/lib/System.Runtime.CompilerServices.Unsafe.dll,sha256=CMvXJ4tm8eaEJagtS5cYGkEw2T492RgxQHq6chLM2s8,19256
+HardwareMonitor/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hardwaremonitor-1.2.0.dist-info/licenses/LICENSE,sha256=psiYy4oS_H6JisAdCj63Pa_ME4WvC5lt3sSQ-akqaXY,1521
+hardwaremonitor-1.2.0.dist-info/METADATA,sha256=tDF-aahrB3SbbTCHoT00Si63_OPNwbgvE8BZwLolaSM,7904
+hardwaremonitor-1.2.0.dist-info/WHEEL,sha256=QR8DNjG6Lr6bNErJWJgF4dP2dJ2N7NpY-BWly1OvcTM,97
+hardwaremonitor-1.2.0.dist-info/top_level.txt,sha256=jDlKTMoU7BagQp3UImcsSB31DZW7zYYAuSuZ4FYW1D4,16
+hardwaremonitor-1.2.0.dist-info/RECORD,,

hardwaremonitor-1.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-win_amd64
+

hardwaremonitor-1.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Nicholas Feix
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

hardwaremonitor-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+HardwareMonitor