Skip to content

Commit 92046c4

Browse files
sergiyesergiye
committed
update README
1 parent fc03eb0 commit 92046c4

1 file changed

Lines changed: 99 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,111 @@
11
# Open hardware monitor
2-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/sergiye/openhardwaremonitor?style=plastic)
3-
![GitHub all releases](https://img.shields.io/github/downloads/sergiye/openhardwaremonitor/total?style=plastic)
4-
![GitHub last commit](https://img.shields.io/github/last-commit/sergiye/openhardwaremonitor?style=plastic)
2+
[![Release](https://img.shields.io/github/v/release/NewOpenHardwareMonitor/openhardwaremonitor)](https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/releases/latest)
3+
![Downloads](https://img.shields.io/github/downloads/NewOpenHardwareMonitor/openhardwaremonitor/total?color=ff4f42)
4+
![Last commit](https://img.shields.io/github/last-commit/NewOpenHardwareMonitor/openhardwaremonitor?color=00AD00)
5+
6+
[![Nuget](https://img.shields.io/nuget/v/OpenHardwareMonitorLib)](https://www.nuget.org/packages/OpenHardwareMonitorLib/)
7+
[![Nuget](https://img.shields.io/nuget/dt/OpenHardwareMonitorLib?label=nuget-downloads)](https://www.nuget.org/packages/OpenHardwareMonitorLib/)
8+
9+
Open hardware monitor - is free software that can monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer.
10+
11+
This application is based on the "original" [openhardwaremonitor](https://github.com/openhardwaremonitor/openhardwaremonitor) project.
12+
13+
# This is a legacy and outdated version, for the latest features check the [current repo](https://github.com/newopenhardwaremonitor/openhardwaremonitor)
514

6-
Open hardware monitor - system sensors monitoring application for Windows/Linux
715

816
## Features
917

10-
repository was forked from https://github.com/openhardwaremonitor/openhardwaremonitor
18+
### What can it do?
19+
20+
You can see information about devices such as:
21+
- Motherboards
22+
- Intel and AMD processors
23+
- RAM
24+
- NVIDIA and AMD graphics cards
25+
- HDD, SSD and NVMe hard drives
26+
- Network cards
27+
- Power suppliers
28+
- Laptop batteries
29+
30+
### Additional features
31+
32+
- `Remote web-server` mode for browsing data from remote machine with custom port and authentication.
33+
- `Hide/Unhide` sensors to remove some data from UI and web server.
34+
- Multiple `Tray icons` and `Gadget` for selected sensor values.
35+
- `Light`/`Dark` themes with auto switching mode.
36+
- Custom `color-themes` from external files - You can find examples [here](https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/tree/dev/OpenHardwareMonitor/Resources/themes)
37+
- `Portable` mode for storing temporary driver file and settings configuration next to the executable file.
38+
- `Updated versions check` - manually from main menu.
39+
40+
Note: Some sensors are only available when running the application as administrator.
41+
42+
### UI example with `Light`/`Dark` themes
43+
44+
[<img src="https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/raw/master/themes.png" alt="Themes" width="300"/>](https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/raw/master/themes.png)
45+
46+
## Download
47+
48+
The published version can be obtained from [releases](https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/releases).
49+
50+
51+
## Developer information
52+
**Integrate the library in own application**
53+
1. Add the [OpenHardwareMonitorLib](https://www.nuget.org/packages/OpenHardwareMonitorLib/) NuGet package to your application.
54+
2. Use the sample code below or the test console application from [here](https://github.com/NewOpenHardwareMonitor/openhardwaremonitor/tree/dev/LibTest)
55+
56+
57+
**Sample code**
58+
```c#
59+
class HardwareInfoProvider : IVisitor, IDisposable {
60+
61+
private readonly Computer computer;
62+
63+
public HardwareInfoProvider() {
64+
computer = new Computer {
65+
IsCpuEnabled = true,
66+
IsMemoryEnabled = true,
67+
};
68+
computer.Open(false);
69+
}
70+
71+
internal float Cpu { get; private set; }
72+
internal float Memory { get; private set; }
73+
74+
public void VisitComputer(IComputer computer) => computer.Traverse(this);
75+
public void VisitHardware(IHardware hardware) => hardware.Update();
76+
public void VisitSensor(ISensor sensor) { }
77+
public void VisitParameter(IParameter parameter) { }
78+
public void Dispose() => computer.Close();
79+
80+
internal void Refresh() {
81+
computer.Accept(this);
82+
var cpuTotal = computer.Hardware.FirstOrDefault(h => h.HardwareType == HardwareType.Cpu)?.Sensors.FirstOrDefault(s => s.SensorType == SensorType.Load && s.Name == "CPU Total");
83+
Cpu = cpuTotal?.Value ?? -1;
84+
85+
var memorySensorName = "Physical Memory Available"; //"Virtual Memory Available";
86+
var memUsed = computer.Hardware.FirstOrDefault(h => h.HardwareType == HardwareType.Memory)?.Sensors.FirstOrDefault(s => s.SensorType == SensorType.Data && s.Name == memorySensorName);
87+
Memory = (memUsed == null || !memUsed.Value.HasValue) ? -1 : memUsed.Value.Value * 1024; //GB -> MB
88+
}
89+
}
90+
```
91+
92+
**Administrator rights**
93+
94+
Some sensors require administrator privileges to access the data. Restart your IDE with admin privileges, or add an [app.manifest](https://learn.microsoft.com/en-us/windows/win32/sbscs/application-manifests) file to your project with requestedExecutionLevel on requireAdministrator.
95+
96+
97+
## How can I help improve it?
98+
The OpenHardwareMonitor team welcomes feedback and contributions!<br/>
99+
You can check if it works properly on your motherboard. For many manufacturers, the way of reading data differs a bit, so if you notice any inaccuracies, please send us a pull request. If you have any suggestions or improvements, don't hesitate to create an issue.
11100

12-
# Download
101+
Also, don't forget to star the repository to help other people find it.
13102

14-
**The recommended way to get the program is BUILD from source**
15-
- Install git, Visual Studio
16-
- `git clone https://github.com/sergiye/openhardwaremonitor.git`
17-
- build
18103

19-
**or download build from <a href="https://github.com/sergiye/openhardwaremonitor/releases">releases</a>.**
104+
## Donate!
105+
Every [cup of coffee](https://patreon.com/SergiyE) you donate will help this app become better and let me know that this project is in demand.
20106

21107
## License
22108

23-
GPL-3.0 License
109+
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
24110

25-
Copyright © 2022 Sergiy Egoshyn
111+
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

0 commit comments

Comments
 (0)