Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0194-WebUI-Add-MissingChannelDescriptions #2922

Merged
merged 4 commits into from
Nov 17, 2024
Merged

0194-WebUI-Add-MissingChannelDescriptions #2922

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05271a2
add missing channel description translation
Nov 17, 2024
e3cb43f
fixes some code rabbit suggestions
Nov 17, 2024
8810fc9
add KWL Controller
Nov 17, 2024
222ff9b
fix more coderabbit suggestions.
jens-maus Nov 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions buildroot-external/patches/occu/0194-WebUI-Add-MissingChannelDescriptions.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
--- occu/WebUI/www/webui/js/lang/de/translate.lang.channelDescription.js.orig
+++ occu/WebUI/www/webui/js/lang/de/translate.lang.channelDescription.js
@@ -1,5 +1,56 @@
jQuery.extend(true,langJSON, {
"de" : {
+ "chType_ACOUSTIC_DISPLAY_RECEIVER" : "Display und<br/>Tonsignalgeber",
+ "chType_AKKU" : "Akku",
+ "chType_ALARMACTUATOR" : "Alarmgeber",
+ "chType_BRIGHTNESS_TRANSMITTER" : "Helligkeitsensor",
+ "chType_CAPACITIVE_FILLING_LEVEL_SENSOR" : "Füllstandssensor",
+ "chType_CARBON_DIOXIDE_RECEIVER" : "Kohlendioxidsensor",
+ "chType_CENTRAL_KEY" : "Zentralentaste",
+ "chType_CLIMATECONTROL_REGULATOR" : "Heizungsregler Temperatur",
+ "chType_CLIMATECONTROL_VENT_DRIVE" : "Heizungsregler Ventilantrieb",
+ "chType_CLIMATE_TRANSCEIVER" :"Temperatur- und<br/>Luftfeuchtigkeitssensor",
+ "chType_COND_SWITCH_TRANSMITTER_NOX" : "Entscheidungswert NOX",
+ "chType_COND_SWITCH_TRANSMITTER_PARTICULATE_MATTER" : "Entscheidungswert Partikeldichte",
+ "chType_COND_SWITCH_TRANSMITTER_VOC" : "Entscheidungswert VOC",
+ "chType_DISPLAY" : "Display",
+ "chType_DISPLAY_INPUT_TRANSMITTER" : "Display Eingabekanal",
+ "chType_DISPLAY_LEVEL_INPUT_TRANSMITTER" : "Display Eingabekanal Level",
+ "chType_DISPLAY_THERMOSTAT_INPUT_TRANSMITTER" : "Display Eingabekanal Thermostat",
+ "chType_DOOR_LOCK_STATE_TRANSCEIVER" : "T%FCrschlosssensor",
+ "chType_DOOR_RECEIVER" : "Tor%F6ffner",
Comment on lines +23 to +24
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Standardize character encoding for German umlauts

Some German characters are URL-encoded (%FC for ü, %F6 for ö) while others are not. This inconsistency should be fixed for better maintainability.

Replace URL-encoded characters with their direct UTF-8 equivalents:

-    "chType_DOOR_LOCK_STATE_TRANSCEIVER" : "T%FCrschlosssensor",
-    "chType_DOOR_RECEIVER" : "Tor%F6ffner",
+    "chType_DOOR_LOCK_STATE_TRANSCEIVER" : "Türschlosssensor",
+    "chType_DOOR_RECEIVER" : "Toröffner",

Similarly for other instances:

-    "chType_SHUTTER_CONTACT" : "T%FCr-/Fensterkontakt",
-    "chType_SHUTTER_CONTACT_TRANSCEIVER" : "T%FCr-/Fensterkontakt",
+    "chType_SHUTTER_CONTACT" : "Tür-/Fensterkontakt",
+    "chType_SHUTTER_CONTACT_TRANSCEIVER" : "Tür-/Fensterkontakt",

Also applies to: 41-42

+ "chType_ENERGY_MANAGMENT" : "Energie Management",
+ "chType_GENERIC_MEASURING_TRANSMITTER" : "Universeller Sensorkanal",
+ "chType_KEYMATIC" : "Türschlossanrieb Keymatic",
+ "chType_LISTENER" : "Central-Device 63",
+ "chType_MAINTENANCE" : "Wartungskanal",
+ "chType_POWER_MAINS_TRANSMITTER" : "Stromnetzsensor",
+ "chType_POWERMETER_IEC1" : "Energiez%E4hler<br/>Sensor: IEC",
+ "chType_POWERMETER_IEC2" : "Energiez%E4hler<br/>Sensor: IEC",
+ "chType_POWERMETER_IGL" : "Energiez%E4hler<br/>Impuls/Gas/LED",
+ "chType_PULSE_SENSOR" : "Impulssensor",
+ "chType_RAIN_DETECTION_TRANSMITTER" : "Regensensor",
+ "chType_REPEATER" : "Repeater",
+ "chType_ROTARY_CONTROL_TRANSCEIVER" : "Drehsensor",
+ "chType_ROTARY_HANDLE_SENSOR" : "Fenster-/ Drehgriffkontakt",
+ "chType_SENSOR" : "Sensor",
+ "chType_SERVO_WEEK_PROFILE" : "Wochenprogramm",
+ "chType_SHUTTER_CONTACT" : "T%FCr-/Fensterkontakt",
+ "chType_SHUTTER_CONTACT_TRANSCEIVER" : "T%FCr-/Fensterkontakt",
+ "chType_SIGNAL_CHIME" : "Signalaktor (akustisch)",
+ "chType_SIGNAL_LED" : "Signalaktor (optisch)",
+ "chType_SMOKE_DETECTOR_TEAM" : "Funk-Rauchmelder (Gruppe)",
+ "chType_SMOKE_DETECTOR_TEAM_V2" : "Funk-Rauchmelder V2 (Gruppe)",
+ "chType_SMOKE_DETECTOR" : "Rauchmelder",
+ "chType_STATUS_INDICATOR" : "Statusanzeiger",
+ "chType_SWITCH_INTERFACE" : "Schalter Interface",
+ "chType_SWITCH_SENSOR" : "Schalter Sensor",
+ "chType_TILT_SENSOR" : "Lagesensor",
+ "chType_VIRTUAL_KEY" : "virtueller Taster",
+ "chType_WATER_DETECTION_TRANSMITTER" : "Wassermelder Sender",
+ "chType_WATERDETECTIONSENSOR" : "Wassermelder-<br/>Sensor-Kanal",
+ "chType_WEATHER" : "Wetter-/<br/>Klimadatenkanal",
+ "chType_WINMATIC" : "Fenster-Kippantrieb",

"chType_ACCELERATION_TRANSCEIVER" : "Lage-/Beschleunigungssensor",
"chType_ACCESS_RECEIVER" : "Benutzer",
--- occu/WebUI/www/webui/js/lang/en/translate.lang.channelDescription.js.orig
+++ occu/WebUI/www/webui/js/lang/en/translate.lang.channelDescription.js
@@ -1,5 +1,56 @@
jQuery.extend(true,langJSON, {
"en" : {
+ "chType_ACOUSTIC_DISPLAY_RECEIVER" : "Acoustic Display<br/>Receiver",
+ "chType_AKKU" : "Accu",
+ "chType_ALARMACTUATOR" : "Alarm actuator",
+ "chType_BRIGHTNESS_TRANSMITTER" : "Brightness Sensor",
+ "chType_CAPACITIVE_FILLING_LEVEL_SENSOR" : "Filling Level Sensor",
+ "chType_CARBON_DIOXIDE_RECEIVER" : "Carbon Dioxide Sensor",
+ "chType_CENTRAL_KEY" : "Central Key",
+ "chType_CLIMATECONTROL_REGULATOR" : "Climate Control</br>Regulator",
+ "chType_CLIMATECONTROL_VENT_DRIVE" : "Climate Control</br>Vent Drive",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix typos and standardize HTML break tags

There are some inconsistencies and typos in the English translations:

  1. Fix the typo in "Partical Matter":
-    "chType_COND_SWITCH_TRANSMITTER_PARTICULATE_MATTER" : "Decision Value<br/>Partical Matter",
+    "chType_COND_SWITCH_TRANSMITTER_PARTICULATE_MATTER" : "Decision Value<br/>Particle Matter",
  1. Standardize HTML break tag usage:
-    "chType_CLIMATECONTROL_REGULATOR" : "Climate Control</br>Regulator",
-    "chType_CLIMATECONTROL_VENT_DRIVE" : "Climate Control</br>Vent Drive",
+    "chType_CLIMATECONTROL_REGULATOR" : "Climate Control<br/>Regulator",
+    "chType_CLIMATECONTROL_VENT_DRIVE" : "Climate Control<br/>Vent Drive",

Also applies to: 76-76

+ "chType_CLIMATE_TRANSCEIVER" :"Temperature and<br/>Humidity sensor",
+ "chType_COND_SWITCH_TRANSMITTER_NOX" : "Decision Value NOX",
+ "chType_COND_SWITCH_TRANSMITTER_PARTICULATE_MATTER" : "Decision Value<br/>Partical Matter",
+ "chType_COND_SWITCH_TRANSMITTER_VOC" : "Decision Value VOC",
+ "chType_DISPLAY" : "Display",
+ "chType_DISPLAY_INPUT_TRANSMITTER" : "Display Input",
+ "chType_DISPLAY_LEVEL_INPUT_TRANSMITTER" : "Display Input Level",
+ "chType_DISPLAY_THERMOSTAT_INPUT_TRANSMITTER" : "Display Input Thermostat",
+ "chType_DOOR_LOCK_STATE_TRANSCEIVER" : "Door Lock State",
+ "chType_DOOR_RECEIVER" : "Door Opener",
+ "chType_ENERGY_MANAGMENT" : "Energy Management",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix typo in key name

The key chType_ENERGY_MANAGMENT contains a typo (missing 'E' in MANAGEMENT).

-    "chType_ENERGY_MANAGMENT" : "Energy Management",
+    "chType_ENERGY_MANAGEMENT" : "Energy Management",

This change needs to be applied to both German and English translation files.

Committable suggestion skipped: line range outside the PR's diff.

+ "chType_GENERIC_MEASURING_TRANSMITTER" : "Generic Sensor Channel",
+ "chType_KEYMATIC" : "Keymatic",
+ "chType_LISTENER" : "Central-Device 63",
+ "chType_MAINTENANCE" : "Maintenance Channel",
+ "chType_POWER_MAINS_TRANSMITTER" : "Mains Sensor",
+ "chType_POWERMETER_IEC1" : "Power Meter<br/>Sensor: IEC",
+ "chType_POWERMETER_IEC2" : "Power Meter<br/>Sensor: IEC",
+ "chType_POWERMETER_IGL" : "Power Meter<br/>Impuls/Gas/LED",
+ "chType_PULSE_SENSOR" : "Pulse Sensor",
+ "chType_RAIN_DETECTION_TRANSMITTER" : "Rain Sensor",
+ "chType_REPEATER" : "Repeater",
+ "chType_ROTARY_CONTROL_TRANSCEIVER" : "Rotary Sensor",
+ "chType_ROTARY_HANDLE_SENSOR" : "Rotary Handle Sensor",
+ "chType_SENSOR" : "Sensor",
+ "chType_SERVO_WEEK_PROFILE" : "Week Profile",
+ "chType_SHUTTER_CONTACT" : "Door/Window Contact",
+ "chType_SHUTTER_CONTACT_TRANSCEIVER" : "Door/Shutter Contact",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Inconsistent terminology in translations

The English translations for these entries are inconsistent:

  • chType_SHUTTER_CONTACT uses "Door/Window Contact"
  • chType_SHUTTER_CONTACT_TRANSCEIVER uses "Door/Shutter Contact"

They should use the same terminology as they refer to the same type of sensor.

-    "chType_SHUTTER_CONTACT_TRANSCEIVER" : "Door/Shutter Contact",
+    "chType_SHUTTER_CONTACT_TRANSCEIVER" : "Door/Window Contact",

Also applies to: 120-120

+ "chType_SIGNAL_CHIME" : "Signal (acoustic)",
+ "chType_SIGNAL_LED" : "Signal (LED)",
+ "chType_SMOKE_DETECTOR_TEAM" : "Smoke Detector (Team)",
+ "chType_SMOKE_DETECTOR_TEAM_V2" : "Smoke Detector V2 (Team)",
+ "chType_SMOKE_DETECTOR" : "Smoke detector",
+ "chType_STATUS_INDICATOR" : "Status Indicator",
+ "chType_SWITCH_INTERFACE" : "Switch Interface",
+ "chType_SWITCH_SENSOR" : "Switch Sensor",
+ "chType_TILT_SENSOR" : "Tilt Sensor",
+ "chType_VIRTUAL_KEY" : "Virtual push button",
+ "chType_WATER_DETECTION_TRANSMITTER" : "Waterdetector<br/>Transmitter",
+ "chType_WATERDETECTIONSENSOR" : "Waterdetector<br/>Sensor Channel",
+ "chType_WEATHER" : "Weather-/<br/>Climate channel",
+ "chType_WINMATIC" : "Winmatic",
"chType_ACCELERATION_TRANSCEIVER" : "Position/Acceleration sensor",
"chType_ACCESS_RECEIVER" : "User",
"chType_ACCESSPOINT_GENERIC_RECEIVER_1" : "Homematic IP Wired Bus Channel 1",
Loading
Loading