📊 ioBroker Simple-API Skill#

Production-ready ioBroker client for OpenClaw automation.

Full access to ioBroker via the simple-api adapter. Read states, objects, historical data, write to states, execute JavaScript, and monitor your smart home. The skill automatically handles caching, rate limiting, and circuit breaker protection. Use this skill to integrate OpenClaw with your ioBroker installation for full smart home control.

---

🚀 Quick Start#

Prerequisites#

• ioBroker with simple-api adapter installed
• Adapter running on a port (default 8087)

Minimal Configuration#

The skill auto-detects config on first run. Manual config in openclaw.json:

json

{
  "entries": {
    "iobroker-simple-api": {
      "config": {
        "url": "http://CHANGE_ME_IP",
        "port": 8087,
        "username": "",
        "password": ""
      }
    }
  }
}

Test Connection#

text

health

Returns connection status, uptime, and state count.

---

⚙️ Configuration#

OptionRequiredDefaultDescriptionurlYeshttp://CHANGE_ME_IPioBroker simple-api base URLportYes8087ioBroker simple-api portusernameNo(empty)Basic Auth usernamepasswordNo(empty)Basic Auth password

Auto-Detection#

The skill automatically detects the OpenClaw config path:

1. From environment variables ( OPENCLAW_HOME, OPENCLAW_STATE_DIR)
2. From its own installation path (skill → workspace → .openclaw)
3. Creates default config on first run if missing

Runtime Config#

Change config at runtime:

text

config:baseUrl=http://CHANGE_ME_IP:8087
config:timeout=20000

---

📖 Read Operations#

Get State Value#

text

getPlainValue:javascript.0.sensor.temperature

With JSON parsing:

text

getPlainValue:javascript.0.data?json

Get State + Object#

text

get:javascript.0.sensor.temperature

Get Multiple States#

text

getBulk:javascript.0.sensor.temperature,javascript.0.sensor.humidity

List Objects/States#

text

objects:*              # All objects
objects:javascript.0.*  # JavaScript adapter objects
states:*               # All states
states:humidity*       # States starting with humidity

Search#

text

search:temperature
search:livingroom

Query History#

text

query:javascript.0.sensor.temperature?dateFrom=-1h
query:system.host.*?dateFrom=-24h&aggregate=minmax

Supported time formats:

• -1h, -30m, -7d (relative)
• today (today at midnight)
• 2024-01-01 (absolute)

CSV Export#

text

csv:javascript.0.sensor.temperature?dateFrom=-24h

---

📤 Write Operations#

Set State#

text

set:javascript.0.light?value=on
set:javascript.0.counter?value=42&type=number&ack=true

Toggle#

text

toggle:javascript.0.switch

Set Multiple#

text

setBulk:javascript.0.light1=on&javascript.0.light2=off

Create/Delete State#

text

create:javascript.0.myNewState?common={"type":"number","name":"My State"}
delete:javascript.0.myNewState

Enable/Disable#

text

enable:javascript.0.myNewState
disable:javascript.0.myNewState

---

💻 Script Execution#

Execute JavaScript#

text

exec:$('javascript.0.sensor.temp').val(true)
eval:2+2

List Scripts#

text

scripts
jsinfo

---

🔌 System Commands#

CommandDescriptionhealthConnection status, uptime, state countcacheCache statistics (hits, misses, size)rateRate limit statussystemHosts, memory, CPU inforuntimeUptime, CPU, memory, diskadaptersList installed adaptersinstancesAdapter instances with statusstatusFull skill status

---

🎬 Scenes & Snapshots#

Scenes#

text

scene:mynight={"light.living":"on","light.bedroom":"off"}
scenes
activate:mynight
deletescene:mynight

Snapshots#

text

snapshot:backup=state1,state2
snapshots
diff:snap1 vs snap2
diff:snap1 vs current

---

📊 Groups & Enums#

text

groups
groups:rooms
group:enum.rooms.living

---

⚡ Features#

Caching#

• 30 second TTL for frequently accessed states
• Automatic cache invalidation on writes

Rate Limiting#

• 10 requests/second to prevent API flooding
• Queue management for burst requests

Circuit Breaker#

• Auto-recovery on failures
• Exponential backoff with jitter

Batch Operations#

• Efficient bulk get/set
• Parallel execution option

Type Coercion#

• Convert between boolean/number/string
• Automatic JSON parsing

Historical Queries#

• Multiple aggregation types (minmax, average, sum, count)
• Configurable time ranges

---

📋 API Reference#

Commands Summary#

CommandDescriptiongetPlainValue:<id>Get state valueget:<id>Get state + objectgetBulk:<ids>Multiple statesobjects:<pattern>List objectsstates:<pattern>List statessearch:<pattern>Search dataquery:<id>?dateFrom=...Query historyset:<id>?value=...Set statetoggle:<id>Toggle statesetBulk:<id1>=<v1>&<id2>=<v2>Multiple writescreate:<id>?common=...Create statedelete:<id>Delete stateexec:<js>Execute JSscene:name={...}Create scenesnapshot:name=...Take snapshotgroupsList enumshealthConnection checkcacheCache statssystemSystem inforuntimeRuntime info

---

📁 Resources#

Files#

• skill.js - Main implementation
• index.js - Skill loader
• LICENSE - MIT No Attribution

---

🔗 External Links#

• ioBroker
• simple-api Adapter
• ioBroker REST API Docs