mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-13 22:38:46 +02:00
Updated the manuals
This commit is contained in:
150
docs/write-value.md
Normal file
150
docs/write-value.md
Normal file
@ -0,0 +1,150 @@
|
||||
The *write-value.ps1* Script
|
||||
===========================
|
||||
|
||||
This PowerShell script writes the given value with the unit and the value range to the console.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
/Repos/PowerShell/scripts/write-value.ps1 [[-value] <Single>] [[-unit] <String>] [[-redMin] <Single>] [[-yellowMin] <Single>] [[-yellowMax] <Single>] [[-redMax] <Single>] [<CommonParameters>]
|
||||
|
||||
-value <Single>
|
||||
Specifies the value
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value 0.5
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-unit <String>
|
||||
|
||||
Required? false
|
||||
Position? 2
|
||||
Default value Mach
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-redMin <Single>
|
||||
|
||||
Required? false
|
||||
Position? 3
|
||||
Default value 0
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-yellowMin <Single>
|
||||
|
||||
Required? false
|
||||
Position? 4
|
||||
Default value 0
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-yellowMax <Single>
|
||||
|
||||
Required? false
|
||||
Position? 5
|
||||
Default value 0
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-redMax <Single>
|
||||
|
||||
Required? false
|
||||
Position? 6
|
||||
Default value 0
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
[<CommonParameters>]
|
||||
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
|
||||
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
|
||||
```
|
||||
|
||||
Example
|
||||
-------
|
||||
```powershell
|
||||
PS> ./write-value.ps1 95.0 "°C" 0 10 90 100
|
||||
[0--------95°C-100]
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Writes a value with unit and range
|
||||
.DESCRIPTION
|
||||
This PowerShell script writes the given value with the unit and the value range to the console.
|
||||
.PARAMETER value
|
||||
Specifies the value
|
||||
.EXAMPLE
|
||||
PS> ./write-value.ps1 95.0 "°C" 0 10 90 100
|
||||
[0--------95°C-100]
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([float]$value = 0.5, [string]$unit = "Mach", [float]$redMin, [float]$yellowMin, [float]$yellowMax, [float]$redMax)
|
||||
|
||||
function WriteValueInRange([float]$value, [string]$unit, [float]$redMin, [float]$yellowMin, [float]$yellowMax, [float]$redMax) {
|
||||
$line = "------------------------------------------------"
|
||||
$text = "[$redMin$($value)$unit $redMax]"
|
||||
[float]$total = 20.0 - $text.Length
|
||||
if ($value -gt $redMax) {
|
||||
Write-Host "[$redMin$($line.Substring(0, $total))$redMax]" -noNewline
|
||||
Write-Host "$($value)$unit " -noNewline -foregroundColor red
|
||||
} elseif ($value -lt $redMin) {
|
||||
Write-Host "$($value)$unit" -noNewline -foregroundColor red
|
||||
Write-Host "[$redMin$($line.Substring(0, $total))$redMax] " -noNewline
|
||||
} else {
|
||||
[float]$leftSide = (($value - $redMin) * $total) / ($redMax - $redMin)
|
||||
if ($leftSide -lt 1.0) { $leftSide = 1.0 }
|
||||
if ($leftSide -gt ($total - 1.0)) { $leftSide = $total - 1.0 }
|
||||
Write-Host "[$redMin$($line.Substring(0, $leftSide))" -noNewline
|
||||
if (($value -le $yellowMin) -or ($value -ge $yellowMax)) {
|
||||
Write-Host "$($value)$unit" -noNewline -foregroundColor yellow
|
||||
} else {
|
||||
Write-Host "$($value)$unit" -noNewline -foregroundColor green
|
||||
}
|
||||
Write-Host "$($line.Substring(0, $total - $leftSide + 0.49))$redMax] " -noNewline
|
||||
}
|
||||
}
|
||||
|
||||
WriteValueInRange -3.5 "°C" 0 10 90 100
|
||||
Write-Host "CPU too cold"
|
||||
|
||||
WriteValueInRange 5 "°C" 0 10 90 100
|
||||
Write-Host "CPU quite cold"
|
||||
|
||||
WriteValueInRange 15 "°C" 0 10 90 100
|
||||
Write-Host "OK"
|
||||
|
||||
WriteValueInRange 50 "°C" 0 10 90 100
|
||||
Write-Host "OK"
|
||||
|
||||
WriteValueInRange 70 "°C" 0 10 90 100
|
||||
Write-Host "OK"
|
||||
|
||||
WriteValueInRange 95 "°C" 0 10 90 100
|
||||
Write-Host "CPU quite hot "
|
||||
|
||||
WriteValueInRange 110 "°C" 0 10 90 100
|
||||
Write-Host "CPU too hot "
|
||||
|
||||
exit 0 # success
|
||||
```
|
||||
|
||||
*(page generated by convert-ps2md.ps1 as of 01/17/2025 08:30:58)*
|
Reference in New Issue
Block a user