Apply suggestions from code review

Co-authored-by: Jacob Laursen <[email protected]> Signed-off-by: Markus Heberling <[email protected]>
openhab · Nov 24, 2023 · f0f6231 · f0f6231
1 parent f1201e2
commit f0f6231
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 18 deletions.
diff --git a/bundles/org.openhab.binding.bluetooth.grundfosalpha/README.md b/bundles/org.openhab.binding.bluetooth.grundfosalpha/README.md
@@ -1,8 +1,8 @@
 # GrundfosAlpha Binding
 
-This adds support for reading out the data of Grundfos Alpha Pumps with a Grundfos Alpha Reader (https://product-selection.grundfos.com/de/products/alpha-reader/mi401-alpha-reader-98916967?pumpsystemid=2213476387&tab=variant-specifications)
+This adds support for reading out the data of Grundfos Alpha Pumps with a [Grundfos Alpha Reader](https://product-selection.grundfos.com/products/alpha-reader)
 
-The reverse engineering of the protocol was taken from https://github.com/JsBergbau/AlphaDecoder
+The reverse engineering of the protocol was taken from [https://github.com/JsBergbau/AlphaDecoder](https://github.com/JsBergbau/AlphaDecoder).
 
 ## Supported Things
 
@@ -22,13 +22,13 @@ All readers are auto-detected as soon as Bluetooth is configured in openHAB and
 
 ## Channels
 
-| Channel         | Type                      | Read/Write | Description                        |
-|-----------------|---------------------------|------------|------------------------------------|
-| rssi            | Number                    | R          | Received Signal Strength Indicator |
-| flowRate        | Number:VolumetricFlowRate | R          | The flow rate of the pump          |
-| pumpHead        | Number:Length             | R          | The water head above the pump      |
-| pumpTemperature | Number:Temperature        | R          | The temperature of the pump        |
-| batteryLevel    | Number:Percent            | R          | The battery level of the reader    |
+| Channel          | Type                      | Read/Write | Description                        |
+|------------------|---------------------------|------------|------------------------------------|
+| rssi             | Number                    | R          | Received Signal Strength Indicator |
+| flow-rate        | Number:VolumetricFlowRate | R          | The flow rate of the pump          |
+| pump-head        | Number:Length             | R          | The water head above the pump      |
+| pump-temperature | Number:Temperature        | R          | The temperature of the pump        |
+| battery-level    | Number:Percent            | R          | The battery level of the reader    |
 
 ## Full Example
 

diff --git a/...hab/binding/bluetooth/grundfosalpha/internal/GrundfosAlphaReaderDiscoveryParticipant.java b/...hab/binding/bluetooth/grundfosalpha/internal/GrundfosAlphaReaderDiscoveryParticipant.java
@@ -32,7 +32,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * This discovery participant is able to recognize enoceanble devices and create discovery results for them.
+ * This discovery participant is able to recognize Grundfos Alpha devices and create discovery results for them.
  *
  * @author Patrick Fink - Initial contribution
  *

diff --git a/...g/openhab/binding/bluetooth/grundfosalpha/internal/GrundfosAlphaReaderHandlerFactory.java b/...g/openhab/binding/bluetooth/grundfosalpha/internal/GrundfosAlphaReaderHandlerFactory.java
@@ -32,7 +32,7 @@
  * @author Markus Heberling - Initial contribution
  */
 @NonNullByDefault
-@Component(configurationPid = "binding.grundfosalphareader", service = ThingHandlerFactory.class)
+@Component(configurationPid = "binding.bluetooth.grundfosalpha", service = ThingHandlerFactory.class)
 public class GrundfosAlphaReaderHandlerFactory extends BaseThingHandlerFactory {
 
     private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_MI401);

diff --git a/...les/org.openhab.binding.bluetooth.grundfosalpha/src/main/resources/OH-INF/addon/addon.xml b/...les/org.openhab.binding.bluetooth.grundfosalpha/src/main/resources/OH-INF/addon/addon.xml
@@ -5,7 +5,7 @@
 
 	<type>binding</type>
 	<name>GrundfosAlpha Binding</name>
-	<description>This is the binding for GrundfosAlpha.</description>
+	<description>This is the binding for Grundfos Alpha circulator pumps.</description>
 	<connection>local</connection>
 
 </addon:addon>
diff --git a/...g.openhab.binding.bluetooth.grundfosalpha/src/main/resources/OH-INF/thing/thing-types.xml b/...g.openhab.binding.bluetooth.grundfosalpha/src/main/resources/OH-INF/thing/thing-types.xml
@@ -8,23 +8,27 @@
 		<item-type>Number:VolumetricFlowRate</item-type>
 		<label>Current Flow</label>
 		<description>Current flow</description>
-		<category>flow</category>
+		<category>Flow</category>
 		<state readOnly="true" pattern="%.2f %unit%"/>
 	</channel-type>
 
 	<channel-type id="grundfos-head">
 		<item-type>Number:Length</item-type>
 		<label>Current Head</label>
-		<description>Current Head</description>
-		<category>water</category>
+		<description>Current head</description>
+		<category>Water</category>
 		<state readOnly="true" pattern="%.2f %unit%"/>
 	</channel-type>
 
 	<channel-type id="grundfos-temperature">
 		<item-type>Number:Temperature</item-type>
 		<label>Current Pump Temperature</label>
 		<description>Current pump temperature</description>
-		<category>temperature</category>
+		<category>Temperature</category>
+		<tags>
+			<tag>Measurement</tag>
+			<tag>Temperature</tag>
+		</tags>
 		<state readOnly="true" pattern="%.2f %unit%"/>
 	</channel-type>
 
@@ -37,7 +41,7 @@
 
 		<label>Grundfos Alpha Reader MI401</label>
 		<description>A Grundfos Alpha Reader MI401</description>
-		<category>pump</category>
+		<category>Pump</category>
 
 		<channels>
 			<channel id="rssi" typeId="rssi"/>

diff --git a/bundles/pom.xml b/bundles/pom.xml
@@ -77,8 +77,8 @@
     <module>org.openhab.binding.bluetooth.daikinmadoka</module>
     <module>org.openhab.binding.bluetooth.enoceanble</module>
     <module>org.openhab.binding.bluetooth.generic</module>
-    <module>org.openhab.binding.bluetooth.grundfosalpha</module>
     <module>org.openhab.binding.bluetooth.govee</module>
+    <module>org.openhab.binding.bluetooth.grundfosalpha</module>
     <module>org.openhab.binding.bluetooth.radoneye</module>
     <module>org.openhab.binding.bluetooth.roaming</module>
     <module>org.openhab.binding.bluetooth.ruuvitag</module>