Members
(constant) builder :RuleBuilder
- Source:
Type:
Methods
thingActions(bindingId, thingUid) → {any}
- Source:
Get the ThingActions of a Thing.
Parameters:
Name | Type | Description |
---|---|---|
bindingId |
String | binding ID |
thingUid |
String | Thing UID |
Returns:
- Type
- any
Type Definitions
HostState
Native Java openHAB State (instance of org.openhab.core.types.State)
Type:
- object
HostItem
Native Java openHAB Item (instance of org.openhab.core.items.Item)
Type:
- object
HostClass
Native Java Class Object (instance of java.lang.Class)
Type:
- object
HostRule
Native Jave openHAB Rule (instance of org.openhab.core.automation.Rule)
Type:
- object
HostTrigger
Native Jave openHAB Trigger (instance of org.openhab.core.automation.Trigger)
Type:
- object
HostThing
Native Java openHAB Thing (instance of org.openhab.core.thing.Thing)
Type:
- object
ItemConfig
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
type |
string | the type of the Item |
|
name |
string | Item name for the Item to create |
|
label |
string |
<optional> |
the label for the Item |
category |
string |
<optional> |
the category (icon) for the Item |
groups |
Array.<String> |
<optional> |
an array of groups the Item is a member of |
tags |
Array.<String> |
<optional> |
an array of tags for the Item |
channels |
String | Object |
<optional> |
for single channel link a string or for multiple an object { channeluid: configuration }; configuration is an object |
metadata |
ItemMetadata |
<optional> |
either object { namespace: value } or { namespace: { value: value, config: {} } } |
giBaseType |
string |
<optional> |
the group Item base type for the Item |
groupFunction |
HostGroupFunction |
<optional> |
the group function used by the Item |
configuration describing an Item
Type:
- object
ItemMetadata
- Source:
Properties:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
stateDescription |
object |
<optional> |
Properties
|
||||||||||||||||||||
expire |
object |
<optional> |
Properties
|
||||||||||||||||||||
autoupdate |
object |
<optional> |
Properties
|
Item metadata configuration, not fully documented
Type:
- object
EventObject
- Source:
Properties:
Name | Type | Description |
---|---|---|
oldState |
string | only for |
newState |
string | only for |
receivedState |
string | only for |
receivedCommand |
string | only for |
itemName |
string | for all triggers except |
receivedEvent |
string | only for |
channelUID |
string | only for |
oldStatus |
string | only for |
newStatus |
string | only for |
status |
string | only for |
eventType |
string | for all triggers except |
triggerType |
string | for all triggers except |
payload |
* | for most triggers |
When a rule is triggered, the script is provided the event instance that triggered it. The specific data depends on the event type. The EventObject
provides several information about that trigger.
Note:
Group****Trigger
s use the equivalent Item****Trigger
as trigger for each member.
Type:
- object
RuleCallback(event)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
event |
EventObject |
RuleConfig
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
name |
string | name of the rule (used in UI) |
||
description |
string |
<optional> |
description of the rule (used in UI) |
|
triggers |
triggers | Array.<triggers> | which will fire the rule |
||
execute |
RuleCallback | callback to run when the rule fires |
||
id |
string |
<optional> |
UID of the rule, if not provided, one is generated |
|
tags |
Array.<String> |
<optional> |
tags for the rule (used in UI) |
|
ruleGroup |
string |
<optional> |
name of rule group to use |
|
overwrite |
boolean |
<optional> |
false
|
whether to overwrite an existing rule with the same UID |
configuration for rules.JSRule
Type:
- object