public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[modbus] correct parameter names in docs, logs and code comments (#10560) 

Signed-off-by: Sami Salonen <ssalonen@gmail.com>
This commit is contained in:
Sami Salonen 2021-04-24 13:20:32 +03:00 committed by GitHub
parent 19eea60a26
commit 1f4612ba2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bundles/org.openhab.binding.modbus/README.md
View File

@ -319,7 +319,7 @@ The profile works also in the reverse direction, when commanding items.
In addition, the profile allows attaching units to the raw numbers, as well as converting the quantity-aware numbers to bare numbers on write.
Profile has two parameters, `gain` (bare number or number with unit) and `pre-offset` (bare number), both of which must be provided.
Profile has two parameters, `gain` (bare number or number with unit) and `pre-gain-offset` (bare number), both of which must be provided.
When reading from Modbus, the result will be `updateTowardsItem = (raw_value_from_modbus + preOffset) * gain`.
When applying command, the calculation goes in reverse.
@ -775,7 +775,7 @@ Bridge modbus:tcp:localhostTCP3 [ host="127.0.0.1", port=502 ] {
`items/modbus_ex_scaling.items`:
```
Number:Temperature TemperatureItem "Temperature [%.1f °C]" { channel="modbus:data:localhostTCP3:holdingPoller:temperatureDeciCelsius:number"[ profile="modbus:gainOffset", gain="0.1 °C", offset="0" ] }
Number:Temperature TemperatureItem "Temperature [%.1f °C]" { channel="modbus:data:localhostTCP3:holdingPoller:temperatureDeciCelsius:number"[ profile="modbus:gainOffset", gain="0.1 °C", pre-gain-offset="0" ] }
```
`sitemaps/modbus_ex_scaling.sitemap`:

4
bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/profiles/ModbusGainOffsetProfile.java
View File

@ -131,7 +131,7 @@ public class ModbusGainOffsetProfile<Q extends Quantity<Q>> implements StateProf
Optional<QuantityType<Q>> localGain = gain;
Optional<QuantityType<Dimensionless>> localPregainOffset = pregainOffset;
if (localGain.isEmpty() || localPregainOffset.isEmpty()) {
logger.warn("Gain or offset unavailable. Check logs for configuration errors.");
logger.warn("Gain or pre-gain-offset unavailable. Check logs for configuration errors.");
return UnDefType.UNDEF;
} else if (state instanceof UnDefType) {
return UnDefType.UNDEF;
@ -162,7 +162,7 @@ public class ModbusGainOffsetProfile<Q extends Quantity<Q>> implements StateProf
}
} catch (UnconvertibleException | UnsupportedOperationException e) {
logger.warn(
"Cannot apply gain ('{}') and offset ('{}') to state ('{}') (formula {}) because types do not match (towardsItem={}): {}",
"Cannot apply gain ('{}') and pre-gain-offset ('{}') to state ('{}') (formula {}) because types do not match (towardsItem={}): {}",
gain, pregainOffsetQt, state, formula, towardsItem, e.getMessage());
return UnDefType.UNDEF;
}

32
bundles/org.openhab.binding.modbus/src/test/java/org/openhab/binding/modbus/internal/profiles/ModbusGainOffsetProfileTest.java
View File

@ -53,8 +53,8 @@ public class ModbusGainOffsetProfileTest {
//
// gain with same unit
//
// e.g. (handler) 3 <---> (item) 106K with raw-offset=50, gain=2K
// e.g. (handler) 3 K <---> (item) 106K^2 with raw-offset=50K, gain=2K
// e.g. (handler) 3 <---> (item) 106K with pre-gain-offset=50, gain=2K
// e.g. (handler) 3 K <---> (item) 106K^2 with pre-gain-offset=50K, gain=2K
//
Arguments.of("50", "2 K", "3", "106 K"),
//
@ -98,9 +98,9 @@ public class ModbusGainOffsetProfileTest {
*/
@ParameterizedTest
@MethodSource({ "provideArgsForBoth", "provideAdditionalArgsForStateUpdateFromHandler" })
public void testOnStateUpdateFromHandler(String rawOffset, String gain, Object updateFromHandlerObj,
public void testOnStateUpdateFromHandler(String preGainOffset, String gain, Object updateFromHandlerObj,
Object expectedUpdateTowardsItemObj) {
testOnUpdateFromHandlerGeneric(rawOffset, gain, updateFromHandlerObj, expectedUpdateTowardsItemObj, true);
testOnUpdateFromHandlerGeneric(preGainOffset, gain, updateFromHandlerObj, expectedUpdateTowardsItemObj, true);
}
/**
@ -110,18 +110,18 @@ public class ModbusGainOffsetProfileTest {
*/
@ParameterizedTest
@MethodSource({ "provideArgsForBoth", "provideAdditionalArgsForStateUpdateFromHandler" })
public void testOnCommandFromHandler(String rawOffset, String gain, Object updateFromHandlerObj,
public void testOnCommandFromHandler(String preGainOffset, String gain, Object updateFromHandlerObj,
Object expectedUpdateTowardsItemObj) {
// UNDEF is not a command, cannot be sent by handler
assumeTrue(updateFromHandlerObj != UnDefType.UNDEF);
testOnUpdateFromHandlerGeneric(rawOffset, gain, updateFromHandlerObj, expectedUpdateTowardsItemObj, false);
testOnUpdateFromHandlerGeneric(preGainOffset, gain, updateFromHandlerObj, expectedUpdateTowardsItemObj, false);
}
/**
*
* Test profile behaviour when handler updates the state
*
* @param rawOffset profile raw offset
* @param preGainOffset profile pre-gain-offset offset
* @param gain profile gain
* @param updateFromHandlerObj state update from handler. String representing QuantityType or State/Command
* @param expectedUpdateTowardsItemObj expected state/command update towards item. String representing QuantityType
@ -130,10 +130,10 @@ public class ModbusGainOffsetProfileTest {
* @param stateUpdateFromHandler whether there is state update from handler. Otherwise command
*/
@SuppressWarnings("rawtypes")
private void testOnUpdateFromHandlerGeneric(String rawOffset, String gain, Object updateFromHandlerObj,
private void testOnUpdateFromHandlerGeneric(String preGainOffset, String gain, Object updateFromHandlerObj,
Object expectedUpdateTowardsItemObj, boolean stateUpdateFromHandler) {
ProfileCallback callback = mock(ProfileCallback.class);
ModbusGainOffsetProfile profile = createProfile(callback, gain, rawOffset);
ModbusGainOffsetProfile profile = createProfile(callback, gain, preGainOffset);
final Type actualStateUpdateTowardsItem;
if (stateUpdateFromHandler) {
@ -213,7 +213,7 @@ public class ModbusGainOffsetProfileTest {
*
* Test profile behaviour when item receives command
*
* @param rawOffset profile raw offset
* @param preGainOffset profile pre-gain-offset
* @param gain profile gain
* @param expectedCommandTowardsHandlerObj expected command towards handler. String representing QuantityType or
* Command. Use null to verify that no commands are sent to handler.
@ -222,11 +222,11 @@ public class ModbusGainOffsetProfileTest {
@SuppressWarnings({ "rawtypes" })
@ParameterizedTest
@MethodSource({ "provideArgsForBoth", "provideAdditionalArgsForCommandFromItem" })
public void testOnCommandFromItem(String rawOffset, String gain, @Nullable Object expectedCommandTowardsHandlerObj,
Object commandFromItemObj) {
public void testOnCommandFromItem(String preGainOffset, String gain,
@Nullable Object expectedCommandTowardsHandlerObj, Object commandFromItemObj) {
assumeFalse(commandFromItemObj.equals(UnDefType.UNDEF));
ProfileCallback callback = mock(ProfileCallback.class);
ModbusGainOffsetProfile profile = createProfile(callback, gain, rawOffset);
ModbusGainOffsetProfile profile = createProfile(callback, gain, preGainOffset);
Command commandFromItem = (commandFromItemObj instanceof String) ? new QuantityType((String) commandFromItemObj)
: (Command) commandFromItemObj;
@ -264,7 +264,7 @@ public class ModbusGainOffsetProfileTest {
@Test
public void testInvalidInit() {
// offset must be dimensionless
// preGainOffset must be dimensionless
ProfileCallback callback = mock(ProfileCallback.class);
ModbusGainOffsetProfile<?> profile = createProfile(callback, "1.0", "0.0 K");
assertFalse(profile.isValid());
@ -283,9 +283,9 @@ public class ModbusGainOffsetProfileTest {
@ParameterizedTest
@NullSource
@EmptySource
public void testInitOffsetDefault(String offset) {
public void testInitOffsetDefault(String preGainOffset) {
ProfileCallback callback = mock(ProfileCallback.class);
ModbusGainOffsetProfile<?> p = createProfile(callback, "1", offset);
ModbusGainOffsetProfile<?> p = createProfile(callback, "1", preGainOffset);
assertTrue(p.isValid());
assertEquals(p.getPregainOffset(), Optional.of(QuantityType.ZERO));
}