OpenSource/PVE-mods
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix duplicate sodimm fan keys dectection, setup and visualisation (#133, #136, #113)

Browse Source
This commit is contained in:
Meliox 2025-09-15 20:31:19 +02:00 committed by GitHub
parent 67338aabbd
commit bb56097710
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 191 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

300
pve-mod-gui-sensors.sh
View File

@ -101,8 +101,8 @@ function install_packages {
;; ;;
[nN]) [nN])
# If the user chooses not to install lm-sensors, exit the script with a zero status code # If the user chooses not to install lm-sensors, exit the script with a zero status code
msg "Decided to not install lm-sensors. The mod cannot run without it. Exiting..." msgb "Decided to not install lm-sensors. The mod cannot run without it. Exiting..."
exit 0 err "lm-sensors is required. Exiting..."
;; ;;
*) *)
# If the user enters an invalid input, print an error message and exit the script with a non-zero status code # If the user enters an invalid input, print an error message and exit the script with a non-zero status code
@ -110,76 +110,112 @@ function install_packages {
;; ;;
esac esac
fi fi
# Check if lm-sensors is installed correctly and exit if not
if (! command -v sensors &>/dev/null); then
err "lm-sensors installation failed or 'sensors' command is not available. Please install lm-sensors manually and re-run the script."
fi
} }
function configure { function configure {
SENSORS_DETECTED=false SENSORS_DETECTED=false
local sensorsOutput local sensorsOutput
local sanitisedSensorsOutput
local upsOutput
local modelName
local upsConnection
# Load sensor data install_packages
if [ "$DEBUG_REMOTE" = true ]; then
warn "Remote debugging is used. Sensor readings from dump file $DEBUG_JSON_FILE will be used." #### Collect lm-sensors output ####
#region sensors collection
if [ "$DEBUG_REMOTE" = true ]; then
warn "Remote debugging is used. Sensor readings from dump file $DEBUG_JSON_FILE will be used."
warn "Remote debugging is used. UPS readings from dump file $DEBUG_UPS_FILE will be used." warn "Remote debugging is used. UPS readings from dump file $DEBUG_UPS_FILE will be used."
sensorsOutput=$(cat "$DEBUG_JSON_FILE") sensorsOutput=$(cat "$DEBUG_JSON_FILE")
else else
sensorsOutput=$(sensors -j 2>/dev/null | python3 -m json.tool) sensorsOutput=$(sensors -j 2>/dev/null)
fi fi
# Apply lm-sensors sanitization
sanitisedSensorsOutput=$(sanitize_sensors_output "$sensorsOutput")
if [ $? -ne 0 ]; then if [ $? -ne 0 ]; then
err "Sensor output error.\n\nCommand output:\n${sensorsOutput}\n\nExiting..." err "Sensor output error.\n\nCommand output:\n${sanitisedSensorsOutput}\n\nExiting..."
fi fi
#endregion sensors collection
#### CPU #### #### CPU ####
msgb "\n=== Detecting CPU temperature sensors ===" #region cpu setup
ENABLE_CPU=false msgb "\n=== Detecting CPU temperature sensors ==="
local cpuList=() ENABLE_CPU=false
for item in "${KNOWN_CPU_SENSORS[@]}"; do local cpuList=""
if echo "$sensorsOutput" | grep -q "$item"; then local cpuCount=0
cpuList+=("$item")
ENABLE_CPU=true
fi
done
if [ "$ENABLE_CPU" = true ]; then # Find all CPU sensors that match known patterns
info "Detected CPU sensors (${#cpuList[@]}): $(IFS=,; echo "${cpuList[*]}")" for pattern in "${KNOWN_CPU_SENSORS[@]}"; do
SENSORS_DETECTED=true found_sensors=$(echo "$sanitisedSensorsOutput" | grep -o "\"${pattern}[^\"]*\"" | sed 's/"//g')
while true; do if [ -n "$found_sensors" ]; then
local choice=$(ask "Display temperatures for all cores [C] or average per CPU [a] (some newer AMD variants support per die)? (C/a)") while read -r sensor; do
case "$choice" in if [ -n "$sensor" ]; then
[cC]|"") cpuCount=$((cpuCount + 1))
CPU_TEMP_TARGET="Core" if [ -z "$cpuList" ]; then
info "Temperatures will be displayed for all cores." cpuList="$sensor"
break else
;; cpuList="$cpuList,$sensor"
[aA]) fi
CPU_TEMP_TARGET="Package" ENABLE_CPU=true
info "An average temperature will be displayed per CPU." fi
break done <<< "$found_sensors"
;; fi
*) done
warn "Invalid input, please choose C or a."
;;
esac
done
else
warn "No CPU temperature sensors found."
fi
#### RAM #### if [ "$ENABLE_CPU" = true ]; then
msgb "\n=== Detecting RAM temperature sensors ===" info "Detected CPU sensors ($cpuCount): $cpuList"
local ramList=($(echo "$sensorsOutput" | grep -o '"SODIMM[^"]*"' | sed 's/"//g')) SENSORS_DETECTED=true
if [ ${#ramList[@]} -gt 0 ]; then while true; do
info "Detected RAM sensors (${#ramList[@]}): $(IFS=,; echo "${ramList[*]}")" local choice=$(ask "Display temperatures for all cores [C] or average per CPU [a] (some newer AMD variants support per die)? (C/a)")
ENABLE_RAM_TEMP=true case "$choice" in
SENSORS_DETECTED=true [cC]|"")
else CPU_TEMP_TARGET="Core"
warn "No RAM temperature sensors found." info "Temperatures will be displayed for all cores."
ENABLE_RAM_TEMP=false break
fi ;;
[aA])
CPU_TEMP_TARGET="Package"
info "An average temperature will be displayed per CPU."
break
;;
*)
warn "Invalid input, please choose C or a."
;;
esac
done
else
warn "No CPU temperature sensors found."
fi
#endregion cpu setup
#### RAM ####
#region ram setup
msgb "\n=== Detecting RAM temperature sensors ==="
local ramList=$(echo "$sanitisedSensorsOutput" | grep -o '"SODIMM[^"]*"' | sed 's/"//g' | paste -sd, -)
local ramCount=$(grep -c '"SODIMM[^"]*"' <<<"$sanitisedSensorsOutput")
if [ "$ramCount" -gt 0 ]; then
info "Detected RAM sensors ($ramCount): $ramList"
ENABLE_RAM_TEMP=true
SENSORS_DETECTED=true
else
warn "No RAM temperature sensors found."
ENABLE_RAM_TEMP=false
fi
#endregion ram setup
#### HDD/SSD #### #### HDD/SSD ####
#region hdd setup
msgb "\n=== Detecting HDD/SSD temperature sensors ===" msgb "\n=== Detecting HDD/SSD temperature sensors ==="
local hddList=($(echo "$sensorsOutput" | grep -o '"drivetemp-scsi[^"]*"' | sed 's/"//g')) local hddList=($(echo "$sanitisedSensorsOutput" | grep -o '"drivetemp-scsi[^"]*"' | sed 's/"//g'))
if [ ${#hddList[@]} -gt 0 ]; then if [ ${#hddList[@]} -gt 0 ]; then
info "Detected HDD/SSD sensors (${#hddList[@]}): $(IFS=,; echo "${hddList[*]}")" info "Detected HDD/SSD sensors (${#hddList[@]}): $(IFS=,; echo "${hddList[*]}")"
ENABLE_HDD_TEMP=true ENABLE_HDD_TEMP=true
@ -188,10 +224,12 @@ function configure {
warn "No HDD/SSD temperature sensors found." warn "No HDD/SSD temperature sensors found."
ENABLE_HDD_TEMP=false ENABLE_HDD_TEMP=false
fi fi
#endregion hdd setup
#### NVMe #### #### NVMe ####
#region nvme setup
msgb "\n=== Detecting NVMe temperature sensors ===" msgb "\n=== Detecting NVMe temperature sensors ==="
local nvmeList=($(echo "$sensorsOutput" | grep -o '"nvme[^"]*"' | sed 's/"//g')) local nvmeList=($(echo "$sanitisedSensorsOutput" | grep -o '"nvme[^"]*"' | sed 's/"//g'))
if [ ${#nvmeList[@]} -gt 0 ]; then if [ ${#nvmeList[@]} -gt 0 ]; then
info "Detected NVMe sensors (${#nvmeList[@]}): $(IFS=,; echo "${nvmeList[*]}")" info "Detected NVMe sensors (${#nvmeList[@]}): $(IFS=,; echo "${nvmeList[*]}")"
ENABLE_NVME_TEMP=true ENABLE_NVME_TEMP=true
@ -200,37 +238,49 @@ function configure {
warn "No NVMe temperature sensors found." warn "No NVMe temperature sensors found."
ENABLE_NVME_TEMP=false ENABLE_NVME_TEMP=false
fi fi
#endregion nvme setup
#### Fans #### #### Fans ####
msgb "\n=== Detecting fan speed sensors ===" #region fan setup
local fanList=$(echo "$sensorsOutput" | grep -B 1 '"fan[0-9]*_input"' | grep -Po '"[^"]*":\s*\{$' | sed 's/"//g' | sed 's/: {//' | paste -sd ',' -) msgb "\n=== Detecting fan speed sensors ==="
local fanCount=$(echo "$sensorsOutput" | grep -c '"fan[0-9]*_input"')
if [ ${#fanList[@]} -gt 0 ]; then
info "Detected fan speed sensors ($fanCount): $fanList"
ENABLE_FAN_SPEED=true
SENSORS_DETECTED=true
local choice=$(ask "Display fans reporting zero speed? (Y/n)") local fanList=""
case "$choice" in local fanCount=0
[yY]|"")
DISPLAY_ZERO_SPEED_FANS=true # Find all fan names that have fan*_input entries
info "Zero-speed fans will be displayed." fanList=$(echo "$sanitisedSensorsOutput" | grep -B2 '"fan[0-9]\+_input"' | grep '".*": {' | sed 's/.*"\([^"]*\)": {.*/\1/' | sort -u | paste -sd, -)
;; fanCount=$(grep -c 'fan[0-9]\+_input' <<<"$sanitisedSensorsOutput")
[nN])
DISPLAY_ZERO_SPEED_FANS=false if [ "$fanCount" -gt 0 ]; then
info "Only active fans will be displayed." info "Detected fan speed sensors ($fanCount): $fanList"
;; ENABLE_FAN_SPEED=true
*) SENSORS_DETECTED=true
warn "Invalid input. Defaulting to show zero-speed fans."
DISPLAY_ZERO_SPEED_FANS=true local choice
;; choice=$(ask "Display fans reporting zero speed? (Y/n)")
esac case "$choice" in
else [yY]|"")
warn "No fan speed sensors found." DISPLAY_ZERO_SPEED_FANS=true
ENABLE_FAN_SPEED=false info "Zero-speed fans will be displayed."
fi ;;
[nN])
DISPLAY_ZERO_SPEED_FANS=false
info "Only active fans will be displayed."
;;
*)
warn "Invalid input. Defaulting to show zero-speed fans."
DISPLAY_ZERO_SPEED_FANS=true
;;
esac
else
warn "No fan speed sensors found."
ENABLE_FAN_SPEED=false
fi
#endregion fan setup
#### Temperature Units #### #### Temperature Units ####
#region temp unit setup
msgb "\n=== Display temperature ==="
if [ "$SENSORS_DETECTED" = true ]; then if [ "$SENSORS_DETECTED" = true ]; then
local unit=$(ask "Display temperatures in Celsius [C] or Fahrenheit [f]? (C/f)") local unit=$(ask "Display temperatures in Celsius [C] or Fahrenheit [f]? (C/f)")
case "$unit" in case "$unit" in
@ -248,8 +298,10 @@ function configure {
;; ;;
esac esac
fi fi
#endregion temp unit setup
#### UPS #### #### UPS ####
#region ups setup
local choiceUPS=$(ask "Enable UPS information? (y/N)") local choiceUPS=$(ask "Enable UPS information? (y/N)")
case "$choiceUPS" in case "$choiceUPS" in
[yY]) [yY])
@ -283,8 +335,10 @@ function configure {
ENABLE_UPS=false ENABLE_UPS=false
;; ;;
esac esac
#endregion ups setup
#### System Info #### #### System Info ####
#region system info setup
msgb "\n=== Detecting System Information ===" msgb "\n=== Detecting System Information ==="
for i in 1 2; do for i in 1 2; do
echo "type ${i})" echo "type ${i})"
@ -312,11 +366,14 @@ function configure {
SYSTEM_INFO_TYPE=1 SYSTEM_INFO_TYPE=1
;; ;;
esac esac
#endregion system info setup
#### Final Check #### #### Final Check ####
#region final check
if [ "$SENSORS_DETECTED" = false ] && [ "$ENABLE_UPS" = false ] && [ "$ENABLE_SYSTEM_INFO" = false ]; then if [ "$SENSORS_DETECTED" = false ] && [ "$ENABLE_UPS" = false ] && [ "$ENABLE_SYSTEM_INFO" = false ]; then
err "No sensors detected, UPS or system info enabled. Exiting." err "No sensors detected, UPS or system info enabled. Exiting."
fi fi
#endregion final check
} }
@ -377,6 +434,34 @@ function install_mod {
ask "Clear the browser cache to ensure all changes are visualized. (any key to continue)" ask "Clear the browser cache to ensure all changes are visualized. (any key to continue)"
} }
# Sanitize sensors output to handle common lm-sensors parsing issues
sanitize_sensors_output() {
local input="$1"
# Pipe the text into Perl:
# -0777 → "slurp mode": read the entire stream as one string so
# regexes can match across line breaks.
# -pe → loop over input, applying the script (-e) and printing.
# Apply python3 json.tool for proper formatting and validation
echo "$input" | perl -0777 -pe '
# Replace ERROR lines with placeholder values
s/ERROR:.+\s(\w+):\s(.+)/"$1": 0.000,/g;
s/ERROR:.+\s(\w+)!/"$1": 0.000,/g;
# Remove trailing commas before closing braces
s/,\s*(\})/$1/g;
# Replace NaN values with null
s/\bNaN\b/null/g;
# Fix duplicate SODIMM keys - handle both pretty and one-line JSON
s/"SODIMM"\s*:\s*\{\s*"temp(\d+)_input"/"SODIMM $1": {\n "temp$1_input"/g;
# Fix duplicate fan keys - handle both pretty and one-line JSON
s/"([^"]*Fan[^"]*)"\s*:\s*\{\s*"fan(\d+)_input"/"$1 $2": {\n "fan$2_input"/g;
' | python3 -m json.tool 2>/dev/null || echo "$input"
}
#region node info insertion #region node info insertion
# Main insertion routine # Main insertion routine
insert_node_info() { insert_node_info() {
@ -402,8 +487,10 @@ collect_sensors_output() {
sensorsCmd="cat \"$DEBUG_JSON_FILE\"" sensorsCmd="cat \"$DEBUG_JSON_FILE\""
else else
# Note: sensors -f (Fahrenheit) breaks fan speeds # Note: sensors -f (Fahrenheit) breaks fan speeds
sensorsCmd="sensors -j 2>/dev/null | python3 -m json.tool" sensorsCmd="sensors -j 2>/dev/null"
fi fi
# Remember to reflect this in sanitize_sensors_output()
#region sensors heredoc #region sensors heredoc
sed -i '/my \$dinfo = df('\''\/'\'', 1);/i\ sed -i '/my \$dinfo = df('\''\/'\'', 1);/i\
# Collect sensor data from lm-sensors\ # Collect sensor data from lm-sensors\
@ -420,10 +507,17 @@ collect_sensors_output() {
# Replace NaN values with null for valid JSON\ # Replace NaN values with null for valid JSON\
$res->{sensorsOutput} =~ s/\\bNaN\\b/null/g;\ $res->{sensorsOutput} =~ s/\\bNaN\\b/null/g;\
\ \
# Fix duplicate SODIMM keys by appending temperature sensor number\ # Fix duplicate SODIMM keys by appending temperature sensor number with a space - handle both pretty and one-line JSON\
# This prevents JSON key overwrites when multiple SODIMM sensors exist\ # Example: "SODIMM":{"temp3_input":34.0} becomes "SODIMM 3":{"temp3_input":34.0}\
# Example: "SODIMM":{"temp3_input":34.0} becomes "SODIMM3":{"temp3_input":34.0}\ $res->{sensorsOutput} =~ s/"SODIMM"\\s*:\\s*\\{\\s*"temp(\\d+)_input"/"SODIMM $1": {\\n "temp$1_input"/g;\
$res->{sensorsOutput} =~ s/\\"SODIMM\\":\\{\\"temp(\\d+)_input\\"/\\"SODIMM$1\\":\\{\\"temp$1_input\\"/g;\ \
# Fix duplicate fans keys by appending fan number with a space - handle both pretty and one-line JSON\
# Example: "Processor Fan":{"fan2_input":1000,...} → "Processor Fan 2":{"fan2_input":1000,...}\
$res->{sensorsOutput} =~ s/"([^"]+)"\\s*:\\s*\{\\s*"fan(\\d+)_input"/"$1 $2": {\\n "fan$2_input"/g;\
\
# Format JSON output properly (workaround for lm-sensors >3.6.0 issues)\
$res->{sensorsOutput} =~ /^(.*)$/s;\
$res->{sensorsOutput} = `echo \\Q$1\\E | python3 -m json.tool 2>/dev/null || echo \\Q$1\E`;\
' "$NODES_PM_FILE" ' "$NODES_PM_FILE"
#endregion sensors heredoc #endregion sensors heredoc
info "Sensors' retriever added to \"$output_file\"." info "Sensors' retriever added to \"$output_file\"."
@ -1185,23 +1279,6 @@ generate_ram_widget() {
textField: 'sensorsOutput', textField: 'sensorsOutput',
renderer: function(value) { renderer: function(value) {
const cpuTempHelper = Ext.create('PVE.mod.TempHelper', $HELPERCTORPARAMS); const cpuTempHelper = Ext.create('PVE.mod.TempHelper', $HELPERCTORPARAMS);
// Make SODIMM unique keys
value = value.split('\n'); // Split by newlines
for (let i = 0; i < value.length; i++) {
// Check if the current line contains 'SODIMM'
if (value[i].includes('SODIMM') && i + 1 < value.length) {
// Extract the number '3' following 'temp' from the next line (e.g., "temp3_input": 25.000)
let nextLine = value[i + 1];
let match = nextLine.match(/"temp(\d+)_input": (\d+\.\d+)/);
if (match) {
let number = match[1]; // Extracted number
// Replace the current line with SODIMM by the extracted number
value[i] = value[i].replace('SODIMM', `SODIMM${number}`);
}
}
}
value = value.join('\n'); // Reverse line split
let objValue; let objValue;
try { try {
@ -1238,8 +1315,7 @@ generate_ram_widget() {
// Process each ram key and value // Process each ram key and value
ramKeys.forEach(({ key: ramKey, value: ramTemp }) => { ramKeys.forEach(({ key: ramKey, value: ramTemp }) => {
try { try {
ram = ramKey.replace('SODIMM', 'SODIMM '); ramTemps.push(`${ramKey}:&nbsp${ramTemp}${cpuTempHelper.getUnit()}`);
ramTemps.push(`${ram}:&nbsp${ramTemp}${cpuTempHelper.getUnit()}`);
} catch(e) { } catch(e) {
console.error(`Error retrieving Ram Temp for ${ramTemps} in ${parentKey}:`, e); // Debug: Log specific error console.error(`Error retrieving Ram Temp for ${ramTemps} in ${parentKey}:`, e); // Debug: Log specific error
} }
@ -1558,7 +1634,13 @@ function save_sensors_data {
local choiceContinue=$(ask "Do you wish to continue? (Y/n)") local choiceContinue=$(ask "Do you wish to continue? (Y/n)")
case "$choiceContinue" in case "$choiceContinue" in
[yY]|"") [yY]|"")
sensors -j 2>/dev/null | python3 -m json.tool >"$filepath" echo "lm-sensors raw output:" >"$filepath"
sensorsOutput=$(sensors -j 2>/dev/null)
echo "$sensorsOutput" >>"$filepath"
echo -e "\n\nSanitised lm-sensors output:" >>"$filepath"
# Apply lm-sensors sanitization
sanitisedSensorsOutput=$(sanitize_sensors_output "$sensorsOutput")
echo "$sanitisedSensorsOutput" >>"$filepath"
info "Sensors data saved in $filepath." info "Sensors data saved in $filepath."
;; ;;
*) *)