-
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* [items] Refactor ItemChannelLink * [items] Refactor Metadata * [items] Export metadata & itemchannellink * [items] Adjust usage of metadata & itemchannellink * README: Adjust to metadata & itemchannellink changes * [items] Use getters instead of accessors * [items] Remove redundant toString from metadata * [items] Convert Item channel link configuration to JS object Also-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
- Loading branch information
1 parent
9ea4e53
commit eccf2d4
Showing
20 changed files
with
377 additions
and
326 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| /** | ||
| * Item channel link namespace. | ||
| * This namespace provides access to Item channel links. | ||
| * | ||
| * @namespace items.metadata.itemchannellink | ||
| */ | ||
|
|
||
| const osgi = require('../../osgi'); | ||
| const utils = require('../../utils'); | ||
| const log = require('../../log')('itemchannellink'); | ||
|
|
||
| const ItemChannelLink = Java.type('org.openhab.core.thing.link.ItemChannelLink'); | ||
| const ChannelUID = Java.type('org.openhab.core.thing.ChannelUID'); | ||
| const Configuration = Java.type('org.openhab.core.config.core.Configuration'); | ||
| const managedItemChannelLinkProvider = osgi.getService('org.openhab.core.thing.link.ManagedItemChannelLinkProvider'); | ||
|
|
||
| /** | ||
| * Creates a new ItemChannelLink object. | ||
| * | ||
| * @private | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @param {object} [conf] channel configuration | ||
| * @returns {ItemChannelLink} ItemChannelLink object | ||
| */ | ||
| const _createItemChannelLink = function (itemName, channelUID, conf) { | ||
| log.debug(`Creating ItemChannelLink ${itemName} -> ${channelUID}...`); | ||
| if (typeof conf === 'object') { | ||
| log.debug(` .. with configuration ${conf}`); | ||
| return new ItemChannelLink(itemName, new ChannelUID(channelUID), new Configuration(conf)); | ||
| } else { | ||
| return new ItemChannelLink(itemName, new ChannelUID(channelUID)); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Gets an ItemChannelLink from the provider. | ||
| * | ||
| * @memberof items.metadata.itemchannellink | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @returns {{itemName: string, configuration: *, channelUID: string}|null} the ItemChannelLink or `null` if none exists | ||
| */ | ||
| const getItemChannelLink = function (itemName, channelUID) { | ||
| log.debug(`Getting ItemChannelLink ${itemName} -> ${channelUID} from provider...`); | ||
| const itemChannelLink = managedItemChannelLinkProvider.get(itemName + ' -> ' + channelUID); | ||
| if (itemChannelLink === null || itemChannelLink === undefined) return null; | ||
| return { | ||
| itemName: itemChannelLink.getItemName().toString(), | ||
| channelUID: itemChannelLink.getLinkedUID().toString(), | ||
| configuration: utils.javaMapToJsObj(itemChannelLink.getConfiguration().getProperties()) | ||
| }; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds a new ItemChannelLink to the provider. Therefore, it adds a channel link to an Item. | ||
| * | ||
| * @private | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @param {object} [conf] channel configuration | ||
| * @returns {{itemName: string, configuration: *, channelUID: string}} the ItemChannelLink | ||
| */ | ||
| const _addItemChannelLink = function (itemName, channelUID, conf) { | ||
| log.debug(`Adding ItemChannelLink ${itemName} -> ${channelUID} to provider...`); | ||
| const itemChannelLink = _createItemChannelLink(itemName, channelUID, conf); | ||
| managedItemChannelLinkProvider.add(itemChannelLink); | ||
| return { | ||
| itemName: itemChannelLink.getItemName().toString(), | ||
| channelUID: itemChannelLink.getLinkedUID().toString(), | ||
| configuration: utils.javaMapToJsObj(itemChannelLink.getConfiguration().getProperties()) | ||
| }; | ||
| }; | ||
|
|
||
| /** | ||
| * Update an ItemChannelLink in the provider. Therefore, it updates the channel link of an Item. | ||
| * | ||
| * @private | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @param {object} [conf] channel configuration | ||
| * @returns {{itemName: string, configuration: *, channelUID: string}|null} the old ItemChannelLink or `null` if none exists | ||
| */ | ||
| const _updateItemChannelLink = function (itemName, channelUID, conf) { | ||
| log.debug(`Updating ItemChannelLink ${itemName} -> ${channelUID} in provider...`); | ||
| const itemChannelLink = _createItemChannelLink(itemName, channelUID, conf); | ||
| managedItemChannelLinkProvider.update(itemChannelLink); | ||
| if (itemChannelLink === null || itemChannelLink === undefined) return null; | ||
| return { | ||
| itemName: itemChannelLink.getItemName().toString(), | ||
| channelUID: itemChannelLink.getLinkedUID().toString(), | ||
| configuration: utils.javaMapToJsObj(itemChannelLink.getConfiguration().getProperties()) | ||
| }; | ||
| }; | ||
|
|
||
| /** | ||
| * Adds or updates an ItemChannelLink. | ||
| * | ||
| * @memberof items.metadata.itemchannellink | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @param {object} [conf] channel configuration | ||
| * @returns {{itemName: string, configuration: *, channelUID: string}|null} the old ItemChannelLink or `null` if it did not exist | ||
| */ | ||
| const replaceItemChannelLink = function (itemName, channelUID, conf) { | ||
| const existing = getItemChannelLink(itemName, channelUID); | ||
| if (existing === null) { | ||
| _addItemChannelLink(itemName, channelUID, conf); | ||
| } else { | ||
| _updateItemChannelLink(itemName, channelUID, conf); | ||
| } | ||
| return existing; | ||
| }; | ||
|
|
||
| /** | ||
| * Removes an ItemChannelLink from the provider. Therefore, the channel link is removed from the Item. | ||
| * | ||
| * @memberof items.metadata.itemchannellink | ||
| * @param {string} itemName the name of the Item | ||
| * @param {string} channelUID | ||
| * @returns {{itemName: string, configuration: *, channelUID: string}|null} the removed ItemChannelLink or `null` if none exists | ||
| */ | ||
| const removeItemChannelLink = function (itemName, channelUID) { | ||
| log.debug(`Removing ItemChannelLink ${itemName} -> ${channelUID} from provider...`); | ||
| const itemChannelLink = managedItemChannelLinkProvider.remove(itemName + ' -> ' + channelUID); | ||
| if (itemChannelLink === null || itemChannelLink === undefined) return null; | ||
| return { | ||
| itemName: itemChannelLink.getItemName().toString(), | ||
| channelUID: itemChannelLink.getLinkedUID().toString(), | ||
| configuration: utils.javaMapToJsObj(itemChannelLink.getConfiguration().getProperties()) | ||
| }; | ||
| }; | ||
|
|
||
| module.exports = { | ||
| getItemChannelLink, | ||
| replaceItemChannelLink, | ||
| removeItemChannelLink | ||
| }; |
Oops, something went wrong.