```javascript
const item = items.getItem("KitchenLight");
-//send a ON command
+//send an ON command
item.sendCommand("ON");
//Post an update
item.postUpdate("OFF");
private @Nullable AirQualityBridgeHandler bridgeHandler;
/**
- * Creates a AirQualityDiscoveryService with enabled autostart.
+ * Creates an AirQualityDiscoveryService with enabled autostart.
*/
public AirQualityDiscoveryService() {
super(SUPPORTED_THING_TYPES_UIDS, DISCOVER_TIMEOUT_SECONDS, false);
The url <YOUR_OPENHAB>/amazonechocontrol/<YOUR_ACCOUNT>/PROXY/<API_URL> provides a proxy server with an authenticated connection to the amazon alexa server. This can be used to call alexa api from rules.
-E.g. to read out the history call from an installation on openhab:8080 with a account named account1:
+E.g. to read out the history call from an installation on openhab:8080 with an account named account1:
http://openhab:8080/amazonechocontrol/account1/PROXY/api/activities?startTime=&size=50&offset=1
package org.openhab.binding.autelis.internal.config;
/**
- * Configuration properties for connecting to a Autelis Controller
+ * Configuration properties for connecting to an Autelis Controller
*
* @author Dan Cunningham - Initial contribution
*
private final Logger logger = LoggerFactory.getLogger(AutelisHandler.class);
/**
- * Default timeout for http connections to a Autelis controller
+ * Default timeout for http connections to an Autelis controller
*/
static final int TIMEOUT_SECONDS = 5;
} else if (command instanceof DecimalType) {
value = ((DecimalType) command).intValue();
if (!isJandy() && value >= 3) {
- // this is a autelis dim type. not sure what 2 does
+ // this is an autelis dim type. not sure what 2 does
cmd = "dim";
}
} else {
}
/**
- * Simple logic to perform a authenticated GET request
+ * Simple logic to perform an authenticated GET request
*
* @param url
* @param timeout
# binding
binding.autelis.name = Autelis Pool Control Binding
-binding.autelis.description = This is the binding for a Autelis pool controller.
+binding.autelis.description = This is the binding for an Autelis pool controller.
# thing types
thing-type.autelis.jandy.label = Jandy Pool Controller
-thing-type.autelis.jandy.description = A Jandy pool control thing represents a Autelis pool controller for Jandy systems
+thing-type.autelis.jandy.description = A Jandy pool control thing represents an Autelis pool controller for Jandy systems
thing-type.autelis.jandy.channel.equipment-aux1.label = Auxiliary 1
thing-type.autelis.jandy.channel.equipment-aux1.description = The current state of auxiliary 1
thing-type.autelis.jandy.channel.equipment-aux2.label = Auxiliary 2
thing-type.config.autelis.jandy.host.label = Host or IP
thing-type.config.autelis.jandy.host.description = The host name or IP address of the Autelis Controller.
thing-type.config.autelis.jandy.password.label = Password
-thing-type.config.autelis.jandy.password.description = The password to use when connecting to a Autelis Controller.
+thing-type.config.autelis.jandy.password.description = The password to use when connecting to an Autelis Controller.
thing-type.config.autelis.jandy.port.label = Port
thing-type.config.autelis.jandy.port.description = The port the Autelis Controller is listening on.
thing-type.config.autelis.jandy.refresh.label = Refresh Interval
thing-type.config.autelis.jandy.refresh.description = Specifies the refresh interval in seconds
thing-type.config.autelis.jandy.user.label = User Name
-thing-type.config.autelis.jandy.user.description = The user name to use when connecting to a Autelis Controller.
+thing-type.config.autelis.jandy.user.description = The user name to use when connecting to an Autelis Controller.
thing-type.config.autelis.pentair.host.label = Host or IP
thing-type.config.autelis.pentair.host.description = The host name or IP address of the Autelis Controller.
thing-type.config.autelis.pentair.password.label = Password
-thing-type.config.autelis.pentair.password.description = The password to use when connecting to a Autelis Controller.
+thing-type.config.autelis.pentair.password.description = The password to use when connecting to an Autelis Controller.
thing-type.config.autelis.pentair.port.label = Port
thing-type.config.autelis.pentair.port.description = The port the Autelis Controller is listening on.
thing-type.config.autelis.pentair.refresh.label = Refresh Interval
thing-type.config.autelis.pentair.refresh.description = Specifies the refresh interval in seconds
thing-type.config.autelis.pentair.user.label = User Name
-thing-type.config.autelis.pentair.user.description = The user name to use when connecting to a Autelis Controller.
+thing-type.config.autelis.pentair.user.description = The user name to use when connecting to an Autelis Controller.
# channel types
channel-type.autelis.equipment-ht.state.option.1 = Enabled
channel-type.autelis.equipment-ht.state.option.2 = On
channel-type.autelis.equipment-switch.label = Equipment Switch
-channel-type.autelis.equipment-switch.description = The current state of a equipment switch
+channel-type.autelis.equipment-switch.description = The current state of an equipment switch
channel-type.autelis.lightscmd.label = Lighting Cmd
channel-type.autelis.lightscmd.description = Send A lighting command
channel-type.autelis.lightscmd.state.option.alloff = All Off
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="jandy">
<label>Jandy Pool Controller</label>
- <description>A Jandy pool control thing represents a Autelis pool controller for Jandy systems</description>
+ <description>A Jandy pool control thing represents an Autelis pool controller for Jandy systems</description>
<channels>
<channel id="system-runstate" typeId="system-runstate"/>
<channel id="system-model" typeId="system-model"/>
</parameter>
<parameter name="user" type="text" required="true">
<label>User Name</label>
- <description>The user name to use when connecting to a Autelis Controller.</description>
+ <description>The user name to use when connecting to an Autelis Controller.</description>
</parameter>
<parameter name="password" type="text" required="true">
<label>Password</label>
- <description>The password to use when connecting to a Autelis Controller.</description>
+ <description>The password to use when connecting to an Autelis Controller.</description>
</parameter>
<parameter name="refresh" type="integer" required="false">
<label>Refresh Interval</label>
<channel-type id="equipment-switch">
<item-type>Switch</item-type>
<label>Equipment Switch</label>
- <description>The current state of a equipment switch</description>
+ <description>The current state of an equipment switch</description>
</channel-type>
<channel-type id="equipment-ht">
<item-type>Number</item-type>
</parameter>
<parameter name="user" type="text" required="true">
<label>User Name</label>
- <description>The user name to use when connecting to a Autelis Controller.</description>
+ <description>The user name to use when connecting to an Autelis Controller.</description>
</parameter>
<parameter name="password" type="text" required="true">
<label>Password</label>
- <description>The password to use when connecting to a Autelis Controller.</description>
+ <description>The password to use when connecting to an Autelis Controller.</description>
</parameter>
<parameter name="refresh" type="integer" required="false">
<label>Refresh Interval</label>
</supported-bridge-type-refs>
<label>AM43 Blind Drive Motor</label>
- <description>A AM43 Blind Drive Motor</description>
+ <description>An AM43 Blind Drive Motor</description>
<category>Blinds</category>
<channels>
cancelScheduledPassiveScan();
bgEndProcedure();
- // Start a active scan
+ // Start an active scan
bgStartScanning(true, configuration.activeScanInterval, configuration.activeScanWindow);
}
/**
* Class to implement the BlueGiga command <b>indicateConfirm</b>.
* <p>
- * This command can be used to send a acknowledge a received indication from a remote device.
+ * This command can be used to send an acknowledge a received indication from a remote device.
* This function allows the application to manually confirm the indicated values instead of
* the smart stack Bluetooth automatically doing it. The benefit of this is extra reliability
* since the application can for example store the received value on the flash memory before
/**
* Class to implement the BlueGiga command <b>procedureCompletedEvent</b>.
* <p>
- * This event is produced at the GATT client when an attribute protocol event is completed a and
+ * This event is produced at the GATT client when an attribute protocol event is completed and a
* new operation can be issued
* <p>
* This class provides methods for processing BlueGiga API commands.
* This command is used by the GATT server to acknowledge to the remote device that the
* attribute's value was written. This feature again allows the user application to
* acknowledged the attribute write operations instead of the Smart stack doing it
- * automatically. Bluetooth The command should be used when a event is received where the
+ * automatically. Bluetooth The command should be used when an event is received where the
* reason why value has changed Value corresponds to
* attributes_attribute_change_reason_write_request_user. This response must be sent
* within 30 seconds or otherwise a timeout will occur.
* This command is used by the GATT server to acknowledge to the remote device that the
* attribute's value was written. This feature again allows the user application to
* acknowledged the attribute write operations instead of the Smart stack doing it
- * automatically. Bluetooth The command should be used when a event is received where the
+ * automatically. Bluetooth The command should be used when an event is received where the
* reason why value has changed Value corresponds to
* attributes_attribute_change_reason_write_request_user. This response must be sent
* within 30 seconds or otherwise a timeout will occur.
/**
* Class to implement the BlueGiga command <b>getStatus</b>.
* <p>
- * This command returns the status of the given connection. Status is returned in a event.
+ * This command returns the status of the given connection. Status is returned in an event.
* <p>
* This class provides methods for processing BlueGiga API commands.
* <p>
/**
* Class to implement the BlueGiga command <b>getStatus</b>.
* <p>
- * This command returns the status of the given connection. Status is returned in a event.
+ * This command returns the status of the given connection. Status is returned in an event.
* <p>
* This class provides methods for processing BlueGiga API commands.
* <p>
* connectable advertisement packets Bluetooth from the remote device which matches the
* Bluetooth address gives as a parameter. Upon receiving the advertisement packet, the
* module will send a connection request packet to the target device to imitate a Bluetooth
- * connection. A successful connection will bi indicated by a event. Status If the device is
+ * connection. A successful connection will be indicated by an event. Status If the device is
* configured to support more than one connection, the smallest connection interval which is
* divisible by maximum_connections * 2.5ms will be selected. Thus, it is important to provide
* minimum and maximum connection intervals so that such a connection interval is available
* connectable advertisement packets Bluetooth from the remote device which matches the
* Bluetooth address gives as a parameter. Upon receiving the advertisement packet, the
* module will send a connection request packet to the target device to imitate a Bluetooth
- * connection. A successful connection will bi indicated by a event. Status If the device is
+ * connection. A successful connection will be indicated by an event. Status If the device is
* configured to support more than one connection, the smallest connection interval which is
* divisible by maximum_connections * 2.5ms will be selected. Thus, it is important to provide
* minimum and maximum connection intervals so that such a connection interval is available
* Adds a ContentItem to the PresetContainer
*
* @param id the id the ContentItem should be reached
- * @param contentItem the contentItem that should be saved as PRESET. Note that a eventually set presetID of the
+ * @param contentItem the contentItem that should be saved as PRESET. Note that an eventually set presetID of the
* ContentItem will be overwritten with id
*/
public void addContentItemToPresetContainer(int id, ContentItem contentItem) {
}
/**
- * Adds a ContentItem as Preset, with presetID. Note that a eventually existing id in preset will be overwritten by
+ * Adds a ContentItem as Preset, with presetID. Note that an eventually existing id in preset will be overwritten by
* presetID
*
* @param presetID
@NonNullByDefault
public interface ComfoAirDataType {
/**
- * Generate a openHAB State object based on response data.
+ * Generate an openHAB State object based on response data.
*
* @param response
* @param commandType
State convertToState(int[] response, ComfoAirCommandType commandType);
/**
- * Generate byte array based on a openHAB State.
+ * Generate byte array based on an openHAB State.
*
* @param value
* @param commandType
## Thing Configuration
-- `controller` is a openHAB "bridge", and represents a single CoolMasterNet device. A single controller supports one or more HVAC units.
+- `controller` is an openHAB "bridge", and represents a single CoolMasterNet device. A single controller supports one or more HVAC units.
- `hvac` is an HVAC device connected to a controller. Each `hvac` thing is identified by a CoolMasterNet UID (refer to CoolMasterNet controller documentation).
Example demo.things configuration for two HVAC devices connected to a CoolMasterNet device found at IP 192.168.0.100:
| Channel Type ID | Item Type | Access Mode | Description | Thing types |
|-------------------|--------------------------|:-----------:|---------------------------------------|-------------------------------------------------|
| brightness | Dimmer | R/W | Brightness of the light | `dimmablelight`, `colortemperaturelight` |
-| switch | Switch | R/W | State of a ON/OFF device | `onofflight` |
+| switch | Switch | R/W | State of an ON/OFF device | `onofflight` |
| color | Color | R/W | Color of an multi-color light | `colorlight`, `extendedcolorlight`, `lightgroup`|
| color_temperature | Number | R/W | Color temperature in Kelvin. The value range is determined by each individual light | `colortemperaturelight`, `extendedcolorlight`, `lightgroup` |
| effect | String | R/W | Effect selection. Allowed commands are set dynamically | `colorlight` |
thing-type.deconz.onofflight.label = On/Off Light
thing-type.deconz.onofflight.description = A light that can be turned on or off.
thing-type.deconz.openclosesensor.label = Open/Close Sensor
-thing-type.deconz.openclosesensor.description = A open/close sensor
+thing-type.deconz.openclosesensor.description = An open/close sensor
thing-type.deconz.powersensor.label = Power Sensor
thing-type.deconz.powersensor.description = A power sensor
thing-type.deconz.presencesensor.label = Presence Sensor
<bridge-type-ref id="deconz"/>
</supported-bridge-type-refs>
<label>Open/Close Sensor</label>
- <description>A open/close sensor</description>
+ <description>An open/close sensor</description>
<channels>
<channel typeId="open" id="open"/>
<channel typeId="last_updated" id="last_updated"/>
*
* @param config the {@link Configuration} to be checked
* @param bridge the responsible {@link BridgeHandler}
- * @return zoneID the existing dS zoneID or a error constant
+ * @return zoneID the existing dS zoneID or an error constant
*/
public static int getZoneID(Configuration config, BridgeHandler bridge) {
if (config == null || config.get(DigitalSTROMBindingConstants.ZONE_ID) == null) {
* Removes a subscribed event and unsubscibe it, if it is not needed by other {@link EventHandler}'s.
*
* @param unsubscribeEvent event name to unsubscibe
- * @param eventHandlerID EventHandler-ID of the EventHandler that unsubscibe a event
+ * @param eventHandlerID EventHandler-ID of the EventHandler that unsubscibe an event
*/
public void removeSubscribe(String unsubscribeEvent, String eventHandlerID) {
if (subscribedEvents != null && !subscribedEvents.contains(unsubscribeEvent)) {
import org.openhab.binding.digitalstrom.internal.lib.event.constants.EventResponseEnum;
/**
- * The {@link EventItem} represents a event item of an digitalSTROM-Event.
+ * The {@link EventItem} represents an event item of an digitalSTROM-Event.
*
* @author Alexander Betker
* @author Michael Ochel - add getSource()
}
}
if (deviceDiscovery != null) {
- // only informs discovery, if the device is a output or a sensor device
+ // only informs discovery, if the device is an output or a sensor device
deviceDiscovery.onDeviceAdded(currentDevice);
logger.debug("inform DeviceStatusListener: {} about added device with dSID {}",
DeviceStatusListener.DEVICE_DISCOVERY, currentDevice.getDSID().getValue());
private static final List<String> SUPPORTED_OUTPUT_CHANNEL_TYPES = new ArrayList<>();
/**
- * Returns true, if the given channel type id is a output channel.
+ * Returns true, if the given channel type id is an output channel.
*
* @param channelTypeID to check
* @return true, if channel type id is output channel
SystemBellTrouble("806", "System Bell Trouble",
"806: An open circuit has been detected across the bell terminals."),
SystemBellTroubleRestore("807", "System Bell Trouble Restore", "807: The bell trouble has been restored."),
- TLMLine1Trouble("810", "TML Line 1 Trouble", "810: The phone line is a open or shorted condition."),
+ TLMLine1Trouble("810", "TML Line 1 Trouble", "810: The phone line is an open or shorted condition."),
TLMLine1TroubleRestore("811", "TML Line 1 Trouble Restore",
"811: The phone line trouble condition has been restored."),
- TLMLine2Trouble("812", "TML Line 2 Trouble", "812: The phone line is a open or shorted condition."),
+ TLMLine2Trouble("812", "TML Line 2 Trouble", "812: The phone line is an open or shorted condition."),
TLMLine2TroubleRestore("813", "TML Line 2 Trouble Restore",
"813: The phone line trouble condition has been restored."),
FTCTrouble("814", "FTC Trouble",
new CosemString("val1"), // Specification is not clear what this value is
new CosemDecimal("val2"), // Specification is not clear what this value is
new CosemDecimal("val3"), // Specification is not clear what this value is
- new CosemString("obisId"), // String containing a OBIS Identifier
+ new CosemString("obisId"), // String containing an OBIS Identifier
new CosemString("unit"), // String containing the type (m3)
CosemDecimal.INSTANCE),
GMETER_VALVE_POSITION_V2_1(new OBISIdentifier(7, 96, 3, 10), CosemDecimal.INSTANCE),
## Thing Configuration
-The thing has a one configuration parameter:
+The thing has one configuration parameter:
| Parameter | Description |
|-----------|------------------------------------------------------------------------- |
/*
* Setting the needed boolean variable to false, so we can be sure
- * that the XML response won't have a OK_200 status
+ * that the XML response won't have an OK_200 status
*/
ChannelUID modeChannelUID = getChannelUID(radioThing, modeChannelID);
Item modeTestItem = initializeItem(modeChannelUID, CHANNEL_MODE, acceptedItemType);
}
/**
- * Converts a Gardena property value to a openHAB state.
+ * Converts a Gardena property value to an openHAB state.
*/
private @Nullable State convertToState(Device device, ChannelUID channelUID) throws GardenaException {
if (isLocalDurationCommand(channelUID)) {
/**
* The {@link HaasSohnpelletstoveJsonDataDTO} is the Java class used to map the JSON
- * response to a Oven request.
+ * response to an Oven request.
*
* @author Christian Feininger - Initial contribution
*/
/**
* The {@link HomeConnectOvenHandler} is responsible for handling commands, which are
- * sent to one of the channels of a oven.
+ * sent to one of the channels of an oven.
*
* @author Jonas Brüstel - Initial contribution
*/
import org.openhab.binding.homematic.internal.model.HmParamsetType;
/**
- * Parses a event received from a Homematic gateway.
+ * Parses an event received from a Homematic gateway.
*
* @author Gerhard Riegler - Initial contribution
*/
}
/**
- * Listening for events and starts the callbackHandler if a event received.
+ * Listening for events and starts the callbackHandler if an event received.
*/
@Override
public void run() {
import org.openhab.binding.homematic.internal.model.HmDatapointInfo;
/**
- * Methods called by the RpcServer when a event is received.
+ * Methods called by the RpcServer when an event is received.
*
* @author Gerhard Riegler - Initial contribution
*/
public boolean canHandleEvent(HmDatapoint dp);
/**
- * Handles a event to extract data required for the virtual datapoint.
+ * Handles an event to extract data required for the virtual datapoint.
*/
public void handleEvent(VirtualGateway gateway, HmDatapoint dp);
private static Map<String, TypeConverter<?>> converterCache = new HashMap<>();
/**
- * Returns the converter for a itemType.
+ * Returns the converter for an itemType.
*/
public static TypeConverter<?> createConverter(String itemType) throws ConverterException {
Class<? extends TypeConverter<?>> converterClass = null;
public interface TypeConverter<T extends State> {
/**
- * Converts a openHAB type to a Homematic value.
+ * Converts an openHAB type to a Homematic value.
*/
public Object convertToBinding(Type type, HmDatapoint dp) throws ConverterException;
/**
- * Converts a Homematic value to a openHAB type.
+ * Converts a Homematic value to an openHAB type.
*/
public T convertFromBinding(HmDatapoint dp) throws ConverterException;
}
}
/**
- * Converts a openHAB command to a Homematic value.
+ * Converts an openHAB command to a Homematic value.
*/
protected Object commandToBinding(Command command, HmDatapoint dp) throws ConverterException {
throw new ConverterException("Unsupported command " + command.getClass().getSimpleName() + " for "
protected abstract boolean fromBindingValidation(HmDatapoint dp);
/**
- * Converts the datapoint value to a openHAB type.
+ * Converts the datapoint value to an openHAB type.
*/
protected abstract T fromBinding(HmDatapoint dp) throws ConverterException;
import org.openhab.core.types.Type;
/**
- * Converts between a Homematic datapoint value and a openHAB DecimalType.
+ * Converts between a Homematic datapoint value and an openHAB DecimalType.
*
* @author Gerhard Riegler - Initial contribution
*/
import org.openhab.core.types.Type;
/**
- * Converts between a Homematic datapoint value and a openHAB OnOffType.
+ * Converts between a Homematic datapoint value and an openHAB OnOffType.
*
* @author Gerhard Riegler - Initial contribution
*/
import org.openhab.core.types.Type;
/**
- * Converts between a Homematic datapoint value and a openHAB OpenClosedType.
+ * Converts between a Homematic datapoint value and an openHAB OpenClosedType.
*
* @author Gerhard Riegler - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * Converts between a Homematic datapoint value and a openHAB PercentType.
+ * Converts between a Homematic datapoint value and an openHAB PercentType.
*
* @author Gerhard Riegler - Initial contribution
*/
import org.openhab.core.types.Type;
/**
- * Converts between a Homematic datapoint value and a openHAB StringType.
+ * Converts between a Homematic datapoint value and an openHAB StringType.
*
* @author Gerhard Riegler - Initial contribution
*/
private static final Logger logger = LoggerFactory.getLogger(MiscUtils.class);
/**
- * Replaces invalid characters of the text to fit into a openHAB UID.
+ * Replaces invalid characters of the text to fit into an openHAB UID.
*/
public static String validateCharacters(String text, String textType, String replaceChar) {
if (text == null) {
}
/**
- * Returns the index of the value in a option list.
+ * Returns the index of the value in an option list.
*/
public int getOptionIndex(String option) {
if (options != null && option != null) {
}
/**
- * Returns the value of a option list.
+ * Returns the value of an option list.
*/
public @Nullable String getOptionValue() {
Integer idx = getIntegerValue();
### Account Thing
-| Configuration Name | type | required | Comments |
-|--------------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------|
-| userName | String | False | The Hydrawise account user name |
-| password | String | False | The Hydrawise account password |
-| savePassword | Boolean | False | By default the password will be not be persisted after the first login attempt unless this is true, defaults to false |
-| refresh | Integer | False | Defaults to a 60 second polling rate, more frequent polling may cause the service to deny requests |
-| refreshToken | Boolean | False | A oAuth refresh token, this will be automatically configured after the first login and updated as the token is refreshed |
+| Configuration Name | type | required | Comments |
+|--------------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------|
+| userName | String | False | The Hydrawise account user name |
+| password | String | False | The Hydrawise account password |
+| savePassword | Boolean | False | By default the password will be not be persisted after the first login attempt unless this is true, defaults to false |
+| refresh | Integer | False | Defaults to a 60 second polling rate, more frequent polling may cause the service to deny requests |
+| refreshToken | Boolean | False | An oAuth refresh token, this will be automatically configured after the first login and updated as the token is refreshed |
### Controller Thing
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Thrown when command responses return a error message
+ * Thrown when command responses return an error message
*
* @author Dan Cunningham - Initial contribution
*/
/**
* Publish the state. In the case of PercentType, if the value is
- * 0, send a OnOffType.OFF and if the value is 100, send a OnOffType.ON.
+ * 0, send an OnOffType.OFF and if the value is 100, send an OnOffType.ON.
* That way an openHAB Switch will work properly with a Insteon dimmer,
* as long it is used like a switch (On/Off). An openHAB DimmerItem will
* internally convert the ON back to 100% and OFF back to 0, so there is
}
}
return null;
- case DATA_TYPE_ERROR_LIST: /* Check whether the type is a errorList */
+ case DATA_TYPE_ERROR_LIST: /* Check whether the type is an errorList */
KM200ErrorServiceHandler eService = null;
logger.trace("state of type errorList: {}", nodeRoot);
if (null != parent) {
import com.google.gson.JsonObject;
/**
- * The KM200ErrorService representing a error service with its all capabilities
+ * The KM200ErrorService representing an error service with its all capabilities
*
* @author Markus Eckhardt - Initial contribution
*/
serviceObject.setJSONData(dataObject);
remoteDevice.virtualList.add(serviceObject);
break;
- case DATA_TYPE_ERROR_LIST: /* Check whether the type is a errorList */
+ case DATA_TYPE_ERROR_LIST: /* Check whether the type is an errorList */
logger.trace("initDevice: type errorList: {}", dataObject);
KM200ErrorServiceHandler eService = new KM200ErrorServiceHandler();
eService.updateErrors(nodeRoot);
* This class provides type mapping between all openHAB core types and KNX data point types.
*
* Each 'MainType' delivered from calimero, has a default mapping
- * for all it's children to a openHAB Typeclass.
+ * for all it's children to an openHAB Typeclass.
* All these 'MainType' mapping's are put into 'dptMainTypeMap'.
*
* Default 'MainType' mapping's we can override by a specific mapping.
import org.eclipse.jdt.annotation.Nullable;
/**
- * Configuration settings for an {@link org.openhab.binding.lutron.internal.handler.BlindHandler}.
+ * Configuration settings for a {@link org.openhab.binding.lutron.internal.handler.BlindHandler}.
*
* @author Bob Adair - Initial contribution
*/
import org.eclipse.jdt.annotation.Nullable;
/**
- * Configuration settings for an {@link org.openhab.binding.lutron.internal.handler.LeapBridgeHandler}.
+ * Configuration settings for a {@link org.openhab.binding.lutron.internal.handler.LeapBridgeHandler}.
*
* @author Bob Adair - Initial contribution
*/
}
/**
- * Deutsche Telekom uses a OAuth-based authentication to access the EPG portal.
+ * Deutsche Telekom uses an OAuth-based authentication to access the EPG portal.
* The binding automates the login incl. OAuth authentication. This class helps mapping the response to a Java
* object (using Gson)
*
* @param colorMode The color mode: HSB, RGB or XYY.
* @param onValue The ON value string. This will be compared to MQTT messages.
* @param offValue The OFF value string. This will be compared to MQTT messages.
- * @param onBrightness When receiving a ON command, the brightness percentage is set to this value
+ * @param onBrightness When receiving an ON command, the brightness percentage is set to this value
*/
public ColorValue(ColorMode colorMode, @Nullable String onValue, @Nullable String offValue, int onBrightness) {
super(CoreItemFactory.COLOR, List.of(OnOffType.class, PercentType.class, StringType.class));
}
/**
- * Final step of the login process to get a oAuth access response token
+ * Final step of the login process to get an oAuth access response token
*
* @param redirectLocation
* @param codeVerifier
<channel-type id="SDMCameraEventImage">
<item-type>Image</item-type>
<label>Image</label>
- <description>Static image based on a event</description>
+ <description>Static image based on an event</description>
<state readOnly="true"/>
<config-description-ref uri="channel-type:nest:sdm_camera_image"/>
</channel-type>
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * A Component in the Nobø Hub can be a oven, a floor or a switch.
+ * A Component in the Nobø Hub can be an oven, a floor or a switch.
*
* @author Jørgen Austvik - Initial contribution
* @author Espen Fossen - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link NetworkOceanicThingHandler} implements {@link OceanicThingHandler} for a Oceanic water softener that is
+ * The {@link NetworkOceanicThingHandler} implements {@link OceanicThingHandler} for an Oceanic water softener that is
* reached using a socat TCP proxy
*
* @author Karel Goderis - Initial contribution
import gnu.io.UnsupportedCommOperationException;
/**
- * The {@link SerialOceanicThingHandler} implements {@link OceanicThingHandler} for a Oceanic water softener that is
+ * The {@link SerialOceanicThingHandler} implements {@link OceanicThingHandler} for an Oceanic water softener that is
* directly connected to a serial port of the openHAB host
*
* @author Karel Goderis - Initial contribution
}
}
}
- logger.info("Found BTicino device: not a OpenWebNet gateway or not supported (UDN={})", idString);
+ logger.info("Found BTicino device: not an OpenWebNet gateway or not supported (UDN={})", idString);
}
return null;
}
}
/**
- * Updates light brightness state based on a OWN Lighting message
+ * Updates light brightness state based on an OWN Lighting message
*
* @param msg the Lighting message received
*/
}
/**
- * Updates light on/off state based on a OWN Lighting event message received
+ * Updates light on/off state based on an OWN Lighting event message received
*
* @param msg the Lighting message received
*/
import org.slf4j.LoggerFactory;
/**
- * The {@link OpenWebNetThingHandler} is responsible for handling commands for a OpenWebNet device.
+ * The {@link OpenWebNetThingHandler} is responsible for handling commands for an OpenWebNet device.
* It's the abstract class for all OpenWebNet things. It should be extended by each specific OpenWebNet category of
* device (WHO).
*
# thing types
thing-type.openwebnet.bus_automation.label = Automation
-thing-type.openwebnet.bus_automation.description = A OpenWebNet BUS/SCS automation device to control roller shutters, blinds, etc. BTicino models: xxx/yyyy/etc.
+thing-type.openwebnet.bus_automation.description = An OpenWebNet BUS/SCS automation device to control roller shutters, blinds, etc. BTicino models: xxx/yyyy/etc.
thing-type.openwebnet.bus_aux.label = Auxiliary
-thing-type.openwebnet.bus_aux.description = A OpenWebNet BUS/SCS Auxiliary command
+thing-type.openwebnet.bus_aux.description = An OpenWebNet BUS/SCS Auxiliary command
thing-type.openwebnet.bus_cen_scenario_control.label = CEN Scenario Control
-thing-type.openwebnet.bus_cen_scenario_control.description = A OpenWebNet BUS/SCS CEN Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680
+thing-type.openwebnet.bus_cen_scenario_control.description = An OpenWebNet BUS/SCS CEN Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680
thing-type.openwebnet.bus_cenplus_scenario_control.label = CEN+ Scenario Control
-thing-type.openwebnet.bus_cenplus_scenario_control.description = A OpenWebNet BUS/SCS CEN+ Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680
+thing-type.openwebnet.bus_cenplus_scenario_control.description = An OpenWebNet BUS/SCS CEN+ Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680
thing-type.openwebnet.bus_dimmer.label = Dimmer
-thing-type.openwebnet.bus_dimmer.description = A OpenWebNet BUS/SCS dimmer for the dimmer control of 1 light. BTicino models: yyyy/zzzz/etc.
+thing-type.openwebnet.bus_dimmer.description = An OpenWebNet BUS/SCS dimmer for the dimmer control of 1 light. BTicino models: yyyy/zzzz/etc.
thing-type.openwebnet.bus_dry_contact_ir.label = Dry Contact/IR Interface
-thing-type.openwebnet.bus_dry_contact_ir.description = A OpenWebNet BUS/SCS Dry Contact Interface or IR Interface. BTicino models: 3477/F428, IR 4610-4611-4640 etc.
+thing-type.openwebnet.bus_dry_contact_ir.description = An OpenWebNet BUS/SCS Dry Contact Interface or IR Interface. BTicino models: 3477/F428, IR 4610-4611-4640 etc.
thing-type.openwebnet.bus_energy_meter.label = Energy Meter
-thing-type.openwebnet.bus_energy_meter.description = A OpenWebNet BUS/SCS Energy Meter. BTicino models: F52x
+thing-type.openwebnet.bus_energy_meter.description = An OpenWebNet BUS/SCS Energy Meter. BTicino models: F52x
thing-type.openwebnet.bus_gateway.label = BUS Gateway
thing-type.openwebnet.bus_gateway.description = This thing allows to connect to a IP BUS/SCS gateway that supports the OpenWebNet protocol (models: F454, MyHOMEServer1, F455, MH200N, F453, etc.)
thing-type.openwebnet.bus_on_off_switch.label = Switch
-thing-type.openwebnet.bus_on_off_switch.description = A OpenWebNet BUS/SCS switch for the control of 1 light/load. BTicino models: xxx/yyyy/etc.
+thing-type.openwebnet.bus_on_off_switch.description = An OpenWebNet BUS/SCS switch for the control of 1 light/load. BTicino models: xxx/yyyy/etc.
thing-type.openwebnet.bus_scenario_control.label = Scenario Control
-thing-type.openwebnet.bus_scenario_control.description = A OpenWebNet BUS/SCS Scenario Control device. BTicino models: F420/IR3456
+thing-type.openwebnet.bus_scenario_control.description = An OpenWebNet BUS/SCS Scenario Control device. BTicino models: F420/IR3456
thing-type.openwebnet.bus_thermo_cu.label = Thermo Central Unit
-thing-type.openwebnet.bus_thermo_cu.description = A OpenWebNet BUS/SCS configured thermo Central Unit.
+thing-type.openwebnet.bus_thermo_cu.description = An OpenWebNet BUS/SCS configured thermo Central Unit.
thing-type.openwebnet.bus_thermo_sensor.label = Thermo Sensor
-thing-type.openwebnet.bus_thermo_sensor.description = A OpenWebNet BUS/SCS thermo sensor (probe) for measuring temperature in a zone. BTicino models: L/N/NT4577 etc.
+thing-type.openwebnet.bus_thermo_sensor.description = An OpenWebNet BUS/SCS thermo sensor (probe) for measuring temperature in a zone. BTicino models: L/N/NT4577 etc.
thing-type.openwebnet.bus_thermo_zone.label = Thermo Zone
-thing-type.openwebnet.bus_thermo_zone.description = A OpenWebNet BUS/SCS configured thermo zone (managed via Central Unit or stand alone).
+thing-type.openwebnet.bus_thermo_zone.description = An OpenWebNet BUS/SCS configured thermo zone (managed via Central Unit or stand alone).
thing-type.openwebnet.generic_device.label = Generic Device
thing-type.openwebnet.generic_device.description = An OpenWebNet Generic Device.
thing-type.openwebnet.zb_automation.label = ZigBee Automation
-thing-type.openwebnet.zb_automation.description = A OpenWebNet ZigBee automation device to control roller shutters, blinds, etc. BTicino models: xxx/yyyy/etc.
+thing-type.openwebnet.zb_automation.description = An OpenWebNet ZigBee automation device to control roller shutters, blinds, etc. BTicino models: xxx/yyyy/etc.
thing-type.openwebnet.zb_dimmer.label = ZigBee Dimmer
-thing-type.openwebnet.zb_dimmer.description = A OpenWebNet ZigBee dimmer for the dimmer control of 1 light. BTicino models: 4585/4594/etc.
+thing-type.openwebnet.zb_dimmer.description = An OpenWebNet ZigBee dimmer for the dimmer control of 1 light. BTicino models: 4585/4594/etc.
thing-type.openwebnet.zb_gateway.label = ZigBee USB Gateway
thing-type.openwebnet.zb_gateway.description = This USB gateway (BTicino/Legrand models: BTI-3578/088328) connects to a BTicino/Legrand ZigBee network and uses the OpenWebNet protocol. For more information see: https://catalogo.bticino.it/BTI-3578-IT and https://www.legrand.com/ecatalogue/088328-openweb-net-zigbee-gateway-radio-interface.html
thing-type.openwebnet.zb_on_off_switch.label = ZigBee Switch
-thing-type.openwebnet.zb_on_off_switch.description = A OpenWebNet ZigBee switch (actuator) for the control of 1 load/light. BTicino models: 4591/3684/etc.
+thing-type.openwebnet.zb_on_off_switch.description = An OpenWebNet ZigBee switch (actuator) for the control of 1 load/light. BTicino models: 4591/3684/etc.
thing-type.openwebnet.zb_on_off_switch2u.label = ZigBee 2-units Switch
-thing-type.openwebnet.zb_on_off_switch2u.description = A OpenWebNet ZigBee 2-units switch (actuator) for the control of 2 loads/lights. BTicino model: 4592
+thing-type.openwebnet.zb_on_off_switch2u.description = An OpenWebNet ZigBee 2-units switch (actuator) for the control of 2 loads/lights. BTicino model: 4592
# thing types config
</supported-bridge-type-refs>
<label>Automation</label>
- <description>A OpenWebNet BUS/SCS automation device to control roller shutters, blinds, etc. BTicino models:
+ <description>An OpenWebNet BUS/SCS automation device to control roller shutters, blinds, etc. BTicino models:
xxx/yyyy/etc.</description>
<channels>
</supported-bridge-type-refs>
<label>Auxiliary</label>
- <description>A OpenWebNet BUS/SCS Auxiliary command</description>
+ <description>An OpenWebNet BUS/SCS Auxiliary command</description>
<channels>
<channel id="aux" typeId="aux"/>
</supported-bridge-type-refs>
<label>Scenario Control</label>
- <description>A OpenWebNet BUS/SCS Scenario Control device. BTicino models: F420/IR3456</description>
+ <description>An OpenWebNet BUS/SCS Scenario Control device. BTicino models: F420/IR3456</description>
<channels>
<channel id="scenario" typeId="scenarioEvent"/>
<bridge-type-ref id="bus_gateway"/>
</supported-bridge-type-refs>
<label>CEN+ Scenario Control</label>
- <description>A OpenWebNet BUS/SCS CEN+ Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680</description>
+ <description>An OpenWebNet BUS/SCS CEN+ Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680</description>
<!-- channels are created dynamically based on configured buttons -->
</supported-bridge-type-refs>
<label>CEN Scenario Control</label>
- <description>A OpenWebNet BUS/SCS CEN Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680</description>
+ <description>An OpenWebNet BUS/SCS CEN Scenario Control device. BTicino models: HC/HD/HS/L/N/NT4680</description>
<!-- channels are created dynamically based on configured buttons -->
</supported-bridge-type-refs>
<label>Dimmer</label>
- <description>A OpenWebNet BUS/SCS dimmer for the dimmer control of 1 light. BTicino models: yyyy/zzzz/etc.</description>
+ <description>An OpenWebNet BUS/SCS dimmer for the dimmer control of 1 light. BTicino models: yyyy/zzzz/etc.</description>
<channels>
<channel id="brightness" typeId="brightness"/>
</supported-bridge-type-refs>
<label>Dry Contact/IR Interface</label>
- <description>A OpenWebNet BUS/SCS Dry Contact Interface or IR Interface. BTicino models: 3477/F428, IR 4610-4611-4640
+ <description>An OpenWebNet BUS/SCS Dry Contact Interface or IR Interface. BTicino models: 3477/F428, IR 4610-4611-4640
etc.</description>
<channels>
</supported-bridge-type-refs>
<label>Energy Meter</label>
- <description>A OpenWebNet BUS/SCS Energy Meter. BTicino models: F52x</description>
+ <description>An OpenWebNet BUS/SCS Energy Meter. BTicino models: F52x</description>
<channels>
<channel id="power" typeId="power"/>
</supported-bridge-type-refs>
<label>Switch</label>
- <description>A OpenWebNet BUS/SCS switch for the control of 1 light/load. BTicino models: xxx/yyyy/etc.</description>
+ <description>An OpenWebNet BUS/SCS switch for the control of 1 light/load. BTicino models: xxx/yyyy/etc.</description>
<channels>
<channel id="switch" typeId="switch"/>
</supported-bridge-type-refs>
<label>Thermo Central Unit</label>
- <description>A OpenWebNet BUS/SCS configured thermo Central Unit.</description>
+ <description>An OpenWebNet BUS/SCS configured thermo Central Unit.</description>
<channels>
<!-- read only -->
<bridge-type-ref id="bus_gateway"/>
</supported-bridge-type-refs>
<label>Thermo Sensor</label>
- <description>A OpenWebNet BUS/SCS thermo sensor (probe) for measuring temperature in a zone. BTicino models:
+ <description>An OpenWebNet BUS/SCS thermo sensor (probe) for measuring temperature in a zone. BTicino models:
L/N/NT4577 etc.</description>
<channels>
</supported-bridge-type-refs>
<label>Thermo Zone</label>
- <description>A OpenWebNet BUS/SCS configured thermo zone (managed via Central Unit or stand alone).</description>
+ <description>An OpenWebNet BUS/SCS configured thermo zone (managed via Central Unit or stand alone).</description>
<channels>
<!-- read only -->
</supported-bridge-type-refs>
<label>ZigBee Automation</label>
- <description>A OpenWebNet ZigBee automation device to control roller shutters, blinds, etc. BTicino models:
+ <description>An OpenWebNet ZigBee automation device to control roller shutters, blinds, etc. BTicino models:
xxx/yyyy/etc.</description>
<channels>
</supported-bridge-type-refs>
<label>ZigBee Dimmer</label>
- <description>A OpenWebNet ZigBee dimmer for the dimmer control of 1 light. BTicino models: 4585/4594/etc.</description>
+ <description>An OpenWebNet ZigBee dimmer for the dimmer control of 1 light. BTicino models: 4585/4594/etc.</description>
<channels>
<channel id="brightness" typeId="brightness"/>
</supported-bridge-type-refs>
<label>ZigBee Switch</label>
- <description>A OpenWebNet ZigBee switch (actuator) for the control of 1 load/light. BTicino models: 4591/3684/etc.</description>
+ <description>An OpenWebNet ZigBee switch (actuator) for the control of 1 load/light. BTicino models: 4591/3684/etc.</description>
<channels>
<channel id="switch_01" typeId="switch"/>
</supported-bridge-type-refs>
<label>ZigBee 2-units Switch</label>
- <description>A OpenWebNet ZigBee 2-units switch (actuator) for the control of 2 loads/lights. BTicino model: 4592</description>
+ <description>An OpenWebNet ZigBee 2-units switch (actuator) for the control of 2 loads/lights. BTicino model: 4592</description>
<channels>
<channel id="switch_01" typeId="switch"/>
import org.openhab.core.thing.Thing;
/**
- * An handler of an AVR connected through an IP connection.
+ * A handler of an AVR connected through an IP connection.
*
* @author Antoine Besnard - Initial contribution
*/
import org.openhab.core.thing.Thing;
/**
- * An handler of an AVR connected through a serial port.
+ * A handler of an AVR connected through a serial port.
*
* @author Antoine Besnard - Initial contribution
*/
/**
* Tell the PS4 that we want to get info about the OnScreenKeyboard.
*
- * @return A OSKStartPacket.
+ * @return An OSKStartPacket.
*/
static ByteBuffer makeOSKStartPacket() {
return newPacketForEncryption(8, PS4Command.OSK_START_REQ);
* Send text to the OSK on the PS4. Replaces all the text as it is now.
*
* @param text
- * @return A OSKStringChangePacket.
+ * @return An OSKStringChangePacket.
*/
static ByteBuffer makeOSKStringChangePacket(String text) {
byte[] chars = text.getBytes(StandardCharsets.UTF_16LE);
}
/**
- * Parses out the text from a OSKStringChange-packet.
+ * Parses out the text from an OSKStringChange-packet.
*
* @param buffer The received packet from the PS4.
* @return The text in the packet.
}
/**
- * Sends a EVENT instruction to the zone
+ * Sends an EVENT instruction to the zone
*
* @param event a non-null, non-empty string to send
* @throws IllegalArgumentException if event is null or empty
/**
* Brightness channel has 2 functions: Switch On/Off (OnOnType) and setting brightness (PercentType)
* There is some more logic in the control. When brightness is set to 0 the control sends also an OFF command
- * When current brightness is 0 and slider will be moved the new brightness will be set, but also a ON command is
- * send.
+ * When current brightness is 0 and slider will be moved the new brightness will be set, but also an ON command is
+ * sent.
*
* @param command
* @param index
createDimmerChannels(dstatus, l);
// On a status update we map a dimmer.ison = false to brightness 0 rather than the device's brightness
- // and send a OFF status to the same channel.
- // When the device's brightness is > 0 we send the new value to the channel and a ON command
+ // and send an OFF status to the same channel.
+ // When the device's brightness is > 0 we send the new value to the channel and an ON command
if (dimmer.ison) {
updated |= updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Switch", OnOffType.ON);
updated |= updateChannel(groupName, CHANNEL_BRIGHTNESS + "$Value",
}
/**
- * Emitting of values shall happen here. If there is a event based emitting, this can be overriden.
+ * Emitting of values shall happen here. If there is an event based emitting, this can be overriden.
*
* @param initMessage The message which shall be written before reading the values.
* @param emitter The {@link FlowableEmitter} to emit the values to.
import org.openmuc.jsml.structures.SmlListEntry;
/**
- * Proxy class to encapsulate a openMUC SML_ListEntry-Object to read informations.
+ * Proxy class to encapsulate an openMUC SML_ListEntry-Object to read informations.
*
* @author Matthias Steigenberger - Initial contribution
* @author Mathias Gilhuber - Also-By
public void update(DeviceDTO deviceDTO) {
super.update(deviceDTO);
- // values to put on a overview dashboard
+ // values to put on an overview dashboard
this.addWattQuantity(CHANNEL_POWER_BUFFERED, deviceDTO);
this.addWattQuantity(CHANNEL_POWER_SELF_CONSUMED, deviceDTO);
this.addWattQuantity(CHANNEL_POWER_SELF_SUPPLIED, deviceDTO);
/**
* The {@link SonnenJsonDataDTO} is the Java class used to map the JSON
- * response to a Oven request.
+ * response to an Oven request.
*
* @author Christian Feininger - Initial contribution
*/
This thing reflecting one of our 'schema API page' as defined in the prerequisites.
This thing doesn't need the bridge.
-Multiple of these pages on different C.M.I.'s could be defined within a openHAB instance.
+Multiple of these pages on different C.M.I.'s could be defined within an openHAB instance.
* TA C.M.I. CoE Bridge
| API Schema ID | schemaId | ID of the schema API page | 1-256 |
| Poll Interval | pollInterval | Poll interval (in seconds) how often to poll the API Page | 1-300; default 10 |
-This thing doesn't need a bridge. Multiple of these things for different C.M.I.'s could be defined within a openHAB instance.
+This thing doesn't need a bridge. Multiple of these things for different C.M.I.'s could be defined within an openHAB instance.
### TA C.M.I. CoE Connection
import org.slf4j.LoggerFactory;
/**
- * This represents the configuration of a openHAB item that is binded to a Velux
+ * This represents the configuration of an openHAB item that is binded to a Velux
* KLF200 Gateway. It contains the following information:
*
* <ul>
import org.slf4j.LoggerFactory;
/**
- * This represents the configuration of a openHAB item that is binded to a Velux
+ * This represents the configuration of an openHAB item that is binded to a Velux
* KLF200 Gateway. It contains the following information:
*
* <ul>
-Alternatively, you may add the WebThing as a openHAB Thing by using a webthing.thing file that has to be located inside the things folder.
+Alternatively, you may add the WebThing as an openHAB Thing by using a webthing.thing file that has to be located inside the things folder.
```
Thing webthing:generic:speedmonitor [ webThingURI="http://192.168.1.27:9496/0" ]
void updateItemState(ChannelUID channelUID, Command command);
/**
- * Listener that will be notified, if a Item state is changed
+ * Listener that will be notified, if an Item state is changed
*/
interface ItemChangedListener {
// suppressed. Otherwise, the task will only terminate via cancellation or
// termination of the executor.
try {
- // Authenticate - thing status update with a error message
+ // Authenticate - thing status update with an error message
if (mZWayApi.getLogin() != null) {
// Thing status set to online in login callback
logger.info("Z-Way bridge successfully authenticated");
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_PENDING,
"Checking configuration and bridge...");
- // Configuration - thing status update with a error message
+ // Configuration - thing status update with an error message
mConfig = loadAndCheckConfiguration();
if (mConfig != null) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_PENDING,
"Checking configuration and bridge...");
- // Configuration - thing status update with a error message
+ // Configuration - thing status update with an error message
mConfig = loadAndCheckConfiguration();
if (mConfig != null) {
}
/**
- * return HomeKit accessory types for a OH item based on meta data
+ * return HomeKit accessory types for an OH item based on meta data
*
* @param item OH item
* @param metadataRegistry meta data registry
}
/**
- * collect optional HomeKit characteristics for a OH item.
+ * collect optional HomeKit characteristics for an OH item.
*
* @param taggedItem main OH item
* @param metadataRegistry OH metadata registry
import tech.units.indriya.unit.UnitDimension;
/**
- * Creates a optional characteristics .
+ * Creates an optional characteristics .
*
* @author Eugen Freiter - Initial contribution
*/
import org.openhab.io.imperihome.internal.model.param.ParamType;
/**
- * MultiSwitch device, mimics behavior of a OH Switch with a mapping.
+ * MultiSwitch device, mimics behavior of an OH Switch with a mapping.
*
* @author Pepijn de Geus - Initial contribution
*/
}
/**
- * Parses the text into a ItemSubType enum (ignoring case)
+ * Parses the text into an ItemSubType enum (ignoring case)
*
* @param text the text to parse
* @return the ItemSubType type
logger.trace("Storing item {} in InfluxDB point {}", item, point);
influxDBRepository.write(point);
} else {
- logger.trace("Ignoring item {} as is cannot be converted to a InfluxDB point", item);
+ logger.trace("Ignoring item {} as is cannot be converted to an InfluxDB point", item);
}
} else {
logger.debug("store ignored, InfluxDB is not yet connected");
import org.openhab.core.persistence.FilterCriteria;
/**
- * Creates InfluxDB query sentence given a OpenHab persistence {@link FilterCriteria}
+ * Creates InfluxDB query sentence given an OpenHab persistence {@link FilterCriteria}
*
* @author Joan Pujol Espinar - Initial contribution
*/
Defines the type of data to be stored.
It must be one of the following string values:
-- **COUNTER** represents a ever-incrementing value (historically this was used for packet counters or traffic counters on network interfaces, a typical home-automation application would be your electricity meter). If you store the values of this counter in a simple database and make a chart of that, you'll most likely see a nearly flat line, because the increments per time are small compared to the absolute value (e.g. your electricity meter reads 60567 kWh, and you add 0.5 kWh per hour, than your chart over the whole day will show 60567 at the start and 60579 at the end of your chart. That is nearly invisible. RRD4J helps you out and will display the difference from one stored value to the other (depending on the selected size). Please note that the persistence extensions will return difference instead of the actual values if you use this type; this especially leads to wrong values if you try to restoreOnStartup!
+- **COUNTER** represents an ever-incrementing value (historically this was used for packet counters or traffic counters on network interfaces, a typical home-automation application would be your electricity meter). If you store the values of this counter in a simple database and make a chart of that, you'll most likely see a nearly flat line, because the increments per time are small compared to the absolute value (e.g. your electricity meter reads 60567 kWh, and you add 0.5 kWh per hour, than your chart over the whole day will show 60567 at the start and 60579 at the end of your chart. That is nearly invisible. RRD4J helps you out and will display the difference from one stored value to the other (depending on the selected size). Please note that the persistence extensions will return difference instead of the actual values if you use this type; this especially leads to wrong values if you try to restoreOnStartup!
- **GAUGE** represents the reading of e.g. a temperature sensor. You'll see only small deviation over the day and your values will be within a small range, clearly visible within a chart.
- **ABSOLUTE** is like a counter, but RRD4J assumes that the counter is reset when the value is read. So these are basically the delta values between the reads.
- **DERIVE** is like a counter, but it can also decrease and therefore have a negative delta.
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the ExecTransformationservice on a ItemChannelLink
+ * Profile to offer the ExecTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*/
It expects the transformation rule to be read from a file which is stored under the `transform` folder.
To organize the various transformations, one should use subfolders.
-Simple transformation rules can also be given as a inline script.
+Simple transformation rules can also be given as an inline script.
Inline script should be start by `|` character following the JavaScript.
Beware that complex inline script could cause issues to e.g. item file parsing.
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the JavascriptTransformationservice on a ItemChannelLink
+ * Profile to offer the JavascriptTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the JinjaTransformationservice on a ItemChannelLink
+ * Profile to offer the JinjaTransformationservice on an ItemChannelLink
*
* @author Jochen Klein - initial contribution
*
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the JSonPathTransformationservice on a ItemChannelLink
+ * Profile to offer the JSonPathTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the MapTransformationservice on a ItemChannelLink
+ * Profile to offer the MapTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the RegexTransformationservice on a ItemChannelLink
+ * Profile to offer the RegexTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the ScaleTransformationservice on a ItemChannelLink
+ * Profile to offer the ScaleTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the XPathTransformationservice on a ItemChannelLink
+ * Profile to offer the XPathTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the XsltTransformationservice on a ItemChannelLink
+ * Profile to offer the XsltTransformationservice on an ItemChannelLink
*
* @author Stefan Triller - initial contribution
*
projects / openhab-addons.git / commitdiff