git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.fineoffsetweatherstation.internal.domain;
  14
  15 import static javax.measure.MetricPrefix.HECTO;
  16 import static javax.measure.MetricPrefix.KILO;
  17 import static javax.measure.MetricPrefix.MILLI;
  18 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_CO2;
  19 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_HUMIDITY;
  20 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_ILLUMINATION;
  21 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_LIGHTNING_COUNTER;
  22 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_LIGHTNING_DISTANCE;
  23 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_LIGHTNING_TIME;
  24 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_PM10;
  25 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_PM25;
  26 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_PRESSURE;
  27 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_RAIN;
  28 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_RAIN_RATE;
  29 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_TEMPERATURE;
  30 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_UV_RADIATION;
  31 import static org.openhab.binding.fineoffsetweatherstation.internal.FineOffsetWeatherStationBindingConstants.CHANNEL_TYPE_WATER_LEAK_DETECTION;
  32 import static org.openhab.binding.fineoffsetweatherstation.internal.Utils.toInt16;
  33 import static org.openhab.binding.fineoffsetweatherstation.internal.Utils.toUInt16;
  34 import static org.openhab.binding.fineoffsetweatherstation.internal.Utils.toUInt32;
  35 import static org.openhab.binding.fineoffsetweatherstation.internal.Utils.toUInt8;
  36 import static org.openhab.core.library.unit.SIUnits.CELSIUS;
  37 import static org.openhab.core.library.unit.SIUnits.METRE;
  38 import static org.openhab.core.library.unit.SIUnits.PASCAL;
  39 import static org.openhab.core.library.unit.SIUnits.SQUARE_METRE;
  40 import static org.openhab.core.library.unit.Units.DEGREE_ANGLE;
  41 import static org.openhab.core.library.unit.Units.METRE_PER_SECOND;
  42 import static org.openhab.core.library.unit.Units.MICROGRAM_PER_CUBICMETRE;
  43 import static org.openhab.core.library.unit.Units.MILLIMETRE_PER_HOUR;
  44 import static org.openhab.core.library.unit.Units.PARTS_PER_MILLION;
  45 import static org.openhab.core.library.unit.Units.PERCENT;
  46
  47 import java.time.Instant;
  48 import java.time.ZonedDateTime;
  49 import java.util.function.BiFunction;
  50
  51 import javax.measure.Unit;
  52
  53 import org.eclipse.jdt.annotation.NonNullByDefault;
  54 import org.eclipse.jdt.annotation.Nullable;
  55 import org.openhab.binding.fineoffsetweatherstation.internal.Utils;
  56 import org.openhab.core.library.types.DateTimeType;
  57 import org.openhab.core.library.types.DecimalType;
  58 import org.openhab.core.library.types.OnOffType;
  59 import org.openhab.core.library.types.QuantityType;
  60 import org.openhab.core.library.unit.Units;
  61 import org.openhab.core.thing.type.ChannelTypeUID;
  62 import org.openhab.core.types.State;
  63
  64 /**
  65  * Represents the measured type with conversion from the sensors' bytes to the openHAB state.
  66  *
  67  * @author Andreas Berger - Initial contribution
  68  */
  69 @NonNullByDefault
  70 public enum MeasureType {
  71
  72     TEMPERATURE(CELSIUS, 2, CHANNEL_TYPE_TEMPERATURE, (data, offset) -> toInt16(data, offset) / 10.),
  73
  74     PERCENTAGE(PERCENT, 1, CHANNEL_TYPE_HUMIDITY, (data, offset) -> toUInt8(data[offset])),
  75
  76     PRESSURE(HECTO(PASCAL), 2, CHANNEL_TYPE_PRESSURE, (data, offset) -> toUInt16(data, offset) / 10.),
  77
  78     DEGREE(DEGREE_ANGLE, 2, null, Utils::toUInt16),
  79
  80     SPEED(METRE_PER_SECOND, 2, null, (data, offset) -> toUInt16(data, offset) / 10.),
  81
  82     HEIGHT(MILLI(METRE), 2, CHANNEL_TYPE_RAIN, (data, offset) -> toUInt16(data, offset) / 10.),
  83
  84     HEIGHT_BIG(MILLI(METRE), 4, CHANNEL_TYPE_RAIN, (data, offset) -> toUInt32(data, offset) / 10.),
  85
  86     HEIGHT_PER_HOUR(MILLIMETRE_PER_HOUR, 2, CHANNEL_TYPE_RAIN_RATE, (data, offset) -> toUInt16(data, offset) / 10.),
  87
  88     HEIGHT_PER_HOUR_BIG(MILLIMETRE_PER_HOUR, 4, CHANNEL_TYPE_RAIN_RATE, (data, offset) -> toUInt32(data, offset) / 10.),
  89
  90     LUX(Units.LUX, 4, CHANNEL_TYPE_ILLUMINATION, (data, offset) -> toUInt32(data, offset) / 10.),
  91
  92     PM25(MICROGRAM_PER_CUBICMETRE, 2, CHANNEL_TYPE_PM25, (data, offset) -> toUInt16(data, offset) / 10.),
  93
  94     PM10(MICROGRAM_PER_CUBICMETRE, 2, CHANNEL_TYPE_PM10, (data, offset) -> toUInt16(data, offset) / 10.),
  95
  96     CO2(PARTS_PER_MILLION, 2, CHANNEL_TYPE_CO2, Utils::toUInt16),
  97
  98     WATER_LEAK_DETECTION(1, CHANNEL_TYPE_WATER_LEAK_DETECTION,
  99             (data, offset, context) -> toUInt8(data[offset]) != 0 ? OnOffType.ON : OnOffType.OFF),
 100
 101     LIGHTNING_DISTANCE(KILO(METRE), 1, CHANNEL_TYPE_LIGHTNING_DISTANCE, (data, offset) -> toUInt8(data[offset])),
 102
 103     LIGHTNING_COUNTER(4, CHANNEL_TYPE_LIGHTNING_COUNTER,
 104             (data, offset, context) -> new DecimalType(toUInt32(data, offset))),
 105
 106     LIGHTNING_TIME(4, CHANNEL_TYPE_LIGHTNING_TIME,
 107             (data, offset, context) -> new DateTimeType(
 108                     ZonedDateTime.ofInstant(Instant.ofEpochSecond(toUInt32(data, offset)), context.getZoneId()))),
 109
 110     MILLIWATT_PER_SQUARE_METRE(MILLI(Units.WATT).divide(SQUARE_METRE), 2, CHANNEL_TYPE_UV_RADIATION,
 111             (data, offset) -> Utils.toUInt16(data, offset) / 10.),
 112
 113     BYTE(1, null, (data, offset, context) -> new DecimalType(toUInt8(data[offset]))),
 114
 115     DATE_TIME2(6, null, (data, offset, context) -> new DateTimeType(
 116             ZonedDateTime.ofInstant(Instant.ofEpochSecond(toUInt32(data, offset)), context.getZoneId())));
 117
 118     private final int byteSize;
 119     private final @Nullable ChannelTypeUID channelTypeUID;
 120     private final StateConverter stateConverter;
 121
 122     /**
 123      * @param unit the unit
 124      * @param byteSize the size in the sensors' payload
 125      * @param channelTypeUID the channel type
 126      * @param valueExtractor a function to extract the sensor data into a number of the dimension defined by the unit
 127      */
 128     MeasureType(Unit<?> unit, int byteSize, @Nullable ChannelTypeUID channelTypeUID,
 129             BiFunction<byte[], Integer, @Nullable Number> valueExtractor) {
 130         this(byteSize, channelTypeUID, (bytes, offset, context) -> {
 131             Number value = valueExtractor.apply(bytes, offset);
 132             return value == null ? null : new QuantityType<>(value, unit);
 133         });
 134     }
 135
 136     /**
 137      * @param byteSize the size in the sensors' payload
 138      * @param channelTypeUID the channel type
 139      * @param stateConverter a function to extract the sensor data into the openHAB's state
 140      */
 141     MeasureType(int byteSize, @Nullable ChannelTypeUID channelTypeUID, StateConverter stateConverter) {
 142         this.byteSize = byteSize;
 143         this.channelTypeUID = channelTypeUID;
 144         this.stateConverter = stateConverter;
 145     }
 146
 147     public int getByteSize() {
 148         return byteSize;
 149     }
 150
 151     public @Nullable ChannelTypeUID getChannelTypeId() {
 152         return channelTypeUID;
 153     }
 154
 155     public @Nullable State toState(byte[] data, int offset, ConversionContext context) {
 156         return stateConverter.toState(data, offset, context);
 157     }
 158
 159     private interface StateConverter {
 160         @Nullable
 161         State toState(byte[] data, int offset, ConversionContext context);
 162     }
 163 }