# openHAB

> Run your smart home from a workflow: switch lights and devices, set levels, run scenes and scripts, read sensors and their history, and check which devices are offline. Start a workflow when an item changes, a reading passes a number, a device goes offline or openHAB finds a new one.

App · 32 actions. Web page: https://docs.lodol.com/docs/integrations/openhab

## Actions

### Add item to group

Put an item in a group, keeping the groups it is in.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Group (`group`, text, required): The group: pick one, or give its name from another openHAB step or its label, such as Lights.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Add tag to item

Add a tag to an item, keeping the tags it has.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Tag (`tag`, text, required): The tag, such as Light.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Create or update item

Create an item, or change one that exists: its label, icon, tags and groups. What you leave blank on an item that exists stays as it is.

**Inputs**

- Name (`name`, text, required): The item's name: letters, numbers and underscores, such as Kitchen_Light. An item with this name is changed; otherwise one is created.
- Type (`item_type`, text): What kind of item it is. Needed to create one. One of: `Switch` (Switch (on or off)), `Dimmer` (Dimmer (0 to 100 percent)), `Number`, `String` (String (text)), `Contact` (Contact (open or closed)), `Rollershutter` (Rollershutter (blinds)), `Color`, `DateTime` (DateTime (date and time)), `Player` (Player (play and pause)), `Location`, and 3 more.
- Label (`label`, text): The name people see, such as Kitchen Light.
- Icon (`category`, text): Its icon in openHAB, such as lightbulb.
- Tags (`tags`, list): Its tags, such as Light. These replace the tags it had.
- Groups (`groups`, list): The names of the groups it belongs to, such as Lights. These replace the groups it was in.
- Dimension (`dimension`, text): For a Number with a unit, what it measures, such as Temperature, Power or Length.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `created` (true/false): Whether the item was created (false when it was changed)
- `group_type` (text): For a group, the kind of item it adds up to, or blank
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `members` (list): For a group, the names of the items in it
- `metadata` (object): The item's metadata: for each kind (such as unit), its value and config
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "created": true,
  "group_type": "",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "members": [],
  "metadata": {
    "semantics": {
      "config": {},
      "value": "Point_Control"
    }
  },
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Delete item

Delete an item for good. Items defined in a file on the server can't be deleted this way.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.

**Outputs**

- `deleted` (true/false): Whether it was deleted
- `label` (text): The label it had
- `name` (text): The deleted item's name

**Example output**

```json
{
  "deleted": true,
  "label": "Kitchen Light",
  "name": "Kitchen_Light"
}
```

### Disable rule

Turn a rule, scene or script off, so nothing starts it until it is enabled again, such as while you're on holiday.

**Inputs**

- Rule (`rule`, text, required): The rule, scene or script: pick one, or give its ID from another openHAB step or its name.

**Outputs**

- `description` (text): Its description
- `enabled` (true/false): Whether it is turned on
- `link` (text): Where it opens in openHAB
- `name` (text): The rule's name
- `rule_type` (text): rule, scene or script
- `status` (text): IDLE, RUNNING, INITIALIZING or UNINITIALIZED
- `status_detail` (text): Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
- `tags` (list): Its tags
- `uid` (text): The rule's ID, which other openHAB steps take

**Example output**

```json
{
  "description": "Lamp on, dimmer low",
  "enabled": false,
  "link": "https://openhab.example.com/settings/scenes/evening_scene",
  "name": "Evening",
  "rule_type": "scene",
  "status": "UNINITIALIZED",
  "status_detail": "DISABLED",
  "tags": [
    "Scene"
  ],
  "uid": "evening_scene"
}
```

### Disable thing

Turn a thing off, so openHAB stops talking to it until it is enabled again.

**Inputs**

- Thing (`thing`, text, required): The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.

**Outputs**

- `bridge` (text): The ID of the bridge it connects through, or blank
- `enabled` (true/false): Whether the thing is turned on in openHAB
- `label` (text): The thing's label
- `link` (text): Where the thing opens in openHAB
- `location` (text): Where it is, when set
- `online` (true/false): Whether the thing is online
- `status` (text): ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
- `status_description` (text): Why, in the thing's own words, when it says
- `status_detail` (text): Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
- `thing_type` (text): What kind of thing it is, such as astro:sun
- `uid` (text): The thing's ID, which other openHAB steps take

**Example output**

```json
{
  "bridge": "hue:bridge:bridge1",
  "enabled": false,
  "label": "Hallway Lamp",
  "link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
  "location": "Hallway",
  "online": false,
  "status": "UNINITIALIZED",
  "status_description": "",
  "status_detail": "DISABLED",
  "thing_type": "hue:0210",
  "uid": "hue:0210:bridge1:lamp3"
}
```

### Enable rule

Turn a rule, scene or script back on.

**Inputs**

- Rule (`rule`, text, required): The rule, scene or script: pick one, or give its ID from another openHAB step or its name.

**Outputs**

- `description` (text): Its description
- `enabled` (true/false): Whether it is turned on
- `link` (text): Where it opens in openHAB
- `name` (text): The rule's name
- `rule_type` (text): rule, scene or script
- `status` (text): IDLE, RUNNING, INITIALIZING or UNINITIALIZED
- `status_detail` (text): Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
- `tags` (list): Its tags
- `uid` (text): The rule's ID, which other openHAB steps take

**Example output**

```json
{
  "description": "Lamp on, dimmer low",
  "enabled": true,
  "link": "https://openhab.example.com/settings/scenes/evening_scene",
  "name": "Evening",
  "rule_type": "scene",
  "status": "IDLE",
  "status_detail": "",
  "tags": [
    "Scene"
  ],
  "uid": "evening_scene"
}
```

### Enable thing

Turn a thing back on, so openHAB talks to it again.

**Inputs**

- Thing (`thing`, text, required): The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.

**Outputs**

- `bridge` (text): The ID of the bridge it connects through, or blank
- `enabled` (true/false): Whether the thing is turned on in openHAB
- `label` (text): The thing's label
- `link` (text): Where the thing opens in openHAB
- `location` (text): Where it is, when set
- `online` (true/false): Whether the thing is online
- `status` (text): ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
- `status_description` (text): Why, in the thing's own words, when it says
- `status_detail` (text): Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
- `thing_type` (text): What kind of thing it is, such as astro:sun
- `uid` (text): The thing's ID, which other openHAB steps take

**Example output**

```json
{
  "bridge": "hue:bridge:bridge1",
  "enabled": true,
  "label": "Hallway Lamp",
  "link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
  "location": "Hallway",
  "online": true,
  "status": "ONLINE",
  "status_description": "The lamp isn't reachable.",
  "status_detail": "",
  "thing_type": "hue:0210",
  "uid": "hue:0210:bridge1:lamp3"
}
```

### Get item

Get an item with what it shows now, what it showed before, its tags, groups, members and metadata.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `group_type` (text): For a group, the kind of item it adds up to, or blank
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `members` (list): For a group, the names of the items in it
- `metadata` (object): The item's metadata: for each kind (such as unit), its value and config
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "group_type": "",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "members": [],
  "metadata": {
    "semantics": {
      "config": {},
      "value": "Point_Control"
    }
  },
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Get item history

Get what an item was between two times, as openHAB stored it, with the lowest, highest and average for numbers. Needs a persistence add-on in openHAB.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- From (`start`, date and time): The start of the time. Defaults to a day before the end.
- To (`end`, date and time): The end of the time. Defaults to now.
- Persistence service (`service`, text): Where openHAB stored it, such as rrd4j. Leave blank for openHAB's default.
- How many (`limit`, number): The most values to return, keeping the newest. Defaults to 1000. From 1 to 10000.

**Outputs**

- `average` (number): The average of the numbers, empty when there are none
- `count` (number): How many values are listed
- `datapoints` (list): Each stored value, oldest first
- `end` (text): The end of the time looked at (UTC)
- `first_state` (text): The oldest value listed
- `last_state` (text): The newest value listed
- `maximum` (number): The highest number, empty when none are numbers
- `minimum` (number): The lowest number, empty when none are numbers
- `more` (true/false): Whether older values in that time were left out
- `name` (text): The item's name
- `start` (text): The start of the time looked at (UTC)

**Example output**

```json
{
  "average": 385,
  "count": 2,
  "datapoints": [
    {
      "number": 360,
      "state": "360",
      "time": "2026-11-12T08:00:00Z"
    },
    {
      "number": 410,
      "state": "410",
      "time": "2026-11-12T12:00:00Z"
    }
  ],
  "end": "2026-11-12T18:30:00Z",
  "first_state": "360",
  "last_state": "410",
  "maximum": 410,
  "minimum": 360,
  "more": false,
  "name": "Power_Meter",
  "start": "2026-11-11T18:30:00Z"
}
```

### Get item state

Get only what an item shows now, such as ON or 21.5 °C, with the number and unit read out of it.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.

**Outputs**

- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "has_state": true,
  "name": "LivingRoom_Temperature",
  "number": 21.5,
  "state": "21.5 \u00b0C",
  "unit": "\u00b0C"
}
```

### Get last stored state

Get the newest value openHAB stored for an item and when, looking back up to a year. Says so when nothing was stored.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Persistence service (`service`, text): Where openHAB stored it, such as rrd4j. Leave blank for openHAB's default.

**Outputs**

- `found` (true/false): Whether anything was stored for it in the past year
- `name` (text): The item's name
- `number` (number): The value as a number (1 for ON, 0 for OFF), empty when it isn't one
- `state` (text): The value, as openHAB stored it
- `time` (text): When the value was stored (UTC)

**Example output**

```json
{
  "found": true,
  "name": "Power_Meter",
  "number": 410,
  "state": "410",
  "time": "2026-11-12T12:00:00Z"
}
```

### Get rule

Get a rule, scene or script with what starts it and what it does.

**Inputs**

- Rule (`rule`, text, required): The rule, scene or script: pick one, or give its ID from another openHAB step or its name.

**Outputs**

- `actions` (list): What it does
- `conditions` (list): What must be true for it to run
- `description` (text): Its description
- `enabled` (true/false): Whether it is turned on
- `link` (text): Where it opens in openHAB
- `name` (text): The rule's name
- `rule_type` (text): rule, scene or script
- `status` (text): IDLE, RUNNING, INITIALIZING or UNINITIALIZED
- `status_detail` (text): Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
- `tags` (list): Its tags
- `triggers` (list): What starts it
- `uid` (text): The rule's ID, which other openHAB steps take

**Example output**

```json
{
  "actions": [
    {
      "configuration": {
        "command": "ON",
        "itemName": "LivingRoom_Lamp"
      },
      "id": "1",
      "label": "",
      "type": "core.ItemCommandAction"
    }
  ],
  "conditions": [],
  "description": "Lamp on, dimmer low",
  "enabled": true,
  "link": "https://openhab.example.com/settings/scenes/evening_scene",
  "name": "Evening",
  "rule_type": "scene",
  "status": "IDLE",
  "status_detail": "",
  "tags": [
    "Scene"
  ],
  "triggers": [],
  "uid": "evening_scene"
}
```

### Get system info

Get the openHAB server's version, language, time zone, how long it has been running and its memory.

**Inputs**: None.

**Outputs**

- `api_version` (text): The version of its API
- `build` (text): Which build it is, such as Release Build
- `java_version` (text): The Java version it runs on
- `language` (text): Its language and region, such as en_US
- `link` (text): openHAB's About page
- `measurement_system` (text): SI (metric) or US
- `memory_free_mb` (number): Memory openHAB has free, in megabytes
- `memory_total_mb` (number): Memory openHAB has taken, in megabytes
- `operating_system` (text): The system it runs on
- `time_zone` (text): Its time zone, such as Europe/Berlin
- `uptime_seconds` (number): How long it has been running, in seconds
- `version` (text): openHAB's version, such as 5.2.4

**Example output**

```json
{
  "api_version": "8",
  "build": "Release Build",
  "java_version": "21.0.13",
  "language": "en_US",
  "link": "https://openhab.example.com/about",
  "measurement_system": "SI",
  "memory_free_mb": 120.5,
  "memory_total_mb": 512,
  "operating_system": "Linux 6.12",
  "time_zone": "Europe/Berlin",
  "uptime_seconds": 86400,
  "version": "5.2.4"
}
```

### Get thing

Get a thing with whether it is online and why not, its channels with the items linked to them, and its settings.

**Inputs**

- Thing (`thing`, text, required): The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.

**Outputs**

- `bridge` (text): The ID of the bridge it connects through, or blank
- `channels` (list): What the thing offers, each with the items linked to it
- `configuration` (object): The thing's settings
- `enabled` (true/false): Whether the thing is turned on in openHAB
- `label` (text): The thing's label
- `link` (text): Where the thing opens in openHAB
- `location` (text): Where it is, when set
- `online` (true/false): Whether the thing is online
- `properties` (object): What the thing reports about itself, such as its model
- `status` (text): ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
- `status_description` (text): Why, in the thing's own words, when it says
- `status_detail` (text): Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
- `thing_type` (text): What kind of thing it is, such as astro:sun
- `uid` (text): The thing's ID, which other openHAB steps take

**Example output**

```json
{
  "bridge": "hue:bridge:bridge1",
  "channels": [
    {
      "id": "brightness",
      "item_type": "Dimmer",
      "label": "Brightness",
      "linked_items": [
        "Hall_Light"
      ]
    }
  ],
  "configuration": {
    "lightId": "3"
  },
  "enabled": true,
  "label": "Hallway Lamp",
  "link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
  "location": "Hallway",
  "online": false,
  "properties": {
    "modelId": "LWB010"
  },
  "status": "OFFLINE",
  "status_description": "The lamp isn't reachable.",
  "status_detail": "COMMUNICATION_ERROR",
  "thing_type": "hue:0210",
  "uid": "hue:0210:bridge1:lamp3"
}
```

### List add-ons

List the add-ons installed in openHAB with their versions, or everything its Add-on Store offers.

**Inputs**

- Type (`addon_type`, text): Only add-ons of this kind. Defaults to all kinds. One of: `all` (All kinds), `binding` (Bindings), `automation`, `persistence`, `transformation` (Transformations), `ui` (User interfaces), `voice`, `misc` (Other). Default: `all`.
- Include not installed (`include_available`, true/false): Also list add-ons that could be installed. Default: `false`.
- Name contains (`words`, text): Only those whose name has these words.

**Outputs**

- `addons` (list): Each add-on, A to Z by name
- `count` (number): How many are listed
- `text` (text): The list as text, one per line

**Example output**

```json
{
  "addons": [
    {
      "addon_type": "binding",
      "author": "openHAB",
      "description": "Sunrise, sunset and moon phases.",
      "id": "binding-astro",
      "installed": true,
      "link": "https://www.openhab.org/addons/bindings/astro/",
      "name": "Astro Binding",
      "version": "5.2.4"
    }
  ],
  "count": 1,
  "text": "- Astro Binding (binding, 5.2.4)"
}
```

### List discovered things

List what openHAB has found on the network and keeps in its inbox, waiting to be added.

**Inputs**: None.

**Outputs**

- `count` (number): How many are listed
- `text` (text): The list as text, one per line
- `things` (list): Each thing waiting in openHAB's inbox

**Example output**

```json
{
  "count": 1,
  "text": "- Hue Bridge (hue:bridge:001788fffe2b3c4d)",
  "things": [
    {
      "binding": "hue",
      "bridge": "",
      "ignored": false,
      "label": "Hue Bridge",
      "properties": {
        "ipAddress": "192.168.1.20"
      },
      "thing_type": "hue:bridge",
      "uid": "hue:bridge:001788fffe2b3c4d"
    }
  ]
}
```

### List items

List items (lights, sensors, switches and the rest) with what each shows now, all of them or only one type, tag or group.

**Inputs**

- Type (`item_type`, text): Only items of this type. Number also finds numbers with a unit. One of: `Switch` (Switch (on or off)), `Dimmer` (Dimmer (0 to 100 percent)), `Number`, `String` (String (text)), `Contact` (Contact (open or closed)), `Rollershutter` (Rollershutter (blinds)), `Color`, `DateTime` (DateTime (date and time)), `Player` (Player (play and pause)), `Location`, and 3 more.
- Tag (`tag`, text): Only items with this tag, such as Light.
- Group (`group`, text): Only items in this group or the groups inside it, such as Lights.
- Name contains (`words`, text): Only those whose name has these words.
- How many (`limit`, number): The most items to return. Defaults to 200. From 1 to 2000.

**Outputs**

- `count` (number): How many items are listed
- `items` (list): Each item, A to Z by label
- `more` (true/false): Whether there were more than the most asked for
- `text` (text): The list as text, one item per line, to send to someone

**Example output**

```json
{
  "count": 1,
  "items": [
    {
      "category": "lightbulb",
      "groups": [
        "LivingRoom",
        "Lights"
      ],
      "has_state": true,
      "is_group": false,
      "label": "Living Room Lamp",
      "last_changed": "2026-11-12T18:30:00Z",
      "last_updated": "2026-11-12T18:30:00Z",
      "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
      "name": "LivingRoom_Lamp",
      "number": null,
      "previous_state": "OFF",
      "state": "ON",
      "tags": [
        "Light"
      ],
      "type": "Switch",
      "unit": ""
    }
  ],
  "more": false,
  "text": "- Living Room Lamp (LivingRoom_Lamp): ON"
}
```

### List rules

List rules, scenes and scripts, with whether each is turned on.

**Inputs**

- Show (`rule_type`, text): Only rules, only scenes or only scripts. Defaults to everything. One of: `all` (Everything), `rule` (Rules), `scene` (Scenes), `script` (Scripts). Default: `all`.
- Tag (`tag`, text): Only those with this tag.
- Name contains (`words`, text): Only those whose name has these words.

**Outputs**

- `count` (number): How many are listed
- `rules` (list): Each rule, scene or script, A to Z by name
- `text` (text): The list as text, one per line

**Example output**

```json
{
  "count": 1,
  "rules": [
    {
      "description": "Lamp on, dimmer low",
      "enabled": true,
      "link": "https://openhab.example.com/settings/scenes/evening_scene",
      "name": "Evening",
      "rule_type": "scene",
      "status": "IDLE",
      "status_detail": "",
      "tags": [
        "Scene"
      ],
      "uid": "evening_scene"
    }
  ],
  "text": "- Evening (scene evening_scene)"
}
```

### List things

List things (the devices and services openHAB talks to) with whether each is online and, when it isn't, why.

**Inputs**

- Status (`status`, text): Only things that are online, offline or turned off. Defaults to all. One of: `all`, `online`, `offline`, `disabled`. Default: `all`.
- Name contains (`words`, text): Only those whose name has these words.

**Outputs**

- `count` (number): How many things are listed
- `offline_count` (number): How many of them are offline
- `text` (text): The list as text, one thing per line, to send to someone
- `things` (list): Each thing, A to Z by label

**Example output**

```json
{
  "count": 1,
  "offline_count": 1,
  "text": "- Hallway Lamp (hue:0210:bridge1:lamp3): OFFLINE (The lamp isn't reachable.)",
  "things": [
    {
      "bridge": "hue:bridge:bridge1",
      "enabled": true,
      "label": "Hallway Lamp",
      "link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
      "location": "Hallway",
      "online": false,
      "status": "OFFLINE",
      "status_description": "The lamp isn't reachable.",
      "status_detail": "COMMUNICATION_ERROR",
      "thing_type": "hue:0210",
      "uid": "hue:0210:bridge1:lamp3"
    }
  ]
}
```

### Remove item from group

Take an item out of a group.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Group (`group`, text, required): The group: pick one, or give its name from another openHAB step or its label, such as Lights.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "groups": [
    "LivingRoom"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Remove item metadata

Remove one piece of an item's metadata. Says so when there was none.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Metadata (`namespace`, text, required): Which metadata, by openHAB's name for it, such as unit, stateDescription or alexa.

**Outputs**

- `name` (text): The item's name
- `namespace` (text): Which metadata was removed, such as unit
- `removed` (true/false): Whether there was any to remove

**Example output**

```json
{
  "name": "LivingRoom_Temperature",
  "namespace": "unit",
  "removed": true
}
```

### Remove tag from item

Take a tag off an item.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Tag (`tag`, text, required): The tag, such as Light.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [],
  "type": "Switch",
  "unit": ""
}
```

### Run rule

Run a rule, a scene or a script now, whatever usually starts it, such as a Good night scene.

**Inputs**

- Rule (`rule`, text, required): The rule, scene or script: pick one, or give its ID from another openHAB step or its name.

**Outputs**

- `description` (text): Its description
- `enabled` (true/false): Whether it is turned on
- `link` (text): Where it opens in openHAB
- `name` (text): The rule's name
- `rule_type` (text): rule, scene or script
- `started` (true/false): Whether openHAB started it
- `status` (text): IDLE, RUNNING, INITIALIZING or UNINITIALIZED
- `status_detail` (text): Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
- `tags` (list): Its tags
- `uid` (text): The rule's ID, which other openHAB steps take

**Example output**

```json
{
  "description": "Lamp on, dimmer low",
  "enabled": true,
  "link": "https://openhab.example.com/settings/scenes/evening_scene",
  "name": "Evening",
  "rule_type": "scene",
  "started": true,
  "status": "IDLE",
  "status_detail": "",
  "tags": [
    "Scene"
  ],
  "uid": "evening_scene"
}
```

### Say text

Have openHAB say something out loud through a speaker it knows. Needs a text-to-speech add-on and a speaker set up in openHAB.

**Inputs**

- Text (`text`, text, required): What to say, such as The washing is done.
- Voice (`voice`, text): The voice's ID in openHAB. Leave blank for openHAB's default.
- Speaker (`speaker`, text): The ID of the speaker (audio sink) in openHAB. Leave blank for openHAB's default.
- Volume (`volume`, number): How loud, from 0 to 100 percent. From 0 to 100.

**Outputs**

- `sent` (true/false): Whether openHAB took the request
- `text` (text): What openHAB was asked to say

**Example output**

```json
{
  "sent": true,
  "text": "The washing is done"
}
```

### Send command

Tell an item, and the device behind it, to do something: ON or OFF, a number, UP, DOWN or STOP for blinds, PLAY or PAUSE, a colour, or text.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Command (`command`, text, required): What to send, as openHAB takes it: ON, OFF, 50, UP, DOWN, STOP, PLAY, PAUSE, a colour as hue,saturation,brightness such as 120,100,50, or any text.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `command` (text): The command openHAB was sent, such as ON or 50
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "command": "ON",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Set item metadata

Set one piece of an item's metadata, such as its unit or what a voice assistant calls it, replacing what was there.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Metadata (`namespace`, text, required): Which metadata, by openHAB's name for it, such as unit, stateDescription or alexa.
- Value (`value`, text, required): The value, such as °C.
- Settings (`config`, object): Extra fields and values it takes, such as pattern: %.1f °C.

**Outputs**

- `config` (object): Its extra settings
- `name` (text): The item's name
- `namespace` (text): Which metadata was set, such as unit
- `value` (text): Its value

**Example output**

```json
{
  "config": {},
  "name": "LivingRoom_Temperature",
  "namespace": "unit",
  "value": "\u00b0C"
}
```

### Set level

Set a dimmer's brightness, a blind's position or a volume, from 0 to 100 percent.

**Inputs**

- Item (`item`, text, required): The dimmer, blind or volume: pick one, or give its name from another openHAB step or its label, such as Hall_Dimmer.
- Level (`level`, number, required): From 0 to 100 percent, such as 50. From 0 to 100.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `command` (text): The command openHAB was sent, such as ON or 50
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "command": "50",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Dimmer",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Dimmer",
  "number": 50,
  "previous_state": "OFF",
  "state": "50",
  "tags": [
    "Light"
  ],
  "type": "Dimmer",
  "unit": ""
}
```

### Tell openHAB in words

Give openHAB a command in plain words, such as turn on the hall light, and get its answer. openHAB matches the words to your items' labels.

**Inputs**

- Text (`text`, text, required): What to tell it, such as turn off the kitchen light.
- Language (`language`, text): The language it's in, such as en, de, fr or es. Defaults to en.
- Interpreter (`interpreter`, text): The ID of another interpreter set up in openHAB, such as a chat add-on's. Leave blank for openHAB's built-in one.

**Outputs**

- `answer` (text): What openHAB answered, such as Ok.
- `text` (text): What openHAB was told
- `understood` (true/false): Whether openHAB understood it and acted

**Example output**

```json
{
  "answer": "Ok.",
  "text": "turn on the hall light",
  "understood": true
}
```

### Turn off

Turn off a light, a switch or a group of them.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `command` (text): The command openHAB was sent, such as ON or 50
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "command": "OFF",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "OFF",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Turn on

Turn on a light, a switch or a group of them.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `command` (text): The command openHAB was sent, such as ON or 50
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "command": "ON",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```

### Update item state

Change what an item shows without telling its device to do anything, such as a text item with a status, or a number worked out in a workflow.

**Inputs**

- Item (`item`, text, required): The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- State (`state`, text, required): What it should show, such as OPEN, 21.5 or any text. NULL clears it.

**Outputs**

- `category` (text): Its icon, such as lightbulb
- `groups` (list): The groups it belongs to, by name
- `has_state` (true/false): Whether the item has a value (not NULL or UNDEF)
- `is_group` (true/false): Whether the item is a group of other items
- `label` (text): The item's label, as people see it
- `last_changed` (text): When its state last changed (UTC), or blank
- `last_updated` (text): When it last received a state (UTC), or blank
- `link` (text): Where the item opens in openHAB
- `name` (text): The item's name, which other openHAB steps take
- `number` (number): The state as a number, empty when it isn't one
- `previous_state` (text): What it showed before its last change
- `state` (text): What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
- `tags` (list): Its tags, such as Light
- `type` (text): What kind of item it is, such as Switch, Dimmer or Number
- `unit` (text): The unit of that number, such as °C, or blank

**Example output**

```json
{
  "category": "lightbulb",
  "groups": [
    "LivingRoom",
    "Lights"
  ],
  "has_state": true,
  "is_group": false,
  "label": "Living Room Lamp",
  "last_changed": "2026-11-12T18:30:00Z",
  "last_updated": "2026-11-12T18:30:00Z",
  "link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
  "name": "LivingRoom_Lamp",
  "number": null,
  "previous_state": "OFF",
  "state": "ON",
  "tags": [
    "Light"
  ],
  "type": "Switch",
  "unit": ""
}
```
